[Workspace] Support workspace in saved objects client in server side. (…

…opensearch-project#6365) * Support workspace in saved objects client in server side. (opensearch-project#293) * feat: POC implementation Signed-off-by: SuZhou-Joe <[email protected]> * feat: add some comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: revert dependency Signed-off-by: SuZhou-Joe <[email protected]> * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: address one TODO Signed-off-by: SuZhou-Joe <[email protected]> * feat: address TODO Signed-off-by: SuZhou-Joe <[email protected]> * feat: add unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: some special logic on specific operation Signed-off-by: SuZhou-Joe <[email protected]> * feat: add integration test Signed-off-by: SuZhou-Joe <[email protected]> * feat: declare workspaces as empty array for advanced settings Signed-off-by: SuZhou-Joe <[email protected]> * feat: unified workspaces parameters when parsing from router Signed-off-by: SuZhou-Joe <[email protected]> * feat: improve code coverage Signed-off-by: SuZhou-Joe <[email protected]> * feat: declare workspaces as null Signed-off-by: SuZhou-Joe <[email protected]> * feat: use unified types Signed-off-by: SuZhou-Joe <[email protected]> * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: remove null Signed-off-by: SuZhou-Joe <[email protected]> * feat: address comments Signed-off-by: SuZhou-Joe <[email protected]> * feat: use request app to store request workspace id Signed-off-by: SuZhou-Joe <[email protected]> * feat: use app state to store request workspace id Signed-off-by: SuZhou-Joe <[email protected]> * refact: update types declaration Signed-off-by: SuZhou-Joe <[email protected]> * fix: unit test error Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> * fix: import error Signed-off-by: SuZhou-Joe <[email protected]> * feat: add integration test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: use consts and add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: change the priority value Signed-off-by: SuZhou-Joe <[email protected]> * feat: update Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]>
SuZhou-Joe · Apr 12, 2024 · 0293044 · 0293044
1 parent f792a32
commit 0293044
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 6 deletions.
diff --git a/src/core/server/saved_objects/import/create_saved_objects.ts b/src/core/server/saved_objects/import/create_saved_objects.ts
@@ -176,7 +176,7 @@ export const createSavedObjects = async <T>({
     const bulkCreateResponse = await savedObjectsClient.bulkCreate(objectsToCreate, {
       namespace,
       overwrite,
-      workspaces,
+      ...(workspaces ? { workspaces } : {}),
     });
     expectedResults = bulkCreateResponse.saved_objects;
   }

diff --git a/src/plugins/workspace/common/constants.ts b/src/plugins/workspace/common/constants.ts
@@ -22,3 +22,13 @@ export enum WorkspacePermissionMode {
 }
 
 export const WORKSPACE_ID_CONSUMER_WRAPPER_ID = 'workspace_id_consumer';
+
+/**
+ * The priority for these wrappers matters:
+ * 1. WORKSPACE_ID_CONSUMER should be placed before the other two wrappers(smaller than the other two wrappers) as it cost little
+ *    and will append the essential workspaces field into the options, which will be honored by permission control wrapper and conflict wrapper.
+ * 2. The order of permission wrapper and conflict wrapper does not matter as no dependency between these two wrappers.
+ */
+export const PRIORITY_FOR_WORKSPACE_ID_CONSUMER_WRAPPER = -2;
+export const PRIORITY_FOR_PERMISSION_CONTROL_WRAPPER = 0;
+export const PRIORITY_FOR_WORKSPACE_CONFLICT_CONTROL_WRAPPER = -1;
diff --git a/src/plugins/workspace/server/plugin.ts b/src/plugins/workspace/server/plugin.ts
@@ -17,6 +17,9 @@ import {
   WORKSPACE_SAVED_OBJECTS_CLIENT_WRAPPER_ID,
   WORKSPACE_CONFLICT_CONTROL_SAVED_OBJECTS_CLIENT_WRAPPER_ID,
   WORKSPACE_ID_CONSUMER_WRAPPER_ID,
+  PRIORITY_FOR_WORKSPACE_CONFLICT_CONTROL_WRAPPER,
+  PRIORITY_FOR_WORKSPACE_ID_CONSUMER_WRAPPER,
+  PRIORITY_FOR_PERMISSION_CONTROL_WRAPPER,
 } from '../common/constants';
 import { IWorkspaceClientImpl, WorkspacePluginSetup, WorkspacePluginStart } from './types';
 import { WorkspaceClient } from './workspace_client';
@@ -82,7 +85,7 @@ export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePl
     this.workspaceConflictControl = new WorkspaceConflictSavedObjectsClientWrapper();
 
     core.savedObjects.addClientWrapper(
-      -1,
+      PRIORITY_FOR_WORKSPACE_CONFLICT_CONTROL_WRAPPER,
       WORKSPACE_CONFLICT_CONTROL_SAVED_OBJECTS_CLIENT_WRAPPER_ID,
       this.workspaceConflictControl.wrapperFactory
     );
@@ -93,6 +96,12 @@ export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePl
       new WorkspaceIdConsumerWrapper().wrapperFactory
     );
 
+    core.savedObjects.addClientWrapper(
+      PRIORITY_FOR_WORKSPACE_ID_CONSUMER_WRAPPER,
+      WORKSPACE_ID_CONSUMER_WRAPPER_ID,
+      new WorkspaceIdConsumerWrapper().wrapperFactory
+    );
+
     const maxImportExportSize = core.savedObjects.getImportExportObjectLimit();
     this.logger.info('Workspace permission control enabled:' + isPermissionControlEnabled);
     if (isPermissionControlEnabled) {
@@ -103,7 +112,7 @@ export class WorkspacePlugin implements Plugin<WorkspacePluginSetup, WorkspacePl
       );
 
       core.savedObjects.addClientWrapper(
-        0,
+        PRIORITY_FOR_PERMISSION_CONTROL_WRAPPER,
         WORKSPACE_SAVED_OBJECTS_CLIENT_WRAPPER_ID,
         this.workspaceSavedObjectsClientWrapper.wrapperFactory
       );

diff --git a/...ns/workspace/server/saved_objects/integration_tests/workspace_id_consumer_wrapper.test.ts b/...ns/workspace/server/saved_objects/integration_tests/workspace_id_consumer_wrapper.test.ts
@@ -238,5 +238,33 @@ describe('workspace_id_consumer integration test', () => {
         )
       );
     });
+
+    it('import within workspace', async () => {
+      await clearFooAndBar();
+
+      const importWithWorkspacesResult = await osdTestServer.request
+        .post(root, `/w/${createdFooWorkspace.id}/api/saved_objects/_import?overwrite=false`)
+        .attach(
+          'file',
+          Buffer.from(
+            [
+              JSON.stringify({
+                ...dashboard,
+                id: 'bar',
+              }),
+            ].join('\n'),
+            'utf-8'
+          ),
+          'tmp.ndjson'
+        )
+        .expect(200);
+
+      const findResult = await osdTestServer.request
+        .get(root, `/w/${createdFooWorkspace.id}/api/saved_objects/_find?type=${dashboard.type}`)
+        .expect(200);
+
+      expect(importWithWorkspacesResult.body.success).toEqual(true);
+      expect(findResult.body.saved_objects[0].workspaces).toEqual([createdFooWorkspace.id]);
+    });
   });
 });
diff --git a/...gins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts b/...gins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts
@@ -20,8 +20,8 @@ import {
 const errorContent = (error: Boom.Boom) => error.output.payload;
 
 const filterWorkspacesAccordingToSourceWorkspaces = (
-  targetWorkspaces?: string[],
-  baseWorkspaces?: string[]
+  targetWorkspaces?: SavedObjectsBaseOptions['workspaces'],
+  baseWorkspaces?: SavedObjectsBaseOptions['workspaces']
 ): string[] => targetWorkspaces?.filter((item) => !baseWorkspaces?.includes(item)) || [];
 
 export class WorkspaceConflictSavedObjectsClientWrapper {
@@ -110,7 +110,7 @@ export class WorkspaceConflictSavedObjectsClientWrapper {
             })
         : [];
       const objectsConflictWithWorkspace: SavedObject[] = [];
-      const objectsMapWorkspaces: Record<string, string[] | undefined> = {};
+      const objectsMapWorkspaces: Record<string, SavedObjectsBaseOptions['workspaces']> = {};
       if (bulkGetDocs.length) {
         /**
          * Get latest status of objects