feat: optimization according to PR comments

Signed-off-by: SuZhou-Joe <[email protected]>

Author: SuZhou-Joe

src/plugins/workspace/opensearch_dashboards.json

@@ -2,8 +2,10 @@
   "id": "workspace",
   "version": "opensearchDashboards",
   "server": true,
-  "ui": true,
-  "requiredPlugins": [],
+  "ui": false,
+  "requiredPlugins": [
+    "savedObjects"
+  ],
   "optionalPlugins": [],
   "requiredBundles": []
 }

src/plugins/workspace/public/plugin.ts

@@ -2,6 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
 import { Plugin } from '../../../core/public';
 
 export class WorkspacePlugin implements Plugin<{}, {}, {}> {

src/plugins/workspace/server/index.ts

@@ -2,6 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
 import { PluginConfigDescriptor, PluginInitializerContext } from '../../../core/server';
 import { WorkspacePlugin } from './plugin';
 import { configSchema } from '../config';

src/plugins/workspace/server/plugin.ts

@@ -2,20 +2,21 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
 import {
   PluginInitializerContext,
   CoreSetup,
   Plugin,
   Logger,
   CoreStart,
 } from '../../../core/server';
-import { IWorkspaceDBImpl } from './types';
-import { WorkspaceClientWithSavedObject } from './workspace_client';
+import { IWorkspaceClientImpl } from './types';
+import { WorkspaceClient } from './workspace_client';
 import { registerRoutes } from './routes';
 
 export class WorkspacePlugin implements Plugin<{}, {}> {
   private readonly logger: Logger;
-  private client?: IWorkspaceDBImpl;
+  private client?: IWorkspaceClientImpl;
 
   constructor(initializerContext: PluginInitializerContext) {
     this.logger = initializerContext.logger.get('plugins', 'workspace');
@@ -24,14 +25,14 @@ export class WorkspacePlugin implements Plugin<{}, {}> {
   public async setup(core: CoreSetup) {
     this.logger.debug('Setting up Workspaces service');
 
-    this.client = new WorkspaceClientWithSavedObject(core);
+    this.client = new WorkspaceClient(core);
 
     await this.client.setup(core);
 
     registerRoutes({
       http: core.http,
       logger: this.logger,
-      client: this.client as IWorkspaceDBImpl,
+      client: this.client as IWorkspaceClientImpl,
     });
 
     return {
@@ -44,7 +45,7 @@ export class WorkspacePlugin implements Plugin<{}, {}> {
     this.client?.setSavedObjects(core.savedObjects);
 
     return {
-      client: this.client as IWorkspaceDBImpl,
+      client: this.client as IWorkspaceClientImpl,
     };
   }
 

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

@@ -2,10 +2,10 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { schema } from '@osd/config-schema';
 
+import { schema } from '@osd/config-schema';
 import { CoreSetup, Logger } from '../../../../core/server';
-import { IWorkspaceDBImpl } from '../types';
+import { IWorkspaceClientImpl } from '../types';
 
 const WORKSPACES_API_BASE_URL = '/api/workspaces';
 
@@ -23,7 +23,7 @@ export function registerRoutes({
   logger,
   http,
 }: {
-  client: IWorkspaceDBImpl;
+  client: IWorkspaceClientImpl;
   logger: Logger;
   http: CoreSetup['http'];
 }) {
@@ -78,17 +78,9 @@ export function registerRoutes({
         },
         id
       );
-      if (!result.success) {
-        return res.ok({ body: result });
-      }
 
       return res.ok({
-        body: {
-          ...result,
-          result: {
-            ...result.result,
-          },
-        },
+        body: result,
       });
     })
   );
@@ -110,9 +102,7 @@ export function registerRoutes({
           request: req,
           logger,
         },
-        {
-          ...attributes,
-        }
+        attributes
       );
       return res.ok({ body: result });
     })
@@ -140,9 +130,7 @@ export function registerRoutes({
           logger,
         },
         id,
-        {
-          ...attributes,
-        }
+        attributes
       );
       return res.ok({ body: result });
     })

src/plugins/workspace/server/saved_objects/workspace.ts

