[Workspace] Add User level setting

changelogs/fragments/7953.yml

@@ -0,0 +1,2 @@
+feat:
+- [Workspace] Support user personal settings ([#7953](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7953))

src/core/server/index.ts

@@ -358,6 +358,7 @@ export {
   StringValidation,
   StringValidationRegex,
   StringValidationRegexString,
+  CURRENT_USER,
 } from './ui_settings';
 
 export {

src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts

@@ -155,6 +155,7 @@ describe('uiSettings/createOrUpgradeSavedConfig', function () {
             Object {
               "newVersion": "4.0.1",
               "prevVersion": "4.0.0",
+              "userLevel": false,
             },
           ],
         ]

src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts

@@ -35,24 +35,27 @@ import { SavedObjectsErrorHelpers } from '../../saved_objects/';
 import { Logger } from '../../logging';
 
 import { getUpgradeableConfig } from './get_upgradeable_config';
+import { CURRENT_USER } from '../ui_settings_client';
 
 interface Options {
   savedObjectsClient: SavedObjectsClientContract;
   version: string;
   buildNum: number;
   log: Logger;
   handleWriteErrors: boolean;
+  userLevel?: boolean;
 }
 
 export async function createOrUpgradeSavedConfig(
   options: Options
 ): Promise<Record<string, any> | undefined> {
-  const { savedObjectsClient, version, buildNum, log, handleWriteErrors } = options;
+  const { savedObjectsClient, version, buildNum, log, handleWriteErrors, userLevel } = options;
 
   // try to find an older config we can upgrade
   const upgradeableConfig = await getUpgradeableConfig({
     savedObjectsClient,
     version,
+    userLevel,
   });
 
   // default to the attributes of the upgradeableConfig if available
@@ -62,8 +65,9 @@ export async function createOrUpgradeSavedConfig(
   );
 
   try {
+    const docId = userLevel ? `${CURRENT_USER}_${version}` : version;
     // create the new SavedConfig
-    await savedObjectsClient.create('config', attributes, { id: version });
+    await savedObjectsClient.create('config', attributes, { id: docId });
   } catch (error) {
     if (handleWriteErrors) {
       if (SavedObjectsErrorHelpers.isConflictError(error)) {
@@ -85,6 +89,7 @@ export async function createOrUpgradeSavedConfig(
     log.debug(`Upgrade config from ${upgradeableConfig.id} to ${version}`, {
       prevVersion: upgradeableConfig.id,
       newVersion: version,
+      userLevel: !!userLevel,
     });
   }
 }

src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts

@@ -29,6 +29,7 @@
  */
 
 import { SavedObjectsClientContract } from '../../saved_objects/types';
+import { CURRENT_USER } from '../ui_settings_client';
 import { isConfigVersionUpgradeable } from './is_config_version_upgradeable';
 
 /**
@@ -41,9 +42,11 @@ import { isConfigVersionUpgradeable } from './is_config_version_upgradeable';
 export async function getUpgradeableConfig({
   savedObjectsClient,
   version,
+  userLevel,
 }: {
   savedObjectsClient: SavedObjectsClientContract;
   version: string;
+  userLevel?: boolean;
 }) {
   // attempt to find a config we can upgrade
   const { saved_objects: savedConfigs } = await savedObjectsClient.find({
@@ -52,6 +55,7 @@ export async function getUpgradeableConfig({
     perPage: 1000,
     sortField: 'buildNum',
     sortOrder: 'desc',
+    ...(userLevel ? { hasReference: { type: 'user', id: CURRENT_USER } } : {}),
   });
 
   // try to find a config that we can upgrade

src/core/server/ui_settings/index.ts

@@ -28,7 +28,7 @@
  * under the License.
  */
 
-export { UiSettingsClient, UiSettingsServiceOptions } from './ui_settings_client';
+export { UiSettingsClient, UiSettingsServiceOptions, CURRENT_USER } from './ui_settings_client';
 
 export { config } from './ui_settings_config';
 export { UiSettingsService } from './ui_settings_service';

src/core/server/ui_settings/ui_settings_client.test.ts

@@ -36,7 +36,7 @@ import { createOrUpgradeSavedConfigMock } from './create_or_upgrade_saved_config
 
 import { SavedObjectsClient } from '../saved_objects';
 import { savedObjectsClientMock } from '../saved_objects/service/saved_objects_client.mock';
-import { UiSettingsClient } from './ui_settings_client';
+import { CURRENT_USER, UiSettingsClient } from './ui_settings_client';
 import { CannotOverrideError } from './ui_settings_errors';
 
 const logger = loggingSystemMock.create().get();
@@ -105,6 +105,22 @@ describe('ui settings', () => {
       });
     });
 
+    it('updates several values in one operation includes user level settings', async () => {
+      const value = chance.word();
+      const defaults = { key: { value, scope: 'user' } };
+      const { uiSettings, savedObjectsClient } = setup({ defaults });
+      await uiSettings.setMany({ one: 'value', another: 'val', key: 'value' });
+
+      expect(savedObjectsClient.update).toHaveBeenCalledTimes(2);
+      expect(savedObjectsClient.update).toHaveBeenCalledWith(TYPE, ID, {
+        one: 'value',
+        another: 'val',
+      });
+      expect(savedObjectsClient.update).toHaveBeenCalledWith(TYPE, `${CURRENT_USER}_${ID}`, {
+        key: 'value',
+      });
+    });
+
     it('automatically creates the savedConfig if it is missing', async () => {
       const { uiSettings, savedObjectsClient, createOrUpgradeSavedConfig } = setup();
       savedObjectsClient.update
@@ -357,8 +373,9 @@ describe('ui settings', () => {
       const { uiSettings, savedObjectsClient } = setup();
       await uiSettings.getUserProvided();
 
-      expect(savedObjectsClient.get).toHaveBeenCalledTimes(1);
+      expect(savedObjectsClient.get).toHaveBeenCalledTimes(2);
       expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, ID);
+      expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, `${CURRENT_USER}_${ID}`);
     });
 
     it('returns user configuration', async () => {
@@ -410,6 +427,9 @@ describe('ui settings', () => {
           Array [
             "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
           ],
+          Array [
+            "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
+          ],
         ]
       `);
     });
@@ -419,11 +439,13 @@ describe('ui settings', () => {
       savedObjectsClient.get = jest
         .fn()
         .mockRejectedValueOnce(SavedObjectsClient.errors.createGenericNotFoundError())
+        .mockResolvedValueOnce({ attributes: {} })
+        .mockRejectedValueOnce(SavedObjectsClient.errors.createGenericNotFoundError())
         .mockResolvedValueOnce({ attributes: {} });
 
       expect(await uiSettings.getUserProvided()).toStrictEqual({});
 
-      expect(savedObjectsClient.get).toHaveBeenCalledTimes(2);
+      expect(savedObjectsClient.get).toHaveBeenCalledTimes(3);
 
       expect(createOrUpgradeSavedConfig).toHaveBeenCalledTimes(1);
       expect(createOrUpgradeSavedConfig).toHaveBeenCalledWith(
@@ -518,8 +540,9 @@ describe('ui settings', () => {
       const opensearchDocSource = {};
       const { uiSettings, savedObjectsClient } = setup({ opensearchDocSource });
       await uiSettings.getAll();
-      expect(savedObjectsClient.get).toHaveBeenCalledTimes(1);
+      expect(savedObjectsClient.get).toHaveBeenCalledTimes(2);
       expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, ID);
+      expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, `${CURRENT_USER}_${ID}`);
     });
 
     it('returns defaults when opensearch doc is empty', async () => {
@@ -552,6 +575,9 @@ describe('ui settings', () => {
           Array [
             "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
           ],
+          Array [
+            "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
+          ],
         ]
       `);
     });
@@ -599,6 +625,43 @@ describe('ui settings', () => {
         bar: 'user-provided',
       });
     });
+
+    // verify user level settings override global
+    it(`user level values will override global settings`, async () => {
+      const defaults = {
+        foo: {
+          value: 'default',
+        },
+        bar: {
+          value: 'default',
+          scope: 'user',
+        },
+      };
+
+      const { uiSettings, savedObjectsClient } = setup({ defaults });
+
+      savedObjectsClient.get.mockImplementation((_type, id, _options) => {
+        if (id === `${CURRENT_USER}_${ID}`) {
+          return Promise.resolve({
+            attributes: {
+              bar: 'my personal value',
+            },
+          } as any);
+        } else {
+          return Promise.resolve({
+            attributes: {
+              foo: 'default1',
+              bar: 'global value',
+            },
+          } as any);
+        }
+      });
+
+      expect(await uiSettings.getAll()).toStrictEqual({
+        foo: 'default1',
+        bar: 'my personal value',
+      });
+    });
   });
 
   describe('#getDefault()', () => {
@@ -626,8 +689,9 @@ describe('ui settings', () => {
       const { uiSettings, savedObjectsClient } = setup({ opensearchDocSource });
       await uiSettings.get('any');
 
-      expect(savedObjectsClient.get).toHaveBeenCalledTimes(1);
+      expect(savedObjectsClient.get).toHaveBeenCalledTimes(2);
       expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, ID);
+      expect(savedObjectsClient.get).toHaveBeenCalledWith(TYPE, `${CURRENT_USER}_${ID}`);
     });
 
     it(`returns the promised value for a key`, async () => {
@@ -722,6 +786,9 @@ describe('ui settings', () => {
           Array [
             "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
           ],
+          Array [
+            "Ignore invalid UiSettings value. ValidationError: [validation [id]]: expected value of type [number] but got [string].",
+          ],
         ]
       `);
     });