testaro 12.7.3 → 13.0.0

package/README.md

@@ -639,6 +639,14 @@ The URL from which Testaro requests jobs is given by the fourth passed argument,
 
 The URL to which Testaro sends reports is given by the `sources.sendReportTo` property of each job, if the property exists, or, if not, by `process.env.REPORT_URL`.
 
+##### Job isolation
+
+If you execute a repeating watch and the watch process becomes corrupted, the corruption can damage an indefinite subsequent sequence of job performances. Under some conditions, for example, Playwright has been observed to throw errors with a message starting with “Navigation timeout of 30000 ms exceeded” and ending with the entire HTML content of the web page, even when page navigation has been subjected to shorter time limits. Thereafter, Playwright issues that error message again about every 15 seconds, even if the browser has been closed.
+
+To counteract such corruption, you can perform repeating directory watches with job isolation. To do this, use the statement `node dirWatch n`, where `n` is the number of seconds Testaro should wait after finding no job before looking again. The `dirWatch` module spawns a new process for each job, and also shrinks Playwright error messages before they are logged on the console.
+
+You can stop a repeating directory watch of this kind by entering `CTRL-c`.
+
 ### Environment variables
 
 In addition to their uses described above, environment variables can be used by acts of type `text`, as documented in the `actSpecs.js` file.

package/dirWatch.js

@@ -0,0 +1,47 @@
+/*
+  dirWatch.js
+  Module for launching a one-time directory watch.
+*/
+
+// ########## IMPORTS
+
+// Module to spawn a child process.
+const {spawn} = require('node:child_process');
+
+// ########## CONSTANTS
+
+const interval = process.argv[2];
+
+// ########## FUNCTIONS
+
+// Spawns a one-time directory watch.
+const spawnWatch = (command, args) => spawn(command, args, {stdio: ['inherit', 'inherit', 'pipe']});
+// Repeatedly spawns a one-time directory watch.
+const reWatch = () => {
+  const watcher = spawnWatch('node', ['call', 'watch', 'true', 'false', interval]);
+  let error = '';
+  watcher.stderr.on('data', data => {
+    error += data.toString();
+  });
+  watcher.on('close', async code => {
+    if (error) {
+      if (error.startsWith('Navigation timeout of 30000 ms exceeded')) {
+        console.log('ERROR: Playwright claims 30-second timeout exceeded');
+      }
+      else {
+        console.log(`ERROR: ${error.slice(0, 200)}`);
+      }
+    }
+    if (code === 0) {
+      console.log('Watcher exited successfully');
+    }
+    else {
+      console.log(`Watcher exited with error code ${code}`);
+    }
+    reWatch();
+  });
+};
+
+// ########## OPERATION
+
+reWatch();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "12.7.3",
+  "version": "13.0.0",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/run.js

@@ -302,11 +302,15 @@ const nowString = () => (new Date()).toISOString().slice(0, 19);
 // Closes the current browser.
 const browserClose = async () => {
   if (browser) {
-    const contexts = browser.contexts();
+    const browserType = browser.browserType().name();
+    let contexts = browser.contexts();
     for (const context of contexts) {
       await context.close();
+      contexts = browser.contexts();
     }
     await browser.close();
+    browser = null;
+    console.log(`${browserType} browser closed`);
   }
 };
 // Returns the first line of an error message.
@@ -319,7 +323,12 @@ const launch = async (report, typeName, lowMotion = false) => {
     // Close the current browser, if any.
     await browserClose();
     // Launch a browser of that type.
-    const browserOptions = {};
+    const browserOptions = {
+      logger: {
+        isEnabled: (name, severity) => false,
+        log: (name, severity, message, args) => console.log(message.slice(0, 100))
+      }
+    };
     if (debug) {
       browserOptions.headless = false;
     }
@@ -375,7 +384,10 @@ const launch = async (report, typeName, lowMotion = false) => {
             report.jobData.errorLogSize += msgLength;
           }
           const msgLC = msgText.toLowerCase();
-          if (msgText.includes('403') && (msgLC.includes('status') || msgLC.includes('prohibited'))) {
+          if (
+            msgText.includes('403') && (msgLC.includes('status')
+            || msgLC.includes('prohibited'))
+          ) {
             report.jobData.prohibitedCount++;
           }
         });
