add try catch and add tests

Signed-off-by: tygao <tygao@amazon.com>
opensearch-project · Jul 9, 2024 · 641b9b1 · 641b9b1
1 parent 1956444
commit 641b9b1
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 17 deletions.
diff --git a/src/plugins/workspace/server/plugin.ts b/src/plugins/workspace/server/plugin.ts
@@ -113,7 +113,7 @@ export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePl
     const globalConfig = await this.globalConfig$.pipe(first()).toPromise();
     const isPermissionControlEnabled = globalConfig.savedObjects.permission.enabled === true;
 
-    this.client = new WorkspaceClient(core);
+    this.client = new WorkspaceClient(core, this.logger);
 
     await this.client.setup(core);
 

diff --git a/src/plugins/workspace/server/utils.test.ts b/src/plugins/workspace/server/utils.test.ts
@@ -215,4 +215,17 @@ describe('workspace utils', () => {
       dataSources[0]
     );
   });
+
+  it('should clear default data source if there is no new data source', async () => {
+    const savedObjectsClient = savedObjectsClientMock.create();
+    const uiSettings = uiSettingsServiceMock.createStartContract();
+    const uiSettingsClient = uiSettings.asScopedToClient(savedObjectsClient);
+    const dataSources: string[] = [];
+    uiSettingsClient.get = jest.fn().mockResolvedValue('');
+    await checkAndSetDefaultDataSource(uiSettingsClient, dataSources, true);
+    expect(uiSettingsClient.set).toHaveBeenCalledWith(
+      DEFAULT_DATA_SOURCE_UI_SETTINGS_ID,
+      undefined
+    );
+  });
 });
diff --git a/src/plugins/workspace/server/utils.ts b/src/plugins/workspace/server/utils.ts
@@ -119,10 +119,10 @@ export const getDataSourcesList = (client: SavedObjectsClientContract, workspace
 export const checkAndSetDefaultDataSource = async (
   uiSettingsClient: IUiSettingsClient,
   dataSources: string[],
-  isNeededCheck: boolean
+  needCheck: boolean
 ) => {
   if (dataSources?.length > 0) {
-    if (!isNeededCheck) {
+    if (!needCheck) {
       // Create# Will set first data source as default data source.
       await uiSettingsClient.set(DEFAULT_DATA_SOURCE_UI_SETTINGS_ID, dataSources[0]);
     } else {

diff --git a/src/plugins/workspace/server/workspace_client.test.ts b/src/plugins/workspace/server/workspace_client.test.ts
@@ -5,7 +5,12 @@
 
 import { WorkspaceClient } from './workspace_client';
 
-import { coreMock, httpServerMock, uiSettingsServiceMock } from '../../../core/server/mocks';
+import {
+  coreMock,
+  httpServerMock,
+  uiSettingsServiceMock,
+  loggingSystemMock,
+} from '../../../core/server/mocks';
 import { DATA_SOURCE_SAVED_OBJECT_TYPE } from '../../data_source/common';
 import { SavedObjectsServiceStart, SavedObjectsClientContract } from '../../../core/server';
 import { IRequestDetail } from './types';
@@ -15,6 +20,7 @@ const coreSetup = coreMock.createSetup();
 const mockWorkspaceId = 'workspace_id';
 const mockWorkspaceName = 'workspace_name';
 const mockCheckAndSetDefaultDataSource = jest.fn();
+const logger = loggingSystemMock.create().get();
 
 jest.mock('./utils', () => ({
   generateRandomId: () => mockWorkspaceId,
@@ -62,7 +68,7 @@ describe('#WorkspaceClient', () => {
   } as unknown) as IRequestDetail;
 
   it('create# should not call addToWorkspaces if no data sources passed', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
 
@@ -75,7 +81,7 @@ describe('#WorkspaceClient', () => {
   });
 
   it('create# should call addToWorkspaces with passed data sources normally', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
 
@@ -91,7 +97,7 @@ describe('#WorkspaceClient', () => {
   });
 
   it('create# should call set default data source after creating', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
     client?.setUiSettings(uiSettings);
@@ -108,7 +114,7 @@ describe('#WorkspaceClient', () => {
   });
 
   it('update# should not call addToWorkspaces if no new data sources added', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
 
@@ -122,7 +128,7 @@ describe('#WorkspaceClient', () => {
   });
 
   it('update# should call deleteFromWorkspaces if there is data source to be removed', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
 
@@ -140,7 +146,7 @@ describe('#WorkspaceClient', () => {
     ]);
   });
   it('update# should calculate data sources to be added and to be removed', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
 
@@ -159,7 +165,7 @@ describe('#WorkspaceClient', () => {
   });
 
   it('update# should call set default data source with check after updating', async () => {
-    const client = new WorkspaceClient(coreSetup);
+    const client = new WorkspaceClient(coreSetup, logger);
     await client.setup(coreSetup);
     client?.setSavedObjects(savedObjects);
     client?.setUiSettings(uiSettings);

diff --git a/src/plugins/workspace/server/workspace_client.ts b/src/plugins/workspace/server/workspace_client.ts
@@ -12,6 +12,7 @@ import {
   SavedObjectsServiceStart,
   UiSettingsServiceStart,
   WORKSPACE_TYPE,
+  Logger,
 } from '../../../core/server';
 import { updateWorkspaceState, getWorkspaceState } from '../../../core/server/utils';
 import {
@@ -37,11 +38,13 @@ const DUPLICATE_WORKSPACE_NAME_ERROR = i18n.translate('workspace.duplicate.name.
 
 export class WorkspaceClient implements IWorkspaceClientImpl {
   private setupDep: CoreSetup;
+  private logger: Logger;
   private savedObjects?: SavedObjectsServiceStart;
   private uiSettings?: UiSettingsServiceStart;
 
-  constructor(core: CoreSetup) {
+  constructor(core: CoreSetup, logger: Logger) {
     this.setupDep = core;
+    this.logger = logger;
   }
 
   private getScopedClientWithoutPermission(
@@ -133,11 +136,16 @@ export class WorkspaceClient implements IWorkspaceClientImpl {
         });
         // Set first data source as default after creating workspace
         const uiSettingsClient = this.uiSettings.asScopedToClient(client);
-        await checkAndSetDefaultDataSource(uiSettingsClient, dataSources, false);
-        // Reset workspace state
-        updateWorkspaceState(requestDetail.request, {
-          requestWorkspaceId: rawState.requestWorkspaceId,
-        });
+        try {
+          await checkAndSetDefaultDataSource(uiSettingsClient, dataSources, false);
+        } catch (e) {
+          this.logger.error('Set default data source error');
+        } finally {
+          // Reset workspace state
+          updateWorkspaceState(requestDetail.request, {
+            requestWorkspaceId: rawState.requestWorkspaceId,
+          });
+        }
       }
 
       return {