Add registerNavGroupUpdater to nav group service

Signed-off-by: Lin Wang <wonglam@amazon.com>

Author: wanglam

src/core/public/chrome/chrome_service.mock.ts

@@ -39,6 +39,7 @@ const createSetupContractMock = () => {
     navGroup: {
       addNavLinksToGroup: jest.fn(),
       getNavGroupEnabled: jest.fn(),
+      registerNavGroupUpdater: jest.fn(),
     },
   };
 };

src/core/public/chrome/index.ts

@@ -50,4 +50,4 @@ export { ChromeRecentlyAccessed, ChromeRecentlyAccessedHistoryItem } from './rec
 export { ChromeNavControl, ChromeNavControls } from './nav_controls';
 export { ChromeDocTitle } from './doc_title';
 export { RightNavigationOrder } from './constants';
-export { ChromeRegistrationNavLink } from './nav_group';
+export { ChromeRegistrationNavLink, ChromeNavGroupUpdater } from './nav_group';

src/core/public/chrome/nav_group/index.ts

@@ -9,4 +9,5 @@ export {
   ChromeNavGroupServiceStartContract,
   ChromeRegistrationNavLink,
   NavGroupItemInMap,
+  ChromeNavGroupUpdater,
 } from './nav_group_service';

src/core/public/chrome/nav_group/nav_group_service.test.ts

@@ -10,6 +10,7 @@ import { uiSettingsServiceMock } from '../../ui_settings/ui_settings_service.moc
 import { NavLinksService } from '../nav_links';
 import { applicationServiceMock, httpServiceMock } from '../../mocks';
 import { AppCategory } from 'opensearch-dashboards/public';
+import { DEFAULT_NAV_GROUPS } from '../../';
 
 const mockedGroupFoo = {
   id: 'foo',
@@ -219,3 +220,66 @@ describe('ChromeNavGroupService#start()', () => {
     expect(chromeNavGroupServiceStart.getNavGroupEnabled()).toBe(false);
   });
 });
+
+describe('nav group updater', () => {
+  it('should emit updated nav group after nav group updater called', async () => {
+    const navGroup = new ChromeNavGroupService();
+    const uiSettings = uiSettingsServiceMock.createSetupContract();
+    uiSettings.get$.mockImplementation(() => new Rx.BehaviorSubject(true));
+
+    const navGroupSetup = navGroup.setup({ uiSettings });
+    navGroupSetup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.dataAdministration, [
+      {
+        id: 'foo',
+      },
+    ]);
+    const navGroupStart = await navGroup.start({ navLinks: mockedNavLinkService });
+
+    expect(await navGroupStart.getNavGroupsMap$().pipe(first()).toPromise()).toEqual({
+      dataAdministration: expect.not.objectContaining({
+        status: expect.anything,
+      }),
+    });
+    navGroupSetup.registerNavGroupUpdater(
+      new Rx.BehaviorSubject(() => ({
+        status: 2,
+      }))
+    );
+    expect(await navGroupStart.getNavGroupsMap$().pipe(first()).toPromise()).toEqual({
+      dataAdministration: expect.objectContaining({
+        status: 2,
+      }),
+    });
+  });
+
+  it('should reset to original status after nav group updater unregister', async () => {
+    const navGroup = new ChromeNavGroupService();
+    const uiSettings = uiSettingsServiceMock.createSetupContract();
+    uiSettings.get$.mockImplementation(() => new Rx.BehaviorSubject(true));
+
+    const navGroupSetup = navGroup.setup({ uiSettings });
+    navGroupSetup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.dataAdministration, [
+      {
+        id: 'foo',
+      },
+    ]);
+    const appUpdater$ = new Rx.BehaviorSubject(() => ({
+      status: 2,
+    }));
+    const unregister = navGroupSetup.registerNavGroupUpdater(appUpdater$);
+    const navGroupStart = await navGroup.start({ navLinks: mockedNavLinkService });
+    expect(await navGroupStart.getNavGroupsMap$().pipe(first()).toPromise()).toEqual({
+      dataAdministration: expect.objectContaining({
+        status: 2,
+      }),
+    });
+
+    unregister();
+
+    expect(await navGroupStart.getNavGroupsMap$().pipe(first()).toPromise()).toEqual({
+      dataAdministration: expect.not.objectContaining({
+        status: expect.anything,
+      }),
+    });
+  });
+});

src/core/public/chrome/nav_group/nav_group_service.ts

@@ -3,9 +3,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { BehaviorSubject, combineLatest, Observable, ReplaySubject, Subscription } from 'rxjs';
+import { BehaviorSubject, combineLatest, Observable, of, ReplaySubject, Subscription } from 'rxjs';
 import { AppCategory, ChromeNavGroup, ChromeNavLink } from 'opensearch-dashboards/public';
