@suffolklitlab/alkiln 5.15.1 → 5.15.2

package/CHANGELOG.md

@@ -45,6 +45,12 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+## [5.15.2] - 2025-11-29
+
+### Fixed
+
+- Fixed race condition between navigating and extracting button text.
+
 ## [5.15.1] - 2025-08-05
 
 ### Changed

package/lib/scope.js

@@ -254,23 +254,21 @@ module.exports = {
     if ( options.waitForTimeout ) { await time.waitForTimeout( options.waitForTimeout ); }
   },  // Ends afterStep
 
-  tapElementAndNavigate: async function(scope, { elem, waitForTimeout=0 }) {
-    /** Tap a given element, detect navigation, and do appropriate related things.
-     *  TODO: not quite sure if we'll be using `waitForTimeout`. */
+  tapElementAndNavigate: async function(scope, { elem, waitForTimeout=null }) {
+    /** Tap a given element, detect navigation, and do appropriate related things. */
 
     let start_url = await scope.page.url();  // so we can later check for navigation
 
     await scope.tapElementAndStayOnPage(scope, {
       elem,
-      click_promise: Promise.all([
-        scope.page.waitForNavigation({ waitUntil: 'domcontentloaded' }),
-        elem.evaluate( (el) => { return el.click(); })
-      ])
+      promise_returners: [
+        () => { return scope.nav_race(scope, {}).result; },
+        () => { return elem.evaluate( (el) => { return el.click(); }) },
+      ]
     });
 
-    // TODO: Not sure how to detect navigation landing at same page, such as
-    // with a user input validation error. Does that count as navigating?
-    // Maybe url change + trigger var change? Maybe just trigger var?
+    // For other ideas for detecting navigation, see
+    // https://github.com/SuffolkLITLab/ALKiln/issues/229
     let end_url = await scope.page.url();
     let navigated = start_url !== end_url;
 
@@ -282,36 +280,77 @@ module.exports = {
       let { question_has_id, id, id_matches } = await scope.examinePageID( scope, 'none to match' );
 
       // If navigation, wait for 200ms to let things finish loading and moving
-      await scope.afterStep(scope, { waitForTimeout: 200, navigated: true });
+      await scope.afterStep(scope, {
+        waitForTimeout: ( waitForTimeout || 200 ),
+        navigated: true
+      });
     } else {
-      await scope.afterStep(scope, { waitForTimeout, navigated: false });
+      // Discuss: Fail here or later since the test didn't manage to navigate?
+      await scope.afterStep(scope, {
+        waitForTimeout: ( waitForTimeout || 0 ),
+        navigated: false
+      });
     }
   },  // Ends scope.tapElementAndNavigate()
 
-  tapElementAndStayOnPage: async function(scope, { elem, click_promise }) {
+  nav_race: function(scope, opts={}) {
+    /**
+     * Return a Promise for a race that detects which, if any, navigation result
+     * a navigation had.
+     * 
+     * Warning: Unable to effectively add event listener for `daPageLoad`. Gets
+     * overwritten on every page load.
+     * 
+     * @returns
+     *   { obj }
+     *     ok { bool } - True if no unexpected errors
+     *     messages {[ str ]} - Any error or info messages
+     *     errors {[ Error ]} - Any Errors that happened
+     *     result { Promise } with result of { obj } - HTTP response or other data
+     *     aborters {[ obj ]} - Abort signals for all the Promises involved
+     * */
+    let ok, messages, errors;
+    let aborters = [];
+
+    let result = Promise.race([
+      scope.page.waitForNavigation({ waitUntil: 'domcontentloaded' }),
+    ]);
+
+    return { result, aborters, ok, messages, errors, };
+  },  // Ends scope.nav_race()
+
+  tapElementAndStayOnPage: async function(scope, { elem, promise_returners=null }) {
     /** Tap a given element, detect navigation, and do appropriate related things.
-    *  `click_promise can be any kind of Promise, including a Promise.all()
+     * 
+     * @param elem { obj } - element to tap
+     * @param promise_returners {[ func -> Promise ]} - list of functions that
+     *     return promises
     */
     await scope.guard_against_missing_tap_element(scope, { elem });
 
     // Get the text on the button or link for a potential error message later
     let tapperText = await (await elem.getProperty('textContent')).jsonValue();
 
-    click_promise = click_promise || elem.click();
+    let click_promises = null;
+    if ( promise_returners ) {
+      click_promises = Promise.all(promise_returners.map( pr_ret => pr_ret() ));
+    } else {
+      click_promises = elem.click();
+    }
     
     // TODO: implement and use scope.handle_possible_timeout()
     try {
-      // Serever error loads page, so keeping things shorter by not looking
+      // Server error loads page, so keeping things shorter by not looking
       // for that text too. Also, puppeteer will ensure proper timeout.
       await Promise.race([
-        click_promise,
+        click_promises,
         // This is meant to detect user-visible alerts/errors,
         // not breaking errors in the testing code.
+        // No need for aborters since puppeteer has its own timeout
         scope.page.waitForSelector('.alert-danger', { visible: true }),
         scope.page.waitForSelector('.da-has-error', { visible: true }),
       ]);
     } catch ( error ) {
-
       if ( error.name === `TimeoutError` ) {
         let non_reload_report_msg = `After ALKiln tapped "${ tapperText }" it took too long to load the next page.`;
         await scope.handle_page_timeout_error( scope, { non_reload_report_data: {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.15.0-deps-2",
+  "version": "5.15.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@suffolklitlab/alkiln",
-      "version": "5.15.0-deps-2",
+      "version": "5.15.1",
       "license": "MIT",
       "dependencies": {
         "@axe-core/puppeteer": "4.7.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.15.1",
+  "version": "5.15.2",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {