feat: introducing workspace level ui settings and hide non-global ui settings from advance settings page

changelogs/fragments/8500.yml

@@ -0,0 +1,2 @@
+feat:
+- Introducing workspace level ui settings and hide non-global ui settings from advance settings page ([#8500](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8500))

src/core/server/index.ts

@@ -93,6 +93,7 @@ import {
   CoreEnvironmentUsageData,
   CoreServicesUsageData,
 } from './core_usage_data';
+import { WorkspaceSetup, WorkspaceStart } from './workspace';
 
 export { CoreUsageData, CoreConfigUsageData, CoreEnvironmentUsageData, CoreServicesUsageData };
 
@@ -480,6 +481,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
   auditTrail: AuditTrailSetup;
   /** {@link DynamicConfigServiceSetup} */
   dynamicConfigService: DynamicConfigServiceSetup;
+  /** {@link WorkspaceSetup} */
+  workspace: WorkspaceSetup;
 }
 
 /**
@@ -521,6 +524,8 @@ export interface CoreStart {
   crossCompatibility: CrossCompatibilityServiceStart;
   /** {@link DynamicConfigServiceStart} */
   dynamicConfig: DynamicConfigServiceStart;
+  /** {@link WorkspaceStart} */
+  workspace: WorkspaceStart;
 }
 
 export {

src/core/server/internal_types.ts

@@ -54,6 +54,7 @@ import { InternalLoggingServiceSetup } from './logging';
 import { CoreUsageDataStart } from './core_usage_data';
 import { InternalSecurityServiceSetup } from './security/types';
 import { CrossCompatibilityServiceStart } from './cross_compatibility';
+import { InternalWorkspaceServiceSetup, InternalWorkspaceServiceStart } from './workspace';
 
 /** @internal */
 export interface InternalCoreSetup {
@@ -72,6 +73,7 @@ export interface InternalCoreSetup {
   metrics: InternalMetricsServiceSetup;
   security: InternalSecurityServiceSetup;
   dynamicConfig: InternalDynamicConfigServiceSetup;
+  workspace: InternalWorkspaceServiceSetup;
 }
 
 /**
@@ -88,6 +90,7 @@ export interface InternalCoreStart {
   coreUsageData: CoreUsageDataStart;
   crossCompatibility: CrossCompatibilityServiceStart;
   dynamicConfig: InternalDynamicConfigServiceStart;
+  workspace: InternalWorkspaceServiceStart;
 }
 
 /**

src/core/server/legacy/legacy_service.test.ts

@@ -63,6 +63,7 @@ import { auditTrailServiceMock } from '../audit_trail/audit_trail_service.mock';
 import { loggingServiceMock } from '../logging/logging_service.mock';
 import { metricsServiceMock } from '../metrics/metrics_service.mock';
 import { securityServiceMock } from '../security/security_service.mock';
+import { workspaceServiceMock } from '../workspace/mocks';
 
 const MockOsdServer: jest.Mock<OsdServer> = OsdServer as any;
 
@@ -114,6 +115,7 @@ beforeEach(() => {
       metrics: metricsServiceMock.createInternalSetupContract(),
       security: securityServiceMock.createSetupContract(),
       dynamicConfig: dynamicConfigServiceMock.createInternalSetupContract(),
+      workspace: workspaceServiceMock.createInternalSetupContract(),
     },
     plugins: { 'plugin-id': 'plugin-value' },
     uiPlugins: {

src/core/server/legacy/legacy_service.ts

@@ -239,6 +239,7 @@ export class LegacyService implements CoreService {
         getAsyncLocalStore: startDeps.core.dynamicConfig.getAsyncLocalStore,
         createStoreFromRequest: startDeps.core.dynamicConfig.createStoreFromRequest,
       },
+      workspace: startDeps.core.workspace,
     };
 
     const router = setupDeps.core.http.createRouter('', this.legacyId);
@@ -308,6 +309,7 @@ export class LegacyService implements CoreService {
       auditTrail: setupDeps.core.auditTrail,
       getStartServices: () => Promise.resolve([coreStart, startDeps.plugins, {}]),
       security: setupDeps.core.security,
+      workspace: setupDeps.core.workspace,
     };
 
     // eslint-disable-next-line @typescript-eslint/no-var-requires

src/core/server/mocks.ts

@@ -53,6 +53,7 @@ import { coreUsageDataServiceMock } from './core_usage_data/core_usage_data_serv
 import { securityServiceMock } from './security/security_service.mock';
 import { crossCompatibilityServiceMock } from './cross_compatibility/cross_compatibility.mock';
 import { dynamicConfigServiceMock } from './config/dynamic_config_service.mock';
+import { workspaceServiceMock } from './workspace/mocks';
 
 export { configServiceMock } from './config/mocks';
 export { dynamicConfigServiceMock } from './config/mocks';
@@ -170,6 +171,7 @@ function createCoreSetupMock({
       .mockResolvedValue([createCoreStartMock(), pluginStartDeps, pluginStartContract]),
     security: securityServiceMock.createSetupContract(),
     dynamicConfigService: dynamicConfigServiceMock.createSetupContract(),
+    workspace: workspaceServiceMock.createSetupContract(),
   };
 
   return mock;
@@ -187,6 +189,7 @@ function createCoreStartMock() {
     coreUsageData: coreUsageDataServiceMock.createStartContract(),
     crossCompatibility: crossCompatibilityServiceMock.createStartContract(),
     dynamicConfig: dynamicConfigServiceMock.createStartContract(),
+    workspace: workspaceServiceMock.createStartContract(),
   };
 
   return mock;
@@ -209,6 +212,7 @@ function createInternalCoreSetupMock() {
     metrics: metricsServiceMock.createInternalSetupContract(),
     security: securityServiceMock.createSetupContract(),
     dynamicConfig: dynamicConfigServiceMock.createInternalSetupContract(),
+    workspace: workspaceServiceMock.createInternalSetupContract(),
   };
   return setupDeps;
 }
@@ -225,6 +229,7 @@ function createInternalCoreStartMock() {
     coreUsageData: coreUsageDataServiceMock.createStartContract(),
     crossCompatibility: crossCompatibilityServiceMock.createStartContract(),
     dynamicConfig: dynamicConfigServiceMock.createInternalStartContract(),
+    workspace: workspaceServiceMock.createInternalStartContract(),
   };
   return startDeps;
 }

src/core/server/plugins/plugin_context.ts

@@ -226,6 +226,7 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
       registerAsyncLocalStoreRequestHeader: deps.dynamicConfig.registerAsyncLocalStoreRequestHeader,
       getStartService: deps.dynamicConfig.getStartService,
     },
+    workspace: deps.workspace,
   };
 }
 
@@ -282,5 +283,6 @@ export function createPluginStartContext<TPlugin, TPluginDependencies>(
       getClient: deps.dynamicConfig.getClient,
       createStoreFromRequest: deps.dynamicConfig.createStoreFromRequest,
     },
+    workspace: deps.workspace,
   };
 }

src/core/server/server.ts

@@ -71,6 +71,7 @@ import { InternalCoreSetup, InternalCoreStart, ServiceConfigDescriptor } from '.
 import { CoreUsageDataService } from './core_usage_data';
 import { CoreRouteHandlerContext } from './core_route_handler_context';
 import { DynamicConfigService } from './config/dynamic_config_service';
+import { WorkspaceService } from './workspace/workspace_service';
 
 const coreId = Symbol('core');
 const rootConfigPath = '';
@@ -88,6 +89,7 @@ export class Server {
   private readonly plugins: PluginsService;
   private readonly savedObjects: SavedObjectsService;
   private readonly uiSettings: UiSettingsService;
+  private readonly workspace: WorkspaceService;
   private readonly environment: EnvironmentService;
   private readonly metrics: MetricsService;
   private readonly httpResources: HttpResourcesService;
@@ -130,6 +132,7 @@ export class Server {
     this.opensearch = new OpenSearchService(core);
     this.savedObjects = new SavedObjectsService(core);
     this.uiSettings = new UiSettingsService(core);
+    this.workspace = new WorkspaceService(core);
     this.capabilities = new CapabilitiesService(core);
     this.environment = new EnvironmentService(core);
     this.metrics = new MetricsService(core);
@@ -199,6 +202,7 @@ export class Server {
       http: httpSetup,
       savedObjects: savedObjectsSetup,
     });
+    const workspaceSetup = await this.workspace.setup();
 
     const metricsSetup = await this.metrics.setup({ http: httpSetup });
 
@@ -247,6 +251,7 @@ export class Server {
       metrics: metricsSetup,
       security: securitySetup,
       dynamicConfig: dynamicConfigServiceSetup,
+      workspace: workspaceSetup,
     };
 
     const pluginsSetup = await this.plugins.setup(coreSetup);
@@ -285,6 +290,7 @@ export class Server {
     soStartSpan?.end();
     const capabilitiesStart = this.capabilities.start();
     const uiSettingsStart = await this.uiSettings.start();
+    const workspaceStart = await this.workspace.start();
     const metricsStart = await this.metrics.start();
     const httpStart = this.http.getStartContract();
     const coreUsageDataStart = this.coreUsageData.start({
@@ -308,6 +314,7 @@ export class Server {
       coreUsageData: coreUsageDataStart,
       crossCompatibility: crossCompatibilityServiceStart,
       dynamicConfig: dynamicConfigServiceStart,
+      workspace: workspaceStart,
     };
 
     const pluginsStart = await this.plugins.start(this.coreStart);

src/core/server/workspace/index.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { PublicMethodsOf } from '@osd/utility-types';
+
+import {
+  InternalWorkspaceServiceSetup,
+  InternalWorkspaceServiceStart,
+  WorkspaceService,
+} from './workspace_service';
+
+export { InternalWorkspaceServiceSetup, InternalWorkspaceServiceStart } from './workspace_service';
+
+export type WorkspaceSetup = InternalWorkspaceServiceSetup;
+export type WorkspaceStart = InternalWorkspaceServiceStart;
+
+export type IWorkspaceService = PublicMethodsOf<WorkspaceService>;

src/core/server/workspace/mocks.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { IWorkspaceService } from '.';
+import { InternalWorkspaceServiceSetup, InternalWorkspaceServiceStart } from './workspace_service';
+
+const createWorkspaceServiceMock = () => {
+  const mocked: jest.Mocked<IWorkspaceService> = {
+    setup: jest.fn().mockReturnValue(createInternalSetupContractMock()),
+    start: jest.fn().mockReturnValue({}),
+    stop: jest.fn(),
+  };
+
+  return mocked;
+};
+
+const createInternalSetupContractMock = () => {
+  const mocked: jest.Mocked<InternalWorkspaceServiceSetup> = {
+    isWorkspaceEnabled: jest.fn(),
+  };
+
+  return mocked;
+};
+const createSetupContractMock = createInternalSetupContractMock;
+
+const createInternalStartContractMock = () => {
+  const mocked: jest.Mocked<InternalWorkspaceServiceStart> = {
+    isWorkspaceEnabled: jest.fn(),
+  };
+
+  return mocked;
+};
+const createStartContractMock = createInternalStartContractMock;
+
+export const workspaceServiceMock = {
+  create: createWorkspaceServiceMock,
+  createInternalSetupContract: createInternalSetupContractMock,
+  createInternalStartContract: createInternalStartContractMock,
+  createSetupContract: createSetupContractMock,
+  createStartContract: createStartContractMock,
+};

src/core/server/workspace/workspace_service.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Observable } from 'rxjs';
+import { first } from 'rxjs/operators';
+
+import { CoreService } from '../../types';
+import { CoreContext } from '../core_context';
+import { Logger } from '../logging';
+
+export interface InternalWorkspaceServiceSetup {
+  isWorkspaceEnabled: () => boolean;
+}
+
+export interface InternalWorkspaceServiceStart {
+  isWorkspaceEnabled: () => boolean;
+}
+
+/** @internal */
+export class WorkspaceService
+  implements CoreService<InternalWorkspaceServiceSetup, InternalWorkspaceServiceStart> {
+  private readonly log: Logger;
+  private readonly config$: Observable<{ enabled: boolean }>;
+
+  constructor(private readonly coreContext: CoreContext) {
+    this.log = this.coreContext.logger.get('workspace-service');
+    this.config$ = this.coreContext.configService.atPath<{ enabled: boolean }>('workspace');
+  }
+
+  public async setup(): Promise<InternalWorkspaceServiceSetup> {
+    this.log.debug('Setting up workspace service');
+
+    const workspaceConfig = await this.config$.pipe(first()).toPromise();
+
+    return {
+      isWorkspaceEnabled: () => workspaceConfig.enabled,
+    };
+  }
+
+  public async start(): Promise<InternalWorkspaceServiceStart> {
+    this.log.debug('Starting workspace service');
+
+    const workspaceConfig = await this.config$.pipe(first()).toPromise();
+
+    return {
+      isWorkspaceEnabled: () => workspaceConfig.enabled,
+    };
+  }
+
+  public async stop() {}
+}

src/core/types/ui_settings.ts

@@ -63,6 +63,7 @@ export interface DeprecationSettings {
 export enum UiSettingScope {
   GLOBAL = 'global',
   USER = 'user',
+  WORKSPACE = 'workspace',
 }
 
 /**

src/plugins/advanced_settings/public/management_app/advanced_settings.tsx

@@ -173,7 +173,23 @@
     const all = config.getAll();
     const userSettingsEnabled = config.get('theme:enableUserControl');
     return Object.entries(all)
-      .filter(([, setting]) => setting.scope !== UiSettingScope.USER)
+      .filter(([, setting]) => {
+        const scope = setting.scope;
+        // if scope is not defined, then it's a global ui setting
+        if (!scope) {
+          return true;
+        }
+
+        if (typeof scope === 'string') {
+          return scope === UiSettingScope.GLOBAL;
+        }
+
+        if (Array.isArray(scope)) {
+          return scope.includes(UiSettingScope.GLOBAL);
+        }
+
+        return false;
+      })
       .map((setting) => {
         return toEditableConfig({
           def: setting[1],

src/plugins/data/server/plugin.ts

@@ -106,7 +106,7 @@
     this.autocompleteService.setup(core);
     this.dqlTelemetryService.setup(core, { usageCollection });
 
-    core.uiSettings.register(getUiSettings());
+    core.uiSettings.register(getUiSettings(core.workspace.isWorkspaceEnabled()));
 
     const searchSetup = await this.searchService.setup(core, {
       registerFunction: expressions.registerFunction,

src/plugins/data/server/ui_settings.ts

@@ -34,6 +34,10 @@ import { UiSettingsParams } from 'opensearch-dashboards/server';
 // @ts-ignore untyped module
 import numeralLanguages from '@elastic/numeral/languages';
 import { DEFAULT_QUERY_LANGUAGE, UI_SETTINGS } from '../common';
+// cannot import from core/server due to src/core/server/saved_objects/opensearch_query.js which
+// export { opensearchKuery } from '../../../plugins/data/server';
+// eslint-disable-next-line @osd/eslint/no-restricted-paths
+import { UiSettingScope } from '../../../core/server/ui_settings/types';
 
 const luceneQueryLanguageLabel = i18n.translate('data.advancedSettings.searchQueryLanguageLucene', {
   defaultMessage: 'Lucene',
@@ -79,7 +83,9 @@ const numeralLanguageIds = [
   }),
 ];
 
-export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
+export function getUiSettings(
+  workspaceEnabled: boolean
+): Record<string, UiSettingsParams<unknown>> {
   return {
     [UI_SETTINGS.META_FIELDS]: {
       name: i18n.translate('data.advancedSettings.metaFieldsTitle', {
@@ -200,6 +206,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
         defaultMessage: 'The index to access if no index is set',
       }),
       schema: schema.nullable(schema.string()),
+      scope: workspaceEnabled ? UiSettingScope.WORKSPACE : UiSettingScope.GLOBAL,
     },
     [UI_SETTINGS.COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX]: {
       name: i18n.translate('data.advancedSettings.courier.ignoreFilterTitle', {
@@ -757,7 +764,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
       }),
       value: ['none'],
       description: i18n.translate('data.advancedSettings.searchQueryLanguageBlocklistText', {
-        defaultMessage: `Additional languages that are blocked from being used in the query editor. 
+        defaultMessage: `Additional languages that are blocked from being used in the query editor.
          <strong>Note</strong>: DQL and Lucene will not be blocked even if set.`,
       }),
       schema: schema.arrayOf(schema.string()),