@suffolklitlab/alkiln 4.0.0 → 4.2.1-custom-setup-timeout.1

package/.github/workflows/test_tests.yml

@@ -31,6 +31,9 @@ jobs:
       REPO_URL: https://github.com/plocket/docassemble-ALAutomatedTestingTests
       USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
       USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
+      SECRET_VAR1: secret-var1-value
+      SECRET_VAR2: secret-var2-value
+      SECRET_FOR_MISSING_FIELD: secret for missing field
 
     name: Run Puppeteer tests
     steps:

package/CHANGELOG.md

@@ -38,7 +38,13 @@ Format:
 ### Security
 - 
 -->
-<!-- ## [Unreleased] -->
+## [Unreleased]
+### Added
+- GitHub environment variable MAX_SECONDS_FOR_SETUP to set a custom maximum time for setup and takedown for packages that take a long time to load.
+
+## [4.1.1] - 2022-04-01
+### Added
+- Step to set vars to secret variables. That is, using environment variables while hiding the names of those variables in the report, errors, and console logs.
 
 ## [4.0.0] - 2022-03-30
 ### Added
@@ -57,10 +63,11 @@ Format:
 - BREAKING: Update action.yml node to v17
 - BREAKING: Use alkiln v4 package.json we create during the test run in `action.yml` (as discussed in #489)
 - BREAKING: Use API key to access da server, create projects, pull code, delete projects, and check for server restart.
+- BREAKING: Throw an error for uploading nonexistent file, changed to error instead of warning in reports.
+- Update test setup interview to v4 of ALKiln.
 - Remove and ignore package-lock.json so that our tests will behave more like our users' tests
 - Add warning in steps.js for name input with too many parts. Add test in reports.
-- fix typo in the report
-- Throw an error for uploading nonexistent file, changed to error instead of warning in reports. 
+- fix typo in the report 
 - Allow a developer to wait as a first Step. See #387.
 
 <!-- ## [3.0.1-peer-deps.1] - 2021-12-07 -->

package/action.yml

@@ -28,6 +28,10 @@ inputs:
     description: 'Version of ALKiln to get from npm.'
     required: false
     default: '^4.0.0'
+  MAX_SECONDS_FOR_SETUP:
+    description: 'Amount of time to give the Project to upload your package's GitHub code.'
+    required: false
+    default: '120'
 
 runs:
   using: "composite"
@@ -54,9 +58,11 @@ runs:
         echo "PLAYGROUND_ID=${{ inputs.PLAYGROUND_ID }}" >> $GITHUB_ENV
         echo "DOCASSEMBLE_DEVELOPER_API_KEY=${{ inputs.DOCASSEMBLE_DEVELOPER_API_KEY }}" >> $GITHUB_ENV
         echo "ALKILN_VERSION=${{ inputs.ALKILN_VERSION }}" >> $GITHUB_ENV
+        echo "MAX_SECONDS_FOR_SETUP=${{ inputs.MAX_SECONDS_FOR_SETUP }}" >> $GITHUB_ENV
       shell: bash
     - name: "ALKiln: confirm info"
       run: echo -e "\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nManually added languages are $EXTRA_LANGUAGES\nAll other data is secret\n"
+      run: echo -e "\nALKiln version is $ALKILN_VERSION\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nMAX_SECONDS_FOR_SETUP is $MAX_SECONDS_FOR_SETUP\nManually added languages are $EXTRA_LANGUAGES\n"
       shell: bash
 
     # This doesn't use an already established package-lock.json and that

package/lib/docassemble/docassemble_api_interface.js

@@ -59,6 +59,10 @@ let da_i = {};
 module.exports = da_i;
 
 
+// Constants
+const DEFAULT_MAX_REQUEST_MS = session_vars.get_setup_timeout_ms();
+
+
 let is_timeout_error = function( error ) {
   /** Return whether the error is an axios timeout error.
   * See:
@@ -84,7 +88,7 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
   */
 
   // Defaults
-  let { timeout } = options || { timeout: 5 * 1000 };
+  let { timeout } = options || { timeout: DEFAULT_MAX_REQUEST_MS };
   log.info({ pre: `Waiting for the docassemble server to respond. Will wait for ${ timeout/1000 } seconds at most.` });
   
   try {
@@ -123,7 +127,7 @@ da_i.get_dev_id = async function ( dev_id_options ) {
   *    See https://docassemble.org/docs/api.html#user. */
 
   // Default timeouts
-  let { timeout } = dev_id_options ||  { timeout: 75 * 1000 };
+  let { timeout } = dev_id_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
   let response = await _da_REST.get_dev_id( timeout );
   return response.data.id;
 };  // Ends da_i.get_dev_id();
@@ -137,7 +141,7 @@ da_i.validate_api_key = async function ( api_key_options ) {
   log.info({ pre: `Checking the testing account's API key.` });
 
   // Default timeouts
-  api_key_options = api_key_options ||  { timeout: 75 * 1000 };
+  api_key_options = api_key_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
 
   try {
 
@@ -174,8 +178,13 @@ da_i.loop_to_create_project = async function( creation_options ) {
   /** Create a docassemble Project on the docassemble server's account.
   *    Loop through potential project names until we find one that
   *    isn't already taken and then use that name to create the Project. */
-  let default_opts = { timeout: 3 * 1000, max_tries: 15, wait_seconds: 5 };
-  let { timeout, max_tries, wait_seconds } = creation_options || default_opts;
+
+  // Defaults
+  creation_options = creation_options || {};
+  let default_opts = { timeout: DEFAULT_MAX_REQUEST_MS, max_tries: 15, wait_seconds: 5 };
+  let timeout = creation_options.timeout || default_opts.timeout;
+  let max_tries = creation_options.max_tries || default_opts.max_tries;
+  let wait_seconds = creation_options.wait_seconds || default_opts.wait_seconds;
 
   let project_name = null;
   let name_incrementor = 0;
@@ -229,6 +238,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
       } else {
 
         // If it's a timeout error, server is busy. Try again after waiting.
+        // Why are we using `max_tries` for timeout error as well?
         if ( is_timeout_error( error ) && name_incrementor < max_tries ) {
           log.info({ pre: `The docassemble server was busy when we tried to `
             + `create the Project. Attempt ${ name_incrementor } of `
@@ -243,7 +253,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
           throw error;
 
         }  // ends type of non-response error
-      }  // ends type of reponse error
+      }  // ends type of response error
     }  // ends try
   }  // ends while
 };  // Ends da_i.loop_to_create_project()
@@ -256,7 +266,7 @@ da_i.pull = async function ( pull_options ) {
   log.info({ pre: `Trying to pull code from the "${ session_vars.get_branch_name() }" branch.` });
 
   // Default timeouts
-  let { timeout } = pull_options ||  { timeout: 75 * 1000 };
+  let { timeout } = pull_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
 
   try {
 
@@ -290,7 +300,7 @@ da_i.has_task_finished = async function ( task_id, options ) {
   *    See https://docassemble.org/docs/api.html#restart_status. */
 
   // Defaults
-  let { timeout } = options ||  { timeout: 3 * 1000 };
+  let { timeout } = options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
 
   try {
 
@@ -340,8 +350,17 @@ da_i.wait_for_server_to_restart = async ( task_id, options ) => {
     + `"${ task_id }". A task_id is usually created for a package `
     + `with a module. It can take a few minutes to finish uploading.` });
 
-  // Defaults
-  let { wait_seconds_per_loop, max_loops } = options || { wait_seconds_per_loop: 5, max_loops: 15 };
+  // Base default
+  options = options || {};
+  // Default timeout
+  let default_timeout = DEFAULT_MAX_REQUEST_MS;
+  let timeout = options.timeout || default_timeout;
+  // Other defaults
+  let default_wait_per_loop = 5 * 1000;
+  let default_max_loops = timeout/default_wait_per_loop;
+  // Actual values
+  let wait_ms_per_loop = options.wait_ms_per_loop || default_wait_per_loop;
+  let max_loops = options.max_loops || default_max_loops;
 
   // Flags for stopping the `while` loop
   let num_tries = 0;
@@ -350,22 +369,28 @@ da_i.wait_for_server_to_restart = async ( task_id, options ) => {
   // Why loop instead of one long timeout? Because it might not just hang.
   // We might get a return value that's just `waiting`, meaning the
   // task is not done.
-  // - [ ] How many tries/time do we give this? Do we allow customization of those values?
   while ( !done_restarting && num_tries <= max_loops ) {
     num_tries++;
-
-    done_restarting = await da_i.has_task_finished( task_id );
+    // Wait only a short time for the task to finish, not the full default timeout
+    done_restarting = await da_i.has_task_finished( task_id, { timeout: 1 * 1000 } );
     if ( !done_restarting ) {
       if ( num_tries < max_loops ) {
-        log.info({ pre: `Not yet complete. Check ${ num_tries } of ${ max_loops }. `
-          + `Will check again in ${ wait_seconds_per_loop } seconds.`
+        // Show a slightly different message after a number of tries to reassure
+        // users we're still paying attention
+        let msg_start = `Not yet complete`;
+        if ( num_tries > 3 ) { msg_start = `Still not complete`; }
+
+        // When the server is busy, the task timeout causes this loop to actually
+        // take 6 seconds to complete, not 5, but I'm not sure how to make that clear
+        log.info({ pre: `${ msg_start }. Check ${ num_tries } of ${ max_loops }. `
+          + `Will check again in ${ wait_ms_per_loop/1000 } seconds.`
         });
-        await time.waitForTimeout( wait_seconds_per_loop * 1000 );
+        await time.waitForTimeout( wait_ms_per_loop );
 
       } else {
         // This is our last round, let's wrap it up
         let server_msg = `ALKiln setup: It seems like the docassemble server `
-          + `didn't finish uploading the code after ${ max_loops * wait_seconds_per_loop } `
+          + `didn't finish uploading the code after ${ max_loops * (wait_ms_per_loop/1000) } `
           + `seconds. Some things you can try: check your server is up, try `
           + `re-running the test, and try pulling the package manually `
           + `into the playground.`;
@@ -385,7 +410,7 @@ da_i.delete_project = async function ( delete_options ) {
   /** Delete a project on the user's da server. */
 
   // Defaults
-  let { timeout } = delete_options ||  { timeout: 75 * 1000 };
+  let { timeout } = delete_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
 
   let project_name = session_vars.get_project_name()
   log.info({ pre: `Trying to delete Project ${ project_name }` });
@@ -396,7 +421,9 @@ da_i.delete_project = async function ( delete_options ) {
     log.info({ pre: `Deleted Project "${ project_name }"` });
 
   } catch ( error ) {
-    // Should we throw in here?
+    // TODO: Add more useful error messages, like project doesn't exist. The devs
+    // shouldn't be deleting projects by hand, but it's still very possible they would
+    // Status 400
     log.error({ pre: `Ran into an error when deleting Project "${ project_name }"` });
     log.debug({ pre: `See https://docassemble.org/docs/api.html#playground_delete_project.` });
     throw error;

package/lib/scope.js

@@ -22,6 +22,30 @@ let escape_regex = function( to_escape ) {
   return to_escape.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
 };
 
+let get_original_row = function (row) {
+  /* `row` might be a row, a source row, or an original row. */
+
+  // Until we flatten row data a litte, we need to find the `orignal` row, which has the flags
+  let source_row = row.source || row;
+  let original = source_row.original || source_row;
+  return original;
+}
+
+let printable_var_value = function(row) {
+  /* `row` might be a row, a source row, or an original row. */
+  let original = get_original_row(row);
+  if ( is_secret_var(original) ) {
+    return original.flags.secret_name;
+  }
+  return row.value;
+};
+
+let is_secret_var = function(row) {
+  /* `row` might be a row, a source row, or an original row. */
+  let original = get_original_row(row);
+  return original.flags !== undefined && original.flags.secret_name !== undefined;
+}
+
 let proxies_regex = /(\bx\.)|(\bx\[)|(\[[ijklmn]\])/g;
 
 module.exports = {
@@ -63,7 +87,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;
@@ -113,7 +137,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
@@ -137,7 +161,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 ) {
@@ -391,7 +415,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 );
   },
@@ -414,7 +438,7 @@ module.exports = {
     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( '' );
@@ -467,19 +491,29 @@ module.exports = {
 
   normalizeTable: async function ( scope, { var_data, from_story_table=true }) {
     /* Return data derived from cucumber variable-setting data.
-    * Table must have headers. Arrays are not supported. */
+     * Table must have headers. Arrays are not supported. */
 
     // Support tables with no 'trigger' column
     let supported_table = [];
     for ( let row of var_data ) {
       // See tests > unit_tests > tables.fixtures.js > tables.old_to_current_formatting
+      let actual_var_value = row.value;
+      if (is_secret_var(row)) {
+        actual_var_value = process.env[row.flags.secret_name];
+        if ( actual_var_value === undefined ) {
+          let not_in_env_msg = `The GitHub SECRET "${ row.flags.secret_name }" doesn't exist. Check for a typo and check your workflow file.`;
+          await scope.addToReport( scope, { type: `error`, value: not_in_env_msg })
+          throw ReferenceError(`Could not find "${row.flags.secret_name }": ${not_in_env_msg}.`)
+        }
+      }
+
       let result = {
         original: row,
         // Give fake data if needed to prevent some kind of hidden input field from being found
         // See bug at https://github.com/plocket/docassemble-cucumber/issues/79
         // May be able to remove this once converted to `getAllFields`
         var: row.var || 'al_no_var_name',
-        value: row.value,
+        value: actual_var_value,
         trigger: row.trigger || '',
         times_used: 0,
       }
@@ -487,7 +521,9 @@ module.exports = {
       supported_table.push( result );
     }
 
-    if ( session_vars.get_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()
@@ -639,7 +675,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?
@@ -860,7 +896,7 @@ module.exports = {
     let uses_proxies = false;  // See "proxies" notes further down
     let trigger_might_be_needed = true;
 
-    // There are mutliple guesses because field names are sometimes encoded
+    // There are multiple guesses because field names are sometimes encoded
     for ( let guess of field.guesses ) {
       for ( let table_row of var_data ) {
         let this_row_matches_this_field = false;
@@ -1085,7 +1121,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 ];
@@ -1360,7 +1396,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, '-');
@@ -1506,9 +1542,10 @@ module.exports = {
         if ( row.times_used === 0 ) {
           num_unused_rows += 1;
           let source_row = row;
+          // TODO: Make the row object flatter so we don't need to dig in this way
           if ( row.source ) { source_row = row.source; }
           let original_row = source_row.original;
-          let msg = `Did not find a field on this page for the variable \`${ original_row.var }\` that could be set to \`${ original_row.value }\``;
+          let msg = `Did not find a field on this page for the variable "${ original_row.var }" that could be set to "${ original_row.value }"`;
           await scope.addToReport(scope, { type: `warning`, value: msg });
         }
       }
@@ -1605,25 +1642,29 @@ 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.
     */
-    let value = row.value;
+    let value = row.value.toLowerCase();
+    let val_to_print = printable_var_value(row); 
     let int_val = parseInt( value );
     
     // Step stuff. Take into account a lot of possible values
     if ( value.match( /(false|no|unchecked|uncheck|deselected|deselect)/i )) {
+      // Should this also contain a warning if this is trying to set `target_number`?
       return `False`;
 
     } else if ( value.match( /(true|yes|checked|check|selected|select)/i )) {
       if ( from_story_table ) {
-        // Just in case, but this should never happen.
         if ( row.var.match( /\.there_is_another$/ ) ) {
+          // `.there_is_another` should never get in here, but just in case
           await scope.addToReport( scope, { type: `warning`, value: `The attribute \`.there_is_another\` is invalid in story table tests. Replace it with \`.target_number\` in your \`var\` column. Set the \`value\` to the number of items in that list. This test will now set this row's \`value\` to \`False\`. See https://suffolklitlab.github.io/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing#there_is_another-loop. The row data is\n${ JSON.stringify( row.original )}` });
         } else {
-          await scope.addToReport( scope, { type: `warning`, value: `${ value } is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
+          // If `target_number` is set to True instead of a number
+          // Since secret vars can't be passed in a table, this should never be a secret var
+          await scope.addToReport( scope, { type: `warning`, value: `${ val_to_print } value is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
         }
         return `False`;
       } else { return `True`; }
@@ -1638,7 +1679,8 @@ module.exports = {
         return `False`;
 
     } else if ( isNaN( parseInt( value )) ) { // Loop will end
-      await scope.addToReport( scope, { type: `warning`, value: `${ value } is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
+      // I can't figure out how to trigger this warning either
+      await scope.addToReport( scope, { type: `warning`, value: `${ val_to_print } value is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
       return `False`;
 
     } else {  // It's a number. Loop will continue.
@@ -1680,7 +1722,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"]' ),
     };
@@ -1703,13 +1745,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;
     }
@@ -1792,6 +1834,21 @@ module.exports = {
       await scope.setFields( scope, { var_data, ensure_navigation: false, ensure_all_vars_used: true });
     },  // Ends set_regular_var()
 
+    set_secret_var: async ( scope, var_name, set_to_env_name ) => {
+      /** Sets a non-story table variable to a "secret" value (i.e. an env var) */
+      let var_data = await scope.normalizeTable( scope, {
+              var_data: [{
+                var: var_name,
+                value: set_to_env_name,
+                trigger: scope.trigger_not_needed_flag,
+                flags: {secret_name: set_to_env_name}
+              }],
+      });
+      // 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 });
+    },
+
     tap_term: async ( scope, phrase ) => {
       /** Tap a link that doesn't navigate. Depends on the language of the text. */
       const [link] = await scope.page.$x(`//a[contains(text(), "${phrase}")]`);

package/lib/steps.js

@@ -14,13 +14,11 @@ const wrapPromiseWithTimeout = require('./cucumber_8_shim');
 const fs = require('fs');
 const path = require('path');
 const { expect } = require('chai');
-const puppeteer = require('puppeteer');
 const { v4: uuidv4 } = require('uuid');
 
 // Ours
 const scope = require('./scope');
 const session_vars = require('./utils/session_vars');
-
 /* Of Note:
 - We're using `*=` because sometimes da text has funny characters in it that are hard to anticipate
 */
@@ -33,7 +31,7 @@ require("dotenv").config();  // Where did this go?
 1. 'choice' to have a more specific way to access each item. For
     example, for a list collect or other things that have multiple
     things with the same text on the page.
-1. Figure out how to test allowing felxibility for coder. For example:
+1. Figure out how to test allowing flexibility for coder. For example:
     there is placeholder text for the title of the form and if it's not
     defined, placeholder text should appear (though that behavior may
     bear discussion).
@@ -180,7 +178,7 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
 
     // If response has a file in it that matches the file we are downloading
     if ( response._headers['content-disposition'] && (response._headers['content-disposition']).includes(`attachment;filename=${scope.toDownload}`) ) {
-      // We're chosing avoid removing the event listener in case removal
+      // We're choosing to avoid removing the event listener in case removal
       // would prevent downloading other files. The listener should get
       // destroyed when the page closes anyway.
 
@@ -219,7 +217,7 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
   await custom_lang_timeout;
 
 
-  let custom_aferStep_timeout = new Promise(async ( resolve, reject ) => {
+  let custom_afterStep_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() { reject(`\`afterStep()\` took too long.`); }, scope.timeout);
     // self-invoke an anonymous async function so we don't have to
     // abstract the details of resolving and rejecting.
@@ -230,8 +228,8 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
       // prevent temporary hang at end of tests
       finally { clearTimeout( page_timeout ); }
     })();
-  });  // ends custom_aferStep_timeout
-  await custom_aferStep_timeout;
+  });  // ends custom_afterStep_timeout
+  await custom_afterStep_timeout;
 });
 
 Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)" and(?: the password)? "([^"]+)"(?: SECRETs)?/i, {timeout: -1}, async ( email, password ) => {
@@ -252,7 +250,7 @@ Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^
   );
 });
 
-// I am using a moble/pc
+// I am using a mobile/pc
 When(/I am using an? (.*)/, async ( device ) => {
   // Let developer pick mobile device if they want to
   // TODO: Add tablet?
@@ -350,7 +348,7 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
   for ( let row of supported_table ) {
     row.report_str = `${ await scope.convertToOriginalStoryTableRow(scope, { row_data: row }) }`;
   }
-  // Sort into aphabetical order, as is recommended for writing story tables
+  // Sort into alphabetical order, as is recommended for writing story tables
   let sorted_rows = supported_table.sort( function ( row1, row2 ) {
     if( row1.report_str < row2.report_str ) { return -1; }
     if( row1.report_str > row2.report_str ) { return 1; }
@@ -404,7 +402,7 @@ When(/I wait (\d*\.?\d+) seconds?/, { timeout: -1 }, async ( seconds ) => {
   * - Should this really reset the 'navigated' flag? Should the below
   *     return succeed or fail? e.g:
   *     I tap to continue; I wait 10 seconds; I arrive at the next page;
-  *     Maybe the 'navitaged' flag should only be reset just before trying to
+  *     Maybe the 'navigated' flag should only be reset just before trying to
   *     navigate (after pressing a button)
   */
   return wrapPromiseWithTimeout(
@@ -426,7 +424,7 @@ Then(/I take a screenshot ?(?:named "([^"]+)")?/, { timeout: -1 }, async ( name
 When("I do nothing", async () => { await scope.afterStep(scope); });  // √
 
 Then('the question id should be {string}', { timeout: -1 }, async ( 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 */
   let { question_has_id, id, id_matches } = await scope.examinePageID( scope, question_id );
 
@@ -449,7 +447,7 @@ Then('the question id should be {string}', { timeout: -1 }, async ( question_id
 });
 
 // Allow emphasis with capital letters
-Then(/I should see the phrase "([^"]+)"/i, async ( phrase ) => {  // √
+Then(/I ?(?:should)? see the phrase "([^"]+)"/i, async ( phrase ) => {  // √
   /* In Chrome, this `innerText` gets only visible text */
   const bodyText = await scope.page.$eval('body', elem => elem.innerText);
 
@@ -567,7 +565,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 ) => {  // √
-  /* Loosley match link visible text. Should probably deprecate this. */
+  /* Loosely match link visible text. Should probably deprecate this. */
   let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
 
   let msg = `Cannot find a link with the text "${ linkText }".`;
@@ -668,7 +666,7 @@ Then(/I get the(?: page's)?(?: JSON)? var(?:iable)?s and val(?:ue)?s/i, { timeou
   *    to get the variable values on the page of the interview and add
   *    them to the report.
   * 
-  * Varations:
+  * Variations:
   * I get the page's JSON variables and values
   * I get the json vars and vals
   * I get the page's vars and vals
@@ -735,6 +733,15 @@ When(/I set the var(?:iable)? "([^"]+)" to "([^"]+)"/, { timeout: -1 }, async (
   );
 });
 
+When(/I set the var(?:iable)? "([^"]+)" to ?(?:the)? ?(?:GitHub)? secret "([^"]+)"/i, { timeout: -1 }, async ( var_name, set_to_env_name ) => {
+  /* Set a non-story table variable to a secrete value. Same as the above, but reads the value from `process.env` */
+  return wrapPromiseWithTimeout(
+    scope.steps.set_secret_var( scope, var_name, set_to_env_name ),
+    scope.timeout
+  );
+});
+
+
 Then(/I upload "([^"]+)" to "([^"]+)"/, { timeout: -1 }, async ( filenames, var_name ) => {
   /* Uploads file (docx, jpg, etc) in same folder to input var. Can actually use
   * 'I set the var "" to ""', but this is more explicit if it's desired. */

package/lib/utils/langs.js

@@ -20,7 +20,7 @@ for ( let full_path of filepaths ) {  // Handle old language files before creati
   // Don't apply this to the example test that this package always provides
   if ( full_path.includes( 'example_test.feature' )) { continue; }
 
-  // Delete alredy existing non-default language files and skip the rest of this. For example,
+  // Delete already existing non-default language files and skip the rest of this. For example,
   // if 3 languages were tested previously and now only two are being tested.
   if ( full_path.includes( flag )) {
       fs.unlinkSync( full_path );

package/lib/utils/session_vars.js

@@ -10,7 +10,7 @@ require('dotenv').config();
 /* This file provides user info variables. E.g. server address. They're either
 *    `process.env` vars or vars that have been built from `process.env` vars.
 *    It is meant to avoid duplication, make testing easier, and leave room for
-*    future maninpulation. No other file should need to use `process.env`.
+*    future manipulation. No other file should need to use `process.env`.
 *
 * We have a bunch of `.get_foo()` functions partly because it makes the code
 *    much easier to test.
@@ -20,10 +20,20 @@ const session_vars = {};
 
 module.exports = session_vars;
 
+// Default to null
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
 session_vars.get_repo_url = function () { return process.env.REPO_URL || null; };
 
+// More complex logic
+session_vars.get_setup_timeout_ms = function () {
+  let timeout = 120 * 1000;
+  if ( process.env.MAX_SECONDS_FOR_SETUP ) {
+    timeout = parseFloat( process.env.MAX_SECONDS_FOR_SETUP ) * 1000;
+  }
+  return timeout;
+};
+
 session_vars.get_da_server_url = function () {
   try {
     let url = process.env.SERVER_URL || process.env.BASE_URL;
@@ -105,7 +115,7 @@ session_vars.get_project_name = function () {
 
 session_vars.delete_project_name = function () {
   /* Delete the file storing the name of the docassemble project */
-  // Avoid race coditions possibly caused by checking for existence first
+  // Avoid race conditions possibly caused by checking for existence first
   // Delete file if possible
   try {
     fs.unlinkSync( project_name_file_path );

package/package.json

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

package/tests/features/interactive_steps.feature

@@ -83,3 +83,21 @@ Scenario: I set text-type values
   And I tap to continue
   # Next page
   Then the question id should be "the end"
+
+@fast @i2 @secret
+Scenario: handles settings from Github secrets
+  Given the final Scenario status should be "failed"
+  And the Scenario report should include:
+  """
+  The GitHub SECRET "SECRET_NOT_THERE" doesn't exist
+  """
+  Given I start the interview at "test_secret_vars"
+  When I set the var "first_text_entry" to the secret "SECRET_VAR1"
+  And I tap to continue
+  Then I see the phrase "secret-var1-value"
+  When I tap to continue
+  And I set the var "second_text_entry" to the github secret "SECRET_VAR2"
+  And I tap to continue
+  Then I see the phrase "secret-var2-value"
+  When I tap to continue
+  And I set the variable "third_text_entry" to secret "SECRET_NOT_THERE"

package/tests/features/reports.feature

@@ -386,6 +386,17 @@ Scenario: Fail with could not find files
   Given I start the interview at "all_tests"
   And I upload "nonexistant1.pdf, nonexistant2.pdf" to "upload_files_visible"
 
+@fast @rf26 @secret @error
+Scenario: Fail to find var while keeping value secret
+  Given the final Scenario status should be "failed"
+  Given the Scenario report should include:
+  """
+  Did not find a field on this page for the variable "missing_var" that could be set to "SECRET_FOR_MISSING_FIELD"
+  """
+  And I start the interview at "test_secret_vars"
+  And I set the var "missing_var" to the secret "SECRET_FOR_MISSING_FIELD"
+
+
 # scope.js
 # I upload "___" to "___"
 # No need to test wrong var name
@@ -409,6 +420,7 @@ Scenario: Warn when there are too many names
   And I set the name of "users[0]" to "Uli Udo User Sampson Jr"
   And I tap to continue
 
+
 # ===============================
 # Reports for "passed" Scenarios
 # ===============================