testaro 67.0.0 → 68.0.0

package/procs/doTestAct.js

@@ -1,6 +1,6 @@
 /*
   © 2024–2025 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
+  © 2025–2026 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -9,18 +9,55 @@
 */
 
 /*
-  doTestAct
+  doActs
   Performs the tests of an act.
+  This file is designed to be run as a child process.
 */
 
+// ERROR LOGGING
+
+// Log uncaught exceptions.
+process.on('uncaughtException', error => {
+  console.error(`ERROR:\n${error.stack || 'Uncaught exception'}`);
+  process.exit(1);
+});
+
+// Log unhandled rejections.
+process.on('unhandledRejection', reason => {
+  console.error(`ERROR:\n${reason?.stack || 'Unhandled rejection'}`);
+  process.exit(1);
+});
+
 // IMPORTS
 
 // Module to perform file operations.
 const fs = require('fs/promises');
-//Modules to close and launch browsers.
-const {browserClose, launch} = require(`${__dirname}/../run`);
-// Module to set operating-system constants.
-const os = require('os');
+// Module to close and launch browsers.
+const {browserClose, launch} = require('./launch');
+
+// CONSTANTS
+
+/*
+  Tool XPath requirements.
+    none: Needs no script or extra load time.
+    own: Needs extra load time for its own XPath computations.
+    script: Needs the window.getXPath script.
+    attribute: Needs data-xpath attributes made with window.getXPath.
+*/
+const xPathNeeds = {
+  alfa: 'own',
+  aslint: 'own',
+  axe: 'attribute',
+  ed11y: 'script',
+  htmlcs: 'attribute',
+  ibm: 'attribute',
+  nuVal: 'attribute',
+  nuVnu: 'attribute',
+  qualWeb: 'attribute',
+  wave: 'script',
+  wax: 'attribute'
+};
+const accessibleNameNeeders = ['testaro'];
 
 // FUNCTIONS
 
