pa11y-ci-reporter-runner 3.0.1 → 4.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 - 2023 Aaron Goldenthal
+Copyright (c) 2022 - 2024 Aaron Goldenthal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.js

@@ -8,7 +8,7 @@
  * @module pa11y-ci-reporter-runner
  */
 
-const fs = require('fs');
+const fs = require('node:fs');
 const formatter = require('./lib/formatter');
 const reporterBuilder = require('./lib/reporter-builder');
 const createConfig = require('./lib/config');

package/lib/pa11yci-machine.js

@@ -13,10 +13,10 @@ const { createMachine, assign } = require('xstate');
  */
 const pa11yciMachine = createMachine(
     {
-        context: {
-            urlIndex: 0,
-            urls: []
-        },
+        context: ({ input }) => ({
+            urlIndex: input.urlIndex,
+            urls: input.urls
+        }),
         id: 'pa11yci-runner',
         initial: 'init',
         // Opting in for v4, will be default in xstate v5
@@ -34,7 +34,7 @@ const pa11yciMachine = createMachine(
             beforeAll: {
                 on: {
                     NEXT: [
-                        { target: 'beginUrl', cond: 'hasUrls' },
+                        { target: 'beginUrl', guard: 'hasUrls' },
                         { target: 'afterAll' }
                     ],
                     RESET: { target: 'init' }
@@ -49,7 +49,7 @@ const pa11yciMachine = createMachine(
             urlResults: {
                 on: {
                     NEXT: [
-                        { target: 'afterAll', cond: 'isLastUrl' },
+                        { target: 'afterAll', guard: 'isLastUrl' },
                         { target: 'beginUrl', actions: 'incrementUrl' }
                     ],
                     RESET: { target: 'init' }
@@ -66,15 +66,16 @@ const pa11yciMachine = createMachine(
     {
         actions: {
             incrementUrl: assign({
-                urlIndex: (context) => context.urlIndex + 1
+                urlIndex: ({ context }) => context.urlIndex + 1
             }),
             setInitialUrlIndex: assign({
                 urlIndex: () => 0
             })
         },
         guards: {
-            hasUrls: (context) => context.urls.length > 0,
-            isLastUrl: (context) => context.urlIndex === context.urls.length - 1
+            hasUrls: ({ context }) => context.urls.length > 0,
+            isLastUrl: ({ context }) =>
+                context.urlIndex === context.urls.length - 1
         }
     }
 );

package/lib/pa11yci-service.js

@@ -7,6 +7,7 @@
  * @module pa11yci-service
  */
 
+const { createActor, getNextSnapshot } = require('xstate');
 const machine = require('./pa11yci-machine');
 const RunnerStates = require('./runner-states');
 
@@ -38,6 +39,14 @@ const StateTypes = Object.freeze({
     next: 'next'
 });
 
+/**
+ * Generates a machine event object for the given event type.
+ *
+ * @param   {string} eventType The type of event (a MachineEvents value).
+ * @returns {object}           The machine event object.
+ */
+const getMachineEvent = (eventType) => ({ type: eventType });
+
 /**
  * Gets the initial pa11yci-runner state machine context given an array of URLs.
  *
@@ -68,6 +77,7 @@ const hasUrl = (state) =>
  * @private
  */
 const getUrlForState = (machineState) =>
+    // Only a subset of states have an associated URL
     hasUrl(machineState.value)
         ? // User supplied input used to index user supplied data file
           // nosemgrep: eslint.detect-object-injection
@@ -126,12 +136,17 @@ const getStateSummary = (machineState) => ({
 const serviceFactory = (urls, actions) => {
     let pendingCommand;
 
-    // Implement custom xstate interpreter, which allows for tracking for current
+    // Implement custom xstate actor, which allows for tracking for current
     // and the next state, which is required for some control functions.
-    const pa11yMachine = machine.withContext(getInitialContext(urls));
-    let currentState = pa11yMachine.initialState;
-    // Machine.transition is a pure function, so only retrieves the state
-    let nextState = machine.transition(currentState, MachineEvents.NEXT);
+    const pa11yActor = createActor(machine, {
+        input: getInitialContext(urls)
+    });
+    let currentState = pa11yActor.getSnapshot();
+    let nextState = getNextSnapshot(
+        machine,
+        currentState,
+        getMachineEvent(MachineEvents.NEXT)
+    );
 
     /**
      * Validates that a command is allowed in the given state. Throws if invalid.
@@ -167,24 +182,28 @@ const serviceFactory = (urls, actions) => {
             pendingCommand = true;
 
             // Send event to the machine and executes the action for the
-            // current state (except in init, which has no action)
-            currentState = machine.transition(currentState, event);
+            // new current state (except in init, which has no action).
+            currentState = getNextSnapshot(
+                machine,
+                currentState,
+                getMachineEvent(event)
+            );
             if (currentState.value !== 'init') {
-                // Value is internal object state
+                // Value is internal object state.
                 // nosemgrep: eslint.detect-object-injection, unsafe-dynamic-method
                 await actions[currentState.value](getUrlForState(currentState));
             }
 
-            // Check next state and save for reference (machine.transition
-            // is a pure function, so only retrieves the state)
+            // Check next state and save for reference.
             if (currentState.value !== finalState) {
-                nextState = machine.transition(
+                nextState = getNextSnapshot(
+                    machine,
                     currentState,
-                    MachineEvents.NEXT
+                    getMachineEvent(MachineEvents.NEXT)
                 );
             }
         } finally {
-            // Ensure pending command is reset in all cases, including on error
+            // Ensure pending command is reset in all cases, including on error.
             pendingCommand = false;
         }
     };

package/lib/reporter-builder.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const path = require('path');
+const path = require('node:path');
 
 const reporterMethods = ['beforeAll', 'begin', 'results', 'error', 'afterAll'];
 const noop = () => {};

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "pa11y-ci-reporter-runner",
-  "version": "3.0.1",
+  "version": "4.1.0",
   "description": "Pa11y CI Reporter Runner is designed to facilitate testing of Pa11y CI reporters. Given a Pa11y CI JSON results file and optional configuration it simulates the Pa11y CI calls to the reporter.",
   "main": "index.js",
   "scripts": {
-    "build-types": "tsc index.js --declaration --allowJs --emitDeclarationOnly",
-    "hooks-pre-commit": "npm run lint && npm run prettier-check",
-    "hooks-pre-push": "npm audit --audit-level=critical && npm test",
-    "lint": "npm run lint-js && npm run lint-md",
-    "lint-js": "eslint .",
-    "lint-md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#Archive\"",
-    "prettier-check": "prettier --check .",
-    "prettier-fix": "prettier --write .",
+    "build:types": "tsc index.js --declaration --allowJs --emitDeclarationOnly",
+    "hooks:pre-commit": "npm run lint && npm run prettier:check",
+    "hooks:pre-push": "npm audit --audit-level=critical && npm test",
+    "lint": "npm run lint:js && npm run lint:md",
+    "lint:js": "eslint .",
+    "lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#Archive\"",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
     "test": "jest --ci",
-    "test-types": "tsd"
+    "test:types": "tsd"
   },
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
   "author": "Aaron Goldenthal <npm@aarongoldenthal.com>",
   "license": "MIT",
   "engines": {
-    "node": "^16.13.0 || ^18.12.0 || >=20.0.0"
+    "node": "^18.12.0 || >=20.0.0"
   },
   "files": [
     "index.d.ts",
@@ -41,18 +41,18 @@
   },
   "homepage": "https://gitlab.com/gitlab-ci-utils/pa11y-ci-reporter-runner",
   "devDependencies": {
-    "@aarongoldenthal/eslint-config-standard": "^23.1.1",
-    "eslint": "^8.47.0",
-    "jest": "^29.6.2",
+    "@aarongoldenthal/eslint-config-standard": "^25.0.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "markdownlint-cli2": "^0.8.1",
+    "markdownlint-cli2": "^0.11.0",
     "pa11y-ci-reporter-cli-summary": "^3.0.0",
-    "prettier": "^3.0.1",
-    "tsd": "^0.28.1",
-    "typescript": "^5.1.6"
+    "prettier": "^3.1.1",
+    "tsd": "^0.30.3",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
     "lodash": "^4.17.21",
-    "xstate": "^4.38.2"
+    "xstate": "^5.5.1"
   }
 }