testaro 64.8.9 → 64.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "64.8.9",
+  "version": "64.9.1",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/getLocatorData.js

@@ -101,3 +101,47 @@ exports.getLocatorData = async loc => {
     return null;
   }
 };
+// Returns location data from the extract of a standard instance.
+exports.getLocationData = async (page, excerpt) => {
+  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#"/);
+  // If the excerpt contains a Testaro identifier:
+  if (testaroIDArray) {
+    const testaroID = testaroIDArray[1];
+    // Return location data for the element.
+    return await page.evaluate(testaroID => {
+      const element = document.querySelector(`[data-testaro-id="${testaroID}#"]`);
+      // If any element has that identifier:
+      if (element) {
+        // Get box and path IDs for the element.
+        const box = {};
+        let boxID = '';
+        const boundingBox = element.getBoundingClientRect() || {};
+        if (boundingBox.x) {
+          ['x', 'y', 'width', 'height'].forEach(coordinate => {
+            box[coordinate] = Math.round(boundingBox[coordinate]);
+          });
+        }
+        if (typeof box.x === 'number') {
+          boxID = Object.values(box).join(':');
+        }
+        const pathID = window.getXPath(element) || '';
+        // Return them.
+        return {
+          boxID,
+          pathID
+        };
+      }
+      // Otherwise, i.e. if no element has it, return empty location data.
+      return {};
+    }, testaroID);
+  }
+  // Otherwise, i.e. if the extract contains no Testaro identifier:
+  else {
+    // Return a non-DOM location.
+    return {
+      notInDOM: true,
+      boxID: '',
+      pathID: ''
+    };
+  }
+};

package/procs/identify.js

@@ -83,6 +83,21 @@ const addIDs = async (locator, recipient) => {
         recipient.pathID = pathID;
       }
     }
+    // Normalize the path ID.
+    const xPathSegments = recipient.pathID.split('/');
+    const normalizedSegments = xPathSegments.map(segment => {
+      if (segment === '') {
+        return '';
+      }
+      if (['html', 'body'].includes(segment)) {
+        return segment;
+      }
+      if (segment.endsWith(']')) {
+        return segment;
+      }
+      return `${segment}[1]`;
+    });
+    recipient.pathID = normalizedSegments.join('/');
   }
 };
 // Sanitizes a tag name.
