Remove `StateService` `useAccountCache` (#8882)

* Remove Account Cache from StateService

* Remove Extra Change

* Fix Desktop Build

apps/browser/src/platform/background/service-factories/state-service.factory.ts

@@ -30,7 +30,6 @@ import {
 
 type StateServiceFactoryOptions = FactoryOptions & {
   stateServiceOptions: {
-    useAccountCache?: boolean;
     stateFactory: StateFactory<GlobalState, Account>;
   };
 };
@@ -64,7 +63,6 @@ export async function stateServiceFactory(
         await environmentServiceFactory(cache, opts),
         await tokenServiceFactory(cache, opts),
         await migrationRunnerFactory(cache, opts),
-        opts.stateServiceOptions.useAccountCache,
       ),
   );
   // TODO: If we run migration through a chrome installed/updated event we can turn off running migrations

apps/browser/src/platform/services/browser-state.service.spec.ts

@@ -27,7 +27,6 @@ describe("Browser State Service", () => {
   let diskStorageService: MockProxy<AbstractStorageService>;
   let logService: MockProxy<LogService>;
   let stateFactory: MockProxy<StateFactory<GlobalState, Account>>;
-  let useAccountCache: boolean;
   let environmentService: MockProxy<EnvironmentService>;
   let tokenService: MockProxy<TokenService>;
   let migrationRunner: MockProxy<MigrationRunner>;
@@ -46,8 +45,6 @@ describe("Browser State Service", () => {
     environmentService = mock();
     tokenService = mock();
     migrationRunner = mock();
-    // turn off account cache for tests
-    useAccountCache = false;
 
     state = new State(new GlobalState());
     state.accounts[userId] = new Account({
@@ -78,7 +75,6 @@ describe("Browser State Service", () => {
         environmentService,
         tokenService,
         migrationRunner,
-        useAccountCache,
       );
     });
 

apps/browser/src/platform/services/default-browser-state.service.ts

@@ -15,7 +15,6 @@ import { MigrationRunner } from "@bitwarden/common/platform/services/migration-r
 import { StateService as BaseStateService } from "@bitwarden/common/platform/services/state.service";
 
 import { Account } from "../../models/account";
-import { BrowserApi } from "../browser/browser-api";
 import { browserSession, sessionSync } from "../decorators/session-sync-observable";
 
 import { BrowserStateService } from "./abstractions/browser-state.service";
@@ -45,7 +44,6 @@ export class DefaultBrowserStateService
     environmentService: EnvironmentService,
     tokenService: TokenService,
     migrationRunner: MigrationRunner,
-    useAccountCache = true,
   ) {
     super(
       storageService,
@@ -57,45 +55,7 @@ export class DefaultBrowserStateService
       environmentService,
       tokenService,
       migrationRunner,
-      useAccountCache,
     );
-
-    // TODO: This is a hack to fix having a disk cache on both the popup and
-    // the background page that can get out of sync. We need to work out the
-    // best way to handle caching with multiple instances of the state service.
-    if (useAccountCache) {
-      BrowserApi.storageChangeListener((changes, namespace) => {
-        if (namespace === "local") {
-          for (const key of Object.keys(changes)) {
-            if (key !== "accountActivity" && this.accountDiskCache.value[key]) {
-              this.deleteDiskCache(key);
-            }
-          }
-        }
-      });
-
-      BrowserApi.addListener(
-        chrome.runtime.onMessage,
-        (message: { command: string }, _, respond) => {
-          if (message.command === "initializeDiskCache") {
-            respond(JSON.stringify(this.accountDiskCache.value));
-          }
-        },
-      );
-    }
-  }
-
-  override async initAccountState(): Promise<void> {
-    if (this.isRecoveredSession && this.useAccountCache) {
-      // request cache initialization
-
-      const response = await BrowserApi.sendMessageWithResponse<string>("initializeDiskCache");
-      this.accountDiskCache.next(JSON.parse(response));
-
-      return;
-    }
-
-    await super.initAccountState();
   }
 
   async addAccount(account: Account) {

apps/desktop/src/app/services/services.module.ts

@@ -4,7 +4,6 @@ import { Subject, merge } from "rxjs";
 import { SafeProvider, safeProvider } from "@bitwarden/angular/platform/utils/safe-provider";
 import {
   SECURE_STORAGE,
-  STATE_SERVICE_USE_CACHE,
   LOCALES_DIRECTORY,
   SYSTEM_LANGUAGE,
   MEMORY_STORAGE,
@@ -205,7 +204,6 @@ const safeProviders: SafeProvider[] = [
       EnvironmentService,
       TokenService,
       MigrationRunner,
-      STATE_SERVICE_USE_CACHE,
     ],
   }),
   safeProvider({

apps/desktop/src/main.ts

@@ -205,7 +205,6 @@ export class Main {
       this.environmentService,
       this.tokenService,
       this.migrationRunner,
-      false, // Do not use disk caching because this will get out of sync with the renderer service
     );
 
     this.desktopSettingsService = new DesktopSettingsService(stateProvider);

apps/web/src/app/core/core.module.ts

@@ -5,7 +5,6 @@ import { SafeProvider, safeProvider } from "@bitwarden/angular/platform/utils/sa
 import {
   SECURE_STORAGE,
   STATE_FACTORY,
-  STATE_SERVICE_USE_CACHE,
   LOCALES_DIRECTORY,
   SYSTEM_LANGUAGE,
   MEMORY_STORAGE,
@@ -78,10 +77,6 @@ const safeProviders: SafeProvider[] = [
     provide: STATE_FACTORY,
     useValue: new StateFactory(GlobalState, Account),
   }),
-  safeProvider({
-    provide: STATE_SERVICE_USE_CACHE,
-    useValue: false,
-  }),
   safeProvider({
     provide: I18nServiceAbstraction,
     useClass: I18nService,

apps/web/src/app/core/state/state.service.ts

@@ -4,7 +4,6 @@ import {
   MEMORY_STORAGE,
   SECURE_STORAGE,
   STATE_FACTORY,
-  STATE_SERVICE_USE_CACHE,
 } from "@bitwarden/angular/services/injection-tokens";
 import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { TokenService } from "@bitwarden/common/auth/abstractions/token.service";
@@ -34,7 +33,6 @@ export class StateService extends BaseStateService<GlobalState, Account> {
     environmentService: EnvironmentService,
     tokenService: TokenService,
     migrationRunner: MigrationRunner,
-    @Inject(STATE_SERVICE_USE_CACHE) useAccountCache = true,
   ) {
     super(
       storageService,
@@ -46,7 +44,6 @@ export class StateService extends BaseStateService<GlobalState, Account> {
       environmentService,
       tokenService,
       migrationRunner,
-      useAccountCache,
     );
   }
 

libs/angular/src/services/injection-tokens.ts

@@ -36,7 +36,6 @@ export const MEMORY_STORAGE = new SafeInjectionToken<AbstractMemoryStorageServic
 );
 export const SECURE_STORAGE = new SafeInjectionToken<AbstractStorageService>("SECURE_STORAGE");
 export const STATE_FACTORY = new SafeInjectionToken<StateFactory>("STATE_FACTORY");
-export const STATE_SERVICE_USE_CACHE = new SafeInjectionToken<boolean>("STATE_SERVICE_USE_CACHE");
 export const LOGOUT_CALLBACK = new SafeInjectionToken<
   (expired: boolean, userId?: string) => Promise<void>
 >("LOGOUT_CALLBACK");

libs/angular/src/services/jslib-services.module.ts

@@ -269,7 +269,6 @@ import {
   SafeInjectionToken,
   SECURE_STORAGE,
   STATE_FACTORY,
-  STATE_SERVICE_USE_CACHE,
   SUPPORTS_SECURE_STORAGE,
   SYSTEM_LANGUAGE,
   SYSTEM_THEME_OBSERVABLE,
@@ -313,10 +312,6 @@ const safeProviders: SafeProvider[] = [
     provide: STATE_FACTORY,
     useValue: new StateFactory(GlobalState, Account),
   }),
-  safeProvider({
-    provide: STATE_SERVICE_USE_CACHE,
-    useValue: true,
-  }),
   safeProvider({
     provide: LOGOUT_CALLBACK,
     useFactory:
@@ -690,7 +685,6 @@ const safeProviders: SafeProvider[] = [
       EnvironmentService,
       TokenServiceAbstraction,
       MigrationRunner,
-      STATE_SERVICE_USE_CACHE,
     ],
   }),
   safeProvider({

libs/common/src/platform/services/state.service.ts

@@ -65,8 +65,6 @@ export class StateService<
   private hasBeenInited = false;
   protected isRecoveredSession = false;
 
-  protected accountDiskCache = new BehaviorSubject<Record<string, TAccount>>({});
-
   // default account serializer, must be overridden by child class
   protected accountDeserializer = Account.fromJSON as (json: Jsonify<TAccount>) => TAccount;
 
@@ -80,7 +78,6 @@ export class StateService<
     protected environmentService: EnvironmentService,
     protected tokenService: TokenService,
     private migrationRunner: MigrationRunner,
-    protected useAccountCache: boolean = true,
   ) {}
 
   async init(initOptions: InitOptions = {}): Promise<void> {
@@ -995,13 +992,6 @@ export class StateService<
       return null;
     }
 
-    if (this.useAccountCache) {
-      const cachedAccount = this.accountDiskCache.value[options.userId];
-      if (cachedAccount != null) {
-        return cachedAccount;
-      }
-    }
-
     const account = options?.useSecureStorage
       ? (await this.secureStorageService.get<TAccount>(options.userId, options)) ??
         (await this.storageService.get<TAccount>(
@@ -1009,8 +999,6 @@ export class StateService<
           this.reconcileOptions(options, { htmlStorageLocation: HtmlStorageLocation.Local }),
         ))
       : await this.storageService.get<TAccount>(options.userId, options);
-
-    this.setDiskCache(options.userId, account);
     return account;
   }
 
@@ -1040,8 +1028,6 @@ export class StateService<
       : this.storageService;
 
     await storageLocation.save(`${options.userId}`, account, options);
-
-    this.deleteDiskCache(options.userId);
   }
 
   protected async saveAccountToMemory(account: TAccount): Promise<void> {
@@ -1241,9 +1227,6 @@ export class StateService<
     await this.updateState(async (state) => {
       userId = userId ?? state.activeUserId;
       delete state.accounts[userId];
-
-      this.deleteDiskCache(userId);
-
       return state;
     });
   }
@@ -1357,20 +1340,6 @@ export class StateService<
       return await this.setState(updatedState);
     });
   }
-
-  private setDiskCache(key: string, value: TAccount, options?: StorageOptions) {
-    if (this.useAccountCache) {
-      this.accountDiskCache.value[key] = value;
-      this.accountDiskCache.next(this.accountDiskCache.value);
-    }
-  }
-
-  protected deleteDiskCache(key: string) {
-    if (this.useAccountCache) {
-      delete this.accountDiskCache.value[key];
-      this.accountDiskCache.next(this.accountDiskCache.value);
-    }
-  }
 }
 
 function withPrototypeForArrayMembers<T>(