Add Toasts to Observability Dashboards (opensearch-project#435)

* Fixes * Panel View (legacy) - Duplicate - Rename Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com> * Toasts use hook from useOpenSearchDashboards context provider Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com> * Testing for CustomPanel Toast Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com> * update catches from comments, minor code cleaning Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * update tests Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * remove unused redux slice Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * revert cypress changes Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * add toasts to SOflyout Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * fix messaging for multiple delete Signed-off-by: Derek Ho <dxho@amazon.com> * fix up toast and error handling for create and delete flows Signed-off-by: Derek Ho <dxho@amazon.com> * fix up clone Signed-off-by: Derek Ho <dxho@amazon.com> * fix rename in table Signed-off-by: Derek Ho <dxho@amazon.com> * fix rename in custom panel so view Signed-off-by: Derek Ho <dxho@amazon.com> * fix up panel toasts Signed-off-by: Derek Ho <dxho@amazon.com> * fix up for flyout Signed-off-by: Derek Ho <dxho@amazon.com> * code cleanup Signed-off-by: Derek Ho <dxho@amazon.com> * finish merge Signed-off-by: Derek Ho <dxho@amazon.com> * fix up PR comments Signed-off-by: Derek Ho <dxho@amazon.com> --------- Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com> Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> Signed-off-by: Derek Ho <dxho@amazon.com> Co-authored-by: Peter Fitzgibbons <pjfitz@amazon.com> Co-authored-by: Derek Ho <dxho@amazon.com> (cherry picked from commit a9d1d37) Signed-off-by: Derek Ho <dxho@amazon.com>
derek-ho · May 8, 2023 · ff22120 · ff22120
1 parent 2b7c21a
commit ff22120
Show file tree

Hide file tree

Showing 15 changed files with 248 additions and 270 deletions.
diff --git a/.cypress/integration/3_panels.spec.ts b/.cypress/integration/3_panels.spec.ts
@@ -644,8 +644,7 @@ const eraseTestPanels = () => {
   eraseLegacyPanels();
   eraseSavedObjectPaenls();
 };
-const uuidRx =
-  /[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}/;
+const uuidRx = /[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}/;
 
 const clickCreatePanelButton = () =>
   cy.get('a[data-test-subj="customPanels__createNewPanels"]').click();

diff --git a/common/constants/custom_panels.ts b/common/constants/custom_panels.ts
@@ -8,7 +8,7 @@ import { v4 as uuidv4 } from 'uuid';
 export const CUSTOM_PANELS_API_PREFIX = '/api/observability/operational_panels';
 export const CUSTOM_PANELS_DOCUMENTATION_URL =
   'https://opensearch.org/docs/latest/observability-plugin/operational-panels/';
-export const CREATE_PANEL_MESSAGE = 'Enter a name to describe the purpose of this custom panel.';
+export const CREATE_PANEL_MESSAGE = 'Enter a name to describe the purpose of this Observability Dashboard.';
 
 export const CUSTOM_PANELS_SAVED_OBJECT_TYPE = 'observability-panel';
 

diff --git a/common/constants/shared.ts b/common/constants/shared.ts
@@ -25,7 +25,7 @@ export const DSL_ENDPOINT = '/_plugins/_dsl';
 
 export const observabilityID = 'observability-logs';
 export const observabilityTitle = 'Observability';
-export const observabilityPluginOrder = 6000;
+export const observabilityPluginOrder = 1500;
 
 export const observabilityApplicationsID = 'observability-applications';
 export const observabilityApplicationsTitle = 'Applications';

diff --git a/public/components/common/toast/index.tsx b/public/components/common/toast/index.tsx
@@ -0,0 +1,37 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ToastInputFields } from '../../../../../../src/core/public';
+import { coreRefs } from '../../../framework/core_refs';
+
+type Color = 'success' | 'primary' | 'warning' | 'danger' | undefined;
+
+export const useToast = () => {
+  const toasts = coreRefs.toasts!;
+
+  const setToast = (title: string, color: Color = 'success', text?: string) => {
+    const newToast: ToastInputFields = {
+      id: new Date().toISOString(),
+      title,
+      text,
+    };
+    switch (color) {
+      case 'danger': {
+        toasts.addDanger(newToast);
+        break;
+      }
+      case 'warning': {
+        toasts.addWarning(newToast);
+        break;
+      }
+      default: {
+        toasts.addSuccess(newToast);
+        break;
+      }
+    }
+  };
+
+  return { setToast };
+};
diff --git a/public/components/custom_panels/__tests__/custom_panel_view.test.tsx b/public/components/custom_panels/__tests__/custom_panel_view.test.tsx
@@ -20,13 +20,15 @@ import PPLService from '../../../../public/services/requests/ppl';
 import DSLService from '../../../../public/services/requests/dsl';
 import { coreStartMock } from '../../../../test/__mocks__/coreMocks';
 import { HttpResponse } from '../../../../../../src/core/public';
