@suffolklitlab/alkiln 5.17.1-fix-stop-on-error-3 → 5.17.2

package/.github/workflows/al_da_image_latest.yml

@@ -36,6 +36,17 @@ jobs:
           && github.event.pull_request.head.repo.fork
         )
     runs-on: ubuntu-latest
+
+    env:
+      NORMAL_USER_EMAIL: "alkiln@example.com"
+      NORMAL_USER_PASSWORD: "User123^"
+      WRONG_EMAIL: "wrong_email@example.com"
+      WRONG_PASSWORD: "wrong_password"
+      INVALID_API_KEY: "invalidAPIkey"
+      EMPTY_STRING: ""
+      SECRET_VAR1: "secret-var1-value"
+      SECRET_VAR2: "secret-var2-value"
+      SECRET_FOR_MISSING_FIELD: "secret for missing field"
       
     steps:
       # Place the root directory in this branch to access relative paths to
@@ -51,20 +62,70 @@ jobs:
       - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
         shell: bash
 
+      - name: "Add a low-level user and their API key (in an env var)"
+        env:
+          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
+          KEY: ${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
+        run: |
+          # Create user and their API key
+
+          # Install json processor
+          sudo apt-get install jq
+
+          # https://docassemble.org/docs/api.html#user_new
+          user_data=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/new \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "username": "${{ env.NORMAL_USER_EMAIL }}",
+              "password": "${{ env.NORMAL_USER_PASSWORD }}"
+            }')
+          echo "User data:"
+          echo "$user_data"
+
+          user_id=$(echo "$user_data" | jq '.user_id' -r)
+
+          # https://docassemble.org/docs/api.html#api_user_user_id_api_post
+          new_key_with_quotes=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "name": "alkiln_key",
+              "method": "none"
+            }')
+          echo "new key (watch out, this contains actual quotation marks): $new_key_with_quotes"
+          no_end_quote="${new_key_with_quotes%\"}"
+          unquoted="${no_end_quote#\"}"
+          echo "unquoted: $unquoted"
+
+          echo "NORMAL_USER_API_KEY=$unquoted" >> "$GITHUB_ENV"
+
       ## Optional debugging to explore things like docker issues
       #- name: Docker debug tmate session
       #  #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
       #  uses: mxschmitt/action-tmate@v3
 
-      - name: "ALKiln - Confirm docassemble packages get installed correctly"
+      - name: "Create other env vars for our own tests from server output"
+        run: |
+          echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
+          echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
+
+      - name: "ALKiln - Run if docassemble packages get installed correctly"
         if: ${{ success() }}
         id: alkiln
         uses: ./
+        env:
+          # Internal: docassemble changes sometimes break @a11y tests. That is
+          # a da problem, not ours. We will trigger these tests manually when we
+          # want to check up on this.
+          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
         with:
           # Required inputs. See
           # https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sandbox-inputs
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
           INSTALL_METHOD: "server"
-          ALKILN_TAG_EXPRESSION: "@e3"  # One very simple test
-          ALKILN_VERSION: "stop_on_error"
+          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
+          # ALKIlN_VERSION:

package/.github/workflows/github_server.yml

@@ -159,7 +159,7 @@ jobs:
           #### Developer note: You can probably leave the rest out
           #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
-          ALKILN_VERSION: "stop_on_error"
+          # ALKIlN_VERSION:
 
       #### Developer note: Example of making an issue when tests fail
       #### that includes the text of the failure output file

package/.github/workflows/playground.yml

@@ -80,4 +80,4 @@ jobs:
           # want to check up on this.
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           #### Developer note: You can probably leave this out
-          ALKILN_VERSION: "stop_on_error"
+          # ALKIlN_VERSION:

package/CHANGELOG.md

@@ -44,23 +44,26 @@ Format:
 - 
 -->
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [5.17.2] - 2026-10-29
 
 ### Added
 
