@suffolklitlab/alkiln 5.13.0 → 5.13.1

package/lib/scope.js

@@ -171,7 +171,7 @@ module.exports = {
     // If something might be hidden or shown, wait extra time to let it hide or show
     // I think `.$()` does not use a timeout
     let showif = await scope.page.$('.dashowif');
-    if ( showif ) { await scope.page.waitForTimeout( scope.showif_timeout ); }
+    if ( showif ) { await time.waitForTimeout( scope.showif_timeout ); }
   },
 
   waitForTab: async function waitForTab(scope, { tab_id }) {
@@ -288,9 +288,7 @@ module.exports = {
     /** Tap a given element, detect navigation, and do appropriate related things.
     *  `click_promise can be any kind of Promise, including a Promise.all()
     */
-    let msg = `Cannot find the element to tap.`;
-    if ( !elem ) { reports.addToReport(scope, { type: `error`, code: `ALK0102`, value: msg }); }
-    expect( elem, msg ).to.exist;
+    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();
@@ -326,6 +324,14 @@ module.exports = {
     }  // ends try/catch
   },  // Ends scope.tapElementAndStayOnPage()
 
+  guard_against_missing_tap_element: async function(scope, { elem }) {
+    /** Handle the error message for a missing tap element, if it's missing. */
+    let msg = `Cannot find the element to tap.`;
+    if ( !elem ) { reports.addToReport(scope, { type: `error`, code: `ALK0102`, value: msg }); }
+    expect( elem, msg ).to.exist;
+    return elem;
+  },
+
   // Handle server reload errors
   server_statuses: [],
   server_check_interval_ms: 1 * 1000,
@@ -501,7 +507,7 @@ module.exports = {
     if ( diff <= 0 ) { return false; }
 
     // If time hasn't expired, wait and then check again
-    await scope.page.waitForTimeout( 100 );
+    await time.waitForTimeout( 100 );
     await scope.detectDownloadComplete(scope, endTime);
 
     return false;
@@ -1627,7 +1633,7 @@ module.exports = {
         catch(err){ elem.style.background = 'Khaki'; }
         return elem.getAttribute('for') || elem.getAttribute('name'); 
       });
-      await scope.page.waitForTimeout( 400 );
+      await time.waitForTimeout( 400 );
     }
 
     // We use the last match. We wrote a warning for the user if there were
