[Workspace] update workspace not found message to generic message

changelogs/fragments/9189.yml

@@ -0,0 +1,2 @@
+fix:
+- Update workspace not found message to generic message ([#9189](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9189))

src/plugins/workspace/server/integration_tests/duplicate.test.ts

@@ -209,9 +209,7 @@ describe(`duplicate saved objects among workspaces`, () => {
       })
       .expect(400);
 
-    expect(result.body.message).toMatchInlineSnapshot(
-      `"Get target workspace non-existen-workspace error: undefined"`
-    );
+    expect(result.body.message).toMatchInlineSnapshot(`"Get target workspace error: undefined"`);
   });
 
   it('duplicate unsupported objects', async () => {

src/plugins/workspace/server/integration_tests/routes.test.ts

@@ -158,6 +158,14 @@ describe('workspace service api integration test', () => {
       );
       expect(getResult.body.result.name).toEqual(testWorkspace.name);
     });
+
+    it('get when workspace not found', async () => {
+      const workspaceId = 'non-exist workspace id';
+      const getResult = await osdTestServer.request.get(root, `/api/workspaces/${workspaceId}`);
+      expect(getResult.body.success).toEqual(false);
+      expect(getResult.body.error).toEqual('workspace not found');
+    });
+
     it('update', async () => {
       const result: any = await osdTestServer.request
         .post(root, `/api/workspaces`)
@@ -185,6 +193,23 @@ describe('workspace service api integration test', () => {
       expect(getResult.body.result.name).toEqual('updated');
     });
 
+    it('update non exist workspace', async () => {
+      const workspaceId = 'non-exist workspace id';
+
+      const result = await osdTestServer.request
+        .put(root, `/api/workspaces/${workspaceId}`)
+        .send({
+          attributes: {
+            ...omitId(testWorkspace),
+            name: 'updated',
+          },
+        })
+        .expect(200);
+
+      expect(result.body.success).toEqual(false);
+      expect(result.body.error).toEqual('workspace not found');
+    });
+
     it('update workspace failed when new name is duplicate', async () => {
       const result: any = await osdTestServer.request
         .post(root, `/api/workspaces`)
@@ -286,6 +311,17 @@ describe('workspace service api integration test', () => {
         `Reserved workspace ${result.body.result.id} is not allowed to delete.`
       );
     });
+
+    it('delete non exist workspace', async () => {
+      const workspaceId = 'non-exist workspace id';
+      const result = await osdTestServer.request
+        .delete(root, `/api/workspaces/${workspaceId}`)
+        .expect(200);
+
+      expect(result.body.success).toEqual(false);
+      expect(result.body.error).toEqual('workspace not found');
+    });
+
     it('list', async () => {
       await osdTestServer.request
         .post(root, `/api/workspaces`)
@@ -504,7 +540,7 @@ describe('workspace service api integration test', () => {
         .expect(400);
 
       expect(result.body.message).toMatchInlineSnapshot(
-        `"Get target workspace test_workspace error: Saved object [workspace/test_workspace] not found"`
+        `"Get target workspace error: workspace not found"`
       );
     });
 

src/plugins/workspace/server/routes/duplicate.ts

@@ -66,7 +66,7 @@ export const registerDuplicateRoute = (
       if (!getTargetWorkspaceResult.success) {
         return res.badRequest({
           body: {
-            message: `Get target workspace ${targetWorkspace} error: ${getTargetWorkspaceResult.error}`,
+            message: `Get target workspace error: ${getTargetWorkspaceResult.error}`,
           },
         });
       }

src/plugins/workspace/server/workspace_client.ts

@@ -14,6 +14,7 @@
   WORKSPACE_TYPE,
   Logger,
   WorkspaceFindOptions,
+  SavedObjectsErrorHelpers,
 } from '../../../core/server';
 import { updateWorkspaceState, getWorkspaceState } from '../../../core/server/utils';
 import {
@@ -39,6 +40,10 @@
   defaultMessage: 'workspace name has already been used, try with a different name',
 });
 
+const WORKSPACE_NOT_FOUND_ERROR = i18n.translate('workspace.notFound.error', {
+  defaultMessage: 'workspace not found',
+});
+
 export class WorkspaceClient implements IWorkspaceClientImpl {
   private setupDep: CoreSetup;
   private logger: Logger;
@@ -86,6 +91,10 @@
     };
   }
   private formatError(error: Error | any): string {
+    if (SavedObjectsErrorHelpers.isNotFoundError(error)) {
+      return WORKSPACE_NOT_FOUND_ERROR;
+    }
+
     return error.message || error.error || 'Error';
   }
   public async setup(core: CoreSetup): Promise<IResponse<boolean>> {