-import { createStore } from '@reduxjs/toolkit';
+import { applyMiddleware, createStore } from 'redux';
 import { rootReducer } from '../../../framework/redux/reducers';
+import thunk from 'redux-thunk';
 import { Provider } from 'react-redux';
 
 describe('Panels View Component', () => {
   configure({ adapter: new Adapter() });
-  const store = createStore(rootReducer);
+
+  const store = createStore(rootReducer, applyMiddleware(thunk));
 
   it('renders panel view container without visualizations', async () => {
     httpClientMock.get = jest.fn(() =>

diff --git a/public/components/custom_panels/custom_panel_table.tsx b/public/components/custom_panels/custom_panel_table.tsx
@@ -48,7 +48,6 @@ import { getSampleDataModal } from '../common/helpers/add_sample_modal';
 import { pageStyles } from '../../../common/constants/shared';
 import { DeleteModal } from '../common/helpers/delete_modal';
 import {
-  clonePanel,
   createPanel,
   deletePanels,
   fetchPanels,
@@ -57,6 +56,8 @@ import {
   renameCustomPanel,
   selectPanelList,
 } from './redux/panel_slice';
+import { isNameValid } from './helpers/utils';
+import { useToast } from '../common/toast';
 
 /*
  * "CustomPanelTable" module, used to view all the saved panels
@@ -77,17 +78,13 @@ interface Props {
   loading: boolean;
   setBreadcrumbs: (newBreadcrumbs: ChromeBreadcrumb[]) => void;
   parentBreadcrumbs: EuiBreadcrumb[];
-  cloneCustomPanel: (newCustomPanelName: string, customPanelId: string) => void;
-  deleteCustomPanelList: (customPanelIdList: string[], toastMessage: string) => any;
   addSamplePanels: () => void;
 }
 
 export const CustomPanelTable = ({
   loading,
   setBreadcrumbs,
   parentBreadcrumbs,
-  cloneCustomPanel,
-  deleteCustomPanelList,
   addSamplePanels,
 }: Props) => {
   const customPanels = useSelector<CustomPanelType[]>(selectPanelList);
@@ -100,16 +97,13 @@ export const CustomPanelTable = ({
   const history = useHistory();
 
   const dispatch = useDispatch();
+  const { setToast } = useToast();
 
   useEffect(() => {
     setBreadcrumbs(parentBreadcrumbs);
     dispatch(fetchPanels());
   }, []);
 
-  // useEffect(() =>
-  //   console.log({ customPanels, selectedCustomPanels }, [customPanels, selectedCustomPanels])
-  // );
-
   useEffect(() => {
     const url = window.location.hash.split('/');
     if (url[url.length - 1] === 'create') {
@@ -126,55 +120,58 @@ export const CustomPanelTable = ({
   };
 
   const onCreate = async (newCustomPanelName: string) => {
-    const newPanel = newPanelTemplate(newCustomPanelName);
-    dispatch(createPanel(newPanel));
+    if (!isNameValid(newCustomPanelName)) {
+      setToast('Invalid Dashboard name', 'danger');
+    } else {
+      const newPanel = newPanelTemplate(newCustomPanelName);
+      dispatch(createPanel(newPanel));
+    }
     closeModal();
   };
 
   const onRename = async (newCustomPanelName: string) => {
-    dispatch(renameCustomPanel(newCustomPanelName, selectedCustomPanels[0].id));
+    if (!isNameValid(newCustomPanelName)) {
+      setToast('Invalid Dashboard name', 'danger');
+    } else {
+      dispatch(renameCustomPanel(newCustomPanelName, selectedCustomPanels[0].id));
+    }
     closeModal();
   };
 
   const onClone = async (newName: string) => {
-    let sourcePanel = selectedCustomPanels[0];
-    try {
-      if (!isUuid(sourcePanel.id)) {
-        // Observability Panel API returns partial record, so for duplication
-        // we will retrieve the entire record and allow new process to continue.
-        const legacyFetchResult = await coreRefs.http!.get(
-          `${CUSTOM_PANELS_API_PREFIX}/panels/${sourcePanel.id}`
-        );
-        sourcePanel = legacyFetchResult.operationalPanel;
-      }
+    if (!isNameValid(newName)) {
+      setToast('Invalid Operational Panel name', 'danger');
+    } else {
+      let sourcePanel = selectedCustomPanels[0];
+      try {
+        if (!isUuid(sourcePanel.id)) {
+          // Observability Panel API returns partial record, so for duplication
+          // we will retrieve the entire record and allow new process to continue.
+          const legacyFetchResult = await coreRefs.http!.get(
+            `${CUSTOM_PANELS_API_PREFIX}/panels/${sourcePanel.id}`
+          );
+          sourcePanel = legacyFetchResult.operationalPanel;
+        }
 
-      const { id, ...newPanel } = {
-        ...sourcePanel,
-        title: newName,
-      };
+        const { id, ...newPanel } = {
+          ...sourcePanel,
+          title: newName,
+        };
 
-      dispatch(createPanel(newPanel));
-    } catch (err) {
-      console.log(err);
+        dispatch(createPanel(newPanel));
+      } catch (err) {
+        setToast(
+          'Error cloning Observability Dashboard, please make sure you have the correct permission.',
+          'danger'
+        );
+        console.error(err);
+      }
     }
     closeModal();
   };
 
   const onDelete = async () => {
-    const toastMessage = `Observability Dashboards ${
-      selectedCustomPanels.length > 1 ? 's' : ' ' + selectedCustomPanels[0].title
-    } successfully deleted!`;
-
-    try {
-      dispatch(deletePanels(selectedCustomPanels));
-    } catch (err) {
-      // setToast(
-      //   'Error deleting Operational Panels, please make sure you have the correct permission.',
-      //   'danger'
-      // );
-      console.error(err.body?.message || err);
-    }
-
+    dispatch(deletePanels(selectedCustomPanels));
     closeModal();
   };
 
@@ -337,7 +334,6 @@ export const CustomPanelTable = ({
     },
   ] as Array<EuiTableFieldDataColumnType<CustomPanelListType>>;
 
-  // console.log('rendering', { customPanels, selectedCustomPanels });
   return (
     <div style={pageStyles}>
       <EuiPage>

diff --git a/public/components/custom_panels/custom_panel_view.tsx b/public/components/custom_panels/custom_panel_view.tsx
@@ -70,6 +70,7 @@ import { AddVisualizationPopover } from './helpers/add_visualization_popover';
 import { DeleteModal } from '../common/helpers/delete_modal';
 import { coreRefs } from '../../framework/core_refs';
 import { clonePanel } from './redux/panel_slice';
+import { useToast } from '../common/toast';
 
 /*
  * "CustomPanelsView" module used to render an Observability Dashboard
@@ -104,12 +105,6 @@ interface CustomPanelViewProps {
   chrome: CoreStart['chrome'];
   parentBreadcrumbs: EuiBreadcrumb[];
   cloneCustomPanel: (clonedCustomPanelName: string, clonedCustomPanelId: string) => Promise<string>;
-  setToast: (
-    title: string,
-    color?: string,
-    text?: React.ReactChild | undefined,
-    side?: string | undefined
-  ) => void;
   onEditClick: (savedVisualizationId: string) => any;
   startTime: string;
   endTime: string;
@@ -138,7 +133,6 @@ export const CustomPanelView = (props: CustomPanelViewProps) => {
     setEndTime,
     updateAvailabilityVizId,
     cloneCustomPanel,
-    setToast,
     onEditClick,
     onAddClick,
   } = props;
@@ -169,6 +163,8 @@ export const CustomPanelView = (props: CustomPanelViewProps) => {
 
   const dispatch = useDispatch();
 
+  const { setToast } = useToast();
+
   const closeHelpFlyout = () => {
     setAddVizDisabled(false);
     setHelpIsFlyoutVisible(false);
@@ -318,24 +314,11 @@ export const CustomPanelView = (props: CustomPanelViewProps) => {
   };
 
   const onClone = async (newCustomPanelName: string) => {
-    try {
-      await dispatch(clonePanel(panel, newCustomPanelName));
-    } catch (err) {
-      setToast('Error while attempting to Duplicate this Dashboard.', 'danger');
+    if (!isNameValid(newCustomPanelName)) {
+      setToast('Invalid Operational Panel name', 'danger');
+    } else {
+      dispatch(clonePanel(panel, newCustomPanelName));
     }
-
-    // const newPanel = {
-    //   ...panel,
-    //   title: newCustomPanelName,
-    //   dateCreated: new Date().getTime(),
-    //   dateModified: new Date().getTime(),
-    // } as PanelType;
-    // const newSOPanel = await coreRefs.savedObjectsClient!.create(
-    //   CUSTOM_PANELS_SAVED_OBJECT_TYPE,
-    //   newPanel
-    // );
-    //
-    // window.location.assign(`${last(parentBreadcrumbs)!.href}${newSOPanel.id}`);
     closeModal();
   };