[Feedback] Add option to queue flash messages to handleAPIError

- Should be hopefully useful for calls that need to queue an error and then redirect to another page
elastic · Sep 11, 2020 · dcdd872 · dcdd872
1 parent ab889ee
commit dcdd872
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/...ins/enterprise_search/public/applications/shared/flash_messages/handle_api_errors.test.ts b/...ins/enterprise_search/public/applications/shared/flash_messages/handle_api_errors.test.ts
@@ -5,7 +5,12 @@
  */
 
 jest.mock('./', () => ({
-  FlashMessagesLogic: { actions: { setFlashMessages: jest.fn() } },
+  FlashMessagesLogic: {
+    actions: {
+      setFlashMessages: jest.fn(),
+      setQueuedMessages: jest.fn(),
+    },
+  },
 }));
 import { FlashMessagesLogic } from './';
 
@@ -37,6 +42,16 @@ describe('handleAPIError', () => {
     ]);
   });
 
+  it('queues messages when isQueued is passed', () => {
+    handleAPIError(mockHttpError, { isQueued: true });
+
+    expect(FlashMessagesLogic.actions.setQueuedMessages).toHaveBeenCalledWith([
+      { type: 'error', message: 'Could not find X' },
+      { type: 'error', message: 'Could not find Y' },
+      { type: 'error', message: 'Something else bad happened' },
+    ]);
+  });
+
   it('displays a generic error message and re-throws non-API errors', () => {
     try {
       handleAPIError(Error('whatever') as any);

diff --git a/.../plugins/enterprise_search/public/applications/shared/flash_messages/handle_api_errors.ts b/.../plugins/enterprise_search/public/applications/shared/flash_messages/handle_api_errors.ts
@@ -25,18 +25,28 @@ interface IErrorResponse {
     errors: string[];
   };
 }
+interface IOptions {
+  isQueued?: boolean;
+}
 
 /**
  * Converts API/HTTP errors into user-facing Flash Messages
  */
-export const handleAPIError = (error: HttpResponse<IErrorResponse>) => {
+export const handleAPIError = (
+  error: HttpResponse<IErrorResponse>,
+  { isQueued }: IOptions = {}
+) => {
   const defaultErrorMessage = 'An unexpected error occurred';
 
   const errorFlashMessages: IFlashMessage[] = Array.isArray(error?.body?.attributes?.errors)
     ? error.body!.attributes.errors.map((message) => ({ type: 'error', message }))
     : [{ type: 'error', message: defaultErrorMessage }];
 
-  FlashMessagesLogic.actions.setFlashMessages(errorFlashMessages);
+  if (isQueued) {
+    FlashMessagesLogic.actions.setQueuedMessages(errorFlashMessages);
+  } else {
+    FlashMessagesLogic.actions.setFlashMessages(errorFlashMessages);
+  }
 
   // If this was a programming error or a failed request (such as a CORS) error,
   // we rethrow the error so it shows up in the developer console