fix: make importing workspace-specific objects as copy

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

src/core/public/saved_objects/saved_objects_client.ts

@@ -61,7 +61,7 @@ export interface SavedObjectsCreateOptions {
   /** {@inheritDoc SavedObjectsMigrationVersion} */
   migrationVersion?: SavedObjectsMigrationVersion;
   references?: SavedObjectReference[];
-  workspaces?: string[];
+  workspace?: string;
 }
 
 /**
@@ -268,11 +268,7 @@ export class SavedObjectsClient {
         attributes,
         migrationVersion: options.migrationVersion,
         references: options.references,
-        ...(options.workspaces || currentWorkspaceId
-          ? {
-              workspaces: options.workspaces || [currentWorkspaceId],
-            }
-          : {}),
+        workspace: options.workspace || currentWorkspaceId,
       }),
     });
 

src/core/server/saved_objects/export/get_sorted_objects_for_export.ts

@@ -109,7 +109,7 @@ async function fetchObjectsToExport({
     if (typeof search === 'string') {
       throw Boom.badRequest(`Can't specify both "search" and "objects" properties when exporting`);
     }
-    const bulkGetResult = await savedObjectsClient.bulkGet(objects, { namespace, workspaces });
+    const bulkGetResult = await savedObjectsClient.bulkGet(objects, { namespace });
     const erroredObjects = bulkGetResult.saved_objects.filter((obj) => !!obj.error);
     if (erroredObjects.length) {
       const err = Boom.badRequest();

src/core/server/saved_objects/import/create_saved_objects.ts

@@ -39,7 +39,7 @@ interface CreateSavedObjectsParams<T> {
   importIdMap: Map<string, { id?: string; omitOriginId?: boolean }>;
   namespace?: string;
   overwrite?: boolean;
-  workspaces?: string[];
+  workspace?: string;
 }
 interface CreateSavedObjectsResult<T> {
   createdObjects: Array<CreatedObject<T>>;
@@ -57,7 +57,7 @@ export const createSavedObjects = async <T>({
   importIdMap,
   namespace,
   overwrite,
-  workspaces,
+  workspace,
 }: CreateSavedObjectsParams<T>): Promise<CreateSavedObjectsResult<T>> => {
   // filter out any objects that resulted in errors
   const errorSet = accumulatedErrors.reduce(
@@ -105,7 +105,7 @@ export const createSavedObjects = async <T>({
     const bulkCreateResponse = await savedObjectsClient.bulkCreate(objectsToCreate, {
       namespace,
       overwrite,
-      workspaces,
+      workspace,
     });
     expectedResults = bulkCreateResponse.saved_objects;
   }

src/core/server/saved_objects/import/import_saved_objects.ts

@@ -54,7 +54,7 @@ export async function importSavedObjectsFromStream({
   savedObjectsClient,
   typeRegistry,
   namespace,
-  workspaces,
+  workspace,
 }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse> {
   let errorAccumulator: SavedObjectsImportError[] = [];
   const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((type) => type.name);
@@ -119,7 +119,7 @@ export async function importSavedObjectsFromStream({
     importIdMap,
     overwrite,
     namespace,
-    workspaces,
+    workspace,
   };
   const createSavedObjectsResult = await createSavedObjects(createSavedObjectsParams);
   errorAccumulator = [...errorAccumulator, ...createSavedObjectsResult.errors];

src/core/server/saved_objects/import/types.ts

@@ -187,8 +187,8 @@ export interface SavedObjectsImportOptions {
   namespace?: string;
   /** If true, will create new copies of import objects, each with a random `id` and undefined `originId`. */
   createNewCopies: boolean;
