[Workspace] Feature/workspace service core module (opensearch-project…

…#5092)

* feat: add core workspace module (#145)

The core workspace module(WorkspaceService) is a foundational component
that enables the implementation of workspace features within OSD
plugins. The purpose of the core workspace module is to provide
a framework for workspace implementations.

This module does not implement specific workspace
functionality but provides the essential infrastructure for plugins to
extend and customize workspace features, it maintains a shared
workspace state(observables) across the entire application to ensure
a consistent and up-to-date view of workspace-related information to
all parts of the application.

Signed-off-by: Yulong Ruan <[email protected]>
Signed-off-by: Yulong Ruan <[email protected]>
Co-authored-by: Miki <[email protected]>

CHANGELOG.md

@@ -41,6 +41,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Theme] Use themes' definitions to render the initial view ([#4936](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4936))
 - [Theme] Make `next` theme the default ([#4854](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4854))
 - [Discover] Update embeddable for saved searches ([#5081](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5081))
+- [Workspace] Add core workspace service module to enable the implementation of workspace features within OSD plugins ([#5092](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5092))
 
 ### 🐛 Bug Fixes
 
@@ -803,4 +804,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### 🔩 Tests
 
-- Update caniuse to fix failed integration tests ([#2322](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2322))
+- Update caniuse to fix failed integration tests ([#2322](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2322))

src/core/public/application/capabilities/capabilities_service.mock.ts

@@ -37,6 +37,7 @@ const createStartContractMock = (): jest.Mocked<CapabilitiesStart> => ({
     catalogue: {},
     management: {},
     navLinks: {},
+    workspaces: {},
   }),
 });
 

src/core/public/application/types.ts

@@ -47,6 +47,7 @@ import { IUiSettingsClient } from '../ui_settings';
 import { SavedObjectsStart } from '../saved_objects';
 import { AppCategory } from '../../types';
 import { ScopedHistory } from './scoped_history';
+import { WorkspacesStart } from '../workspace';
 
 /**
  * Accessibility status of an application.
@@ -334,6 +335,8 @@ export interface AppMountContext {
     injectedMetadata: {
       getInjectedVar: (name: string, defaultValue?: any) => unknown;
     };
+    /** {@link WorkspacesService} */
+    workspaces: WorkspacesStart;
   };
 }
 

src/core/public/core_system.test.mocks.ts

@@ -42,6 +42,7 @@ import { docLinksServiceMock } from './doc_links/doc_links_service.mock';
 import { renderingServiceMock } from './rendering/rendering_service.mock';
 import { contextServiceMock } from './context/context_service.mock';
 import { integrationsServiceMock } from './integrations/integrations_service.mock';
+import { workspacesServiceMock } from './workspace/workspaces_service.mock';
 import { coreAppMock } from './core_app/core_app.mock';
 
 export const MockInjectedMetadataService = injectedMetadataServiceMock.create();
@@ -145,3 +146,11 @@ export const CoreAppConstructor = jest.fn().mockImplementation(() => MockCoreApp
 jest.doMock('./core_app', () => ({
   CoreApp: CoreAppConstructor,
 }));
+
+export const MockWorkspacesService = workspacesServiceMock.create();
+export const WorkspacesServiceConstructor = jest
+  .fn()
+  .mockImplementation(() => MockWorkspacesService);
+jest.doMock('./workspace', () => ({
+  WorkspacesService: WorkspacesServiceConstructor,
+}));

src/core/public/core_system.test.ts

@@ -55,6 +55,8 @@ import {
   MockIntegrationsService,
   CoreAppConstructor,
   MockCoreApp,
+  WorkspacesServiceConstructor,
+  MockWorkspacesService,
 } from './core_system.test.mocks';
 
 import { CoreSystem } from './core_system';
@@ -99,6 +101,7 @@ describe('constructor', () => {
     expect(RenderingServiceConstructor).toHaveBeenCalledTimes(1);
     expect(IntegrationsServiceConstructor).toHaveBeenCalledTimes(1);
     expect(CoreAppConstructor).toHaveBeenCalledTimes(1);
+    expect(WorkspacesServiceConstructor).toHaveBeenCalledTimes(1);
   });
 
   it('passes injectedMetadata param to InjectedMetadataService', () => {
@@ -223,6 +226,11 @@ describe('#setup()', () => {
     expect(MockIntegrationsService.setup).toHaveBeenCalledTimes(1);
   });
 
+  it('calls workspaces#setup()', async () => {
+    await setupCore();
+    expect(MockWorkspacesService.setup).toHaveBeenCalledTimes(1);
+  });
+
   it('calls coreApp#setup()', async () => {
     await setupCore();
     expect(MockCoreApp.setup).toHaveBeenCalledTimes(1);
@@ -310,6 +318,11 @@ describe('#start()', () => {
     expect(MockIntegrationsService.start).toHaveBeenCalledTimes(1);
   });
 
+  it('calls workspaces#start()', async () => {
+    await startCore();
+    expect(MockWorkspacesService.start).toHaveBeenCalledTimes(1);
+  });
+
   it('calls coreApp#start()', async () => {
     await startCore();
     expect(MockCoreApp.start).toHaveBeenCalledTimes(1);
@@ -364,6 +377,14 @@ describe('#stop()', () => {
     expect(MockIntegrationsService.stop).toHaveBeenCalled();
   });
 
+  it('calls workspaces.stop()', () => {
+    const coreSystem = createCoreSystem();
+
+    expect(MockWorkspacesService.stop).not.toHaveBeenCalled();
+    coreSystem.stop();
+    expect(MockWorkspacesService.stop).toHaveBeenCalled();
+  });
+
   it('calls coreApp.stop()', () => {
     const coreSystem = createCoreSystem();
 

src/core/public/core_system.ts

@@ -54,6 +54,7 @@ import { ContextService } from './context';
 import { IntegrationsService } from './integrations';
 import { CoreApp } from './core_app';
 import type { InternalApplicationSetup, InternalApplicationStart } from './application/types';
+import { WorkspacesService } from './workspace';
 
 interface Params {
   rootDomElement: HTMLElement;
@@ -110,6 +111,7 @@ export class CoreSystem {
 
   private readonly rootDomElement: HTMLElement;
   private readonly coreContext: CoreContext;
+  private readonly workspaces: WorkspacesService;
   private fatalErrorsSetup: FatalErrorsSetup | null = null;
 
   constructor(params: Params) {
@@ -138,6 +140,7 @@ export class CoreSystem {
     this.rendering = new RenderingService();
     this.application = new ApplicationService();
     this.integrations = new IntegrationsService();
+    this.workspaces = new WorkspacesService();
 
     this.coreContext = { coreId: Symbol('core'), env: injectedMetadata.env };
 
@@ -160,6 +163,7 @@ export class CoreSystem {
       const http = this.http.setup({ injectedMetadata, fatalErrors: this.fatalErrorsSetup });
       const uiSettings = this.uiSettings.setup({ http, injectedMetadata });
       const notifications = this.notifications.setup({ uiSettings });
+      const workspaces = this.workspaces.setup();
 
       const pluginDependencies = this.plugins.getOpaqueIds();
       const context = this.context.setup({
@@ -176,6 +180,7 @@ export class CoreSystem {
         injectedMetadata,
         notifications,
         uiSettings,
+        workspaces,
       };
 
       // Services that do not expose contracts at setup
@@ -220,6 +225,7 @@ export class CoreSystem {
         targetDomElement: notificationsTargetDomElement,
       });
       const application = await this.application.start({ http, overlays });
+      const workspaces = this.workspaces.start();
       const chrome = await this.chrome.start({
         application,
         docLinks,
@@ -242,6 +248,7 @@ export class CoreSystem {
         overlays,
         savedObjects,
         uiSettings,
+        workspaces,
       }));
 
       const core: InternalCoreStart = {
@@ -256,6 +263,7 @@ export class CoreSystem {
         overlays,
         uiSettings,
         fatalErrors,
+        workspaces,
       };
 
       await this.plugins.start(core);
@@ -303,6 +311,7 @@ export class CoreSystem {
     this.chrome.stop();
     this.i18n.stop();
     this.application.stop();
+    this.workspaces.stop();
     this.rootDomElement.textContent = '';
   }
 }

src/core/public/index.ts

@@ -87,6 +87,7 @@ import {
   HandlerParameters,
 } from './context';
 import { Branding } from '../types';
+import { WorkspacesStart, WorkspacesSetup } from './workspace';
 
 export type { Logos } from '../common';
 export { PackageInfo, EnvironmentMode } from '../server/types';
@@ -102,6 +103,7 @@ export {
   StringValidation,
   StringValidationRegex,
   StringValidationRegexString,
+  WorkspaceAttribute,
 } from '../types';
 
 export {
@@ -239,6 +241,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
   };
   /** {@link StartServicesAccessor} */
   getStartServices: StartServicesAccessor<TPluginsStart, TStart>;
+  /** {@link WorkspacesSetup} */
+  workspaces: WorkspacesSetup;
 }
 
 /**
@@ -293,6 +297,8 @@ export interface CoreStart {
     getInjectedVar: (name: string, defaultValue?: any) => unknown;
     getBranding: () => Branding;
   };
+  /** {@link WorkspacesStart} */
+  workspaces: WorkspacesStart;
 }
 
 export {
@@ -341,3 +347,5 @@ export {
 };
 
 export { __osdBootstrap__ } from './osd_bootstrap';
+
+export { WorkspacesStart, WorkspacesSetup } from './workspace';

src/core/public/mocks.ts

@@ -47,6 +47,7 @@ import { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
 import { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
 import { contextServiceMock } from './context/context_service.mock';
 import { injectedMetadataServiceMock } from './injected_metadata/injected_metadata_service.mock';
+import { workspacesServiceMock } from './workspace/workspaces_service.mock';
 
 export { chromeServiceMock } from './chrome/chrome_service.mock';
 export { docLinksServiceMock } from './doc_links/doc_links_service.mock';
@@ -60,6 +61,7 @@ export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
 export { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
 export { scopedHistoryMock } from './application/scoped_history.mock';
 export { applicationServiceMock } from './application/application_service.mock';
+export { workspacesServiceMock } from './workspace/workspaces_service.mock';
 
 function createCoreSetupMock({
   basePath = '',
@@ -85,6 +87,7 @@ function createCoreSetupMock({
       getInjectedVar: injectedMetadataServiceMock.createSetupContract().getInjectedVar,
       getBranding: injectedMetadataServiceMock.createSetupContract().getBranding,
     },
+    workspaces: workspacesServiceMock.createSetupContract(),
   };
 
   return mock;
@@ -106,6 +109,7 @@ function createCoreStartMock({ basePath = '' } = {}) {
       getBranding: injectedMetadataServiceMock.createStartContract().getBranding,
     },
     fatalErrors: fatalErrorsServiceMock.createStartContract(),
+    workspaces: workspacesServiceMock.createStartContract(),
   };
 
   return mock;

src/core/public/plugins/plugin_context.ts

@@ -121,6 +121,7 @@ export function createPluginSetupContext<
       getBranding: deps.injectedMetadata.getBranding,
     },
     getStartServices: () => plugin.startDependencies,
+    workspaces: deps.workspaces,
   };
 }
 
@@ -168,5 +169,6 @@ export function createPluginStartContext<
       getBranding: deps.injectedMetadata.getBranding,
     },
     fatalErrors: deps.fatalErrors,
+    workspaces: deps.workspaces,
   };
 }

src/core/public/plugins/plugins_service.test.ts

@@ -58,6 +58,7 @@ import { CoreSetup, CoreStart, PluginInitializerContext } from '..';
 import { docLinksServiceMock } from '../doc_links/doc_links_service.mock';
 import { savedObjectsServiceMock } from '../saved_objects/saved_objects_service.mock';
 import { contextServiceMock } from '../context/context_service.mock';
+import { workspacesServiceMock } from '../workspace/workspaces_service.mock';
 
 export let mockPluginInitializers: Map<PluginName, MockedPluginInitializer>;
 
@@ -108,6 +109,7 @@ describe('PluginsService', () => {
       injectedMetadata: injectedMetadataServiceMock.createStartContract(),
       notifications: notificationServiceMock.createSetupContract(),
       uiSettings: uiSettingsServiceMock.createSetupContract(),
+      workspaces: workspacesServiceMock.createSetupContract(),
     };
     mockSetupContext = {
       ...mockSetupDeps,
@@ -127,6 +129,7 @@ describe('PluginsService', () => {
       uiSettings: uiSettingsServiceMock.createStartContract(),
       savedObjects: savedObjectsServiceMock.createStartContract(),
       fatalErrors: fatalErrorsServiceMock.createStartContract(),
+      workspaces: workspacesServiceMock.createStartContract(),
     };
     mockStartContext = {
       ...mockStartDeps,

src/core/public/workspace/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { WorkspacesStart, WorkspacesService, WorkspacesSetup } from './workspaces_service';

src/core/public/workspace/workspaces_service.mock.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { BehaviorSubject } from 'rxjs';
+import type { PublicMethodsOf } from '@osd/utility-types';
+
+import { WorkspacesService } from './workspaces_service';
+import { WorkspaceAttribute } from '..';
+
+const currentWorkspaceId$ = new BehaviorSubject<string>('');
+const workspaceList$ = new BehaviorSubject<WorkspaceAttribute[]>([]);
+const currentWorkspace$ = new BehaviorSubject<WorkspaceAttribute | null>(null);
+const initialized$ = new BehaviorSubject<boolean>(false);
+
+const createWorkspacesSetupContractMock = () => ({
+  currentWorkspaceId$,
+  workspaceList$,
+  currentWorkspace$,
+  initialized$,
+});
+
+const createWorkspacesStartContractMock = () => ({
+  currentWorkspaceId$,
+  workspaceList$,
+  currentWorkspace$,
+  initialized$,
+});
+
+export type WorkspacesServiceContract = PublicMethodsOf<WorkspacesService>;
+const createMock = (): jest.Mocked<WorkspacesServiceContract> => ({
+  setup: jest.fn().mockReturnValue(createWorkspacesSetupContractMock()),
+  start: jest.fn().mockReturnValue(createWorkspacesStartContractMock()),
+  stop: jest.fn(),
+});
+
+export const workspacesServiceMock = {
+  create: createMock,
+  createSetupContract: createWorkspacesSetupContractMock,
+  createStartContract: createWorkspacesStartContractMock,
+};