worker: add wpt tests for Web Workers

Author: avivkeller

test/common/wpt.js

@@ -8,6 +8,7 @@ const path = require('path');
 const events = require('events');
 const os = require('os');
 const { inspect } = require('util');
+const { pathToFileURL } = require('url');
 const { Worker } = require('worker_threads');
 
 const workerPath = path.join(__dirname, 'wpt/worker.js');
@@ -194,6 +195,24 @@ class ResourceLoader {
       fixtures.path('wpt', base, url);
   }
 
+  /**
+   * Map a URL that a test would have fetched from the WPT server (an
+   * absolute path, or a path relative to the test file) to a file: URL
+   * into the fixtures directory. URLs that already have a scheme (data:,
+   * blob:, http:, ...) are returned unchanged.
+   * @param {string} from the path of the file loading this resource,
+   *   relative to the WPT folder.
+   * @param {string|URL} url the url of the resource being loaded.
+   * @returns {string}
+   */
+  mapServerURL(from, url) {
+    url = `${url}`;
+    if (/^[a-zA-Z][a-zA-Z0-9+.-]*:|^\/\//.test(url)) {
+      return url;
+    }
+    return pathToFileURL(this.toRealFilePath(from, url)).href;
+  }
+
   /**
    * Load a resource in test/fixtures/wpt specified with a URL
    * @param {string} from the path of the file loading this resource,
@@ -389,13 +408,15 @@ class WPTTestSpec {
    * @returns {{ script?: string[]; variant?: string[]; [key: string]: string }} parsed META tags of a spec file
    */
   getMeta() {
-    const matches = this.getContent().match(/\/\/ META: .+/g);
+    // Like upstream, tolerate missing whitespace around "META:".
+    // Refs: https://github.com/web-platform-tests/wpt/blob/master/tools/manifest/sourcefile.py
+    const matches = this.getContent().match(/\/\/\s*META:\s*.+/g);
     if (!matches) {
       return {};
     }
     const result = {};
     for (const match of matches) {
-      const parts = match.match(/\/\/ META: ([^=]+?)=(.+)/);
+      const parts = match.match(/\/\/\s*META:\s*([^=]+?)=(.+)/);
       const key = parts[1];
       const value = parts[2];
       if (key === 'script' || key === 'variant') {
@@ -570,7 +591,11 @@ class WPTRunner {
     this.resource = new ResourceLoader(path);
     this.concurrency = concurrency;
 
-    this.flags = [];
+    // Since we need to prepare the Web Worker APIs
+    // in the harness that runs on all WPT workers,
+    // we enable the API globally. This has no practical
+    // effect on the non-web-worker tests, however.
+    this.flags = ['--experimental-web-worker'];
     this.globalThisInitScripts = [];
     this.initScript = null;
 
@@ -596,7 +621,7 @@ class WPTRunner {
    * @param {string[]} flags
    */
   setFlags(flags) {
-    this.flags = flags;
+    this.flags = this.flags.concat(flags);
   }
 
   /**
@@ -679,23 +704,41 @@ class WPTRunner {
       const absolutePath = spec.getAbsolutePath();
       const relativePath = spec.getRelativePath();
       const harnessPath = fixtures.path('wpt', 'resources', 'testharness.js');
-
-      // Scripts specified with the `// META: script=` header
-      const scriptsToRun = meta.script?.map((script) => {
+      // *.worker.js tests are dedicated worker tests by definition.
+      // Multi-global (*.any.js) tests whose global scopes include a
+      // dedicated worker but not a window also run inside an actual Web
+      // Worker, like the .any.worker.html variant generated by the WPT
+      // server does. Refs:
+      // https://web-platform-tests.org/writing-tests/testharness.html#multi-global-tests
+      const isAnyTest = /\.any\.js$/.test(spec.filename);
+      const globalScopes = isAnyTest ?
+        (meta.global?.split(',').map((s) => s.trim()) ??
+          ['window', 'dedicatedworker']) : [];
+      const isWebWorkerTest = /\.worker\.js$/.test(spec.filename) ||
+        (isAnyTest && !globalScopes.includes('window') &&
+         (globalScopes.includes('worker') ||
+          globalScopes.includes('dedicatedworker')));
+
+      // Scripts specified with the `// META: script=` header. For tests
+      // that run inside a Web Worker they are imported by the worker
+      // instead.
+      const scriptsToRun = isWebWorkerTest ? [] : meta.script?.map((script) => {
         const obj = {
           filename: this.resource.toRealFilePath(relativePath, script),
           code: this.resource.read(relativePath, script),
         };
         this.scriptsModifier?.(obj);
         return obj;
       }) ?? [];
-      // The actual test
-      const obj = {
-        code: content,
-        filename: absolutePath,
-      };
-      this.scriptsModifier?.(obj);
-      scriptsToRun.push(obj);
+      if (!isWebWorkerTest) {
+        // The actual test
+        const obj = {
+          code: content,
+          filename: absolutePath,
+        };
+        this.scriptsModifier?.(obj);
+        scriptsToRun.push(obj);
+      }
 
       run(async () => {
         const worker = new Worker(workerPath, {
@@ -710,6 +753,15 @@ class WPTRunner {
               filename: harnessPath,
             },
             scriptsToRun,
+            // Set when the test runs inside an actual Web Worker.
+            webWorker: isWebWorkerTest ? {
+              path: absolutePath,
+              isAnyTest,
+              scripts: meta.script?.map(
+                (script) => this.resource.toRealFilePath(relativePath, script),
+              ) ?? [],
+              skippedTests: spec.skippedTests,
+            } : undefined,
             needsGc: !!meta.script?.find((script) => script === '/common/gc.js'),
             skippedTests: spec.skippedTests,
           },

test/common/wpt/webworker.js

@@ -0,0 +1,112 @@
+'use strict';
+
+// Runs a WPT test file inside a Web Worker
+// Refs: https://web-platform-tests.org/writing-tests/testharness.html
+
+const { pathToFileURL } = require('url');
+
+globalThis.onmessage = ({ data }) => {
+  // Let the test install its own handler.
+  globalThis.onmessage = null;
+
+  const { ResourceLoader } = require(data.wptRunner);
+  const resource = new ResourceLoader(data.wptPath);
+
+  // Pretend the worker was served from the URL the WPT server would have
+  // used
+  const fakePath = (data.isAnyTest ?
+    data.testRelativePath.replace(/\.any\.js$/, '.any.worker.js') :
+    data.testRelativePath).replace(/\\/g, '/');
+  const fakeURL = new URL(`/${fakePath}`, 'http://wpt');
+  // eslint-disable-next-line no-undef
+  const fakeLocation = { __proto__: WorkerLocation.prototype };
+  for (const key of ['href', 'origin', 'protocol', 'host', 'hostname',
+                     'port', 'pathname', 'search', 'hash']) {
+    Object.defineProperty(fakeLocation, key, {
+      value: fakeURL[key],
+      enumerable: true,
+    });
+  }
+  Object.defineProperty(fakeLocation, 'toString', {
+    value: function toString() { return fakeURL.href; },
+    enumerable: true,
+  });
+  Object.defineProperty(globalThis, 'location', {
+    value: fakeLocation,
+    enumerable: true,
+    configurable: true,
+  });
+
+  const testharnessPath =
+    pathToFileURL(resource.toRealFilePath(data.testRelativePath,
+                                          '/resources/testharness.js')).href;
+
+  // If there are skip patterns, wrap the test functions to prevent
+  // execution of matching tests. This must happen after testharness.js is
+  // loaded but before the test scripts run.
+  function applySkips() {
+    if (!data.skippedTests?.length) {
+      return;
+    }
+    function isSkipped(name) {
+      for (const matcher of data.skippedTests) {
+        if (typeof matcher === 'string') {
+          if (name === matcher) return true;
+        } else if (matcher.test(name)) {
+          return true;
+        }
+      }
+      return false;
+    }
+    for (const fn of ['test', 'async_test', 'promise_test']) {
+      const original = globalThis[fn];
+      globalThis[fn] = function(func, name, ...rest) {
+        if (typeof name === 'string' && isSkipped(name)) {
+          // eslint-disable-next-line no-undef
+          postMessage({ type: 'skip', name });
+          return;
+        }
+        return original.call(this, func, name, ...rest);
+      };
+    }
+  }
+
+  // Tests fetch scripts and nested worker scripts from the WPT server; map
+  // those URLs into the fixtures directory.
+  const realImportScripts = globalThis.importScripts;
+  globalThis.importScripts = function importScripts(...urls) {
+    const mapped = urls.map(
+      (url) => resource.mapServerURL(data.testRelativePath, url));
+    const result = realImportScripts.apply(this, mapped);
+    if (mapped.includes(testharnessPath)) {
+      applySkips();
+    }
+    return result;
+  };
+  const RealWorker = globalThis.Worker;
+  globalThis.Worker = class Worker extends RealWorker {
+    constructor(url, options) {
+      super(resource.mapServerURL(data.testRelativePath, url), options);
+    }
+  };
+
+  if (data.isAnyTest) {
+    // Emulate the generated .any.worker.js wrapper script.
+    // Refs: https://github.com/web-platform-tests/wpt/blob/master/tools/serve/serve.py
+    globalThis.GLOBAL = {
+      isWindow() { return false; },
+      isWorker() { return true; },
+      isShadowRealm() { return false; },
+    };
+    globalThis.importScripts('/resources/testharness.js');
+    for (const script of data.scripts) {
+      globalThis.importScripts(pathToFileURL(script).href);
+    }
+    globalThis.importScripts(pathToFileURL(data.path).href);
+    // eslint-disable-next-line no-undef
+    done();
+  } else {
+    // *.worker.js tests import testharness.js and call done() themselves.
+    globalThis.importScripts(pathToFileURL(data.path).href);
+  }
+};

test/common/wpt/worker.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const path = require('path');
+const { pathToFileURL } = require('url');
 const {
   runInNewContext,
   runInThisContext,
@@ -11,6 +13,15 @@ const { parentPort, workerData } = require('worker_threads');
 const { ResourceLoader } = require(workerData.wptRunner);
 const resource = new ResourceLoader(workerData.wptPath);
 
+// Tests create workers with URLs the WPT server would have served them
+// from; map them into the fixtures directory.
+const RealWorker = globalThis.Worker;
+globalThis.Worker = class Worker extends RealWorker {
+  constructor(url, options) {
+    super(resource.mapServerURL(workerData.testRelativePath, url), options);
+  }
+};
+
 if (workerData.needsGc) {
   // See https://github.com/nodejs/node/issues/16595#issuecomment-340288680
   setFlagsFromString('--expose-gc');
@@ -104,3 +115,41 @@ for (const scriptToRun of workerData.scriptsToRun) {
     importModuleDynamically: USE_MAIN_CONTEXT_DEFAULT_LOADER,
   });
 }
+
+if (workerData.webWorker) {
+  const worker = new RealWorker(
+    pathToFileURL(path.join(__dirname, 'webworker.js')));
+  worker.postMessage({
+    wptRunner: workerData.wptRunner,
+    wptPath: workerData.wptPath,
+    testRelativePath: workerData.testRelativePath,
+    ...workerData.webWorker,
+  });
+
+  let started = false;
+  worker.addEventListener('message', (event) => {
+    started = true;
+    // Skipped subtests never register with the testharness inside the
+    // worker; the runner is notified about them directly.
+    if (event.data?.type === 'skip') {
+      parentPort.postMessage({ type: 'skip', name: event.data.name });
+    }
+  });
+  worker.addEventListener('error', (event) => {
+    if (started) {
+      return;
+    }
+    clearTimeout(timeout);
+    parentPort.postMessage({
+      type: 'completion',
+      status: {
+        status: 1,
+        message: event.message,
+        stack: event.error?.stack,
+      },
+    });
+  });
+
+  // eslint-disable-next-line no-undef
+  fetch_tests_from_worker(worker);
+}

test/fixtures/wpt/README.md

@@ -1,14 +1,46 @@
 # Web Platform Test Fixtures
 
-The files in this folder are maintained by [`git node wpt`][].
+The files in this folder, including this document,
+are generated by [`git node wpt`][].
 
 This folder contains a subset of the [Web Platform Tests][] for the
 implementation of Web APIs in Node.js.
 
 See [test/wpt](../../wpt/README.md) for information on how these tests are run.
 
-Pinned upstream WPT revisions for each imported subset are recorded in
-[`versions.json`](./versions.json).
+Last update:
+
+- common: https://github.com/web-platform-tests/wpt/tree/dbd648158d/common
+- compression: https://github.com/web-platform-tests/wpt/tree/ae05f5cb53/compression
+- console: https://github.com/web-platform-tests/wpt/tree/e48251b778/console
+- dom/abort: https://github.com/web-platform-tests/wpt/tree/dc928169ee/dom/abort
+- dom/events: https://github.com/web-platform-tests/wpt/tree/0a811c5161/dom/events
+- encoding: https://github.com/web-platform-tests/wpt/tree/1ac8deee08/encoding
+- fetch/data-urls/resources: https://github.com/web-platform-tests/wpt/tree/7c79d998ff/fetch/data-urls/resources
+- FileAPI: https://github.com/web-platform-tests/wpt/tree/7f51301888/FileAPI
+- hr-time: https://github.com/web-platform-tests/wpt/tree/34cafd797e/hr-time
+- html/webappapis/atob: https://github.com/web-platform-tests/wpt/tree/f267e1dca6/html/webappapis/atob
+- html/webappapis/microtask-queuing: https://github.com/web-platform-tests/wpt/tree/2c5c3c4c27/html/webappapis/microtask-queuing
+- html/webappapis/structured-clone: https://github.com/web-platform-tests/wpt/tree/47d3fb280c/html/webappapis/structured-clone
+- html/webappapis/timers: https://github.com/web-platform-tests/wpt/tree/5873f2d8f1/html/webappapis/timers
+- interfaces: https://github.com/web-platform-tests/wpt/tree/a8392bd021/interfaces
+- performance-timeline: https://github.com/web-platform-tests/wpt/tree/94caab7038/performance-timeline
+- resource-timing: https://github.com/web-platform-tests/wpt/tree/22d38586d0/resource-timing
+- resources: https://github.com/web-platform-tests/wpt/tree/6a2f322376/resources
+- service-workers: https://github.com/web-platform-tests/wpt/tree/b7ed7c8dcd/service-workers
+- streams: https://github.com/web-platform-tests/wpt/tree/f8f26a372f/streams
+- url: https://github.com/web-platform-tests/wpt/tree/4832db4761/url
+- urlpattern: https://github.com/web-platform-tests/wpt/tree/5847ee5cfa/urlpattern
+- user-timing: https://github.com/web-platform-tests/wpt/tree/5ae85bf826/user-timing
+- wasm/jsapi: https://github.com/web-platform-tests/wpt/tree/288c467d35/wasm/jsapi
+- wasm/webapi: https://github.com/web-platform-tests/wpt/tree/fd1b23eeaa/wasm/webapi
+- web-locks: https://github.com/web-platform-tests/wpt/tree/10a122a6bc/web-locks
+- WebCryptoAPI: https://github.com/web-platform-tests/wpt/tree/ec2fee39a4/WebCryptoAPI
+- webidl: https://github.com/web-platform-tests/wpt/tree/63ca529a02/webidl
+- webidl/ecmascript-binding/es-exceptions: https://github.com/web-platform-tests/wpt/tree/2f96fa1996/webidl/ecmascript-binding/es-exceptions
+- webmessaging/broadcastchannel: https://github.com/web-platform-tests/wpt/tree/6495c91853/webmessaging/broadcastchannel
+- webstorage: https://github.com/web-platform-tests/wpt/tree/1d2c5fb36a/webstorage
+- workers: https://github.com/web-platform-tests/wpt/tree/4832db4761/workers
 
 [Web Platform Tests]: https://github.com/web-platform-tests/wpt
 [`git node wpt`]: https://github.com/nodejs/node-core-utils/blob/main/docs/git-node.md#git-node-wpt

test/fixtures/wpt/service-workers/META.yml

@@ -0,0 +1,6 @@
+spec: https://w3c.github.io/ServiceWorker/
+suggested_reviewers:
+  - asutherland
+  - mkruisselbrink
+  - mattto
+  - wanderview

test/fixtures/wpt/service-workers/WEB_FEATURES.yml

@@ -0,0 +1,2 @@
+rules:
+- "*": [service-workers]

test/fixtures/wpt/service-workers/cache-storage/META.yml

@@ -0,0 +1,3 @@
+suggested_reviewers:
+  - inexorabletash
+  - wanderview

test/fixtures/wpt/service-workers/cache-storage/WEB_FEATURES.yml

@@ -0,0 +1,2 @@
+rules:
+- "**": [service-workers]