@@ -21,9 +21,6 @@ export const workspace: SavedObjectsType = {
       description: {
         type: 'text',
       },
-      /**
-       * In opensearch, string[] is also mapped to text
-       */
       features: {
         type: 'keyword',
       },

src/plugins/workspace/server/types.ts

@@ -2,6 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
 import {
   Logger,
   OpenSearchDashboardsRequest,
@@ -27,7 +28,7 @@ export interface IRequestDetail {
   logger: Logger;
 }
 
-export interface IWorkspaceDBImpl {
+export interface IWorkspaceClientImpl {
   setup(dep: CoreSetup): Promise<IResponse<boolean>>;
   setSavedObjects(savedObjects: SavedObjectsServiceStart): void;
   create(

src/plugins/workspace/server/workspace_client.ts

@@ -2,6 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
 import { i18n } from '@osd/i18n';
 import type {
   SavedObject,
@@ -11,7 +12,7 @@ import type {
   SavedObjectsServiceStart,
 } from '../../../core/server';
 import { WORKSPACE_TYPE } from '../../../core/server';
-import { IWorkspaceDBImpl, WorkspaceFindOptions, IResponse, IRequestDetail } from './types';
+import { IWorkspaceClientImpl, WorkspaceFindOptions, IResponse, IRequestDetail } from './types';
 import { workspace } from './saved_objects';
 import { generateRandomId } from './utils';
 import { WORKSPACE_SAVED_OBJECTS_CLIENT_WRAPPER_ID } from '../common/constants';
@@ -22,7 +23,7 @@ const DUPLICATE_WORKSPACE_NAME_ERROR = i18n.translate('workspace.duplicate.name.
   defaultMessage: 'workspace name has already been used, try with a different name',
 });
 
-export class WorkspaceClientWithSavedObject implements IWorkspaceDBImpl {
+export class WorkspaceClient implements IWorkspaceClientImpl {
   private setupDep: CoreSetup;
   private savedObjects?: SavedObjectsServiceStart;
 
@@ -64,7 +65,7 @@ export class WorkspaceClientWithSavedObject implements IWorkspaceDBImpl {
   public async create(
     requestDetail: IRequestDetail,
     payload: Omit<WorkspaceAttribute, 'id'>
-  ): ReturnType<IWorkspaceDBImpl['create']> {
+  ): ReturnType<IWorkspaceClientImpl['create']> {
     try {
       const attributes = payload;
       const id = generateRandomId(WORKSPACE_ID_SIZE);
@@ -102,7 +103,7 @@ export class WorkspaceClientWithSavedObject implements IWorkspaceDBImpl {
   public async list(
     requestDetail: IRequestDetail,
     options: WorkspaceFindOptions
-  ): ReturnType<IWorkspaceDBImpl['list']> {
+  ): ReturnType<IWorkspaceClientImpl['list']> {
     try {
       const {
         saved_objects: savedObjects,

test/api_integration/apis/workspace/index.ts

@@ -5,9 +5,13 @@
 
 import expect from '@osd/expect';
 import { WorkspaceAttribute } from 'opensearch-dashboards/server';
-import { omit } from 'lodash';
 import { FtrProviderContext } from '../../ftr_provider_context';
 
+const omitId = <T extends { id?: string }>(object: T): Omit<T, 'id'> => {
+  const { id, ...others } = object;
+  return others;
+};
+
 const testWorkspace: WorkspaceAttribute = {
   id: 'fake_id',
   name: 'test_workspace',
@@ -47,7 +51,7 @@ export default function ({ getService }: FtrProviderContext) {
       const result: any = await supertest
         .post(`/api/workspaces`)
         .send({
-          attributes: omit(testWorkspace, 'id'),
+          attributes: omitId(testWorkspace),
         })
         .set('osd-xsrf', 'opensearch-dashboards')
         .expect(200);
@@ -59,7 +63,7 @@ export default function ({ getService }: FtrProviderContext) {
       const result = await supertest
         .post(`/api/workspaces`)
         .send({
-          attributes: omit(testWorkspace, 'id'),
+          attributes: omitId(testWorkspace),
         })
         .set('osd-xsrf', 'opensearch-dashboards')
         .expect(200);
@@ -71,7 +75,7 @@ export default function ({ getService }: FtrProviderContext) {
       const result: any = await supertest
         .post(`/api/workspaces`)
         .send({
-          attributes: omit(testWorkspace, 'id'),
+          attributes: omitId(testWorkspace),
         })
         .set('osd-xsrf', 'opensearch-dashboards')
         .expect(200);
@@ -80,7 +84,7 @@ export default function ({ getService }: FtrProviderContext) {
         .put(`/api/workspaces/${result.body.result.id}`)
         .send({
           attributes: {
-            ...omit(testWorkspace, 'id'),
+            ...omitId(testWorkspace),
             name: 'updated',
           },
         })
@@ -96,7 +100,7 @@ export default function ({ getService }: FtrProviderContext) {
       const result: any = await supertest
         .post(`/api/workspaces`)
         .send({
-          attributes: omit(testWorkspace, 'id'),
+          attributes: omitId(testWorkspace),
         })
         .set('osd-xsrf', 'opensearch-dashboards')
         .expect(200);
@@ -114,7 +118,7 @@ export default function ({ getService }: FtrProviderContext) {
       await supertest
         .post(`/api/workspaces`)
         .send({
-          attributes: omit(testWorkspace, 'id'),
+          attributes: omitId(testWorkspace),
         })
         .set('osd-xsrf', 'opensearch-dashboards')
         .expect(200);