Issue 5143 - Convert ElemHideEmulation to C++

test/elemHideEmulation.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");
+const {withNAD} = require("./_test-utils");
 
 let ElemHideEmulationFilter = null;
 let ElemHideEmulation = null;
 let ElemHide = null;
 let Filter = null;
 
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox();
   (
     {Filter,
      ElemHideEmulationFilter} = sandboxedRequire("../lib/filterClasses"),
     {ElemHideEmulation} = sandboxedRequire("../lib/elemHideEmulation"),
     {ElemHide} = sandboxedRequire("../lib/elemHide")
   );
 
   callback();
 };
 
-
 exports.testElemHideAPI = function(test)
 {
-  let filter = Filter.fromText("###ads");
-  ElemHide.add(filter);
-
-  test.equal(filter.selectorDomain, "");
-  let unconditionals = ElemHide.getUnconditionalSelectors();
-  test.equal(unconditionals.selectorCount, 1);
-  test.equal(unconditionals.selectorAt(0), "#ads");
-  test.equal(unconditionals.filterKeyAt(0), "###ads");
-
-  let filter2 = Filter.fromText("example.com##.foo");
-  ElemHide.add(filter2);
-  test.equal(filter2.selectorDomain, "example.com");
-
-  unconditionals = ElemHide.getUnconditionalSelectors();
-  test.equal(unconditionals.selectorCount, 1);
-
-  let selectors = ElemHide.getSelectorsForDomain("example.com", 1);
-  test.equal(selectors.selectorCount, 1);
-  test.equal(selectors.selectorAt(0), ".foo");
-  test.equal(selectors.filterKeyAt(0), "example.com##.foo");
-
-  selectors = ElemHide.getSelectorsForDomain("example.com", 0);
-  test.equal(selectors.selectorCount, 2);
-  test.equal(selectors.selectorAt(0), "#ads");
-  test.equal(selectors.filterKeyAt(0), "###ads");
-  test.equal(selectors.selectorAt(1), ".foo");
-  test.equal(selectors.filterKeyAt(1), "example.com##.foo");
-
-  let filter3 = Filter.fromText("example.com##.message");
-  ElemHide.add(filter3);
-  selectors = ElemHide.getSelectorsForDomain("example.com", 0);
-  test.equal(selectors.selectorCount, 3);
-  selectors = ElemHide.getSelectorsForDomain("mail.example.com", 0);
-  test.equal(selectors.selectorCount, 3);
-
-  let filter4 = Filter.fromText("mail.example.com#@#.message");
-  ElemHide.add(filter4);
-  selectors = ElemHide.getSelectorsForDomain("example.com", 0);
-  test.equal(selectors.selectorCount, 3);
-  selectors = ElemHide.getSelectorsForDomain("mail.example.com", 0);
-  test.equal(selectors.selectorCount, 2);
-
-  unconditionals = ElemHide.getUnconditionalSelectors();
-  test.equal(unconditionals.selectorCount, 1);
-
-  ElemHide.remove(filter4);
-  selectors = ElemHide.getSelectorsForDomain("example.com", 0);
-  test.equal(selectors.selectorCount, 3);
-  selectors = ElemHide.getSelectorsForDomain("mail.example.com", 0);
-  test.equal(selectors.selectorCount, 3);
-
-  ElemHide.remove(filter3);
-  selectors = ElemHide.getSelectorsForDomain("example.com", 0);
-  test.equal(selectors.selectorCount, 2);
+  withNAD(0, elemHide =>
+  {
+    withNAD(0, filter =>
+    {
+      elemHide.add(filter);
+      test.equal(filter.selectorDomain, "");
+    })(Filter.fromText("###ads"));
+
+    withNAD(0, unconditionals =>
+    {
+      test.equal(unconditionals.selectorCount, 1);
+      test.equal(unconditionals.selectorAt(0), "#ads");
+      test.equal(unconditionals.filterKeyAt(0), "###ads");
+    })(elemHide.getUnconditionalSelectors());
+
+    withNAD(0, filter =>
+    {
+      elemHide.add(filter);
+      test.equal(filter.selectorDomain, "example.com");
+    })(Filter.fromText("example.com##.foo"));
+
+    withNAD(
+      0, unconditionals =>
+        test.equal(unconditionals.selectorCount, 1))(elemHide.getUnconditionalSelectors());
+
+    withNAD(0, selectors =>
+    {
+      test.equal(selectors.selectorCount, 1);
+      test.equal(selectors.selectorAt(0), ".foo");
+      test.equal(selectors.filterKeyAt(0), "example.com##.foo");
+    })(elemHide.getSelectorsForDomain("example.com", 1));
+
+    withNAD(0, selectors =>
+    {
+      test.equal(selectors.selectorCount, 2);
+      test.equal(selectors.selectorAt(0), "#ads");
+      test.equal(selectors.filterKeyAt(0), "###ads");
+      test.equal(selectors.selectorAt(1), ".foo");
+      test.equal(selectors.filterKeyAt(1), "example.com##.foo");
+    })(elemHide.getSelectorsForDomain("example.com", 0));
+
+    withNAD(0, filter3 =>
+    {
+      elemHide.add(filter3);
+
+      withNAD(
+        0, selectors =>
+          test.equal(selectors.selectorCount, 3))(
+        elemHide.getSelectorsForDomain("example.com", 0));
+
+      withNAD(
+        0, selectors =>
+          test.equal(selectors.selectorCount, 3))(
+        elemHide.getSelectorsForDomain("mail.example.com", 0));
+
+      withNAD(0, filter4 =>
+      {
+        elemHide.add(filter4);
+        withNAD(
+          0, selectors =>
+            test.equal(selectors.selectorCount, 3))(
+          elemHide.getSelectorsForDomain("example.com", 0));
+
+        withNAD(
+          0, selectors =>
+            test.equal(selectors.selectorCount, 2))(
+          elemHide.getSelectorsForDomain("mail.example.com", 0));
+
+        withNAD(
+          0,
+          unconditionals =>
+            test.equal(unconditionals.selectorCount, 1))(elemHide.getUnconditionalSelectors());
+
+        elemHide.remove(filter4);
+      })(Filter.fromText("mail.example.com#@#.message"));
+
+      withNAD(
+        0, selectors =>
+          test.equal(selectors.selectorCount, 3))(
+        elemHide.getSelectorsForDomain("example.com", 0));
+
+      withNAD(
+        0, selectors =>
+          test.equal(selectors.selectorCount, 3))(
+        elemHide.getSelectorsForDomain("mail.example.com", 0));
+
+      elemHide.remove(filter3);
+    })(Filter.fromText("example.com##.message"));
+
+    withNAD(
+      0, selectors =>
+        test.equal(selectors.selectorCount, 2))(
+      elemHide.getSelectorsForDomain("example.com", 0));
+  })(ElemHide.create());
 
   test.done();
 };
 
 exports.testDomainRestrictions = function(test)
 {
   function testSelectorMatches(description, filters, domain, expectedMatches)
   {
-    for (let text of filters)
-    {
-      let filter = Filter.fromText(text);
-      if (filter instanceof ElemHideEmulationFilter)
-        ElemHideEmulation.add(filter);
-      else
-        ElemHide.add(filter);
-    }
-
-    let rules = ElemHideEmulation.getRulesForDomain(domain);
-    let matches = [];
-    for (let i = 0; i < rules.filterCount; i++)
-      matches.push(rules.filterAt(i).text);
-    test.deepEqual(matches.sort(), expectedMatches.sort(), description);
-
-    ElemHideEmulation.clear();
-    ElemHide.clear();
+    withNAD([0, 1], (elemHide, elemHideEmulation) =>
+    {
+      let addFilter = withNAD(0, filter =>
+      {
+        if (filter instanceof ElemHideEmulationFilter)
+          elemHideEmulation.add(filter);
+        else
+          elemHide.add(filter);
+      });
+
+      for (let text of filters)
+        addFilter(Filter.fromText(text));
+
+      withNAD(0, rules =>
+      {
+        let matches = [];
+        let push = withNAD(0, filter => matches.push(filter.text));
+
+        for (let i = 0; i < rules.filterCount; i++)
+          push(rules.filterAt(i));
+
+        test.deepEqual(matches.sort(), expectedMatches.sort(), description);
+      })(elemHideEmulation.getRulesForDomain(elemHide, domain));
+
+      elemHideEmulation.clear();
+    })(ElemHide.create(), ElemHideEmulation.create());
   }
 
   testSelectorMatches(
     "Ignore generic filters",
     [
       "##[-abp-properties='foo']", "example.com##[-abp-properties='foo']",
       "~example.com##[-abp-properties='foo']"
     ],
     "example.com",
     ["example.com##[-abp-properties='foo']"]
@@ skipping 33 matching lines @@
     ],
     "other.example.com",
     ["other.example.com##[-abp-properties='foo']"]
   );
 
   test.done();
 };
 
 exports.testElemHideEmulationFiltersContainer = function(test)
 {
-  function compareRules(description, domain, expectedMatches)
+  withNAD([0, 1], (elemHide, elemHideEmulation) =>
   {
-    let rules = ElemHideEmulation.getRulesForDomain(domain);

[sergei, 2017/11/16 09:58:07]

What about returning a generator object from ElemHideEmulation.getRulesForDomain
(similar to
https://github.com/adblockplus/adblockpluscore/blob/emscripten/lib/filterStor...

BTW, one should call `delete` on the result of `rules.filterAt(i)` and on
`rules`.

[hub, 2017/11/20 19:16:01]

delete on the result of `rules.filterAt(i)` is an error with the current
implementation. I'll change filterAt() to match FilterStorage.

I am not convinced on having that iterator / generator since it involve writing
JS code.

-    let result = [];
-    for (let i = 0; i < rules.filterCount; i++)
-      result.push(rules.filterAt(i).text);
-    expectedMatches = expectedMatches.map(filter => filter.text);
-    test.deepEqual(result.sort(), expectedMatches.sort(), description);
-  }
-
-  let domainFilter = Filter.fromText("example.com##filter1");
-  let subdomainFilter = Filter.fromText("www.example.com##filter2");
-  let otherDomainFilter = Filter.fromText("other.example.com##filter3");
-
-  ElemHideEmulation.add(domainFilter);
-  ElemHideEmulation.add(subdomainFilter);
-  ElemHideEmulation.add(otherDomainFilter);
-  compareRules(
-    "Return all matching filters",
-    "www.example.com",
-    [domainFilter, subdomainFilter]
-  );
-
-  ElemHideEmulation.remove(domainFilter);
-  compareRules(
-    "Return all matching filters after removing one",
-    "www.example.com",
-    [subdomainFilter]
-  );
-
-  ElemHideEmulation.clear();
-  compareRules(
-    "Return no filters after clearing",
-    "www.example.com",
-    []
-  );
+    function compareRules(description, domain, expectedMatches)
+    {
+      withNAD(0, rules =>
+      {
+        let result = [];
+        for (let i = 0; i < rules.filterCount; i++)
+          withNAD(0, filter => result.push(filter.text))(rules.filterAt(i));
+
+        expectedMatches = expectedMatches.map(filter => filter.text);
+        test.deepEqual(result.sort(), expectedMatches.sort(), description);
+      })(elemHideEmulation.getRulesForDomain(elemHide, domain));
+    }
+
+    withNAD([0, 1, 2], (domainFilter, subdomainFilter, otherDomainFilter) =>
+    {
+      elemHideEmulation.add(domainFilter);
+      elemHideEmulation.add(subdomainFilter);
+      elemHideEmulation.add(otherDomainFilter);
+      compareRules(
+        "Return all matching filters",
+        "www.example.com",
+        [domainFilter, subdomainFilter]
+      );
+
+      elemHideEmulation.remove(domainFilter);
+      compareRules(
+        "Return all matching filters after removing one",
+        "www.example.com",
+        [subdomainFilter]
+      );
+
+      elemHideEmulation.clear();
+      compareRules(
+        "Return no filters after clearing",
+        "www.example.com",
+        []
+      );
+    })(Filter.fromText("example.com##filter1"),
+       Filter.fromText("www.example.com##filter2"),
+       Filter.fromText("other.example.com##filter3"));
+  })(ElemHide.create(), ElemHideEmulation.create());
 
   test.done();
 };