Issue 3143 - Filter elements with :-abp-has()

test/browser/elemHideEmulation.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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";
 
-/* globals ElemHideEmulation, pseudoClassHasSelectorRegExp, splitSelector,
-   parsePattern, PseudoHasMatcher */
+/* globals ElemHideEmulation, splitSelector,
+   parseSelectorContent,
+   parseSelector, positionInParent, makeSelector,
+   PlainSelector, HasSelector, PropsSelector */
 
 let myUrl = document.currentScript.src;
 
 exports.tearDown = function(callback)
 {
   let styleElements = document.head.getElementsByTagName("style");
   while (styleElements.length)
     styleElements[0].parentNode.removeChild(styleElements[0]);
 
   let child;
   while (child = document.body.firstChild)
-    document.body.removeChild(child);
+    child.parentNode.removeChild(child);
 
   callback();
 };
 
 function unexpectedError(error)
 {
   console.error(error);
   this.ok(false, "Unexpected error: " + error);
 }
 
@@ skipping 24 matching lines @@
   if (styleElements.length)
     styleElement = styleElements[0];
   else
   {
     styleElement = document.createElement("style");
     document.head.appendChild(styleElement);
   }
   styleElement.sheet.insertRule(rule, styleElement.sheet.cssRules.length);
 }
 
-// insert a <div> with a unique id and and empty CSS rule
+// insert a <div> with a unique id and a CSS rule
 // for the the selector matching the id.
 function createElementWithStyle(styleBlock, parent)
 {
   let element = document.createElement("div");
   element.id = findUniqueId();
   if (!parent)
     document.body.appendChild(element);
   else
     parent.appendChild(element);
   insertStyleRule("#" + element.id + " " + styleBlock);
   return element;
 }
 
-// Will ensure the class ElemHideEmulation is loaded
-// and then will call the callback.
-// NOTE: if it never loads, this will probably hang in an infinite
-// loop
+// Will ensure the class ElemHideEmulation is loaded.
+// NOTE: if it never loads, this will probably hang.
 function loadElemHideEmulation()
 {
   if (typeof ElemHideEmulation == "undefined")
   {
     return loadScript(myUrl + "/../../../lib/common.js").then(() =>
     {
       return loadScript(myUrl + "/../../../chrome/content/elemHideEmulation.js");
     }).then(() =>
     {
       return loadElemHideEmulation();
     });
   }
 
   return Promise.resolve();
 }
 
-// instantiate a ElemHideEmulation with @selectors.
+// Create a new ElemHideEmulation instance with @selectors.
 function applyElemHideEmulation(selectors)
 {
   return loadElemHideEmulation().then(() =>
   {
     let elemHideEmulation = new ElemHideEmulation(
       window,
       callback =>
       {
         let patterns = [];
         selectors.forEach(selector =>
         {
           patterns.push({selector});
         });
         callback(patterns);
       },
       newSelectors =>
       {
         if (!newSelectors.length)
           return;
         let selector = newSelectors.join(", ");
         insertStyleRule(selector + "{display: none !important;}");
       },
-      elements =>
+      elems =>
       {
-        if (!elements.length)
-          return;
-        for (let element of elements)
-          element.style.display = "none";
+        for (let elem of elems)
+          elem.style.display = "none";
       }
     );
 
     elemHideEmulation.apply();
-    return Promise.resolve();
+    return Promise.resolve(elemHideEmulation);
   });
 }
 
