fix: settings schema migration

Author: pnd280

src/entrypoints/background/listeners.ts

@@ -4,15 +4,9 @@ import { onMessage } from "webext-bridge/background";
 import { APP_CONFIG } from "@/app.config";
 import { ExtensionLocalStorageService } from "@/services/extension-local-storage";
 import { ExtensionLocalStorageApi } from "@/services/extension-local-storage/extension-local-storage-api";
-import {
-  ExtensionLocalStorage,
-  ExtensionLocalStorageSchema,
-} from "@/services/extension-local-storage/extension-local-storage.types";
 import { hasRequiredPermissions } from "@/services/pplx-theme-preloader";
-import { errorWrapper } from "@/utils/error-wrapper";
 import { ExtensionVersion } from "@/utils/ext-version";
 import { getThemeCss } from "@/utils/pplx-theme-loader-utils";
-import { EXT_UPDATE_MIGRATIONS } from "@/utils/update-migrations";
 import { getOptionsPageUrl } from "@/utils/utils";
 
 export type BackgroundEvents = {
@@ -27,8 +21,6 @@ export function setupBackgroundListeners() {
 
   onboardingFlowTrigger();
 
-  updateMigrations();
-
   invalidateCdnCache();
 
   createDashboardShortcut();
@@ -137,42 +129,3 @@ function extensionIconActionListener() {
     else chrome.runtime.openOptionsPage();
   });
 }
-
-function updateMigrations() {
-  chrome.runtime.onInstalled.addListener(
-    async ({ reason, previousVersion }) => {
-      if (reason !== chrome.runtime.OnInstalledReason.UPDATE) return;
-
-      if (!previousVersion) return;
-
-      console.log("Upgraded from", previousVersion, "to", APP_CONFIG.VERSION);
-
-      const migrations = Object.entries(EXT_UPDATE_MIGRATIONS);
-
-      let migratedSettings: ExtensionLocalStorage | null = null;
-
-      for (const [version, migrationFns] of migrations) {
-        if (new ExtensionVersion(version).isNewerThan(previousVersion)) {
-          for (const migrationFn of migrationFns) {
-            const oldRawSettings =
-              migratedSettings ?? (await ExtensionLocalStorageApi.get());
-            const [newSettings, error] = await errorWrapper(
-              (): Promise<ExtensionLocalStorage> =>
-                migrationFn({ oldRawSettings }),
-            )();
-
-            if (error) continue;
-
-            migratedSettings = newSettings;
-          }
-        }
-      }
-
-      if (migratedSettings) {
-        ExtensionLocalStorageApi.set(
-          ExtensionLocalStorageSchema.parse(migratedSettings),
-        );
-      }
-    },
-  );
-}

src/services/extension-local-storage/index.ts

@@ -1,5 +1,6 @@
 import { produce } from "immer";
 
+import { APP_CONFIG } from "@/app.config";
 import { ExtensionLocalStorageApi } from "@/services/extension-local-storage/extension-local-storage-api";
 import {
   ExtensionLocalStorageSchema,
@@ -16,7 +17,10 @@ import {
 } from "@/services/extension-local-storage/utils";
 import { isZodError } from "@/types/utils.types";
 import { csLoaderRegistry } from "@/utils/cs-loader-registry";
+import { errorWrapper } from "@/utils/error-wrapper";
+import { ExtensionVersion } from "@/utils/ext-version";
 import { queryClient } from "@/utils/ts-query-client";
+import { EXT_UPDATE_MIGRATIONS } from "@/utils/update-migrations";
 import { isInContentScript, whereAmI } from "@/utils/utils";
 import packageJson from "~/package.json";
 
@@ -119,16 +123,24 @@ async function mergeData(
     return DEFAULT_STORAGE;
   }
 
-  console.log("[Cplx] Settings schema mismatch, merging with defaults...");
+  console.log("[Cplx] Settings schema mismatch");
 
-  const cleanSettings = error.issues.reduce(
-    (settings, issue) =>
-      setPathToUndefined({
-        paths: issue.path as string[],
-        obj: settings,
-      }) as ExtensionLocalStorage,
-    rawSettings,
-  );
+  if (error.issues.some((issue) => issue.path[0] === "schemaVersion")) {
+    return mergeData(
+      (await updateMigrations({
+        previousVersion: rawSettings.schemaVersion,
+        rawSettings,
+      })) ?? rawSettings,
+      DEFAULT_STORAGE,
+    );
+  }
+
+  const cleanSettings = error.issues.reduce((settings, issue) => {
+    return setPathToUndefined({
+      paths: issue.path as string[],
+      obj: settings,
+    }) as ExtensionLocalStorage;
+  }, rawSettings);
 
   const updatedSettings = {
     ...mergeUndefined({
@@ -155,3 +167,39 @@ csLoaderRegistry.register({
     await ExtensionLocalStorageService.get();
   },
 });
+
+async function updateMigrations({
+  previousVersion,
+  rawSettings,
+}: {
+  previousVersion: string;
+  rawSettings: ExtensionLocalStorage;
+}) {
+  if (!previousVersion) return;
+
+  console.log("Migrate schema from", previousVersion, "to", APP_CONFIG.VERSION);
+
+  const migrations = Object.entries(EXT_UPDATE_MIGRATIONS);
+
+  let migratedSettings: ExtensionLocalStorage = rawSettings;
+
+  for (const [version, migrationFns] of migrations) {
+    if (new ExtensionVersion(version).isNewerThan(previousVersion)) {
+      for (const migrationFn of migrationFns) {
+        const oldRawSettings = migratedSettings ?? rawSettings;
+        const [newSettings, error] = await errorWrapper(
+          (): Promise<ExtensionLocalStorage> => migrationFn({ oldRawSettings }),
+        )();
+
+        if (error || !newSettings) continue;
+
+        migratedSettings = newSettings;
+      }
+    }
+  }
+
+  return {
+    ...migratedSettings,
+    schemaVersion: packageJson.version,
+  };
+}

src/utils/update-migrations.ts

@@ -11,6 +11,8 @@ type MigrationFn = ({
 export const enableThreadMessageTtsKey: MigrationFn = async ({
   oldRawSettings,
 }) => {
+  console.log("[ExtUpdateMigrations] Enable Thread Message TTS Key");
+
   return produce(oldRawSettings, (draft) => {
     draft.plugins["thread:messageTts"] = {
       enabled: true,