Add test filters for selective test running (#2441)

* Add test filters for selective test running

* Fix transpile-typescript:watch

* Respond with an error rather than unregistering

Author: philipwalton

gulp-tasks/transpile-typescript.js

@@ -29,8 +29,10 @@ const packagesDir = path.join(__dirname, '..', 'packages');
  * in the root package directory, along with the corresponding `.d.ts` files.
  *
  * @param {string} packageName
+ * @param {Object} [options]
+ * @param {boolean} [options.failOnError=true]
  */
-const transpilePackage = async (packageName) => {
+const transpilePackage = async (packageName, {failOnError = true} = {}) => {
   try {
     // Compile TypeScript for the given project.
     // Reference the local `node_modules` version of `tsc` since on Windows
@@ -50,27 +52,30 @@ const transpilePackage = async (packageName) => {
       if (!(await fs.pathExists(mjsFile))) {
         const mjsSource = `export * from './${assetBasename}.js';`;
 
-        // console.log({mjsFile, tsFile, assetBasename})
         fs.outputFileSync(mjsFile, mjsSource);
       }
     }
   } catch (error) {
-    logHelper.error(error.stdout);
-    throw error;
+    if (failOnError) {
+      throw error;
+    } else {
+      logHelper.error(error.stdout);
+    }
   }
 };
 
 /**
  * Transpiles a package iff it has TypeScript source files.
  *
  * @param {string} packagePath
+ * @param {Object} [options]
  */
-const transpilePackageOrSkip = async (packagePath) => {
-  // `packagePath` will be posix style because it comes from `glog()`.
+const transpilePackageOrSkip = async (packagePath, options) => {
+  // `packagePath` will be posix style because it comes from `glob()`.
   const packageName = packagePath.split('/').slice(-1)[0];
 
   if (await fs.pathExists(path.join(packagePath, 'tsconfig.json'))) {
-    await queueTranspile(packageName);
+    await queueTranspile(packageName, options);
   } else {
     logHelper.log(ol`Skipping package '${packageName}'
         not yet converted to typescript.`);
@@ -92,14 +97,16 @@ const debouncedTranspilerMap = {};
  * needed.
  *
  * @param {string} packageName
+ * @param {Object} [options]
  */
-const queueTranspile = async (packageName) => {
+const queueTranspile = async (packageName, options) => {
   if (!debouncedTranspilerMap[packageName]) {
     debouncedTranspilerMap[packageName] = new AsyncDebounce(async () => {
-      await transpilePackage(packageName);
+      await transpilePackage(packageName, options);
     });
   }
   await debouncedTranspilerMap[packageName].call();
+  debouncedTranspilerMap[packageName] = null;
 };
 
 /**
@@ -123,16 +130,13 @@ const needsTranspile = (packageName) => {
 gulp.task('transpile-typescript', gulp.series(packageRunnner(
     'transpile-typescript', 'all', transpilePackageOrSkip)));
 
-gulp.task('transpile-typescript:watch', gulp.series(packageRunnner(
-    'transpile-typescript', 'all', transpilePackageOrSkip)));
-
 gulp.task('transpile-typescript:watch', () => {
   const watcher = gulp.watch(`./${global.packageOrStar}/workbox-*/src/**/*.ts`);
   watcher.on('all', async (event, file) => {
     const changedPkg = path.relative(packagesDir, file).split(path.sep)[0];
 
     pendingChangesMap[changedPkg] = true;
-    await queueTranspile(changedPkg);
+    await queueTranspile(changedPkg, {failOnError: false});
     pendingChangesMap[changedPkg] = false;
   });
 });

infra/testing/helpers/extendable-event-utils.mjs

@@ -33,11 +33,13 @@ export const spyOnEvent = (event) => {
 
   if (event instanceof FetchEvent) {
     event.respondWith = sinon.stub().callsFake((responseOrPromise) => {
-      eventResponses.set(event, responseOrPromise);
-      promises.push(Promise.resolve(responseOrPromise));
+      const promise = Promise.resolve(responseOrPromise);
+
+      eventResponses.set(event, promise);
+      promises.push(promise);
 
       // TODO(philipwalton): we cannot currently call the native
-      // `respondWith()` due to this bug in Firefix:
+      // `respondWith()` due to this bug in Firefox:
       // https://bugzilla.mozilla.org/show_bug.cgi?id=1538756
       // FetchEvent.prototype.respondWith.call(event, responseOrPromise);
     });

infra/testing/server/routes/sw-bundle.js

@@ -26,44 +26,59 @@ async function handler(req, res) {
   const env = process.env.NODE_ENV || 'development';
   const packageName = req.params.package;
 
-  // Ensure the TypeScript transpile step has completed first.
-  if (needsTranspile(packageName)) {
-    await queueTranspile(packageName);
-  }
+  res.set('Content-Type', 'text/javascript');
 
-  const bundle = await rollup({
-    input: `./test/${packageName}/sw/**/test-*.mjs`,
-    plugins: [
-      multiEntry(),
-      resolve({
-        customResolveOptions: {
-          moduleDirectory: 'packages',
-        },
-      }),
-      // TODO(philipwalton): some of our shared testing helpers use commonjs
-      // so we have to support this for the time being.
-      commonjs({
-        exclude: '*.mjs',
-      }),
-      replace({
-        'process.env.NODE_ENV': JSON.stringify(env),
-        'BROWSER_NAMESPACES': JSON.stringify(BROWSER_NAMESPACES),
-        'WORKBOX_CDN_ROOT_URL': '/__WORKBOX/buildFile',
-      }),
-    ],
-    cache: caches[env],
-  });
+  try {
+    // Ensure the TypeScript transpile step has completed first.
+    if (needsTranspile(packageName)) {
+      await queueTranspile(packageName);
+    }
 
-  // Update the cache so subsequent bundles are faster, and make sure it
-  // keep the dev/prod caches separate since the source files won't change
-  // between those builds, but the outputs will.
-  caches[env] = bundle.cache;
+    // Allows you to selectively run tests by adding the `?test=` to the URL.
+    const testFilter = req.query.filter || '**/test-*.mjs';
+    const bundle = await rollup({
+      input: `./test/${packageName}/sw/` + testFilter,
+      plugins: [
+        multiEntry(),
+        resolve({
+          customResolveOptions: {
+            moduleDirectory: 'packages',
+          },
+        }),
+        // TODO(philipwalton): some of our shared testing helpers use commonjs
+        // so we have to support this for the time being.
+        commonjs({
+          exclude: '*.mjs',
+        }),
+        replace({
+          'process.env.NODE_ENV': JSON.stringify(env),
+          'BROWSER_NAMESPACES': JSON.stringify(BROWSER_NAMESPACES),
+          'WORKBOX_CDN_ROOT_URL': '/__WORKBOX/buildFile',
+        }),
+      ],
+      // Fail in the case of warning, so rebuilds work.
+      onwarn({loc, message}) {
+        if (loc) {
+          message = `${loc.file} (${loc.line}:${loc.column}) ${message}`;
+        }
+        throw new Error(message);
+      },
+      cache: caches[env],
+    });
 
-  const {output} = await bundle.generate({format: 'iife'});
+    // Update the cache so subsequent bundles are faster, and make sure it
+    // keep the dev/prod caches separate since the source files won't change
+    // between those builds, but the outputs will.
+    caches[env] = bundle.cache;
 
-  res.set('Content-Type', 'text/javascript');
-  res.write(output[0].code);
-  res.end();
+    const {output} = await bundle.generate({format: 'iife'});
+
+    console.log(`Successfully built: ${req.url}`);
+    res.send(output[0].code);
+  } catch (error) {
+    res.status(400).send('');
+    console.error(error);
+  }
 }
 
 module.exports = {

infra/testing/server/routes/test-sw.js

@@ -15,20 +15,26 @@ const match = '/test/:packageName/sw/';
 
 async function handler(req, res) {
   const {packageName} = req.params;
-  const testFiles = await globby(`test/${packageName}/sw/**/test-*.mjs`) || [];
+  const testFilter = req.query.filter || '**/test-*.mjs';
+
+  const testFiles = await globby(`test/${packageName}/sw/${testFilter}`) || [];
   const testModules = testFiles.map((file) => '/' + file);
 
-  templateData.assign({packageName, testModules});
+  if (testFiles.length > 0) {
+    templateData.assign({packageName, testModules, testFilter});
 
-  res.set('Content-Type', 'text/html');
+    res.set('Content-Type', 'text/html');
 
-  // Since templates can change between tests without the URL changing,
-  // we need to make sure the browser doesn't cache the response.
-  res.set('Cache-Control', 'no-cache, no-store, must-revalidate');
-  res.set('Expires', '0');
+    // Since templates can change between tests without the URL changing,
+    // we need to make sure the browser doesn't cache the response.
+    res.set('Cache-Control', 'no-cache, no-store, must-revalidate');
+    res.set('Expires', '0');
 
-  const file = path.join(__dirname, '..', 'templates', 'test-sw.html.njk');
-  res.render(file, templateData.get());
+    const file = path.join(__dirname, '..', 'templates', 'test-sw.html.njk');
+    res.render(file, templateData.get());
+  } else {
+    res.status(404).send(`No test files found for: ${testFilter}`);
+  }
 }
 
 module.exports = {

infra/testing/server/routes/test-window.js

@@ -15,12 +15,14 @@ const match = '/test/:packageName/window/';
 
 async function handler(req, res) {
   const {packageName} = req.params;
+  const testFilter = req.query.filter || '**/test-*.mjs';
+
   const testFiles =
-      await globby(`test/${packageName}/window/**/test-*.mjs`) || [];
+      await globby(`test/${packageName}/window/**/${testFilter}`) || [];
 
   const testModules = testFiles.map((file) => '/' + file);
 
-  templateData.assign({packageName, testModules});
+  templateData.assign({packageName, testModules, testFilter});
 
   res.set('Content-Type', 'text/html');
 

infra/testing/server/templates/test-sw-runner.js.njk

@@ -12,6 +12,9 @@ importScripts(
     '/node_modules/sinon/pkg/sinon-no-sourcemaps.js'
 );
 
+// Disable workbox logs in test mode.
+self.__WB_DISABLE_DEV_LOGS = true;
+
 self.expect = chai.expect;
 
 // TODO(philipwalton): Move these globals back into imports once the
@@ -111,4 +114,4 @@ addEventListener('install', (event) => {
   event.waitUntil(testsComplete);
 }, {once: true}); // Run once since `install` events are dispatched in tests.
 
-importScripts('sw-bundle.js');
+importScripts('sw-bundle.js?filter={{ testFilter }}');