Issue 7054 - Update the adblockpluscore dependency to 5cb695da5a40, adblockplusui to f86abf2efdfd

lib/subscriptionInit.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 subscriptionInit */
 
 "use strict";
 
 const {Subscription,
        DownloadableSubscription,
        SpecialSubscription} =
   require("../adblockpluscore/lib/subscriptionClasses");
-const {FilterStorage} = require("../adblockpluscore/lib/filterStorage");
+const {filterStorage} = require("../adblockpluscore/lib/filterStorage");
 const {filterNotifier} = require("../adblockpluscore/lib/filterNotifier");
 const info = require("info");
 const {Prefs} = require("./prefs");
 const {Synchronizer} = require("../adblockpluscore/lib/synchronizer");
 const {Utils} = require("./utils");
 const {initNotifications} = require("./notificationHelper");
 const {updatesVersion} = require("../adblockplusui/lib/prefs");
 
 let firstRun;
 let subscriptionsCallback = null;
 let reinitialized = false;
 let dataCorrupted = false;
 
 /**
  * If there aren't any filters, the default subscriptions are added.
  * However, if patterns.ini already did exist and/or any preference
  * is set to a non-default value, this indicates that this isn't the
  * first run, but something went wrong.
  *
  * This function detects the first run, and makes sure that the user
  * gets notified (on the first run page) if the data appears incomplete
  * and therefore will be reinitialized.
  */
 function detectFirstRun()
 {
-  firstRun = FilterStorage.knownSubscriptions.size == 0;

[Manish Jethani, 2018/10/15 23:54:47]

The intention was to expose the subscriptions generator function and keep
knownSubscriptions as "private" to the module. Let's use
`FilterStorage.subscriptionCount` here.

[Jon Sonesen, 2018/11/29 17:33:54]

Acknowledged.

-
-  if (firstRun && (!FilterStorage.firstRun || Prefs.currentVersion))
+  firstRun = filterStorage.subscriptionCount == 0;
+
+  if (firstRun && (!filterStorage.firstRun || Prefs.currentVersion))
     reinitialized = true;
 
   Prefs.currentVersion = info.addonVersion;
 }
 
 /**
  * Determines whether to add the default ad blocking subscriptions.
  * Returns true, if there are no filter subscriptions besides those
  * other subscriptions added automatically, and no custom filters.
  *
  * On first run, this logic should always result in true since there
  * is no data and therefore no subscriptions. But it also causes the
  * default ad blocking subscriptions to be added again after some
  * data corruption or misconfiguration.
  *
  * @return {boolean}
  */
 function shouldAddDefaultSubscriptions()
 {
-  for (let subscription of [...FilterStorage.knownSubscriptions.values()])

[Manish Jethani, 2018/10/15 23:54:47]

Similarly, let's make this `FilterStorage.subscriptions()` (note: there's no
need for a temporary array).

[Jon Sonesen, 2018/11/29 17:33:54]

Acknowledged.

+  for (let subscription of filterStorage.subscriptions())
   {
     if (subscription instanceof DownloadableSubscription &&
         subscription.url != Prefs.subscriptions_exceptionsurl &&
         subscription.url != Prefs.subscriptions_antiadblockurl &&
         subscription.type != "circumvention")
       return false;
 
     if (subscription instanceof SpecialSubscription &&
-        subscription.filters.length > 0)
+        subscription.filterCount > 0)
       return false;
   }
 
   return true;
 }
 
 /**
  * @typedef {object} DefaultSubscriptions
  * @property {?Element} ads
  * @property {?Element} circumvention
  */
 /**
  * Finds the elements for the default ad blocking filter subscriptions based
  * on the user's locale.
  *
  * @param {HTMLCollection} subscriptions
  * @return {DefaultSubscriptions}
  */
 function chooseFilterSubscriptions(subscriptions)
 {
   let selectedItem = {};
   let selectedPrefix = null;
   let matchCount = 0;
-  for (let subscription of [...subscriptions])

[Manish Jethani, 2018/10/15 23:54:47]

Not required.

[Jon Sonesen, 2018/11/29 17:33:54]

Acknowledged.

+  for (let subscription of subscriptions)
   {
     let prefixes = subscription.getAttribute("prefixes");
     let prefix = prefixes && prefixes.split(",").find(
       lang => new RegExp("^" + lang + "\\b").test(Utils.appLocale)
     );
 
     let subscriptionType = subscription.getAttribute("type");
 
     if ((subscriptionType == "ads" || subscriptionType == "circumvention") &&
         !selectedItem[subscriptionType])
@@ skipping 139 matching lines @@
   }
 
   return subscriptions;
 }
 
 function addSubscriptionsAndNotifyUser(subscriptions)
 {
   if (subscriptionsCallback)
     subscriptions = subscriptionsCallback(subscriptions);
 
-  for (let subscription of [...subscriptions])

[Manish Jethani, 2018/10/15 23:54:47]

Not required.

[Jon Sonesen, 2018/11/29 17:33:54]

Acknowledged.

-  {
-    FilterStorage.addSubscription(subscription);
+  for (let subscription of subscriptions)
+  {
+    filterStorage.addSubscription(subscription);
     if (subscription instanceof DownloadableSubscription &&
         !subscription.lastDownload)
       Synchronizer.execute(subscription);
   }
 
   // Show first run page or the updates page. The latter is only shown
   // on Chromium (since the current updates page announces features that
   // aren't new to Firefox users), and only if this version of the
   // updates page hasn't been shown yet.
   if (firstRun || info.platform == "chromium" &&
@@ skipping 54 matching lines @@
  *
  * @param {function} callback
  */
 exports.setSubscriptionsCallback = callback =>
 {
   subscriptionsCallback = callback;
 };
 
 // Exports for tests only
 exports.chooseFilterSubscriptions = chooseFilterSubscriptions;