[ADR-16] Refactor Folders

.github/whitelist-capital-letters.txt

@@ -38,7 +38,6 @@
 ./libs/common/spec/shared/interceptConsole.ts
 ./libs/common/spec/models/view/passwordHistoryView.spec.ts
 ./libs/common/spec/models/view/cipherView.spec.ts
-./libs/common/spec/models/view/folderView.spec.ts
 ./libs/common/spec/models/view/attachmentView.spec.ts
 ./libs/common/spec/models/view/loginView.spec.ts
 ./libs/common/spec/models/domain/loginUri.spec.ts

.vscode/settings.json

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

apps/browser/src/background/main.background.ts

@@ -310,7 +310,11 @@ export default class MainBackground {
       this.cipherService,
       this.stateService
     );
-    this.folderApiService = new FolderApiService(this.folderService, this.apiService);
+    this.folderApiService = new FolderApiService(
+      this.folderService,
+      this.cryptoService,
+      this.apiService
+    );
     this.collectionService = new CollectionService(
       this.cryptoService,
       this.i18nService,

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/bw.ts

@@ -231,7 +231,11 @@ export class Main {
       this.stateService
     );
 
-    this.folderApiService = new FolderApiService(this.folderService, this.apiService);
+    this.folderApiService = new FolderApiService(
+      this.folderService,
+      this.cryptoService,
+      this.apiService
+    );
 
     this.collectionService = new CollectionService(
       this.cryptoService,

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 folderView = FolderExport.toView(req);
     try {
-      await this.folderApiService.save(folder);
-      const newFolder = await this.folderService.get(folder.id);
-      const decFolder = await newFolder.decrypt();
+      await this.folderApiService.save(folderView);
+      const newFolder = await this.folderService.get(folderView.id);
+      const decFolder = await this.cryptoService.decryptDomain(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,12 @@ export class EditCommand {
       return Response.notFound();
     }
 
-    let folderView = await folder.decrypt();
+    let folderView = await this.cryptoService.decryptDomain(FolderView, folder);
     folderView = FolderExport.toView(req, folderView);
-    const encFolder = await this.folderService.encrypt(folderView);
     try {
-      await this.folderApiService.save(encFolder);
+      await this.folderApiService.save(folderView);
       const updatedFolder = await this.folderService.get(folder.id);
-      const decFolder = await updatedFolder.decrypt();
+      const decFolder = await this.cryptoService.decryptDomain(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.decryptDomain(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";
@@ -57,7 +58,8 @@ export class ChangePasswordComponent extends BaseChangePasswordComponent {
     private keyConnectorService: KeyConnectorService,
     private router: Router,
     private organizationApiService: OrganizationApiServiceAbstraction,
-    private organizationUserService: OrganizationUserService
+    private organizationUserService: OrganizationUserService,
+    private encryptService: EncryptService
   ) {
     super(
       i18nService,
@@ -206,7 +208,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";
@@ -18,8 +19,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";
@@ -25,7 +26,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() {
@@ -43,8 +45,7 @@ export class FolderAddEditComponent implements OnInit {
     }
 
     try {
-      const folder = await this.folderService.encrypt(this.folder);
-      this.formPromise = this.folderApiService.save(folder);
+      this.formPromise = this.folderApiService.save(this.folder);
       await this.formPromise;
       this.platformUtilsService.showToast(
         "success",
@@ -93,7 +94,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.decryptDomain(FolderView, folder);
     } else {
       this.title = this.i18nService.t("addFolder");
     }

libs/common/spec/services/folder.service.spec.ts

@@ -7,7 +7,7 @@ import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
 import { EncryptService } from "@bitwarden/common/abstractions/encrypt.service";
 import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
 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 { FolderView } from "@bitwarden/common/models/view/folder.view";
 import { ContainerService } from "@bitwarden/common/services/container.service";
 import { FolderService } from "@bitwarden/common/services/folder/folder.service";
@@ -33,6 +33,13 @@ describe("Folder Service", () => {
     activeAccount = new BehaviorSubject("123");
     activeAccountUnlocked = new BehaviorSubject(true);
 
+    cryptoService.decryptDomain(Arg.any(), Arg.any()).mimicks((view: any, model: Folder) => {
+      const v = new FolderView();
+      v.id = model.id;
+      v.revisionDate = model.revisionDate;
+      return Promise.resolve(v);
+    });
+
     stateService.getEncryptedFolders().resolves({
       "1": folderData("1", "test"),
     });
@@ -43,33 +50,13 @@ describe("Folder Service", () => {
     folderService = new FolderService(cryptoService, i18nService, cipherService, stateService);
   });
 
-  it("encrypt", async () => {
-    const model = new FolderView();
-    model.id = "2";
-    model.name = "Test Folder";
-
-    cryptoService.encrypt(Arg.any()).resolves(new EncString("ENC"));
-    cryptoService.decryptToUtf8(Arg.any()).resolves("DEC");
-
-    const result = await folderService.encrypt(model);
-
-    expect(result).toEqual({
-      id: "2",
-      name: {
-        encryptedString: "ENC",
-        encryptionType: 0,
-      },
-    });
-  });
-
   describe("get", () => {
     it("exists", async () => {
       const result = await folderService.get("1");
 
       expect(result).toEqual({
         id: "1",
         name: {
-          decryptedValue: [],
           encryptedString: "test",
           encryptionType: 0,
         },
@@ -91,7 +78,6 @@ describe("Folder Service", () => {
       {
         id: "1",
         name: {
-          decryptedValue: [],
           encryptedString: "test",
           encryptionType: 0,
         },
@@ -100,7 +86,6 @@ describe("Folder Service", () => {
       {
         id: "2",
         name: {
-          decryptedValue: [],
           encryptedString: "test 2",
           encryptionType: 0,
         },
@@ -109,8 +94,8 @@ describe("Folder Service", () => {
     ]);
 
     expect(await firstValueFrom(folderService.folderViews$)).toEqual([
-      { id: "1", name: [], revisionDate: null },
-      { id: "2", name: [], revisionDate: null },
+      { id: "1", name: null, revisionDate: null },
+      { id: "2", name: null, revisionDate: null },
       { id: null, name: [], revisionDate: null },
     ]);
   });
@@ -122,7 +107,6 @@ describe("Folder Service", () => {
       {
         id: "2",
         name: {
-          decryptedValue: [],
           encryptedString: "test 2",
           encryptionType: 0,
         },
@@ -131,8 +115,8 @@ describe("Folder Service", () => {
     ]);
 
     expect(await firstValueFrom(folderService.folderViews$)).toEqual([
-      { id: "2", name: [], revisionDate: null },
-      { id: null, name: [], revisionDate: null },
+      { id: "2", name: null, revisionDate: null },
+      { id: null, name: null, revisionDate: null },
     ]);
   });