Issue 6665 - Abstract element hiding container logic into its own module

test/filterListener.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/>.
  */
 
 "use strict";
 
 const {createSandbox} = require("./_common");
 let sandboxedRequire = null;
 
 let FilterStorage = null;
 let Subscription = null;
 let Filter = null;
 let defaultMatcher = null;
 let SpecialSubscription = null;
-let ElemHideException = null;
 
 exports.setUp = function(callback)
 {
-  sandboxedRequire = createSandbox();
+  sandboxedRequire = createSandbox({
+    extraExports: {
+      elemHideExceptions: ["knownExceptions"],
+      snippets: ["filters"]
+    }
+  });
 
   // We need to require the filterListener module so that filter changes will be
   // noticed, even though we don't directly use the module here.
   sandboxedRequire("../lib/filterListener");
 
   (
     {FilterStorage} = sandboxedRequire("../lib/filterStorage"),
     {Subscription, SpecialSubscription} = sandboxedRequire("../lib/subscriptionClasses"),
-    {Filter, ElemHideException} = sandboxedRequire("../lib/filterClasses"),
+    {Filter} = sandboxedRequire("../lib/filterClasses"),
     {defaultMatcher} = sandboxedRequire("../lib/matcher")
   );
 
   FilterStorage.addSubscription(Subscription.fromURL("~fl~"));
   FilterStorage.addSubscription(Subscription.fromURL("~wl~"));
   FilterStorage.addSubscription(Subscription.fromURL("~eh~"));
 
   Subscription.fromURL("~fl~").defaults = ["blocking"];
   Subscription.fromURL("~wl~").defaults = ["whitelist"];
   Subscription.fromURL("~eh~").defaults = ["elemhide"];
@@ skipping 16 matching lines @@
         test.equal(matcher.getKeywordForFilter(filter), keyword,
                    "Keyword of filter " + filter.text);
         filters.push(filter.text);
       }
     }
     result[type] = filters;
   }
 
   let elemHide = sandboxedRequire("../lib/elemHide");
   result.elemhide = [];
+  for (let filter of elemHide.ElemHide._knownFilters)
+    result.elemhide.push(filter.text);
+
+  let elemHideExceptions = sandboxedRequire("../lib/elemHideExceptions");
   result.elemhideexception = [];
-  for (let filter of elemHide.ElemHide._knownFilters)
-  {
-    if (filter instanceof ElemHideException)
-      result.elemhideexception.push(filter.text);
-    else
-      result.elemhide.push(filter.text);
-  }
+  for (let exception of elemHideExceptions.knownExceptions)
+    result.elemhideexception.push(exception.text);
 
   let elemHideEmulation = sandboxedRequire("../lib/elemHideEmulation");
   result.elemhideemulation = [];
   for (let filter of elemHideEmulation.ElemHideEmulation._knownFilters)
     result.elemhideemulation.push(filter.text);
 
+  let snippets = sandboxedRequire("../lib/snippets");
+  result.snippets = [];
+  for (let filterText of snippets.filters)
+    result.snippets.push(filterText);
+
   let types = ["blacklist", "whitelist", "elemhide", "elemhideexception",
-               "elemhideemulation"];
+               "elemhideemulation", "snippets"];
   for (let type of types)
   {
     if (!(type in expected))
       expected[type] = [];
     else
       expected[type].sort();
     result[type].sort();
   }
 
   test.deepEqual(result, expected, text);
@@ skipping 175 matching lines @@
 
   subscription2.disabled = false;
   checkKnownFilters(test, "enable blocking filters", {blacklist: [filter1.text]});
 
   let subscription3 = Subscription.fromURL("~wl~");
   subscription3.disabled = true;
   checkKnownFilters(test, "disable exception rules", {blacklist: [filter1.text]});
 
   FilterStorage.addFilter(filter2);
   checkKnownFilters(test, "add @@filter2", {blacklist: [filter1.text], whitelist: [filter2.text]});
-  test.equal(filter2.subscriptions.length, 1, "@@filter2.subscription.length");
-  test.ok(filter2.subscriptions[0] instanceof SpecialSubscription, "@@filter2 added to a new filter group");
-  test.ok(filter2.subscriptions[0] != subscription3, "@@filter2 filter group is not the disabled exceptions group");
+  test.equal(filter2.subscriptions.size, 1, "@@filter2.subscription.length");
+  test.ok([...filter2.subscriptions][0] instanceof SpecialSubscription, "@@filter2 added to a new filter group");
+  test.ok([...filter2.subscriptions][0] != subscription3, "@@filter2 filter group is not the disabled exceptions group");
 
   subscription3.disabled = false;
   checkKnownFilters(test, "enable exception rules", {blacklist: [filter1.text], whitelist: [filter2.text]});
 
   FilterStorage.removeFilter(filter2);
   FilterStorage.addFilter(filter2);
   checkKnownFilters(test, "re-add @@filter2", {blacklist: [filter1.text], whitelist: [filter2.text]});
-  test.equal(filter2.subscriptions.length, 1, "@@filter2.subscription.length");
-  test.ok(filter2.subscriptions[0] == subscription3, "@@filter2 added to the default exceptions group");
+  test.equal(filter2.subscriptions.size, 1, "@@filter2.subscription.length");
+  test.ok([...filter2.subscriptions][0] == subscription3, "@@filter2 added to the default exceptions group");
 
   let subscription4 = Subscription.fromURL("http://test/");
   FilterStorage.updateSubscriptionFilters(subscription4, [filter3, filter4, filter5]);
   checkKnownFilters(test, "update subscription not in the list yet", {blacklist: [filter1.text], whitelist: [filter2.text]});
 
   FilterStorage.addSubscription(subscription4);
   checkKnownFilters(test, "add subscription to the list", {blacklist: [filter1.text, filter3.text], whitelist: [filter2.text, filter4.text]});
 
   FilterStorage.updateSubscriptionFilters(subscription4, [filter3, filter2, filter5]);
   checkKnownFilters(test, "update subscription while in the list", {blacklist: [filter1.text, filter3.text], whitelist: [filter2.text]});
 
   subscription3.disabled = true;
   checkKnownFilters(test, "disable exception rules", {blacklist: [filter1.text, filter3.text], whitelist: [filter2.text]});
 
   FilterStorage.removeSubscription(subscription4);
   checkKnownFilters(test, "remove subscription from the list", {blacklist: [filter1.text]});
 
   subscription3.disabled = false;
   checkKnownFilters(test, "enable exception rules", {blacklist: [filter1.text], whitelist: [filter2.text]});
 
   test.done();
 };
+
+exports.testSnippetFilters = function(test)
+{
+  let filter1 = Filter.fromText("example.com#$#filter1");
+  let filter2 = Filter.fromText("example.com#$#filter2");
+
+  let subscription1 = Subscription.fromURL("http://test1/");
+  subscription1.filters = [filter1, filter2];
+
+  FilterStorage.addSubscription(subscription1);
+  checkKnownFilters(test, "add subscription with filter1 and filter2", {});
+
+  let subscription2 = Subscription.fromURL("http://test2/");
+  subscription2.type = "circumvention";
+  subscription2.filters = [filter1];
+
+  FilterStorage.addSubscription(subscription2);
+  checkKnownFilters(test, "add subscription of type circumvention with filter1", {snippets: [filter1.text]});
+
+  let subscription3 = Subscription.fromURL("~foo");
+  subscription3.filters = [filter2];
+
+  FilterStorage.addSubscription(subscription3);
+  checkKnownFilters(test, "add special subscription with filter2", {snippets: [filter1.text, filter2.text]});
+
+  test.done();
+};