refactor: move workspace uiSettings registration to workspace service

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

src/core/server/server.ts

@@ -178,6 +178,7 @@ export class Server {
     await this.workspaces.setup({
       http: httpSetup,
       savedObject: savedObjectsSetup,
+      uiSettings: uiSettingsSetup,
     });
 
     const statusSetup = await this.status.setup({

src/core/server/ui_settings/settings/index.test.ts

@@ -36,7 +36,6 @@ import { getNotificationsSettings } from './notifications';
 import { getThemeSettings } from './theme';
 import { getCoreSettings } from './index';
 import { getStateSettings } from './state';
-import { getWorkspaceSettings } from './workspace';
 
 describe('getCoreSettings', () => {
   it('should not have setting overlaps', () => {
@@ -49,7 +48,6 @@ describe('getCoreSettings', () => {
       getNotificationsSettings(),
       getThemeSettings(),
       getStateSettings(),
-      getWorkspaceSettings(),
     ].reduce((sum, settings) => sum + Object.keys(settings).length, 0);
 
     expect(coreSettingsLength).toBe(summedLength);

src/core/server/ui_settings/settings/index.ts

@@ -36,7 +36,6 @@ import { getNavigationSettings } from './navigation';
 import { getNotificationsSettings } from './notifications';
 import { getThemeSettings } from './theme';
 import { getStateSettings } from './state';
-import { getWorkspaceSettings } from './workspace';
 
 export const getCoreSettings = (): Record<string, UiSettingsParams> => {
   return {
@@ -47,6 +46,5 @@ export const getCoreSettings = (): Record<string, UiSettingsParams> => {
     ...getNotificationsSettings(),
     ...getThemeSettings(),
     ...getStateSettings(),
-    ...getWorkspaceSettings(),
   };
 };

src/core/server/workspaces/ui_settings.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { i18n } from '@osd/i18n';
+import { schema } from '@osd/config-schema';
+
+import { UiSettingsParams } from 'opensearch-dashboards/server';
+
+export const uiSettings: Record<string, UiSettingsParams> = {
+  'workspace:enabled': {
+    name: i18n.translate('core.ui_settings.params.workspace.enableWorkspaceTitle', {
+      defaultMessage: 'Enable Workspace',
+    }),
+    value: false,
+    requiresPageReload: true,
+    description: i18n.translate('core.ui_settings.params.workspace.enableWorkspaceTitle', {
+      defaultMessage: 'Enable or disable OpenSearch Dashboards Workspace',
+    }),
+    category: ['workspace'],
+    schema: schema.boolean(),
+  },
+};

src/core/server/workspaces/workspaces_service.ts

@@ -12,6 +12,8 @@ import { InternalSavedObjectsServiceSetup } from '../saved_objects';
 import { IWorkspaceDBImpl } from './types';
 import { WorkspacesClientWithSavedObject } from './workspaces_client';
 import { WorkspaceSavedObjectsClientWrapper } from './saved_objects';
+import { InternalUiSettingsServiceSetup } from '../ui_settings';
+import { uiSettings } from './ui_settings';
 
 export interface WorkspacesServiceSetup {
   client: IWorkspaceDBImpl;
@@ -24,6 +26,7 @@ export interface WorkspacesServiceStart {
 export interface WorkspacesSetupDeps {
   http: InternalHttpServiceSetup;
   savedObject: InternalSavedObjectsServiceSetup;
+  uiSettings: InternalUiSettingsServiceSetup;
 }
 
 export type InternalWorkspacesServiceSetup = WorkspacesServiceSetup;
@@ -58,6 +61,8 @@ export class WorkspacesService
   public async setup(setupDeps: WorkspacesSetupDeps): Promise<InternalWorkspacesServiceSetup> {
     this.logger.debug('Setting up Workspaces service');
 
+    setupDeps.uiSettings.register(uiSettings);
+
     this.client = new WorkspacesClientWithSavedObject(setupDeps);
 
     await this.client.setup(setupDeps);