[Navigation] Register all plugins to NavGroups #1926

TackAdam · 2024-06-27T16:30:22Z

Description

Demo.mov.zip

This change adds a function that registers all the plugins to their corresponding NavGroups and NavCategories:

Plug-in	Group	Category
Notebooks	Observability	Dashboards and report
Notebooks	Security Analytics	Dashboards and report
Notebooks	Analytics	Dashboards and report
Integrations	Observability	Dashboards and report
Integrations	Security Analytics	Dashboards and report
Integrations	Analytics	Dashboards and report
Metrics	Observability	Investigate
Applications	Observability	Dashboards and report
Traces	Observability	Investigate

Issues Resolved

opensearch-project/OpenSearch-Dashboards#7029

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]>

joshuali925 · 2024-06-27T17:03:46Z

~~should this be done inside each plugin? rather than in observability~~ nvm i just realized Discover is log explore, not OSD Discover

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

ps48 · 2024-07-02T23:12:22Z

common/constants/shared.ts

@@ -58,7 +58,7 @@ export const observabilityNotebookTitle = 'Notebooks';
 export const observabilityNotebookPluginOrder = 5094;

 export const observabilityPanelsID = 'observability-dashboards';
-export const observabilityPanelsTitle = 'Dashboards';


can't change this here as it also changes in the name existing side-nav

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

RyanL1997 · 2024-07-04T02:05:54Z

common/constants/shared.ts

@@ -58,7 +58,7 @@ export const observabilityNotebookTitle = 'Notebooks';
 export const observabilityNotebookPluginOrder = 5094;

 export const observabilityPanelsID = 'observability-dashboards';
-export const observabilityPanelsTitle = 'Dashboards';


RyanL1997 · 2024-07-04T02:07:27Z

public/plugin.tsx

-      order: observabilityPanelsPluginOrder,
-      mount: appMountWithStartPage('dashboards'),
-    });
+    if (core.chrome.navGroup.getNavGroupEnabled()) {


Just for my knowledge, is this like a feature flag?

Yes, the navigation change can be toggled, and the UI plan currently list regular dashboards as going into the same category. Until it is depreciated the idea was to rename ours for clarity while using the new navigation.

Signed-off-by: SuZhou-Joe <[email protected]>

feat: enable default route

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

joshuali925 · 2024-07-05T21:12:04Z

public/components/trace_analytics/home.tsx

@@ -364,6 +366,7 @@ export const Home = (props: HomeProps) => {
            />
          )}
        />
+        <Route path="/" render={() => <Redirect to={defaultRoute} />} />


why this change?

Because we need to remove in-app navigation when the new navigation is enabled. In such case, different apps registered to new left navigation will have difference landing pages.

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

Signed-off-by: SuZhou-Joe <[email protected]>

Add some features to all use cases

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

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

…s while new navigation is active Signed-off-by: Adam Tackett <[email protected]>

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

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

TackAdam · 2024-07-18T23:28:36Z

public/components/application_analytics/components/app_table.tsx

-        href: '#/',
-      },
-    ]);
+    const isNavGroupEnabled = coreRefs?.chrome?.navGroup.getNavGroupEnabled();


This is to account for Logs being removed in the new navigation.

TackAdam · 2024-07-18T23:48:12Z

public/components/trace_analytics/home.tsx

