[Workspace] use registered nav groups in workspace form

changelogs/fragments/7221.yml

@@ -0,0 +1,2 @@
+feat:
+- Use registered nav group as workspace use case ([#7221](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7221))

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, ChromeNavGroupUpdater } from './nav_group';
+export { ChromeRegistrationNavLink, ChromeNavGroupUpdater, NavGroupItemInMap } from './nav_group';

src/core/public/index.ts

@@ -73,6 +73,7 @@ import {
   RightNavigationButtonProps,
   ChromeRegistrationNavLink,
   ChromeNavGroupUpdater,
+  NavGroupItemInMap,
 } from './chrome';
 import { FatalErrorsSetup, FatalErrorsStart, FatalErrorInfo } from './fatal_errors';
 import { HttpSetup, HttpStart } from './http';
@@ -373,6 +374,7 @@ export {
   RightNavigationButtonProps,
   ChromeRegistrationNavLink,
   ChromeNavGroupUpdater,
+  NavGroupItemInMap,
 };
 
 export { __osdBootstrap__ } from './osd_bootstrap';

src/plugins/workspace/public/application.tsx

@@ -10,7 +10,7 @@ import { OpenSearchDashboardsContextProvider } from '../../opensearch_dashboards
 import { WorkspaceFatalError } from './components/workspace_fatal_error';
 import { WorkspaceCreatorApp } from './components/workspace_creator_app';
 import { WorkspaceUpdaterApp } from './components/workspace_updater_app';
-import { WorkspaceListApp } from './components/workspace_list_app';
+import { WorkspaceListApp, WorkspaceListAppProps } from './components/workspace_list_app';
 import { WorkspaceUpdaterProps } from './components/workspace_updater';
 import { Services } from './types';
 import { WorkspaceCreatorProps } from './components/workspace_creator/workspace_creator';
@@ -65,10 +65,14 @@ export const renderFatalErrorApp = (params: AppMountParameters, services: Servic
     ReactDOM.unmountComponentAtNode(element);
   };
 };
