Overview page add state for missing data source #2237

TackAdam · 2024-10-30T21:14:29Z

Description

Add a state for workspaces when there is no data source associated. A data source needs to be present for everything to function so the user is prompted to do so if they end up in a state where a data source is not present.

Screen.Recording.2024-10-30.at.2.36.54.PM.mov

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.

Signed-off-by: Adam Tackett <[email protected]>

common/constants/shared.ts

ps48 · 2024-11-11T01:04:10Z

public/components/overview/components/dashboard_controls.tsx

+
+        // Set to null if there are no data sources associated [Handle if dashboard was set, then datasource deleted]
+        if (savedObjectsArray.length === 0) {
+          await setObservabilityDashboardsId(null);


For the refresh problem, I looked into the CMS implementation. It looks like this is an issue from the CMS plugin where the registration is only happening in plugin setup:

dashboards-observability/public/plugin.tsx

Line 192 in 6a43f53

setOverviewPage(page);

May be we can add a call-back for this function. This callback can be called to run setupOverviewPage

Wasn't able to use a callback as the registration exist. Found a work around calling
getOverviewPage().removeSection(SECTIONS.DASHBOARD);

to remove the section getting it to re-render correctly.

public/components/overview/components/dashboard_controls.tsx

Signed-off-by: Adam Tackett <[email protected]>

mengweieric · 2024-11-12T00:13:35Z

public/components/overview/components/add_datasource_callout.tsx

+        <EuiFlexItem grow={false} style={{ maxWidth: '40%' }}>
+          <EuiText textAlign="center">
+            <p style={{ margin: 0 }}>
+              There are no data sources associated to the workspace. Associate data sources or


minor: add i18n please (can be followups)

added

{i18n.translate('traceAnalytics.noDataSourcesMessage', { defaultMessage: 'There are no data sources associated to the workspace. Associate data sources or request your administrator to associate data sources for you to get started.', })}

mengweieric · 2024-11-12T00:16:07Z

public/components/overview/home.tsx

@@ -92,6 +97,7 @@ export const Home = () => {
            startDate: dashboardAttributes.timeFrom,
            endDate: dashboardAttributes.timeTo,
          };
+          setIsDashboardLoaded(true);


we should be able to set this flag in finally block

Added

.finally(() => { setIsDashboardLoaded(true); });

Thanks for feedback

mengweieric · 2024-11-12T00:20:17Z

public/components/overview/components/dashboard_controls.tsx

  const isDashboardSelected = useObservable(ObsDashboardStateManager.isDashboardSelected$);
  const dashboardState = useObservable(ObsDashboardStateManager.dashboardState$);

+  useEffect(() => {
+    const checkDataSource = async () => {


We should move this function definition out of the useEffect to make it cleaner

ps48 · 2024-11-12T00:23:30Z

public/components/overview/components/select_dashboard_flyout.tsx

@@ -61,6 +63,7 @@ export function SelectDashboardFlyout({ closeFlyout, dashboardsSavedObjects, rel
  const onClickAdd = async () => {
    const selectedOption = options.find((option) => option.checked === 'on');
    if (selectedOption && selectedOption.key) {
+      getOverviewPage().createSection(DASHBOARD_SECTION);


Does replace dashboard work as expected when the section is already created?

Yes, haven't seen any problems in all my testing. Just added as a fail safe for if a user removed the datasource to ensure when it is added back it works without needing a hard refresh.

ps48 · 2024-11-12T00:23:52Z

public/components/overview/components/add_dashboard_callout.tsx

@@ -26,7 +26,7 @@ import SampleDataLightPNG from './assets/SampleDataLight.png';

 export function AddDashboardCallout() {
  const showFlyout = useObservable(ObsDashboardStateManager.showFlyout$);
-  const isDarkMode = uiSettingsService.get('theme:darkMode');
+  const isDarkMode = uiSettingsService?.get('theme:darkMode') ?? false;


Signed-off-by: Adam Tackett <[email protected]>

mengweieric

Thanks

* added callout for no data sources pathway in workspaces Signed-off-by: Adam Tackett <[email protected]> * reset dashboard if datasource is deleted Signed-off-by: Adam Tackett <[email protected]> * handle refresh, adjust naming, unit test Signed-off-by: Adam Tackett <[email protected]> * add i18n, finally block, move function Signed-off-by: Adam Tackett <[email protected]> --------- Signed-off-by: Adam Tackett <[email protected]> Co-authored-by: Adam Tackett <[email protected]> (cherry picked from commit 3631968) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* added callout for no data sources pathway in workspaces * reset dashboard if datasource is deleted * handle refresh, adjust naming, unit test * add i18n, finally block, move function --------- (cherry picked from commit 3631968) Signed-off-by: Adam Tackett <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Adam Tackett <[email protected]>

added callout for no data sources pathway in workspaces

4b5e972

Signed-off-by: Adam Tackett <[email protected]>

TackAdam added enhancement New feature or request backport 2.x labels Oct 30, 2024

Adam Tackett and others added 2 commits October 30, 2024 16:30

reset dashboard if datasource is deleted

5190f1d

Signed-off-by: Adam Tackett <[email protected]>

Merge branch 'main' into overviewDataSource

9206f59

TackAdam added the mds-2.18.0 label Nov 4, 2024

TackAdam added 3 commits November 6, 2024 09:32

Merge branch 'main' into overviewDataSource

74ab651

Merge branch 'main' into overviewDataSource

fa9b4e9

Merge branch 'main' into overviewDataSource

3126f99

ps48 reviewed Nov 11, 2024

View reviewed changes

common/constants/shared.ts Outdated Show resolved Hide resolved

ps48 reviewed Nov 11, 2024

View reviewed changes

public/components/overview/components/dashboard_controls.tsx Outdated Show resolved Hide resolved

handle refresh, adjust naming, unit test

42b6c6b

Signed-off-by: Adam Tackett <[email protected]>

TackAdam marked this pull request as ready for review November 11, 2024 23:09

mengweieric reviewed Nov 12, 2024

View reviewed changes

ps48 reviewed Nov 12, 2024

View reviewed changes

ps48 approved these changes Nov 12, 2024

View reviewed changes

add i18n, finally block, move function

b06e832

Signed-off-by: Adam Tackett <[email protected]>

mengweieric approved these changes Nov 12, 2024

View reviewed changes

TackAdam merged commit 3631968 into opensearch-project:main Nov 12, 2024
11 of 18 checks passed

opensearch-trigger-bot bot mentioned this pull request Nov 12, 2024

[Backport 2.x] Overview page add state for missing data source #2252

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overview page add state for missing data source #2237

Overview page add state for missing data source #2237

TackAdam commented Oct 30, 2024 •

edited

Loading

ps48 Nov 11, 2024 •

edited

Loading

TackAdam Nov 11, 2024

mengweieric Nov 12, 2024

TackAdam Nov 12, 2024

mengweieric Nov 12, 2024

TackAdam Nov 12, 2024

mengweieric Nov 12, 2024 •

edited

Loading

TackAdam Nov 12, 2024

ps48 Nov 12, 2024

TackAdam Nov 12, 2024

ps48 Nov 12, 2024

mengweieric left a comment

Overview page add state for missing data source #2237

Overview page add state for missing data source #2237

Conversation

TackAdam commented Oct 30, 2024 • edited Loading

Description

Issues Resolved

Check List

ps48 Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mengweieric Nov 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mengweieric left a comment

Choose a reason for hiding this comment

TackAdam commented Oct 30, 2024 •

edited

Loading

ps48 Nov 11, 2024 •

edited

Loading

mengweieric Nov 12, 2024 •

edited

Loading