Use Pa11y 7, require Node 18, fix issues (#149)

* Using `npm@10` upgrade `lockfileVersion` to `3` from `1`

* Increase `package.engines.node` to `>=18` from `>=12`, and introduce `package.engines.npm` as `10`

* Use npm for scripts for linting, testing, loading fixtures

* Consistently use `npm start` to start the service

* Make linter config export slightly more straightforward

* Remove overrides which are no longer required

* Use `const` and remove override of `prefer-const` rule

* Remove object shorthand override, since it only produces a warning

* Move the final override `prefer-arrow-callback` into the tests, where it's more relevant; fix two inconsistencies in the app

* Upgrade to `hapi@~21.3` from `20.3.2`

* Start working against `pa11y@7` candidate

* Return to `node index.js &` for now

* Replace `ubuntu-20.04` with `ubuntu-latest` now that `pa11y` is upgraded

* When testing, use Node.js `18, 20` instead of `12, 14, 16`

* When publishing, use Node.js `18` instead of `12`

* Use property shorthand to placate linter

* Remove unnecessary leniency for `id-length`

* Resolve shadowing issues with different names

* Remove comments where they echoed adjacent naming

* Refer to `NODE_ENV` as `mode` instead of `environment`

* Update `ecmaVersion` to `2020` from `2017`

* Improve logging at startup

* More logging; remove unused linting override

* Use npm 10 when testing and publishing

* Test with MongoDB `7`, up from `3`

* Replace `underscore` with `lodash.groupby`

* Narrow eslint-override

* Use more method shorthand for linter

* Fix/narrow `camelcase` issues

* Reorganise routes for brevity and to resolve a couple more linter warnings

* Resolve line length warning

* Use `Array.find` for invalid action check

* Pick required values from requests and tighten id names

* Decompose and pick

* Strip out obsolete dependency `request`, replacing with `fetch`; move towards promises

* Fix typo in `.editorconfig`

* Document use of nektos/act

* Dim MongoDB chatter

* Use `throw` instead of `process.exit`

* Rewrite fixtures script as `async` and allow error to bubble

* Rename `this.last` to `this.response`

* Fix `lockfile-version` to `2`, and remove `npm` fixing/bumps

* Add `.nvmrc` as `18`

* Return to using `ubuntu-latest`, replacing `ubuntu-20.04`

* Run Mongo version tests on Node `18`, up from `12`, and fix matrix typo

* Use `pa11y@7` in place of the preview version

* Run linter on Node `18`, up from `12`

* Update copyright to `2024` from `2023`, and fix some markdown linter complaints

* Update `actions/setup-node` to `4` from `3`

* Add link to Docker Desktop

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>

* Add link to `nektosact.com` and mention other ways to install `act`

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>

* Be clearer that `act` is for locally testing GitHub Actions

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>

* Mention installation options across both Docker Desktop and `act`; use shortlinks for consistency

Co-Authored-By: Hollie Kay <1948361+hollsk@users.noreply.github.com>

---------

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>

Author: danyalaytekin

.editorconfig

@@ -1,5 +1,3 @@
-# http://editorconfig.org
-
 root = true
 
 [*]

.eslintrc.js

@@ -1,16 +1,12 @@
 'use strict';
 
-const config = module.exports = require('pa11y-lint-config/eslint/es2017');
+const pa11yConfig = require('pa11y-lint-config/eslint/es2017');
 
-// NOTE: we have to override here because we're using
-// a `for of` loop somewhere. Once this repo moves to
-// ES6 syntax, we can remove most of this
+const config = {
+	...pa11yConfig,
+	parserOptions: {
+		ecmaVersion: 2020
+	}
+};
 
-// ES5 overrides
-config.rules['no-var'] = 'off';
-config.rules['object-shorthand'] = 'off';
-config.rules['prefer-arrow-callback'] = 'off';
-config.rules['prefer-const'] = 'off';
-config.rules['prefer-rest-params'] = 'off';
-config.rules['prefer-spread'] = 'off';
-config.rules['prefer-template'] = 'off';
+module.exports = config;

.github/workflows/publish.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version: 18
           registry-url: https://registry.npmjs.org
       - run: npm ci
 

.github/workflows/tests.yml

@@ -9,33 +9,32 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version: 18
       - run: npm ci
       - run: npm run lint
 
   test:
     name: test (node ${{ matrix.node }}, mongodb ${{ matrix.mongo }})
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [12, 14, 16, 18, 20]
+        node: [18, 20]
         mongo: [latest]
         include:
-          - { node: 12, mongo: 6.0.11 }
-          - { node: 12, mongo: 5.0.22 }
-          - { node: 12, mongo: 4.4.25 }
-          - { node: 12, mongo: 3.6.23 }
-          - { node: 12, mongo: 2.6.12 }
-
+          - { node: 18, mongo: 6.0.11 }
+          - { node: 18, mongo: 5.0.22 }
+          - { node: 18, mongo: 4.4.25 }
+          - { node: 18, mongo: 3.6.23 }
+          - { node: 18, mongo: 2.6.12 }
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       - run: npm ci
-      - run: make test-unit
+      - run: npm run test:unit
 
       - name: Supply MongoDB ${{ matrix.mongo }}
         uses: supercharge/mongodb-github-action@1.5.0
@@ -47,4 +46,4 @@ jobs:
         run: NODE_ENV=test node index.js &
       - run: sleep 10s
 
-      - run: make test-integration
+      - run: npm run test:integration

.nvmrc

@@ -1 +1 @@
-14
+18

Makefile

@@ -5,8 +5,6 @@
 [![Build status][shield-build]][info-build]
 [![GPL-3.0 licensed][shield-license]][info-license]
 
----
-
 Pa11y Webservice is a Node.js service that can schedule accessibility testing for multiple URLs, using [Pa11y][pa11y].
 
 Use this service if you'd like to coordinate your testing by interacting with a restful API. For other scenarios, another Pa11y tool may be more appropriate:
@@ -136,34 +134,65 @@ There are many ways to contribute to Pa11y Webservice, we cover these in the [co
 If you're ready to contribute some code, follow the [setup guide](#setup). The project can be linted and unit tested immediately:
 
 ```sh
-make lint           # Lint the code
-make test-unit      # Run the unit tests
+npm run lint           # Lint the code
+npm run test:unit      # Run the unit tests
 ```
 
 The integration tests require the service to be running in the background, since they'll be checking its behaviour.
 
 1. Create a configuration file for the `test` mode; one can be created quickly with `cp config/test.sample.json config/test.json`
 1. Start the service in test mode with:
+
    ```sh
    NODE_ENV=test npm start &
    ```
 
    The `&` places the service into the background. An alternative approach is to run `NODE_ENV=test npm start`, suspend the process with `CTRL+z`, and finally run `bg` to place it into the background.
+
 1. ```sh
-   make test-integration    # Run the integration tests
-   make test                # Run both the integration tests and the unit tests mentioned above
+   npm run test:integration   # Run the integration tests
+   npm test                   # Run both the integration tests and the unit tests mentioned above
    ```
 
+### Locally testing the GitHub Actions workflow `test.yml`
+
+1. Install [Docker Desktop] and [Nektos Act]. You can install these directly, or with a software package manager. For example, with Homebrew:
+
+   ```sh
+   brew install --cask docker
+   brew install act
+   ```
+
+1. To check the syntax of a GitHub Actions workflow before pushing it:
+
+   ```sh
+   # Verify `test.yml`
+   act --dryrun push
+   ```
+
+   ```sh
+   # Verify `publish.yml`
+   act --dryrun release
+   ```
+
+1. To test the `push` workflow under Node.js 18 only:
+
+   ```sh
+   act push --matrix node-version:18
+   ```
+
+   Add `--verbose` for more information.
+
 ## Fixtures
 
 If you'd like to preview Pa11y Webservice or present it to someone else, we've provided some [sample tasks and results](data/fixture), which can be embedded by running one of the following commands:
 
 ```sh
-NODE_ENV=development make fixtures
+NODE_ENV=development npm run load-fixtures
 ```
 
 ```sh
-NODE_ENV=test make fixtures
+NODE_ENV=test npm run load-fixtures
 ```
 
 ## Support and migration
@@ -185,11 +214,14 @@ The following table lists the major versions available and, for each previous ma
 ## License
 
 Pa11y Webservice is licensed under the [GNU General Public License 3.0][info-license].  
-Copyright © 2013-2023, Team Pa11y and contributors
+Copyright © 2013-2024, Team Pa11y and contributors
 
 [mongo]: http://www.mongodb.org/
 [mongo-connection-string]: http://docs.mongodb.org/manual/reference/connection-string/
 [node]: http://nodejs.org/
+[Docker Desktop]: https://www.docker.com/products/docker-desktop/
+[Nektos Act]: https://nektosact.com/
+
 [pa11y]: https://github.com/pa11y/pa11y
 [pa11y-ci]: https://github.com/pa11y/pa11y-ci
 [pa11y-dashboard]: https://github.com/pa11y/pa11y-dashboard

Makefile.node

@@ -17,12 +17,9 @@
 const async = require('async');
 const Hapi = require('@hapi/hapi');
 const {MongoClient} = require('mongodb');
+const {dim} = require('kleur');
 
-module.exports = initApp;
-
-// Initialise the application
 function initApp(config, callback) {
-
 	const app = {
 		server: new Hapi.Server({
 			host: config.host,
@@ -31,82 +28,81 @@ function initApp(config, callback) {
 		db: null,
 		client: null,
 		model: {},
-		config: config
+		config
 	};
 
-	const url = config.database;
-	const client = new MongoClient(url, {
-		useNewUrlParser: true,
-		useUnifiedTopology: true
-	});
+	const client = new MongoClient(
+		config.database,
+		{
+			useNewUrlParser: true,
+			useUnifiedTopology: true
+		}
+	);
 
-	// Mongo documentation states that events need to be defined before
-	//  connect() so we can be sure that we're capturing all the events
 	client.on('timeout', () => {
-		console.log('Mongo connection timeout');
+		console.log('mongodb: connection timeout');
+	});
+
+	client.on('connect', () => {
+		console.log(dim('mongodb: connected'));
 	});
 
 	client.on('close', () => {
-		console.log('Mongo connection closed');
+		console.log(dim('mongodb: connection closed'));
 	});
 
 	client.on('reconnect', () => {
-		console.log('Mongo connection reestablished');
+		console.log(dim('mongodb: connection reestablished'));
 	});
 
-	async.series([
-		next => {
-			/* eslint camelcase: 'off' */
-
-			client.connect(error => {
-				console.log('Connected successfully to server');
-				const db = client.db();
-				app.client = client;
-				app.db = db;
-
-				next(error);
-			});
-		},
-
-		next => {
-			require('./model/result')(app, (error, model) => {
-				app.model.result = model;
-				next(error);
-			});
-		},
-
-		next => {
-			require('./model/task')(app, (error, model) => {
-				app.model.task = model;
-				next(error);
-			});
-		},
-
-		next => {
-			if (!config.dbOnly && process.env.NODE_ENV !== 'test') {
-				require('./task/pa11y')(config, app);
-			}
-			next();
-		},
-
-		next => {
-			if (config.dbOnly) {
-				return next();
+	async.series(
+		[
+			next => {
+				client.connect(error => {
+					app.client = client;
+					app.db = client.db();
+
+					next(error);
+				});
+			},
+			next => {
+				require('./model/result')(app, (error, model) => {
+					app.model.result = model;
+					next(error);
+				});
+			},
+			next => {
+				require('./model/task')(app, (error, model) => {
+					app.model.task = model;
+					next(error);
+				});
+			},
+			next => {
+				if (!config.dbOnly && process.env.NODE_ENV !== 'test') {
+					require('./task/pa11y')(config, app);
+				}
+				next();
+			},
+			next => {
+				if (config.dbOnly) {
+					return next();
+				}
+
+				require('./route/index')(app);
+				require('./route/tasks')(app);
+				require('./route/task')(app);
+
+				app.server.start()
+					.then(
+						() => next(),
+						error => next(error)
+					);
+
+				console.log(`Server running at: ${app.server.info.uri}`);
 			}
-
-			require('./route/index')(app);
-			require('./route/tasks')(app);
-			require('./route/task')(app);
-
-			app.server.start()
-				.then(
-					() => next(),
-					error => next(error)
-				);
-
-			console.log(`Server running at: ${app.server.info.uri}`);
-		}
-
-	], error => callback(error, app));
-
+		],
+		error => callback(error, app)
+	);
 }
+
+module.exports = initApp;