Issue 6538, 6781 - Implement script compilation for snippets

test/snippets.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/>.
  */
 
+/* eslint no-new-func: "off" */
+
 "use strict";
 
 const {createSandbox} = require("./_common");
 
 let Snippets = null;
 let parseScript = null;
+let compileScript = null;
 let Filter = null;
 
 exports.setUp = function(callback)
 {
   let sandboxedRequire = createSandbox();
   (
     {Filter} = sandboxedRequire("../lib/filterClasses"),
-    {Snippets, parseScript} = sandboxedRequire("../lib/snippets")
+    {Snippets, parseScript, compileScript} = sandboxedRequire("../lib/snippets")
   );
 
   callback();
 };
 
 exports.testDomainRestrictions = function(test)
 {
   function testScriptMatches(description, filters, domain, expectedMatches)
   {
     for (let filter of filters)
@@ skipping 119 matching lines @@
                     "fo\\'\\ \\ \\\t\\\n\\;o 1 2 3; 'b a  r' 1 2",
                     [["fo'  \t\n;o", "1", "2", "3"], ["b a  r", "1", "2"]]);
   checkParsedScript("Script containing Unicode composite characters",
                     "f\ud83d\ude42\ud83d\ude42 b\ud83d\ude02r",
                     [["f\ud83d\ude42\ud83d\ude42", "b\ud83d\ude02r"]]);
   checkParsedScript("Script with no-op commands", "foo; ;;; ;  ; bar 1",
                     [["foo"], ["bar", "1"]]);
 
   test.done();
 };
+
+exports.testScriptCompilation = function(test)
+{
+  let libraries = [
+    `
+      let foo = 0;
+
+      exports.setFoo = function(value)
+      {
+        foo = value;
+      };
+
+      exports.assertFoo = function(expected)
+      {
+        if (foo != expected)
+          throw new Error("Value mismatch");
+      };
+    `
+  ];
+
+  let template = `
+    "use strict";
+    {
+      const libraries = ${JSON.stringify(libraries)};
+
+      const script = {{{script}}};
+
+      let imports = Object.create(null);
+      for (let library of libraries)
+        new Function("exports", library)(imports);
+
+      for (let [name, ...args] of script)
+      {
+        if (Object.prototype.hasOwnProperty.call(imports, name))
+        {
+          let value = imports[name];
+          if (typeof value == "function")
+            value(...args);
+        }
+      }
+    }
+  `;
+
+  function verifyExecutable(script)
+  {
+    let actual = compileScript(script, libraries);
+    let expected = template.replace("{{{script}}}",
+                                    JSON.stringify(parseScript(script)));
+
+    test.equal(expected, actual);

[Sebastian Noack, 2018/07/16 16:37:35]

Instead of copying the boilerplate over to the tests and verifying that the
output of the generated code matches, I wonder whether we should rather run the
generated code and verify, that it behaves as expected?

[Manish Jethani, 2018/07/17 19:57:15]

Let me try something.

Yeah I agree that the current approach probably isn't the best way to do it.

[Manish Jethani, 2018/07/17 20:10:26]

Wait, this is what the next test does! It tests the _execution_ of the snippet.
setFoo is supposed to set the value of an internal variable, and assertFoo is
supposed to verify the value. We are already doing this.

+  }
+
+  verifyExecutable("hello 'How are you?'");
+
+  // Test script execution.
+  new Function(compileScript("setFoo 123; assertFoo 123", libraries))();
+
+  // Override setFoo in a second library, without overriding assertFoo. A
+  // couple of things to note here: (1) each library has its own variables;
+  // (2) script execution is stateless, i.e. the values are not retained
+  // between executions. In the example below, assertFoo does not find 456 but
+  // it doesn't find 123 either. It's the initial value 0.
+  new Function(
+    compileScript("setFoo 456; assertFoo 0", [
+      ...libraries, "let foo = 1; exports.setFoo = value => { foo = value; };"
+    ])
+  )();
+
+  test.done();
+};