testaro 32.2.0 → 32.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "32.2.0",
+  "version": "32.2.2",
   "description": "Run 960 web accessibility tests from 9 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/run.js

@@ -422,6 +422,8 @@ const launch = async (report, typeName, url, debug, waits, isLowMotion = false)
     // Open a context (i.e. browser tab), with reduced motion if specified.
     const options = {reduceMotion: isLowMotion ? 'reduce' : 'no-preference'};
     const browserContext = await browser.newContext(options);
+    // Prevent default timeouts, including those arising from a Playwright bug.
+    browserContext.setDefaultTimeout(0);
     // When a page (i.e. browser tab) is added to the browser context (i.e. browser window):
     browserContext.on('page', async page => {
       // If it emits a message:

package/tests/qualWeb.js

@@ -42,6 +42,7 @@ const clusterOptions = {
 exports.reporter = async (page, options) => {
   const {withNewContent, rules} = options;
   const data = {};
+  let result = {};
   // Start the QualWeb core engine.
   await qualWeb.start(clusterOptions);
   // Specify the invariant test options.
@@ -61,143 +62,154 @@ exports.reporter = async (page, options) => {
     }
   };
   // Specify a URL or provide the content.
-  if (withNewContent) {
-    qualWebOptions.url = page.url();
-  }
-  else {
-    qualWebOptions.html = await page.content();
-  }
-  // Specify which rules to test for.
-  const actSpec = rules ? rules.find(typeRules => typeRules.startsWith('act:')) : null;
-  const wcagSpec = rules ? rules.find(typeRules => typeRules.startsWith('wcag:')) : null;
-  const bestSpec = rules ? rules.find(typeRules => typeRules.startsWith('best:')) : null;
-  if (actSpec) {
-    if (actSpec === 'act:') {
-      qualWebOptions.execute.act = false;
+  try {
+    if (withNewContent) {
+      qualWebOptions.url = page.url();
     }
     else {
-      const actRules = actSpec.slice(4).split(',').map(num => `QW-ACT-R${num}`);
-      qualWebOptions['act-rules'] = {rules: actRules};
+      qualWebOptions.html = await page.content();
+    }
+    // Specify which rules to test for.
+    const actSpec = rules ? rules.find(typeRules => typeRules.startsWith('act:')) : null;
+    const wcagSpec = rules ? rules.find(typeRules => typeRules.startsWith('wcag:')) : null;
+    const bestSpec = rules ? rules.find(typeRules => typeRules.startsWith('best:')) : null;
+    if (actSpec) {
+      if (actSpec === 'act:') {
+        qualWebOptions.execute.act = false;
+      }
+      else {
+        const actRules = actSpec.slice(4).split(',').map(num => `QW-ACT-R${num}`);
+        qualWebOptions['act-rules'] = {rules: actRules};
+        qualWebOptions.execute.act = true;
+      }
+    }
+    else {
+      qualWebOptions['act-rules'] = {
+        levels: ['A', 'AA', 'AAA'],
+        principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
+      };
       qualWebOptions.execute.act = true;
     }
-  }
-  else {
-    qualWebOptions['act-rules'] = {
-      levels: ['A', 'AA', 'AAA'],
-      principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
-    };
-    qualWebOptions.execute.act = true;
-  }
-  if (wcagSpec) {
-    if (wcagSpec === 'wcag:') {
-      qualWebOptions.execute.wcag = false;
+    if (wcagSpec) {
+      if (wcagSpec === 'wcag:') {
+        qualWebOptions.execute.wcag = false;
+      }
+      else {
+        const wcagTechniques = wcagSpec.slice(5).split(',').map(num => `QW-WCAG-T${num}`);
+        qualWebOptions['wcag-techniques'] = {techniques: wcagTechniques};
+        qualWebOptions.execute.wcag = true;
+      }
     }
     else {
-      const wcagTechniques = wcagSpec.slice(5).split(',').map(num => `QW-WCAG-T${num}`);
-      qualWebOptions['wcag-techniques'] = {techniques: wcagTechniques};
+      qualWebOptions['wcag-techniques'] = {
+        levels: ['A', 'AA', 'AAA'],
+        principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
+      };
       qualWebOptions.execute.wcag = true;
     }
-  }
-  else {
-    qualWebOptions['wcag-techniques'] = {
-      levels: ['A', 'AA', 'AAA'],
-      principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
-    };
-    qualWebOptions.execute.wcag = true;
-  }
-  if (bestSpec) {
-    if (bestSpec === 'best:') {
-      qualWebOptions.execute.bp = false;
+    if (bestSpec) {
+      if (bestSpec === 'best:') {
+        qualWebOptions.execute.bp = false;
+      }
+      else {
+        const bestPractices = bestSpec.slice(5).split(',').map(num => `QW-BP${num}`);
+        qualWebOptions['best-practices'] = {bestPractices};
+        // qualWebOptions.execute.bp = true;
+        // Temporarily disable best practices, because they crash QualWeb.
+        qualWebOptions.execute.bp = false;
+      }
     }
     else {
-      const bestPractices = bestSpec.slice(5).split(',').map(num => `QW-BP${num}`);
-      qualWebOptions['best-practices'] = {bestPractices};
       // qualWebOptions.execute.bp = true;
       // Temporarily disable best practices, because they crash QualWeb.
       qualWebOptions.execute.bp = false;
     }
-  }
-  else {
-    // qualWebOptions.execute.bp = true;
-    // Temporarily disable best practices, because they crash QualWeb.
-    qualWebOptions.execute.bp = false;
-  }
-  // Get the report.
-  let actReports = await qualWeb.evaluate(qualWebOptions);
-  // Remove the copy of the DOM from it.
-  const result = actReports[withNewContent ? qualWebOptions.url : 'customHtml'];
-  if (result && result.system && result.system.page && result.system.page.dom) {
-    delete result.system.page.dom;
-    // For each test section of the act report:
-    const {modules} = result;
-    if (modules) {
-      for (const section of ['act-rules', 'wcag-techniques', 'best-practices']) {
-        if (qualWebOptions[section]) {
-          if (modules[section]) {
-            const {assertions} = modules[section];
-            if (assertions) {
-              const ruleIDs = Object.keys(assertions);
-              ruleIDs.forEach(ruleID => {
-                // Remove passing results.
-                const ruleAssertions = assertions[ruleID];
-                const {metadata} = ruleAssertions;
-                if (metadata) {
-                  if (metadata.warning === 0 && metadata.failed === 0) {
-                    delete assertions[ruleID];
-                  }
-                  else {
-                    if (ruleAssertions.results) {
-                      ruleAssertions.results = ruleAssertions.results.filter(
-                        raResult => raResult.verdict !== 'passed'
-                      );
+    // Get the report.
+    let actReports = await qualWeb.evaluate(qualWebOptions);
+    // Remove the copy of the DOM from it.
+    result = actReports[withNewContent ? qualWebOptions.url : 'customHtml'];
+    if (result && result.system && result.system.page && result.system.page.dom) {
+      delete result.system.page.dom;
+      // For each test section of the act report:
+      const {modules} = result;
+      if (modules) {
+        for (const section of ['act-rules', 'wcag-techniques', 'best-practices']) {
+          if (qualWebOptions[section]) {
+            if (modules[section]) {
+              const {assertions} = modules[section];
+              if (assertions) {
+                const ruleIDs = Object.keys(assertions);
+                ruleIDs.forEach(ruleID => {
+                  // Remove passing results.
+                  const ruleAssertions = assertions[ruleID];
+                  const {metadata} = ruleAssertions;
+                  if (metadata) {
+                    if (metadata.warning === 0 && metadata.failed === 0) {
+                      delete assertions[ruleID];
                     }
-                  }
-                }
-                // Shorten long HTML codes of elements.
-                const {results} = ruleAssertions;
-                results.forEach(raResult => {
-                  const {elements} = raResult;
-                  if (elements && elements.length) {
-                    elements.forEach(element => {
-                      if (element.htmlCode && element.htmlCode.length > 700) {
-                        element.htmlCode = `${element.htmlCode.slice(0, 700)} …`;
+                    else {
+                      if (ruleAssertions.results) {
+                        ruleAssertions.results = ruleAssertions.results.filter(
+                          raResult => raResult.verdict !== 'passed'
+                        );
                       }
-                    });
+                    }
                   }
+                  // Shorten long HTML codes of elements.
+                  const {results} = ruleAssertions;
+                  results.forEach(raResult => {
+                    const {elements} = raResult;
+                    if (elements && elements.length) {
+                      elements.forEach(element => {
+                        if (element.htmlCode && element.htmlCode.length > 700) {
+                          element.htmlCode = `${element.htmlCode.slice(0, 700)} …`;
+                        }
+                      });
+                    }
+                  });
                 });
-              });
+              }
+              else {
+                data.prevented = true;
+                data.error = 'ERROR: No assertions';
+              }
             }
             else {
               data.prevented = true;
-              data.error = 'ERROR: No assertions';
+              data.error = `ERROR: No ${section} section`;
             }
           }
-          else {
-            data.prevented = true;
-            data.error = `ERROR: No ${section} section`;
-          }
         }
       }
+      else {
+        data.prevented = true;
+        data.error = 'ERROR: No modules';
+      }
     }
     else {
       data.prevented = true;
-      data.error = 'ERROR: No modules';
+      data.error = 'ERROR: No DOM';
     }
-  }
-  else {
-    data.prevented = true;
-    data.error = 'ERROR: No DOM';
-  }
-  // Stop the QualWeb core engine.
-  await qualWeb.stop();
-  // Return the result.
-  try {
-    JSON.stringify(result);
+    // Stop the QualWeb core engine.
+    await qualWeb.stop();
+    // Return the result.
+    try {
+      JSON.stringify(result);
+    }
+    catch(error) {
+      const message = `ERROR: qualWeb result cannot be made JSON (${error.message})`;
+      data.prevented = true;
+      data.error = message;
+    };
   }
   catch(error) {
-    const message = `ERROR: qualWeb result cannot be made JSON (${error.message})`;
+    const message = error.message.slice(0, 200);
     data.prevented = true;
     data.error = message;
+    result = {
+      prevented: true,
+      error: message
+    };
   };
   return {
     data,