add more tests

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

src/plugins/dashboard/public/application/utils/index.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './breadcrumbs';
+export * from './utils';
 export * from './get_nav_actions';
 export * from './get_no_items_message';
 export * from './get_table_columns';

src/plugins/dashboard/public/application/utils/use/use_dashboard_app_state.test.ts

@@ -12,6 +12,8 @@ import { DashboardServices } from '../../../types';
 import { SavedObjectDashboard } from '../../../saved_dashboards';
 import { dashboardAppStateStub } from '../stubs';
 import { createDashboardServicesMock } from '../mocks';
+import { Dashboard } from '../../../dashboard';
+import { convertToSerializedDashboard } from '../../../saved_dashboards/_saved_dashboard';
 
 jest.mock('../create_dashboard_app_state');
 jest.mock('../create_dashboard_container.tsx');
@@ -28,7 +30,6 @@ describe('useDashboardAppAndGlobalState', () => {
     getState: stateContainerGetStateMock,
     state$: new Observable(),
     transitions: {
-      updateVisState: jest.fn(),
       set: jest.fn(),
     },
   };
@@ -49,6 +50,8 @@ describe('useDashboardAppAndGlobalState', () => {
       optionsJSON: JSON.stringify(dashboardAppStateStub.options),
     },
   } as unknown) as SavedObjectDashboard;
+  const dashboard = new Dashboard(convertToSerializedDashboard(savedDashboardInstance));
+
   let mockServices: jest.Mocked<DashboardServices>;
 
   beforeEach(() => {
@@ -77,6 +80,7 @@ describe('useDashboardAppAndGlobalState', () => {
         services: mockServices,
         eventEmitter,
         savedDashboardInstance,
+        dashboard,
       })
     );
 
@@ -106,6 +110,7 @@ describe('useDashboardAppAndGlobalState', () => {
         services: mockServices,
         eventEmitter,
         savedDashboardInstance,
+        dashboard,
       })
     );
 

src/plugins/dashboard/public/application/utils/use/use_editor_updates.test.ts

@@ -13,7 +13,7 @@ import { dashboardAppStateStub } from '../stubs';
 import { createDashboardServicesMock } from '../mocks';
 import { Dashboard } from '../../../dashboard';
 import { convertToSerializedDashboard } from '../../../saved_dashboards/_saved_dashboard';
