[Bugfix] Make UI setting client more robust when the setting key does not exist (#9927) (#9945)

* feat: add settings



* Changeset file for PR #9927 created/updated

* fix: bootstrap



---------



(cherry picked from commit 935758f)

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

Author: 3 people

changelogs/fragments/9927.yml

@@ -0,0 +1,2 @@
+fix:
+- Make UI setting client more robust when the setting key not exists ([#9927](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9927))

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

@@ -261,6 +261,12 @@ describe('#set', () => {
     await client.set('defaultIndex', 'index', UiSettingScope.USER);
     expect(getAll).toHaveBeenCalled();
   });
+
+  it('should not throw error if the key does not exist', async () => {
+    const { client } = setup();
+
+    await expect(client.set('not_exist', UiSettingScope.GLOBAL)).resolves.not.toThrowError();
+  });
 });
 
 describe('#getUserProvidedWithScope', () => {
@@ -287,6 +293,13 @@ describe('#getUserProvidedWithScope', () => {
       client.getUserProvidedWithScope('defaultDatasource', UiSettingScope.WORKSPACE)
     ).resolves.toBe('ds');
   });
+
+  it('should not throw error if the key does not exist', async () => {
+    const { client } = setup();
+    const notExistSettingKey = 'not_exist';
+
+    await client.getUserProvidedWithScope(notExistSettingKey, UiSettingScope.GLOBAL);
+  });
 });
 
 describe('#remove', () => {
@@ -322,6 +335,11 @@ describe('#remove', () => {
       client.remove('defaultDatasource', UiSettingScope.USER)
     ).rejects.toThrowErrorMatchingSnapshot();
   });
+  it('should not throw error if the key does not exist', () => {
+    const { client } = setup();
+
+    expect(() => client.remove('not_exist')).not.toThrowError();
+  });
 });
 
 describe('#isDeclared', () => {

src/core/public/ui_settings/ui_settings_client.ts

@@ -141,7 +141,7 @@ You can use \`IUiSettingsClient.get("${key}", defaultValue)\`, which will just r
   }
 
   private validateScope(key: string, scope: UiSettingScope) {
-    const definition = this.cache[key];
+    const definition = this.cache[key] || {};
     const validScopes = Array.isArray(definition.scope)
       ? definition.scope
       : [definition.scope || UiSettingScope.GLOBAL];
@@ -157,7 +157,7 @@ You can use \`IUiSettingsClient.get("${key}", defaultValue)\`, which will just r
       .getAll()
       .then((response: any) => {
         const value = response.settings[key]?.userValue;
-        const type = this.cache[key].type;
+        const type = this.cache[key]?.type;
         return this.resolveValue(value, type);
       });
   }
@@ -277,8 +277,7 @@ You can use \`IUiSettingsClient.get("${key}", defaultValue)\`, which will just r
     key: string,
     defaults: Record<string, any>,
     enableUserControl: boolean,
-    settings: Record<string, any> = {},
-    scope: UiSettingScope | undefined
+    settings: Record<string, any> = {}
   ) {
     const hasMultipleScopes =
       Array.isArray(this.cache[key]?.scope) && (this.cache[key].scope?.length ?? 0) > 1;
@@ -327,10 +326,10 @@ You can use \`IUiSettingsClient.get("${key}", defaultValue)\`, which will just r
           ? this.setBrowserStoredSettings(key, newVal)
           : (await this.selectedApi(scope).batchSet(key, newVal)) || {};
 
-        this.mergeSettingsIntoCache(key, defaults, true, settings, scope);
+        this.mergeSettingsIntoCache(key, defaults, true, settings);
       } else {
         const { settings } = (await this.selectedApi(scope).batchSet(key, newVal)) || {};
-        this.mergeSettingsIntoCache(key, defaults, false, settings, scope);
+        this.mergeSettingsIntoCache(key, defaults, false, settings);
       }
       this.saved$.next({ key, newValue: newVal, oldValue: initialVal });
       return true;