Add validation when load page (#8)

* fix: validation & query Signed-off-by: SuZhoue-Joe <[email protected]> * feat: modify file name to reduce confusion Signed-off-by: SuZhoue-Joe <[email protected]> * feat: add landing logic to retrive workspace id Signed-off-by: SuZhoue-Joe <[email protected]> * feat: add worklist observable Signed-off-by: SuZhoue-Joe <[email protected]> * feat: add worklist observable Signed-off-by: SuZhoue-Joe <[email protected]> * feat: add worklist observable Signed-off-by: SuZhoue-Joe <[email protected]> * fix: type error Signed-off-by: SuZhoue-Joe <[email protected]> * fix: type error Signed-off-by: SuZhoue-Joe <[email protected]> * feat: make client more robust Signed-off-by: SuZhoue-Joe <[email protected]> * feat: use Subject Signed-off-by: SuZhoue-Joe <[email protected]> --------- Signed-off-by: SuZhoue-Joe <[email protected]>
SuZhou-Joe · Jun 15, 2023 · 9be35b0 · 9be35b0
1 parent e3e278c
commit 9be35b0
Show file tree

Hide file tree

Showing 21 changed files with 340 additions and 152 deletions.
diff --git a/src/core/public/core_app/core_app.ts b/src/core/public/core_app/core_app.ts
@@ -42,12 +42,14 @@ import type { IUiSettingsClient } from '../ui_settings';
 import type { InjectedMetadataSetup } from '../injected_metadata';
 import { renderApp as renderErrorApp, setupUrlOverflowDetection } from './errors';
 import { renderApp as renderStatusApp } from './status';
+import { WorkspacesSetup } from '../workspace';
 
 interface SetupDeps {
   application: InternalApplicationSetup;
   http: HttpSetup;
   injectedMetadata: InjectedMetadataSetup;
   notifications: NotificationsSetup;
+  workspaces: WorkspacesSetup;
 }
 
 interface StartDeps {

diff --git a/src/core/public/core_system.ts b/src/core/public/core_system.ts
@@ -163,13 +163,14 @@ 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 = await this.workspaces.setup({ http });
 
       const pluginDependencies = this.plugins.getOpaqueIds();
       const context = this.context.setup({
         pluginDependencies: new Map([...pluginDependencies]),
       });
       const application = this.application.setup({ context, http });
-      this.coreApp.setup({ application, http, injectedMetadata, notifications });
+      this.coreApp.setup({ application, http, injectedMetadata, notifications, workspaces });
 
       const core: InternalCoreSetup = {
         application,
@@ -179,6 +180,7 @@ export class CoreSystem {
         injectedMetadata,
         notifications,
         uiSettings,
+        workspaces,
       };
 
       // Services that do not expose contracts at setup
@@ -202,7 +204,7 @@ export class CoreSystem {
       const uiSettings = await this.uiSettings.start();
       const docLinks = this.docLinks.start({ injectedMetadata });
       const http = await this.http.start();
-      const workspaces = await this.workspaces.start({ http });
+      const workspaces = await this.workspaces.start();
       const savedObjects = await this.savedObjects.start({ http });
       const i18n = await this.i18n.start();
       const fatalErrors = await this.fatalErrors.start();

diff --git a/src/core/public/fatal_errors/fatal_errors_service.mock.ts b/src/core/public/fatal_errors/fatal_errors_service.mock.ts
@@ -30,6 +30,8 @@
 
 import type { PublicMethodsOf } from '@osd/utility-types';
 import { FatalErrorsService, FatalErrorsSetup } from './fatal_errors_service';
+import { BehaviorSubject, Subject } from 'rxjs';
+import { WorkspaceAttribute } from '../workspace';
 
 const createSetupContractMock = () => {
   const setupContract: jest.Mocked<FatalErrorsSetup> = {
@@ -58,3 +60,31 @@ export const fatalErrorsServiceMock = {
   createSetupContract: createSetupContractMock,
   createStartContract: createStartContractMock,
 };
+
+const currentWorkspaceId$ = new BehaviorSubject<string>('');
+const workspaceList$ = new Subject<WorkspaceAttribute[]>();
+
+const createWorkspacesSetupContractMock = () => ({
+  client: {
+    currentWorkspaceId$,
+    workspaceList$,
+    stop: jest.fn(),
+    enterWorkspace: jest.fn(),
+    exitWorkspace: jest.fn(),
+    create: jest.fn(),
+    delete: jest.fn(),
+    list: jest.fn(),
+    getCurrentWorkspace: jest.fn(),
+    getCurrentWorkspaceId: jest.fn(),
+    get: jest.fn(),
+    update: jest.fn(),
+  },
+  formatUrlWithWorkspaceId: jest.fn(),
+});
+
+const createWorkspacesStartContractMock = createWorkspacesSetupContractMock;
+
+export const workspacesServiceMock = {
+  createSetupContractMock: createWorkspacesStartContractMock,
+  createStartContract: createWorkspacesStartContractMock,
+};
diff --git a/src/core/public/index.ts b/src/core/public/index.ts
@@ -88,7 +88,7 @@ import {
   HandlerParameters,
 } from './context';
 import { Branding } from '../types';
-import { WorkspacesStart } from './workspace';
+import { WorkspacesStart, WorkspacesSetup } from './workspace';
 
 export { PackageInfo, EnvironmentMode } from '../server/types';
 /** @interal */
@@ -241,6 +241,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
   };
   /** {@link StartServicesAccessor} */
   getStartServices: StartServicesAccessor<TPluginsStart, TStart>;
+  /** {@link WorkspacesSetup} */
+  workspaces: WorkspacesSetup;
 }
 
 /**
@@ -354,4 +356,5 @@ export {
   WorkspacesService,
   WorkspaceAttribute,
   WorkspaceFindOptions,
+  WORKSPACE_ID_QUERYSTRING_NAME,
 } from './workspace';
diff --git a/src/core/public/plugins/plugin_context.ts b/src/core/public/plugins/plugin_context.ts
@@ -121,6 +121,7 @@ export function createPluginSetupContext<
       getBranding: deps.injectedMetadata.getBranding,
     },
     getStartServices: () => plugin.startDependencies,
+    workspaces: deps.workspaces,
   };
 }
 

diff --git a/src/core/public/plugins/plugins_service.test.ts b/src/core/public/plugins/plugins_service.test.ts
@@ -50,7 +50,10 @@ import { applicationServiceMock } from '../application/application_service.mock'
 import { i18nServiceMock } from '../i18n/i18n_service.mock';
 import { overlayServiceMock } from '../overlays/overlay_service.mock';
 import { chromeServiceMock } from '../chrome/chrome_service.mock';
-import { fatalErrorsServiceMock } from '../fatal_errors/fatal_errors_service.mock';
+import {
+  fatalErrorsServiceMock,
+  workspacesServiceMock,
+} from '../fatal_errors/fatal_errors_service.mock';
 import { uiSettingsServiceMock } from '../ui_settings/ui_settings_service.mock';
 import { injectedMetadataServiceMock } from '../injected_metadata/injected_metadata_service.mock';
 import { httpServiceMock } from '../http/http_service.mock';
@@ -108,6 +111,7 @@ describe('PluginsService', () => {
       injectedMetadata: injectedMetadataServiceMock.createStartContract(),
       notifications: notificationServiceMock.createSetupContract(),
       uiSettings: uiSettingsServiceMock.createSetupContract(),
+      workspaces: workspacesServiceMock.createSetupContractMock(),
     };
     mockSetupContext = {
       ...mockSetupDeps,
@@ -127,6 +131,7 @@ describe('PluginsService', () => {
       uiSettings: uiSettingsServiceMock.createStartContract(),
       savedObjects: savedObjectsServiceMock.createStartContract(),
       fatalErrors: fatalErrorsServiceMock.createStartContract(),
+      workspaces: workspacesServiceMock.createStartContract(),
     };
     mockStartContext = {
       ...mockStartDeps,

diff --git a/src/core/public/workspace/consts.ts b/src/core/public/workspace/consts.ts
@@ -0,0 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const WORKSPACES_API_BASE_URL = '/api/workspaces';
+
+export const WORKSPACE_ID_QUERYSTRING_NAME = '_workspace_id_';
diff --git a/src/core/public/workspace/index.ts b/src/core/public/workspace/index.ts
@@ -3,5 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 export { WorkspacesClientContract, WorkspacesClient } from './workspaces_client';
-export { WorkspacesStart, WorkspacesService } from './workspaces_service';
-export { WorkspaceAttribute, WorkspaceFindOptions } from '../../server/types';
+export { WorkspacesStart, WorkspacesService, WorkspacesSetup } from './workspaces_service';
+export type { WorkspaceAttribute, WorkspaceFindOptions } from '../../server/types';
+export { WORKSPACE_ID_QUERYSTRING_NAME } from './consts';
-Original file line number
+Diff line change
@@ Expand Up / @@ -121,6 +121,7 @@ export function createPluginSetupContext< @@
           getBranding: deps.injectedMetadata.getBranding,
         },
         getStartServices: () => plugin.startDependencies,
+        workspaces: deps.workspaces,
       };
     }
@@ Expand Down @@