[PM-32743] Convert collections to folders when importing into My Items (#20453)

* [PM-32743] Convert collections to folders when importing into My Items

* Fix multi collection detection bug

* Add tests

Author: mcamirault

apps/browser/src/_locales/en/messages.json

@@ -6641,5 +6641,8 @@
   },
   "hideEmailPolicyInEffect": {
     "message": "Your organization requires email visibility. Uncheck \"Hide your email from viewers\" to save."
+  },
+  "errorImportingMyItemsMultiCollection": {
+    "message": "You cannot import items into My Items that are part of multiple collections"
   }
 }

apps/desktop/src/locales/en/messages.json

@@ -5233,6 +5233,9 @@
     "message": "Progress bar",
     "description": "This is the name of a page component that displays progress to the user. This string will be used to label the progress bar for a screenreader when multiple progress bars are on a page, like 'Progress bar 1' and 'Progress bar 2'."
   },
+  "errorImportingMyItemsMultiCollection": {
+    "message": "You cannot import items into My Items that are part of multiple collections"
+  },
   "driversLicenseDetails": {
     "message": "License details"
   },

apps/web/src/locales/en/messages.json

@@ -13919,6 +13919,9 @@
     "message": "Progress bar",
     "description": "This is the name of a page component that displays progress to the user. This string will be used to label the progress bar for a screenreader when multiple progress bars are on a page, like 'Progress bar 1' and 'Progress bar 2'."
   },
+  "errorImportingMyItemsMultiCollection": {
+    "message": "You cannot import items into My Items that are part of multiple collections"
+  },
   "searchDriversLicense": {
     "message": "Search licenses"
   },

libs/common/src/models/request/import-organization-ciphers.request.ts

@@ -1,6 +1,7 @@
 // This import has been flagged as unallowed for this class. It may be involved in a circular dependency loop.
 // eslint-disable-next-line no-restricted-imports
 import { CollectionWithIdRequest } from "@bitwarden/admin-console/common";
+import { FolderWithOptionalIdRequest } from "@bitwarden/common/vault/models/request/folder-with-optional-id.request";
 
 import { CipherRequest } from "../../vault/models/request/cipher.request";
 
@@ -10,4 +11,6 @@ export class ImportOrganizationCiphersRequest {
   ciphers: CipherRequest[] = [];
   collections: CollectionWithIdRequest[] = [];
   collectionRelationships: KvpRequest<number, number>[] = [];
+  folders: FolderWithOptionalIdRequest[] = [];
+  folderRelationships: KvpRequest<number, number>[] = [];
 }

libs/importer/src/services/import.service.spec.ts

@@ -281,6 +281,47 @@ describe("ImportService", () => {
       expect(importResult.collectionRelationships.map((r) => r[0])).toEqual([0, 1, 2]);
       expect(importResult.collectionRelationships.every((r) => r[1] === 0)).toBe(true);
     });
+
+    it("If importTarget is of type DefaultUserCollection throw an error if trying to import cipher with multiple collections", async () => {
+      importResult.collections.push(mockCollection1);
+      importResult.collections.push(mockCollection2);
+      importResult.ciphers.push(createCipher({ name: "cipher1" }));
+      importResult.collectionRelationships.push([0, 0], [0, 1]);
+
+      mockImportTargetCollection.type = CollectionTypes.DefaultUserCollection;
+      const setImportTargetMethod = importService["setImportTarget"](
+        importResult,
+        organizationId,
+        mockImportTargetCollection,
+      );
+      await expect(setImportTargetMethod).rejects.toThrow();
+    });
+
+    it("If importTarget is of type DefaultUserCollection create any collections as folders", async () => {
+      importResult.collections.push(mockCollection1);
+      importResult.collections.push(mockCollection2);
+      importResult.ciphers.push(
+        createCipher({ name: "cipher1", collectionIds: [mockCollection1.id] }),
+      );
+      importResult.ciphers.push(
+        createCipher({ name: "cipher2", collectionIds: [mockCollection2.id] }),
+      );
+
+      mockImportTargetCollection.type = CollectionTypes.DefaultUserCollection;
+      await importService["setImportTarget"](
+        importResult,
+        organizationId,
+        mockImportTargetCollection,
+      );
+
+      expect(importResult.collections.length).toEqual(1);
+      expect(importResult.collectionRelationships.length).toEqual(2);
+      expect(importResult.collectionRelationships[0]).toEqual([0, 0]);
+      expect(importResult.collectionRelationships[1]).toEqual([1, 0]);
+      expect(importResult.folders.length).toEqual(2);
+      expect(importResult.folders[0].name).toEqual(mockCollection1.name);
+      expect(importResult.folders[1].name).toEqual(mockCollection2.name);
+    });
   });
 
   describe("handleIndividualImport", () => {

libs/importer/src/services/import.service.ts

@@ -20,6 +20,7 @@ import { ErrorResponse } from "@bitwarden/common/models/response/error.response"
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { Utils } from "@bitwarden/common/platform/misc/utils";
 import { OrganizationId, UserId } from "@bitwarden/common/types/guid";
+import { UserKey } from "@bitwarden/common/types/key";
 import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
 import { FolderService } from "@bitwarden/common/vault/abstractions/folder/folder.service.abstraction";
 import { CipherType, toCipherTypeName } from "@bitwarden/common/vault/enums";
@@ -385,17 +386,8 @@ export class ImportService implements ImportServiceAbstraction {
 
     const userKey = await firstValueFrom(this.keyService.userKey$(userId));
 
-    if (importResult.folders != null) {
-      for (let i = 0; i < importResult.folders.length; i++) {
-        const f = await this.folderService.encrypt(importResult.folders[i], userKey);
-        request.folders.push(new FolderWithOptionalIdRequest(f));
-      }
-    }
-    if (importResult.folderRelationships != null) {
-      importResult.folderRelationships.forEach((r) =>
-        request.folderRelationships.push(new KvpRequest(r[0], r[1])),
-      );
-    }
+    await this.addFolders(request, importResult, userKey);
+
     return await this.importApiService.postImportCiphers(request);
   }
 
@@ -417,6 +409,10 @@ export class ImportService implements ImportServiceAbstraction {
       request.ciphers.push(new CipherRequest(encryptedCipher));
     }
 
+    const userKey = await firstValueFrom(this.keyService.userKey$(userId));
+
+    await this.addFolders(request, importResult, userKey);
+
     if (importResult.collections != null) {
       for (let i = 0; i < importResult.collections.length; i++) {
         importResult.collections[i].organizationId = organizationId;
@@ -432,6 +428,24 @@ export class ImportService implements ImportServiceAbstraction {
     return await this.importApiService.postImportOrganizationCiphers(organizationId, request);
   }
 
+  private async addFolders(
+    request: ImportCiphersRequest | ImportOrganizationCiphersRequest,
+    importResult: ImportResult,
+    userKey: UserKey,
+  ) {
+    if (importResult.folders != null) {
+      for (let i = 0; i < importResult.folders.length; i++) {
+        const f = await this.folderService.encrypt(importResult.folders[i], userKey);
+        request.folders.push(new FolderWithOptionalIdRequest(f));
+      }
+    }
+    if (importResult.folderRelationships != null) {
+      importResult.folderRelationships.forEach((r) =>
+        request.folderRelationships.push(new KvpRequest(r[0], r[1])),
+      );
+    }
+  }
+
   private badData(c: CipherView) {
     return (
       (c.name == null || c.name === "--") &&
@@ -509,16 +523,31 @@ export class ImportService implements ImportServiceAbstraction {
         }
       });
 
-      // My Items collections do not support collection nesting.
-      // Flatten all ciphers from nested collections into the import target.
       if (importTarget.type === CollectionTypes.DefaultUserCollection) {
-        importResult.collections = [importTarget];
-
-        const flattenRelationships: CollectionRelationship[] = [];
-        importResult.ciphers.forEach((c, index) => {
-          flattenRelationships.push([index, 0]);
+        // Since ciphers can only have one folder (for now)
+        // we bail if any are a part of multiple Collections
+        if (
+          importResult.ciphers.some(
+            (_c, c_idx) =>
+              importResult.collectionRelationships.filter((cr) => cr[0] === c_idx).length > 1,
+          )
+        ) {
+          throw new Error(this.i18nService.t("errorImportingMyItemsMultiCollection"));
+        }
+        importResult.folders = importResult.collections.map((c) => {
+          const f = new FolderView();
+          f.name = c.name;
+          return f;
         });
-        importResult.collectionRelationships = flattenRelationships;
+        // We use the collection relationships to create the folder relationships
+        importResult.folderRelationships = importResult.collectionRelationships.map((c) => [
+          c[0],
+          c[1],
+        ]);
+        // We then set the target collection to My Items...
+        importResult.collections = [importTarget];
+        // ...and set the collection relationships accordingly
+        importResult.collectionRelationships = importResult.ciphers.map((_c, idx) => [idx, 0]);
         return;
       }