Toast on CustomPanels by pjfitzgibbons · Pull Request #415 · opensearch-project/dashboards-observability

pjfitzgibbons · 2023-04-21T22:54:54Z

Description

Apply OSD GlobalToast to CustomPanels

Issues Resolved

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

* Panel View (legacy) - Duplicate - Rename Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

ps48 · 2023-04-24T06:34:56Z

.cypress/integration/3_panels.spec.ts

 });

-describe('Testing panels table', () => {
+describe.only('Testing panels table', () => {


I feel the .only, commented code and console.log additions were part of cypress debugging. We can remove these.

ps48 · 2023-04-24T06:43:34Z

public/components/custom_panels/custom_panel_table.tsx

        'Cancel',
        'Duplicate',
-        selectedCustomPanels[0].title + ' (copy)',
+        selectedCustomPanels[0].title + ' (copy)x',


We can remove the x typo here.

ps48 · 2023-04-24T06:48:33Z

public/components/common/toast/index.tsx

+    services: { toasts },
+  } = useOpenSearchDashboards<ObservabilityAppServices>();
+
+  const setToast = (title: string, color: Color = 'success', text?, side?: string) => {


We can remove the side parameter, if not being used.

Side is used when toast during flyout. So unless toast on right-side is OK while visualization flyout and others are active, only then could we remove it.

Side is being passed-through on OSD API

I may be missing something here. Can you please explain how are you using/passing down the side parameter in this function?

ps48 · 2023-04-24T06:54:01Z

public/components/custom_panels/custom_panel_table.tsx

  const [modalLayout, setModalLayout] = useState(<EuiOverlayMask />); // Modal Layout
  const [isActionsPopoverOpen, setIsActionsPopoverOpen] = useState(false);
-  const [selectedCustomPanels, setselectedCustomPanels] = useState<CustomPanelType[]>([]);
+  const [selectedCustomPanels, setselectedCustomPanels$] = useState<CustomPanelType[]>([]);


Not sure if the $ is expected here. I see the below reference is setselectedCustomPanels

There was debugging. Will double-check.

ps48 · 2023-04-24T07:05:04Z

public/components/custom_panels/custom_panel_table.tsx

+      const newPanel = newPanelTemplate(newCustomPanelName);
+      dispatch(createPanel(newPanel));
+    }


Should we add a toast for create panel here?
From the change in panel_slice.tsx, I see that we are not redirecting to a new panel when created. So, the user stays in home table page after the panel is created.

I think we should be redirecting - that is the current behavior?

ps48 · 2023-04-24T07:06:12Z

public/components/custom_panels/custom_panel_table.tsx

+          'Error cloning Operational Panel, please make sure you have the correct permission.',
+          'danger'
+        );
+        console.log(err);


We should replace console.log with console.error to show errors.

joshuali925 · 2023-04-24T16:54:00Z

public/components/custom_panels/__tests__/custom_panel_view.test.tsx

      window.location.assign(`#/event_analytics/explorer/${savedVisId}`);
    };

+    const services = { toasts: { addDanger: (t) => {} } }


you can use https://github.com/opensearch-project/opensearch-dashboards/blob/main/src/core/TESTING.md#core-mocks

i added a mock here

dashboards-observability/test/__mocks__/coreMocks.ts

Line 11 in a4cb6d1

const coreStart = coreMock.createStart();

joshuali925 · 2023-04-24T16:56:30Z

public/framework/redux/reducers/toast_slice.ts

@@ -0,0 +1,40 @@
+import { createSlice } from '@reduxjs/toolkit';


license header missing

joshuali925 · 2023-04-24T16:58:33Z

public/plugin.ts


+      const services: ObservabilityAppServices = {
+        toasts: coreStart.notifications.toasts,
+      };


why is this another service and not using your coreRefs?

joshuali925 · 2023-04-24T16:58:58Z

also backport to main?

pjfitzgibbons requested review from Swiddis, YANG-DB, anirudha, dai-chen, derek-ho, joshuali925, kavithacm, mengweieric, ps48, rupal-bq and vamsimanohar as code owners April 21, 2023 22:54

pjfitzgibbons changed the base branch from main to 2.7 April 21, 2023 22:55

pjfitzgibbons requested a review from a team as a code owner April 21, 2023 22:55

Peter Fitzgibbons added 3 commits April 21, 2023 16:01

Fixes

d855d04

* Panel View (legacy) - Duplicate - Rename Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

Toasts use hook from useOpenSearchDashboards context provider

7782039

Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

Testing for CustomPanel Toast

caa1499

Signed-off-by: Peter Fitzgibbons <pjfitz@amazon.com>

pjfitzgibbons force-pushed the toast branch from f8a4744 to caa1499 Compare April 21, 2023 23:06

ps48 reviewed Apr 24, 2023

View reviewed changes

pjfitzgibbons changed the base branch from 2.7 to main April 24, 2023 16:42

pjfitzgibbons changed the base branch from main to 2.7 April 24, 2023 16:50

joshuali925 reviewed Apr 24, 2023

View reviewed changes

rupal-bq mentioned this pull request Apr 25, 2023

Add Error handling on duplicate dashboard names #422

Closed

6 tasks

ps48 mentioned this pull request Apr 25, 2023

fixes edit mode callback bug in Saved Object Panels #420

Merged

6 tasks

pjfitzgibbons closed this Jun 13, 2023

		@@ -0,0 +1,40 @@
		import { createSlice } from '@reduxjs/toolkit';

Conversation

pjfitzgibbons commented Apr 21, 2023

Description

Issues Resolved

Check List

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joshuali925 commented Apr 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants