[Workspace] Fix: keep disallowed types when importing with overwrite (o…

…pensearch-project#6668) * fix: keep disallowed types when importing with overwrite Signed-off-by: SuZhou-Joe <[email protected]> * Changeset file for PR opensearch-project#6668 created/updated * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: address some minor concern Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
yujin-emma · Apr 29, 2024 · de6a889 · de6a889
1 parent 29a09b0
commit de6a889
Show file tree

Hide file tree

Showing 4 changed files with 174 additions and 5 deletions.
diff --git a/changelogs/fragments/6668.yml b/changelogs/fragments/6668.yml
@@ -0,0 +1,2 @@
+fix:
+- Keep disallowed types when importing with overwrite ([#6668](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6668))
diff --git a/...aved_objects/integration_tests/saved_objects_wrapper_for_check_workspace_conflict.test.ts b/...aved_objects/integration_tests/saved_objects_wrapper_for_check_workspace_conflict.test.ts
@@ -23,6 +23,12 @@ const dataSource: Omit<SavedObject, 'id'> = {
   references: [],
 };
 
+const indexPattern: Omit<SavedObject, 'id'> = {
+  type: 'index-pattern',
+  attributes: {},
+  references: [],
+};
+
 const advancedSettings: Omit<SavedObject, 'id'> = {
   type: 'config',
   attributes: {},
@@ -445,6 +451,95 @@ describe('saved_objects_wrapper_for_check_workspace_conflict integration test',
       );
     });
 
+    it('checkConflicts when importing disallowed types', async () => {
+      await clearFooAndBar();
+      // Create data source through OpenSearch API directly
+      // or the saved objects API will do connection validation on the data source
+      // which will not pass as it is a dummy data source without endpoint and credentials
+      await osdTestServer.request
+        .post(root, `/api/console/proxy?path=.kibana%2F_doc%2Fdata-source%3Afoo&method=PUT`)
+        .send({
+          type: dataSource.type,
+          [dataSource.type]: {},
+        })
+        .expect(201);
+
+      await osdTestServer.request
+        .post(root, `/api/saved_objects/${indexPattern.type}/foo`)
+        .send({
+          attributes: indexPattern.attributes,
+          references: [
+            {
+              id: 'foo',
+              type: dataSource.type,
+              name: 'dataSource',
+            },
+          ],
+        })
+        .expect(200);
+
+      const getResultFoo = await getItem({
+        type: dataSource.type,
+        id: 'foo',
+      });
+      const getResultBar = await getItem({
+        type: indexPattern.type,
+        id: 'foo',
+      });
+
+      /**
+       * import with workspaces when conflicts
+       */
+      const importWithWorkspacesResult = await osdTestServer.request
+        .post(
+          root,
+          `/api/saved_objects/_import?workspaces=${createdFooWorkspace.id}&overwrite=true&dataSourceEnabled=true`
+        )
+        .attach(
+          'file',
+          Buffer.from(
+            [JSON.stringify(getResultFoo.body), JSON.stringify(getResultBar.body)].join('\n'),
+            'utf-8'
+          ),
+          'tmp.ndjson'
+        )
+        .expect(200);
+
+      expect(importWithWorkspacesResult.body.success).toEqual(false);
+      expect(importWithWorkspacesResult.body.errors.length).toEqual(1);
+      expect(importWithWorkspacesResult.body.errors[0].id).toEqual('foo');
+      expect(importWithWorkspacesResult.body.errors[0].error.type).toEqual('unknown');
+      expect(importWithWorkspacesResult.body.successCount).toEqual(1);
+
+      const [indexPatternImportResult] = importWithWorkspacesResult.body.successResults;
+      const getImportIndexPattern = await getItem({
+        type: indexPatternImportResult.type,
+        id: indexPatternImportResult.destinationId,
+      });
+
+      // The references to disallowed types should be kept
+      expect(getImportIndexPattern.body.references).toEqual([
+        {
+          id: 'foo',
+          type: dataSource.type,
+          name: 'dataSource',
+        },
+      ]);
+
+      await Promise.all(
+        [
+          { id: 'foo', type: indexPattern.type },
+          { id: 'foo', type: dataSource.type },
+          { id: indexPatternImportResult.destinationId, type: indexPattern.type },
+        ].map((item) =>
+          deleteItem({
+            type: item.type,
+            id: item.id,
+          })
+        )
+      );
+    });
+
     it('find by workspaces', async () => {
       const createResultFoo = await osdTestServer.request
         .post(root, `/api/saved_objects/_bulk_create?workspaces=${createdFooWorkspace.id}`)

diff --git a/...workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.test.ts b/...workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.test.ts
@@ -461,6 +461,43 @@ describe('WorkspaceConflictSavedObjectsClientWrapper', () => {
         }
       `);
     });
+
+    it(`Should return error when trying to check conflict on disallowed types within a workspace`, async () => {
+      mockedClient.bulkCreate.mockResolvedValueOnce({ saved_objects: [] });
+      const result = await wrapperClient.checkConflicts(
+        [
+          getSavedObject({
+            type: 'config',
+            id: 'foo',
+          }),
+          getSavedObject({
+            type: DATA_SOURCE_SAVED_OBJECT_TYPE,
+            id: 'foo',
+          }),
+        ],
+        {
+          workspaces: ['foo'],
+        }
+      );
+
+      expect(mockedClient.bulkCreate).toBeCalledWith([], {
+        workspaces: ['foo'],
+      });
+      expect(result.errors[0].error).toEqual(
+        expect.objectContaining({
+          message:
+            "Unsupported type in workspace: 'config' is not allowed to be imported in workspace.",
+          statusCode: 400,
+        })
+      );
+      expect(result.errors[1].error).toEqual(
+        expect.objectContaining({
+          message:
+            "Unsupported type in workspace: 'data-source' is not allowed to be imported in workspace.",
+          statusCode: 400,
+        })
+      );
+    });
   });
 
   describe('find', () => {

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
@@ -289,11 +289,33 @@ export class WorkspaceConflictSavedObjectsClientWrapper {
         return { errors: [] };
       }
 
+      const { workspaces } = options;
+
+      const disallowedSavedObjects: SavedObjectsCheckConflictsObject[] = [];
+      const allowedSavedObjects: SavedObjectsCheckConflictsObject[] = [];
+      objects.forEach((item) => {
+        const isImportIntoWorkspace = !!workspaces?.length;
+        // config can not be created inside a workspace
+        if (this.isConfigType(item.type) && isImportIntoWorkspace) {
+          disallowedSavedObjects.push(item);
+          return;
+        }
+
+        // For 2.14, data source can only be created without workspace info
+        if (this.isDataSourceType(item.type) && isImportIntoWorkspace) {
+          disallowedSavedObjects.push(item);
+          return;
+        }
+
+        allowedSavedObjects.push(item);
+        return;
+      });
+
       /**
        * Workspace conflict only happens when target workspaces params present.
        */
       if (options.workspaces) {
-        const bulkGetDocs: any[] = objects.map((object) => {
+        const bulkGetDocs: any[] = allowedSavedObjects.map((object) => {
           const { type, id } = object;
 
           return {
@@ -335,7 +357,7 @@ export class WorkspaceConflictSavedObjectsClientWrapper {
         }
       }
 
-      const objectsNoWorkspaceConflictError = objects.filter(
+      const objectsNoWorkspaceConflictError = allowedSavedObjects.filter(
         (item) =>
           !objectsConflictWithWorkspace.find(
             (errorItems) =>
@@ -355,7 +377,7 @@ export class WorkspaceConflictSavedObjectsClientWrapper {
       /**
        * Bypass those objects that are not conflict on workspaces
        */
-      const realBulkCreateResult = await wrapperOptions.client.checkConflicts(
+      const realCheckConflictsResult = await wrapperOptions.client.checkConflicts(
         objectsNoWorkspaceConflictError,
         options
       );
@@ -364,8 +386,21 @@ export class WorkspaceConflictSavedObjectsClientWrapper {
        * Merge results from two conflict check.
        */
       const result: SavedObjectsCheckConflictsResponse = {
-        ...realBulkCreateResult,
-        errors: [...objectsConflictWithWorkspace, ...realBulkCreateResult.errors],
+        ...realCheckConflictsResult,
+        errors: [
+          ...objectsConflictWithWorkspace,
+          ...disallowedSavedObjects.map((item) => ({
+            ...item,
+            error: {
+              ...SavedObjectsErrorHelpers.decorateBadRequestError(
+                new Error(`'${item.type}' is not allowed to be imported in workspace.`),
+                'Unsupported type in workspace'
+              ).output.payload,
+              metadata: { isNotOverwritable: true },
+            },
+          })),
+          ...(realCheckConflictsResult?.errors || []),
+        ],
       };
 
       return result;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		fix:
		- Keep disallowed types when importing with overwrite ([#6668](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6668))