-  /** if specified, will import in given workspaces, else will import as global object */
-  workspaces?: string[];
+  /** if specified, will import in given workspace, else will import as global object */
+  workspace?: string;
 }
 
 /**

src/core/server/saved_objects/routes/bulk_create.ts

@@ -30,7 +30,6 @@
 
 import { schema } from '@osd/config-schema';
 import { IRouter } from '../../http';
-import { formatWorkspaces, workspacesValidator } from '../../workspaces';
 
 export const registerBulkCreateRoute = (router: IRouter) => {
   router.post(
@@ -39,7 +38,7 @@ export const registerBulkCreateRoute = (router: IRouter) => {
       validate: {
         query: schema.object({
           overwrite: schema.boolean({ defaultValue: false }),
-          workspaces: workspacesValidator,
+          workspace: schema.maybe(schema.string()),
         }),
         body: schema.arrayOf(
           schema.object({
@@ -63,11 +62,10 @@ export const registerBulkCreateRoute = (router: IRouter) => {
       },
     },
     router.handleLegacyErrors(async (context, req, res) => {
-      const { overwrite } = req.query;
-      const workspaces = formatWorkspaces(req.query.workspaces);
+      const { overwrite, workspace } = req.query;
       const result = await context.core.savedObjects.client.bulkCreate(req.body, {
         overwrite,
-        workspaces,
+        workspace,
       });
       return res.ok({ body: result });
     })

src/core/server/saved_objects/routes/copy.ts

@@ -73,7 +73,7 @@ export const registerCopyRoute = (router: IRouter, config: SavedObjectConfig) =>
         objectLimit: maxImportExportSize,
         overwrite: false,
         createNewCopies: true,
-        workspaces: [targetWorkspace],
+        workspace: targetWorkspace,
       });
 
       return res.ok({ body: result });

src/core/server/saved_objects/routes/create.ts

@@ -56,22 +56,22 @@ export const registerCreateRoute = (router: IRouter) => {
             )
           ),
           initialNamespaces: schema.maybe(schema.arrayOf(schema.string(), { minSize: 1 })),
-          workspaces: schema.maybe(schema.arrayOf(schema.string(), { minSize: 1 })),
+          workspace: schema.maybe(schema.string()),
         }),
       },
     },
     router.handleLegacyErrors(async (context, req, res) => {
       const { type, id } = req.params;
       const { overwrite } = req.query;
-      const { attributes, migrationVersion, references, initialNamespaces, workspaces } = req.body;
+      const { attributes, migrationVersion, references, initialNamespaces, workspace } = req.body;
 
       const options = {
         id,
         overwrite,
         migrationVersion,
         references,
         initialNamespaces,
-        workspaces,
+        workspace,
       };
       const result = await context.core.savedObjects.client.create(type, attributes, options);
       return res.ok({ body: result });

src/core/server/saved_objects/routes/import.ts

@@ -35,7 +35,6 @@ import { IRouter } from '../../http';
 import { importSavedObjectsFromStream } from '../import';
 import { SavedObjectConfig } from '../saved_objects_config';
 import { createSavedObjectsStreamFromNdJson } from './utils';
-import { formatWorkspaces, workspacesValidator } from '../../workspaces';
 
 interface FileStream extends Readable {
   hapi: {
@@ -61,7 +60,7 @@ export const registerImportRoute = (router: IRouter, config: SavedObjectConfig)
           {
             overwrite: schema.boolean({ defaultValue: false }),
             createNewCopies: schema.boolean({ defaultValue: false }),
-            workspaces: workspacesValidator,
+            workspace: schema.maybe(schema.string()),
           },
           {
             validate: (object) => {
@@ -77,7 +76,7 @@ export const registerImportRoute = (router: IRouter, config: SavedObjectConfig)
       },
     },
     router.handleLegacyErrors(async (context, req, res) => {
-      const { overwrite, createNewCopies } = req.query;
+      const { overwrite, createNewCopies, workspace } = req.query;
       const file = req.body.file as FileStream;
       const fileExtension = extname(file.hapi.filename).toLowerCase();
       if (fileExtension !== '.ndjson') {
@@ -93,16 +92,14 @@ export const registerImportRoute = (router: IRouter, config: SavedObjectConfig)
         });
       }
 
-      const workspaces = formatWorkspaces(req.query.workspaces);
-
       const result = await importSavedObjectsFromStream({
         savedObjectsClient: context.core.savedObjects.client,
         typeRegistry: context.core.savedObjects.typeRegistry,
         readStream,
         objectLimit: maxImportExportSize,
         overwrite,
         createNewCopies,
-        workspaces,
+        workspace,
       });
 
       return res.ok({ body: result });

src/core/server/saved_objects/service/lib/repository.ts

@@ -217,6 +217,18 @@ export class SavedObjectsRepository {
     this._serializer = serializer;
   }
 
+  private isSharedObject(object: SavedObject) {
+    if (!object.workspaces || object.workspaces.includes('public')) {
+      return true;
+    }
+
+    return false;
+  }
+
+  private isWorkspaceSpecificObject(object: SavedObject) {
+    return !this.isSharedObject(object);
+  }
+
   /**
    * Persists an object
    *
@@ -244,7 +256,7 @@ export class SavedObjectsRepository {
       originId,
       initialNamespaces,
       version,
-      workspaces,
+      workspace,
     } = options;
     const namespace = normalizeNamespace(options.namespace);
 
@@ -281,7 +293,7 @@ export class SavedObjectsRepository {
       }
     }
 
-    let savedObjectWorkspaces = workspaces;
+    let savedObjectWorkspaces = workspace ? [workspace] : undefined;
 
     if (id && overwrite) {
       try {
@@ -372,15 +384,28 @@ export class SavedObjectsRepository {
 
       const method = object.id && overwrite ? 'index' : 'create';
       const requiresNamespacesCheck = object.id && this._registry.isMultiNamespace(object.type);
+      /**
+       * Only when importing an object to a target workspace should we check if the object is workspace-specific.
+       */
+      const requiresWorkspaceCheck = object.id && options.workspace;
 
       if (object.id == null) object.id = uuid.v1();
 
+      let opensearchRequestIndexPayload = {};
+
+      if (requiresNamespacesCheck || requiresWorkspaceCheck) {
+        opensearchRequestIndexPayload = {
+          opensearchRequestIndex: bulkGetRequestIndexCounter,
+        };
+        bulkGetRequestIndexCounter++;
+      }
+
       return {
         tag: 'Right' as 'Right',
         value: {
           method,
           object,
-          ...(requiresNamespacesCheck && { opensearchRequestIndex: bulkGetRequestIndexCounter++ }),
+          ...opensearchRequestIndexPayload,
         },
       };
     });
@@ -391,7 +416,7 @@ export class SavedObjectsRepository {
       .map(({ value: { object: { type, id } } }) => ({
         _id: this._serializer.generateRawId(namespace, type, id),
         _index: this.getIndexForType(type),
-        _source: ['type', 'namespaces'],
+        _source: ['type', 'namespaces', 'workspaces'],
       }));
     const bulkGetResponse = bulkGetDocs.length
       ? await this.client.mget(
@@ -420,15 +445,8 @@ export class SavedObjectsRepository {
         method,
       } = expectedBulkGetResult.value;
       let savedObjectWorkspaces: string[] | undefined;
-      if (expectedBulkGetResult.value.method === 'create') {
-        if (options.workspaces) {
-          savedObjectWorkspaces = Array.from(new Set([...(options.workspaces || [])]));
-        }
-      } else if (object.workspaces) {
-        savedObjectWorkspaces = Array.from(
-          new Set([...object.workspaces, ...(options.workspaces || [])])
-        );
-      }
+      let finalMethod = method;
+      let finalObjectId = object.id;
       if (opensearchRequestIndex !== undefined) {
         const indexFound = bulkGetResponse?.statusCode !== 404;
         const actualResult = indexFound
@@ -465,12 +483,49 @@ export class SavedObjectsRepository {
         versionProperties = getExpectedVersionProperties(version);
       }
 
+      if (expectedBulkGetResult.value.method === 'create') {
+        if (options.workspace) {
+          savedObjectWorkspaces = [options.workspace];
+        }
+      } else {
+        /**
+         * When overwrite, need to check if the object is workspace-specific
+         * if so, copy object to target workspace instead of refering it.
+         */
+        if (opensearchRequestIndex !== undefined && bulkGetResponse?.statusCode !== 404) {
+          const rawId = this._serializer.generateRawId(namespace, object.type, object.id);
+          const findObject = bulkGetResponse?.body.docs?.find((item) => item._id === rawId);
+          if (findObject && findObject.found) {
+            const transformedObject = this._serializer.rawToSavedObject(
+              findObject as SavedObjectsRawDoc
+            ) as SavedObject;
+            if (
+              options.workspace &&
+              this.isWorkspaceSpecificObject(transformedObject) &&
+              !transformedObject.workspaces?.includes(options.workspace)
+            ) {
+              finalMethod = 'create';
+              finalObjectId = uuid.v1();
+              savedObjectWorkspaces = [options.workspace];
+              versionProperties = {};
+            } else {
+              savedObjectWorkspaces = transformedObject.workspaces;
+            }
+          } else {
+            finalMethod = 'create';
+            finalObjectId = object.id;
+            savedObjectWorkspaces = options.workspace ? [options.workspace] : undefined;
+            versionProperties = {};
+          }
+        }
+      }
+
       const expectedResult = {
         opensearchRequestIndex: bulkRequestIndexCounter++,
-        requestedId: object.id,
+        requestedId: finalObjectId,
         rawMigratedDoc: this._serializer.savedObjectToRaw(
           this._migrator.migrateDocument({
-            id: object.id,
+            id: finalObjectId,
             type: object.type,
             attributes: object.attributes,
             migrationVersion: object.migrationVersion,
@@ -486,7 +541,7 @@ export class SavedObjectsRepository {
 
       bulkCreateParams.push(
         {
-          [method]: {
+          [finalMethod]: {
             _id: expectedResult.rawMigratedDoc._id,
             _index: this.getIndexForType(object.type),
             ...(overwrite && versionProperties),

src/core/server/saved_objects/types.ts

@@ -120,7 +120,7 @@ export interface SavedObjectsFindOptions {
 export interface SavedObjectsBaseOptions {
   /** Specify the namespace for this operation */
   namespace?: string;
-  workspaces?: string[];
+  workspace?: string;
 }
 
 /**

src/plugins/saved_objects_management/public/lib/import_file.ts

@@ -40,11 +40,11 @@ interface ImportResponse {
 export async function importFile(
   http: HttpStart,
   file: File,
-  { createNewCopies, overwrite, workspaces }: ImportMode
+  { createNewCopies, overwrite, workspace }: ImportMode
 ) {
   const formData = new FormData();
   formData.append('file', file);
-  const query = createNewCopies ? { createNewCopies, workspaces } : { overwrite, workspaces };
+  const query = createNewCopies ? { createNewCopies, workspace } : { overwrite, workspace };
   return await http.post<ImportResponse>('/api/saved_objects/_import', {
     body: formData,
     headers: {