@@ -1850,7 +1856,7 @@ module.exports = {
       });
       if ( type === `radio` || type === `checkbox` ) {
 
-        let [label] = await handle.$x(`following-sibling::label`);
+        let [label] = await handle.$$(`xpath/.//following-sibling::label`);
         
         if ( session_vars.get_debug() ) {
           if ( answer.toLowerCase() === 'false' ) { await label.evaluate( elem => { elem.style.background = 'tomato'; }); }
@@ -2213,7 +2219,7 @@ module.exports = {
       }  // ends for every non-submit-button field on the page
     }  // ends while fields are still being set
 
-    if ( session_vars.get_debug() ) { await scope.page.waitForTimeout(2000); }
+    if ( session_vars.get_debug() ) { await time.waitForTimeout(2000); }
 
     // Press a continue button with a story table variable name if it exists
     let did_navigate = false;
@@ -2561,7 +2567,7 @@ module.exports = {
 
     // Attempt to solve weird race condition issues where page has not properly continued
     while ( curr_url === prev_url && !error.was_found && !timedOut ) {
-      await scope.page.waitForTimeout( 50 );
+      await time.waitForTimeout( 50 );
       curr_url = await scope.page.url();
       error = await scope.checkForError( scope );
     }
@@ -2582,10 +2588,10 @@ module.exports = {
 
     // All results are lists to match `$x`
     let possible_errors = {
-      complex_user_error: await scope.page.$$('.alert-danger'),
+      complex_user_error: await scope.page.$$(`.alert-danger`),
       // The below does not work if there's not a space between ':' and 'none'
-      simple_user_error: await scope.page.$x(`//*[contains(@class, "da-has-error")][not(contains(@style,"display: none"))]`),
-      system_error: await scope.page.$x( '//meta[@content="docassemble: Error"]' ),
+      simple_user_error: await scope.page.$$(`xpath/.//*[contains(@class, "da-has-error")][not(contains(@style,"display: none"))]`),
+      system_error: await scope.page.$$(`xpath/.//meta[@content="docassemble: Error"]` ),
     };
 
     let error_handlers = {};
@@ -2597,7 +2603,7 @@ module.exports = {
         // Also, if you're debugging and you close the window early, the process will still
         // take this long to exit after the tests finish. Not sure how to account for that.
         if ( session_vars.get_debug() ) {
-          await scope.page.waitForTimeout( ( scope.timeout - (1 * 1000)) );
+          await time.waitForTimeout( ( scope.timeout - (1 * 1000)) );
         }
         was_found = true;
         error_handlers[ error_key ] = possible_errors[ error_key ][0];
@@ -2702,7 +2708,7 @@ module.exports = {
     },  // Ends scope.steps.add_json_vars_to_report()
 
     link_works: async ( scope, linkText ) => {
-      let [link] = await scope.page.$x(`//a[contains(text(), "${ linkText }")]`);
+      let [link] = await scope.page.$$(`xpath/.//a[contains(text(), "${ linkText }")]`);
       let prop_obj = await link.getProperty( 'href' );
       let actual_url = await prop_obj.jsonValue();
 
@@ -2760,13 +2766,13 @@ module.exports = {
       /** Tap a link that doesn't navigate. Depends on the language of the text.
        *  TODO: This may be broken at this point.
        * */
-      const [link] = await scope.page.$x(`//a[contains(text(), "${phrase}")]`);
+      const [link] = await scope.page.$$(`xpath/.//a[contains(text(), "${phrase}")]`);
 
       let msg = `The term "${ phrase }" seems to be missing.`;
       if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0151`, value: msg }); }
       expect( link, msg ).to.exist;
       await scope.tapElementAndStayOnPage(scope, { elem: link });
-      await scope.page.waitForTimeout(10000);
+      await time.waitForTimeout(10000);
     },  // Ends scope.steps.tap_term()
 
     sign: async ( scope, name ) => {
@@ -2785,7 +2791,7 @@ module.exports = {
       * TODO: Properly wait for download to complete. See notes in
       * scope.js scope.detectDownloadComplete()
       */
-      let [elem] = await scope.page.$x(`//a[contains(@href, "${ filename }")]`);
+      let [elem] = await scope.page.$$(`xpath/.//a[contains(@href, "${ filename }")]`);
 
       let msg = `"${ filename }" seems to be missing. Cannot find a link to that document.`;
       if ( !elem ) { reports.addToReport(scope, { type: `error`, code: `ALK0152`, value: msg }); }
@@ -3017,20 +3023,101 @@ module.exports = {
       expect( email, email_msg ).to.not.equal( undefined );
       expect( password, password_msg ).to.not.equal( undefined );
 
-      // Try to log in
+      // Try to enter the information
       await scope.page.type( `#email`, email );
       await scope.page.type( `#password`, password );
-      let elem = await scope.page.$( `button[name="submit"]` );
-      await scope.tapElementAndNavigate( scope, { elem });
+      let elem = await scope.page.$( `button[type="submit"]` );
+      await scope.guard_against_missing_tap_element(scope, { elem });
 
-      reports.addToReport( scope, {
-        type: `row info`,
-        code: `ALK0163`,
-        value: `Signed into ${ session_vars.get_da_server_url() }/user/sign-in successfully.`
+      // Submit and see what happens
+      let winner = await scope.steps.race_sign_in_navigation( scope, { elem });
+      // Add the result to the report and possibly throw errors
+      if ( winner[0] === `success` ) {
+        reports.addToReport( scope, {
+          type: `row info`, code: `ALK0163`,
+          value: `Successfully signed into ${ login_url }`
+        });
+        await scope.afterStep(scope, {waitForShowIf: false});
+      } else if ( winner[0] === `failure` ) {
+        let error_msg = reports.addToReport( scope, {
+          type: `error`, code: `ALK0209`,
+          value: `Failed to sign into ${ login_url }. Make sure you followed the instructions at https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in.`
+        });
+        throw new Error( error_msg );
+      } else if ( winner[0] === `error` ) {
+        let error_msg = reports.addToReport( scope, {
+          type: `error`, code: `ALK0210`,
+          value: `Error on sign in page at ${ login_url }. Try this by hand and then run the test again.`
+        });
+        throw new Error( error_msg );
+      }
+    },  // Ends scope.steps.sign_in()
+
+    race_sign_in_navigation: async function ( scope, { elem }) {
+      /** Wait for sign in navigation success or failure, or system error. */
+
+      // After everything, clean up incomplete promises
+      const controller = new AbortController;
+
+      // Redirect
+      let redirect_promise = scope.page.waitForResponse(function ( response ) {
+        return response.status() === 302;
+      }, { signal: controller.signal })
+      .catch(( error ) => {
+        log.debug({
+          code: `ALK0204`, type: `info`,
+          pre: `302 sign-in wait error: ${ error.name }`,
+          data: error,
+        });
       });
 
-      await scope.afterStep(scope, {waitForShowIf: false});
-    },  // Ends scope.steps.sign_in()
+      // Invalid credentials, no navigation, no sign in
+      let wrong_sign_in_promise = scope.page.waitForResponse(function ( response ) {
+        return response.status() >= 200 && response.status() < 300 && response.url().includes(`/sign-in`);
+      }, { signal: controller.signal })
+      .catch(( error ) => {
+        log.debug({
+          code: `ALK0205`, type: `info`,
+          pre: `200s sign-in wait error: ${ error.name }`,
+          data: error,
+        });
+      });
+
+      // System error
+      let error_promise = scope.page.waitForResponse(function ( response ) {
+        return response.status() >= 500 && response.status() < 600;
+      }, { signal: controller.signal })
+      .catch(( error ) => {
+        log.debug({
+          code: `ALK0206`, type: `info`,
+          pre: `500s sign-in wait error: ${ error.name }`,
+          data: error,
+        });
+      });
+
+      let click_promise = elem.click();  // MUST complete
+      const winner = await Promise.race([
+        Promise.all([ `success`, click_promise, redirect_promise ]),
+        Promise.all([ `failure`, click_promise, wrong_sign_in_promise ]),
+        Promise.all([ `error`, click_promise, error_promise ]),
+      ]).catch(function ( error ) {
+        let error_msg = reports.addToReport( scope, {
+          type: `error`, code: `ALK0207`,
+          value: `Unknown error waiting for results during sign in at ${ login_url }.`
+        });
+        throw new Error( error );
+      });
+
+      // Clean up unresolved promises
+      controller.abort();
+
+      log.debug({
+        code: `ALK0208`, type: `info`,
+        pre: `Sign-in winner:`, data: winner,
+      });
+
+      return winner;
+    },
 
     set_random_page_vars: async ( scope ) => {
       /** Answer inputs randomly. */

package/lib/steps.js

@@ -650,7 +650,7 @@ Then('I arrive at the next page', async () => {  // √
 // Link observations have the 'Escape' button link in mind
 Then('I should see the link {string}', async ( linkText ) => {  // √
   /* Loosely match link visible text. Should probably deprecate this. */
-  let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
+  let [link] = await scope.page.$$(`xpath/.//a[contains(text(), "${linkText}")]`);
 
   let msg = `Cannot find a link with the text "${ linkText }".`;
   if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0079`, value: msg }); }
@@ -672,7 +672,7 @@ Then('I should see the link to {string}', async ( url ) => {  // √
 
 Then(/the "([^"]+)" link leads to "([^"]+)"/, async (linkText, expected_url) => {  // √
   /* Find link by its visible text and where it leads. */
-  let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
+  let [link] = await scope.page.$$(`xpath/.//a[contains(text(), "${linkText}")]`);
   // TODO: Possibly add a check here for the link text, though note this
   // Step is not currently supported.
 
@@ -687,7 +687,7 @@ Then(/the "([^"]+)" link leads to "([^"]+)"/, async (linkText, expected_url) =>
 });
 
 Then(/the "([^"]+)" link opens in (a new window|the same window)/, async (linkText, which_window) => {  // √
-  let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
+  let [link] = await scope.page.$$(`xpath/.//a[contains(text(), "${linkText}")]`);
 
   let prop_obj = await link.getProperty('target');
   let target = await prop_obj.jsonValue();
@@ -1497,18 +1497,22 @@ After(async function(scenario) {
     }
   }
 
-  // Handle all the accumulated errors
-  let errors = []
-  if ( !expected_status_was_met ) { errors.push( expected_status_err_msg ); }
-  if ( !signout_succeeded ) { errors.push( signout_error_msg ); }
-  if ( errors.length > 0 ) {
-    throw new Error( `${errors.join( errors, '\n')}` );
-  }
+  // Collect all the relevant special errors
+  let internal_errors = []
+  if ( !expected_status_was_met ) { internal_errors.push( expected_status_err_msg ); }
+  if ( !signout_succeeded ) { internal_errors.push( signout_error_msg ); }
 
   // Theoretically, we should never get here:
   // If everything else worked, if we need to force an internal test failure
   if ( need_to_force_failed_status ) {
-    throw new Error( `🤕 ${force_failure_code} unreachable ERROR: ${force_failure_msg}` );
+    if ( internal_errors.length > 0 ) {
+      // Handle all the accumulated errors
+      throw new Error( `${internal_errors.join( internal_errors, '\n')}` );
+    }
+    throw new Error( `🤕 ${ force_failure_code } unreachable ERROR: ${ force_failure_msg }` );
+
+  } else if ( internal_errors.length > 0 ) {
+    log.info({ type: `internal error`, code: `ALK0203`, pre: `No need to force failed status and yet there are error messages. ${ errors.join( errors, '\n') }` });
   }
 
   // Find the race condition.

package/lib/utils/reports.js

@@ -81,7 +81,7 @@ reports.addToReport = function( scope, { type, code, value }) {
   let scenario = reports.makeSureScenarioExists( scope );
   scenario.lines.push({ type, code, value });
 
-  return scenario;
+  return getLineText({ type, code, value });
 };  // Ends reports.addToReport()
 
 reports.create = function( scope ) {

package/lib/utils/session_vars.js

@@ -242,7 +242,7 @@ session_vars.get_runtime_config_var = function ( key ) {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     let value = json[ key ];
     if ( session_vars.get_debug() ) {
-      console.log( `🐞 ALK0041 DEBUG: Runtime config var "${key}"" is "${value}".` );
+      console.log( `🐞 ALK0041 DEBUG: Runtime config var "${key}" is "${value}".` );
     }
 
     return value;