@@ -694,41 +706,31 @@ const doActs = async (report, actIndex, page) => {
           // Identify the URL.
           const resolved = act.which.replace('__dirname', __dirname);
           requestedURL = resolved;
-          // Visit it and wait until the network is idle.
           const {strict} = report;
-          let response = await goTo(report, page, requestedURL, 15000, 'networkidle', strict);
+          // Visit it and wait until the DOM is loaded.
+          response = await goTo(report, page, requestedURL, 15000, 'domcontentloaded', strict);
           // If the visit fails:
           if (response.error) {
-            // Try again until the DOM is loaded.
+            // Launch another browser type.
+            const newBrowserName = Object.keys(browserTypeNames)
+            .find(name => name !== browserTypeName);
+            console.log(`>> Launching ${newBrowserName} instead`);
+            await launch(newBrowserName);
+            // Identify its only page as current.
+            page = browserContext.pages()[0];
+            // Visit the URL and wait until the DOM is loaded.
             response = await goTo(report, page, requestedURL, 10000, 'domcontentloaded', strict);
             // If the visit fails:
             if (response.error) {
-              // Launch another browser type.
-              const newBrowserName = Object.keys(browserTypeNames)
-              .find(name => name !== browserTypeName);
-              console.log(`>> Launching ${newBrowserName} instead`);
-              await launch(newBrowserName);
-              // Identify its only page as current.
-              page = browserContext.pages()[0];
-              // Try again until the network is idle.
-              response = await goTo(report, page, requestedURL, 10000, 'networkidle', strict);
+              // Try again and wait until a load.
+              response = await goTo(report, page, requestedURL, 5000, 'load', strict);
               // If the visit fails:
               if (response.error) {
-                // Try again until the DOM is loaded.
-                response = await goTo(report, page, requestedURL, 5000, 'domcontentloaded', strict);
-                // If the visit fails:
-                if (response.error) {
-                  // Try again or until a load.
-                  response = await goTo(report, page, requestedURL, 5000, 'load', strict);
-                  // If the visit fails:
-                  if (response.error) {
-                    // Navigate to a blank page instead.
-                    await page.goto('about:blank')
-                    .catch(error => {
-                      console.log(`ERROR: Navigation to blank page failed (${error.message})`);
-                    });
-                  }
-                }
+                // Navigate to a blank page instead.
+                await page.goto('about:blank')
+                .catch(error => {
+                  console.log(`ERROR: Navigation to blank page failed (${error.message})`);
+                });
               }
             }
           }
@@ -1505,7 +1507,6 @@ const doActs = async (report, actIndex, page) => {
   else if (! report.jobData.abortTime) {
     console.log('Acts completed');
     await browserClose();
-    console.log('Browser closed');
   }
 };
 /*

package/tests/dupAtt.js

@@ -50,14 +50,12 @@ exports.reporter = async (page, withItems) => {
   rawPage = rawPage.replace(/<(script [^<>]+)>.*?<\/script>/g, '$1');
   // Remove any comments from it.
   rawPage = rawPage.replace(/<!--.*?-->/g, '');
-  console.log(rawPage);
   // Extract the opening tags of its elements.
   let elements = rawPage.match(/<[a-zA-Z][^<>]+>/g);
   // Delete their enclosing angle brackets and the values of any attributes in them.
   elements = elements.map(el => el.replace(/^< *|=[^ ]*| *>$/g, ''));
   // For each element:
   elements.forEach(element => {
-    console.log(element);
     // Identify its tag name and attributes.
     const terms = element.split(' ');
     // If it has 2 or more attributes:

package/tests/ibm.js

@@ -26,7 +26,7 @@ const run = async (content, timeLimit) => {
   });
   // Return the result of the test, or null if it timed out.
   try {
-    const ibmReport = await getCompliance(content, nowLabel);
+    const ibmReport = getCompliance(content, nowLabel);
     const result = await Promise.race([ibmReport, timeout]);
     clearTimeout(timeoutID);
     return result;

package/watch.js

@@ -214,14 +214,13 @@ const runJob = async (job, isDirWatch) => {
   }
 };
 // Checks for a job, performs it, and submits a report, once or repeatedly.
-exports.cycle = async (isDirWatch, isForever, interval, watchee = null) => {
-  const intervalMS = 1000 * Number.parseInt(interval);
+exports.cycle = async (isDirWatch, isForever, interval = 300, watchee = null) => {
   let statusOK = true;
   // Prevent a wait before the first iteration.
   let empty = false;
-  console.log(
-    `Watching started with intervals of ${interval} seconds when idle (${nowString()})`
-  );
+  const intervalMS = 1000 * Number.parseInt(interval);
+  const intervalSpec = isForever ? `with intervals of ${interval} seconds when idle ` : '';
+  console.log(`Watching started ${intervalSpec}(${nowString()})`);
   while (statusOK) {
     if (empty) {
       await wait(intervalMS);