[Feature] OverviewPage made with Content Management

[TackAdam]

Description

1. Implement the overview page using content management. Has embeddable dashboard.
2. Add new setting for Observability default dashboard.
3. Adjust header title for getting started
4. Create folder for plugin helper files

Changes to overview page:
Before:

After:

New setting:

Getting Started before:

After:

Issues Resolved

New standard for Overview pages from opensearch-project/OpenSearch-Dashboards#7201

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.

[codecov]

Codecov Report

Attention: Patch coverage is 69.35484% with 19 lines in your changes missing coverage. Please review.

Project coverage is 54.81%. Comparing base (c3ab50f) to head (5c578a4).
Report is 56 commits behind head on main.

Files	Patch %	Lines
...ts/overview/components/select_dashboard_flyout.tsx	56.00%	11 Missing ⚠️
public/plugin_helpers/plugin_overview.tsx	28.57%	5 Missing ⚠️
public/plugin.tsx	0.00%	2 Missing ⚠️
...ponents/overview/components/dashboard_controls.tsx	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2077      +/-   ##
==========================================
- Coverage   57.85%   54.81%   -3.04%     
==========================================
  Files         372      399      +27     
  Lines       14081    15306    +1225     
  Branches     3712     4134     +422     
==========================================
+ Hits         8146     8390     +244     
- Misses       5871     6835     +964     
- Partials       64       81      +17     

Flag	Coverage Δ
dashboards-observability	54.81% <69.35%> (-3.04%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RyanL1997]

Hi @TackAdam , thanks for putting this together. In generally this is looking good to me=, and I just left some comments.

[RyanL1997]

Instead of repeatedly accessing properties, can we destructure the response at the beginning?

useEffect(() => {
  const fetchDashboards = async () => {
    const response = await coreRefs.savedObjectsClient?.find({ type: 'dashboard' });

    const savedDashboards = response?.savedObjects.reduce((acc, { id, attributes }) => {
      const { title, timeFrom, timeTo } = attributes as {
        title: string;
        timeFrom: string;
        timeTo: string;
      };

      acc[id] = {
        value: id,
        label: title,
        startDate: timeFrom,
        endDate: timeTo,
      };
      return acc;
    }, {} as DashboardDictionary);

    setDashboards(savedDashboards || {});

    const defaultDashboard = uiSettingsService.get(uiSettingsKey);

    if (defaultDashboard && savedDashboards?.[defaultDashboard]) {
      const { label, startDate, endDate } = savedDashboards[defaultDashboard];
      setDashboardTitle(label);
      setDashboardId(defaultDashboard);
      setStartDate(startDate);
      setEndDate(endDate);
      wrapper.dashboardSelected = true;
    } else {
      uiSettingsService.set('observability:defaultDashboard', null);
      setDashboardTitle('');
      setDashboardId('');
      wrapper.dashboardSelected = false;
    }
  };

  fetchDashboards();
}, []);

Also in the above comment, since we have destructured the attribute we do not need the toString() for id:

// Original
const dashboardAttributes = savedDashboard.attributes as { title: string; timeFrom: string; timeTo: string };
const id = savedDashboard.id.toString();

// Refactored
const { title, timeFrom, timeTo } = attributes as { title: string; timeFrom: string; timeTo: string };

[TackAdam]

Good call out, will look to implement this in a later PR when time allows thorough testing.

[ps48]

➕ to Ryan, Let's try to keep the useEffect cleaner, may be move this to function call and function can be declared outside useEffect

[ps48]

Why is this declared outside home? If this needs to be registered just once outside of react page updates then this should be part of plugin setup or plugin start.

[TackAdam]

Pending Fix in follow up PR / content management changes.

[TackAdam]

Updated flyout to be search/selectable.

[TackAdam]

Card wording update:

[paulstn]

Since all of the functions here are asynchronous, could there be any race conditions? Would any of these processes be dependent on any of the others in any way?

[TackAdam]

No each is independent. The registration for each section between the cards / dashboards / controls should be non reliant on each other. Haven't encountered any issues in testing.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-observability/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-observability/backport-2.x
# Create a new branch
git switch --create backport/backport-2077-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 881e56ac3742e716d7b25458aa75d716e7c83038
# Push it to GitHub
git push --set-upstream origin backport/backport-2077-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-observability/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-2077-to-2.x.