Add option to override timeouts for larger scans

Author: Finholt

README.md

@@ -48,6 +48,8 @@ package = "netlify-plugin-a11y"
 
   # resultMode = "warn" # is "error" by default
 
+  # timeout = 60000 # in milliseconds; is 30000 by default
+
   # # Developer only
   # debugMode = true # extra logging for plugin developers
 ```

manifest.yml

@@ -7,6 +7,8 @@ inputs:
     required: false
   - name: resultMode
     default: error
+  - name: timeout
+    default: 30000
   - name: debugMode
     default: false
   - name: testMode

plugin/index.js

@@ -9,7 +9,7 @@ const pluginCore = require('./pluginCore');
 
 module.exports = {
     async onPostBuild({
-      inputs: { checkPaths, ignoreDirectories, resultMode, debugMode },
+      inputs: { checkPaths, ignoreDirectories, resultMode, timeout, debugMode },
       constants: { PUBLISH_DIR },
       utils: { build }
     }) {
@@ -24,6 +24,7 @@ module.exports = {
       const results = await pluginCore.runPa11y({
         htmlFilePaths,
         build,
+        timeout,
         debugMode
       });
 

plugin/pluginCore.js

@@ -4,8 +4,8 @@ const pa11y = require('pa11y');
 const readdirp = require('readdirp')
 const { isDirectory, isFile } = require('path-type')
 
-exports.runPa11y = async function({ htmlFilePaths, build, testMode, debugMode }) {
-  let results = await Promise.all(htmlFilePaths.map(htmlFilePath => runPa11yOnFile(htmlFilePath, build)));
+exports.runPa11y = async function({ htmlFilePaths, build, timeout, testMode, debugMode }) {
+  let results = await Promise.all(htmlFilePaths.map(htmlFilePath => runPa11yOnFile(htmlFilePath, build, timeout)));
   results = results
     .filter((res) => res.issues.length)
     .map((res) =>
@@ -25,9 +25,9 @@ exports.runPa11y = async function({ htmlFilePaths, build, testMode, debugMode })
   return flattenedResults;
 };
 
-const runPa11yOnFile = async function(htmlFilePath, build) {
+const runPa11yOnFile = async function(htmlFilePath, build, timeout) {
   try {
-    return await pa11y(htmlFilePath)
+    return await pa11y(htmlFilePath, {timeout, chromeLaunchConfig: {timeout}})
   } catch (error) {
     build.failBuild(`pa11y failed`, { error })
   }

tests/runPa11y/this.test.js

@@ -6,7 +6,8 @@ const pluginCore = require('../../plugin/pluginCore.js');
 test('runPa11y works', async () => {
   const results = await pluginCore.runPa11y({
     htmlFilePaths: [path.join(__dirname, 'publishDir/index.html')],
-    build: { failBuild() {} }
+    build: { failBuild() {} },
+    timeout: 30000
   });
   expect(results).toMatchSnapshot();
 });