add rules conversion when update from 1.x to 2.x

Author: maximelebreton

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "qjs",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.6",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -15,13 +15,15 @@
     "core-js": "^3.6.5",
     "deepmerge": "^4.2.2",
     "lodash": "^4.17.21",
+    "semver": "^7.3.5",
     "tldts": "^5.7.38",
     "vue": "^3.2.21"
   },
   "devDependencies": {
     "@types/chrome": "0.0.75",
     "@types/jest": "^24.0.19",
     "@types/lodash": "^4.14.170",
+    "@types/semver": "^7.3.9",
     "@typescript-eslint/eslint-plugin": "^4.18.0",
     "@typescript-eslint/parser": "^4.18.0",
     "@vue/cli-plugin-babel": "~4.5.0",

package.json

@@ -5,8 +5,8 @@ import { updateIcon } from "./icon";
 import {
   getStorageRules,
   QJS,
-  setStorageRules,
-  unsetStorageRules,
+  setStorageRule,
+  unsetStorageRule,
 } from "./storage";
 import { getUrlAsObject, isValidScheme } from "./utils";
 
@@ -92,7 +92,7 @@ export const addJavascriptRule = async (rule: QJS.ContentSettingRule) => {
       if (chrome.runtime.lastError) {
         console.error(chrome.runtime.lastError.message);
       } else {
-        await setStorageRules(rule);
+        await setStorageRule(rule);
       }
       resolve();
     });
@@ -128,7 +128,7 @@ export const removeJavascriptRule = async (
       Object.entries(storageRules).forEach(([key, storageRule]) => {
         chrome.contentSettings.javascript.set(storageRule, async () => {});
       });
-      await unsetStorageRules(rule);
+      await unsetStorageRule(rule);
     }
     resolve();
   });

src/entry/background/contentsettings.ts

@@ -4,9 +4,15 @@ import { rebaseJavascriptSettingsFromStorage } from "./contentsettings";
 import { handleContextMenu, updateContextMenus } from "./contextmenus";
 import { updateIcon } from "./icon";
 
-import { getStorageRules } from "./storage";
+import {
+  convertOldRulesToNew,
+  getStorageRules,
+  QJS,
+  setStorage,
+} from "./storage";
 import { getActiveTab } from "./tabs";
 import { cl, Log } from "./utils";
+import satisfies from "semver/functions/satisfies";
 
 // export const handleUpdates = async () => {
 //   await updateContextMenus();
@@ -56,10 +62,36 @@ export const initEvents = () => {
 
   // chrome.tabs.onUpdated.addListener((tabId, changeInfo) => {});
 
-  chrome.runtime.onInstalled.addListener(async () => {
+  const handleUpdateFromV1toV2 = async () => {
+    const currentRules = await getStorageRules();
+    if (Array.isArray(currentRules)) {
+      const convertedRules = convertOldRulesToNew(currentRules);
+      await setStorage("rules", convertedRules);
+    }
+  };
+
+  chrome.runtime.onInstalled.addListener(async (details) => {
     await updateContextMenus();
     const tab = await getActiveTab();
     await updateIcon(tab);
+
+    // Check whether new version is installed
+    if (details.reason == "install") {
+      //console.log("First install!");
+    } else if (details.reason == "update") {
+      const currentVersion = chrome.runtime.getManifest().version;
+      const isFromV1ToV2 =
+        details.previousVersion &&
+        satisfies(details.previousVersion, "<2.0.0") &&
+        satisfies(currentVersion, ">=2.0.0");
+
+      if (isFromV1ToV2) {
+        console.log(
+          `Updated from ${details.previousVersion} to ${currentVersion}, trying to convert existing rules.`
+        );
+        await handleUpdateFromV1toV2();
+      }
+    }
   });
 
   chrome.contextMenus.onClicked.addListener((info, tab) => {