Issue 7452 - Do not cache element hiding filter objects by default

test/elemHide.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
@@ skipping 17 matching lines @@
 let selectorGroupSize = null;
 
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox({
     extraExports: {
       elemHide: ["filterTextByDomain", "selectorGroupSize"]
     }
   });
   (
-    {ElemHide, createStyleSheet, rulesFromStyleSheet, filterTextByDomain,
-     selectorGroupSize} = sandboxedRequire("../lib/elemHide"),
+    {ElemHide, createStyleSheet, rulesFromStyleSheet,
+     filterTextByDomain, selectorGroupSize} = sandboxedRequire("../lib/elemHide"),
     {ElemHideExceptions} = sandboxedRequire("../lib/elemHideExceptions"),
     {Filter} = sandboxedRequire("../lib/filterClasses")
   );
 
   callback();
 };
 
 function normalizeSelectors(selectors)
 {
   // generateStyleSheetForDomain is currently allowed to return duplicate
   // selectors for performance reasons, so we need to remove duplicates here.
   return selectors.slice().sort().filter((selector, index, sortedSelectors) =>
   {
     return index == 0 || selector != sortedSelectors[index - 1];
   });
 }
 
-function testResult(test, domain, expectedSelectors, specificOnly)
+function testResult(test, domain, expectedSelectors,
+                    {specificOnly = false, expectedExceptions = []} = {})
 {
   let normalizedExpectedSelectors = normalizeSelectors(expectedSelectors);
 
-  let {code, selectors} =
-    ElemHide.generateStyleSheetForDomain(domain, specificOnly, true);
+  let {code, selectors, exceptions} =
+    ElemHide.generateStyleSheetForDomain(domain, specificOnly, true, true);
 
   test.deepEqual(normalizeSelectors(selectors), normalizedExpectedSelectors);
+
+  // Test for consistency in exception free case.
+  test.deepEqual(ElemHide.generateStyleSheetForDomain(
+    domain, specificOnly, true, false), {
+      code,
+      selectors,
+      exceptions: null
+    });
+
+  test.deepEqual(exceptions.map(({text}) => text), expectedExceptions);
 
   // Make sure each expected selector is in the actual CSS code.
   for (let selector of normalizedExpectedSelectors)
   {
     test.ok(code.includes(selector + ", ") ||
             code.includes(selector + " {display: none !important;}\n"));
   }
 }
 
 exports.testGenerateStyleSheetForDomain = function(test)
@@ skipping 16 matching lines @@
   testResult(test, "", []);
 
   addFilter("foo.example.com##turnip");
   testResult(test, "foo.example.com", ["turnip"]);
   testResult(test, "example.com", ["foo"]);
   testResult(test, "com", []);
   testResult(test, "", []);
 
   addException("example.com#@#foo");
   testResult(test, "foo.example.com", ["turnip"]);
-  testResult(test, "example.com", []);
+  testResult(test, "example.com", [], {
+    expectedExceptions: ["example.com#@#foo"]
+  });
   testResult(test, "com", []);
   testResult(test, "", []);
 
   addFilter("com##bar");
   testResult(test, "foo.example.com", ["turnip", "bar"]);
-  testResult(test, "example.com", ["bar"]);
+  testResult(test, "example.com", ["bar"], {
+    expectedExceptions: ["example.com#@#foo"]
+  });
   testResult(test, "com", ["bar"]);
   testResult(test, "", []);
 
   addException("example.com#@#bar");
-  testResult(test, "foo.example.com", ["turnip"]);
-  testResult(test, "example.com", []);
+  testResult(test, "foo.example.com", ["turnip"], {
+    expectedExceptions: ["example.com#@#bar"]
+  });
+  testResult(test, "example.com", [], {
+    expectedExceptions: ["example.com#@#foo", "example.com#@#bar"]
+  });
   testResult(test, "com", ["bar"]);
   testResult(test, "", []);
 
   removeException("example.com#@#foo");
