fix broken data storage upgrade from 3.4.3

Author: GaurangTandon

js/background.js

@@ -265,6 +265,24 @@ let removeCtxSnippetList,
     };
 }());
 
+/**
+ * when upgrading from old versions to 3.5.0, we need to set
+ * the localStorage property which indicates what type of storage
+ * the user is using. This fn detects correct storage
+ * @param {Function} callback fn called after correctly setting type of
+ * storage in localStorage
+ */
+function updateCompatForOldData(callback) {
+    localStorage[LS_STORAGE_TYPE_PROP] = "local";
+    chrome.storage.local.get(OLD_DATA_STORAGE_KEY, (response) => {
+        const Data = response[OLD_DATA_STORAGE_KEY];
+        if (Data.snippets === false) {
+            localStorage[LS_STORAGE_TYPE_PROP] = "sync";
+        }
+        callback();
+    });
+}
+
 function afterBGPageReload({
     notifText, notifTitle, version, reason,
 }) {
@@ -282,6 +300,20 @@ function afterBGPageReload({
     });
 }
 
+function handleExtUpdate(notifProps) {
+    storage = chrome.storage[localStorage[LS_STORAGE_TYPE_PROP]];
+
+    window.latestRevisionLabel = "";
+    storage.get(
+        OLD_DATA_STORAGE_KEY,
+        chromeAPICallWrapper((response) => {
+            window.Data = response[OLD_DATA_STORAGE_KEY];
+
+            afterBGPageReload(notifProps);
+        }),
+    );
+}
+
 chrome.runtime.onInstalled.addListener((details) => {
     runtimeOnInstalledFired = true;
     // unset it after five seconds, reasonable time
@@ -316,22 +348,17 @@ chrome.runtime.onInstalled.addListener((details) => {
     } else if (reason === "update") {
         notifTitle = `ProKeys updated to v${version}`;
         notifText = "Hooray! Please reload active tabs to use the new version.";
-        storage = chrome.storage[localStorage[LS_STORAGE_TYPE_PROP]];
-
-        window.latestRevisionLabel = "";
-        storage.get(
-            OLD_DATA_STORAGE_KEY,
-            chromeAPICallWrapper((response) => {
-                window.Data = response[OLD_DATA_STORAGE_KEY];
-
-                afterBGPageReload({
-                    notifText,
-                    notifTitle,
-                    version,
-                    reason,
-                });
-            }),
-        );
+        const args = {
+            notifText,
+            notifTitle,
+            version,
+            reason,
+        };
+        if (typeof localStorage[LS_STORAGE_TYPE_PROP] === "undefined") {
+            updateCompatForOldData(() => handleExtUpdate(args));
+        } else {
+            handleExtUpdate(args);
+        }
     } else {
         // do not process anything other than install or update
     }

tests/data/ProKeys data Jun 12 2019.txt

@@ -0,0 +1,60 @@
+{
+  "blockedSites": [
+    "so.com"
+  ],
+  "charsToAutoInsertUserList": [
+    [
+      "(",
+      ")"
+    ],
+    [
+      "[",
+      "]"
+    ]
+  ],
+  "dataUpdateVariable": true,
+  "dataVersion": 1,
+  "hotKey": [
+    32
+  ],
+  "language": "English",
+  "matchDelimitedWord": true,
+  "omniboxSearchURL": "https://www.google.com/search?q=SEARCH",
+  "snipNameDelimiterList": "@#$%&*+-=(){}[]:\"'/_<>?!., ",
+  "snippets": [
+    "Snippets",
+    1560319171318,
+    [
+      "sampleFolder",
+      1560319171318,
+      {
+        "name": "brb",
+        "body": "be right back",
+        "timestamp": 1560319171318
+      },
+      {
+        "name": "dateArithmetic",
+        "body": "Use this snippet in any webpage, and you'll see that the following: [[%d(Do MMMM YYYY hh:m:s)]] is replaced by the current date and time.\n\nMoreover, you can perform date/time arithmetic. The following: [[%d(D+5 MMMM+5 YYYY+5 hh-5:m-5:s-5)]] gives the date, month, year, forward by five; and hour, minutes, and seconds backward by 5.\n\nMore info on this in the Help section.",
+        "timestamp": 1560319171318
+      },
+      {
+        "name": "letter",
+        "body": "(Sample snippet to demonstrate the power of ProKeys snippets; for more detail on Placeholders, see the Help section)\n\nHello %name%,\n\nYour complaint number %complaint% has been noted. We will work at our best pace to get this issue solved for you. If you experience any more problems, please feel free to contact at [email protected].\n\nRegards,\n%my_name%,\nDate: [[%d(D-MM-YYYY)]]",
+        "timestamp": 1560319171318
+      },
+      {
+        "name": "my_sign",
+        "body": "<b>Aquila Softworks ©</b>\n<i>Creator Of ProKeys</i>\n<u>[email protected]</u>",
+        "timestamp": 1560319171318
+      }
+    ],
+    {
+      "name": "123",
+      "body": "Hello new user! Thank you for using ProKeys!\n\nThis is a sample snippet. Try using it on any webpage by typing 'sampleSnippet' (snippet name; without quotes), and press the hotkey (default: Shift+Space), and this whole text would come in place of it.",
+      "timestamp": 1560319171318
+    }
+  ],
+  "tabKey": false,
+  "visited": true,
+  "wrapSelectionAutoInsert": true
+}

tests/data/README.md

@@ -0,0 +1,4 @@
+# Test data
+
+This data can be exported into a v3.4.3+ extension to enable it for testing.
+It features several changes to default data, and the aim is that after upgrading from one version to another, this data must be retained as is.