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 {isDataCorrupted} = require("./subscriptionInit.js");
 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 initialized and a data corruption
+ * if any was detected, as well when notification 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=" + (isDataCorrupted() ? "1" : "0"));

[Thomas Greiner, 2018/04/27 14:50:13]

Suggestion: Instead of passing this parameter on each download even for those
who don't even encounter this issue, what about an "issue" query string
parameter which can specify one or more issues? (e.g.
"?issue=dataCorrupted&issues=reinitialized&...")

On the server-side we should be able to infer using "addonVersion" that if the
parameter is missing that the issue wasn't encountered.

[Sebastian Noack, 2018/04/27 16:01:04]

This seems somewhat premature. I guess we can change this, once we start
indicating different issues here (if ever).

[Thomas Greiner, 2018/04/27 16:27:33]

Ok, I'll bring this up with the Data team for tackling it afterwards.

 
   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);