[8.x] [Advanced Settings] Hide settings that are not applicable to cu…

…rrent solution (#209136) (#211835) # Backport This will backport the following commits from `main` to `8.x`: - [[Advanced Settings] Hide settings that are not applicable to current solution (#209136)](#209136)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Elena Stoeva <59341489+ElenaStoeva@users.noreply.github.com>
elastic · Feb 19, 2025 · 7a729c7 · 7a729c7
1 parent 8c44d22
commit 7a729c7
Show file tree

Hide file tree

Showing 22 changed files with 210 additions and 18 deletions.
diff --git a/src/core/packages/ui-settings/common/index.ts b/src/core/packages/ui-settings/common/index.ts
@@ -11,6 +11,7 @@ export type {
   UiSettingsType,
   ReadonlyModeType,
   DeprecationSettings,
+  UiSettingsSolution,
   UiSettingsParams,
   UserProvidedValues,
   UiSettingsScope,

diff --git a/src/core/packages/ui-settings/common/src/ui_settings.ts b/src/core/packages/ui-settings/common/src/ui_settings.ts
@@ -50,6 +50,8 @@ export interface GetUiSettingsContext {
   request?: KibanaRequest;
 }
 
+export type UiSettingsSolution = 'es' | 'oblt' | 'security';
+
 /**
  * UiSettings parameters defined by the plugins.
  * @public
@@ -116,6 +118,10 @@ export interface UiSettingsParams<T = unknown> {
    * scoped to a namespace. The default value is 'namespace'
    */
   scope?: UiSettingsScope;
+  /** The solution where this setting is applicable.
+   * This field is used to determine whether the setting should be displayed in the Advanced settings app.
+   * If undefined, the setting must be displayed in all solutions. */
+  solution?: UiSettingsSolution;
 }
 
 /**

diff --git a/src/platform/packages/shared/kbn-management/settings/application/application.test.tsx b/src/platform/packages/shared/kbn-management/settings/application/application.test.tsx
@@ -81,6 +81,34 @@ describe('Settings application', () => {
     }
   });
 
+  it("doesn't render settings that are not applicable in the current solution", async () => {
+    const services: SettingsApplicationServices = createSettingsApplicationServicesMock(
+      undefined,
+      'es',
+      'security'
+    );
+
+    const { findByTestId } = render(wrap(<SettingsApplication />, services));
+
+    // The empty state should be rendered since all settings are for es solution and current space solution is security
+    expect(findByTestId(DATA_TEST_SUBJ_SETTINGS_EMPTY_STATE)).toBeTruthy();
+  });
+
+  it('renders settings that are applicable in the current solution', async () => {
+    const services: SettingsApplicationServices = createSettingsApplicationServicesMock(
+      undefined,
+      'oblt',
+      'oblt'
+    );
+
+    const { getByTestId } = render(wrap(<SettingsApplication />, services));
+
+    // The form should be rendered
+    for (const category of spaceCategories) {
+      expect(getByTestId(`${DATA_TEST_SUBJ_SETTINGS_CATEGORY}-${category}`)).toBeInTheDocument();
+    }
+  });
+
   describe('Tabs', () => {
     const spaceSettingsTestSubj = `${DATA_TEST_SUBJ_PREFIX_TAB}-${SPACE_SETTINGS_TAB_ID}`;
     const globalSettingsTestSubj = `${DATA_TEST_SUBJ_PREFIX_TAB}-${GLOBAL_SETTINGS_TAB_ID}`;

diff --git a/src/platform/packages/shared/kbn-management/settings/application/hooks/use_settings.ts b/src/platform/packages/shared/kbn-management/settings/application/hooks/use_settings.ts
@@ -7,10 +7,11 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { useState } from 'react';
+import { useState, useEffect } from 'react';
 import useEffectOnce from 'react-use/lib/useEffectOnce';
 
 import { UiSettingsScope } from '@kbn/core-ui-settings-common';
+import { SolutionView } from '@kbn/spaces-plugin/common';
 import { useServices } from '../services';
 
 /**
@@ -21,13 +22,31 @@ import { useServices } from '../services';
  * @returns An array of settings metadata objects.
  */
 export const useSettings = (scope: UiSettingsScope) => {
-  const { getAllowlistedSettings, subscribeToUpdates } = useServices();
+  const { getAllowlistedSettings, subscribeToUpdates, getActiveSpace, subscribeToActiveSpace } =
+    useServices();
+  const [solutionView, setSolutionView] = useState<SolutionView>();
 
-  const [settings, setSettings] = useState(getAllowlistedSettings(scope));
+  useEffectOnce(() => {
+    const subscription = subscribeToActiveSpace(() => {
+      getActiveSpace().then((space) => {
+        setSolutionView(space.solution);
+      });
+    });
+
+    return () => {
+      subscription.unsubscribe();
+    };
+  });
+
+  const [settings, setSettings] = useState(getAllowlistedSettings(scope, solutionView));
+
+  useEffect(() => {
+    setSettings(getAllowlistedSettings(scope, solutionView));
+  }, [solutionView, scope, getAllowlistedSettings]); // Update settings when solutionView changes
 
   useEffectOnce(() => {
     const subscription = subscribeToUpdates(() => {
-      setSettings(getAllowlistedSettings(scope));
+      setSettings(getAllowlistedSettings(scope, solutionView));
     }, scope);
 
     return () => {

diff --git a/src/platform/packages/shared/kbn-management/settings/application/index.tsx b/src/platform/packages/shared/kbn-management/settings/application/index.tsx
@@ -33,6 +33,7 @@ export const KibanaSettingsApplication = ({
   sectionRegistry,
   application,
   chrome,
+  spaces,
 }: SettingsApplicationKibanaDependencies) => (
   <SettingsApplicationKibanaProvider
     {...{
@@ -46,6 +47,7 @@ export const KibanaSettingsApplication = ({
       sectionRegistry,
       application,
       chrome,
+      spaces,
     }}
   >
     <SettingsApplication />

diff --git a/src/platform/packages/shared/kbn-management/settings/application/mocks/context.tsx b/src/platform/packages/shared/kbn-management/settings/application/mocks/context.tsx
@@ -24,6 +24,8 @@ import {
 } from '@kbn/management-settings-utilities/mocks/settings.mock';
 import { UiSettingsScope } from '@kbn/core-ui-settings-common';
 import { getSettingsCapabilitiesMock } from '@kbn/management-settings-utilities/mocks/capabilities.mock';
+import { UiSettingsSolution } from '@kbn/core-ui-settings-common';
+import { SolutionView } from '@kbn/spaces-plugin/common';
 import { SettingsApplicationProvider, SettingsApplicationServices } from '../services';
 
 const createRootMock = () => {
@@ -42,11 +44,17 @@ const createRootMock = () => {
 };
 
 export const createSettingsApplicationServicesMock = (
-  hasGlobalSettings?: boolean
+  hasGlobalSettings?: boolean,
+  settingsSolution?: UiSettingsSolution,
+  spaceSolution: SolutionView = 'classic'
 ): SettingsApplicationServices => ({
   ...createFormServicesMock(),
   getAllowlistedSettings: (scope: UiSettingsScope) =>
-    scope === 'namespace' ? getSettingsMock() : hasGlobalSettings ? getGlobalSettingsMock() : {},
+    scope === 'namespace'
+      ? getSettingsMock(undefined, undefined, settingsSolution)
+      : hasGlobalSettings
+      ? getGlobalSettingsMock(undefined, undefined, settingsSolution)
+      : {},
   getSections: () => [],
   getCapabilities: getSettingsCapabilitiesMock,
   setBadge: jest.fn(),
@@ -55,6 +63,11 @@ export const createSettingsApplicationServicesMock = (
   subscribeToUpdates: () => new Subscription(),
   addUrlToHistory: jest.fn(),
   getToastsService: jest.fn(),
+  getActiveSpace: () =>
+    Promise.resolve({
+      solution: spaceSolution,
+    }),
+  subscribeToActiveSpace: () => new Subscription(),
 });
 
 export const TestWrapper = ({

diff --git a/src/platform/packages/shared/kbn-management/settings/application/services.tsx b/src/platform/packages/shared/kbn-management/settings/application/services.tsx
@@ -24,9 +24,15 @@ import { UiSettingsScope } from '@kbn/core-ui-settings-common';
 import { RegistryEntry, SectionRegistryStart } from '@kbn/management-settings-section-registry';
 import { ToastsStart } from '@kbn/core-notifications-browser';
 import { ChromeBadge, ChromeStart } from '@kbn/core-chrome-browser';
+import type { SpacesPluginStart } from '@kbn/spaces-plugin/public';
+import type { Space } from '@kbn/spaces-plugin/common';
+import { SolutionView } from '@kbn/spaces-plugin/common';
 
 export interface Services {
-  getAllowlistedSettings: (scope: UiSettingsScope) => Record<string, UiSettingMetadata>;
+  getAllowlistedSettings: (
+    scope: UiSettingsScope,
+    solution: SolutionView | undefined
+  ) => Record<string, UiSettingMetadata>;
   getSections: (scope: UiSettingsScope) => RegistryEntry[];
   getToastsService: () => ToastsStart;
   getCapabilities: () => SettingsCapabilities;
@@ -35,6 +41,8 @@ export interface Services {
   isCustomSetting: (key: string, scope: UiSettingsScope) => boolean;
   isOverriddenSetting: (key: string, scope: UiSettingsScope) => boolean;
   addUrlToHistory: (url: string) => void;
+  getActiveSpace: () => Promise<Pick<Space, 'solution'>>;
+  subscribeToActiveSpace: (fn: () => void) => Subscription;
 }
 
 export type SettingsApplicationServices = Services & FormServices;
@@ -57,6 +65,7 @@ export interface KibanaDependencies {
   };
   application: Pick<ApplicationStart, 'capabilities'>;
   chrome: Pick<ChromeStart, 'setBadge'>;
+  spaces: Pick<SpacesPluginStart, 'getActiveSpace' | 'getActiveSpace$'>;
 }
 
 export type SettingsApplicationKibanaDependencies = KibanaDependencies & FormKibanaDependencies;
@@ -87,6 +96,8 @@ export const SettingsApplicationProvider: FC<PropsWithChildren<SettingsApplicati
     isCustomSetting,
     isOverriddenSetting,
     addUrlToHistory,
+    getActiveSpace,
+    subscribeToActiveSpace,
   } = services;
 
   return (
@@ -101,6 +112,8 @@ export const SettingsApplicationProvider: FC<PropsWithChildren<SettingsApplicati
         isCustomSetting,
         isOverriddenSetting,
         addUrlToHistory,
+        getActiveSpace,
+        subscribeToActiveSpace,
       }}
     >
       <FormProvider
@@ -129,18 +142,25 @@ export const SettingsApplicationKibanaProvider: FC<
     sectionRegistry,
     application,
     chrome,
+    spaces,
   } = dependencies;
   const { client, globalClient } = settings;
 
   const getScopeClient = (scope: UiSettingsScope) => {
     return scope === 'namespace' ? client : globalClient;
   };
 
-  const getAllowlistedSettings = (scope: UiSettingsScope) => {
+  const getAllowlistedSettings = (scope: UiSettingsScope, solution: SolutionView | undefined) => {
     const scopeClient = getScopeClient(scope);
     const rawSettings = Object.fromEntries(
       Object.entries(scopeClient.getAll()).filter(
-        ([settingId, settingDef]) => !settingDef.readonly && !client.isCustom(settingId)
+        ([settingId, settingDef]) =>
+          !settingDef.readonly &&
+          !client.isCustom(settingId) &&
+          (!solution ||
+            solution === 'classic' ||
+            !settingDef.solution ||
+            settingDef.solution === solution)
       )
     );
     return normalizeSettings(rawSettings);
@@ -191,6 +211,10 @@ export const SettingsApplicationKibanaProvider: FC<
     isOverriddenSetting,
     subscribeToUpdates,
     addUrlToHistory: (url: string) => history.push({ pathname: '', search: url }),
+    getActiveSpace: spaces.getActiveSpace,
+    subscribeToActiveSpace: (fn: () => void) => {
+      return spaces.getActiveSpace$().subscribe(fn);
+    },
   };
 
   return (

diff --git a/src/platform/packages/shared/kbn-management/settings/application/tsconfig.json b/src/platform/packages/shared/kbn-management/settings/application/tsconfig.json
@@ -36,5 +36,6 @@
     "@kbn/core-notifications-browser",
     "@kbn/core-chrome-browser",
     "@kbn/core-user-profile-browser-mocks",
+    "@kbn/spaces-plugin",
   ]
 }
diff --git a/src/platform/packages/shared/kbn-management/settings/field_definition/get_definition.ts b/src/platform/packages/shared/kbn-management/settings/field_definition/get_definition.ts
@@ -102,6 +102,7 @@ export const getFieldDefinition = <T extends SettingType>(
     type,
     userValue: savedValue,
     value: defaultValue,
+    solution,
   } = setting;
 
   const { isCustom, isOverridden } = params;
@@ -144,6 +145,7 @@ export const getFieldDefinition = <T extends SettingType>(
     savedValue,
     type,
     unsavedFieldId: `${id}-unsaved`,
+    solution,
   };
 
   // TODO: clintandrewhall - add validation (e.g. `select` contains non-empty `options`)

diff --git a/src/platform/packages/shared/kbn-management/settings/types/field_definition.ts b/src/platform/packages/shared/kbn-management/settings/types/field_definition.ts
@@ -10,7 +10,7 @@
 import { ReactElement } from 'react';
 
 import { UiCounterMetricType } from '@kbn/analytics';
-import { DeprecationSettings } from '@kbn/core-ui-settings-common';
+import { DeprecationSettings, UiSettingsSolution } from '@kbn/core-ui-settings-common';
 
 import { KnownTypeToValue, SettingType } from './setting_type';
 
@@ -88,6 +88,11 @@ export interface FieldDefinition<
   type: T;
   /** An identifier of the field when it has an unsaved change. */
   unsavedFieldId: string;
+  /** The solution where this setting is applicable.
+   * If undefined, the setting must be displayed in all solutions.
+   * @see {@link UiSettingsSolution}
+   */
+  solution?: UiSettingsSolution;
 }
 
 /**

diff --git a/src/platform/packages/shared/kbn-management/settings/utilities/mocks/settings.mock.ts b/src/platform/packages/shared/kbn-management/settings/utilities/mocks/settings.mock.ts
@@ -8,6 +8,7 @@
  */
 
 import { KnownTypeToMetadata, SettingType } from '@kbn/management-settings-types';
+import { UiSettingsSolution } from '@kbn/core-ui-settings-common';
 
 type Settings = {
   [key in Exclude<SettingType, 'json' | 'markdown'>]: KnownTypeToMetadata<key>;
@@ -20,11 +21,13 @@ type Settings = {
  */
 export const getSettingsMock = (
   requiresPageReload: boolean = false,
-  readonly: boolean = false
+  readonly: boolean = false,
+  solution?: UiSettingsSolution
 ): Settings => {
   const defaults = {
     requiresPageReload,
     readonly,
+    solution,
   };
 
   return {
@@ -135,11 +138,13 @@ export const getSettingsMock = (
  */
 export const getGlobalSettingsMock = (
   requiresPageReload: boolean = false,
-  readonly: boolean = false
+  readonly: boolean = false,
+  solution?: UiSettingsSolution
 ) => {
   const defaults = {
     requiresPageReload,
     readonly,
+    solution,
   };
   return {
     globalString: {

diff --git a/src/platform/plugins/private/advanced_settings/kibana.jsonc b/src/platform/plugins/private/advanced_settings/kibana.jsonc
@@ -16,7 +16,8 @@
     ],
     "optionalPlugins": [
       "home",
-      "usageCollection"
+      "usageCollection",
+      "spaces",
     ],
     "requiredBundles": []
   }