-exports.testPseudoHasRule = function(test)
-{
-  loadElemHideEmulation().then(() =>
-  {
-    let selector = "div:-abp-has(span)";
-    // testing the regexp
-    let match = pseudoClassHasSelectorRegExp.exec(selector);
-    test.ok(match);
-    test.equal(match[1], "span");
-
-    selector = ":-abp-has(div.inside)";
-    match = pseudoClassHasSelectorRegExp.exec(selector);
-    test.ok(match);
-    test.equal(match[1], "div.inside");
+// internals testing
+
+exports.testParseSelectorContent = function(test)
+{
+  loadElemHideEmulation().then(() =>
+  {
+    let parsed = parseSelectorContent(":-abp-has(> div) > div", 10);
+    test.equal(parsed.text, "> div");
+    test.equal(parsed.end, 15);
+
+    parsed = parseSelectorContent("> div) > div", 0);
+    test.equal(parsed.text, "> div");
+    test.equal(parsed.end, 5);
+
+    // parens not closed.
+    parsed = parseSelectorContent("> div > div", 0);
+    test.equal(parsed, null);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testParseSelector = function(test)
+{
+  loadElemHideEmulation().then(() =>
+  {
+    let selectors = parseSelector("");
+    test.equal(selectors.length, 0);
+
+    let selector = "div > :-abp-properties('background-color: rgb(0, 0, 0)')";
+    selectors = parseSelector(selector);
+    test.equal(selectors.length, 2);
+    test.ok(selectors[0] instanceof PlainSelector);
+    test.ok(selectors[1] instanceof PropsSelector);
+
+    selector = "div > :-abp-has(> div.inside) > div";
+    selectors = parseSelector(selector);
+    test.equal(selectors.length, 3);
+    test.ok(selectors[0] instanceof PlainSelector);
+    test.ok(selectors[1] instanceof HasSelector);
+    test.ok(selectors[2] instanceof PlainSelector);
+
+    selector = "div > div:-abp-has(> div.inside) > div";
+    selectors = parseSelector(selector);
+
+    test.equal(selectors.length, 3);
+    test.ok(selectors[0] instanceof PlainSelector);
+    test.ok(selectors[1] instanceof HasSelector);
+    test.ok(selectors[2] instanceof PlainSelector);
+
+    selector = "div > :-abp-has(> div.inside) > :-abp-properties(background-color: rgb(0, 0, 0))";
+    selectors = parseSelector(selector);
+
+    test.equal(selectors.length, 4);
+    test.ok(selectors[0] instanceof PlainSelector);
+    test.ok(selectors[1] instanceof HasSelector);
+    test.ok(selectors[2] instanceof PlainSelector);
+    test.ok(selectors[3] instanceof PropsSelector);
+
+    selector = "div > :-abp-has(> div.inside > :-abp-properties(background-color: rgb(0, 0, 0))";
+    selectors = parseSelector(selector);
+    test.equal(selectors, null);
+
+    // -abp-has-unsupported() is unknown. Ensure we fail parsing.
+    selector = 'div[arial-label="Story"]:-abp-has(> div > div > span > span:-abp-unsupported("Suggested Post"))';
+    selectors = parseSelector(selector);
+    test.equal(selectors, null);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+function buildDom(doc)
+{
+  doc.body.innerHTML = `<div id="parent">
+    <div id="middle">
+      <div id="middle1"><div id="inside" class="inside"></div></div>
+    </div>
+    <div id="sibling">
+      <div id="tohide">to hide</div>
+    </div>
+    <div id="sibling2">
+      <div id="sibling21"><div id="sibling211" class="inside"></div></div>
+    </div>
+  </div>`;
+  let parent = document.getElementById("parent");
+  let middle = document.getElementById("middle");
+  let middle1 = document.getElementById("middle1");
+  let inside = document.getElementById("inside");
+  let sibling = document.getElementById("sibling");
+  let sibling2 = document.getElementById("sibling2");
+  let toHide = document.getElementById("tohide");
+  return {parent, middle, middle1, inside, sibling, sibling2, toHide};
+}
+
+exports.testPositionInParent = function(test)
+{
+  let nodes = buildDom(document);
+
+  loadElemHideEmulation().then(() =>
+  {
+    test.equal(positionInParent(nodes.middle1), 1);
+    test.equal(positionInParent(nodes.inside), 1);
+    test.equal(positionInParent(nodes.sibling2), 3);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testMakeSelector = function(test)
+{
+  let nodes = buildDom(document);
+
+  loadElemHideEmulation().then(() =>
+  {
+    test.equal(makeSelector(nodes.middle, ""),
+               ":root > BODY:nth-child(2) > DIV:nth-child(1) > DIV:nth-child(1)");
+    test.equal(makeSelector(nodes.toHide, ""),
+               ":root > BODY:nth-child(2) > DIV:nth-child(1) > DIV:nth-child(2) > DIV:nth-child(1)");
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testPlainSelector = function(test)
+{
+  buildDom(document);
+
+  loadElemHideEmulation().then(() =>
+  {
+    let selector = new PlainSelector("div > div");
+
+    let iter = selector.getSelectors("foo > ");
+    let value = iter.next();
+    test.equal(value.value[0], "foo > div > div");
+    test.ok(iter.next().done);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testHasSelector = function(test)
+{
+  buildDom(document);
+
+  loadElemHideEmulation().then(() =>
+  {
+    let selector = new HasSelector("> div.inside");
+
+    let iter = selector.getSelectors("", document, document.sheet);
+    let value = iter.next();
+    test.ok(!value.done);
+    test.equal(value.value[0],
+               ":root > BODY:nth-child(2) > DIV:nth-child(1) > DIV:nth-child(1) > DIV:nth-child(1)");
+
+    iter = selector.getElements("", document, document.sheet);
+    value = iter.next();
+    test.ok(!value.done);
+    test.equal(value.value.id, "middle1");
+    value = iter.next();
+    test.ok(!value.done);
+    test.equal(value.value.id, "sibling21");
+    value = iter.next();
+    test.ok(value.done);
+
+    selector = new HasSelector(":-abp-has(> div.inside)");
+
+    test.ok(selector._innerSelectors);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testSplitStyleRule = function(test)
 {
   loadElemHideEmulation().then(() =>
   {
     let selectors = splitSelector("div:-abp-has(div) > [-abp-properties='background-color: rgb(0, 0, 0)'] > span");
     test.ok(selectors);
     test.equal(selectors.length, 1, "There is only one selector");
 
     selectors = splitSelector("div:-abp-has(div), [-abp-properties='background-color: rgb(0, 0, 0)']");
     test.ok(selectors);
     test.equal(selectors.length, 2, "There are two selectors");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
-exports.testParsePattern = function(test)
-{
-  loadElemHideEmulation().then(() =>
-  {
-    let pattern = parsePattern({selector: "[-abp-properties='background-color: rgb(0, 0, 0)']"});
-    test.ok(pattern);
-    test.equal(pattern.type, "props");
-    pattern = parsePattern({selector: "[-abp-properties='background-color: rgb(0, 0, 0)']"});
-    test.ok(pattern);
-    test.equal(pattern.type, "props");
-
-    pattern = parsePattern({selector: ":-abp-has(div)"});
-    test.ok(pattern);
-    test.equal(pattern.type, "has");
-
-    pattern = parsePattern({selector: ":-abp-properties('background-color: rgb(0, 0, 0)')"});
-    test.ok(pattern);
-    test.equal(pattern.type, "props");
-  }).catch(unexpectedError.bind(test)).then(() => test.done());
-};
-
-function runTestVerbatimPropertySelector(test, selector)
+// API testing
+
+exports.testVerbatimPropertySelector = function(test)
 {
   let toHide = createElementWithStyle("{background-color: #000}");
   applyElemHideEmulation(
-    [selector]
-  ).then(() =>
-  {
-    expectHidden(test, toHide);
-  }).catch(unexpectedError.bind(test)).then(() => test.done());
-}
-
-exports.testVerbatimPropertySelector = function(test)
-{
-  runTestVerbatimPropertySelector(test, "[-abp-properties='background-color: rgb(0, 0, 0)']");
-};
-
-/* Testing the new syntax */
-exports.testVerbatimPropertyPseudoSelector = function(test)
-{
-  runTestVerbatimPropertySelector(test, ":-abp-properties('background-color: rgb(0, 0, 0)')");
-};
-
-function runTestVerbatimPropertySelectorWithPrefix(test, selector)
+    [":-abp-properties(background-color: rgb(0, 0, 0))"]
+  ).then(() =>
+  {
+    expectHidden(test, toHide);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testVerbatimPropertySelectorWithPrefix = function(test)
 {
   let parent = createElementWithStyle("{background-color: #000}");
   let toHide = createElementWithStyle("{background-color: #000}", parent);
   applyElemHideEmulation(
-    [selector]
-  ).then(() =>
-  {
-    expectVisible(test, parent);
-    expectHidden(test, toHide);
-  }).catch(unexpectedError.bind(test)).then(() => test.done());
-}
-
-exports.testVerbatimPropertySelectorWithPrefix = function(test)
-{
-  runTestVerbatimPropertySelectorWithPrefix(test, "div > [-abp-properties='background-color: rgb(0, 0, 0)']");
-};
-
-// testing the new syntax
-exports.testVerbatimPropertyPseudoSelectorWithPrefix = function(test)
-{
-  runTestVerbatimPropertySelectorWithPrefix(test, "div > :-abp-properties('background-color: rgb(0, 0, 0)')");
+    ["div > :-abp-properties(background-color: rgb(0, 0, 0))"]
+  ).then(() =>
+  {
+    expectVisible(test, parent);
+    expectHidden(test, toHide);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testVerbatimPropertySelectorWithPrefixNoMatch = function(test)
 {
   let parent = createElementWithStyle("{background-color: #000}");
   let toHide = createElementWithStyle("{background-color: #fff}", parent);
   applyElemHideEmulation(
-    ["div > [-abp-properties='background-color: rgb(0, 0, 0)']"]
+    ["div > :-abp-properties(background-color: rgb(0, 0, 0))"]
   ).then(() =>
   {
     expectVisible(test, parent);
     expectVisible(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
-function runTestVerbatimPropertySelectorWithSuffix(test, selector)
+exports.testVerbatimPropertySelectorWithSuffix = function(test)
 {
   let parent = createElementWithStyle("{background-color: #000}");
   let toHide = createElementWithStyle("{background-color: #000}", parent);
   applyElemHideEmulation(
-    [selector]
-  ).then(() =>
-  {
-    expectVisible(test, parent);
-    expectHidden(test, toHide);
-  }).catch(unexpectedError.bind(test)).then(() => test.done());
-}
-
-exports.testVerbatimPropertySelectorWithSuffix = function(test)
-{
-  runTestVerbatimPropertySelectorWithSuffix(test, "[-abp-properties='background-color: rgb(0, 0, 0)'] > div");
-};
-
-exports.testVerbatimPropertyPseudoSelectorWithSuffix = function(test)
-{
-  runTestVerbatimPropertySelectorWithSuffix(test, ":-abp-properties('background-color: rgb(0, 0, 0)') > div");
-};
-
-function runTestVerbatimPropertySelectorWithPrefixAndSuffix(test, selector)
+    [":-abp-properties(background-color: rgb(0, 0, 0)) > div"]
+  ).then(() =>
+  {
+    expectVisible(test, parent);
+    expectHidden(test, toHide);
+  }).catch(unexpectedError.bind(test)).then(() => test.done());
+};
+
+exports.testVerbatimPropertyPseudoSelectorWithPrefixAndSuffix = function(test)
 {
   let parent = createElementWithStyle("{background-color: #000}");
   let middle = createElementWithStyle("{background-color: #000}", parent);
   let toHide = createElementWithStyle("{background-color: #000}", middle);
   applyElemHideEmulation(
-    [selector]
+    ["div > :-abp-properties(background-color: rgb(0, 0, 0)) > div"]
   ).then(() =>
   {
     expectVisible(test, parent);
     expectVisible(test, middle);
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
-}
-
-exports.testVerbatimPropertySelectorWithPrefixAndSuffix = function(test)
-{
-  runTestVerbatimPropertySelectorWithPrefixAndSuffix(test, "div > [-abp-properties='background-color: rgb(0, 0, 0)'] > div");
-};
-
-exports.testVerbatimPropertyPseudoSelectorWithPrefixAndSuffix = function(test)
-{
-  runTestVerbatimPropertySelectorWithPrefixAndSuffix(test, "div > :-abp-properties('background-color: rgb(0, 0, 0)') > div");
 };
 
 exports.testPropertySelectorWithWildcard = function(test)
 {
   let toHide = createElementWithStyle("{background-color: #000}");
   applyElemHideEmulation(
-    ["[-abp-properties='*color: rgb(0, 0, 0)']"]
+    [":-abp-properties(*color: rgb(0, 0, 0))"]
   ).then(() =>
   {
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testPropertySelectorWithRegularExpression = function(test)
 {
   let toHide = createElementWithStyle("{background-color: #000}");
   applyElemHideEmulation(
-    ["[-abp-properties='/.*color: rgb\\(0, 0, 0\\)/']"]
+    [":-abp-properties(/.*color: rgb\\(0, 0, 0\\)/)"]
   ).then(() =>
   {
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testPropertySelectorWithEscapedBrace = function(test)
 {
   let toHide = createElementWithStyle("{background-color: #000}");
   applyElemHideEmulation(
-    ["[-abp-properties='/background.\\x7B 0,6\\x7D : rgb\\(0, 0, 0\\)/']"]
+    [":-abp-properties(/background.\\x7B 0,6\\x7D : rgb\\(0, 0, 0\\)/)"]
   ).then(() =>
   {
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testPropertySelectorWithImproperlyEscapedBrace = function(test)
 {
   let toHide = createElementWithStyle("{background-color: #000}");
   applyElemHideEmulation(
-    ["[-abp-properties='/background.\\x7B0,6\\x7D: rgb\\(0, 0, 0\\)/']"]
+    [":-abp-properties(/background.\\x7B0,6\\x7D: rgb\\(0, 0, 0\\)/)"]
   ).then(() =>
   {
     expectVisible(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 exports.testDynamicallyChangedProperty = function(test)
 {
   let toHide = createElementWithStyle("{}");
   applyElemHideEmulation(
-    ["[-abp-properties='background-color: rgb(0, 0, 0)']"]
+    [":-abp-properties(background-color: rgb(0, 0, 0))"]
   ).then(() =>
   {
     expectVisible(test, toHide);
     insertStyleRule("#" + toHide.id + " {background-color: #000}");
     return new Promise((resolve, reject) =>
     {
       window.setTimeout(() =>
       {
         expectHidden(test, toHide);
         resolve();
       }, 0);
     });
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
-exports.testPseudoClassHasMatcher = function(test)
-{
-  let parent = createElementWithStyle("{}");
-  let child = createElementWithStyle("{}", parent);
-  loadElemHideEmulation().then(() =>
-  {
-    let matcher = new PseudoHasMatcher("div");
-    test.equal(matcher.match(parent), true, "Parent should contain what is expected");
-    test.equal(matcher.match(child), false, "Child shouldn't match");
-
-    let matcher2 = new PseudoHasMatcher("span");
-    test.equal(matcher2.match(parent), false, "Doesn't have a <span> child, shouldn't match");
-    test.equal(matcher2.match(child), false, "Child shouldn't match");
-  }).catch(unexpectedError.bind(test)).then(() => test.done());
-};
-
 exports.testPseudoClassHasSelector = function(test)
 {
   let toHide = createElementWithStyle("{}");
   applyElemHideEmulation(
     ["div:-abp-has(div)"]
   ).then(() =>
   {
     expectVisible(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
@@ skipping 60 matching lines @@
     expectVisible(test, parent);
     expectVisible(test, middle);
     expectVisible(test, sibling);
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
 function runTestPseudoClassHasSelectorWithHasAndWithSuffixSibling(test, selector)
 {
   document.body.innerHTML = `<div id="parent">
-    <div id="middle">
-      <div id="middle.1"><div id="inside" class="inside"></div></div>
-    </div>
-    <div id="sibling">
-      <div id="tohide">to hide</div>
-    </div>
-    <div id="sibling2">
-      <div id="sibling2.1"><div id="sibling2.1.1" class="inside"></div></div>
-    </div>
-  </div>`;
+      <div id="middle">
+        <div id="middle1"><div id="inside" class="inside"></div></div>
+      </div>
+      <div id="sibling">
+        <div id="tohide">to hide</div>
+      </div>
+      <div id="sibling2">
+        <div id="sibling21"><div id="sibling211" class="inside"></div></div>
+      </div>
+    </div>`;
   let parent = document.getElementById("parent");
   let middle = document.getElementById("middle");
   let inside = document.getElementById("inside");
   let sibling = document.getElementById("sibling");
   let sibling2 = document.getElementById("sibling2");
   let toHide = document.getElementById("tohide");
 
+  insertStyleRule(".inside {}");
+
   applyElemHideEmulation(
     [selector]
   ).then(() =>
   {
     expectVisible(test, parent);
     expectVisible(test, middle);
     expectVisible(test, inside);
     expectVisible(test, sibling);
     expectVisible(test, sibling2);
     expectHidden(test, toHide);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 }
 
 exports.testPseudoClassHasSelectorWithHasAndWithSuffixSibling = function(test)
 {
   runTestPseudoClassHasSelectorWithHasAndWithSuffixSibling(test, "div:-abp-has(:-abp-has(div.inside)) + div > div");
 };
 
 exports.testPseudoClassHasSelectorWithHasAndWithSuffixSibling2 = function(test)
 {
   runTestPseudoClassHasSelectorWithHasAndWithSuffixSibling(test, "div:-abp-has(:-abp-has(> div.inside)) + div > div");
 };
 
 exports.testPseudoClassHasSelectorWithPropSelector = function(test)
 {
   let parent = createElementWithStyle("{}");
   let child = createElementWithStyle("{background-color: #000}", parent);
   applyElemHideEmulation(
-    ["div:-abp-has(:-abp-properties(\"background-color: rgb(0, 0, 0)\"))"]
+    ["div:-abp-has(:-abp-properties(background-color: rgb(0, 0, 0)))"]
   ).then(() =>
   {
     expectVisible(test, child);
     expectHidden(test, parent);
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };