-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
## Summary A few changes related to toast messages: * Better presentation of error data sent from the API (both general platform errors and app-specific errors) * Uses platform's new Toasts service to prevent modal/toast z-index collision issues * Updates both the Value Lists Modal and the Exceptions List Modals to use this new hook wrapping the above This also fixes an issue with `useListsConfig` where, when the server is nonresponsive, it will not continue to poll awaiting a non-error response.
- Loading branch information
Showing
14 changed files
with
211 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
x-pack/plugins/security_solution/public/common/hooks/use_app_toasts.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { renderHook } from '@testing-library/react-hooks'; | ||
|
|
||
| import { useToasts } from '../lib/kibana'; | ||
| import { useAppToasts } from './use_app_toasts'; | ||
|
|
||
| jest.mock('../lib/kibana'); | ||
|
|
||
| describe('useDeleteList', () => { | ||
| let addErrorMock: jest.Mock; | ||
| let addSuccessMock: jest.Mock; | ||
|
|
||
| beforeEach(() => { | ||
| addErrorMock = jest.fn(); | ||
| addSuccessMock = jest.fn(); | ||
| (useToasts as jest.Mock).mockImplementation(() => ({ | ||
| addError: addErrorMock, | ||
| addSuccess: addSuccessMock, | ||
| })); | ||
| }); | ||
|
|
||
| it('works normally with a regular error', async () => { | ||
| const error = new Error('regular error'); | ||
| const { result } = renderHook(() => useAppToasts()); | ||
|
|
||
| result.current.addError(error, { title: 'title' }); | ||
|
|
||
| expect(addErrorMock).toHaveBeenCalledWith(error, { title: 'title' }); | ||
| }); | ||
|
|
||
| it("uses a AppError's body.message as the toastMessage", async () => { | ||
| const kibanaApiError = { | ||
| message: 'Not Found', | ||
| body: { status_code: 404, message: 'Detailed Message' }, | ||
| }; | ||
|
|
||
| const { result } = renderHook(() => useAppToasts()); | ||
|
|
||
| result.current.addError(kibanaApiError, { title: 'title' }); | ||
|
|
||
| expect(addErrorMock).toHaveBeenCalledWith(kibanaApiError, { | ||
| title: 'title', | ||
| toastMessage: 'Detailed Message', | ||
| }); | ||
| }); | ||
|
|
||
| it('converts an unknown error to an Error', () => { | ||
| const unknownError = undefined; | ||
|
|
||
| const { result } = renderHook(() => useAppToasts()); | ||
|
|
||
| result.current.addError(unknownError, { title: 'title' }); | ||
|
|
||
| expect(addErrorMock).toHaveBeenCalledWith(Error(`${undefined}`), { | ||
| title: 'title', | ||
| }); | ||
| }); | ||
| }); |
48 changes: 48 additions & 0 deletions
48
x-pack/plugins/security_solution/public/common/hooks/use_app_toasts.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { useCallback, useRef } from 'react'; | ||
|
|
||
| import { ErrorToastOptions, ToastsStart, Toast } from '../../../../../../src/core/public'; | ||
| import { useToasts } from '../lib/kibana'; | ||
| import { isAppError, AppError } from '../utils/api'; | ||
|
|
||
| export type UseAppToasts = Pick<ToastsStart, 'addSuccess'> & { | ||
| api: ToastsStart; | ||
| addError: (error: unknown, options: ErrorToastOptions) => Toast; | ||
| }; | ||
|
|
||
| export const useAppToasts = (): UseAppToasts => { | ||
| const toasts = useToasts(); | ||
| const addError = useRef(toasts.addError.bind(toasts)).current; | ||
| const addSuccess = useRef(toasts.addSuccess.bind(toasts)).current; | ||
|
|
||
| const addAppError = useCallback( | ||
| (error: AppError, options: ErrorToastOptions) => | ||
| addError(error, { | ||
| ...options, | ||
| toastMessage: error.body.message, | ||
| }), | ||
| [addError] | ||
| ); | ||
|
|
||
| const _addError = useCallback( | ||
| (error: unknown, options: ErrorToastOptions) => { | ||
| if (isAppError(error)) { | ||
| return addAppError(error, options); | ||
| } else { | ||
| if (error instanceof Error) { | ||
| return addError(error, options); | ||
| } else { | ||
| return addError(new Error(String(error)), options); | ||
| } | ||
| } | ||
| }, | ||
| [addAppError, addError] | ||
| ); | ||
|
|
||
| return { api: toasts, addError: _addError, addSuccess }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.