Version 3.1.0 (#246 )

* Version 3.1.0 Also minor bump to pa11y-webservice * Bump webservice so it includes data fixtures
Bump webservice version and other deps (#245 )
2019-09-27 11:44:24 +01:00 · 2019-09-20 15:59:21 +01:00 · 2019-09-20 14:57:15 +01:00 · 2019-09-13 15:14:36 +01:00 · 2019-08-01 09:20:02 +01:00 · 2019-07-16 15:16:06 +01:00
11 changed files with 109 additions and 75 deletions
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -1,3 +1,3 @@
 'use strict';

-module.exports = require('pa11y-lint-config/eslint/es6');
+module.exports = require('pa11y-lint-config/eslint/es2017');
--- a/.travis.yml
+++ b/.travis.yml
@@ -3,9 +3,9 @@
 language: node_js
 matrix:
  include:
-    - node_js: '4'
-    - node_js: '5'
-    - node_js: '6'
+    - node_js: '8'
+    - node_js: '10'
+    - node_js: '12'

 # Build only master (and pull-requests)
 branches:
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,19 @@

 # Changelog

+## 3.1.0 (2019-09-27)
+
+  * Display the task ID before each line of output, so it's clear to which task a line of output belongs to when they run in parallel.
+  * Bump pa11y-webservice version, which fixes an issue with some pages failing to run.
+  * Fix incorrect routes passing an invalid value to Mongo's ObjectID.
+
+## 3.0.0 (2019-07-16)
+
+  * Update pa11y to v5, which replaces Phantomjs with Headless Chrome
+  * Update dependencies
+  * Several bug fixes and documentation updates
+  * See the [migration guide](https://github.com/pa11y/pa11y-dashboard/blob/master/MIGRATION.md#migrating-from-20-to-30) for details of the breaking changes in this release
+
 ## 2.4.2 (2018-06-21)

  * Update dependencies
--- a/MIGRATION.md
+++ b/MIGRATION.md
@@ -1,18 +1,29 @@
-
-Migration Guide
-===============
+# Migration Guide

 Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens.

+## Table of Contents

-Table Of Contents
-----------------
-
+- [Migrating from 2.0 to 3.0](#migrating-from-20-to-30)
 - [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)

+## Migrating from 2.0 to 3.0

-Migrating from 1.0 to 2.0
-------------------------
+### PhantomJS to Headless Chrome
+
+Pa11y Dashboard 3 uses version 5 of Pa11y, which replaces PhantomJS with [Headless Chrome](https://developers.google.com/web/updates/2017/04/headless-chrome). This allows us to use more modern JavaScript APIs and make Pa11y testing more stable.
+
+As a result of this change, [Pa11y Dashboard's requirements](../README.md#requirements) have changed, and you may need to install additional dependencies required by Chrome before being able to use this version.
+
+### Node.js Support
+
+Pa11y Webservice 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.
+
+### Miscellaneous
+
+The default viewport dimensions for Pa11y have been changed from `1024x768` to `1280x1024`. This could make pa11y report a different number of errors if different content appears on the page based on its width, so results obtained with v2 and v3 may not be comparable.
+
+## Migrating from 1.0 to 2.0

 ### Node.js Support

--- a/Makefile.node
+++ b/Makefile.node
@@ -21,7 +21,7 @@
 NPM_BIN = ./node_modules/.bin
 export PATH := $(NPM_BIN):$(PATH)
 export EXPECTED_COVERAGE := 90
-export INTEGRATION_TIMEOUT := 5000
+export INTEGRATION_TIMEOUT := 10000
 export INTEGRATION_SLOW := 4000


--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Pa11y Dashboard
-===============
+# Pa11y Dashboard

 Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.

@@ -8,27 +7,39 @@ Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter;
 [![Build status][shield-build]][info-build]
 [![GPL-3.0 licensed][shield-license]][info-license]

---
-
-## Latest news from Pa11y
-
-✨ 🔜 ✨ The Pa11y team is very excited to announce plans for the successor to Pa11y Dashboard and Pa11y Webservice, codename "Sidekick". Help us define the features that you want to see by visiting the [proposal][sidekick-proposal]. ✨
+![dashboard](https://user-images.githubusercontent.com/6110968/61603347-0bce1000-abf2-11e9-87b2-a53f91d315bb.jpg)
+![results-page](https://user-images.githubusercontent.com/6110968/62183438-05851580-b30f-11e9-9bc4-b6a4823ae9e8.jpg)

 ---

+## Requirements

-![dashboard](https://f.cloud.github.com/assets/1225142/1549567/f0361e72-4de8-11e3-8d14-3fe6900cc15d.jpg)
-![results-page](https://f.cloud.github.com/assets/1225142/1549568/f225aa54-4de8-11e3-8b25-ef2f405997a3.jpg)
+Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 8 or greater.

+Pa11y Dashboard also requires a [MongoDB][mongo] database to be available so it can store the results of the tests. The database doesn't have to be in the same server or computer where Pa11y Dashboard is running from.

-Setup
-----
+Since version 3, Pa11y Dashboard uses Headless Chrome in order to run the tests. This means that additional dependencies maybe be required.

-Pa11y Dashboard requires [Node.js][node] 4+. See the [Pa11y][pa11y] documentation for detailed instructions on how to install this on your operating system.
+In [Unix-like](https://en.wikipedia.org/wiki/Unix-like) systems you may need to install the `libnss3` and `libgconf-2-4` libraries in order to be able to run Chrome. If you're trying to run the app in a headless environment (e.g. the cloud, or a headless server), you may also need to configure Xvfb before. Please refer to the documentation from your provider for details on how to do this.

-You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this.
+## Setup

-You'll then need to clone this repo locally and install dependencies with `npm install`. Now you need to add some configuration before you can run the application. We can do this in two ways:
+In order to run Pa11y Dashboard, we recommend cloning this repository locally:
+
+```sh
+git clone https://github.com/pa11y/pa11y-dashboard.git
+```
+
+Then installing the dependencies:
+
+```sh
+cd pa11y-dashboard
+npm install
+```
+
+You'll also need to have [MongoDB][mongo] installed and running. For quick access, you can install via a package manager such as on Mac OS `brew install mongodb` or on Linux (Debian) it would be `apt-get install mongodb`. To run MongoDB, you can run `mongod` in the command line. See the [MongoDB install guide][mongo-install] for more detailed information.
+
+The last step before being able to run the application is to define a configuration for it. This can be done in two ways:

 ### Option 1: Using Environment Variables

@@ -62,9 +73,7 @@ See [Contributing](#contributing) for more information about running locally (an

 If you run into problems, check the [troubleshooting guide][troubleshooting].

-
-Configurations
--------------
+## Configurations

 The boot configurations for Pa11y Dashboard are as follows. Look at the sample JSON files in the repo for example usage.

@@ -83,9 +92,7 @@ The boot configurations for Pa11y Dashboard are as follows. Look at the sample J
 ### webservice
 This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.

-
-Contributing
------------
+## Contributing

 There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.

@@ -110,14 +117,12 @@ make less    # Compile the site CSS from LESS files
 make uglify  # Compile and uglify the client-side JavaScript
 ```

+## Useful Resources

-Useful Resources
-------
 * [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/)
 * [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard)

-Support and Migration
---------------------
+## Support and Migration

 Pa11y Dashboard major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.

@@ -125,19 +130,16 @@ We also maintain a [migration guide](MIGRATION.md) to help you migrate.

 | :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
 | :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
-| :heart:         | 2             | N/A                | 4+               | N/A              |
+| :heart:         | 3             | N/A                | 8+               | N/A              |
+| :hourglass:     | 2             | 2.4.2              | 4+               | 2020-01-16       |
 | :skull:         | 1             | 1.12               | 0.10–6           | 2016-12-05       |

 If you're opening issues related to these, please mention the version that the issue relates to.

-
-License
-------
+## License

 Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].<br/>
-Copyright &copy; 2013–2017, Team Pa11y
-
-
+Copyright &copy; 2013–2019, Team Pa11y and contributors

 [gpl]: http://www.gnu.org/licenses/gpl-3.0.html
 [mongo]: http://www.mongodb.org/
@@ -151,10 +153,10 @@ Copyright &copy; 2013–2017, Team Pa11y
 [travis-img]: https://travis-ci.org/pa11y/dashboard.png?branch=master
 [troubleshooting]: https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md

-[info-license]: LICENSE
 [info-node]: package.json
 [info-build]: https://travis-ci.org/pa11y/pa11y-dashboard
-[shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg
-[shield-node]: https://img.shields.io/badge/node.js%20support-4–6-brightgreen.svg
-[shield-version]: https://img.shields.io/badge/version-2.4.2-blue.svg
+[info-license]: LICENSE
+[shield-version]: https://img.shields.io/github/package-json/v/pa11y/pa11y-dashboard.svg
+[shield-node]: https://img.shields.io/node/v/pa11y/pa11y-dashboard.svg
 [shield-build]: https://img.shields.io/travis/pa11y/pa11y-dashboard/master.svg
+[shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg
--- a/app.js
+++ b/app.js
@@ -93,7 +93,6 @@ function initApp(config, callback) {
 	// Load routes
 	require('./route/index')(app);
 	require('./route/task/index')(app);
-	require('./route/result/index')(app);
 	require('./route/result/download')(app);
 	if (!config.readonly) {
 		require('./route/new')(app);
@@ -103,6 +102,8 @@ function initApp(config, callback) {
 		require('./route/task/ignore')(app);
 		require('./route/task/unignore')(app);
 	}
+	// Needs to be loaded after `/route/task/edit`
+	require('./route/result/index')(app);

 	// Error handling
 	app.express.get('*', (request, response) => {
--- a/index.js
+++ b/index.js
@@ -51,8 +51,10 @@ require('./app')(config, (error, app) => {

 			console.log('');
 			console.log(chalk.underline.cyan('Pa11y Webservice started'));
-			console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);
-			console.log(chalk.grey('uri:  %s'), webservice.server.info.uri);
+			console.log(chalk.grey('mode:     %s'), process.env.NODE_ENV);
+			console.log(chalk.grey('uri:      %s'), webservice.server.info.uri);
+			console.log(chalk.grey('database: %s'), config.webservice.database);
+			console.log(chalk.grey('cron:     %s'), config.webservice.cron);
 		});
 	}

--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "pa11y-dashboard",
-  "version": "2.4.2",
+  "version": "3.1.0",
  "private": true,
  "description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
  "keywords": [
@@ -21,31 +21,31 @@
  "bugs": "https://github.com/pa11y/dashboard/issues",
  "license": "GPL-3.0",
  "engines": {
-    "node": ">=4"
+    "node": ">=8",
+    "npm": ">=6"
  },
  "dependencies": {
-    "body-parser": "^1.18.3",
-    "chalk": "~1.1",
-    "compression": "^1.7.2",
-    "express": "^4.16.3",
-    "express-hbs": "~1.0",
-    "http-headers": "^3.0.1",
-    "moment": "^2.22.2",
-    "npm": "^6.1.0",
-    "pa11y-webservice": "^2.3.1",
-    "pa11y-webservice-client-node": "^1.2.1",
-    "underscore": "~1.8"
+    "body-parser": "~1.19.0",
+    "chalk": "~2.4.2",
+    "compression": "~1.7.4",
+    "express-hbs": "~2.1.2",
+    "express": "~4.17.1",
+    "http-headers": "~3.0.2",
+    "moment": "~2.24.0",
+    "pa11y-webservice-client-node": "~2.0.0",
+    "pa11y-webservice": "~3.1.2",
+    "underscore": "~1.9.1"
  },
  "devDependencies": {
-    "bower": "~1.7",
-    "cheerio": "~0.20",
-    "eslint": "^3.18.0",
-    "less": "~2.7",
-    "mocha": "^2",
-    "pa11y-lint-config": "^1.0.0",
-    "proclaim": "^3",
-    "request": "^2.74",
-    "uglify-js": "~2.6"
+    "bower": "^1.8.8",
+    "cheerio": "^1.0.0-rc.3",
+    "eslint": "^6.4.0",
+    "less": "^3.10.3",
+    "mocha": "^6.2.0",
+    "pa11y-lint-config": "^1.2.1",
+    "proclaim": "^3.6.0",
+    "request": "^2.88.0",
+    "uglify-js": "^3.6.0"
  },
  "scripts": {
    "start": "node index.js",
--- a/test/integration/route/index.js
+++ b/test/integration/route/index.js
@@ -40,10 +40,11 @@ describe.only('GET /', function() {

 	it('should display all of the expected tasks', function() {
 		const tasks = this.last.dom('[data-test=task]');
-		assert.strictEqual(tasks.length, 3);
+		assert.strictEqual(tasks.length, 4);
 		assert.match(tasks.eq(0).text(), /npg home\s+\(wcag2aa\)/i);
 		assert.match(tasks.eq(1).text(), /npg home\s+\(wcag2aaa\)/i);
 		assert.match(tasks.eq(2).text(), /nature news\s+\(section508\)/i);
+		assert.match(tasks.eq(3).text(), /z integration test\s+\(wcag2aa\)/i);
 	});

 	it('should have links to each task', function() {
@@ -51,6 +52,7 @@ describe.only('GET /', function() {
 		assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001"]').length, 1);
 		assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002"]').length, 1);
 		assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003"]').length, 1);
+		assert.strictEqual(tasks.eq(3).find('[href="/abc000000000000000000004"]').length, 1);
 	});

 	it('should display an "Edit" button for each task', function() {
@@ -58,6 +60,7 @@ describe.only('GET /', function() {
 		assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/edit"]').length, 1);
 		assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/edit"]').length, 1);
 		assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/edit"]').length, 1);
+		assert.strictEqual(tasks.eq(3).find('[href="/abc000000000000000000004/edit"]').length, 1);
 	});

 	it('should display a "Delete" button for each task', function() {
@@ -65,6 +68,7 @@ describe.only('GET /', function() {
 		assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/delete"]').length, 1);
 		assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/delete"]').length, 1);
 		assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/delete"]').length, 1);
+		assert.strictEqual(tasks.eq(3).find('[href="/abc000000000000000000004/delete"]').length, 1);
 	});

 	it('should display a "Run" button for each task', function() {
@@ -72,6 +76,7 @@ describe.only('GET /', function() {
 		assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/run"]').length, 1);
 		assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/run"]').length, 1);
 		assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/run"]').length, 1);
+		assert.strictEqual(tasks.eq(3).find('[href="/abc000000000000000000004/run"]').length, 1);
 	});

 	it('should display the task result counts if the task has been run', function() {
--- a/view/layout/default.html
+++ b/view/layout/default.html
@@ -27,7 +27,7 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.

 	{{#if noindex}}<meta name="robots" content="noindex"/>{{/if}}

-	<link rel="icon" type="image/png" href="favicon.png" />
+	<link rel="icon" type="image/png" href="/favicon.png" />

 	<!-- For mobile devices. -->
 	<meta name="viewport" content="width=device-width"/>
Author	SHA1	Message	Date
Jose Bolos	ea3183791c	Version 3.1.0 (#246 ) * Version 3.1.0 Also minor bump to pa11y-webservice * Bump webservice so it includes data fixtures	2019-09-27 11:44:24 +01:00
Jose Bolos	102a237d2e	Bump webservice version and other deps (#245 )	2019-09-20 15:59:21 +01:00
Jose Bolos	7c77467dcf	Fix incorrect values being passed to ObjectID (#244 ) Due to the routes being defined in the wrong order, certain urls (e.g. `/tasks/:taskid:/edit`) are being captured by the results route instead (e.g. `/tasks/:taskid:/:resultid:`). This is causing the wrong method to being called with parts of the path like `edit`, `run`, etc. being passed as an argument to ObjectID(). As these are not valid MongoDB IDs, the method displays instead an error message: > Argument passed in must be a single String of 12 bytes or a string of 24 hex characters Also change the path to the favicon image to be not relative, as this is causing a `favicon.png` string to be sent as an argument to ObjectID() when visiting certain pages due to the previous issue.	2019-09-20 14:57:15 +01:00
Jose Bolos	2de7e59f44	Bump webservice to 3.0.1 (#243 ) Fixes a problem with tests not running when cron jobs are triggered.	2019-09-13 15:14:36 +01:00
Jeremy Englert	c7bd2a53b6	Adds new images to Readme (#239 )	2019-08-01 09:20:02 +01:00
Jose Bolos	350f94a0d4	Version 3.0.0 (#236 ) Includes several updates to the migration guide and the README.	2019-07-16 15:16:06 +01:00
Jose Bolos	a5ce220509	Update all dependencies and standardise versions (#235 )	2019-07-16 14:08:27 +01:00
Jose Bolos	ce07206899	Update dependencies (#234 ) * Bumps pa11y-webservice and client to the new versions requiring node 8+ * Update tests to account for the new URL. Integration tests now include a localhost URL, this updates the tests to reflect that. * Increase test timeout to avoid travis failing	2019-07-16 13:41:39 +01:00
Juga Paazmaya	1609c8d667	Updates Node.js min version to 8 and removes npm as dependency (#228 ) * Update Node.js min version to 8 and remove npm as dependency * Test against Node.js 8 and 10 at Travis * Add Node.js v12 in Travis	2019-05-15 12:32:20 +01:00
Jose Bolos	c1dcbf4436	Adds debugging info to startup log (#225 ) There are two ways of setting a configuration for this app: config files, and environment variables. This makes it easy for the app to run with a different config from the one that you intend to run it with. Currently, only the NODE_ENV variable and server url are being printed out on startup. This PR adds the database config and the cron config to the details being displayed. This may help debug configuration issues, database issues, and specially making easier to understand what config is being used when for example running in a container.	2019-05-15 10:57:08 +01:00
James Loveridge	ef769d95e1	Add MongoDB installation instructions for Mac/Linux (#218 )	2018-10-24 20:19:35 +01:00