-- Step "I continue" which taps the continue button expecting to navigate to a new page in the interview. "I continue" and "I can't continue" should together replace the behaviors of "I tap to continue".
-- Step "I can't continue" which taps the continue button expecting to fail to navigate. It passes when there are invalid answers or when a continue button is missing. It fails on other errors, like system errors (including Assembly Line custom errors) and timeout errors. Those types of errors should always fail across the whole framework. An author could use "I can't continue" to check that the interview correctly indicated one or more invalid answers. This replaces the practice of using "I tap to continue" twice.
+- Step `I continue` which taps the continue button expecting to navigate to a new page in the interview. `I continue` and `I can't continue` should together replace the behaviors of `I tap to continue`.
+- Step `I can't continue` which taps the continue button expecting to fail to navigate. It passes when there are invalid answers or when a continue button is missing. It fails on other errors, like system errors (including Assembly Line custom errors) and timeout errors. Those types of errors should always fail across the whole framework. An author could use `I can't continue` to check that the interview correctly indicated one or more invalid answers. This replaces the practice of using `I tap to continue` twice.
 
 ### Changed
 
-- Part 2 of detecting custom AL error screen (final part): Though `I tap to continue` allows invalid answers again, it throws on other errors, like system errors (including Assembly Line custom errors) and timeout errors. Those types of errors should always fail across the whole framework. It also throws if the continue button is missing.
+- Part 2 of detecting custom AL error screen (final part): Though `I tap to continue` allows invalid answers again, it throws on other errors, like system errors (including Assembly Line custom errors) and timeout errors. Those types of errors should always fail across the whole framework. It also throws if the continue button is missing. See [#656](https://github.com/SuffolkLITLab/ALKiln/issues/656).
 - Extended error message when the test causes a docassemble system error page (like syntax errors, etc.) It now should contain some of the relevant contents of the page.
 - Tweaked other log messages.
 
 ### Fixed
 
-- Restores the documented behavior of `I tap to continue`. Specifically, the documentation describes using `I tap to continue` to potentially trigger invalid answers. To do this, these commits re-implement old behavior - `I tap to continue` never fails with invalid answers or missing continue-type buttons. Does add a small change - `I tap to continue` now throws on other errors, like system errors and timeout errors. Those types of errors should always fail across the whole framework. Note: A different behavior was proposed where an author could tap to continue once and be guaranteed no failures and then fail on a second tap to the same page. There are situations in which this would break potentially live tests. For example, an author could test multiple invalid answers in a row for the same field by cycling through. `I tap to continue` and `I should see the phrase`. The proposed change would break those tests.
+- Restored the documented behavior of `I tap to continue`. Specifically, the documentation describes using `I tap to continue` to potentially trigger invalid answers. To do this, these commits re-implement old behavior - `I tap to continue` never fails with invalid answers or missing continue-type buttons. Does add a small change - `I tap to continue` now throws on other errors, like system errors and timeout errors. Those types of errors should always fail across the whole framework. Note: A different behavior was proposed where an author could tap to continue once and be guaranteed no failures and then fail on a second tap to the same page. There are situations in which this would break potentially live tests. For example, an author could test multiple invalid answers in a row for the same field by cycling through `I tap to continue` and `I should see the phrase`. The proposed change would break those tests. The `I tap to continue` Step does now log its deprecation, as well as copious warnings with invalid answers or ambiguous lack of navigation. See [#1125](https://github.com/SuffolkLITLab/ALKiln/issues/1125).
 - Ensured new file upload buttons don't warn about duplicates since they have the same selectors.
+- Restored wait for file upload completion signals. See [#1125](https://github.com/SuffolkLITLab/ALKiln/issues/1125).
 
 ### Internal
 
@@ -69,6 +72,9 @@ Format:
 - Refactored getting different types of page errors (system error pages vs. user errors.)
 - Started refactoring out `scope.examinePageID()` which is currently doing too many things.
 - Added tests
+- Fixed check for previous filenames on file uploads. See [#1125](https://github.com/SuffolkLITLab/ALKiln/issues/1125).
+- Removed `shared_names` from global scope. See [#1125](https://github.com/SuffolkLITLab/ALKiln/issues/1125).
+- Use latest AL docassemble image to run all tests instead of just one.
 
 ## [5.17.1] - 2026-10-13
 

package/lib/scope.js

@@ -2330,7 +2330,7 @@ module.exports = {
         await scope.afterStep(scope, { waitForShowIf: true });
         
       } else if ( type === `file` ) {
-        row_was_used = await scope.uploadFiles( scope, { handle, answer });
+        row_was_used = await scope.upload_files( scope, { handle, answer });
         await scope.afterStep(scope, { waitForShowIf: true });
 
       } else if (type == `date`) {
@@ -2410,7 +2410,7 @@ module.exports = {
     return valid_date;
   },  // Ends scope.today_to_date()
 
-  findFiles: async function( scope, {to_find_names}) {
+  find_files: async function( scope, {to_find_names}) {
     /** Returns a list of paths to the sources folder associated
     *    with the given list of file names.
     * 
@@ -2467,9 +2467,9 @@ module.exports = {
       return [];
     }
     return paths;
-  },  // Ends scope.findFiles()
+  },  // Ends scope.find_files()
 
-  uploadFiles: async function ( scope, { handle, answer }) {
+  upload_files: async function ( scope, { handle, answer }) {
     /* Try to upload one or more files to a file-type input field.
     *    Does not submit, so no danger of timeout with server reload.
     * 
@@ -2479,8 +2479,8 @@ module.exports = {
     // First make sure the list of files was defined. Don't remove spaces yet -
     // allow a typo where someone forgot to include a space after a comma.
     let to_find_names = answer.split(`,`);
-    let paths = await scope.findFiles(scope, {to_find_names});
-    if (paths.length == 0) {
+    let paths = await scope.find_files(scope, {to_find_names});
+    if ( paths.length == 0 ) {
       // The row wasn't used
       return false;
     }
@@ -2492,16 +2492,17 @@ module.exports = {
     //   it's not completely necessary. If the gobal `setTimeout` fires then the
     //   `evaluate` won't be far behind. They both use about the same timeout
     //   duration.
-    let finish_uploading = handle.evaluate( async function detect_finished_upload(
+    let finish_uploading = handle.evaluate( async function (
       elem, timeout, answer
     ) {
       return new Promise (( resolve, reject ) => {
         /**
          * Resolve when upload completes. Logging in here will log to the hidden
          *   browser. Must instead pass information out with `resolve`.
+         * 
+         * Warn about uploading the same file multiple times. It won't protect
+         * against accidentally uploading same file to a different field.
          * */
-        // Warn about uploading the same file multiple times
-        // Won't protect against accidentally uploading same file to diff field
 
         // If elem.files, the author has previously set this field. Warn them.
         // Example prev_filenames: "C:\\fakepath\\name_of_file.png"
@@ -2521,13 +2522,13 @@ module.exports = {
 
         let result = {
           ok: false, prev_filenames, type: null,
-          code: `ALK0283`, level: `debug`, msgs: [], error: null,
+          code: `ALK0283`, level: `info`, msgs: [], error: null,
         };
 
-        if ( prev_filenames ) {
+        if (( prev_filenames?.length || 0) > 0 ) {
           result.level = `warn`;  // log level
           result.type = `warning`;  // report type
-          shared_names = shared_names_list.join(`", "`);
+          let shared_names = shared_names_list.join(`", "`);
 
           if ( shared_names_list.length > 0 ) {
             if ( all_matched ) {
@@ -2545,9 +2546,10 @@ module.exports = {
 
         let timeout_id = null;
         let resolve_on_change = function() {
+          // bootstrap-fileinput starts reading
           result.ok = true;  // May contain warnings
           clearTimeout( timeout_id );
-          result.msgs.push(`Finished uploading these files: "${ answer }"`);
+          result.msgs.push(`Started uploading these files: "${ answer }"`);
           resolve( result );
         };
 
@@ -2568,7 +2570,7 @@ module.exports = {
       });  // ends Promise
 
     }, scope.timeout - 100, answer );  // ends page.evaluate()
-    
+
     await handle.uploadFile(...paths);
 
     // Wait for upload to finish. If already done, execution will continue
@@ -2589,9 +2591,31 @@ module.exports = {
     if ( level === `throw` ) { log_type = `throw`; }
     log[ log_type ]({ code, level, error, context: `file_upload`}, ...msgs );
 
+    // LLM Claude (version?) description: While the bootstrap-fileinput is
+    //   reading, it disables the input, adds `is-locked` to its container
+    //   (lock()), and adds `file-thumb-loading` (_toggleLoading("show")). We'll
+    //   wait till these are gone. See GitHub #1125. @plocket tested these
+    //   classes out and said they seem legit.
+    await scope.page.waitForFunction(
+      ( el ) => {
+        const container = el.closest(`.file-input`);
+        return (
+          !el.disabled
+          && !( container?.classList?.contains?.(`is-locked`)
+            || container?.classList?.contains?.(`file-thumb-loading`)
+        ));
+      },
+      { timeout: scope.timeout - 100 },
+      handle,
+    );
+
+    log.debug({ code: `ALK0297`, context: `file_upload`, level: `info`, },
+      `Finished uploading files`
+    );
+
     // Return whether successfully used row
     return ok;
-  },  // Ends scope.uploadFiles()
+  },  // Ends scope.upload_files()
 
   setCheckbox: async function ( scope, { label, answer }) {
     // Depending on the current value/status of a checkbox and the desired
@@ -3222,12 +3246,12 @@ module.exports = {
      *   further information
      * 4. (optional) Unspecified non-navigation catchall comes last
      * 
-     * Unfortunately, our navigation detection game is weaksauce. Navigation
-     *   detection thoughts: https://github.com/SuffolkLITLab/ALKiln/issues/229
-     * 
      * See docs/decisions/017_post_navigation_custom_behavior_2026_10_26.md for
      *   a deeper discussion.
      * 
+     * Unfortunately, our navigation detection game is weaksauce. Navigation
+     *   detection thoughts: https://github.com/SuffolkLITLab/ALKiln/issues/229
+     * 
      * @param {Object} scope - Tests state object
      * @param {Object} kwargs - Named arguments
      * @param {str} kwargs.url - Assumed to be the url of the initial page
@@ -3241,11 +3265,11 @@ module.exports = {
      * @returns {Object} kwrvs.error_data - Data for any errors found
      * @returns {bool} kwrvs.error_data.was_found - True if the check found any
      *   errors
-     * @returns {bool} kwrvserror_data.ok - False if the check found any errors.
+     * @returns {bool} kwrvs.error_data.ok - False if the check found any errors.
      *   Discuss: Should we only use `ok` for internal errors?
-     * @returns {`user`|`system`} kwrvserror_data.type - "user" with invalid
+     * @returns {`user`|`system`} kwrvs.error_data.type - "user" with invalid
      *   answers, "system" with da or AL server errors
-     * @returns {[ElementHandle]} kwrvserror_data.error_handles - List of
+     * @returns {[ElementHandle]} kwrvs.error_data.error_handles - List of
      *   puppeteer element handles the check found. There can be multiple
      *   invalid answer elements.
      * */
@@ -3374,7 +3398,7 @@ module.exports = {
         //   still be a bit too long.        
         // Also, if you're debugging and you close the window early, the process
         //   will still take this long to exit after the tests finish. May fix
-        //   in future, but it's just during debugging, so yolo!
+        //   in future, but it's just during debugging, so yolo for now!
         if ( session_vars.get_debug() ) {
           await time.waitForTimeout( ( scope.timeout - (1 * 1000)) );
         }
@@ -3809,7 +3833,7 @@ module.exports = {
     },  // Ends scope.steps.get_response_filename()
 
     compare_pdfs: async function (scope, {existing_pdf_path, new_pdf_path}) {
-      let existing_paths = await scope.findFiles(scope, {to_find_names: [existing_pdf_path]});
+      let existing_paths = await scope.find_files(scope, {to_find_names: [existing_pdf_path]});
       if (existing_paths.length == 0) {
         // The row wasn't used
         let msg = `Could not find the existing PDF at ${ existing_pdf_path }`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.17.1-fix-stop-on-error-3",
+  "version": "5.17.2",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/tests/log_codes/log_code_expected_instances.txt

@@ -309,3 +309,4 @@ ALK0293:1
 ALK0294:1
 ALK0295:1
 ALK0296:1
+ALK0297:1