-  testResult(test, "foo.example.com", ["turnip"]);
-  testResult(test, "example.com", ["foo"]);
+  testResult(test, "foo.example.com", ["turnip"], {
+    expectedExceptions: ["example.com#@#bar"]
+  });
+  testResult(test, "example.com", ["foo"], {
+    expectedExceptions: ["example.com#@#bar"]
+  });
   testResult(test, "com", ["bar"]);
   testResult(test, "", []);
 
   removeException("example.com#@#bar");
   testResult(test, "foo.example.com", ["turnip", "bar"]);
   testResult(test, "example.com", ["foo", "bar"]);
   testResult(test, "com", ["bar"]);
   testResult(test, "", []);
 
   addFilter("##generic");
   testResult(test, "foo.example.com", ["turnip", "bar", "generic"]);
   testResult(test, "example.com", ["foo", "bar", "generic"]);
   testResult(test, "com", ["bar", "generic"]);
   testResult(test, "", ["generic"]);
-  testResult(test, "foo.example.com", ["turnip", "bar"], true);
-  testResult(test, "example.com", ["foo", "bar"], true);
-  testResult(test, "com", ["bar"], true);
-  testResult(test, "", [], true);
+  testResult(test, "foo.example.com", ["turnip", "bar"], {specificOnly: true});
+  testResult(test, "example.com", ["foo", "bar"], {specificOnly: true});
+  testResult(test, "com", ["bar"], {specificOnly: true});
+  testResult(test, "", [], {specificOnly: true});
   removeFilter("##generic");
 
   addFilter("~adblockplus.org##example");
   testResult(test, "adblockplus.org", []);
   testResult(test, "", ["example"]);
   testResult(test, "foo.example.com", ["turnip", "bar", "example"]);
-  testResult(test, "foo.example.com", ["turnip", "bar"], true);
+  testResult(test, "foo.example.com", ["turnip", "bar"], {specificOnly: true});
   removeFilter("~adblockplus.org##example");
 
   removeFilter("~foo.example.com,example.com##foo");
   testResult(test, "foo.example.com", ["turnip", "bar"]);
   testResult(test, "example.com", ["bar"]);
   testResult(test, "com", ["bar"]);
   testResult(test, "", []);
 
   removeFilter("com##bar");
   testResult(test, "foo.example.com", ["turnip"]);
@@ skipping 36 matching lines @@
   testResult(test, "com", ["foo"]);
   testResult(test, "", ["foo"]);
   removeFilter("~example.com##foo");
 
   removeFilter("~foo.example.com,example.com##foo");
 
   // Test criteria
   addFilter("##hello");
   addFilter("~example.com##world");
   addFilter("foo.com##specific");
-  testResult(test, "foo.com", ["specific"], true);
-  testResult(test, "foo.com", ["hello", "specific", "world"], false);
+  testResult(test, "foo.com", ["specific"], {specificOnly: true});
   testResult(test, "foo.com", ["hello", "specific", "world"]);
-  testResult(test, "foo.com.", ["hello", "specific", "world"]);
-  testResult(test, "example.com", [], true);
+  testResult(test, "example.com", [], {specificOnly: true});
   removeFilter("foo.com##specific");
   removeFilter("~example.com##world");
   removeFilter("##hello");
   testResult(test, "foo.com", []);
 
   addFilter("##hello");
-  testResult(test, "foo.com", [], true);
-  testResult(test, "foo.com", ["hello"], false);
-  testResult(test, "foo.com", ["hello"]);
-  testResult(test, "bar.com", [], true);
-  testResult(test, "bar.com", ["hello"], false);
+  testResult(test, "foo.com", [], {specificOnly: true});
+  testResult(test, "foo.com", ["hello"]);
+  testResult(test, "bar.com", [], {specificOnly: true});
   testResult(test, "bar.com", ["hello"]);
   addException("foo.com#@#hello");
-  testResult(test, "foo.com", [], true);
-  testResult(test, "foo.com", [], false);
-  testResult(test, "foo.com", []);
-  testResult(test, "bar.com", [], true);
-  testResult(test, "bar.com", ["hello"], false);
+  testResult(test, "foo.com", [], {specificOnly: true});
+  testResult(test, "foo.com", [], {expectedExceptions: ["foo.com#@#hello"]});
+  testResult(test, "bar.com", [], {specificOnly: true});
   testResult(test, "bar.com", ["hello"]);
   removeException("foo.com#@#hello");
