@suffolklitlab/alkiln 4.0.0-pre-api.8 → 4.1.0

package/lib/scope.js

@@ -5,8 +5,8 @@ const fs = require('fs');
 const safe_filename = require("sanitize-filename");
 
 // Ours
-const env_vars = require('./utils/env_vars');
 const session_vars = require('./utils/session_vars');
+const get_base_interview_url = require(`./docassemble/get_base_interview_url`);
 const time = require('./utils/time');
 
 
@@ -25,13 +25,14 @@ let escape_regex = function( to_escape ) {
 let proxies_regex = /(\bx\.)|(\bx\[)|(\[[ijklmn]\])/g;
 
 module.exports = {
+  trigger_not_needed_flag: `ALKiln: no trigger variable needed`,
   addToReport: async function( scope, { type, value }) {
     /* Add an item to a specific list in a scenario's report.
     * Create report if necessary.
     * 
     * The report has a key for each scenario and each of those
     * keys should correspond to a list containing the relevant data. */
-    if ( env_vars.DEBUG ) { console.log(`Report:\ntype: ${ type }, value: ${ value }`) }
+    if ( session_vars.get_debug() ) { console.log(`Report:\ntype: ${ type }, value: ${ value }`) }
     let scenario = await scope.makeSureReportPartsExist( scope );
     scenario.lines.push({ type, value });
 
@@ -62,7 +63,7 @@ module.exports = {
   },  // Ends scope.setReportScenarioStatus()
 
   convertToOriginalStoryTableRow: async function( scope, { row_data }) {
-    /* Returns the original data of row into a string formated as a story table row.
+    /* Returns the original data of row into a string formatted as a story table row.
     * Should this show the actual row data that was used instead? That could
     * be pretty confusing to most devs. */
     let source_row = row_data.source || row_data;
@@ -70,6 +71,10 @@ module.exports = {
     let var_str = await scope.toTrimmedJSON( scope, { str: original.var });
     let value_str = await scope.toTrimmedJSON( scope, { str: original.value });
     let trigger_str = await scope.toTrimmedJSON( scope, { str: original.trigger });
+    if ( trigger_str === scope.trigger_not_needed_flag ) {
+      // This text was added by ALKiln itself. It's not part of the user's data
+      trigger_str = ``;
+    }
     return `${ ' '.repeat(6) }| ${ var_str } | ${ value_str } | ${ trigger_str } |`;
   },  // Ends scope.convertToOriginalStoryTableRows()
 
@@ -84,7 +89,7 @@ module.exports = {
     /** Return printable heading based on Scenario name and tags.
     *    Allow characters from other languages.
     */
-    if ( env_vars.DEBUG ) { console.log( scenario.pickle.name ); }
+    if ( session_vars.get_debug() ) { console.log( scenario.pickle.name ); }
 
     // Collect all tag names
     let tag_names = [];
@@ -108,7 +113,7 @@ module.exports = {
   },  // Ends scope.addReportHeading()
 
   getPrintableReport: async function( scope ) {
-    /* Return a string genereated from test report data. */
+    /* Return a string generated from test report data. */
     let report = `Assembly Line Kiln Automated Testing Report - ${ (new Date()).toUTCString() }\n`;
 
     // First list failed scenarios, then non-passed scenarios, then passed scenarios
@@ -132,7 +137,7 @@ module.exports = {
   },  // Ends scope.getPrintableReport()
 
   getPrintableScenario: async function( scope, { scenario }) {
-    /* Return a string genereated from scenario list of report items. */
+    /* Return a string generated from scenario list of report items. */
     let [ scenario_id, data ] = scenario;
     let report = ``;
     for ( let line of data.lines ) {
@@ -386,7 +391,7 @@ module.exports = {
       scope.page.waitForSelector(`fieldset.da-field-buttons button[type="submit"]`),  // other pages (this is the most consistent way)
       scope.page.waitForSelector(`fieldset .dasigsave`),  // signature page
     ]);
-    let classname = await elem.evaluate( el => { return el.className });
+    await elem.evaluate( el => { return el.className });
     // Waits for navigation or user error
     await scope.tapElement( scope, elem );
   },
@@ -397,18 +402,19 @@ module.exports = {
 
     // If there is no browser open, start a new one
     if (!scope.browser) {
-      scope.browser = await scope.driver.launch({ headless: !env_vars.DEBUG });
+      scope.browser = await scope.driver.launch({ headless: !session_vars.get_debug() });
     }
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
 
     if ( !file_name.includes('.yml') ) { file_name = `${ file_name }.yml` }
-    let interview_url = `${ env_vars.getBaseInterviewURL() }${ file_name }`;
-    if ( env_vars.DEBUG ) { console.log( interview_url ); }
+    let base_url = await get_base_interview_url();
+    let interview_url = `${ base_url }${ file_name }`;
+    if ( session_vars.get_debug() ) { console.log( interview_url ); }
 
     await scope.page.goto(interview_url, { waitUntil: 'domcontentloaded', timeout: scope.timeout })
 
     let load_result = await scope.getLoadData( scope );
-    // Errors, or reaching timeout, causes an excpetion and is shown to the developer at the end
+    // Errors, or reaching timeout, causes an exception and is shown to the developer at the end
     if ( load_result.error ) {
       await scope.addToReport(scope, { type: `error`, value: `On final attempt to load interview, got "${ load_result.error }"` });
       expect( load_result.error ).to.equal( '' );
@@ -481,7 +487,7 @@ module.exports = {
       supported_table.push( result );
     }
 
-    if ( env_vars.DEBUG ) { console.log( 'scope.normalizedTable():\n', JSON.stringify( supported_table )); }
+    if ( session_vars.get_debug() ) { console.log( 'scope.normalizedTable():\n', JSON.stringify( supported_table )); }
 
     return supported_table;
   },  // Ends scope.normalizeTable()
@@ -506,7 +512,7 @@ module.exports = {
     let encoded_trigger_var = $( trigger_elem ).data( `variable` );  // This should come out to 'None' at the very least
     if ( !encoded_trigger_var ) {
       // TODO: Add documentation and then link to it in this message.
-      await scope.addToReport(scope, { type: `warning`, value: `You are missing an element containing the data for the page's trigger variable. Some fields, like loops with index variables, may not work correctly in these tests. Talk to the folks at the AssemblyLine project to learn more or see an example here: https://github.com/plocket/docassemble-ALAutomatedTestingTests/blob/ad1232049d7ca7a9b97b22f8ca3915dd3dae8114/docassemble/ALAutomatedTestingTests/data/questions/all_tests.yml#L6-L10.` });
+      await scope.addToReport(scope, { type: `warning`, value: `You are missing an element containing the data for the page's trigger variable. Some fields, like loops with index variables, may not work correctly in these tests. See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#a-missing-trigger-variable.` });
       encoded_trigger_var = await scope.toBase64( scope, { utf8_str: `None` });
     }
     let trigger = await scope.fromBase64( scope, { base64_str: encoded_trigger_var });
@@ -598,7 +604,7 @@ module.exports = {
       fields.push( field_data );
     }  // ends for every node
 
-    if ( env_vars.DEBUG ) { console.log( `page fields:\n${ JSON.stringify( fields )}`); }
+    if ( session_vars.get_debug() ) { console.log( `page fields:\n${ JSON.stringify( fields )}`); }
     return fields;
   },  // Ends scope.getAllFields()
 
@@ -633,7 +639,7 @@ module.exports = {
 
     // Make sure this selector matches only one node
     let matching_nodes = $( selector );
-    // This check is here to ensure saftey of future development. If there is more
+    // This check is here to ensure safety of future development. If there is more
     // or less than one match, this code may have unexpected behavior later.
     // Really need everything to be unique here if at all possible. Shall we resort
     // to parents and n-th child?
@@ -828,6 +834,8 @@ module.exports = {
     /* Given var_data, a list of objects with variable data for
     * setting fields, and an object for a DOM field, returns list of the
     * rows that match the DOM field. That list of story table rows may be empty.
+    *
+    * For notes on trigger var, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#trigger
     * 
     * @param var_data {arr} - fields and the values they can be set to
     * @param var_data[n].var {str} - name of variable to set
@@ -840,24 +848,26 @@ module.exports = {
     * @param field[n].tag {str} - HTML tag of node
     * @param field[n].type {str} - HTML type of node if it has one
     * @param field[n].guesses {arr} - arr of objects that could
-    *    possibly match a table row
+    *    possibly match a table row's `var` column
     * @param field[n].guesses[n].var {str} - name of variable
     * @param field[n].guesses[n].value {str} - value of a choice
     * @param <field[n].guesses[n].trigger> {str} - var name that triggered this page
     * 
     * @returns [ var_data[n] ]
     */
-    let matches = [];
-    let uses_proxies = false;
 
-    // There are mutliple guesses because field names are encoded
+    let rows_that_match_field_names = [];
+    let uses_proxies = false;  // See "proxies" notes further down
+    let trigger_might_be_needed = true;
+
+    // There are multiple guesses because field names are sometimes encoded
     for ( let guess of field.guesses ) {
-      for ( let var_datum of var_data ) {
-        let row_matches = false;
+      for ( let table_row of var_data ) {
+        let this_row_matches_this_field = false;
 
         // If the dev uses single instead of double quotes, etc, allow that
-        let names_match = await scope.matchNeutralizedQuotes( scope, { value1: guess.var, value2: var_datum.var });
-        let values_match = await scope.matchNeutralizedQuotes( scope, { value1: guess.value, value2: var_datum.value });
+        let names_match = await scope.matchNeutralizedQuotes( scope, { value1: guess.var, value2: table_row.var });
+        let values_match = await scope.matchNeutralizedQuotes( scope, { value1: guess.value, value2: table_row.value });
 
         // Check different things for different fields. An input box won't
         // be expected to have the same value as the var you want to set while
@@ -865,91 +875,152 @@ module.exports = {
         switch ( field.tag ) {
           case 'button':
           case 'select':
-            if ( names_match && values_match ) { row_matches = true; }
+            if ( names_match && values_match ) { this_row_matches_this_field = true; }
             break;
 
           case 'canvas':
           case 'textarea':
           case 'a':
-            if ( names_match ) { row_matches = true; }
+            if ( names_match ) { this_row_matches_this_field = true; }
             break;
 
           case 'input':
             if ( field.type === 'radio' ) {
-              if ( names_match && values_match ) { row_matches = true; }
+              if ( names_match && values_match ) { this_row_matches_this_field = true; }
             } else {  // Some kind of text input
-              if ( names_match ) { row_matches = true; }
+              if ( names_match ) { this_row_matches_this_field = true; }
             }
             break;
         }
 
-        if ( row_matches ) {
-          matches.push( var_datum );  // Collect all matches to start with.
-          if ( !uses_proxies ) {  // If this gets set to `true` once, leave it alone
-            // x, i, j, etc. See notes below about the reasoning
-            // AVOID `.test()` - it advances through a string each time you call it on the
-            // string, so you can have unexpected results.
-            uses_proxies = guess.var.match( proxies_regex );  // 
+        if ( this_row_matches_this_field ) {
+          rows_that_match_field_names.push( table_row );
+          // Check this until the value is set to `true` (if it ever is)
+          // If the field uses proxy variables - x, i, j, etc, flag it. See "proxies" note.
+          uses_proxies = uses_proxies || guess.var.match( proxies_regex );
+
+          if ( table_row.trigger === scope.trigger_not_needed_flag ) {
+            trigger_might_be_needed = false;
           }
-          continue;
-        }
+        } // end if this_row_matches_this_field
 
       }  // ends for each table row
     }  // ends for each field row possibility
 
-    // Some fields will have multiple matches from the story table.
-    // The only reason we would care about multiple story table row
-    // matches is if there is a possible proxy var conflict.
-    // When a dev has a loop with an index var or generic object,
-    // the same variable name will be used over and over, e.g. `users[i]`.
-    // That's what will be in the story table, so there will be multiple
-    // matches for a field setting `users[i]`. For this program to
-    // know which table row to use on which page, we need the one unique var that
-    // will appear on the page - the trigger var. When a row with `users[i]`
-    // has a trigger var that matches the page trigger var, the
-    // program knows to use that row to set the value for that page.
-
-    // If needed, only get the matches that also match the trigger var
-    // For now, we're being flexible about it - if we don't think we
-    // need that trigger var, we don't prevent data getting through.
-    // e.g. If an interview has a list of `users`, but they only set
-    // data for `users[0]`, there's no need to check the trigger var.
-    // That way devs with simple cases can ignore the trigger var column.
-
-    // If field uses proxies and there has been more than one match
-    // we now use the trigger var to narrow down the matches.
-    if ( uses_proxies && matches.length > 1 ) {
-      // Multiple matches means this came from a story
-
-      // Feedback for devs - we need the trigger var but we don't have it (field data)
-      // TODO: Add docs and link to docs on how to add the trigger var
-      if ( field.trigger === undefined ) { await scope.addToReport(scope, { type: `warning`, value: `A field on this page uses an index variable or a generic object, but the page does not contain an element with the trigger variable's name. Tell the developer to add an element to the page with the id "trigger"` }); }
-
-      let original_matches = matches;
-      matches = [];
-      for ( let match of original_matches ) {
-        // Feedback for devs - we need the trigger var but we don't have it (var data)
-        if ( match.trigger === undefined ) { await scope.addToReport(scope, { type: `warning`, value: `A field on this page uses an index variable or a generic object. The test gave story data for setting the field, but that data is missing the trigger. Add a trigger variable to the story table \`trigger\` column. For now, the test may end up ignoring this field. The row's data is\n${ JSON.stringify( match.original )}.\nThe field's data is\n${ JSON.stringify( field )}` }); }
-          // TODO: Add a warning if they're both `undefined`?
-        else {
-
-          let triggers_match = await scope.matchNeutralizedQuotes( scope, { value1: field.trigger, value2: match.trigger });
+    // Proxies:
+    // When a dev has a loop with an index var or generic object, the
+    // same variable name will be used over and over, e.g.`users[i].name.first`.
+    // In a regular Step, there's no ambiguity about the value to set.
+    // In a dev's story table, though, there could be multiple rows that match
+    // a field named `users[i]`. For kiln to know which row to use on which
+    // page, we need the one unique HTML string that will appear on the page -
+    // the trigger var name. When a row with `users[i]` has a "trigger" column
+    // value that matches the page HTML's trigger var name, kiln will know to
+    // use the value from that row. We need to find the matching row.
+    let final_matching_rows = [];
+    if ( trigger_might_be_needed && uses_proxies && rows_that_match_field_names.length > 0 ) {
+
+      let rows_that_also_match_trigger_name = [];
+      let rows_without_a_trigger_name = [];
+      let rows_with_conflicting_trigger_names = [];
+
+      let page_trigger_name = field.trigger;
+
+      // field/page trigger name is needed but is missing.
+      if ( !page_trigger_name ) {
+        let page_trigger_warning = `A field on this page uses an index `
+          + `variable or a generic object, but the page does not `
+          + `contain the trigger variable's name in its HTML. See `
+          + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#a-missing-trigger-variable.`;
+        await scope.addToReport(scope, { type: `warning`, value: page_trigger_warning });
+      }
+
+      for ( let row_that_matches_this_field of rows_that_match_field_names ) {
+
+        let table_row_trigger_name = row_that_matches_this_field.trigger;
+
+        if ( !table_row_trigger_name ) {
+          // var/row trigger name is (probably) needed but is missing. Caveat: If there's
+          // only one page in the proxy var loop and there's only one row, trigger name is
+          // not needed, but I'm not sure how we figure out all those things here and log
+          // a useful message.
+
+          // First, make the row data more readable to humans.
+          let row_as_story_table = await scope.convertToOriginalStoryTableRow( scope, { row_data: row_that_matches_this_field });
+          let row_trigger_warning = `This story table row needs a value in the "trigger" `
+            + `column, but it is empty. The test might get unexpected results. See `
+            + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#trigger.`
+            + `\nThe row's data:\n${ row_as_story_table }`
+            + `\nThis field's data:\n${ JSON.stringify( field )}`;
+          await scope.addToReport(scope, { type: `warning`, value: row_trigger_warning });
+          rows_without_a_trigger_name.push( row_that_matches_this_field );
+        } else {
+          let triggers_match = await scope.matchNeutralizedQuotes( scope, { value1: page_trigger_name, value2: table_row_trigger_name });
           if ( triggers_match ) {
-            matches.push( match );
+            rows_that_also_match_trigger_name.push( row_that_matches_this_field );
+          } else {
+            rows_with_conflicting_trigger_names.push( row_that_matches_this_field );
           }
         }
+      }  // ends for each row_that_matches_this_field
+
+      // Be very permissive, based on feedback. See https://github.com/SuffolkLITLab/ALKiln/issues/464#issuecomment-1005166616
+      if ( rows_that_also_match_trigger_name.length > 0 ) {
+        final_matching_rows = rows_that_also_match_trigger_name;
+      } else {
+        final_matching_rows = rows_without_a_trigger_name;
       }
-      // Feedback for devs - we are missing the matching triggers we need
-      if ( matches.length === 0 ) { await scope.addToReport(scope, { type: `warning`, value: `A field on this page uses an index variable or a generic object. The test gave multiple matches for the story data for the field, but none match the trigger variable. Is the story table missing a row? For now, the test will have to ignore this field. The rows' data is\n${ JSON.stringify( original_matches )}.\nThe field's data is\n${ JSON.stringify( field )}` }); }
-    }
 
-    // Dev may have accidentally included a row more than once. Give them feedback
-    if ( matches.length > 1 ) {
-      await scope.addToReport(scope, { type: `warning`, value: `there are multiple story data matches for this field. The story table data that appears last will be used. The field's data is\n${JSON.stringify( field )}` });
+      // Warn the user if all matching rows had trigger names that conflicted.
+      // Missing trigger names don't count as conflicting.
+      if ( final_matching_rows.length === 0 ) {
+
+        // First, make the row data more readable to humans.
+        let conflicts_as_story_table_rows = [];
+        for ( let row of rows_with_conflicting_trigger_names ) {
+          let table_str = await scope.convertToOriginalStoryTableRow( scope, { row_data: row });
+          conflicts_as_story_table_rows.push( table_str );
+        }
+
+        let all_trigger_names_conflict_msg = `Is this story table missing a row? `
+          + `${ rows_that_match_field_names.length } story table row(s) matched a field name, `
+          + `but none of their trigger variable name(s) matched the trigger variable `
+          + `name in the screen's HTML. The test will have to ignore this field. See `
+          + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#trigger.`
+          + `\nThe data of row(s) with conflicting trigger name(s):\n${ conflicts_as_story_table_rows.join( `\n` )}`
+          + `\nThis field's data:\n${ JSON.stringify( field )}`;
+        await scope.addToReport(scope, {
+          type: `warning`,
+          value: all_trigger_names_conflict_msg
+        });
+      }
+
+    } else {
+      // These should be used if NO trigger name was needed
+      final_matching_rows = rows_that_match_field_names;
+    }  // ends if need trigger name to match
+
+    // Dev may have accidentally included a row more than once.
+    if ( final_matching_rows.length > 1 ) {
+
+      // First, make the row data more readable to humans.
+      let rows_as_story_table = [];
+      for ( let row of final_matching_rows ) {
+        let table_str = await scope.convertToOriginalStoryTableRow( scope, { row_data: row });
+        rows_as_story_table.push( table_str );
+      }
+
+      let multiple_matches_msg = `Do you have a duplicate story table row? `
+        + `Multiple story table rows match this field's variable name. `
+        + `The test will use the last row that matched. See `
+        + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/#trigger.`
+        + `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
+        + `\nThis field's data:\n${ JSON.stringify( field )}`;
+      await scope.addToReport(scope, { type: `warning`, value: multiple_matches_msg });
     }
 
-    if ( env_vars.DEBUG ) { console.log( `matches:\n`, JSON.stringify( matches )); }
-    return matches;
+    if ( session_vars.get_debug() ) { console.log( `final_matching_rows:\n`, JSON.stringify( final_matching_rows )); }
+    return final_matching_rows;
   },  // Ends scope.getMatchingRows()
 
 
@@ -963,7 +1034,6 @@ module.exports = {
     return val_2_str.match( val_1_regex );
   },  // Ends scope.matchNeutralizedQuotes()
 
-
   setVariable: async function ( scope, { field, var_data }) {
     /* Returns true if the field was set.
     *
@@ -1004,7 +1074,7 @@ module.exports = {
     // If field is disabled, don't set it yet
     if ( disabled ) { return row_used; }
 
-    if ( env_vars.DEBUG ) {
+    if ( session_vars.get_debug() ) {
       let name = await handle.evaluate(( elem ) => {  // Not using this right now
         try { elem.nextSibling.style.background = 'Khaki'; }
         catch(err){ elem.style.background = 'Khaki'; }
@@ -1015,7 +1085,7 @@ module.exports = {
 
     let { tag, type } = field;
     // We use the last match. We wrote a warning for the user if there were
-    // mutliple matches in the story that the last value will be used. In future,
+    // multiple matches in the story that the last value will be used. In future,
     // Steps will be able to set this data gradually and we don't want the developer
     // to get confused thinking that an earlier Step was used instead of a later one.
     let row = matching_input_rows[ matching_input_rows.length - 1 ];
@@ -1066,7 +1136,7 @@ module.exports = {
       for ( let field_i = 0; field_i < fields.length; field_i++ ) {
         let field = fields[ field_i ];
 
-        if ( env_vars.DEBUG ) {
+        if ( session_vars.get_debug() ) {
           await field.evaluate( elem => { elem.style.background = `Khaki`; });
         }
 
@@ -1130,7 +1200,7 @@ module.exports = {
 
         let [label] = await handle.$x(`following-sibling::label`);
         
-        if ( env_vars.DEBUG ) {
+        if ( session_vars.get_debug() ) {
           if ( set_to.toLowerCase() === 'false' ) { await label.evaluate( elem => { elem.style.background = 'tomato'; }); }
           else { await label.evaluate( elem => { elem.style.background = 'teal'; }); }
           let name = await label.evaluate( elem => { return elem.getAttribute('for'); });
@@ -1179,7 +1249,7 @@ module.exports = {
     
     // Tests could be in one of two places. Figure out which directory they're in
     // Makes an absolute path from the directory in which `npm run` was used plus our internal folders
-    let dir_source = `${ process.cwd() }/docassemble/${ env_vars.REPO_URL.match(/docassemble-(.*)/)[1] }/data/sources`;
+    let dir_source = `${ process.cwd() }/docassemble/${ session_vars.get_repo_url().match(/docassemble-(.*)/)[1] }/data/sources`;
     let dir_features = `${ process.cwd() }/tests/features`;
     let dir = null;
 
@@ -1290,7 +1360,7 @@ module.exports = {
   },
 
   examinePageID: async function ( scope, question_id = '' ) {
-    /* Looks for a santized version of the question id as it's written
+    /* Looks for a sanitized version of the question id as it's written
     *     in the .yml. docassemble's way in python:
     *     re.sub(r'[^A-Za-z0-9]+', '-', interview_status.question.id.lower()) */
     let id_as_class = question_id.toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
@@ -1334,7 +1404,7 @@ module.exports = {
     * @param ensure_all_vars_used {bool} [false] = Default false. If true, errors if any
     *     object in var_data is not used during running of this function.
     */
-    if ( env_vars.DEBUG ) { console.log( `~~~~~~~~~~~~~~ scope.setFields() ~~~~~~~~~~~~~~` ); }
+    if ( session_vars.get_debug() ) { console.log( `~~~~~~~~~~~~~~ scope.setFields() ~~~~~~~~~~~~~~` ); }
 
     // Only record the page id once for each page to which we navigate
     let { id } = await scope.examinePageID( scope, 'none to match' );
@@ -1535,7 +1605,7 @@ module.exports = {
     * we believe we've set it up so that people will make it a number.
     * Sometimes this will be from `.there_is_another`. We think we've ensured
     * that it will only come from Steps and should be `True` or `False`.
-    * This feels precarious, but I can't see another permuation.
+    * This feels precarious, but I can't see another permutation.
     * 
     * This may in future be used to normalize all values that need `True`/`False`
     * normalization.
@@ -1610,7 +1680,7 @@ module.exports = {
     // All results are lists to match `$x`
     let possible_errors = {
       complex_user_error: await scope.page.$$('.alert-danger'),
-      // The below does not work if there's not a space betweein ':' and 'none'
+      // 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"]' ),
     };
@@ -1621,7 +1691,7 @@ module.exports = {
       if ( possible_errors[ error_key ][0] ) {
         // 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 ( env_vars.DEBUG ) { await scope.page.waitForTimeout( 60 * 1000 ); }
+        if ( session_vars.get_debug() ) { await scope.page.waitForTimeout( 60 * 1000 ); }
         was_found = true;
         error_handlers[ error_key ] = possible_errors[ error_key ][0];
       }
@@ -1633,13 +1703,13 @@ module.exports = {
   throwPageError: async function ( scope, { error_handlers = {}, id = '' }) {
     /* Throw a cucumber error with the error that appeared on the page. */
     if ( error_handlers.system_error !== undefined ) {
-      let sys_err_message = `The test tried to continue to the next page, but there was a system error. Check the screenshot.`
+      let sys_err_message = `The test tried to continue to the next page after ${ id }, but there was a system error. Check the screenshot.`
       await scope.addToReport(scope, { type: `error`, value: sys_err_message });
       expect( was_system_error, sys_err_message ).to.be.false;
 
     } else {
       // If it wasn't a system error, it was a user error
-      let user_err_message = `The test tried to continue to the next page, but the user got an error. Check the screenshot.`
+      let user_err_message = `The test tried to continue to the next page after ${ id }, but the user got an error. Check the screenshot.`
       await scope.addToReport(scope, { type: `error`, value: user_err_message });
       expect( true, user_err_message ).to.be.false;
     }
@@ -1705,7 +1775,7 @@ module.exports = {
     },  // Ends link_works()
 
     set_regular_var: async ( scope, var_name, set_to ) => {
-      /** Set any variable (with or without a choice associated with it) to a value. Set:
+      /** Set a non-story table variable (with or without a choice associated with it) to a value. Set:
       *  - Buttons associated with variables
       *  - Dropdowns
       *  - Checkboxes (multiple choice checkboxes must be set to "true" or "false")
@@ -1713,11 +1783,12 @@ module.exports = {
       *  - Text inputs
       *  - Textareas
       */
+      // Let kiln know not to test against trigger variable values, even for proxy vars
       let var_data = await scope.normalizeTable( scope, {
-        var_data: [{ var: var_name, value: set_to, trigger: '' }],
+        var_data: [{ var: var_name, value: set_to, trigger: scope.trigger_not_needed_flag }],
       });
-      // Don't continue if the variable doesn't navigate and if this variable
-      // cannot be seton this page, trigger an error
+      // Don't continue if the variable doesn't cause navigation itself. Also,
+      // if this variable cannot be set on this page, trigger an error
       await scope.setFields( scope, { var_data, ensure_navigation: false, ensure_all_vars_used: true });
     },  // Ends set_regular_var()