testaro 60.8.4 → 60.10.0

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "testaro",
-  "version": "60.8.4",
+  "version": "60.10.0",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {
+    "build:nameComputation": "esbuild src/nameComputation.js --bundle --format=iife --global-name=computeAccessibleName --outfile=dist/nameComputation.js",
+    "build": "npm run build:nameComputation",
+    "deps": "npm update && npx playwright install && npm run build",
     "tests": "node validation/executors/tests",
     "test": "node validation/executors/test",
     "run": "node validation/executors/run",
@@ -47,6 +50,8 @@
     "puppeteer-extra-plugin-stealth": "*"
   },
   "devDependencies": {
+    "dom-accessibility-api": "*",
+    "esbuild": "*",
     "eslint": "*"
   }
 }

package/procs/doTestAct.js

@@ -39,19 +39,12 @@ const os = require('os');
 
 // CONSTANTS
 
-const headedBrowser = process.env.HEADED_BROWSER === 'true';
-const debug = process.env.DEBUG === 'true';
-const waits = Number.parseInt(process.env.WAITS) || 0;
 const tmpDir = os.tmpdir();
 
-// VARIABLES
-
-const actIndex = Number.parseInt(process.argv[2]);
-
 // FUNCTIONS
 
 // Performs the tests of the act specified by the caller.