-  testResult(test, "foo.com", [], true);
+  testResult(test, "foo.com", [], {specificOnly: true});
   // Note: We don't take care to track conditional selectors which became
   //       unconditional when a filter was removed. This was too expensive.
-  testResult(test, "foo.com", ["hello"], false);
-  testResult(test, "foo.com", ["hello"]);
-  testResult(test, "bar.com", [], true);
-  testResult(test, "bar.com", ["hello"], false);
+  testResult(test, "foo.com", ["hello"]);
+  testResult(test, "bar.com", [], {specificOnly: true});
   testResult(test, "bar.com", ["hello"]);
   removeFilter("##hello");
   testResult(test, "foo.com", []);
   testResult(test, "bar.com", []);
 
   addFilter("##hello");
   addFilter("foo.com##hello");
   testResult(test, "foo.com", ["hello"]);
   removeFilter("foo.com##hello");
   testResult(test, "foo.com", ["hello"]);
   removeFilter("##hello");
   testResult(test, "foo.com", []);
 
   addFilter("##hello");
   addFilter("foo.com##hello");
   testResult(test, "foo.com", ["hello"]);
   removeFilter("##hello");
   testResult(test, "foo.com", ["hello"]);
   removeFilter("foo.com##hello");
   testResult(test, "foo.com", []);
 
   test.done();
 };
 
 exports.testZeroFilterKey = function(test)
 {
   ElemHide.add(Filter.fromText("##test"));
   ElemHideExceptions.add(Filter.fromText("foo.com#@#test"));
-  testResult(test, "foo.com", []);
+  testResult(test, "foo.com", [], {expectedExceptions: ["foo.com#@#test"]});
   testResult(test, "bar.com", ["test"]);
   test.done();
 };
 
 exports.testFiltersByDomain = function(test)
 {
   test.equal(filterTextByDomain.size, 0);
 
   ElemHide.add(Filter.fromText("##test"));
   test.equal(filterTextByDomain.size, 0);
@@ skipping 18 matching lines @@
   test.equal(
     createStyleSheet([
       "html", "#foo", ".bar", "#foo .bar", "#foo > .bar",
       "#foo[data-bar='bar']"
     ]),
     "html, #foo, .bar, #foo .bar, #foo > .bar, #foo[data-bar='bar'] " +
     "{display: none !important;}\n",
     "Style sheet creation should work"
   );
 
-  let selectors = new Array(50000).map((element, index) => ".s" + index);
+  let selectors = new Array(50000).fill().map((element, index) => ".s" + index);
 
   test.equal((createStyleSheet(selectors).match(/\n/g) || []).length,
              Math.ceil(50000 / selectorGroupSize),
              "Style sheet should be split up into rules with at most " +
              selectorGroupSize + " selectors each");
 
+  test.equal(
+    createStyleSheet([
+      "html", "#foo", ".bar", "#foo .bar", "#foo > .bar",
+      "#foo[data-bar='{foo: 1}']"
+    ]),
+    "html, #foo, .bar, #foo .bar, #foo > .bar, " +
+    "#foo[data-bar='\\7B foo: 1\\7D '] {display: none !important;}\n",
+    "Braces should be escaped"
+  );
+
   test.done();
 };
 
 exports.testRulesFromStyleSheet = function(test)
 {
   // Note: The rulesFromStyleSheet function assumes that each rule will be
   // terminated with a newline character, including the last rule. If this is
   // not the case, the function goes into an infinite loop. It should only be
   // used with the return value of the createStyleSheet function.
 
   test.deepEqual([...rulesFromStyleSheet("")], []);
   test.deepEqual([...rulesFromStyleSheet("#foo {}\n")], ["#foo {}"]);
   test.deepEqual([...rulesFromStyleSheet("#foo {}\n#bar {}\n")],
                  ["#foo {}", "#bar {}"]);
 
   test.done();
 };