@@ -52,19 +89,20 @@ const doTestAct = async (reportPath, actIndex) => {
     const browserID = act.launch && act.launch.browserID || report.browserID;
     const targetURL = act.launch && act.launch.target && act.launch.target.url || report.target.url;
     // Launch a browser, navigate to the URL, and update the run-module page export.
-    await launch(
+    page = await launch({
       report,
       actIndex,
-      'high',
-      browserID,
-      targetURL
-    );
+      tempBrowserID: browserID,
+      tempURL: targetURL,
+      xPathNeed: xPathNeeds[which] ?? 'none',
+      needsAccessibleName: accessibleNameNeeders.includes(which)
+    });
     // If the launch aborted the job:
-    if (report.jobData && report.jobData.aborted) {
-      // Close any existing browser.
-      await browserClose();
-      // Save the revised report.
+    if (report.jobData?.aborted) {
+      // Close the browser and its context, if they exist.
+      await browserClose(page);
       const reportJSON = JSON.stringify(report);
+      // Save the revised report.
       await fs.writeFile(reportPath, reportJSON);
       // Report this.
       sendMessage({
@@ -73,11 +111,6 @@ const doTestAct = async (reportPath, actIndex) => {
       });
       process.exit(1);
     }
-    // Otherwise, i.e. if the launch did not abort the job:
-    else {
-      // Get the updated page.
-      page = require('../run').page;
-    }
   }
   // If the page exists or the tool is Testaro:
   if (page || which === 'testaro') {
@@ -89,11 +122,16 @@ const doTestAct = async (reportPath, actIndex) => {
       act.result = actReport.result;
       // If the tool reported that the page prevented testing:
       if (act.data && act.data.prevented) {
+        const {standardResult} = act.result;
+        // Add this to any standard result.
+        if (standardResult) {
+          standardResult.prevented = true;
+        }
         // Add prevention data to the job data.
         report.jobData.preventions[which] = act.data.error;
       }
-      // Close any existing browser.
-      await browserClose();
+      // Close the browser and its context, if they exist.
+      await browserClose(page);
       const reportJSON = JSON.stringify(report);
       // Save the revised report.
       await fs.writeFile(reportPath, reportJSON);
@@ -105,8 +143,8 @@ const doTestAct = async (reportPath, actIndex) => {
     }
     // If the tool invocation failed:
     catch(error) {
-      // Close any existing browser.
-      await browserClose();
+      // Close the browser and its context, if they exist.
+      await browserClose(page);
       // Save the revised report.
       const reportJSON = JSON.stringify(report);
       await fs.writeFile(reportPath, reportJSON);
@@ -128,8 +166,6 @@ const doTestAct = async (reportPath, actIndex) => {
     act.data.error = 'No page';
     // Add prevention data to the job data.
     report.jobData.preventions[which] = act.data.error;
-    // Close any existing browser.
-    await browserClose();
     const reportJSON = JSON.stringify(report);
     // Save the revised report.
     await fs.writeFile(reportPath, reportJSON);
@@ -143,7 +179,6 @@ const doTestAct = async (reportPath, actIndex) => {
     process.exit(1);
   }
 };
-
 process.on('uncaughtException', error => {
   console.log(`ERROR: uncaughtException (${error.message})`);
   sendMessage({
@@ -152,7 +187,6 @@ process.on('uncaughtException', error => {
   });
   process.exit(1);
 });
-
 process.on('unhandledRejection', error => {
   const message = error && error.message ? error.message : String(error);
   console.log(`ERROR: unhandledRejection (${message})`);
@@ -162,6 +196,6 @@ process.on('unhandledRejection', error => {
   });
   process.exit(1);
 });
-
 const args = process.argv;
+// Perform the specified test act.
 doTestAct(args[2], Number.parseInt(args[3]));

package/procs/error.js

@@ -0,0 +1,53 @@
+/*
+  © 2021–2025 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025–2026 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+/*
+  error.js
+  Handles errors.
+*/
+
+// Reports a job being aborted.
+const abortActs = exports.abortActs = (report, actIndex) => {
+  // Add data on the aborted act to the report.
+  report.jobData.abortTime = nowString();
+  report.jobData.abortedAct = actIndex;
+  report.jobData.aborted = true;
+  // Report that the job is aborted.
+  console.log(`ERROR: Job aborted on act ${actIndex}`);
+};
+// Adds an error result to an act.
+exports.addError = (alsoLog, alsoAbort, report, actIndex, message) => {
+  // If the error is to be logged:
+  if (alsoLog) {
+    // Log it.
+    console.log(message);
+  }
+  const act = report.acts[actIndex ?? -1];
+  // If an act was specified:
+  if (act) {
+    // Add error data to the result.
+    act.result ??= {};
+    act.result.success ??= false;
+    act.result.error ??= message;
+    // If the act is a test act:
+    if (act.type === 'test') {
+      act.data ??= {};
+      // Add prevention data to the act data.
+      act.data.prevented = true;
+      act.data.error = message;
+      // Add prevention data to the job data.
+      report.jobData.preventions[act.which] = message;
+    }
+  };
+  // If the job is to be aborted:
+  if (alsoAbort) {
+    // Add this to the report.
+    abortActs(report, actIndex);
+  }
+};

package/procs/job.js

@@ -1,8 +1,8 @@
 /*
   © 2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2026 Jonathan Robert Pool.
 
-  Licensed under the MIT License. See LICENSE file at the project root or
-  https://opensource.org/license/mit/ for details.
+  Licensed under the MIT License. See LICENSE file at the project root or  https://opensource.org/license/mit/ for details.
 
   SPDX-License-Identifier: MIT
 */
@@ -19,20 +19,20 @@ const {actSpecs} = require('../actSpecs');
 // Data on devices.
 const {devices} = require('playwright');
 // Module to get dates from time stamps.
-const {dateOf} = require('./dateOf');
+const {dateOf} = require('./dateTime');
 
 // CONSTANTS
 
 // Names and descriptions of tools.
-const tools = exports.tools ={
+const tools = exports.tools = {
   alfa: 'Alfa',
   aslint: 'ASLint',
   axe: 'Axe',
   ed11y: 'Editoria11y',
-  htmlcs: 'HTML CodeSniffer WCAG 2.1 AA ruleset',
-  ibm: 'IBM Accessibility Checker',
-  nuVal: 'Nu Html Checker API',
-  nuVnu: 'Nu Html Checker',
+  htmlcs: 'HTML CodeSniffer',
+  ibm: 'Accessibility Checker',
+  nuVal: 'Html Checker API',
+  nuVnu: 'Html Checker',
   qualWeb: 'QualWeb',
   testaro: 'Testaro',
   wax: 'WallyAX',
@@ -167,7 +167,7 @@ const isValidAct = exports.isValidAct = act => {
     return false;
   }
 };
-// Returns blank if a job is valid, or an error message.
+// Returns whether a job is valid and, if not, why not.
 exports.isValidJob = job => {
   // If any job was provided:
   if (job) {
@@ -187,38 +187,68 @@ exports.isValidJob = job => {
     } = job;
     // Return an error for the first missing or invalid property.
     if (! id || typeof id !== 'string') {
-      return 'Bad job ID';
+      return {
+        isValid: false,
+        error: 'Bad job ID'
+      };
     }
     if (typeof strict !== 'boolean') {
-      return 'Bad job strict';
+      return {
+        isValid: false,
+        error: 'Bad job strict'
+      };
     }
     if (! ['also', 'only', 'no'].includes(standard)) {
-      return 'Bad job standard';
+      return {
+        isValid: false,
+        error: 'Bad job standard'
+      };
     }
     if (typeof observe !== 'boolean') {
-      return 'Bad job observe';
+      return {
+        isValid: false,
+        error: 'Bad job observe'
+      }
     }
     if (! isDeviceID(device.id)) {
-      return 'Bad job deviceID';
+      return {
+        isValid: false,
+        error: 'Bad job deviceID'
+      };
     }
     if (! isBrowserID(browserID)) {
-      return 'Bad job browserID';
+      return {
+        isValid: false,
+        error: 'Bad job browserID'
+      };
     }
     if (
       ! (creationTimeStamp && typeof creationTimeStamp === 'string' && dateOf(creationTimeStamp))
     ) {
-      return 'bad job creationTimeStamp';
+      return {
+        isValid: false,
+        error: 'Bad job creationTimeStamp'
+      };
     }
     if (
       ! (executionTimeStamp && typeof executionTimeStamp === 'string') && dateOf(executionTimeStamp)
     ) {
-      return 'bad job executionTimeStamp';
+      return {
+        isValid: false,
+        error: 'Bad job executionTimeStamp'
+      };
     }
     if (typeof target !== 'object' || target.url && ! isURL(target.url) || target.what === '') {
-      return 'bad job target';
+      return {
+        isValid: false,
+        error: 'Bad job target'
+      };
     }
     if (sources && typeof sources !== 'object') {
-      return 'Bad job sources';
+      return {
+        isValid: false,
+        error: 'Bad job sources'
+      };
     }
     if (
       ! acts
@@ -226,32 +256,28 @@ exports.isValidJob = job => {
       || ! acts.length
       || ! acts.every(act => act.type && typeof act.type === 'string')
     ) {
-      return 'Bad job acts';
+      return {
+        isValid: false,
+        error: 'Bad job acts'
+      };
     }
     const invalidAct = acts.find(act => ! isValidAct(act));
     if (invalidAct) {
-      return `Invalid act:\n${JSON.stringify(invalidAct, null, 2)}`;
+      return {
+        isValid: false,
+        error: `Invalid act:\n${JSON.stringify(invalidAct, null, 2)}`
+      };
     }
-    return '';
+    return {
+      isValid: true
+    };
   }
   // Otherwise, i.e. if no job was provided:
   else {
     // Return this.
-    return 'no job';
-  }
-};
-// Limits the length of and unilinearizes a string.
-exports.cap = rawString => {
-  const string = (rawString.trim() || '').replace(/[\s\u2028\u2029]+/g, ' ');
-  if (string && string.length > 1000) {
-    return `${string.slice(0, 500)} … ${string.slice(-500)}`;
-  }
-  else if (string) {
-    return string;
-  }
-  else {
-    return '';
+    return {
+      isValid: false,
+      error: 'No job'
+    };
   }
 };
-// Simplifies the spacing of a string.
-exports.tidy = string => string.replace(/\s+/g, ' ');