-import { map, takeUntil } from 'rxjs/operators';
+import { map, switchMap, takeUntil } from 'rxjs/operators';
 import { IUiSettingsClient } from '../../ui_settings';
 import {
   flattenLinksOrCategories,
@@ -31,12 +31,15 @@ export type NavGroupItemInMap = ChromeNavGroup & {
   navLinks: ChromeRegistrationNavLink[];
 };
 
+export type ChromeNavGroupUpdater = (navGroup: ChromeNavGroup) => Partial<ChromeNavGroup> | void;
+
 export interface ChromeNavGroupServiceSetupContract {
   addNavLinksToGroup: (navGroup: ChromeNavGroup, navLinks: ChromeRegistrationNavLink[]) => void;
   /**
    * Get a boolean value to indicates whether use case is enabled
    */
   getNavGroupEnabled: () => boolean;
+  registerNavGroupUpdater: (navGroupUpdater: Observable<ChromeNavGroupUpdater>) => () => void;
 }
 
 export interface ChromeNavGroupServiceStartContract {
@@ -51,6 +54,7 @@ export class ChromeNavGroupService {
   private navLinks$: Observable<Array<Readonly<ChromeNavLink>>> = new BehaviorSubject([]);
   private navGroupEnabled: boolean = false;
   private navGroupEnabledUiSettingsSubscription: Subscription | undefined;
+  private navGroupUpdaters$$ = new BehaviorSubject<Array<Observable<ChromeNavGroupUpdater>>>([]);
   private addNavLinkToGroup(
     currentGroupsMap: Record<string, NavGroupItemInMap>,
     navGroup: ChromeNavGroup,
@@ -78,7 +82,7 @@ export class ChromeNavGroupService {
     return currentGroupsMap;
   }
   private getSortedNavGroupsMap$() {
-    return combineLatest([this.navGroupsMap$, this.navLinks$])
+    return combineLatest([this.getUpdatedNavGroupsMap$(), this.navLinks$])
       .pipe(takeUntil(this.stop$))
       .pipe(
         map(([navGroupsMap, navLinks]) => {
@@ -96,6 +100,33 @@ export class ChromeNavGroupService {
         })
       );
   }
+
+  private getUpdatedNavGroupsMap$() {
+    return combineLatest([this.navGroupsMap$, this.navGroupUpdaters$$]).pipe(
+      switchMap(([navGroupsMap, updaters$]) => {
+        if (updaters$.length === 0) {
+          return of(navGroupsMap);
+        }
+        return combineLatest(updaters$).pipe(
+          map((updaters) => {
+            return Object.keys(navGroupsMap).reduce<Record<string, NavGroupItemInMap>>(
+              (previousValue, currentKey) => ({
+                ...previousValue,
+                [currentKey]: updaters.reduce(
+                  (prevNavGroup, currentUpdater) => ({
+                    ...prevNavGroup,
+                    ...currentUpdater(prevNavGroup),
+                  }),
+                  navGroupsMap[currentKey]
+                ),
+              }),
+              {}
+            );
+          })
+        );
+      })
+    );
+  }
   setup({ uiSettings }: { uiSettings: IUiSettingsClient }): ChromeNavGroupServiceSetupContract {
     this.navGroupEnabledUiSettingsSubscription = uiSettings
       .get$('home:useNewHomePage', false)
@@ -116,6 +147,14 @@ export class ChromeNavGroupService {
         this.navGroupsMap$.next(navGroupsMapAfterAdd);
       },
       getNavGroupEnabled: () => this.navGroupEnabled,
+      registerNavGroupUpdater: (updater$) => {
+        this.navGroupUpdaters$$.next([...this.navGroupUpdaters$$.getValue(), updater$]);
+        return () => {
+          this.navGroupUpdaters$$.next(
+            this.navGroupUpdaters$$.getValue().filter((item) => item !== updater$)
+          );
+        };
+      },
     };
   }
   async start({

src/core/public/index.ts

@@ -72,6 +72,7 @@ import {
   RightNavigationButton,
   RightNavigationButtonProps,
   ChromeRegistrationNavLink,
+  ChromeNavGroupUpdater,
 } from './chrome';
 import { FatalErrorsSetup, FatalErrorsStart, FatalErrorInfo } from './fatal_errors';
 import { HttpSetup, HttpStart } from './http';
@@ -118,6 +119,7 @@ export {
   WorkspaceAttribute,
   ChromeNavGroup,
   NavGroupType,
+  NavGroupStatus,
 } from '../types';
 
 export {
@@ -371,6 +373,7 @@ export {
   RightNavigationButton,
   RightNavigationButtonProps,
   ChromeRegistrationNavLink,
+  ChromeNavGroupUpdater,
 };
 
 export { __osdBootstrap__ } from './osd_bootstrap';

src/core/types/nav_group.ts

@@ -16,6 +16,11 @@ export enum NavGroupType {
   SYSTEM = 'system',
 }
 
+export enum NavGroupStatus {
+  Visible,
+  Hidden,
+}
+
 /** @public */
 export interface ChromeNavGroup {
   id: string;
@@ -24,4 +29,6 @@ export interface ChromeNavGroup {
   order?: number;
   icon?: EuiIconType;
   type?: NavGroupType;
+
+  status?: NavGroupStatus;
 }