-const doTestAct = async () => {
+const doTestAct = async actIndex => {
   const reportPath = `${tmpDir}/report.json`;
   // Get the report from the temporary directory.
   const reportJSON = await fs.readFile(reportPath, 'utf8');
@@ -68,6 +61,7 @@ const doTestAct = async () => {
     // Launch a browser, navigate to the URL, and update the run-module page export.
     await launch(
       report,
+      actIndex,
       'high',
       browserID,
       targetURL
@@ -88,7 +82,7 @@ const doTestAct = async () => {
       page = require('../run').page;
     }
   }
-  // If the page exists:
+  // If the page exists or the tool is Testaro:
   if (page || which === 'testaro') {
     try {
       // Make the act reporter perform the specified tests of the tool.
@@ -142,4 +136,4 @@ const doTestAct = async () => {
   }
 };
 
-doTestAct();
+doTestAct(Number.parseInt(process.argv[2]));

package/run.js

@@ -111,7 +111,6 @@ const tmpDir = os.tmpdir();
 // Facts about the current session.
 let actCount = 0;
 // Facts about the current act.
-let actIndex = 0;
 let browser;
 let cleanupInProgress = false;
 let browserCloseIntentional = false;
@@ -290,9 +289,9 @@ const browserClose = exports.browserClose = async () => {
 };
 // Launches a browser and navigates to a URL.
 const launch = exports.launch = async (
-  report, headEmulation, tempBrowserID, tempURL, retries = 2
+  report, actIndex, headEmulation, tempBrowserID, tempURL, retries = 2
 ) => {
-  const act = report.acts[actIndex];
+  const act = report.acts[actIndex] || {};
   const {device} = report;
   const deviceID = device && device.id;
   const browserID = tempBrowserID || report.browserID || '';
@@ -435,10 +434,8 @@ const launch = exports.launch = async (
       page = await browserContext.newPage();
       // Wait until it is stable.
       await page.waitForLoadState('domcontentloaded', {timeout: 5000});
-      const isTestaroTest = act.type === 'test' && act.which === 'testaro';
-      // Add a script to the page to:
-      await page.addInitScript(isTestaroTest => {
-        // Mask automation detection.
+      // Add a script to the page to mask automation detection.
+      await page.addInitScript(() => {
         Object.defineProperty(navigator, 'webdriver', {get: () => undefined});
         window.chrome = {runtime: {}};
         Object.defineProperty(navigator, 'plugins', {
@@ -447,8 +444,21 @@ const launch = exports.launch = async (
         Object.defineProperty(navigator, 'languages', {
           get: () => ['en-US', 'en']
         });
-        // If the act is a testaro test act:
-        if (isTestaroTest) {
+      });
+      const isTestaroTest = act.type === 'test' && act.which === 'testaro';
+      // If the act is a testaro test act:
+      if (isTestaroTest) {
+        // Add a script to the page to compute the accessible name of an element.
+        await page.addInitScript({path: require.resolve('./dist/nameComputation.js')});
+        // Add a script to the page to:
+        await page.addInitScript(() => {
+          // Add a window method to compute the accessible name of an element.
+          window.getAccessibleName = element => {
+            const nameIsComputable = element
+            && element.nodeType === Node.ELEMENT_NODE
+            && typeof window.computeAccessibleName === 'function';
+            return nameIsComputable ? window.computeAccessibleName(element) : '';
+          };
           // Add a window method to return an instance.
           window.getInstance = (
             element, ruleID, what, count = 1, ordinalSeverity, summaryTagName = ''
@@ -551,8 +561,8 @@ const launch = exports.launch = async (
             // Return the XPath.
             return `/${segments.join('/')}`;
           };
-        }
-      }, isTestaroTest);
+        });
+      }
       // Navigate to the specified URL.
       const navResult = await goTo(report, page, url, 15000, 'domcontentloaded');
       // If the navigation succeeded:
@@ -594,7 +604,7 @@ const launch = exports.launch = async (
         );
         await wait(1000 * waitSeconds + 100);
         // Then retry the launch and navigation.
-        return launch(report, headEmulation, tempBrowserID, tempURL, retries - 1);
+        return launch(report, actIndex, headEmulation, tempBrowserID, tempURL, retries - 1);
       }
       // Otherwise, i.e. if no retries remain:
       else {
@@ -819,9 +829,8 @@ const doActs = async (report, opts = {}) => {
   const standard = report.standard || 'only';
   const reportPath = `${tmpDir}/report.json`;
   // For each act in the report.
-  for (const doActsIndex in acts) {
+  for (const actIndex in acts) {
     if (signal && signal.aborted) throw new Error('doActs aborted');
-    actIndex = doActsIndex;
     // If the job has not been aborted:
     if (report.jobData && ! report.jobData.aborted) {
       let act = acts[actIndex];
@@ -899,6 +908,7 @@ const doActs = async (report, opts = {}) => {
         // Launch a browser, navigate to a page, and add the result to the act.
         await launch(
           report,
+          actIndex,
           'high',
           actLaunchSpecs[0],
           actLaunchSpecs[1]
@@ -1649,6 +1659,7 @@ const doActs = async (report, opts = {}) => {
       // Replace the browser and navigate to the URL.
       await launch(
         report,
+        '',
         'high',
         specs[0],
         specs[1]

package/src/nameComputation.js

@@ -0,0 +1,5 @@
+// src/nameComputation.js
+
+const {computeAccessibleName} = require('dom-accessibility-api');
+
+window.computeAccessibleName = computeAccessibleName;

package/testaro/autocomplete.js

@@ -1,5 +1,6 @@
 /*
   © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool. All rights reserved.
 
   MIT License
 
@@ -27,59 +28,74 @@
   This test reports failures to equip name and email inputs with correct autocomplete attributes.
 */
 
-// ########## IMPORTS
-
-// Module to perform common operations.
-const {init, getRuleResult} = require('../procs/testaro');
-// Module to get locator data.
-const {getLocatorData} = require('../procs/getLocatorData');
-
-// ########## FUNCTIONS
+// FUNCTIONS
 
 // Runs the test and returns the result.
 exports.reporter = async (
   page,
   withItems,
+  nameLabels = ['your name', 'full name', 'first and last name'],
+  emailLabels = ['email'],
   givenLabels = ['first name', 'forename', 'given name'],
-  familyLabels = ['last name', 'surname', 'family name'],
-  emailLabels = ['email']
+  familyLabels = ['last name', 'surname', 'family name']
 ) => {
-  // Initialize the locators and result.
-  const all = await init(100, page, 'input[type=text], input[type=email], input:not([type])');
-  // For each locator:
-  const autoValues = {
-    'given-name': givenLabels,
-    'family-name': familyLabels,
-    'email': emailLabels
-  };
-  for (const loc of all.allLocs) {
-    // Get which autocomplete value, if any, its element needs.
-    const elData = await getLocatorData(loc);
-    const lcText = elData.excerpt.toLowerCase();
-    const neededAutos = Object.keys(autoValues)
-    .filter(autoValue => autoValues[autoValue].some(typeLabel => lcText.includes(typeLabel)));
-    let neededAuto;
-    if (neededAutos.length === 1) {
-      neededAuto = neededAutos[0];
-    }
-    else if (! neededAutos.length && await loc.getAttribute('type') === 'email') {
-      neededAuto = 'email';
-    }
-    // If it needs one:
-    if (neededAuto) {
-      // If it does not have the one it needs:
-      const actualAuto = await loc.getAttribute('autocomplete');
-      const isBad = actualAuto !== neededAuto;
-      if (isBad) {
-        // Add the locator to the array of violators.
-        all.locs.push([loc, neededAuto]);
+  // Return totals and standard instances for the rule.
+  return await page.evaluate(args => {
+    const [withItems, nameLabels,givenLabels, familyLabels, emailLabels] = args;
+    // Get all candidates, i.e. text and email input elements.
+    const candidates = document.body.querySelectorAll(
+      'input[type=text], input[type=email], input:not([type])'
+    );
+    let violationCount = 0;
+    const instances = [];
+    // For each candidate:
+    candidates.forEach(candidate => {
+      // Get its lower-cased accessible name.
+      const name = window.getAccessibleName(candidate).toLowerCase();
+      // Get its required autocomplete value.
+      let requiredAuto = '';
+      if (candidate.type === 'email' || name && emailLabels.some(label => name.includes(label))) {
+        requiredAuto = 'email';
+      }
+      else if (
+        name && candidate.type === 'text' && nameLabels.some(label => name.includes(label))
+      ) {
+        requiredAuto = 'name';
       }
+      else if (
+        name && candidate.type === 'text' && givenLabels.some(label => name.includes(label))
+      ) {
+        requiredAuto = 'given-name';
+      }
+      else if (
+        name && candidate.type === 'text' && familyLabels.some(label => name.includes(label))
+      ) {
+        requiredAuto = 'family-name';
+      }
+      // Get its actual autocomplete value.
+      const actualAuto = candidate.getAttribute('autocomplete');
+      // If an autocomplete value is required but not present:
+      if (requiredAuto && ! (actualAuto && actualAuto.includes(requiredAuto))) {
+        // Increment the violation count.
+        violationCount++;
+        // If itemization is required:
+        if (withItems) {
+          const what = `input has no autocomplete="${requiredAuto}" attribute`;
+          // Add an instance to the instances.
+          instances.push(window.getInstance(candidate, 'autocomplete', what, 1, 2));
+        }
+      }
+    });
+    // If there were any violations and itemization is not required:
+    if (violationCount && ! withItems) {
+      const what = 'Inputs are missing required autocomplete attributes';
+      // Add a summary instance to the instances.
+      instances.push(window.getInstance(null, 'autocomplete', what, violationCount, 2));
+    }
+    return {
+      data: {},
+      totals: [0, 0, violationCount, 0],
+      standardInstances: instances
     }
-  }
-  // Populate and return the result.
-  const whats = [
-    'Input is missing an autocomplete attribute with value __param__',
-    'Inputs are missing applicable autocomplete attributes'
-  ];
-  return await getRuleResult(withItems, all, 'autocomplete', whats, 2);
+  }, [withItems, nameLabels, givenLabels, familyLabels, emailLabels]);
 };

package/tests/testaro.js

@@ -552,6 +552,7 @@ exports.reporter = async (page, report, actIndex) => {
       // Replace the browser and the page and navigate to the target.
       await launch(
         report,
+        actIndex,
         headEmulation,
         browserID,
         url
@@ -663,6 +664,7 @@ exports.reporter = async (page, report, actIndex) => {
             // Replace the browser and the page in the run module and navigate to the target.
             await launch(
               report,
+              actIndex,
               headEmulation,
               report.browserID,
               url