Merge pull request #363 from sanemat/feat/data-migration

data migration from localStorage to browser.storage (chrome.storage)

Author: sanemat

.jshintrc

@@ -20,6 +20,7 @@
   "smarttabs": true,
   "globals" : {
     "chrome": true,
-    "jQuery": true
+    "jQuery": true,
+    "browser": true
   }
 }

app/manifest.json

@@ -7,12 +7,17 @@
         "16": "images/icon2-16.png",
         "128": "images/icon2-128.png"
     },
-    "permissions": [],
+    "permissions": [
+        "storage",
+        "activeTab",
+        "https://github.com/*/*/pull/*"
+    ],
     "default_locale": "en",
     "background": {
         "scripts": [
             "scripts/background.js"
-        ]
+        ],
+        "persistent": true
     },
     "options_page": "options.html",
     "content_scripts": [

app/scripts/background.js

@@ -1,11 +1,48 @@
 'use strict';
 
-chrome.runtime.onInstalled.addListener(function (details) {
-  console.log('previousVersion', details.previousVersion);
+// Define browser for cross-browser compatibility
+var browser = (typeof browser !== 'undefined') ? browser : chrome;
+
+function migrateLocalStorageToBrowserStorage() {
+  // Check if localStorage is not null and contains any keys
+  if (!localStorage || Object.keys(localStorage).length === 0) {
+    console.log('No localStorage data to migrate.');
+    return;
+  }
+
+  // Get all localStorage keys
+  const localStorageKeys = Object.keys(localStorage);
+  const dataToMigrate = {};
+
+  localStorageKeys.forEach((key) => {
+    dataToMigrate[key] = localStorage.getItem(key);
+  });
+
+  // Store data in broswer.storage
+  browser.storage.local.set(dataToMigrate, () => {
+    console.log('Data migrated to browser.storage', dataToMigrate);
+
+    // Clear localStorage after migration
+    localStorage.clear();
+  });
+}
+
+browser.runtime.onInstalled.addListener(function (details) {
+  if (details.reason === 'install') {
+    // Handle installation logic
+    console.log('Extension installed');
+  } else if (details.reason === 'update') {
+    console.log('previousVersion', details.previousVersion);
+    // Handle update logic
+    migrateLocalStorageToBrowserStorage();
+  }
 });
 
-chrome.runtime.onMessage.addListener(function(request, sender, sendResponse){
-  if (request.subject === 'localStorage') {
-    sendResponse({localStorage: localStorage});
+browser.runtime.onMessage.addListener(function (request, sender, sendResponse) {
+  if (request.subject === 'getStorage') {
+    browser.storage.local.get(null, function (items) {
+      sendResponse({ storageData: items });
+    });
+    return true; // Keep the message channel open for sendResponse
   }
 });

app/scripts/contentscript.js

@@ -2,17 +2,20 @@
   'use strict';
 
   function changeMergeButtonState() {
+    // Define browser for cross-browser compatibility
+    var browser = (typeof browser !== 'undefined') ? browser : chrome;
+
     let container = document.querySelector('#js-repo-pjax-container');
     let issueTitle = container.querySelector('.js-issue-title')?.textContent;
     let buttonMerges = container.querySelectorAll('.merge-message button[data-details-container]');
     let buttonMergeOptions = container.querySelectorAll('.merge-message button[data-details-container] + .select-menu-button');
     let disabled = false;
     let buttonHtml = '';
 
-    chrome.runtime.sendMessage({from: 'content', subject: 'localStorage'}, function(response){
+    browser.runtime.sendMessage({ from: 'content', subject: 'getStorage' }, function (response) {
       if (!response) { return; }
 
-      let localStorage = response.localStorage;
+      let storageData = response.storageData;
       const wipTitleRegex = /[\[(^](do\s*n[o']?t\s*merge|wip|dnm)[\]):]/i;
       const wipTagRegex = /(wip|do\s*not\s*merge|dnm)/i;
 
@@ -32,8 +35,8 @@
 
       let buttonMessage = '';
 
-      if (localStorage && localStorage.buttonMessage) {
-        buttonMessage = localStorage.buttonMessage;
+      if (storageData && storageData.buttonMessage) {
+        buttonMessage = storageData.buttonMessage;
       } else {
         buttonMessage = 'WIP! You can\'t merge!';
       }
@@ -56,9 +59,10 @@
       buttonMergeOptions = null;
       buttonHtml = null;
       buttonMessage = null;
-      localStorage = null;
+      storageData = null;
       isSquashCommits = null;
       isWipTag = null;
+      browser = null;
 
       setTimeout(changeMergeButtonState, 1000);
     });

app/scripts/options.js

@@ -1,14 +1,20 @@
 (() => {
   'use strict';
 
+  // Define browser for cross-browser compatibility
+  var browser = (typeof browser !== 'undefined') ? browser : chrome;
+
   window.addEventListener('DOMContentLoaded', () => {
-    document.getElementById('buttonMessage').value = localStorage.buttonMessage;
+    browser.storage.local.get('buttonMessage', function (result) {
+      document.getElementById('buttonMessage').value = result.buttonMessage || '';
+    });
 
     document.getElementById('save_btn').closest('form').addEventListener('submit', e => {
       e.preventDefault();
-      localStorage.buttonMessage = e.target.buttonMessage.value;
-
-      window.alert('The options have been saved!');
+      const buttonMessage = e.target.buttonMessage.value;
+      browser.storage.local.set({ buttonMessage: buttonMessage }, function () {
+        window.alert('The options have been saved!');
+      });
     });
   });
 })();