Test server refactor (#1566)

* WIP.

* More WIP.

* WIP.

* Fixed some URL silliness.

* Integration test cleanup.

* Formatting.

Author: jeffposnick

gulp-tasks/test-integration.js

@@ -7,7 +7,7 @@ const clearRequire = require('clear-require');
 
 const constants = require('./utils/constants');
 const logHelper = require('../infra/utils/log-helper');
-const testServer = require('../infra/testing/test-server');
+const server = require('../infra/testing/server/index');
 
 const runFiles = (filePaths) => {
   // Mocha can't be run multiple times, which we need for NODE_ENV.
@@ -53,24 +53,19 @@ const runIntegrationTestSuite = async (testPath, nodeEnv, seleniumBrowser,
 
   try {
     global.__workbox = {
-      webdriver,
       seleniumBrowser,
-      server: testServer,
+      server,
+      webdriver,
     };
 
     const testFiles = glob.sync(path.posix.join(__dirname, '..', testPath,
       '*.js'));
-
-    testServer.reset();
     await runFiles(testFiles);
 
     process.env.NODE_ENV = originalNodeEnv;
   } catch (err) {
     process.env.NODE_ENV = originalNodeEnv;
-
-    logHelper.error(err);
-    throw new Error(
-      `[Workbox Error Msg] 'gulp test-integration' discovered errors.`);
+    throw new Error(`'gulp test-integration' discovered errors.`);
   }
 };
 
@@ -115,7 +110,7 @@ gulp.task('test-integration', async () => {
     return;
   }
 
-  await testServer.start();
+  await server.start();
 
   try {
     const localBrowsers = seleniumAssistant.getLocalBrowsers();
@@ -138,9 +133,9 @@ gulp.task('test-integration', async () => {
           `);
       }
     }
-    await testServer.stop();
+    await server.stop();
   } catch (err) {
-    await testServer.stop();
+    await server.stop();
     throw err;
   }
 

gulp-tasks/test-server.js

@@ -1,7 +1,7 @@
 const gulp = require('gulp');
 
 const constants = require('./utils/constants');
-const testServer = require('../infra/testing/test-server');
+const testServer = require('../infra/testing/server/index');
 
 const handleExit = () => {
   testServer.stop();
@@ -16,9 +16,9 @@ const startServer = () => {
     'SIGUSR2',
     'uncaughtException',
   ];
-  eventNames.forEach((eventName) => {
+  for (const eventName of eventNames) {
     process.on(eventName, handleExit);
-  });
+  }
 
   return testServer.start();
 };

infra/testing/comlink/sw-interface.js

@@ -1,4 +1,4 @@
-importScripts('/comlink.js');
+importScripts('/__WORKBOX/comlink.js');
 
 // TODO: Standardize on naming, and move over some of the legacy uses of
 // postMessage() to this new approach.

infra/testing/comlink/window-interface.js

@@ -6,7 +6,7 @@ function initComlink() {
 }
 
 const scriptEl = document.createElement('script');
-scriptEl.src = '/comlink.js';
+scriptEl.src = '/__WORKBOX/comlink.js';
 scriptEl.addEventListener('load', () => {
   if (navigator.serviceWorker.controller) {
     initComlink();

infra/testing/server/index.js

@@ -0,0 +1,81 @@
+const express = require('express');
+const path = require('path');
+const requireDir = require('require-dir');
+const serveIndex = require('serve-index');
+
+const logHelper = require('../../utils/log-helper');
+const RequestCounter = require('./request-counter');
+
+const PORT = 3004;
+
+let app;
+let requestCounters;
+let server;
+
+function initApp() {
+  app = express();
+  requestCounters = new Set();
+
+  app.use((req, res, next) => {
+    for (const requestCounter of requestCounters) {
+      requestCounter.count(req);
+    }
+    next();
+  });
+
+  const routes = Object.values(requireDir('./routes'));
+  for (const {match, handler} of routes) {
+    app.get(match, handler);
+  }
+
+  const staticDir = path.resolve(__dirname, '..', '..', '..');
+  app.use(
+    express.static(staticDir),
+    serveIndex(staticDir, {'icons': true})
+  );
+}
+
+function start() {
+  if (!app) {
+    initApp();
+  }
+
+  return new Promise((resolve, reject) => {
+    server = app.listen(PORT, (error) => {
+      if (error) {
+        reject(error);
+      } else {
+        logHelper.log(`The test server is running at ${getAddress()}`);
+        resolve();
+      }
+    });
+  });
+}
+
+function stop() {
+  if (server) {
+    server.close();
+  }
+}
+
+function getAddress() {
+  return `http://localhost:${PORT}`;
+}
+
+function startCountingRequests(headerValue) {
+  const requestCounter = new RequestCounter(headerValue);
+  requestCounters.add(requestCounter);
+  return requestCounter;
+}
+
+function stopCountingRequests(requestCounter) {
+  requestCounters.delete(requestCounter);
+}
+
+module.exports = {
+  getAddress,
+  start,
+  startCountingRequests,
+  stop,
+  stopCountingRequests,
+};

infra/testing/server/request-counter.js

@@ -0,0 +1,35 @@
+class RequestCounter {
+  constructor(headerName) {
+    this.headerName = headerName;
+    this.headerCount = {};
+    this.urlCount = {};
+  }
+
+  count(req) {
+    if (this.headerName) {
+      const headerValue = req.get(this.headerName);
+      if (headerValue !== undefined) {
+        if (!(headerValue in this.headerCount)) {
+          this.headerCount[headerValue] = 0;
+        }
+        this.headerCount[headerValue]++;
+      }
+    }
+
+    const url = req.url;
+    if (!(url in this.urlCount)) {
+      this.urlCount[url] = 0;
+    }
+    this.urlCount[url]++;
+  }
+
+  getHeaderCount(headerValue) {
+    return this.headerCount[headerValue] || 0;
+  }
+
+  getUrlCount(url) {
+    return this.urlCount[url] || 0;
+  }
+}
+
+module.exports = RequestCounter;

infra/testing/server/routes/build-file.js

@@ -0,0 +1,34 @@
+const path = require('path');
+
+const constants = require('../../../../gulp-tasks/utils/constants');
+
+const match = '/__WORKBOX/buildFile/:moduleInfo';
+
+async function handler(req, res) {
+  const {moduleInfo} = req.params;
+  const [moduleName, buildType, extension] = moduleInfo.split('.', 3);
+
+  const packagePath = `../../../../packages/${moduleName}`;
+  const {main} = require(`${packagePath}/package.json`);
+
+  const buildPath = path.dirname(path.join(packagePath, main));
+  let fileName = path.basename(main);
+
+  if (buildType) {
+    fileName = fileName.replace('.prod.', `.${buildType}.`);
+  } else if (process.env.NODE_ENV === constants.BUILD_TYPES.dev) {
+    fileName = fileName.replace('.prod.', '.dev.');
+  }
+
+  if (extension) {
+    fileName = fileName.replace(/\.js$/, `.${extension}`);
+  }
+
+  const filePath = path.resolve(__dirname, buildPath, fileName);
+  res.sendFile(filePath);
+}
+
+module.exports = {
+  handler,
+  match,
+};

infra/testing/server/routes/comlink.js

@@ -0,0 +1,14 @@
+const path = require('path');
+
+const match = '/__WORKBOX/comlink.js';
+
+async function handler(req, res) {
+  const comlinkMain = require.resolve('comlinkjs');
+  const comlinkPath = path.join(path.dirname(comlinkMain), 'umd', 'comlink.js');
+  res.sendFile(comlinkPath);
+}
+
+module.exports = {
+  handler,
+  match,
+};

infra/testing/server/routes/integration-html.js

@@ -0,0 +1,13 @@
+const path = require('path');
+
+const match = '/*/integration.html';
+
+async function handler(req, res) {
+  const filePath = path.join(__dirname, '..', 'static', 'integration.html');
+  res.sendFile(filePath);
+}
+
+module.exports = {
+  handler,
+  match,
+};

infra/testing/server/routes/unique-etag.js

@@ -0,0 +1,12 @@
+const match = '/__WORKBOX/uniqueETag';
+
+let counter = 0;
+async function handler(req, res) {
+  res.set('ETag', ++counter);
+  res.send(`ETag is ${counter}.`);
+}
+
+module.exports = {
+  handler,
+  match,
+};