Let feature handle state keys

Moves to a feature folder and creates clipboard-module level state
handler functions.

StateService is being paired down to storage routing, so we are handling storage
specifics in-module.

Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com>
Co-authored-by: Daniel Smith <djsmith85@users.noreply.github.com>

apps/browser/src/listeners/clearClipboard.spec.ts → apps/browser/src/clipboard/clearClipboard.spec.ts

@@ -4,6 +4,17 @@ import { BrowserApi } from "../browser/browserApi";
 import { StateService } from "../services/abstractions/state.service";
 
 import { ClearClipboard } from "./clearClipboard";
+import { getClearClipboardTime, setClearClipboardTime } from "./clipboard-state";
+
+jest.mock("./clipboard-state", () => {
+  return {
+    getClearClipboardTime: jest.fn(),
+    setClearClipboardTime: jest.fn(),
+  };
+});
+
+const getClearClipboardTimeMock = getClearClipboardTime as jest.Mock;
+const setClearClipboardTimeMock = setClearClipboardTime as jest.Mock;
 
 describe("clearClipboard", () => {
   describe("run", () => {
@@ -33,7 +44,7 @@ describe("clearClipboard", () => {
 
       jest.spyOn(BrowserApi, "sendTabsMessage").mockReturnValue();
 
-      stateService.getClearClipboardTime.mockResolvedValue(clearTime.getTime());
+      getClearClipboardTimeMock.mockResolvedValue(clearTime.getTime());
 
       await ClearClipboard.run(executionTime, serviceCache);
 
@@ -48,7 +59,7 @@ describe("clearClipboard", () => {
       const executionTime = new Date(2022, 1, 1, 12);
       const clearTime = new Date(2022, 1, 1, 11);
 
-      stateService.getClearClipboardTime.mockResolvedValue(clearTime.getTime());
+      setClearClipboardTimeMock.mockResolvedValue(clearTime.getTime());
 
       await ClearClipboard.run(executionTime, serviceCache);
 
@@ -58,7 +69,7 @@ describe("clearClipboard", () => {
     it("has an undefined clearTime", async () => {
       const executionTime = new Date(2022, 1, 1);
 
-      stateService.getClearClipboardTime.mockResolvedValue(undefined);
+      getClearClipboardTimeMock.mockResolvedValue(undefined);
 
       await ClearClipboard.run(executionTime, serviceCache);
 

apps/browser/src/listeners/clearClipboard.ts → apps/browser/src/clipboard/clearClipboard.ts

@@ -5,6 +5,8 @@ import { stateServiceFactory } from "../background/service_factories/state-servi
 import { BrowserApi } from "../browser/browserApi";
 import { Account } from "../models/account";
 
+import { getClearClipboardTime } from "./clipboard-state";
+
 export class ClearClipboard {
   static async run(executionTime: Date, serviceCache: Record<string, unknown>) {
     const stateFactory = new StateFactory(GlobalState, Account);
@@ -26,7 +28,7 @@ export class ClearClipboard {
       },
     });
 
-    const clearClipboardTime = await stateService.getClearClipboardTime();
+    const clearClipboardTime = await getClearClipboardTime(stateService);
 
     if (!clearClipboardTime) {
       return;

apps/browser/src/clipboard/clipboard-state.ts

@@ -0,0 +1,10 @@
+import { StateService } from "../services/abstractions/state.service";
+
+const clearClipboardStorageKey = "clearClipboardTime";
+export const getClearClipboardTime = async (stateService: StateService) => {
+  return await stateService.getFromSessionMemory<number>(clearClipboardStorageKey);
+};
+
+export const setClearClipboardTime = async (stateService: StateService, time: number) => {
+  await stateService.setInSessionMemory(clearClipboardStorageKey, time);
+};

apps/browser/src/commands/generate-password-to-clipboard-command.spec.ts → apps/browser/src/clipboard/generate-password-to-clipboard-command.spec.ts

@@ -1,12 +1,22 @@
-import { matches, mock, MockProxy } from "jest-mock-extended";
+import { mock, MockProxy } from "jest-mock-extended";
 
 import { PasswordGenerationService } from "@bitwarden/common/abstractions/passwordGeneration.service";
 
 import { BrowserApi } from "../browser/browserApi";
 import { StateService } from "../services/abstractions/state.service";
 
+import { setClearClipboardTime } from "./clipboard-state";
 import { GeneratePasswordToClipboardCommand } from "./generate-password-to-clipboard-command";
 
+jest.mock("./clipboard-state", () => {
+  return {
+    getClearClipboardTime: jest.fn(),
+    setClearClipboardTime: jest.fn(),
+  };
+});
+
+const setClearClipboardTimeMock = setClearClipboardTime as jest.Mock;
+
 describe("GeneratePasswordToClipboardCommand", () => {
   let passwordGenerationService: MockProxy<PasswordGenerationService>;
   let stateService: MockProxy<StateService>;
@@ -43,16 +53,9 @@ describe("GeneratePasswordToClipboardCommand", () => {
         text: "PASSWORD",
       });
 
-      expect(stateService.setClearClipboardTime).toHaveBeenCalledTimes(1);
-
-      expect(stateService.setClearClipboardTime).toHaveBeenCalledWith(
-        matches((time: number) => {
-          const now = new Date();
-          const date = new Date(time);
+      expect(setClearClipboardTimeMock).toHaveBeenCalledTimes(1);
 
-          return date.getMinutes() - now.getMinutes() === 5;
-        })
-      );
+      expect(setClearClipboardTimeMock).toHaveBeenCalledWith(stateService, expect.any(Number));
     });
 
     it("does not have clear clipboard value", async () => {
@@ -67,7 +70,7 @@ describe("GeneratePasswordToClipboardCommand", () => {
         text: "PASSWORD",
       });
 
-      expect(stateService.setClearClipboardTime).not.toHaveBeenCalled();
+      expect(setClearClipboardTimeMock).not.toHaveBeenCalled();
     });
   });
 });

apps/browser/src/commands/generate-password-to-clipboard-command.ts → apps/browser/src/clipboard/generate-password-to-clipboard-command.ts

@@ -2,6 +2,7 @@ import { PasswordGenerationService } from "@bitwarden/common/abstractions/passwo
 
 import { StateService } from "../services/abstractions/state.service";
 
+import { setClearClipboardTime } from "./clipboard-state";
 import { copyToClipboard } from "./copy-to-clipboard-command";
 
 export class GeneratePasswordToClipboardCommand {
@@ -19,7 +20,7 @@ export class GeneratePasswordToClipboardCommand {
     const clearClipboard = await this.stateService.getClearClipboard();
 
     if (clearClipboard != null) {
-      await this.stateService.setClearClipboardTime(Date.now() + clearClipboard * 1000);
+      await setClearClipboardTime(this.stateService, Date.now() + clearClipboard * 1000);
     }
   }
 }

apps/browser/src/clipboard/index.ts

@@ -0,0 +1,3 @@
+export * from "./clearClipboard";
+export * from "./copy-to-clipboard-command";
+export * from "./generate-password-to-clipboard-command";

apps/browser/src/services/abstractions/state.service.ts

@@ -33,6 +33,4 @@ export abstract class StateService extends BaseStateServiceAbstraction<Account>
     value: BrowserComponentState,
     options?: StorageOptions
   ) => Promise<void>;
-  getClearClipboardTime: () => Promise<number>;
-  setClearClipboardTime: (time: number) => Promise<void>;
 }

apps/browser/src/services/state.service.ts

@@ -129,12 +129,4 @@ export class StateService
       this.reconcileOptions(options, await this.defaultInMemoryOptions())
     );
   }
-
-  async setClearClipboardTime(time: number): Promise<void> {
-    this.setInSessionMemory("clearClipboardTime", time);
-  }
-
-  async getClearClipboardTime(): Promise<number | undefined> {
-    return this.getFromSessionMemory("clearClipboardTime");
-  }
 }