[ADR-16] Refactor Folders

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-  "cSpell.words": ["Popout", "Reprompt", "takeuntil"]
+  "cSpell.words": ["Decryptable", "Encryptable", "Popout", "Reprompt", "takeuntil"]
 }

apps/browser/src/popup/settings/folder-add-edit.component.ts

@@ -3,6 +3,7 @@ import { ActivatedRoute, Router } from "@angular/router";
 import { first } from "rxjs/operators";
 
 import { FolderAddEditComponent as BaseFolderAddEditComponent } from "@bitwarden/angular/components/folder-add-edit.component";
+import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { FolderApiServiceAbstraction } from "@bitwarden/common/abstractions/folder/folder-api.service.abstraction";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
@@ -22,9 +23,17 @@ export class FolderAddEditComponent extends BaseFolderAddEditComponent {
     platformUtilsService: PlatformUtilsService,
     private router: Router,
     private route: ActivatedRoute,
-    logService: LogService
+    logService: LogService,
+    cryptoService: CryptoService
   ) {
-    super(folderService, folderApiService, i18nService, platformUtilsService, logService);
+    super(
+      folderService,
+      folderApiService,
+      i18nService,
+      platformUtilsService,
+      logService,
+      cryptoService
+    );
   }
 
   async ngOnInit() {

apps/cli/src/commands/create.command.ts

@@ -13,6 +13,7 @@ import { CollectionExport } from "@bitwarden/common/models/export/collection.exp
 import { FolderExport } from "@bitwarden/common/models/export/folder.export";
 import { CollectionRequest } from "@bitwarden/common/models/request/collection.request";
 import { SelectionReadOnlyRequest } from "@bitwarden/common/models/request/selection-read-only.request";
+import { FolderView } from "@bitwarden/common/models/view/folder.view";
 
 import { OrganizationCollectionRequest } from "../models/request/organization-collection.request";
 import { Response } from "../models/response";
@@ -148,11 +149,11 @@ export class CreateCommand {
   }
 
   private async createFolder(req: FolderExport) {
-    const folder = await this.folderService.encrypt(FolderExport.toView(req));
+    const folder = await this.cryptoService.encryptView(FolderExport.toView(req));
     try {
       await this.folderApiService.save(folder);
       const newFolder = await this.folderService.get(folder.id);
-      const decFolder = await newFolder.decrypt();
+      const decFolder = await this.cryptoService.decrypt(FolderView, newFolder);
       const res = new FolderResponse(decFolder);
       return Response.success(res);
     } catch (e) {

apps/cli/src/commands/edit.command.ts

@@ -9,6 +9,7 @@ import { CollectionExport } from "@bitwarden/common/models/export/collection.exp
 import { FolderExport } from "@bitwarden/common/models/export/folder.export";
 import { CollectionRequest } from "@bitwarden/common/models/request/collection.request";
 import { SelectionReadOnlyRequest } from "@bitwarden/common/models/request/selection-read-only.request";
+import { FolderView } from "@bitwarden/common/models/view/folder.view";
 
 import { OrganizationCollectionRequest } from "../models/request/organization-collection.request";
 import { Response } from "../models/response";
@@ -123,13 +124,13 @@ export class EditCommand {
       return Response.notFound();
     }
 
-    let folderView = await folder.decrypt();
+    let folderView = await this.cryptoService.decrypt(FolderView, folder);
     folderView = FolderExport.toView(req, folderView);
-    const encFolder = await this.folderService.encrypt(folderView);
+    const encFolder = await this.cryptoService.encryptView(folderView);
     try {
       await this.folderApiService.save(encFolder);
       const updatedFolder = await this.folderService.get(folder.id);
-      const decFolder = await updatedFolder.decrypt();
+      const decFolder = await this.cryptoService.decrypt(FolderView, updatedFolder);
       const res = new FolderResponse(decFolder);
       return Response.success(res);
     } catch (e) {

apps/cli/src/commands/get.command.ts

@@ -355,7 +355,7 @@ export class GetCommand extends DownloadCommand {
     if (Utils.isGuid(id)) {
       const folder = await this.folderService.getFromState(id);
       if (folder != null) {
-        decFolder = await folder.decrypt();
+        decFolder = await this.cryptoService.decrypt(FolderView, folder);
       }
     } else if (id.trim() !== "") {
       let folders = await this.folderService.getAllDecryptedFromState();

apps/desktop/src/app/vault/folder-add-edit.component.ts

@@ -1,6 +1,7 @@
 import { Component } from "@angular/core";
 
 import { FolderAddEditComponent as BaseFolderAddEditComponent } from "@bitwarden/angular/components/folder-add-edit.component";
+import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { FolderApiServiceAbstraction } from "@bitwarden/common/abstractions/folder/folder-api.service.abstraction";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
@@ -17,8 +18,16 @@ export class FolderAddEditComponent extends BaseFolderAddEditComponent {
     folderApiService: FolderApiServiceAbstraction,
     i18nService: I18nService,
     platformUtilsService: PlatformUtilsService,
-    logService: LogService
+    logService: LogService,
+    cryptoService: CryptoService
   ) {
-    super(folderService, folderApiService, i18nService, platformUtilsService, logService);
+    super(
+      folderService,
+      folderApiService,
+      i18nService,
+      platformUtilsService,
+      logService,
+      cryptoService
+    );
   }
 }

apps/web/src/app/settings/change-password.component.ts

@@ -6,6 +6,7 @@ import { ChangePasswordComponent as BaseChangePasswordComponent } from "@bitward
 import { ApiService } from "@bitwarden/common/abstractions/api.service";
 import { CipherService } from "@bitwarden/common/abstractions/cipher.service";
 import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
+import { EncryptService } from "@bitwarden/common/abstractions/encrypt.service";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
 import { KeyConnectorService } from "@bitwarden/common/abstractions/keyConnector.service";
@@ -55,7 +56,8 @@ export class ChangePasswordComponent extends BaseChangePasswordComponent {
     private organizationService: OrganizationService,
     private keyConnectorService: KeyConnectorService,
     private router: Router,
-    private organizationApiService: OrganizationApiServiceAbstraction
+    private organizationApiService: OrganizationApiServiceAbstraction,
+    private encryptService: EncryptService
   ) {
     super(
       i18nService,
@@ -204,7 +206,7 @@ export class ChangePasswordComponent extends BaseChangePasswordComponent {
       if (folders[i].id == null) {
         continue;
       }
-      const folder = await this.folderService.encrypt(folders[i], encKey[0]);
+      const folder = await folders[i].encrypt(this.encryptService, encKey[0]);
       request.folders.push(new FolderWithIdRequest(folder));
     }
 

apps/web/src/app/settings/update-key.component.ts

@@ -4,6 +4,7 @@ import { firstValueFrom } from "rxjs";
 import { ApiService } from "@bitwarden/common/abstractions/api.service";
 import { CipherService } from "@bitwarden/common/abstractions/cipher.service";
 import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
+import { EncryptService } from "@bitwarden/common/abstractions/encrypt.service";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
 import { LogService } from "@bitwarden/common/abstractions/log.service";
@@ -32,7 +33,8 @@ export class UpdateKeyComponent {
     private syncService: SyncService,
     private folderService: FolderService,
     private cipherService: CipherService,
-    private logService: LogService
+    private logService: LogService,
+    private encryptService: EncryptService
   ) {}
 
   async submit() {
@@ -87,7 +89,7 @@ export class UpdateKeyComponent {
       if (folders[i].id == null) {
         continue;
       }
-      const folder = await this.folderService.encrypt(folders[i], encKey[0]);
+      const folder = await folders[i].encrypt(this.encryptService, encKey[0]);
       request.folders.push(new FolderWithIdRequest(folder));
     }
 

apps/web/src/app/vault/folder-add-edit.component.ts

@@ -1,6 +1,7 @@
 import { Component } from "@angular/core";
 
 import { FolderAddEditComponent as BaseFolderAddEditComponent } from "@bitwarden/angular/components/folder-add-edit.component";
+import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { FolderApiServiceAbstraction } from "@bitwarden/common/abstractions/folder/folder-api.service.abstraction";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
@@ -17,8 +18,16 @@ export class FolderAddEditComponent extends BaseFolderAddEditComponent {
     folderApiService: FolderApiServiceAbstraction,
     i18nService: I18nService,
     platformUtilsService: PlatformUtilsService,
-    logService: LogService
+    logService: LogService,
+    cryptoService: CryptoService
   ) {
-    super(folderService, folderApiService, i18nService, platformUtilsService, logService);
+    super(
+      folderService,
+      folderApiService,
+      i18nService,
+      platformUtilsService,
+      logService,
+      cryptoService
+    );
   }
 }

libs/angular/src/components/folder-add-edit.component.ts

@@ -1,5 +1,6 @@
 import { Directive, EventEmitter, Input, OnInit, Output } from "@angular/core";
 
+import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { FolderApiServiceAbstraction } from "@bitwarden/common/abstractions/folder/folder-api.service.abstraction";
 import { FolderService } from "@bitwarden/common/abstractions/folder/folder.service.abstraction";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
@@ -24,7 +25,8 @@ export class FolderAddEditComponent implements OnInit {
     protected folderApiService: FolderApiServiceAbstraction,
     protected i18nService: I18nService,
     protected platformUtilsService: PlatformUtilsService,
-    private logService: LogService
+    private logService: LogService,
+    private cryptoService: CryptoService
   ) {}
 
   async ngOnInit() {
@@ -42,7 +44,7 @@ export class FolderAddEditComponent implements OnInit {
     }
 
     try {
-      const folder = await this.folderService.encrypt(this.folder);
+      const folder = await this.cryptoService.encryptView(this.folder);
       this.formPromise = this.folderApiService.save(folder);
       await this.formPromise;
       this.platformUtilsService.showToast(
@@ -90,7 +92,7 @@ export class FolderAddEditComponent implements OnInit {
       this.editMode = true;
       this.title = this.i18nService.t("editFolder");
       const folder = await this.folderService.get(this.folderId);
-      this.folder = await folder.decrypt();
+      this.folder = await this.cryptoService.decryptView(FolderView, folder);
     } else {
       this.title = this.i18nService.t("addFolder");
     }

libs/common/spec/models/domain/folder.spec.ts

@@ -2,7 +2,7 @@ import { FolderData } from "@bitwarden/common/models/data/folder.data";
 import { EncString } from "@bitwarden/common/models/domain/enc-string";
 import { Folder } from "@bitwarden/common/models/domain/folder";
 
-import { mockEnc, mockFromJson } from "../../utils";
+import { mockFromJson } from "../../utils";
 
 describe("Folder", () => {
   let data: FolderData;
@@ -25,21 +25,6 @@ describe("Folder", () => {
     });
   });
 
-  it("Decrypt", async () => {
-    const folder = new Folder();
-    folder.id = "id";
-    folder.name = mockEnc("encName");
-    folder.revisionDate = new Date("2022-01-31T12:00:00.000Z");
-
-    const view = await folder.decrypt();
-
-    expect(view).toEqual({
-      id: "id",
-      name: "encName",
-      revisionDate: new Date("2022-01-31T12:00:00.000Z"),
-    });
-  });
-
   describe("fromJSON", () => {
     jest.mock("@bitwarden/common/models/domain/enc-string");
     jest.spyOn(EncString, "fromJSON").mockImplementation(mockFromJson);

libs/common/spec/models/view/folderView.spec.ts

@@ -1,5 +1,12 @@
+import { mock } from "jest-mock-extended";
+
+import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
+import { EncString } from "@bitwarden/common/models/domain/enc-string";
+import { Folder } from "@bitwarden/common/models/domain/folder";
 import { FolderView } from "@bitwarden/common/models/view/folder.view";
 
+import { mockEnc } from "../../utils";
+
 describe("FolderView", () => {
   describe("fromJSON", () => {
     it("initializes nested objects", () => {
@@ -19,4 +26,53 @@ describe("FolderView", () => {
       expect(actual).toMatchObject(expected);
     });
   });
+
+  describe("decrypt", () => {
+    it("with name", async () => {
+      const folder = new Folder();
+      folder.id = "id";
+      folder.name = mockEnc("encName");
+      folder.revisionDate = new Date("2022-01-31T12:00:00.000Z");
+
+      const view = await FolderView.decrypt(null, null, folder);
+
+      expect(view).toEqual({
+        id: "id",
+        name: "encName",
+        revisionDate: new Date("2022-01-31T12:00:00.000Z"),
+      });
+    });
+
+    it("without name", async () => {
+      const folder = new Folder();
+      folder.id = "id";
+
+      const view = await FolderView.decrypt(null, null, folder);
+
+      expect(view).toEqual({
+        id: "id",
+      });
+    });
+  });
+
+  it("encrypt", async () => {
+    const view = new FolderView();
+    view.id = "2";
+    view.name = "Test Folder";
+    view.revisionDate = new Date("2022-10-31T10:16:45+00:00");
+
+    const cryptoService = mock<CryptoService>();
+    cryptoService.encrypt.mockResolvedValue(new EncString("ENC"));
+
+    const result = await view.encrypt(cryptoService, null);
+
+    expect(result).toEqual({
+      id: "2",
+      name: {
+        encryptedString: "ENC",
+        encryptionType: 0,
+      },
+      revisionDate: new Date("2022-10-31T10:16:45+00:00"),
+    });
+  });
 });