@@ -101,115 +116,112 @@ const tagify = tagName => {
 };
 // Returns the XPath and box ID of the element of a standard instance.
 exports.identify = async (instance, page) => {
-  // If the instance does not yet have both boxID and pathID properties:
-  if (['boxID', 'pathID'].some(key => instance[key] === undefined)) {
-    // Initialize a result.
-    const elementID = {
-      boxID: '',
-      pathID: ''
-    };
-    const {excerpt, id, location} = instance;
-    const tagName = tagify(instance.tagName);
-    const {type, spec} = location;
-    // If the instance specifies a CSS selector or XPath location:
-    if (['selector', 'xpath'].includes(type)) {
-      // Get locators for elements with that specifier.
-      let specifier = spec;
-      if (type === 'xpath') {
-        specifier = spec.replace(/\/text\(\)\[\d+\]$/, '');
-      }
-      if (specifier) {
-        if (type === 'xpath') {
-          specifier = `xpath=${specifier}`;
-        }
-        try {
-          const locators = page.locator(specifier);
-          // Get their count, or throw an error if the specifier is invalid.
-          const locatorCount = await locators.count();
-          // If the specifier is valid and the count is 1:
-          if (locatorCount === 1) {
-            // Add a box ID and a path ID to the result.
-            await addIDs(locators, elementID);
-          }
-          /*
-            Otherwise, if the specifier is valid, the count is not 1, and the instance specifies
-            an XPath location:
-          */
-          else if (type === 'xpath') {
-            // Use the XPath location as the path ID.
-            elementID.pathID = spec;
-          }
-        }
-        // If the specifier is invalid:
-        catch(error) {
-          // Add this to the instance.
-          instance.invalidity = {
-            badProperty: 'location',
-            validityError: error.message
-          };
-        }
-      }
+  // Initialize a result.
+  const elementID = {
+    boxID: '',
+    pathID: ''
+  };
+  const {excerpt, id, location} = instance;
+  const tagName = tagify(instance.tagName);
+  const {type, spec} = location;
+  // If the instance specifies a CSS selector or XPath location:
+  if (['selector', 'xpath'].includes(type)) {
+    // Get locators for elements with that specifier.
+    let specifier = spec;
+    if (type === 'xpath') {
+      specifier = spec.replace(/\/text\(\)\[\d+\]$/, '');
     }
-    // If either ID remains undefined and the instance specifies an element ID:
-    if (id && ! (elementID.boxID && elementID.pathID)) {
-      // Get the first locator for an element with the ID.
-      try {
-        let locator = page.locator(`#${id.replace(/([-&;/]|^\d)/g, '\\$1')}`).first();
-        // Add a box ID and a path ID to the result.
-        await addIDs(locator, elementID);
-      }
-      // If the identifier is invalid:
-      catch(error) {
-        // Add this to the instance.
-        instance.invalidity = {
-          badProperty: 'id',
-          validityError: error.message
-        };
+    if (specifier) {
+      if (type === 'xpath') {
+        specifier = `xpath=${specifier}`;
       }
-    }
-    // If either ID remains undefined and the instance specifies a tag name:
-    if (tagName && ! (elementID.boxID && elementID.pathID)) {
       try {
-        // Get locators for elements with the tag name.
-        let locators = page.locator(tagName);
-        // If there is exactly 1 of them:
-        let locatorCount = await locators.count();
+        const locators = page.locator(specifier);
+        // Get their count, or throw an error if the specifier is invalid.
+        const locatorCount = await locators.count();
+        // If the specifier is valid and the count is 1:
         if (locatorCount === 1) {
           // Add a box ID and a path ID to the result.
           await addIDs(locators, elementID);
         }
-        // If either ID remains undefined and the instance also specifies an excerpt:
-        if (excerpt && ! (elementID.boxID && elementID.pathID)) {
-          // Get the plain text parts of the excerpt, converting ... to an empty string.
-          const minTagExcerpt = excerpt.replace(/<[^>]+>/g, '<>');
-          const plainParts = (minTagExcerpt.match(/[^<>]+/g) || [])
-          .map(part => part === '...' ? '' : part);
-          // Get the longest of them.
-          const sortedPlainParts = plainParts.sort((a, b) => b.length - a.length);
-          const mainPart = sortedPlainParts.length ? sortedPlainParts[0] : '';
-          // If there is one:
-          if (mainPart.trim().replace(/\s+/g, '').length) {
-            // Get locators for elements with the tag name and the text.
-            const locators = page.locator(tagName.toLowerCase(), {hasText: mainPart});
-            // If there is exactly 1 of them:
-            const locatorCount = await locators.count();
-            if (locatorCount === 1) {
-              // Add a box ID and a path ID to the result.
-              await addIDs(locators, elementID);
-            }
-          }
+        /*
+          Otherwise, if the specifier is valid, the count is not 1, and the instance specifies
+          an XPath location:
+        */
+        else if (type === 'xpath') {
+          // Use the XPath location as the path ID.
+          elementID.pathID = spec;
         }
       }
-      // If the tag name is invalid:
+      // If the specifier is invalid:
       catch(error) {
         // Add this to the instance.
         instance.invalidity = {
-          badProperty: 'tagName',
+          badProperty: 'location',
           validityError: error.message
         };
       }
     }
-    // Return the result.
-    return elementID;
   }
+  // If either ID remains undefined and the instance specifies an element ID:
+  if (id && ! (elementID.boxID && elementID.pathID)) {
+    // Get the first locator for an element with the ID.
+    try {
+      let locator = page.locator(`#${id.replace(/([-&;/]|^\d)/g, '\\$1')}`).first();
+      // Add a box ID and a path ID to the result.
+      await addIDs(locator, elementID);
+    }
+    // If the identifier is invalid:
+    catch(error) {
+      // Add this to the instance.
+      instance.invalidity = {
+        badProperty: 'id',
+        validityError: error.message
+      };
+    }
+  }
+  // If either ID remains undefined and the instance specifies a tag name:
+  if (tagName && ! (elementID.boxID && elementID.pathID)) {
+    try {
+      // Get locators for elements with the tag name.
+      let locators = page.locator(tagName);
+      // If there is exactly 1 of them:
+      let locatorCount = await locators.count();
+      if (locatorCount === 1) {
+        // Add a box ID and a path ID to the result.
+        await addIDs(locators, elementID);
+      }
+      // If either ID remains undefined and the instance also specifies an excerpt:
+      if (excerpt && ! (elementID.boxID && elementID.pathID)) {
+        // Get the plain text parts of the excerpt, converting ... to an empty string.
+        const minTagExcerpt = excerpt.replace(/<[^>]+>/g, '<>');
+        const plainParts = (minTagExcerpt.match(/[^<>]+/g) || [])
+        .map(part => part === '...' ? '' : part);
+        // Get the longest of them.
+        const sortedPlainParts = plainParts.sort((a, b) => b.length - a.length);
+        const mainPart = sortedPlainParts.length ? sortedPlainParts[0] : '';
+        // If there is one:
+        if (mainPart.trim().replace(/\s+/g, '').length) {
+          // Get locators for elements with the tag name and the text.
+          const locators = page.locator(tagName.toLowerCase(), {hasText: mainPart});
+          // If there is exactly 1 of them:
+          const locatorCount = await locators.count();
+          if (locatorCount === 1) {
+            // Add a box ID and a path ID to the result.
+            await addIDs(locators, elementID);
+          }
+        }
+      }
+    }
+    // If the tag name is invalid:
+    catch(error) {
+      // Add this to the instance.
+      instance.invalidity = {
+        badProperty: 'tagName',
+        validityError: error.message
+      };
+    }
+  }
+  // Return the result.
+  return elementID;
 };

package/procs/nu.js

@@ -15,7 +15,9 @@
 // ########## IMPORTS
 
 // Module to add Testaro IDs to elements.
-const {addTestaroIDs, getLocationData} = require('./testaro');
+const {addTestaroIDs} = require('./testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('./getLocatorData');
 // Module to get the document source.
 const {getSource} = require('./getSource');
 

package/procs/testaro.js

@@ -234,47 +234,3 @@ exports.addTestaroIDs = async page => {
     }
   });
 };
-// Returns location data from the extract of a standard instance.
-exports.getLocationData = async (page, excerpt) => {
-  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#"/);
-  // If the excerpt contains a Testaro identifier:
-  if (testaroIDArray) {
-    const testaroID = testaroIDArray[1];
-    // Return location data for the element.
-    return await page.evaluate(testaroID => {
-      const element = document.querySelector(`[data-testaro-id="${testaroID}#"]`);
-      // If any element has that identifier:
-      if (element) {
-        // Get box and path IDs for the element.
-        const box = {};
-        let boxID = '';
-        const boundingBox = element.getBoundingClientRect() || {};
-        if (boundingBox.x) {
-          ['x', 'y', 'width', 'height'].forEach(coordinate => {
-            box[coordinate] = Math.round(boundingBox[coordinate]);
-          });
-        }
-        if (typeof box.x === 'number') {
-          boxID = Object.values(box).join(':');
-        }
-        const pathID = window.getXPath(element) || '';
-        // Return them.
-        return {
-          boxID,
-          pathID
-        };
-      }
-      // Otherwise, i.e. if no element has it, return empty location data.
-      return {};
-    }, testaroID);
-  }
-  // Otherwise, i.e. if the extract contains no Testaro identifier:
-  else {
-    // Return a non-DOM location.
-    return {
-      notInDOM: true,
-      boxID: '',
-      pathID: ''
-    };
-  }
-};

package/run.js

@@ -438,22 +438,19 @@ const launch = exports.launch = async (
               const parent = element.parentNode;
               // If (abnormally) the parent node is not an element:
               if (!parent || parent.nodeType !== Node.ELEMENT_NODE) {
-                // Prepend it to the segment array.
+                // Prepend the element (not the parent) to the segment array.
                 segments.unshift(tag);
                 // Stop traversing, leaving the segment array partial.
                 break;
               }
-              let subscript = '';
-              // Get the subscript of the element.
+              // Get the subscript of the element if it is not the body element.
               const cohort = Array
               .from(parent.childNodes)
               .filter(
                 childNode => childNode.nodeType === Node.ELEMENT_NODE
                 && childNode.tagName === element.tagName
               );
-              if (cohort.length > 1) {
-                subscript = `[${cohort.indexOf(element) + 1}]`;
-              }
+              const subscript = tag === 'body' ? '' : `[${cohort.indexOf(element) + 1}]`;
               // Prepend the element identifier to the segment array.
               segments.unshift(`${tag}${subscript}`);
               // Continue the traversal with the parent of the current element.
@@ -1649,14 +1646,18 @@ const doActs = async (report, opts = {}) => {
           };
           // Populate it.
           standardize(act);
-          // Add a box ID and a path ID to each of its standard instances if missing.
+          // For each of its standard instances:
           for (const instance of act.standardResult.instances) {
             const elementID = await identify(instance, page);
+            // If a box ID is missing:
             if (! instance.boxID) {
+              // Add one.
               instance.boxID = elementID ? elementID.boxID : '';
             }
-            if (! instance.pathID) {
-              instance.pathID = elementID ? elementID.pathID : '';
+            // If a path ID is missing or different:
+            if (instance.pathID !== elementID.pathID) {
+              // Add a box ID and a path ID to each of its standard instances if missing.
+              instance.pathID = elementID.pathID;
             }
           };
           // If the original-format result is not to be included in the report:

package/tests/htmlcs.js

@@ -1,5 +1,6 @@
 /*
   © 2022–2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -15,7 +16,9 @@
 // IMPORTS
 
 // Module to add and use unique element IDs.
-const {addTestaroIDs, getLocationData} = require('../procs/testaro');
+const {addTestaroIDs} = require('../procs/testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('../procs/getLocatorData');
 // Module to handle files.
 const fs = require('fs/promises');
 
@@ -91,7 +94,7 @@ exports.reporter = async (page, report, actIndex) => {
       // If it is an error or a warning (not a notice):
       else if (['Error', 'Warning'].includes(parts[0])) {
         /*
-          Add the violation to an violationClass.violationCode.description array in the result.
+          Add the violation to a violationClass.violationCode.description array in the result.
           This saves space, because, although some descriptions are violation-specific, such as
           descriptions that state the contrast ratio of an element, most descriptions are
           generic, so typically many violations share a description.

package/tests/wax.js

@@ -16,7 +16,9 @@
 // IMPORTS
 
 // Module to add and use unique element IDs.
-const {addTestaroIDs, getLocationData} = require('../procs/testaro');
+const {addTestaroIDs} = require('../procs/testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('../procs/getLocatorData');
 // Modules to run WAX.
 const runWax = require('@wally-ax/wax-dev');
 const waxDev = {runWax};