-export const renderListApp = ({ element }: AppMountParameters, services: Services) => {
+export const renderListApp = (
+  { element }: AppMountParameters,
+  services: Services,
+  props: WorkspaceListAppProps
+) => {
   ReactDOM.render(
     <OpenSearchDashboardsContextProvider services={services}>
-      <WorkspaceListApp />
+      <WorkspaceListApp {...props} />
     </OpenSearchDashboardsContextProvider>,
     element
   );

src/plugins/workspace/public/components/workspace_creator/workspace_creator.test.tsx

@@ -7,9 +7,13 @@ import React from 'react';
 import { PublicAppInfo } from 'opensearch-dashboards/public';
 import { fireEvent, render, waitFor, act } from '@testing-library/react';
 import { BehaviorSubject } from 'rxjs';
-import { WorkspaceCreator as WorkspaceCreatorComponent } from './workspace_creator';
+import {
+  WorkspaceCreator as WorkspaceCreatorComponent,
+  WorkspaceCreatorProps,
+} from './workspace_creator';
 import { coreMock } from '../../../../../core/public/mocks';
 import { createOpenSearchDashboardsReactContext } from '../../../../opensearch_dashboards_react/public';
+import { WORKSPACE_USE_CASES } from '../../../common/constants';
 
 const workspaceClientCreate = jest
   .fn()
@@ -43,7 +47,10 @@ const dataSourcesList = [
 
 const mockCoreStart = coreMock.createStart();
 
-const WorkspaceCreator = (props: any, isDashboardAdmin = false) => {
+const WorkspaceCreator = ({
+  isDashboardAdmin = false,
+  ...props
+}: Partial<WorkspaceCreatorProps & { isDashboardAdmin: boolean }>) => {
   const { Provider } = createOpenSearchDashboardsReactContext({
     ...mockCoreStart,
     ...{
@@ -86,10 +93,16 @@ const WorkspaceCreator = (props: any, isDashboardAdmin = false) => {
       dataSourceManagement: {},
     },
   });
+  const registeredUseCases$ = new BehaviorSubject([
+    WORKSPACE_USE_CASES.observability,
+    WORKSPACE_USE_CASES['security-analytics'],
+    WORKSPACE_USE_CASES.analytics,
+    WORKSPACE_USE_CASES.search,
+  ]);
 
   return (
     <Provider>
-      <WorkspaceCreatorComponent {...props} />
+      <WorkspaceCreatorComponent {...props} registeredUseCases$={registeredUseCases$} />
     </Provider>
   );
 };
@@ -122,21 +135,13 @@ describe('WorkspaceCreator', () => {
   });
 
   it('should not create workspace when name is empty', async () => {
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     fireEvent.click(getByTestId('workspaceForm-bottomBar-createButton'));
     expect(workspaceClientCreate).not.toHaveBeenCalled();
   });
 
   it('should not create workspace with invalid name', async () => {
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: '~' },
@@ -146,11 +151,7 @@ describe('WorkspaceCreator', () => {
 
   it('should not create workspace without use cases', async () => {
     setHrefSpy.mockReset();
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: 'test workspace name' },
@@ -161,23 +162,15 @@ describe('WorkspaceCreator', () => {
   });
 
   it('cancel create workspace', async () => {
-    const { findByText, getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { findByText, getByTestId } = render(<WorkspaceCreator />);
     fireEvent.click(getByTestId('workspaceForm-bottomBar-cancelButton'));
     await findByText('Discard changes?');
     fireEvent.click(getByTestId('confirmModalConfirmButton'));
     expect(navigateToApp).toHaveBeenCalled();
   });
 
   it('create workspace with detailed information', async () => {
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: 'test workspace name' },
@@ -217,11 +210,7 @@ describe('WorkspaceCreator', () => {
 
   it('should show danger toasts after create workspace failed', async () => {
     workspaceClientCreate.mockReturnValueOnce({ result: { id: 'failResult' }, success: false });
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: 'test workspace name' },
@@ -239,11 +228,7 @@ describe('WorkspaceCreator', () => {
     workspaceClientCreate.mockImplementationOnce(async () => {
       throw new Error();
     });
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: 'test workspace name' },
@@ -257,12 +242,8 @@ describe('WorkspaceCreator', () => {
     expect(notificationToastsAddSuccess).not.toHaveBeenCalled();
   });
 
-  it('create workspace with current user', async () => {
-    const { getByTestId } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-      />
-    );
+  it('create workspace with customized permissions', async () => {
+    const { getByTestId } = render(<WorkspaceCreator />);
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {
       target: { value: 'test workspace name' },
@@ -294,10 +275,7 @@ describe('WorkspaceCreator', () => {
 
   it('create workspace with customized selected dataSources', async () => {
     const { getByTestId, getByTitle, getByText } = render(
-      <WorkspaceCreator
-        workspaceConfigurableApps$={new BehaviorSubject([...PublicAPPInfoMap.values()])}
-        isDashboardAdmin={true}
-      />
+      <WorkspaceCreator isDashboardAdmin={true} />
     );
     const nameInput = getByTestId('workspaceForm-workspaceDetails-nameInputText');
     fireEvent.input(nameInput, {

src/plugins/workspace/public/components/workspace_creator/workspace_creator.tsx

@@ -7,9 +7,8 @@ import React, { useCallback } from 'react';
 import { EuiPage, EuiPageBody, EuiPageHeader, EuiPageContent } from '@elastic/eui';
 import { i18n } from '@osd/i18n';
 import { useObservable } from 'react-use';
-import { BehaviorSubject, of } from 'rxjs';
+import { BehaviorSubject } from 'rxjs';
 
-import { PublicAppInfo } from 'opensearch-dashboards/public';
 import { useOpenSearchDashboards } from '../../../../opensearch_dashboards_react/public';
 import { WorkspaceForm, WorkspaceFormSubmitData, WorkspaceOperationType } from '../workspace_form';
 import { WORKSPACE_OVERVIEW_APP_ID } from '../../../common/constants';
@@ -18,9 +17,10 @@ import { WorkspaceClient } from '../../workspace_client';
 import { convertPermissionSettingsToPermissions } from '../workspace_form';
 import { DataSource } from '../../../common/types';
 import { DataSourceManagementPluginSetup } from '../../../../../plugins/data_source_management/public';
+import { WorkspaceUseCase } from '../../types';
 
 export interface WorkspaceCreatorProps {
-  workspaceConfigurableApps$?: BehaviorSubject<PublicAppInfo[]>;
+  registeredUseCases$: BehaviorSubject<WorkspaceUseCase[]>;
 }
 
 export const WorkspaceCreator = (props: WorkspaceCreatorProps) => {
@@ -37,10 +37,8 @@ export const WorkspaceCreator = (props: WorkspaceCreatorProps) => {
     workspaceClient: WorkspaceClient;
     dataSourceManagement?: DataSourceManagementPluginSetup;
   }>();
-  const workspaceConfigurableApps = useObservable(
-    props.workspaceConfigurableApps$ ?? of(undefined)
-  );
   const isPermissionEnabled = application?.capabilities.workspaces.permissionEnabled;
+  const availableUseCases = useObservable(props.registeredUseCases$, []);
 
   const handleWorkspaceFormSubmit = useCallback(
     async (data: WorkspaceFormSubmitData) => {
@@ -96,7 +94,6 @@ export const WorkspaceCreator = (props: WorkspaceCreatorProps) => {
         <EuiPageHeader pageTitle="Create a workspace" />
         <EuiPageContent
           verticalPosition="center"
-          horizontalPosition="center"
           paddingSize="none"
           color="subdued"
           hasShadow={false}
@@ -107,10 +104,9 @@ export const WorkspaceCreator = (props: WorkspaceCreatorProps) => {
               savedObjects={savedObjects}
               onSubmit={handleWorkspaceFormSubmit}
               operationType={WorkspaceOperationType.Create}
-              workspaceConfigurableApps={workspaceConfigurableApps}
               permissionEnabled={isPermissionEnabled}
-              permissionLastAdminItemDeletable
               dataSourceManagement={dataSourceManagement}
+              availableUseCases={availableUseCases}
             />
           )}
         </EuiPageContent>

src/plugins/workspace/public/components/workspace_form/types.ts

@@ -3,15 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import type {
-  ApplicationStart,
-  PublicAppInfo,
-  SavedObjectsStart,
-} from '../../../../../core/public';
+import type { ApplicationStart, SavedObjectsStart } from '../../../../../core/public';
 import type { WorkspacePermissionMode } from '../../../common/constants';
 import type { WorkspaceOperationType, WorkspacePermissionItemType } from './constants';
 import { DataSource } from '../../../common/types';
 import { DataSourceManagementPluginSetup } from '../../../../../plugins/data_source_management/public';
+import { WorkspaceUseCase } from '../../types';
 
 export interface WorkspaceUserPermissionSetting {
   id: number;
@@ -84,7 +81,7 @@ export interface WorkspaceFormProps {
   onSubmit?: (formData: WorkspaceFormSubmitData) => void;
   defaultValues?: WorkspaceFormData;
   operationType: WorkspaceOperationType;
-  workspaceConfigurableApps?: PublicAppInfo[];
   permissionEnabled?: boolean;
   dataSourceManagement?: DataSourceManagementPluginSetup;
+  availableUseCases: WorkspaceUseCase[];
 }

src/plugins/workspace/public/components/workspace_form/workspace_form.test.tsx

@@ -8,6 +8,8 @@ import { render } from '@testing-library/react';
 import { WorkspaceForm } from './workspace_form';
 import { coreMock } from '../../../../../core/public/mocks';
 import { DataSourceManagementPluginSetup } from '../../../../../plugins/data_source_management/public';
+import { WORKSPACE_USE_CASES } from '../../../common/constants';
+import { WorkspaceOperationType } from './constants';
 
 const mockCoreStart = coreMock.createStart();
 
@@ -38,6 +40,8 @@ const setup = (
     <WorkspaceForm
       application={application}
       savedObjects={savedObjects}
+      operationType={WorkspaceOperationType.Create}
+      availableUseCases={[WORKSPACE_USE_CASES.analytics]}
       dataSourceManagement={dataSourceManagement}
     />
   );

src/plugins/workspace/public/components/workspace_form/workspace_form.tsx

@@ -34,8 +34,8 @@ export const WorkspaceForm = (props: WorkspaceFormProps) => {
     defaultValues,
     operationType,
     permissionEnabled,
-    workspaceConfigurableApps,
     dataSourceManagement: isDataSourceEnabled,
+    availableUseCases,
   } = props;
   const {
     formId,
@@ -163,7 +163,7 @@ export const WorkspaceForm = (props: WorkspaceFormProps) => {
           fullWidth
         >
           <WorkspaceUseCase
-            configurableApps={workspaceConfigurableApps}
+            availableUseCases={availableUseCases}
             value={formData.useCases}
             onChange={handleUseCasesChange}
           />

src/plugins/workspace/public/components/workspace_form/workspace_use_case.test.tsx

@@ -6,14 +6,23 @@
 import React from 'react';
 import { fireEvent, render } from '@testing-library/react';
 import { WorkspaceUseCase, WorkspaceUseCaseProps } from './workspace_use_case';
+import { WORKSPACE_USE_CASES } from 'src/plugins/workspace/common/constants';
 
 const setup = (options?: Partial<WorkspaceUseCaseProps>) => {
   const onChangeMock = jest.fn();
   const renderResult = render(
     <WorkspaceUseCase
-      configurableApps={[
+      availableUseCases={[
+        WORKSPACE_USE_CASES.observability,
+        WORKSPACE_USE_CASES['security-analytics'],
+        WORKSPACE_USE_CASES.analytics,
+        WORKSPACE_USE_CASES.search,
         {
-          id: 'discover',
+          id: 'system-use-case',
+          title: 'System use case',
+          description: 'System use case description',
+          features: [],
+          systematic: true,
         },
       ]}
       value={[]}