[PM-6404] Fully Integrate clearOn Events (#8134)

* Add New KeyDefinitionOption * Add New Services * Add WebStorageServiceProvider Tests * Update Error Message * Add `UserKeyDefinition` * Fix Deserialization Helpers * Fix KeyDefinition * Add `UserKeyDefinition` * Fix Deserialization Helpers * Fix KeyDefinition * Move `ClearEvent` * Cleanup * Fix Imports * Integrate onClear Events * Remove Accidental Addition * Fix Test * Add VaultTimeoutService Tests * Only Register When Current State is Null * Address Feedback
2025-12-16 08:13:42 +00:00 · 2024-03-04 14:33:25 -06:00
parent 4ba2717eb4
commit c3eba7f2c8
28 changed files with 471 additions and 345 deletions
--- a/apps/web/src/app/app.component.ts
+++ b/apps/web/src/app/app.component.ts
@@ -23,6 +23,7 @@ import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.servic
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
 import { StateService } from "@bitwarden/common/platform/abstractions/state.service";
 import { BiometricStateService } from "@bitwarden/common/platform/biometrics/biometric-state.service";
+import { StateEventRunnerService } from "@bitwarden/common/platform/state";
 import { PasswordGenerationServiceAbstraction } from "@bitwarden/common/tools/generator/password";
 import { UserId } from "@bitwarden/common/types/guid";
 import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
@@ -89,6 +90,7 @@ export class AppComponent implements OnDestroy, OnInit {
    private configService: ConfigServiceAbstraction,
    private dialogService: DialogService,
    private biometricStateService: BiometricStateService,
+    private stateEventRunnerService: StateEventRunnerService,
    private paymentMethodWarningService: PaymentMethodWarningService,
    private organizationService: OrganizationService,
  ) {}
@@ -284,6 +286,8 @@ export class AppComponent implements OnDestroy, OnInit {
      this.paymentMethodWarningService.clear(),
    ]);

