Issue 5870 - Implement the new ElemHideEmulation filter type

test/filterClasses.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";
 
 let {createSandbox} = require("./_common");
+const {withNAD} = require("./_test-utils");
 
 let Filter = null;
 let InvalidFilter = null;
 let CommentFilter = null;
 let ActiveFilter = null;
 let RegExpFilter = null;
 let BlockingFilter = null;
 let WhitelistFilter = null;
 let ElemHideBase = null;
 let ElemHideFilter = null;
@@ skipping 39 matching lines @@
     ["foobar#asdf", BlockingFilter, "blocking", 1],
     ["foobar|foobas##asdf", BlockingFilter, "blocking", 1],
     ["foobar##asdf{asdf}", ElemHideFilter, "elemhide"],
     ["foobar##", BlockingFilter, "blocking", 1],
     ["foobar#@#", BlockingFilter, "blocking", 1],
     ["asdf$foobar", InvalidFilter, "invalid"],
     ["asdf$image,foobar", InvalidFilter, "invalid"],
     ["asdf$image=foobar", BlockingFilter, "blocking", 1],
     ["asdf$image=foobar=xyz,~collapse", BlockingFilter, "blocking", 0],
 
-    ["##foo[-abp-properties='something']bar", InvalidFilter, "invalid"],
-    ["#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["example.com##foo[-abp-properties='something']bar", ElemHideEmulationFilter, "elemhideemulation"],
-    ["example.com#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["~example.com##foo[-abp-properties='something']bar", InvalidFilter, "invalid"],
-    ["~example.com#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["~example.com,~example.info##foo[-abp-properties='something']bar", InvalidFilter, "invalid"],
-    ["~example.com,~example.info#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["~sub.example.com,example.com##foo[-abp-properties='something']bar", ElemHideEmulationFilter, "elemhideemulation"],
-    ["~sub.example.com,example.com#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["example.com,~sub.example.com##foo[-abp-properties='something']bar", ElemHideEmulationFilter, "elemhideemulation"],
-    ["example.com,~sub.example.com#@#foo[-abp-properties='something']bar", ElemHideException, "elemhideexception"],
-    ["example.com##[-abp-properties='something']", ElemHideEmulationFilter, "elemhideemulation"],
-    ["example.com#@#[-abp-properties='something']", ElemHideException, "elemhideexception"],
-    ["example.com##[-abp-properties=\"something\"]", ElemHideEmulationFilter, "elemhideemulation"],
-    ["example.com#@#[-abp-properties=\"something\"]", ElemHideException, "elemhideexception"],
-    ["example.com##[-abp-properties=(something)]", ElemHideEmulationFilter, "elemhideemulation"],
-    ["example.com#@#[-abp-properties=(something)]", ElemHideException, "elemhideexception"]
+    ["#?#foo:-abp-properties(something)bar", InvalidFilter, "invalid"],
+    ["#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["example.com#?#foo:-abp-properties(something)bar", ElemHideEmulationFilter, "elemhideemulation"],
+    ["example.com#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["~example.com#?#foo:-abp-properties(something)bar", InvalidFilter, "invalid"],
+    ["~example.com#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["~example.com,~example.info#?#foo:-abp-properties(something)bar", InvalidFilter, "invalid"],
+    ["~example.com,~example.info#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["~sub.example.com,example.com#?#foo:-abp-properties(something)bar", ElemHideEmulationFilter, "elemhideemulation"],
+    ["~sub.example.com,example.com#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["example.com,~sub.example.com#?#foo:-abp-properties(something)bar", ElemHideEmulationFilter, "elemhideemulation"],
+    ["example.com,~sub.example.com#@#foo:-abp-properties(something)bar", ElemHideException, "elemhideexception"],
+    ["example.com#?#:-abp-properties(something)", ElemHideEmulationFilter, "elemhideemulation"],
+    ["example.com#@#:-abp-properties(something)", ElemHideException, "elemhideexception"],
+    ["example.com#?#:-abp-properties((something))", ElemHideEmulationFilter, "elemhideemulation"],
+    ["example.com#@#:-abp-properties((something))", ElemHideException, "elemhideexception"]
   ];
   for (let [text, type, typeName, collapse] of tests)
   {
-    let filter = Filter.fromText(text);
-    test.ok(filter instanceof Filter, "Got filter for " + text);
-    test.equal(filter.text, text, "Correct filter text for " + text);
-    test.ok(filter instanceof type, "Correct filter type for " + text);
-    test.equal(filter.type, typeName, "Type name for " + text + " is " + typeName);
-    if (filter instanceof BlockingFilter)
-      test.equal(filter.collapse, collapse);
-    else
-      test.equal(filter.collapse, undefined);
-    if (type == InvalidFilter)
-      test.ok(filter.reason, "Invalid filter " + text + " has a reason set");
-    filter.delete();
+    withNAD(0, filter =>
+    {
+      test.ok(filter instanceof Filter, "Got filter for " + text);
+      test.equal(filter.text, text, "Correct filter text for " + text);
+      test.ok(filter instanceof type, "Correct filter type for " + text);
+      test.equal(filter.type, typeName, "Type name for " + text + " is " + typeName);
+      if (filter instanceof BlockingFilter)
+        test.equal(filter.collapse, collapse);
+      else
+        test.equal(filter.collapse, undefined);
+      if (type == InvalidFilter)
+        test.ok(filter.reason, "Invalid filter " + text + " has a reason set");
+    })(Filter.fromText(text));
   }
+
+  // conversion from old syntax.
+  withNAD(0, filter =>
+  {
+    test.equal(filter.text, "example.com#?#:-abp-properties(something)");
+    test.ok(filter instanceof ElemHideEmulationFilter);
+    test.equal(filter.type, "elemhideemulation");
+  })(Filter.fromText("example.com##[-abp-properties='something']"));
+
   test.done();
 };
 
 exports.testClassHierarchy = function(test)
 {
   let allClasses = [
     Filter, InvalidFilter, CommentFilter, ActiveFilter,
     RegExpFilter, BlockingFilter, WhitelistFilter, ElemHideBase,
     ElemHideFilter, ElemHideException, ElemHideEmulationFilter
   ];
   let tests = [
     ["/asdf??+/", Filter, InvalidFilter],
     ["!asdf", Filter, CommentFilter],
     ["asdf", Filter, ActiveFilter, RegExpFilter, BlockingFilter],
     ["@@asdf", Filter, ActiveFilter, RegExpFilter, WhitelistFilter],
     ["##asdf", Filter, ActiveFilter, ElemHideBase, ElemHideFilter],
     ["#@#asdf", Filter, ActiveFilter, ElemHideBase, ElemHideException],
-    ["example.com##[-abp-properties='something']", Filter, ActiveFilter, ElemHideBase, ElemHideEmulationFilter]
+    ["example.com#?#:-abp-properties(something)", Filter, ActiveFilter, ElemHideBase, ElemHideEmulationFilter]
   ];
 
   for (let list of tests)
   {
     let filter = Filter.fromText(list.shift());
     for (let cls of list)
     {
       test.ok(filter instanceof cls,
           "Testing correct superclass for filter " + filter.text);
     }
@@ skipping 128 matching lines @@
   filter.delete();
 
   test.done();
 };
 
 exports.testInvalidReasons = function(test)
 {
   let tests = [
     ["/??/", "filter_invalid_regexp"],
     ["asd$foobar", "filter_unknown_option"],
-    ["~foo.com##[-abp-properties='abc']", "filter_elemhideemulation_nodomain"]
+    ["~foo.com#?#:-abp-properties(abc)", "filter_elemhideemulation_nodomain"]
   ];
 
   for (let [text, reason] of tests)
   {
     let filter = Filter.fromText(text);
     test.equals(filter.reason, reason, "Reason why filter " + text + " is invalid");
     filter.delete();
   }
 
   test.done();
@@ skipping 74 matching lines @@
     filter.delete();
   }
 
   let tests = [
     ["##foobar", "foobar", ""],
     ["~example.com##foobar", "foobar", ""],
     ["example.com##body > div:first-child", "body > div:first-child", "example.com"],
     ["xYz,~example.com##foobar:not(whatever)", "foobar:not(whatever)", "xyz"],
     ["~xyz,com,~abc.com,example.info##foobar", "foobar", "com,example.info"],
     ["foo,bar,bas,bam##foobar", "foobar", "foo,bar,bas,bam"],
-    ["foo.com##x[-abp-properties='abc']y", "x[-abp-properties='abc']y", "foo.com"],
+    ["foo.com##x:-abp-properties(abc)y", "x:-abp-properties(abc)y", "foo.com"],
 
     // Good idea to test this? Maybe consider behavior undefined in this case.
     ["foo,bar,bas,~bar##foobar", "foobar", "foo,bas"]
   ];
 
   for (let [text, selector, selectorDomain] of tests)
   {
     doTest(text, selector, selectorDomain);
     doTest(text.replace("##", "#@#"), selector, selectorDomain);
   }
 
   test.done();
 };
 
 exports.testElemHideRulesWithBraces = function(test)
 {
-  let filter = Filter.fromText("###foo{color: red}");
-  test.equal(filter.type, "elemhide");
-  test.equal(filter.selector, "#foo\\7B color: red\\7D ");
-  filter.delete();
+  withNAD(0, filter =>
+  {
+    test.equal(filter.type, "elemhide");
+    test.equal(filter.selector, "#foo\\7B color: red\\7D ");
+  })(Filter.fromText("###foo{color: red}"));
 
-  filter = Filter.fromText("foo.com##[-abp-properties='/margin: [3-4]{2}/']");
-  test.equal(filter.type, "elemhideemulation");
-  test.equal(filter.selector, "[-abp-properties='/margin: [3-4]\\7B 2\\7D /']");
-  filter.delete();
+  // Filter conversion to the new syntax dealing with braces too.
+  withNAD(0, filter =>
+  {
+    test.equal(filter.type, "elemhideemulation");
+    test.equal(filter.selector, ":-abp-properties(/margin: [3-4]\\7B 2\\7D /)");
+  })(Filter.fromText("foo.com##[-abp-properties='/margin: [3-4]{2}/']"));
 
   test.done();
 };
 
 exports.testNotifications = function(test)
 {
   function checkNotifications(action, expected, message)
   {
     let result = null;
     let listener = (topic, filter) =>
@@ skipping 41 matching lines @@
     filter.hitCount++;
   }, ["filter.hitCount", "foobar"], "Increasing filter hit counts");
   checkNotifications(() =>
   {
     filter.hitCount = 0;
   }, ["filter.hitCount", "foobar"], "Resetting filter hit counts");
 
   filter.delete();
   test.done();
 };