PM-3585 Improve state migrations (#5009)

* WIP: safer state migrations Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com> * Add min version check and remove old migrations Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com> * Add rollback and version checking * Add state version move migration * Expand tests and improve typing for Migrations * Remove StateMigration Service * Rewrite version 5 and 6 migrations * Add all but initial migration to supported migrations * Handle stateVersion location in migrator update versions * Move to unique migrations directory * Disallow imports outside of state-migrations * Lint and test fixes * Do not run migrations if we cannot determine state * Fix desktop background StateService build * Document Migration builder class * Add debug logging to migrations * Comment on migrator overrides * Use specific property names * `npm run prettier` 🤖 * Insert new migration * Set stateVersion when creating new globals object * PR comments * Fix migrate imports * Move migration building into `migrate` function * Export current version from migration definitions * Move file version concerns to migrator * Update migrate spec to reflect new version requirements * Fix import paths * Prefer unique state data * Remove unnecessary async * Prefer to not use `any` --------- Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com> Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>
2025-12-18 09:13:33 +00:00 · 2023-08-30 12:57:20 -05:00
parent b444eed0b5
commit 3340af8084
51 changed files with 1538 additions and 980 deletions
--- a/libs/common/src/state-migrations/migrator.spec.ts
+++ b/libs/common/src/state-migrations/migrator.spec.ts
@@ -0,0 +1,75 @@
+import { mock, MockProxy } from "jest-mock-extended";
+
+// eslint-disable-next-line import/no-restricted-paths -- Needed to print log messages
+import { LogService } from "../platform/abstractions/log.service";
+// eslint-disable-next-line import/no-restricted-paths -- Needed to interface with storage locations
+import { AbstractStorageService } from "../platform/abstractions/storage.service";
+
+import { MigrationHelper } from "./migration-helper";
+import { Migrator } from "./migrator";
+
+describe("migrator default methods", () => {
+  class TestMigrator extends Migrator<0, 1> {
+    async migrate(helper: MigrationHelper): Promise<void> {
+      await helper.set("test", "test");
+    }
+    async rollback(helper: MigrationHelper): Promise<void> {
+      await helper.set("test", "rollback");
+    }
+  }
+
+  let storage: MockProxy<AbstractStorageService>;
+  let logService: MockProxy<LogService>;
+  let helper: MigrationHelper;
+  let sut: TestMigrator;
+
+  beforeEach(() => {
+    storage = mock();
+    logService = mock();
+    helper = new MigrationHelper(0, storage, logService);
+    sut = new TestMigrator(0, 1);
+  });
+
+  describe("shouldMigrate", () => {
+    describe("up", () => {
+      it("should return true if the current version equals the from version", async () => {
+        expect(await sut.shouldMigrate(helper, "up")).toBe(true);
+      });
+
+      it("should return false if the current version does not equal the from version", async () => {
+        helper.currentVersion = 1;
+        expect(await sut.shouldMigrate(helper, "up")).toBe(false);
+      });
+    });
+
+    describe("down", () => {
+      it("should return true if the current version equals the to version", async () => {
+        helper.currentVersion = 1;
+        expect(await sut.shouldMigrate(helper, "down")).toBe(true);
+      });
+
+      it("should return false if the current version does not equal the to version", async () => {
+        expect(await sut.shouldMigrate(helper, "down")).toBe(false);
+      });
+    });
+  });
+
+  describe("updateVersion", () => {
+    describe("up", () => {
+      it("should update the version", async () => {
+        await sut.updateVersion(helper, "up");
+        expect(storage.save).toBeCalledWith("stateVersion", 1);
+        expect(helper.currentVersion).toBe(1);
+      });
+    });
+
+    describe("down", () => {
+      it("should update the version", async () => {
+        helper.currentVersion = 1;
+        await sut.updateVersion(helper, "down");
+        expect(storage.save).toBeCalledWith("stateVersion", 0);
+        expect(helper.currentVersion).toBe(0);
+      });
+    });
+  });
+});