Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] [Security Solution][Detections] Better toast errors (#72205) #72222

Merged
merged 1 commit into from
Jul 17, 2020

Conversation

rylnd
Copy link
Contributor

@rylnd rylnd commented Jul 17, 2020

Backports the following commits to 7.x:

* Add new hook to wrap the toasts service

When receiving error responses from our APIs, this gives us better toast
messages.

* Replace useToasts with useAppToasts in trivial case

* WIP: prevent infinite polling when server is unresponsive

The crux of this issue was that we had no steady state when the server
returned a non-API error (!isApiError), as it would if the server was
throwing 500s or just generally misbehaving.

The solution, then, is to addresse these non-API errors in our
underlying useListsIndex and useListsPrivileges hooks.

This also refactors those hooks to:

* collapse multiple error states into one (that's all we currently need)
* use useAppToasts for better UI

TODO: I don't think I need the changes in useListsConfig's useEffect.

* Slightly more legible variables

The only task in this hook is our readPrivileges task right now, so I'm
shortening the variable until we have a need to disambiguate it further.

* Remove unnecessary conditions around creating our index

If the index hook has an error needsIndex will not be true.

* Better toast errors for Kibana API errors

Our isApiError predicate does not work for errors coming back from
Kibana platform itself, e.g. for a request payload error.

I've added a separate predicate for that case, isKibanaError, and then a
wrapping isAppError predicate since most of our use cases just care
about error.body.message, which is common to both.

* Use new toasts hook on our exceptions modals

This fixes two issues:

* toast appears above modal overlay
* Error message from response is now presented in the toast

* Fix bug with toasts dependencies

Because of the way some of the exception modal's hooks are written, a
change to one of its callbacks means that the request will be canceled.

Because the toasts service exports instance methods, the context within
the function (and thus the function itself) can change leading to a
mutable ref.

Because we don't want/need this behavior, we store our exported
functions in refs to 'freeze' them for react.

With our bound functions, we should now be able to declare e.g.
`toast.addError` as a dependency, however react cannot determine that it
is bound (and thus that toast.addError() is equivalent to addError()),
and so we must destructure our functions in order to use them as
dependencies.

* Alert clipboard toasts through new Toasts service

This fixes the z-index issue between modals and toasts.

* Fix type errors

* Mock external dependency

These tests now call out to the Notifications service (in a context)
instead of our redux implementation.
@rylnd rylnd added the backport label Jul 17, 2020
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

id value diff baseline
securitySolution 1066 +1 1065

async chunks size

id value diff baseline
securitySolution 7.3MB -153.0B 7.3MB

page load bundle size

id value diff baseline
securitySolution 870.1KB +485.0B 869.6KB

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yctercero yctercero merged commit 2aea97f into elastic:7.x Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants