[PM-1071] Display import-details-dialog on successful import (#4817)

* Prefer callback over error-flow to prompt for password

Remove error-flow to request file password
Prefer callback, which has to be provided when retrieving/creating an instance.
Delete ImportError
Call BitwardenPasswordProtector for all Bitwarden json imports, as it extends BitwardenJsonImporter
Throw errors instead of returning
Return ImportResult
Fix and extend tests import.service
Replace "@fluffy-spoon/substitute" with "jest-mock-extended"

* Fix up test cases

Delete bitwarden-json-importer.spec.ts
Add test case to ensure bitwarden-json-importer.ts is called given unencrypted or account-protected files

* Move file-password-prompt into dialog-folder

* Add import success dialog

* Fix typo

* Only list the type when at least one got imported

* update copy based on design feedback

* Remove unnecessary /index import

* Remove promptForPassword_callback from interface

PR feedback from @MGibson1 that giving every importer the ability to request a password is unnecessary. Instead, we can pass the callback into the constructor for every importer that needs this functionality

* Remove unneeded import of BitwardenJsonImporter

* Fix spec constructor

* Fixed organizational import

Added an else statement, or else we'd import into an org and then also import into an individual vault

libs/importer/spec/bitwarden-json-importer.spec.ts

@@ -1,33 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import { Substitute, SubstituteOf } from "@fluffy-spoon/substitute";
-
-import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
-import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
-
-import { BitwardenJsonImporter } from "../src/importers";
-
-import { data as passwordProtectedData } from "./test-data/bitwarden-json/password-protected.json";
-
-describe("bitwarden json importer", () => {
-  let sut: BitwardenJsonImporter;
-  let cryptoService: SubstituteOf<CryptoService>;
-  let i18nService: SubstituteOf<I18nService>;
-
-  beforeEach(() => {
-    cryptoService = Substitute.for<CryptoService>();
-    i18nService = Substitute.for<I18nService>();
-
-    sut = new BitwardenJsonImporter(cryptoService, i18nService);
-  });
-
-  it("should fail if password is needed", async () => {
-    expect((await sut.parse(passwordProtectedData)).success).toBe(false);
-  });
-
-  it("should return password needed error message", async () => {
-    const expected = "Password required error message";
-    i18nService.t("importPasswordRequired").returns(expected);
-
-    expect((await sut.parse(passwordProtectedData)).errorMessage).toEqual(expected);
-  });
-});

libs/importer/spec/bitwarden-password-protected-importer.spec.ts

@@ -1,77 +1,89 @@
-// eslint-disable-next-line no-restricted-imports
-import { Substitute, Arg, SubstituteOf } from "@fluffy-spoon/substitute";
+import { mock, MockProxy } from "jest-mock-extended";
 
 import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
 import { KdfType } from "@bitwarden/common/enums";
 import { Utils } from "@bitwarden/common/misc/utils";
 
-import { BitwardenPasswordProtectedImporter } from "../src/importers";
-import { ImportResult } from "../src/models/import-result";
+import {
+  BitwardenPasswordProtectedImporter,
+  BitwardenJsonImporter,
+} from "../src/importers/bitwarden";
 
-import { data as emptyDecryptedData } from "./test-data/bitwarden-json/empty.json";
+import { emptyAccountEncrypted } from "./test-data/bitwarden-json/account-encrypted.json";
+import { emptyUnencryptedExport } from "./test-data/bitwarden-json/unencrypted.json";
 
 describe("BitwardenPasswordProtectedImporter", () => {
   let importer: BitwardenPasswordProtectedImporter;
-  let cryptoService: SubstituteOf<CryptoService>;
-  let i18nService: SubstituteOf<I18nService>;
+  let cryptoService: MockProxy<CryptoService>;
+  let i18nService: MockProxy<I18nService>;
   const password = Utils.newGuid();
-  const result = new ImportResult();
-  let jDoc: {
-    encrypted?: boolean;
-    passwordProtected?: boolean;
-    salt?: string;
-    kdfIterations?: any;
-    kdfType?: any;
-    encKeyValidation_DO_NOT_EDIT?: string;
-    data?: string;
+  const promptForPassword_callback = async () => {
+    return password;
   };
 
   beforeEach(() => {
-    cryptoService = Substitute.for<CryptoService>();
-    i18nService = Substitute.for<I18nService>();
+    cryptoService = mock<CryptoService>();
+    i18nService = mock<I18nService>();
 
-    jDoc = {
-      encrypted: true,
-      passwordProtected: true,
-      salt: "c2FsdA==",
-      kdfIterations: 100000,
-      kdfType: KdfType.PBKDF2_SHA256,
-      encKeyValidation_DO_NOT_EDIT: Utils.newGuid(),
-      data: Utils.newGuid(),
-    };
-
-    result.success = true;
-    importer = new BitwardenPasswordProtectedImporter(cryptoService, i18nService, password);
+    importer = new BitwardenPasswordProtectedImporter(
+      cryptoService,
+      i18nService,
+      promptForPassword_callback
+    );
   });
 
-  describe("Required Json Data", () => {
+  describe("Unencrypted", () => {
+    beforeAll(() => {
+      jest.spyOn(BitwardenJsonImporter.prototype, "parse");
+    });
+
+    it("Should call BitwardenJsonImporter", async () => {
+      expect((await importer.parse(emptyUnencryptedExport)).success).toEqual(true);
+      expect(BitwardenJsonImporter.prototype.parse).toHaveBeenCalledWith(emptyUnencryptedExport);
+    });
+  });
+
+  describe("Account encrypted", () => {
+    beforeAll(() => {
+      jest.spyOn(BitwardenJsonImporter.prototype, "parse");
+    });
+
+    it("Should call BitwardenJsonImporter", async () => {
+      expect((await importer.parse(emptyAccountEncrypted)).success).toEqual(true);
+      expect(BitwardenJsonImporter.prototype.parse).toHaveBeenCalledWith(emptyAccountEncrypted);
+    });
+  });
+
+  describe("Password protected", () => {
+    let jDoc: {
+      encrypted?: boolean;
+      passwordProtected?: boolean;
+      salt?: string;
+      kdfIterations?: any;
+      kdfType?: any;
+      encKeyValidation_DO_NOT_EDIT?: string;
+      data?: string;
+    };
+
+    beforeEach(() => {
+      jDoc = {
+        encrypted: true,
+        passwordProtected: true,
+        salt: "c2FsdA==",
+        kdfIterations: 100000,
+        kdfType: KdfType.PBKDF2_SHA256,
+        encKeyValidation_DO_NOT_EDIT: Utils.newGuid(),
+        data: Utils.newGuid(),
+      };
+    });
+
     it("succeeds with default jdoc", async () => {
-      cryptoService.decryptToUtf8(Arg.any(), Arg.any()).resolves(emptyDecryptedData);
+      cryptoService.decryptToUtf8.mockReturnValue(Promise.resolve(emptyUnencryptedExport));
 
       expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(true);
     });
 
-    it("fails if encrypted === false", async () => {
-      jDoc.encrypted = false;
-      expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(false);
-    });
-
-    it("fails if encrypted === null", async () => {
-      jDoc.encrypted = null;
-      expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(false);
-    });
-
-    it("fails if passwordProtected === false", async () => {
-      jDoc.passwordProtected = false;
-      expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(false);
-    });
-
-    it("fails if passwordProtected === null", async () => {
-      jDoc.passwordProtected = null;
-      expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(false);
-    });
-
     it("fails if salt === null", async () => {
       jDoc.salt = null;
       expect((await importer.parse(JSON.stringify(jDoc))).success).toEqual(false);

libs/importer/spec/test-data/bitwarden-json/account-encrypted.json.ts

@@ -0,0 +1,6 @@
+export const emptyAccountEncrypted = `{
+  "encrypted": true,
+  "encKeyValidation_DO_NOT_EDIT": "",
+  "folders": [],
+  "items": []
+}`;

libs/importer/spec/test-data/bitwarden-json/empty.json.ts

@@ -1 +0,0 @@
-export const data = '{"encrypted":false,"folders":[],"items":[]}';

libs/importer/spec/test-data/bitwarden-json/password-protected.json.ts

@@ -1,9 +1,10 @@
-export const data = `{
-  "encrypted": true,
-  "passwordProtected": true,
-  "salt": "Oy0xcgVRzxQ+9NpB5GLehw==",
-  "kdfIterations": 100000,
-  "kdfType": 0,
-  "encKeyValidation_DO_NOT_EDIT": "2.sZs4Jc1HW9rhABzRRYR/gQ==|8kTDaDxafulnybpWoqVX8RAybhVRTr+dffNjms271Y7amQmIE1VSMwLbk+b2vxZb|IqOo6oXQtmv/Xb/GHDi42XG9c9ILePYtP5qq584VWcg=",
-  "data": "2.D0AXAf7G/XIwq6EC7A0Suw==|4w+m0wHRo25y1T1Syh5wdAUyF8voqEy54waMEsbnK0Nzee959w54ru5D1NntvxZL4HFqkQLyR6jCFkn5g40f+MGJgihS/wvf4NcJJfLiiFo6MEDOQNBkxw7ZBGuHiKfVuBO5u36JgzQtZ8lyFaduGxFszuF5c+URiE9PDh9jY0//poVgHKwuLZuYFIW+f7h6T+shUWK0ya11lcHn/B/CA2xiI+YiKdNZreJrwN0yslpJ/f+MrOzagvftRjt0GNkwveCtwcYUw/zFvqvibUpKeHcRiXs8SaGoHJ5RTm69FbJ7C5tnLwoVT89Af156uvRAXV7yAC4oPcbU/3TGb6hqYosvi1QNyaqG3M9gxS6+AK0C4yWuNbMLDEr+MWiw0SWLVMKQEkCZ4oM+oTCx52otW3+2V9I8Pv3KmmhkvVvE4wBdweOJeRX53Tf5ySkmpIhCfzj6JMmxO+nmTXIhWnJChr4hPVh+ixv1GQK5thIPTCMXmAtXoTIFUx1KWjS6LjOdi2hKQueVI+XZjf0qnY2vTMxRg0ZsLBA2znQTx+DSEqumORb5T/lV73pWZiCNePSAE2msOm7tep+lm4O/VCViCfXjITAY196syhOK0XnhxJvPALchZY8sYRAfuw6hHoDiVr+JUieRoI7eUrhXBp+D6Py9TL/dS/rHe+C2Zhx+xwx2NfGt+xEp8ZAOOCxgZ0UTeSA/abm0Oz7tJIK1n26acQrgbr7rMeBymAX+5L5OWlwI1hGgEBfj6W0rrbSXf3VMfaFXZ5UsXi1VhzQmU3LyWENoDeImXFQj6zMbUSfcVwLsG5Fg8Ee/kO/wJPfG5BO51+/vFqQj6AkaMEcwg5xNrObHYfQ/DMhIn7YDM2zdzbNTdhnobGkz6YRKFPCgFe3EmIEPEpeh9S3eKE9C7MQsrR8jVSiseR/FipJLsN+W7iOwzeXdwxUFlC/0a98bTKvdrbMgNi6ZVXykHY/t2UyEGpxZGTHoZwhX01kiQrwzC4/+v/676ldxPluO9GY7MtrLveCDsiyBz15u43IGHayDEBNT0rqrOKLYmfzwCWoahRLZQrSmepe/FXqgPqRfyWc/Ro+w3sT9dXUkx3B5xxWgSyABowPV48yBUSJuefhKTpqgzkU+LzhNnWHjnxJzzQ2/|IhlRjnyhIoDM85qHX/bY2zaIU5YaRO/iFVTQDd3uFDo="
-}`;
+export const data = {
+  encrypted: true,
+  passwordProtected: true,
+  salt: "Oy0xcgVRzxQ+9NpB5GLehw==",
+  kdfIterations: 100000,
+  kdfType: 0,
+  encKeyValidation_DO_NOT_EDIT:
+    "2.sZs4Jc1HW9rhABzRRYR/gQ==|8kTDaDxafulnybpWoqVX8RAybhVRTr+dffNjms271Y7amQmIE1VSMwLbk+b2vxZb|IqOo6oXQtmv/Xb/GHDi42XG9c9ILePYtP5qq584VWcg=",
+  data: "2.D0AXAf7G/XIwq6EC7A0Suw==|4w+m0wHRo25y1T1Syh5wdAUyF8voqEy54waMEsbnK0Nzee959w54ru5D1NntvxZL4HFqkQLyR6jCFkn5g40f+MGJgihS/wvf4NcJJfLiiFo6MEDOQNBkxw7ZBGuHiKfVuBO5u36JgzQtZ8lyFaduGxFszuF5c+URiE9PDh9jY0//poVgHKwuLZuYFIW+f7h6T+shUWK0ya11lcHn/B/CA2xiI+YiKdNZreJrwN0yslpJ/f+MrOzagvftRjt0GNkwveCtwcYUw/zFvqvibUpKeHcRiXs8SaGoHJ5RTm69FbJ7C5tnLwoVT89Af156uvRAXV7yAC4oPcbU/3TGb6hqYosvi1QNyaqG3M9gxS6+AK0C4yWuNbMLDEr+MWiw0SWLVMKQEkCZ4oM+oTCx52otW3+2V9I8Pv3KmmhkvVvE4wBdweOJeRX53Tf5ySkmpIhCfzj6JMmxO+nmTXIhWnJChr4hPVh+ixv1GQK5thIPTCMXmAtXoTIFUx1KWjS6LjOdi2hKQueVI+XZjf0qnY2vTMxRg0ZsLBA2znQTx+DSEqumORb5T/lV73pWZiCNePSAE2msOm7tep+lm4O/VCViCfXjITAY196syhOK0XnhxJvPALchZY8sYRAfuw6hHoDiVr+JUieRoI7eUrhXBp+D6Py9TL/dS/rHe+C2Zhx+xwx2NfGt+xEp8ZAOOCxgZ0UTeSA/abm0Oz7tJIK1n26acQrgbr7rMeBymAX+5L5OWlwI1hGgEBfj6W0rrbSXf3VMfaFXZ5UsXi1VhzQmU3LyWENoDeImXFQj6zMbUSfcVwLsG5Fg8Ee/kO/wJPfG5BO51+/vFqQj6AkaMEcwg5xNrObHYfQ/DMhIn7YDM2zdzbNTdhnobGkz6YRKFPCgFe3EmIEPEpeh9S3eKE9C7MQsrR8jVSiseR/FipJLsN+W7iOwzeXdwxUFlC/0a98bTKvdrbMgNi6ZVXykHY/t2UyEGpxZGTHoZwhX01kiQrwzC4/+v/676ldxPluO9GY7MtrLveCDsiyBz15u43IGHayDEBNT0rqrOKLYmfzwCWoahRLZQrSmepe/FXqgPqRfyWc/Ro+w3sT9dXUkx3B5xxWgSyABowPV48yBUSJuefhKTpqgzkU+LzhNnWHjnxJzzQ2/|IhlRjnyhIoDM85qHX/bY2zaIU5YaRO/iFVTQDd3uFDo=",
+};

libs/importer/spec/test-data/bitwarden-json/unencrypted.json.ts

@@ -0,0 +1 @@
+export const emptyUnencryptedExport = `{ "encrypted": false,  "folders": [],  "items": [] }`;