Per User Dark Mode Preference

packages/core/http/core-http-request-handler-context-server-internal/src/core_route_handler_context.ts

@@ -52,7 +52,8 @@ export class CoreRouteHandlerContext implements CoreRequestHandlerContext {
     this.savedObjects = new CoreSavedObjectsRouteHandlerContext(coreStart.savedObjects, request);
     this.uiSettings = new CoreUiSettingsRouteHandlerContext(
       coreStart.uiSettings,
-      this.savedObjects
+      this.savedObjects,
+      request
     );
     this.deprecations = new CoreDeprecationsRouteHandlerContext(
       coreStart.deprecations,

packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts

@@ -320,6 +320,9 @@ export function createPluginStartContext<TPlugin, TPluginDependencies>(
     uiSettings: {
       asScopedToClient: deps.uiSettings.asScopedToClient,
       globalAsScopedToClient: deps.uiSettings.globalAsScopedToClient,
+      userAsScopedToClient: deps.uiSettings.userAsScopedToClient,
+      setUserProfileSettingsClientFactoryProvider:
+        deps.uiSettings.setUserProfileSettingsClientFactoryProvider,
     },
     coreUsageData: deps.coreUsageData,
   };

packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx

@@ -15,7 +15,7 @@ import type { ThemeVersion } from '@kbn/ui-shared-deps-npm';
 
 import type { CoreContext } from '@kbn/core-base-server-internal';
 import type { KibanaRequest, HttpAuth } from '@kbn/core-http-server';
-import type { IUiSettingsClient } from '@kbn/core-ui-settings-server';
+import type { IUiSettingsClient, IUserUiSettingsClient } from '@kbn/core-ui-settings-server';
 import type { UiPlugins } from '@kbn/core-plugins-base-server-internal';
 import { CustomBranding } from '@kbn/core-custom-branding-common';
 import { Template } from './views';
@@ -89,6 +89,7 @@ export class RenderingService {
     uiSettings: {
       client: IUiSettingsClient;
       globalClient: IUiSettingsClient;
+      userClient: IUserUiSettingsClient;
     },
     { isAnonymousPage = false, vars, includeExposedConfigKeys }: IRenderOptions = {}
   ) {
@@ -101,6 +102,7 @@ export class RenderingService {
     const buildNum = env.packageInfo.buildNum;
     const basePath = http.basePath.get(request);
     const { serverBasePath, publicBaseUrl } = http.basePath;
+
     const settings = {
       defaults: uiSettings.client?.getRegistered() ?? {},
       user: isAnonymousPage ? {} : await uiSettings.client?.getUserProvided(),
@@ -109,6 +111,11 @@ export class RenderingService {
       defaults: uiSettings.globalClient?.getRegistered() ?? {},
       user: isAnonymousPage ? {} : await uiSettings.globalClient?.getUserProvided(),
     };
+    const userSettings = {
+      defaults: {},
+      user: isAnonymousPage ? {} : await uiSettings.userClient?.getUserProfileSettings(),
+    };
+
     let clusterInfo = {};
     let branding: CustomBranding = {};
     try {
@@ -129,7 +136,15 @@ export class RenderingService {
       // swallow error
     }
 
-    const darkMode = getSettingValue('theme:darkMode', settings, Boolean);
+    // If the user profile switch has been toggled, the value takes precedence
+    const userTheme: string = userSettings.user.darkMode;
+    let darkMode;
+    if (userTheme) {
+      darkMode = userTheme === 'dark';
+    } else {
+      darkMode = getSettingValue('theme:darkMode', settings, Boolean);
+    }
+
     const themeVersion: ThemeVersion = 'v8';
 
     const stylesheetPaths = getStylesheetPaths({

packages/core/ui-settings/core-ui-settings-common/src/ui_settings.ts

@@ -106,4 +106,4 @@ export interface UserProvidedValues<T = any> {
 /**
  * Denotes the scope of the setting
  */
-export type UiSettingsScope = 'namespace' | 'global';
+export type UiSettingsScope = 'namespace' | 'global' | 'user';

packages/core/ui-settings/core-ui-settings-server-internal/src/clients/index.ts

@@ -7,6 +7,7 @@
  */
 
 export { UiSettingsClient } from './ui_settings_client';
+export { UiSettingsUserClient } from './ui_settings_user_client';
 export { UiSettingsGlobalClient } from './ui_settings_global_client';
 export { UiSettingsClientFactory } from './ui_settings_client_factory';
 export { UiSettingsDefaultsClient } from './ui_settings_defaults_client';

packages/core/ui-settings/core-ui-settings-server-internal/src/clients/ui_settings_client_factory.ts

@@ -6,17 +6,21 @@
  * Side Public License, v 1.
  */
 
+import { KibanaRequest } from '@kbn/core-http-server';
 import type { UiSettingsServiceOptions } from '../..';
 import { UiSettingsClient } from './ui_settings_client';
 import { UiSettingsGlobalClient } from './ui_settings_global_client';
+import { UiSettingsUserClient } from './ui_settings_user_client';
 
 export class UiSettingsClientFactory {
-  public static create = (options: UiSettingsServiceOptions) => {
+  public static create = (options: UiSettingsServiceOptions, request?: KibanaRequest) => {
     switch (options.type) {
       case 'config':
         return new UiSettingsClient(options);
       case 'config-global':
         return new UiSettingsGlobalClient(options);
+      case 'config-user':
+        return new UiSettingsUserClient(options, request);
       default:
         throw new Error('Unsupported client error');
     }

packages/core/ui-settings/core-ui-settings-server-internal/src/clients/ui_settings_user_client.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { KibanaRequest } from '@kbn/core-http-server';
+import type { IUserUiSettingsClient } from '@kbn/core-ui-settings-server/src';
+import type { UiSettingsServiceOptions } from '../types';
+import { BaseUiSettingsClient } from './base_ui_settings_client';
+
+interface UserProvidedValue<T = unknown> {
+  userValue?: T;
+  isOverridden?: boolean;
+}
+
+type UserProvided<T = unknown> = Record<string, UserProvidedValue<T>>;
+
+/**
+ * Common logic for setting / removing keys in a {@link IUserUiSettingsClient} implementation
+ */
+export class UiSettingsUserClient extends BaseUiSettingsClient implements IUserUiSettingsClient {
+  private readonly userProfileSettingsClient: UiSettingsServiceOptions['userProfileSettingsClient'];
+  private readonly request?: KibanaRequest;
+
+  constructor(options: UiSettingsServiceOptions, request?: KibanaRequest) {
+    super(options);
+    const { userProfileSettingsClient } = options;
+    this.userProfileSettingsClient = userProfileSettingsClient;
+    this.request = request;
+  }
+
+  async getUserProfileSettings(): Promise<Record<string, string>> {
+    let result = {} as Record<string, string>;
+
+    if (this.request) {
+      result = (await this.userProfileSettingsClient?.get(this.request)) || {};
+    } else {
+      this.log.warn('Request not set, unable to retrieve User Settings');
+    }
+
+    return result;
+  }
+
+  async getUserProvided<T = unknown>(): Promise<UserProvided<T>> {
+    this.log.warn('`getUserProvided` operation is not supported for User Settings.');
+    return {};
+  }
+
+  async setMany(changes: Record<string, any>) {
+    this.log.warn('`setMany` operation is not supported for User Settings.');
+  }
+
+  async set(key: string, value: any) {
+    this.log.warn('`set` operation is not supported for User Settings.');
+  }
+
+  async remove(key: string) {
+    this.log.warn('`remove` operation is not supported for User Settings.');
+  }
+
+  async removeMany(keys: string[]) {
+    this.log.warn('`removeMany` operation is not supported for User Settings.');
+  }
+}

packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts

@@ -28,7 +28,7 @@ interface Options {
   buildNum: number;
   log: Logger;
   handleWriteErrors: boolean;
-  type: 'config' | 'config-global';
+  type: 'config' | 'config-global' | 'config-user';
 }
 
 export async function createOrUpgradeSavedConfig(

packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/get_upgradeable_config.ts

@@ -34,7 +34,7 @@ export async function getUpgradeableConfig({
 }: {
   savedObjectsClient: SavedObjectsClientContract;
   version: string;
-  type: 'config' | 'config-global';
+  type: 'config' | 'config-global' | 'config-user';
 }) {
   // attempt to find a config we can upgrade
   const { saved_objects: savedConfigs } =

packages/core/ui-settings/core-ui-settings-server-internal/src/types.ts

@@ -14,6 +14,7 @@ import type {
 import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server';
 import type { UiSettingsParams } from '@kbn/core-ui-settings-common';
 import type { Logger } from '@kbn/logging';
+import { UserProfileSettingsClientContract } from '@kbn/core-ui-settings-server/src/contracts';
 
 /** @internal */
 export interface InternalUiSettingsServicePreboot {
@@ -31,11 +32,12 @@ export type InternalUiSettingsServiceStart = UiSettingsServiceStart;
 
 /** @internal */
 export interface UiSettingsServiceOptions {
-  type: 'config' | 'config-global';
+  type: 'config' | 'config-global' | 'config-user';
   id: string;
   buildNum: number;
   savedObjectsClient: SavedObjectsClientContract;
   overrides?: Record<string, any>;
   defaults?: Record<string, UiSettingsParams>;
   log: Logger;
+  userProfileSettingsClient?: UserProfileSettingsClientContract;
 }

packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_route_handler_context.ts

@@ -10,7 +10,9 @@ import type { CoreSavedObjectsRouteHandlerContext } from '@kbn/core-saved-object
 import type {
   UiSettingsRequestHandlerContext,
   IUiSettingsClient,
+  IUserUiSettingsClient,
 } from '@kbn/core-ui-settings-server';
+import { KibanaRequest } from '@kbn/core-http-server';
 import type { InternalUiSettingsServiceStart } from './types';
 
 /**
@@ -20,10 +22,12 @@ import type { InternalUiSettingsServiceStart } from './types';
 export class CoreUiSettingsRouteHandlerContext implements UiSettingsRequestHandlerContext {
   #client?: IUiSettingsClient;
   #globalClient?: IUiSettingsClient;
+  #userClient?: IUserUiSettingsClient;
 
   constructor(
     private readonly uiSettingsStart: InternalUiSettingsServiceStart,
-    private readonly savedObjectsRouterHandlerContext: CoreSavedObjectsRouteHandlerContext
+    private readonly savedObjectsRouterHandlerContext: CoreSavedObjectsRouteHandlerContext,
+    private readonly request: KibanaRequest
   ) {}
 
   public get client() {
@@ -43,4 +47,14 @@ export class CoreUiSettingsRouteHandlerContext implements UiSettingsRequestHandl
     }
     return this.#globalClient;
   }
+
+  public get userClient() {
+    if (this.#userClient == null) {
+      this.#userClient = this.uiSettingsStart.userAsScopedToClient(
+        this.savedObjectsRouterHandlerContext.client,
+        this.request
+      );
+    }
+    return this.#userClient;
+  }
 }

packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts

@@ -15,8 +15,18 @@ import type { InternalHttpServiceSetup } from '@kbn/core-http-server-internal';
 import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server';
 import type { InternalSavedObjectsServiceSetup } from '@kbn/core-saved-objects-server-internal';
 import type { UiSettingsParams, UiSettingsScope } from '@kbn/core-ui-settings-common';
+import type { KibanaRequest } from '@kbn/core-http-server';
+import type {
+  UserProfileSettingsClientContract,
+  UserProfileSettingsClientFactoryProvider,
+} from '@kbn/core-ui-settings-server/src/contracts';
 import { UiSettingsConfigType, uiSettingsConfig as uiConfigDefinition } from './ui_settings_config';
-import { UiSettingsClient, UiSettingsClientFactory, UiSettingsGlobalClient } from './clients';
+import {
+  UiSettingsClient,
+  UiSettingsClientFactory,
+  UiSettingsGlobalClient,
+  UiSettingsUserClient,
+} from './clients';
 import type {
   InternalUiSettingsServicePreboot,
   InternalUiSettingsServiceSetup,
@@ -36,6 +46,8 @@ type ClientType<T> = T extends 'global'
   ? UiSettingsGlobalClient
   : T extends 'namespace'
   ? UiSettingsClient
+  : T extends 'user'
+  ? UiSettingsUserClient
   : never;
 
 /** @internal */
@@ -48,6 +60,7 @@ export class UiSettingsService
   private readonly uiSettingsDefaults = new Map<string, UiSettingsParams>();
   private readonly uiSettingsGlobalDefaults = new Map<string, UiSettingsParams>();
   private overrides: Record<string, any> = {};
+  private userProfileSettingsClientFactoryProvider?: UserProfileSettingsClientFactoryProvider;
 
   constructor(private readonly coreContext: CoreContext) {
     this.log = coreContext.logger.get('ui-settings-service');
@@ -96,11 +109,22 @@ export class UiSettingsService
     return {
       asScopedToClient: this.getScopedClientFactory('namespace'),
       globalAsScopedToClient: this.getScopedClientFactory('global'),
+      userAsScopedToClient: this.getUserClientFactory<'user'>(),
+      setUserProfileSettingsClientFactoryProvider:
+        this.setUserProfileSettingsClientFactoryProvider(),
     };
   }
 
   public async stop() {}
 
+  private setUserProfileSettingsClientFactoryProvider(): (
+    provider: UserProfileSettingsClientFactoryProvider
+  ) => void {
+    return (provider: UserProfileSettingsClientFactoryProvider) => {
+      this.userProfileSettingsClientFactoryProvider = provider;
+    };
+  }
+
   private getScopedClientFactory<T extends UiSettingsScope>(
     scope: UiSettingsScope
   ): (savedObjectsClient: SavedObjectsClientContract) => ClientType<T> {
@@ -118,10 +142,43 @@ export class UiSettingsService
         overrides: isNamespaceScope ? this.overrides : {},
         log: this.log,
       };
+
       return UiSettingsClientFactory.create(options) as ClientType<T>;
     };
   }
 
+  private getUserClientFactory<T extends UiSettingsScope>(): (
+    savedObjectsClient: SavedObjectsClientContract,
+    request: KibanaRequest
+  ) => ClientType<T> {
+    const { version, buildNum } = this.coreContext.env.packageInfo;
+
+    return (
+      savedObjectsClient: SavedObjectsClientContract,
+      request: KibanaRequest
+    ): ClientType<T> => {
+      let userProfileSettingsClient: UserProfileSettingsClientContract | undefined;
+
+      if (this.userProfileSettingsClientFactoryProvider) {
+        const userProfilesClientFactory = this.userProfileSettingsClientFactoryProvider();
+        userProfileSettingsClient = userProfilesClientFactory();
+      }
+
+      const options = {
+        id: version,
+        buildNum,
+        log: this.log,
+        savedObjectsClient,
+        type: 'config-user' as 'config' | 'config-global' | 'config-user',
+        defaults: {},
+        ...(userProfileSettingsClient && { userProfileSettingsClient }),
+        overrides: {},
+      };
+
+      return UiSettingsClientFactory.create(options, request) as ClientType<T>;
+    };
+  }
+
   private register = (settings: Record<string, UiSettingsParams> = {}) => {
     Object.entries(settings).forEach(([key, value]) => {
       if (this.uiSettingsDefaults.has(key)) {

packages/core/ui-settings/core-ui-settings-server/index.ts

@@ -8,6 +8,7 @@
 
 export type {
   IUiSettingsClient,
+  IUserUiSettingsClient,
   UiSettingsServiceSetup,
   UiSettingsServiceStart,
   UiSettingsRequestHandlerContext,