[PM-5264] Implement StateProvider in LoginEmailService (#7662)

* setup StateProvider in LoginService

* replace implementations

* replace implementation

* remove stateService

* change storage location for web to 'disk-local'

* implement migrate() method of Migrator

* add RememberedEmailMigrator to migrate.ts

* add rollback

* add tests

* replace implementation

* replace implementation

* add StateProvider to Desktop services

* rename LoginService to RememberEmailService

* update state definition

* rename file

* rename to storedEmail

* rename service to EmailService to avoid confusion

* add jsdocs

* refactor login.component.ts

* fix typos

* fix test

* rename to LoginEmailService

* update factory

* more renaming

* remove duplicate logic and rename method

* convert storedEmail to observable

* refactor to remove setStoredEmail() method

* move service to libs/auth/common

* address floating promises

* remove comment

* remove unnecessary deps in service registration

libs/auth/src/common/abstractions/index.ts

@@ -1,4 +1,5 @@
 export * from "./pin-crypto.service.abstraction";
+export * from "./login-email.service";
 export * from "./login-strategy.service";
 export * from "./user-decryption-options.service.abstraction";
 export * from "./auth-request.service.abstraction";

libs/auth/src/common/abstractions/login-email.service.ts

@@ -0,0 +1,38 @@
+import { Observable } from "rxjs";
+
+export abstract class LoginEmailServiceAbstraction {
+  /**
+   * An observable that monitors the storedEmail
+   */
+  storedEmail$: Observable<string>;
+  /**
+   * Gets the current email being used in the login process.
+   * @returns A string of the email.
+   */
+  getEmail: () => string;
+  /**
+   * Sets the current email being used in the login process.
+   * @param email The email to be set.
+   */
+  setEmail: (email: string) => void;
+  /**
+   * Gets whether or not the email should be stored on disk.
+   * @returns A boolean stating whether or not the email should be stored on disk.
+   */
+  getRememberEmail: () => boolean;
+  /**
+   * Sets whether or not the email should be stored on disk.
+   */
+  setRememberEmail: (value: boolean) => void;
+  /**
+   * Sets the email and rememberEmail properties to null.
+   */
+  clearValues: () => void;
+  /**
+   * - If rememberEmail is true, sets the storedEmail on disk to the current email.
+   * - If rememberEmail is false, sets the storedEmail on disk to null.
+   * - Then sets the email and rememberEmail properties to null.
+   * @returns A promise that resolves once the email settings are saved.
+   */
+  saveEmailSettings: () => Promise<void>;
+}

libs/auth/src/common/services/index.ts

@@ -1,4 +1,5 @@
 export * from "./pin-crypto/pin-crypto.service.implementation";
+export * from "./login-email/login-email.service";
 export * from "./login-strategies/login-strategy.service";
 export * from "./user-decryption-options/user-decryption-options.service";
 export * from "./auth-request/auth-request.service";

libs/auth/src/common/services/login-email/login-email.service.ts

@@ -0,0 +1,52 @@
+import { Observable } from "rxjs";
+
+import {
+  GlobalState,
+  KeyDefinition,
+  LOGIN_EMAIL_DISK,
+  StateProvider,
+} from "../../../../../common/src/platform/state";
+import { LoginEmailServiceAbstraction } from "../../abstractions/login-email.service";
+
+const STORED_EMAIL = new KeyDefinition<string>(LOGIN_EMAIL_DISK, "storedEmail", {
+  deserializer: (value: string) => value,
+});
+
+export class LoginEmailService implements LoginEmailServiceAbstraction {
+  private email: string;
+  private rememberEmail: boolean;
+
+  private readonly storedEmailState: GlobalState<string>;
+  storedEmail$: Observable<string>;
+
+  constructor(private stateProvider: StateProvider) {
+    this.storedEmailState = this.stateProvider.getGlobal(STORED_EMAIL);
+    this.storedEmail$ = this.storedEmailState.state$;
+  }
+
+  getEmail() {
+    return this.email;
+  }
+
+  setEmail(email: string) {
+    this.email = email;
+  }
+
+  getRememberEmail() {
+    return this.rememberEmail;
+  }
+
+  setRememberEmail(value: boolean) {
+    this.rememberEmail = value;
+  }
+
+  clearValues() {
+    this.email = null;
+    this.rememberEmail = null;
+  }
+
+  async saveEmailSettings() {
+    await this.storedEmailState.update(() => (this.rememberEmail ? this.email : null));
+    this.clearValues();
+  }
+}