-          render={(_routerProps) => (
-            <TraceSideBar>
+          render={(_routerProps) =>
+            !isNavGroupEnabled ? (


Prevents in app navigation from rendering while the new left hand navigation is enabled

public/components/application_analytics/components/application.tsx

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

opensearch-trigger-bot · 2024-07-19T20:43:21Z

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-1926-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09090a6d5ec0dc968de7493e6c8371b2dbbaa9cf
# Push it to GitHub
git push --set-upstream origin backport/backport-1926-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-1926-to-2.x.

* Add a function to register all plugin Nav groups and categories Signed-off-by: Adam Tackett <[email protected]> * Updated addNavLinkGroups path rename dashboards Signed-off-by: Adam Tackett <[email protected]> * Fixing Naming Signed-off-by: Adam Tackett <[email protected]> * feat: enable default route Signed-off-by: SuZhou-Joe <[email protected]> * Update breadcrumb for Trace to default to service page Signed-off-by: Adam Tackett <[email protected]> * Update snapshots Signed-off-by: Adam Tackett <[email protected]> * feat: update Signed-off-by: SuZhou-Joe <[email protected]> * feat: add some features to all use case Signed-off-by: SuZhou-Joe <[email protected]> * Depreciated logs, application. Dashboards/Traces adjusted Signed-off-by: Adam Tackett <[email protected]> * Not registering logs/applications/dashboards when left nav used Signed-off-by: Adam Tackett <[email protected]> * Update snapshots Signed-off-by: Adam Tackett <[email protected]> * fixing lint errors Signed-off-by: Adam Tackett <[email protected]> * Put applications back Signed-off-by: Adam Tackett <[email protected]> * update snapshots Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Removed applications from new nav Signed-off-by: Adam Tackett <[email protected]> * Add applications back, remove in app nav for trace, remove breadcrumbs while new navigation is active Signed-off-by: Adam Tackett <[email protected]> * update snapshots Signed-off-by: Adam Tackett <[email protected]> * Adjust order of metrics/traces/services/applications as per guidance from kevin Signed-off-by: Adam Tackett <[email protected]> * function for nav breadcrumbs added Signed-off-by: Adam Tackett <[email protected]> --------- Signed-off-by: Adam Tackett <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> Co-authored-by: Adam Tackett <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Sumukh Swamy <[email protected]> (cherry picked from commit 09090a6)

…1948) * [Navigation] Register all plugins to NavGroups (#1926) * Add a function to register all plugin Nav groups and categories Signed-off-by: Adam Tackett <[email protected]> * Updated addNavLinkGroups path rename dashboards Signed-off-by: Adam Tackett <[email protected]> * Fixing Naming Signed-off-by: Adam Tackett <[email protected]> * feat: enable default route Signed-off-by: SuZhou-Joe <[email protected]> * Update breadcrumb for Trace to default to service page Signed-off-by: Adam Tackett <[email protected]> * Update snapshots Signed-off-by: Adam Tackett <[email protected]> * feat: update Signed-off-by: SuZhou-Joe <[email protected]> * feat: add some features to all use case Signed-off-by: SuZhou-Joe <[email protected]> * Depreciated logs, application. Dashboards/Traces adjusted Signed-off-by: Adam Tackett <[email protected]> * Not registering logs/applications/dashboards when left nav used Signed-off-by: Adam Tackett <[email protected]> * Update snapshots Signed-off-by: Adam Tackett <[email protected]> * fixing lint errors Signed-off-by: Adam Tackett <[email protected]> * Put applications back Signed-off-by: Adam Tackett <[email protected]> * update snapshots Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin_nav.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Update public/plugin.tsx Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> * Removed applications from new nav Signed-off-by: Adam Tackett <[email protected]> * Add applications back, remove in app nav for trace, remove breadcrumbs while new navigation is active Signed-off-by: Adam Tackett <[email protected]> * update snapshots Signed-off-by: Adam Tackett <[email protected]> * Adjust order of metrics/traces/services/applications as per guidance from kevin Signed-off-by: Adam Tackett <[email protected]> * function for nav breadcrumbs added Signed-off-by: Adam Tackett <[email protected]> --------- Signed-off-by: Adam Tackett <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]> Co-authored-by: Adam Tackett <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Sumukh Swamy <[email protected]> (cherry picked from commit 09090a6) * remove error Signed-off-by: Adam Tackett <[email protected]> --------- Signed-off-by: Adam Tackett <[email protected]> Co-authored-by: Adam Tackett <[email protected]>

Add a function to register all plugin Nav groups and categories

43ff505

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

TackAdam requested review from ps48, kavithacm, derek-ho, joshuali925, dai-chen, YANG-DB, rupal-bq, mengweieric, vmmusings, Swiddis, penghuo, seankao-az, anirudha, paulstn and sumukhswamy as code owners June 27, 2024 16:30

SuZhou-Joe mentioned this pull request Jul 2, 2024

[META] New version of navigation opensearch-project/OpenSearch-Dashboards#7027

Closed

17 tasks

Updated addNavLinkGroups path rename dashboards

27641b5

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

ps48 reviewed Jul 2, 2024

View reviewed changes

Fixing Naming

bfa82c8

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

RyanL1997 approved these changes Jul 4, 2024

View reviewed changes

SuZhou-Joe and others added 3 commits July 5, 2024 18:27

feat: enable default route

1519828

Signed-off-by: SuZhou-Joe <[email protected]>

Merge pull request #1 from SuZhou-Joe/feature/enable_default_route

f5e26f3

feat: enable default route

Update breadcrumb for Trace to default to service page

6abb8ed

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

joshuali925 reviewed Jul 5, 2024

View reviewed changes

Adam Tackett and others added 4 commits July 10, 2024 11:36

Update snapshots

60ebb7c

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

feat: update

393815a

Signed-off-by: SuZhou-Joe <[email protected]>

feat: add some features to all use case

9b58c3a

Signed-off-by: SuZhou-Joe <[email protected]>

Merge pull request #2 from SuZhou-Joe/poc/context-menu-navigation

1488866

Add some features to all use cases

TackAdam and others added 9 commits July 17, 2024 22:28

Update public/plugin_nav.tsx

6c821ed

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

8bdc12a

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

ef393c7

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

59e5500

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

2b92e6e

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

6fdc251

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin_nav.tsx

158c8a7

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Update public/plugin.tsx

17994c2

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Adam Tackett <[email protected]>

Removed applications from new nav

1917733

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

SuZhou-Joe approved these changes Jul 18, 2024

View reviewed changes

Add applications back, remove in app nav for trace, remove breadcrumb…

7396203

…s while new navigation is active Signed-off-by: Adam Tackett <[email protected]>

TackAdam force-pushed the navObs branch from 3d47811 to 7396203 Compare July 18, 2024 23:06

update snapshots

0bbc6d4

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

TackAdam force-pushed the navObs branch from 7cffe42 to 0bbc6d4 Compare July 18, 2024 23:19

ps48 added enhancement New feature or request backport 2.x labels Jul 18, 2024

Adjust order of metrics/traces/services/applications as per guidance …

453f171

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

ps48 approved these changes Jul 19, 2024

View reviewed changes

TackAdam commented Jul 19, 2024

View reviewed changes

derek-ho reviewed Jul 19, 2024

View reviewed changes

public/components/application_analytics/components/application.tsx Outdated Show resolved Hide resolved

function for nav breadcrumbs added

50d44d4

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

sumukhswamy approved these changes Jul 19, 2024

View reviewed changes

Merge branch 'main' into navObs

4755904

mengweieric approved these changes Jul 19, 2024

View reviewed changes

ps48 approved these changes Jul 19, 2024

View reviewed changes

ps48 merged commit 09090a6 into opensearch-project:main Jul 19, 2024
12 of 19 checks passed

opensearch-trigger-bot bot added the backport-failed label Jul 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Navigation] Register all plugins to NavGroups #1926

[Navigation] Register all plugins to NavGroups #1926

TackAdam commented Jun 27, 2024 •

edited

Loading

joshuali925 commented Jun 27, 2024 •

edited

Loading

ps48 Jul 2, 2024

RyanL1997 Jul 4, 2024

RyanL1997 Jul 4, 2024

RyanL1997 Jul 4, 2024

TackAdam Jul 4, 2024

joshuali925 Jul 5, 2024

SuZhou-Joe Jul 18, 2024

TackAdam Jul 18, 2024

TackAdam Jul 18, 2024

opensearch-trigger-bot bot commented Jul 19, 2024

[Navigation] Register all plugins to NavGroups #1926

[Navigation] Register all plugins to NavGroups #1926

Conversation

TackAdam commented Jun 27, 2024 • edited Loading

Description

Issues Resolved

Check List

joshuali925 commented Jun 27, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Jul 19, 2024

TackAdam commented Jun 27, 2024 •

edited

Loading

joshuali925 commented Jun 27, 2024 •

edited

Loading