-import { setBreadcrumbsForExistingDashboard, setBreadcrumbsForNewDashboard } from '../breadcrumbs';
+import { setBreadcrumbsForExistingDashboard, setBreadcrumbsForNewDashboard } from '../utils';
 import { ViewMode } from '../../../embeddable_plugin';
 
 describe('useEditorUpdates', () => {
@@ -75,8 +75,6 @@ describe('useEditorUpdates', () => {
   let appState: DashboardAppStateContainer;
   let savedDashboardInstance: SavedObjectDashboard;
   let dashboard: Dashboard;
-  let timeRange: any;
-  let mockFilters: any;
 
   beforeEach(() => {
     unsubscribeStateUpdatesMock = jest.fn();
@@ -98,15 +96,6 @@ describe('useEditorUpdates', () => {
       },
     } as unknown) as SavedObjectDashboard;
     dashboard = new Dashboard(convertToSerializedDashboard(savedDashboardInstance));
-    timeRange = {
-      from: 'now-15m',
-      to: 'now',
-    };
-    mockFilters = ['mockFilters'];
-    const mockQuery = {
-      query: '',
-      language: 'kuery',
-    };
   });
 
   test('should set up current app state and render the editor', () => {

src/plugins/dashboard/public/application/utils/use/use_editor_updates.ts

@@ -9,7 +9,7 @@ import { DashboardAppState, DashboardAppStateContainer, DashboardServices } from
 import { DashboardContainer } from '../../embeddable';
 import { Dashboard } from '../../../dashboard';
 import { SavedObjectDashboard } from '../../../saved_dashboards';
-import { setBreadcrumbsForExistingDashboard, setBreadcrumbsForNewDashboard } from '../breadcrumbs';
+import { setBreadcrumbsForExistingDashboard, setBreadcrumbsForNewDashboard } from '../utils';
 
 export const useEditorUpdates = ({
   eventEmitter,

src/plugins/dashboard/public/application/utils/use/use_saved_dashboard_instance.test.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { renderHook } from '@testing-library/react-hooks';
+import { EventEmitter } from 'events';
+
+import { useSavedDashboardInstance } from './use_saved_dashboard_instance';
+import { DashboardServices } from '../../../types';
+import { SavedObjectDashboard } from '../../../saved_dashboards';
+import { dashboardAppStateStub } from '../stubs';
+import { createDashboardServicesMock } from '../mocks';
+import { Dashboard } from '../../../dashboard';
+import { convertToSerializedDashboard } from '../../../saved_dashboards/_saved_dashboard';
+
+// TODO: needs more setState tests on update
+describe('useSavedDashboardInstance', () => {
+  const eventEmitter = new EventEmitter();
+  let mockServices: jest.Mocked<DashboardServices>;
+  let isChromeVisible: boolean | undefined;
+  let dashboardIdFromUrl: string | undefined;
+  let savedDashboardInstance: SavedObjectDashboard;
+  let dashboard: Dashboard;
+
+  beforeEach(() => {
+    mockServices = createDashboardServicesMock();
+    isChromeVisible = true;
+    dashboardIdFromUrl = '1234';
+
+    savedDashboardInstance = ({
+      ...dashboardAppStateStub,
+      ...{
+        getQuery: () => dashboardAppStateStub.query,
+        getFilters: () => dashboardAppStateStub.filters,
+        optionsJSON: JSON.stringify(dashboardAppStateStub.options),
+      },
+    } as unknown) as SavedObjectDashboard;
+    dashboard = new Dashboard(convertToSerializedDashboard(savedDashboardInstance));
+  });
+
+  describe('should not set saved dashboard instance', () => {
+    test('if id ref is blank and dashboardIdFromUrl not updated', () => {
+      dashboardIdFromUrl = undefined;
+
+      const { result } = renderHook(() =>
+        useSavedDashboardInstance({
+          services: mockServices,
+          eventEmitter,
+          isChromeVisible,
+          dashboardIdFromUrl,
+        })
+      );
+
+      expect(result.current).toEqual({});
+    });
+
+    test('if chrome is not visible', () => {
+      isChromeVisible = undefined;
+
+      const { result } = renderHook(() =>
+        useSavedDashboardInstance({
+          services: mockServices,
+          eventEmitter,
+          isChromeVisible,
+          dashboardIdFromUrl,
+        })
+      );
+
+      expect(result.current).toEqual({});
+    });
+  });
+});

src/plugins/dashboard/public/application/utils/use/use_saved_dashboard_instance.ts

@@ -3,18 +3,17 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { i18n } from '@osd/i18n';
 import { EventEmitter } from 'events';
 import { useEffect, useRef, useState } from 'react';
-import {
-  redirectWhenMissing,
-  SavedObjectNotFound,
-} from '../../../../../opensearch_dashboards_utils/public';
-import { DashboardConstants } from '../../../dashboard_constants';
 import { DashboardServices } from '../../../types';
 import { getDashboardInstance } from '../get_dashboard_instance';
 import { SavedObjectDashboard } from '../../../saved_dashboards';
 import { Dashboard, DashboardParams } from '../../../dashboard';
+import {
+  handleErrorFromDashboard,
+  handleErrorFromCreateDashboard,
+  handleErrorFromSavedDashboard,
+} from '../utils';
 
 /**
  * This effect is responsible for instantiating a saved dashboard or creating a new one
@@ -38,60 +37,7 @@ export const useSavedDashboardInstance = ({
   const dashboardId = useRef('');
 
   useEffect(() => {
-    const {
-      application: { navigateToApp },
-      chrome,
-      history,
-      http: { basePath },
-      notifications,
-      toastNotifications,
-      data,
-    } = services;
-
-    const handleErrorFromSavedDashboard = (error: any) => {
-      // Preserve BWC of v5.3.0 links for new, unsaved dashboards.
-      // See https://github.com/elastic/kibana/issues/10951 for more context.
-      if (error instanceof SavedObjectNotFound && dashboardIdFromUrl === 'create') {
-        // Note preserve querystring part is necessary so the state is preserved through the redirect.
-        history.replace({
-          ...history.location, // preserve query,
-          pathname: DashboardConstants.CREATE_NEW_DASHBOARD_URL,
-        });
-
-        notifications.toasts.addWarning(
-          i18n.translate('dashboard.urlWasRemovedInSixZeroWarningMessage', {
-            defaultMessage:
-              'The url "dashboard/create" was removed in 6.0. Please update your bookmarks.',
-          })
-        );
-      } else {
-        // E.g. a corrupt or deleted dashboard
-        notifications.toasts.addDanger(error.message);
-        history.replace(DashboardConstants.LANDING_PAGE_PATH);
-      }
-      return new Promise(() => {});
-    };
-
-    const handleErrorFromCreateDashboard = () => {
-      redirectWhenMissing({
-        history,
-        basePath,
-        navigateToApp,
-        mapping: {
-          dashboard: DashboardConstants.LANDING_PAGE_PATH,
-        },
-        toastNotifications: notifications.toasts,
-      });
-    };
-
-    const handleError = () => {
-      toastNotifications.addWarning({
-        title: i18n.translate('dashboard.createDashboard.failedToLoadErrorMessage', {
-          defaultMessage: 'Failed to load the dashboard',
-        }),
-      });
-      history.replace(DashboardConstants.LANDING_PAGE_PATH);
-    };
+    const { chrome, history, data } = services;
 
     const getSavedDashboardInstance = async () => {
       try {
@@ -104,7 +50,7 @@ export const useSavedDashboardInstance = ({
             dashboardInstance = await getDashboardInstance(services);
             setSavedDashboardInstance(dashboardInstance);
           } catch {
-            handleErrorFromCreateDashboard();
+            handleErrorFromCreateDashboard({ services });
           }
         } else if (dashboardIdFromUrl) {
           try {
@@ -131,11 +77,11 @@ export const useSavedDashboardInstance = ({
             );
             setSavedDashboardInstance(dashboardInstance);
           } catch (error: any) {
-            return handleErrorFromSavedDashboard(error);
+            return handleErrorFromSavedDashboard({ error, dashboardIdFromUrl, services });
           }
         }
       } catch (error: any) {
-        handleError();
+        handleErrorFromDashboard({ services });
       }
     };
 

src/plugins/dashboard/public/application/utils/breadcrumbs.ts → src/plugins/dashboard/public/application/utils/utils.ts

@@ -1,17 +1,16 @@
 /*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
- *
- * The OpenSearch Contributors require contributions made to
- * this file be licensed under the Apache-2.0 license or a
- * compatible open source license.
- *
- * Any modifications Copyright OpenSearch Contributors. See
- * GitHub history for details.
  */
 
 import { i18n } from '@osd/i18n';
 import { DashboardConstants } from '../../dashboard_constants';
 import { ViewMode } from '../../embeddable_plugin';
+import {
+  redirectWhenMissing,
+  SavedObjectNotFound,
+} from '../../../../opensearch_dashboards_utils/public';
+import { DashboardServices } from '../../types';
 
 export function getLandingBreadcrumbs() {
   return [
@@ -96,3 +95,67 @@ export const setBreadcrumbsForExistingDashboard = (
     }
   }
 };
+
+export const handleErrorFromSavedDashboard = ({
+  error,
+  dashboardIdFromUrl,
+  services,
+}: {
+  error: any;
+  dashboardIdFromUrl: string;
+  services: DashboardServices;
+}) => {
+  const { history, notifications } = services;
+
+  // Preserve BWC of v5.3.0 links for new, unsaved dashboards.
+  // See https://github.com/elastic/kibana/issues/10951 for more context.
+  if (error instanceof SavedObjectNotFound && dashboardIdFromUrl === 'create') {
+    // Note preserve querystring part is necessary so the state is preserved through the redirect.
+    history.replace({
+      ...history.location, // preserve query,
+      pathname: DashboardConstants.CREATE_NEW_DASHBOARD_URL,
+    });
+
+    notifications.toasts.addWarning(
+      i18n.translate('dashboard.urlWasRemovedInSixZeroWarningMessage', {
+        defaultMessage:
+          'The url "dashboard/create" was removed in 6.0. Please update your bookmarks.',
+      })
+    );
+  } else {
+    // E.g. a corrupt or deleted dashboard
+    notifications.toasts.addDanger(error.message);
+    history.replace(DashboardConstants.LANDING_PAGE_PATH);
+  }
+  return new Promise(() => {});
+};
+
+export const handleErrorFromCreateDashboard = ({ services }: { services: DashboardServices }) => {
+  const {
+    application: { navigateToApp },
+    history,
+    http: { basePath },
+    notifications,
+  } = services;
+
+  redirectWhenMissing({
+    history,
+    basePath,
+    navigateToApp,
+    mapping: {
+      dashboard: DashboardConstants.LANDING_PAGE_PATH,
+    },
+    toastNotifications: notifications.toasts,
+  });
+};
+
+export const handleErrorFromDashboard = ({ services }: { services: DashboardServices }) => {
+  const { history, toastNotifications } = services;
+
+  toastNotifications.addWarning({
+    title: i18n.translate('dashboard.createDashboard.failedToLoadErrorMessage', {
+      defaultMessage: 'Failed to load the dashboard',
+    }),
+  });
+  history.replace(DashboardConstants.LANDING_PAGE_PATH);
+};