[PM-6382] Migrate disableContextMenuItem to Autofill Settings state (#8246)

* add enableContextMenu to autofillSettings and migrate disableContextMenuItem

* replace usages of disableContextMenuItem with autofill settings service global enableContextMenu

libs/common/src/state-migrations/migrations/31-move-enable-context-menu-to-autofill-settings-state-provider.spec.ts

@@ -0,0 +1,91 @@
+import { any, MockProxy } from "jest-mock-extended";
+
+import { KeyDefinitionLike, MigrationHelper } from "../migration-helper";
+import { mockMigrationHelper } from "../migration-helper.spec";
+
+import { EnableContextMenuMigrator } from "./31-move-enable-context-menu-to-autofill-settings-state-provider";
+
+function exampleJSON() {
+  return {
+    global: {
+      disableContextMenuItem: true,
+      otherStuff: "otherStuff1",
+    },
+    otherStuff: "otherStuff2",
+  };
+}
+
+function rollbackJSON() {
+  return {
+    global_autofillSettings_enableContextMenu: false,
+    global: {
+      otherStuff: "otherStuff1",
+    },
+    otherStuff: "otherStuff2",
+  };
+}
+
+const enableContextMenuKeyDefinition: KeyDefinitionLike = {
+  stateDefinition: {
+    name: "autofillSettings",
+  },
+  key: "enableContextMenu",
+};
+
+describe("EnableContextMenuMigrator", () => {
+  let helper: MockProxy<MigrationHelper>;
+  let sut: EnableContextMenuMigrator;
+
+  describe("migrate", () => {
+    beforeEach(() => {
+      helper = mockMigrationHelper(exampleJSON(), 30);
+      sut = new EnableContextMenuMigrator(30, 31);
+    });
+
+    it("should remove global disableContextMenuItem setting", async () => {
+      await sut.migrate(helper);
+
+      expect(helper.set).toHaveBeenCalledTimes(1);
+      expect(helper.set).toHaveBeenCalledWith("global", {
+        otherStuff: "otherStuff1",
+      });
+    });
+
+    it("should set enableContextMenu globally", async () => {
+      await sut.migrate(helper);
+
+      expect(helper.setToGlobal).toHaveBeenCalledTimes(1);
+      expect(helper.setToGlobal).toHaveBeenCalledWith(enableContextMenuKeyDefinition, false);
+    });
+  });
+
+  describe("rollback", () => {
+    beforeEach(() => {
+      helper = mockMigrationHelper(rollbackJSON(), 31);
+      sut = new EnableContextMenuMigrator(30, 31);
+    });
+
+    it("should null out new enableContextMenu global value", async () => {
+      await sut.rollback(helper);
+
+      expect(helper.setToGlobal).toHaveBeenCalledTimes(1);
+      expect(helper.setToGlobal).toHaveBeenCalledWith(enableContextMenuKeyDefinition, null);
+    });
+
+    it("should add disableContextMenuItem global value back", async () => {
+      await sut.rollback(helper);
+
+      expect(helper.set).toHaveBeenCalledTimes(1);
+      expect(helper.set).toHaveBeenCalledWith("global", {
+        disableContextMenuItem: true,
+        otherStuff: "otherStuff1",
+      });
+    });
+
+    it("should not try to restore values to missing accounts", async () => {
+      await sut.rollback(helper);
+
+      expect(helper.set).not.toHaveBeenCalledWith("user-3", any());
+    });
+  });
+});

libs/common/src/state-migrations/migrations/31-move-enable-context-menu-to-autofill-settings-state-provider.ts

@@ -0,0 +1,46 @@
+import { KeyDefinitionLike, MigrationHelper } from "../migration-helper";
+import { Migrator } from "../migrator";
+
+type ExpectedGlobalState = {
+  disableContextMenuItem?: boolean;
+};
+
+const enableContextMenuKeyDefinition: KeyDefinitionLike = {
+  stateDefinition: {
+    name: "autofillSettings",
+  },
+  key: "enableContextMenu",
+};
+
+export class EnableContextMenuMigrator extends Migrator<30, 31> {
+  async migrate(helper: MigrationHelper): Promise<void> {
+    const globalState = await helper.get<ExpectedGlobalState>("global");
+
+    // disableContextMenuItem -> enableContextMenu
+    if (globalState?.disableContextMenuItem != null) {
+      await helper.setToGlobal(enableContextMenuKeyDefinition, !globalState.disableContextMenuItem);
+
+      // delete `disableContextMenuItem` from state global
+      delete globalState.disableContextMenuItem;
+
+      await helper.set<ExpectedGlobalState>("global", globalState);
+    }
+  }
+
+  async rollback(helper: MigrationHelper): Promise<void> {
+    const globalState = (await helper.get<ExpectedGlobalState>("global")) || {};
+
+    const enableContextMenu: boolean = await helper.getFromGlobal(enableContextMenuKeyDefinition);
+
+    // enableContextMenu -> disableContextMenuItem
+    if (enableContextMenu != null) {
+      await helper.set<ExpectedGlobalState>("global", {
+        ...globalState,
+        disableContextMenuItem: !enableContextMenu,
+      });
+
+      // remove the global state provider framework key for `enableContextMenu`
+      await helper.setToGlobal(enableContextMenuKeyDefinition, null);
+    }
+  }
+}