+    await this.stateEventRunnerService.handleEvent("logout", userId as UserId);
+
    this.searchService.clearIndex();
    this.authService.logOut(async () => {
      if (expired) {
--- a/apps/web/src/app/core/core.module.ts
+++ b/apps/web/src/app/core/core.module.ts
@@ -14,7 +14,6 @@ import {
 } from "@bitwarden/angular/services/injection-tokens";
 import { JslibServicesModule } from "@bitwarden/angular/services/jslib-services.module";
 import { ModalService as ModalServiceAbstraction } from "@bitwarden/angular/services/modal.service";
-import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { LoginService as LoginServiceAbstraction } from "@bitwarden/common/auth/abstractions/login.service";
 import { LoginService } from "@bitwarden/common/auth/services/login.service";
 import { FileDownloadService } from "@bitwarden/common/platform/abstractions/file-download/file-download.service";
@@ -28,21 +27,16 @@ import { StateFactory } from "@bitwarden/common/platform/factories/state-factory
 import { MemoryStorageService } from "@bitwarden/common/platform/services/memory-storage.service";
 import { MigrationBuilderService } from "@bitwarden/common/platform/services/migration-builder.service";
 import { MigrationRunner } from "@bitwarden/common/platform/services/migration-runner";
-import {
-  ActiveUserStateProvider,
-  GlobalStateProvider,
-  SingleUserStateProvider,
-} from "@bitwarden/common/platform/state";
-// eslint-disable-next-line import/no-restricted-paths -- Implementation for memory storage
+/* eslint-disable import/no-restricted-paths -- Implementation for memory storage */
+import { StorageServiceProvider } from "@bitwarden/common/platform/services/storage-service.provider";
 import { MemoryStorageService as MemoryStorageServiceForStateProviders } from "@bitwarden/common/platform/state/storage/memory-storage.service";
+/* eslint-enable import/no-restricted-paths -- Implementation for memory storage */

 import { PolicyListService } from "../admin-console/core/policy-list.service";
 import { HtmlStorageService } from "../core/html-storage.service";
 import { I18nService } from "../core/i18n.service";
-import { WebActiveUserStateProvider } from "../platform/web-active-user-state.provider";
-import { WebGlobalStateProvider } from "../platform/web-global-state.provider";
 import { WebMigrationRunner } from "../platform/web-migration-runner";
-import { WebSingleUserStateProvider } from "../platform/web-single-user-state.provider";
+import { WebStorageServiceProvider } from "../platform/web-storage-service.provider";
 import { WindowStorageService } from "../platform/window-storage.service";
 import { CollectionAdminService } from "../vault/core/collection-admin.service";

@@ -124,24 +118,9 @@ import { WebPlatformUtilsService } from "./web-platform-utils.service";
      useFactory: () => new WindowStorageService(window.localStorage),
    },
    {
-      provide: SingleUserStateProvider,
-      useClass: WebSingleUserStateProvider,
-      deps: [OBSERVABLE_MEMORY_STORAGE, OBSERVABLE_DISK_STORAGE, OBSERVABLE_DISK_LOCAL_STORAGE],
-    },
-    {
-      provide: ActiveUserStateProvider,
-      useClass: WebActiveUserStateProvider,
-      deps: [
-        AccountService,
-        OBSERVABLE_MEMORY_STORAGE,
-        OBSERVABLE_DISK_STORAGE,
-        OBSERVABLE_DISK_LOCAL_STORAGE,
-      ],
-    },
-    {
-      provide: GlobalStateProvider,
-      useClass: WebGlobalStateProvider,
-      deps: [OBSERVABLE_MEMORY_STORAGE, OBSERVABLE_DISK_STORAGE, OBSERVABLE_DISK_LOCAL_STORAGE],
+      provide: StorageServiceProvider,
+      useClass: WebStorageServiceProvider,
+      deps: [OBSERVABLE_DISK_STORAGE, OBSERVABLE_MEMORY_STORAGE, OBSERVABLE_DISK_LOCAL_STORAGE],
    },
    {
      provide: MigrationRunner,
--- a/apps/web/src/app/platform/web-active-user-state.provider.ts
+++ b/apps/web/src/app/platform/web-active-user-state.provider.ts
@@ -1,44 +0,0 @@
-import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
-import {
-  AbstractMemoryStorageService,
-  AbstractStorageService,
-  ObservableStorageService,
-} from "@bitwarden/common/platform/abstractions/storage.service";
-import { UserKeyDefinition } from "@bitwarden/common/platform/state";
-/* eslint-disable import/no-restricted-paths -- Needed to extend class & in platform owned code */
-import { DefaultActiveUserStateProvider } from "@bitwarden/common/platform/state/implementations/default-active-user-state.provider";
-import { StateDefinition } from "@bitwarden/common/platform/state/state-definition";
-/* eslint-enable import/no-restricted-paths */
-
-export class WebActiveUserStateProvider extends DefaultActiveUserStateProvider {
-  constructor(
-    accountService: AccountService,
-    memoryStorage: AbstractMemoryStorageService & ObservableStorageService,
-    sessionStorage: AbstractStorageService & ObservableStorageService,
-    private readonly diskLocalStorage: AbstractStorageService & ObservableStorageService,
-  ) {
-    super(accountService, memoryStorage, sessionStorage);
-  }
-
-  protected override getLocationString(keyDefinition: UserKeyDefinition<unknown>): string {
-    return (
-      keyDefinition.stateDefinition.storageLocationOverrides["web"] ??
-      keyDefinition.stateDefinition.defaultStorageLocation
-    );
-  }
-
-  protected override getLocation(
-    stateDefinition: StateDefinition,
-  ): AbstractStorageService & ObservableStorageService {
-    const location =
-      stateDefinition.storageLocationOverrides["web"] ?? stateDefinition.defaultStorageLocation;
-    switch (location) {
-      case "disk":
-        return this.diskStorage;
-      case "memory":
-        return this.memoryStorage;
-      case "disk-local":
-        return this.diskLocalStorage;
-    }
-  }
-}
--- a/apps/web/src/app/platform/web-global-state.provider.ts
+++ b/apps/web/src/app/platform/web-global-state.provider.ts
@@ -1,42 +0,0 @@
-import {
-  AbstractMemoryStorageService,
-  AbstractStorageService,
-  ObservableStorageService,
-} from "@bitwarden/common/platform/abstractions/storage.service";
-import { KeyDefinition } from "@bitwarden/common/platform/state";
-/* eslint-disable import/no-restricted-paths -- Needed to extend class & in platform owned code*/
-import { DefaultGlobalStateProvider } from "@bitwarden/common/platform/state/implementations/default-global-state.provider";
-import { StateDefinition } from "@bitwarden/common/platform/state/state-definition";
-/* eslint-enable import/no-restricted-paths */
-
-export class WebGlobalStateProvider extends DefaultGlobalStateProvider {
-  constructor(
-    memoryStorage: AbstractMemoryStorageService & ObservableStorageService,
-    sessionStorage: AbstractStorageService & ObservableStorageService,
-    private readonly diskLocalStorage: AbstractStorageService & ObservableStorageService,
-  ) {
-    super(memoryStorage, sessionStorage);
-  }
-
-  protected getLocationString(keyDefinition: KeyDefinition<unknown>): string {
-    return (
-      keyDefinition.stateDefinition.storageLocationOverrides["web"] ??
-      keyDefinition.stateDefinition.defaultStorageLocation
-    );
-  }
-
-  protected override getLocation(
-    stateDefinition: StateDefinition,
-  ): AbstractStorageService & ObservableStorageService {
-    const location =
-      stateDefinition.storageLocationOverrides["web"] ?? stateDefinition.defaultStorageLocation;
-    switch (location) {
-      case "disk":
-        return this.diskStorage;
-      case "memory":
-        return this.memoryStorage;
-      case "disk-local":
-        return this.diskLocalStorage;
-    }
-  }
-}
--- a/apps/web/src/app/platform/web-single-user-state.provider.ts
+++ b/apps/web/src/app/platform/web-single-user-state.provider.ts
@@ -1,43 +0,0 @@
-import {
-  AbstractMemoryStorageService,
-  AbstractStorageService,
-  ObservableStorageService,
-} from "@bitwarden/common/platform/abstractions/storage.service";
-import { UserKeyDefinition } from "@bitwarden/common/platform/state";
-/* eslint-disable import/no-restricted-paths -- Needed to extend service & and in platform owned file */
-import { DefaultSingleUserStateProvider } from "@bitwarden/common/platform/state/implementations/default-single-user-state.provider";
-import { StateDefinition } from "@bitwarden/common/platform/state/state-definition";
-/* eslint-enable import/no-restricted-paths */
-
-export class WebSingleUserStateProvider extends DefaultSingleUserStateProvider {
-  constructor(
-    memoryStorageService: AbstractMemoryStorageService & ObservableStorageService,
-    sessionStorageService: AbstractStorageService & ObservableStorageService,
-    private readonly diskLocalStorageService: AbstractStorageService & ObservableStorageService,
-  ) {
-    super(memoryStorageService, sessionStorageService);
-  }
-
-  protected override getLocationString(keyDefinition: UserKeyDefinition<unknown>): string {
-    return (
-      keyDefinition.stateDefinition.storageLocationOverrides["web"] ??
-      keyDefinition.stateDefinition.defaultStorageLocation
-    );
-  }
-
-  protected override getLocation(
-    stateDefinition: StateDefinition,
-  ): AbstractStorageService & ObservableStorageService {
-    const location =
-      stateDefinition.storageLocationOverrides["web"] ?? stateDefinition.defaultStorageLocation;
-
-    switch (location) {
-      case "disk":
-        return this.diskStorage;
-      case "memory":
-        return this.memoryStorage;
-      case "disk-local":
-        return this.diskLocalStorageService;
-    }
-  }
-}