Server-side builds (version 0.1.0)

.gitignore

@@ -1,8 +1,8 @@
 .nyc_output/
-MANIFEST.json
 coverage.lcov
 coverage/
 generated/
 node_modules/
 secrets.json
+tests.json
 .testtmp

.nycrc.json

@@ -4,6 +4,7 @@
     "**/generated/**",
     "**/unittest/**",
     "**/coverage/**",
-    "**/json3.min.js"
+    "**/json3.min.js",
+    "selenium.js"
   ]
 }

DESIGN.md

@@ -24,7 +24,10 @@ Each API interface is written in the following structure:
 "INTERFACE_NAME": {
     "__base": "CODE_TO_REPEAT_FOR_EVERY_TEST",
     "__test": "CODE_SPECIFIC_TO_TEST_THE_INTERFACE",
-    "MEMBER": "CODE_TO_TEST_THE_MEMBER"
+    "MEMBER": "CODE_TO_TEST_THE_MEMBER",
+    "__additional": {
+      "SUBFEATURE": "CODE_TO_TEST_SUBFEATURE"
+    }
 }
 ```
 
@@ -34,7 +37,9 @@ You can define a custom method to test the interface instance itself via `__test
 
 Each member can have a custom test by defining a property as the member name.  Like `__test`, it should be a return statement that returns `true` or `false`.  If no custom test is defined, it will default to `return instance && 'MEMBER' in instance`.
 
-Each test will compile into a function as follows: `function() {__base + __test/MEMBER}`
+Additional members and submembers can be defined using the `__additional` property.  If there is a subfeature to an API or one of its members, such as "api.AudioContext.AudioContext.latencyHint", that simply cannot be defined within IDL, you can include this object and specify tests for such subfeatures.
+
+Each test will compile into a function as follows: `function() {__base + __test/MEMBER/SUBFEATURE}`
 
 Example:
 
@@ -47,7 +52,12 @@ The following JSON...
       "__base": "var canvas = document.createElement('canvas'); var gl = canvas.getContext('webgl'); var instance = gl.getExtension('ANGLE_instanced_arrays');",
       "__test": "return canvas && instance;",
       "drawArraysInstancedANGLE": "return true && instance && 'drawArraysInstancedANGLE' in instance;"
