Issue 6599 - Detect data corruption of storage.local

lib/uninstall.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /** @module uninstall */
 
 "use strict";
 
 const info = require("../buildtools/info");
+const subscriptionInit = require("./subscriptionInit.js");

[kzar, 2018/04/25 14:38:12]

Nit: const {dataCorrupted} = require(...)?

[Sebastian Noack, 2018/04/25 14:46:23]

At the time we import subscriptionInit.js, dataCorrupted might not be set to its
final value yet.

[kzar, 2018/04/25 14:57:04]

That's why I suggest making it a getter instead.

 const {Prefs} = require("./prefs");
 const {Utils} = require("./utils");
 
-function setUninstallURL()
+let setUninstallURL =
+/**
+ * Sets (or updates) the URL that is openend when the extension is uninstalled.
+ *
+ * Must be called after prefs got initilized and a data corruption

[kzar, 2018/04/25 14:38:12]

Nit: A couple typos 'initialized' and 'notification'.

[Sebastian Noack, 2018/04/25 14:46:23]

Done.

+ * if any was detected, as well when noification data change.
+ */
+exports.setUninstallURL = () =>
 {
   let search = [];
   for (let key of ["addonName", "addonVersion", "application",
                    "applicationVersion", "platform", "platformVersion"])
     search.push(key + "=" + encodeURIComponent(info[key]));
 
   let downlCount = Prefs.notificationdata.downloadCount || 0;
 
   if (downlCount > 4)
   {
     if (downlCount < 8)
       downlCount = "5-7";
     else if (downlCount < 30)
       downlCount = "8-29";
     else if (downlCount < 90)
       downlCount = "30-89";
     else if (downlCount < 180)
       downlCount = "90-179";
     else
       downlCount = "180+";
   }
 
   search.push("notificationDownloadCount=" + encodeURIComponent(downlCount));
+  search.push("dataCorrupted=" + (subscriptionInit.dataCorrupted ? "1" : "0"));
 
   browser.runtime.setUninstallURL(Utils.getDocLink("uninstalled") + "&" +
                                   search.join("&"));
-}
+};
 
-// The uninstall URL contains the notification download count as a parameter,
-// therefore we must wait for preferences to be loaded before generating the
-// URL and we need to re-generate it each time the notification data changes.
-if ("setUninstallURL" in browser.runtime)
-{
-  Prefs.untilLoaded.then(setUninstallURL);
-  Prefs.on("notificationdata", setUninstallURL);
-}
+Prefs.on("notificationdata", setUninstallURL);