Add State Provider Framework (#6640)

* Add StateDefinition

Add a class for encapsulation information about state
this will often be for a domain but creations of this will
exist outside of a specific domain, hence just the name State.

* Add KeyDefinition

This adds a type that extends state definition into another sub-key
and forces creators to define the data that will be stored and how
to read the data that they expect to be stored.

* Add key-builders helper functions

Adds to function to help building keys for both keys scoped
to a specific user and for keys scoped to global storage.

Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>

* Add updates$ stream to existing storageServices

Original commit by Matt: 823d9546fe
Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>

* Add fromChromeEvent helper

Create a helper that creats an Observable from a chrome event
and removes the listener when the subscription is completed.

* Implement `updates$` property for chrome storage

Use fromChromeEvent to create an observable from chrome
event and map that into our expected shape.

* Add GlobalState Abstractions

* Add UserState Abstractions

* Add Default Implementations of User/Global state

Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>

* Add Barrel File for state

Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>

* Fix ChromeStorageServices

* Rework fromChromeEvent

Rework fromChromeEvent so we have to lie to TS less and
remove unneeded generics. I did this by caring less about
the function and more about the parameters only.

Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>

* Fix UserStateProvider Test

* Add Inner Mock & Assert Calls

* Update Tests to use new keys

Use different key format

* Prefer returns over mutations in update

* Update Tests

* Address PR Feedback

* Be stricter with userId parameter

* Add Better Way To Determine if it was a remove

* Fix Web & Browser Storage Services

* Fix Desktop & CLI Storage Services

* Fix Test Storage Service

* Use createKey Helper

* Prefer implement to extending

* Determine storage location in providers

* Export default providers publicly

* Fix user state tests

* Name tests

* Fix CLI

* Prefer Implement In Chrome Storage

* Remove Secure Storage Option

Also throw an exception for subscribes to the secure storage observable.

* Update apps/browser/src/platform/browser/from-chrome-event.ts

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

* Enforce state module barrel file

* Fix Linting Error

* Allow state module import from other modules

* Globally Unregister fromChromeEvent Listeners

Changed fromChromeEvent to add its listeners through the BrowserApi, so that
they will be unregistered when safari closes.

* Test default global state

* Use Proper Casing in Parameter

* Address Feedback

* Update libs/common/src/platform/state/key-definition.ts

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

* Add `buildCacheKey` Method

* Fix lint errors

* Add Comment

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

* Use Generic in callback parameter

* Refactor Out DerivedStateDefinition

* Persist Listener Return Type

* Add Ticket Link

---------

Co-authored-by: Matt Gibson <MGibson1@users.noreply.github.com>
Co-authored-by: Matt Gibson <mgibson@bitwarden.com>
Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

apps/cli/src/platform/services/lowdb-storage.service.ts

@@ -5,10 +5,14 @@ import * as lowdb from "lowdb";
 import * as FileSync from "lowdb/adapters/FileSync";
 import * as lock from "proper-lockfile";
 import { OperationOptions } from "retry";
+import { Subject } from "rxjs";
 
 import { NodeUtils } from "@bitwarden/common/misc/nodeUtils";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
-import { AbstractStorageService } from "@bitwarden/common/platform/abstractions/storage.service";
+import {
+  AbstractStorageService,
+  StorageUpdate,
+} from "@bitwarden/common/platform/abstractions/storage.service";
 import { sequentialize } from "@bitwarden/common/platform/misc/sequentialize";
 import { Utils } from "@bitwarden/common/platform/misc/utils";
 
@@ -24,6 +28,7 @@ export class LowdbStorageService implements AbstractStorageService {
   private db: lowdb.LowdbSync<any>;
   private defaults: any;
   private ready = false;
+  private updatesSubject = new Subject<StorageUpdate>();
 
   constructor(
     protected logService: LogService,
@@ -102,6 +107,10 @@ export class LowdbStorageService implements AbstractStorageService {
     this.ready = true;
   }
 
+  get updates$() {
+    return this.updatesSubject.asObservable();
+  }
+
   async get<T>(key: string): Promise<T> {
     await this.waitForReady();
     return this.lockDbFile(() => {
@@ -119,21 +128,23 @@ export class LowdbStorageService implements AbstractStorageService {
     return this.get(key).then((v) => v != null);
   }
 
-  async save(key: string, obj: any): Promise<any> {
+  async save(key: string, obj: any): Promise<void> {
     await this.waitForReady();
     return this.lockDbFile(() => {
       this.readForNoCache();
       this.db.set(key, obj).write();
+      this.updatesSubject.next({ key, value: obj, updateType: "save" });
       this.logService.debug(`Successfully wrote ${key} to db`);
       return;
     });
   }
 
-  async remove(key: string): Promise<any> {
+  async remove(key: string): Promise<void> {
     await this.waitForReady();
     return this.lockDbFile(() => {
       this.readForNoCache();
       this.db.unset(key).write();
+      this.updatesSubject.next({ key, value: null, updateType: "remove" });
       this.logService.debug(`Successfully removed ${key} from db`);
       return;
     });

apps/cli/src/platform/services/node-env-secure-storage.service.ts

@@ -1,3 +1,5 @@
+import { throwError } from "rxjs";
+
 import { CryptoService } from "@bitwarden/common/platform/abstractions/crypto.service";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
 import { AbstractStorageService } from "@bitwarden/common/platform/abstractions/storage.service";
@@ -12,6 +14,12 @@ export class NodeEnvSecureStorageService implements AbstractStorageService {
     private cryptoService: () => CryptoService
   ) {}
 
+  get updates$() {
+    return throwError(
+      () => new Error("Secure storage implementations cannot have their updates subscribed to.")
+    );
+  }
+
   async get<T>(key: string): Promise<T> {
     const value = await this.storageService.get<string>(this.makeProtectedStorageKey(key));
     if (value == null) {
@@ -25,7 +33,7 @@ export class NodeEnvSecureStorageService implements AbstractStorageService {
     return (await this.get(key)) != null;
   }
 
-  async save(key: string, obj: any): Promise<any> {
+  async save(key: string, obj: any): Promise<void> {
     if (obj == null) {
       return this.remove(key);
     }
@@ -37,8 +45,9 @@ export class NodeEnvSecureStorageService implements AbstractStorageService {
     await this.storageService.save(this.makeProtectedStorageKey(key), protectedObj);
   }
 
-  remove(key: string): Promise<any> {
-    return this.storageService.remove(this.makeProtectedStorageKey(key));
+  async remove(key: string): Promise<void> {
+    await this.storageService.remove(this.makeProtectedStorageKey(key));
+    return;
   }
 
   private async encrypt(plainValue: string): Promise<string> {