-    }
+    },
+    "DOMTokenList": {
+      "__additional": {
+        "remove_whitespace_and_duplicates": "var elm = document.createElement('b'); elm.className = ' foo bar foo '; elm.classList.remove('bar'); return elm.className === 'foo';"
+      }
+    },
   },
   "css": {
 
@@ -63,7 +73,10 @@ bcd.addTest('api.ANGLE_instanced_arrays.drawArraysInstancedANGLE', "(function()
 bcd.addTest('api.ANGLE_instanced_arrays.drawElementsInstancedANGLE', "(function() {var canvas = document.createElement('canvas'); var gl = canvas.getContext('webgl'); var instance = gl.getExtension('ANGLE_instanced_arrays');return instance && 'drawElementsInstancedANGLE' in instance;})()", 'Window');
 bcd.addTest('api.ANGLE_instanced_arrays.VERTEX_ATTRIB_ARRAY_DIVISOR_ANGLE', "(function() {var canvas = document.createElement('canvas'); var gl = canvas.getContext('webgl'); var instance = gl.getExtension('ANGLE_instanced_arrays');return instance && 'VERTEX_ATTRIB_ARRAY_DIVISOR_ANGLE' in instance;})()", 'Window');
 bcd.addTest('api.ANGLE_instanced_arrays.vertexAttribDivisorANGLE', "(function() {var canvas = document.createElement('canvas'); var gl = canvas.getContext('webgl'); var instance = gl.getExtension('ANGLE_instanced_arrays');return instance && 'vertexAttribDivisorANGLE' in instance;})()", 'Window');
-bcd.addTest('api.Animation', {"property":"Animation","scope":"self"}, 'Window');
+bcd.addTest('api.Animation', {"property":"Animation","owner":"self"}, 'Window');
+...
+bcd.addTest('api.DOMTokenList', {"property":"DOMTokenList","owner":"self"}, 'Window');
+bcd.addTest('api.DOMTokenList.remove_whitespace_and_duplicates', "(function() {var elm = document.createElement('b'); elm.className = ' foo bar foo '; elm.classList.remove('bar'); return elm.className === 'foo';})()", 'Window');
 ```
 
 Tips: make sure to implement thorough feature checking as to not raise exceptions.

README.md

@@ -22,9 +22,11 @@ Before you can run or deploy, copy `secrets.sample.json` to `secrets.json`.
 ## Running locally
 
 ```sh
-npm start
+npm run start-dev
 ```
 
+(`start-dev` as opposed to `start` will automatically reload the server on file changes.)
+
 ## Deploying to App Engine
 
 ```sh

app.js

@@ -14,16 +14,23 @@
 
 'use strict';
 
+const path = require('path');
 const express = require('express');
 const cookieParser = require('cookie-parser');
 const uniqueString = require('unique-string');
+const expressLayouts = require('express-ejs-layouts');
 
 const logger = require('./logger');
 
 const appversion = require('./package.json').version;
 
 const PORT = process.env.PORT || 8080;
 
+/* istanbul ignore next */
+const secrets = process.env.NODE_ENV === 'test' ?
+    require('./secrets.sample.json') :
+    require('./secrets.json');
+
 const getHost = () => {
   const project = process.env.GOOGLE_CLOUD_PROJECT;
   if (project) {
@@ -37,14 +44,12 @@ const getHost = () => {
 };
 
 const {CloudStorage, MemoryStorage} = require('./storage');
+/* istanbul ignore next */
 const storage = process.env.NODE_ENV === 'production' ?
    new CloudStorage(process.env.GOOGLE_CLOUD_PROJECT) :
    new MemoryStorage;
 
-const secrets = process.env.NODE_ENV === 'test' ?
-    require('./secrets.sample.json') :
-    require('./secrets.json');
-
+/* istanbul ignore next */
 const github = require('./github')(
   secrets.github.token ?
   {auth: `token ${secrets.github.token}`} :
@@ -53,7 +58,7 @@ const github = require('./github')(
 
 const Tests = require('./tests');
 const tests = new Tests({
-  manifest: require('./MANIFEST.json'),
+  tests: require('./tests.json'),
   host: getHost(),
   httpOnly: process.env.NODE_ENV !== 'production'
 });
@@ -74,18 +79,21 @@ const catchError = (err, res) => {
 };
 
 const app = express();
+
+// Layout config
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', 'ejs');
+app.use(expressLayouts);
+app.set('layout extractScripts', true);
+
+// Additional config
 app.use(cookieParser());
 app.use(cookieSession);
 app.use(express.json({limit: '32mb'}));
 app.use(express.static('static'));
 app.use(express.static('generated'));
 
-app.get('/api/tests', (req, res) => {
-  const {after, limit} = req.query;
-  const list = tests.list(after, limit ? +limit : 0);
-  const individualList = tests.listIndividual(after, limit ? +limit : 0);
-  res.json([list, individualList]);
-});
+// Backend API
 
 app.post('/api/results', (req, res) => {
   if (!req.is('json')) {
@@ -103,24 +111,12 @@ app.post('/api/results', (req, res) => {
 
   const response = {};
 
-  // Include next test in response as a convenience.
-  try {
-    const next = tests.list(forURL, 1)[0];
-    if (next) {
-      response.next = next;
-    }
-  } catch (err) {
-    logger.warn(`Results submitted for URL not in manifest: ${forURL}`);
-    // note: indistinguishable from finishing last test to client
-  }
-
   Promise.all([
     storage.put(req.sessionID, '__version', appversion),
     storage.put(req.sessionID, forURL, req.body)
   ]).then(() => {
     res.status(201).json(response);
-  })
-      .catch(/* istanbul ignore next */ (err) => catchError(err, res));
+  }).catch(/* istanbul ignore next */ (err) => catchError(err, res));
 });
 
 app.get('/api/results', (req, res) => {
@@ -131,22 +127,66 @@ app.get('/api/results', (req, res) => {
       .catch(/* istanbul ignore next */ (err) => catchError(err, res));
 });
 
-/* istanbul ignore next: we don't want to create lots of dummy PRs */
 app.post('/api/results/export/github', (req, res) => {
   storage.getAll(req.sessionID)
       .then(async (results) => {
+        if (Object.entries(results).length === 0) {
+          res.json({error: 'No results to export'});
+        }
+
         const userAgent = req.get('User-Agent');
         const report = {results, userAgent};
         const response = await github.exportAsPR(report);
         if (response) {
           res.json(response);
         } else {
-          res.status(500).end();
+          res.status(500).json({error: 'Server error'});
         }
       })
       .catch(/* istanbul ignore next */ (err) => catchError(err, res));
 });
 
+// Views
+
+app.get('/', (req, res) => {
+  res.render('index', {
+    tests: tests.listEndpoints('/tests')
+  });
+});
+
+app.get('/results', (req, res) => {
+  res.render('results', {
+    title: 'Test Results'
+  });
+});
+
+app.all('/tests/*', (req, res) => {
+  const ident = req.params['0'].replace(/\//g, '.');
+
+  if (tests.listEndpoints().some((item) => (item === ident))) {
+    res.render('tests', {
+      title: `${ident || 'All Tests'}`,
+      layout: false,
+      tests: tests.getTests(ident, req.query.exposure)
+    });
+  } else {
+    res.status(404).render('error', {
+      title: `Tests Not Found`,
+      message: `Could not find tests for ${ident}.`,
+      url: req.url
+    });
+  }
+});
+
+// Page Not Found Handler
+app.use((req, res) => {
+  res.status(404).render('error', {
+    title: `Page Not Found`,
+    message: 'The requested page was not found.',
+    url: req.url
+  });
+});
+
 /* istanbul ignore if */
 if (require.main === module) {
   // Start the server
@@ -156,5 +196,9 @@ if (require.main === module) {
   });
 } else {
   // Export for testing
-  module.exports = {app: app, version: appversion};
+  module.exports = {
+    app: app,
+    version: appversion,
+    getHost: getHost
+  };
 }