@suffolklitlab/alkiln 5.10.4 → 5.11.1

package/action_for_github_server/action.yml

@@ -45,85 +45,86 @@ runs:
   using: "composite"
   steps:
       # Place the root directory in this branch
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: "ALKiln GitHub server - Set environment variables"
+      - shell: bash
         env:
           MAX_SECONDS_FOR_DOCKER: ${{ inputs.MAX_SECONDS_FOR_DOCKER }}
           DOCASSEMBLECLI_VERSION: ${{ inputs.DOCASSEMBLECLI_VERSION }}
         run: |
-          # ALKiln GitHub server info: Set environment variables
+          # 💡ALK0001 INFO: Set environment variables
           echo "MAX_SECONDS_FOR_DOCKER=$MAX_SECONDS_FOR_DOCKER" >> $GITHUB_ENV
           echo "DOCASSEMBLECLI_VERSION=$DOCASSEMBLECLI_VERSION" >> $GITHUB_ENV
           echo "DA_ADMIN_API_KEY=abcd1234abcd1234abcd5678abdc5678" >> $GITHUB_ENV
           echo "DA_ADMIN_EMAIL=admin@example.com" >> $GITHUB_ENV
           # Login will fail if this value is "password"
           echo "DA_ADMIN_PASSWORD=@123abcdefg" >> $GITHUB_ENV
+      - name: "💡 ALK0002 INFO: Prepare GitHub step output variables"
+        id: api_key_output_step
         shell: bash
-      - id: api_key_output_step
         run: |
+          # 💡 ALK0002 INFO: Create GitHub step output variables
           echo "DOCASSEMBLE_DEVELOPER_API_KEY=$DA_ADMIN_API_KEY" >> "$GITHUB_OUTPUT"
           echo "DA_ADMIN_EMAIL=$DA_ADMIN_EMAIL" >> "$GITHUB_OUTPUT"
           echo "DA_ADMIN_PASSWORD=$DA_ADMIN_PASSWORD" >> "$GITHUB_OUTPUT"
-        shell: bash
 
-      - name: "ALKiln GitHub server - Get config"
+      - name: "💡 ALK0003 INFO: Get config"
         env:
           CONFIG: ${{ inputs.CONFIG_CONTENTS }}
+        shell: bash
         run: |
-          # ALKiln GitHub server info: config values
+          # 💡 ALK0003 INFO: Get config
           mkdir /tmp/config
           # Worth making this silent by defining a variable with > /dev/null...?
           if [ -n "$CONFIG" ]
           then
-            echo "ALKiln GitHub server - The developer did provide a custom docassemble config file as an input into this action."
+            echo "💡 ALK0004 INFO: The developer did provide a custom docassemble config file as an input into this action."
             echo "$CONFIG" > /tmp/config/myconfig.yml
             echo "CONFIG_ARGS=--env DA_CONFIG=/tmp/config/myconfig.yml --volume /tmp/config:/tmp/config " >> $GITHUB_ENV
           else
-            echo "ALKiln GitHub server - The developer did NOT provide a custom docassemble config file as an input into this action. Docassemble will use its default config."
+            echo "💡 ALK0005 INFO: The developer did NOT provide a custom docassemble config file as an input into this action. Docassemble will use its default config."
             echo "CONFIG_ARGS=" >> $GITHUB_ENV
           fi
-        shell: bash
 
       # Question: If in future we allow GitHub variables instead of just secrets,
       # should we let those be visible or prevent them along with the docker logs?
       # Also, does GitHub hide job environment output of secrets as well as
       # hiding the secrets' output from the job console?
 
-      # Define the var to prevent/show docker output
-      # TODO: Why are we only doing this for manually triggered workflows?
-      - name: Env var for showing docker output
+      # Define the var to prevent/show docker output based on action input
+      - name: "💡 ALK0006 INFO: Determine docker logs visibility"
         env:
           SHOW_DOCKER_OUTPUT: ${{ inputs.SHOW_DOCKER_OUTPUT }}
+        shell: bash
         run: |
-          # ALKiln GitHub server info: Docker logs visibility decision
+          # 💡 ALK0006 INFO: Determine docker logs visibility
           if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
             echo "OUTPUT_DOCKER=$SHOW_DOCKER_OUTPUT" >> $GITHUB_ENV
           else
             echo "OUTPUT_DOCKER=false" >> $GITHUB_ENV
           fi
-        shell: bash
 
       # Messages about output
-      - if: ${{ env.OUTPUT_DOCKER == 'false' }}
-        run: |
-          # ALKiln GitHub server info: no output
-          printf '===\nALKiln GitHub server - GitHub will now stop showing output to avoid possibly showing details about your config. If you want to get output to see more of what is going on, use "with:" and set the input "SHOW_DOCKER_OUTPUT" to "true". This output will only be visible to those who can already see the action output, like people with admin or write permissions.\n==='
+      - name: "💡 ALK0007 INFO: ALKiln will now hide docker output"
+        if: ${{ env.OUTPUT_DOCKER == 'false' }}
         shell: bash
-      - if: ${{ env.OUTPUT_DOCKER == 'true' }}
         run: |
-          # ALKiln GitHub server info: show output
-          printf '===\nALKiln GitHub server - GitHub will now show the output of docker creation. ALKiln cannot control this output. If you want to prevent output, use "with:" and set the input "SHOW_DOCKER_OUTPUT" to "false". This output will only be visible to those who can already see the action output, like people with admin or write permissions.\n==='
+          echo '===\n💡 ALK0007 INFO: ALKiln will now hide docker output to avoid possibly showing details about your config. If you want to get output to see more of what is going on, use "with:" and set the input "SHOW_DOCKER_OUTPUT" to "true". This output will only be visible to those who can already see the action output, like people with admin or write permissions.\n==='
+      - name: "💡 ALK0008 INFO: ALKiln will show docker output"
+        if: ${{ env.OUTPUT_DOCKER == 'true' }}
         shell: bash
+        run: |
+          echo '===\n💡 ALK0008 INFO: ALKiln will show docker output. ALKiln cannot control this output. If you want to prevent output, use "with:" and set the input "SHOW_DOCKER_OUTPUT" to "false". This output will only be visible to those who can already see the action output, like people with admin or write permissions.\n==='
 
       # TODO: Reduce these to 1 block by putting ` > /dev/null 2>&1` into an env var
-      # No output
-      - name: "ALKiln GitHub server - Download and start docker silently"
+      # No docker output
+      - name: "💡 ALK0009 INFO: Download and start docker silently"
         if: ${{ env.OUTPUT_DOCKER == 'false' }}
         env:
           CONFIG_ARGS: ${{ env.CONFIG_ARGS }}
+        shell: bash
         run: |
-          # ALKiln GitHub server info: Silent docker pull/run
+          # 💡 ALK0009 INFO: Download and start docker silently
           docker pull jhpyle/docassemble > /dev/null 2>&1
           docker run --name docassemble_container \
                      --env DA_ADMIN_EMAIL="$DA_ADMIN_EMAIL" \
@@ -132,14 +133,14 @@ runs:
                      $CONFIG_ARGS \
                      --cap-add SYS_PTRACE \
                      --memory="4gb" -d -p 80:80 jhpyle/docassemble > /dev/null 2>&1
-        shell: bash
       # With output
-      - name: "ALKiln GitHub server - Download and start docker"
+      - name: "💡 ALK0010 INFO: Download and start docker"
         if: ${{ env.OUTPUT_DOCKER == 'true' }}
         env:
           CONFIG_ARGS: ${{ env.CONFIG_ARGS }}
+        shell: bash
         run: |
-          # ALKiln GitHub server info: Docker pull/run
+          # 💡 ALK0010 INFO: Download and start docker
           docker pull jhpyle/docassemble
           docker run --name docassemble_container \
                      --env DA_ADMIN_EMAIL="$DA_ADMIN_EMAIL" \
@@ -148,18 +149,19 @@ runs:
                      $CONFIG_ARGS \
                      --cap-add SYS_PTRACE \
                      --memory="4gb" -d -p 80:80 jhpyle/docassemble
-        shell: bash
 
-      # Show the time it takes to start the server.
-      - if: ${{ env.OUTPUT_DOCKER == 'false' }}
-        run: |
-          # ALKiln GitHub server info: temporary visible logs
-          echo "ALKiln GitHub server - ALKiln will show safe ALKiln-only output temporarily as ALKiln waits for the server to start"
+      # Section for showing the time it takes to start the server.
+
+      - name: "💡 ALK0011 INFO: The following messages are not docker output"
+        if: ${{ env.OUTPUT_DOCKER == 'false' }}
         shell: bash
+        run: |
+          echo "💡 ALK0011 INFO: The following messages are not docker output, just ALKiln waiting for the server to start"
 
-      - name: "ALKiln GitHub server - Wait for server to start"
+      - name: "💡 ALK0012 INFO: Waiting for server to start"
+        shell: bash
         run: |
-          # ALKiln GitHub server - Wait for server to start
+          # 💡 ALK0012 INFO: Waiting for server to start
 
           # Reset the SECONDS variable
           SECONDS=0
@@ -168,39 +170,30 @@ runs:
 
           response="start"
           while [[ $response != *"200"* ]]; do
-            echo "ALKiln GitHub server - Time elapsed: $SECONDS seconds"
+            echo "💡 ALK0013 INFO: Time elapsed: $SECONDS seconds"
 
             # Check if max seconds till loading has passed
             if [[ $SECONDS -ge $MAX_SECONDS_FOR_DOCKER ]]; then
-              echo "ALKiln GitHub server Error: Timed out waiting for docker container to serve the site. If you want to give your docker container more timem to install, set the MAX_SECONDS_FOR_DOCKER input for this action."
+              echo "🤕 ALK0014 ERROR: Timed out waiting for docker container to serve the site. If you want to give your docker container more timem to install, set the MAX_SECONDS_FOR_DOCKER input for this action."
               exit 1
             fi
 
             # Set the variable to a new string value in each iteration
             response=$(curl -o /dev/null -s -w "%{http_code}\n" http://localhost:80/health_check?ready=1)
-            echo "ALKiln GitHub server - response is $response"
+            echo "💡 ALK0015 INFO: Response is $response"
 
             # Check if the string includes the desired text
             if [[ $response == *"200"* ]]; then
-              echo "ALKiln GitHub server - Success! The docker container is ready!"
+              echo "🌈 ALK0016 SUCCESS: Success! The docker container is ready!"
             else
-              echo "ALKiln GitHub server - The docker container is not ready yet. Will check again in 30 seconds."
+              echo "💡 ALK0017 INFO: The docker container is not ready yet. Will check again in 30 seconds."
               sleep 30
             fi
 
           done
-        shell: bash
-
-      # Output visibility message
-      - name: Message about docassemble install output
-        if: ${{ env.OUTPUT_DOCKER == 'false' }}
-        run: |
-          # ALKiln GitHub server info: Silent install message
-          echo "ALKiln GitHub server - ALKiln will now prevent output again"
-        shell: bash
 
       # Don't rely on the environment's version of python
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       # No output
@@ -223,32 +216,33 @@ runs:
 
       # Upload artifacts that devs can download on the Actions summary page
       # Only if the developer wants to get that info, though
-      - name: "ALKiln GitHub server - Get path names with date and time"
+      - name: "💡 ALK0018 INFO: Get path names with date and time"
         if: ${{ always() && env.OUTPUT_DOCKER == 'true' }}
+        shell: bash
         run: |
+          # 💡 ALK0018 INFO: Get path names with date and time
           echo "GITHUB_SERVER_LOG_FILE_NAME=/tmp/alkiln_docker_logs-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC.txt" >> $GITHUB_ENV
           echo "GITHUB_SERVER_ARTIFACT_NAME=alkiln_github_server-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
-        shell: bash
-      - name: "ALKiln GitHub server - Docker output"
+      - name: "💡 ALK0019 INFO: Create docker artifact data"
         if: ${{ always() && env.OUTPUT_DOCKER == 'true' }}
+        shell: bash
         run: |
+          # 💡 ALK0019 INFO: Create docker artifact data
           echo "$(docker output docassemble_container)" > "${{ env.GITHUB_SERVER_LOG_FILE_NAME }}"
-        shell: bash
-      - name: "ALKiln GitHub server - Upload artifacts folder"
+      - name: "💡 ALK0020 INFO: Upload artifacts folder"
         if: ${{ always() && env.OUTPUT_DOCKER == 'true' }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.GITHUB_SERVER_ARTIFACT_NAME }}
           path: ${{ env.GITHUB_SERVER_LOG_FILE_NAME }}
 
-      - run: |
-          # ALKiln GitHub server info: End silent output
-          echo "ALKiln GitHub server - ALKiln will show output again"
-        if: ${{ always() && env.OUTPUT_DOCKER == 'false' }}
-        shell: bash
+      - shell: bash
+        if: ${{ success() }}
+        run: |
+          echo "🌈 ALK0021 SUCCESS: ALKiln created the docker container and started the server!"
+
+      - shell: bash
+        if: ${{ failure() }}
+        run: |
+          echo "🤕 ALK0022 ERROR: Something went wrong. See above for more details."
 
-      - run: |
-          # ALKiln GitHub server info: Done
-          echo "ALKiln GitHub server - ALKiln will show output again"
-        if: ${{ always() && env.OUTPUT_DOCKER == 'false' }}
-        shell: bash

package/lib/cucumber_8_shim.js

@@ -2,6 +2,7 @@
 module.exports = async function wrapPromiseWithTimeout (
   promise,
   timeoutInMilliseconds,
+  // TODO: Turn this into a function
   timeoutMessage=''
 ) {
   /** Race between a timeout and another function and clean up
@@ -10,7 +11,7 @@ module.exports = async function wrapPromiseWithTimeout (
   * Taken from https://github.com/cucumber/cucumber-js/blob/main/src/time.ts#L42-L59
   */
   if ( timeoutMessage === '' ) {
-    timeoutMessage = `Action did not complete within ${ timeoutInMilliseconds } milliseconds`;
+    timeoutMessage = `🤕 ALK0174 ERROR: Action did not complete within ${ timeoutInMilliseconds } milliseconds`;
   }
 
   let timeoutId;

package/lib/docassemble/docassemble_api_REST.js

@@ -63,7 +63,7 @@ da.__delete_projects_starting_with = async function ( base_name, starting_num=1,
   while ( name_incrementor <= final_num ) {
     try {
       let project_name = base_name + name_incrementor;
-      console.log( `Deleting Project ${ project_name }` );
+      console.log( `🐞 ALKiln internal debug 1: Deleting Project ${ project_name }` );
 
       let options = {
         method: 'DELETE',
@@ -78,7 +78,7 @@ da.__delete_projects_starting_with = async function ( base_name, starting_num=1,
       await axios.request( options );
     } catch ( error ) {
       let response = error.response || {data: null}
-      console.log( {...error.toJSON(), data: response.data});
+      console.log({...error.toJSON(), data: response.data, alkiln_code: `🐞 ALKiln internal debug 2`});
     }
     name_incrementor++;
   }

package/lib/docassemble/docassemble_api_interface.js

@@ -89,7 +89,7 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
 
   // Defaults
   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.` });
+  log.info({ type: `da api`, code: `ALK0166`, pre: `Waiting for the docassemble server to respond. Will wait for ${ timeout/1000 } seconds at most.` });
   
   try {
     let start_time = Date.now()
@@ -97,7 +97,7 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
     let response = await _da_REST.get_dev_id( timeout );
     let end_time = Date.now()
     if ( response && response.data && response.data.id ) {
-      log.info({ pre: `The docassemble server responded after ${ (end_time - start_time)/1000 } seconds.` });
+      log.info({ type: `da api`, code: `ALK0167`, pre: `The docassemble server responded after ${ (end_time - start_time)/1000 } seconds.` });
       return false;
     }
 
@@ -106,13 +106,16 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
     if ( is_timeout_error( error ) ) {
       // Anything that's waiting for the server to not be busy does not want
       // to move forward without a free server.
-      log.info({ pre: `The docassemble server was still busy after ${ timeout/1000 } seconds.` });
+      log.info({ type: `da api`, code: `ALK0168`, pre: `The docassemble server was still busy after ${ timeout/1000 } seconds.` });
     } else {
       // Not sure what to do for other errors. It could be a server
       // error, like an 'Access Denied' error, which should be handled.
       log.error({
+        type: `da api`,
+        code: `ALK0169`,
         pre: `Tried to check if the docassemble server was busy, but `
-        + `ran into an unexpected error. The error didn't indicate a busy server, though.`
+        + `ran into an unexpected error. The error didn't indicate a busy server, though. Error message:\n`
+        + error
       });
     }
 
@@ -180,14 +183,15 @@ da_i.delete_project = async function ( delete_options ) {
   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 }` });
+  log.info({ type: `da api`, code: `ALK0170`, pre: `Trying to delete Project ${ project_name }` });
 
   try {
     let response = await _da_REST.delete_project( timeout );
-    log.info({ pre: `Deleted Project "${ project_name }"` });
+    log.info({ type: `da api`, code: `ALK0171`, pre: `Deleted Project "${ project_name }"` });
   } catch ( error ) {
-    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.` });
+    let msg = `Ran into an error when deleting Project "${ project_name }". See https://docassemble.org/docs/api.html#playground_delete_project.`
+    log.error({ type: `da api`, code: `ALK0172`, pre: msg });
+    log.debug({ type: `da api`, code: `ALK0173`, pre: msg });
     throw error;
   }
 

package/lib/docassemble/server_install.js

@@ -23,14 +23,15 @@ const server_install = async () => {
   // Get names of all folders in repo "docassemble" folder
   let chosen_folder = folders[0];
   if ( folders.length === 0 ) {
-    let msg = `There are 0 folders at ${path}. Tests won't run.`;
-    log.error({ type: `setup`, data: msg })
+    let msg = `There are 0 folders at ${path}. Stopping tests.`;
+    log.error({ type: `setup`, code: `ALK0044`, data: msg })
     throw new ReferenceError( msg );
   }
 
   if ( folders.length > 1 ) {
     log.warn({
       type: `setup`,
+      code: `ALK0045`,
       data: `There are ${folders.length} folders at ${path}: "${folders.join('", "')}". ALKiln chose to use the folder "${chosen_folder}".`
     })
   }

package/lib/docassemble/setup.js

@@ -18,7 +18,7 @@ const setup = async () => {
   let project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
   session_vars.save_project_name( project_name );
 
-  log.info({ type: `setup`, pre: `Starting to upload this package to `
+  log.info({ type: `setup`, code: `ALK0046`, pre: `Starting to upload this package to `
     + `a new Project called ${project_name} in the Playground `
     + `of your server's testing account. It may take a couple of minutes.` });
 
@@ -43,14 +43,16 @@ const setup = async () => {
   if ( result.status !== 0 ) {
     log.error({
       type: `setup`,
+      code: `ALK0047`,
       pre: `Status code ${ result.status }. Could not dainstall this package on your server. See above for more details.`
     });
     throw(result.stderr);
   }
 
-  log.info({
+  log.success({
     type: `setup`,
-    pre: `Success! ALKiln created a Project in your Playground named "${ project_name }"` 
+    code: `ALK0048`,
+    pre: `ALKiln created a Project in your Playground named "${ project_name }"!`
   });
 };  // Ends setup();
 

package/lib/docassemble/takedown.js

@@ -9,16 +9,16 @@ const takedown = async () => {
   *   DOCASSEMBLE_DEVELOPER_API_KEY secret, delete the
   *   Project created for this test.
   *   For local development, clean up project name file. */
-  log.info({ type: `takedown`, pre: `Trying to remove the docassemble Project from the testing account.` });
+  log.info({ type: `takedown`, code: `ALK0177`, pre: `Trying to remove the docassemble Project from the testing account.` });
   // Explicit try-catch prevents "Unhandled promise rejection error"
   // avoids showing confusing node errors to users that they shouldn't have to fix
   try {
     await da_i.delete_project();
     session_vars.delete_project_name();
-    log.info({ type: `takedown`, pre: `Success! Test takedown has finished successfully.` });
+    log.success({ type: `takedown`, code: `ALK0178`, pre: `Test takedown has finished successfully!` });
   } catch (error) {
-    log.error({type: `takedown`, pre: `could not delete project`, data: JSON.stringify(error, null, 4)})
-    // we don't re-throw the exception, so make sure to exit with 1 to let Github Actions know the script failed
+    log.error({type: `takedown`, code: `ALK0179`, pre: `Could not delete project`, data: JSON.stringify(error, null, 4)})
+    // we don't re-throw the exception, so make sure to exit with 1 to let GitHub Actions know the script failed
     process.exitCode = 1;
   }
 };

package/lib/run_cucumber.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
 const fs = require('fs');
+const cucumber_api = require('@cucumber/cucumber/api');
+
 const log = require('./utils/log');
 const session_vars = require('./utils/session_vars');
 
-const cucumber_api = require('@cucumber/cucumber/api');
-
 function build_config( command_args ) {
   // Turn all the paths to the sources folders into paths to the feature files
   let sources_paths = session_vars.get_sources_paths();
@@ -51,7 +51,7 @@ function build_config( command_args ) {
   /** Create the cucumber config, run the tests, create and
   *   manipluate the output. */
   const environment = { cwd: process.cwd() };
-  console.log("alkiln-run: environment: %o", environment);
+  log.info({ type: `run`, code: `ALK0049`, pre: `environment`, data: environment });
 
   // We'll use the user info to construct the possible paths to /sources
   let id = session_vars.get_user_id();
@@ -79,46 +79,54 @@ function build_config( command_args ) {
   let one_dir_exists = session_vars.set_sources_paths( sources_list );
   if ( !one_dir_exists ) {
     // If we don't throw, it'll be more confusing when no tests run
-    throw new ReferenceError( `ALKiln ERROR: ALKiln can't find your "sources" folder(s). See above for details.`);
+    let msg = `ALKiln can't find your "sources" folder(s). See above for details.`;
+    let code = `ALK0050`
+    log.error({ type: `run`, code: code, pre: msg });
+    throw new ReferenceError(`🤕 ${ code } run ERROR: ${ msg }`);
   }
   
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: build_config( argv ),
   }, environment);
 
-  console.log("alkiln-run: runConfiguration: %o", runConfiguration);
+  log.info({ type: `run`, code: `ALK0051`, pre: `runConfiguration`, data: runConfiguration });
 
-  var path = require('path');
+  var path = require(`path`);
   var codeDir = path.dirname(require.main.filename);
-  console.log("alkiln-run: working directory: %o", codeDir);
+  log.info({ type: `run`, code: `ALK0052`, pre: `working directory`, data: codeDir });
   const support = await cucumber_api.loadSupport({ support: {
     requireModules: [ `${ codeDir }/index.js` ],
     requirePaths: [ `${ codeDir }/index.js` ],
     importPaths: [],
   }, sources: {paths: []}}, environment);
 
-  console.log(`\n\n`);
+  log.info({ type: `run`, code: `ALK0053`, pre: `working directory`, data: codeDir });
+  log.info({ type: `plain`, pre: `\n\n` });
 
   const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
-  console.log("alkiln-run: success: %b", success);
+  if ( success ) {
+    log.info({ type: `run`, code: `ALK0054`, pre: `Cucumber executed correctly` });
+  } else {
+    log.error({ type: `run`, code: `ALK0055`, pre: `Cucumber ran into an error` });
+  }
   const exitCode = success ? 0 : 1;
   process.exitCode = exitCode;
 
   // This is hardcoded information from `provide_config` above.
   // This code isn't used for anything other than detecting and removing color codes.
   let summary_file_name = 'cucumber-report.txt';
-  fs.readFile(summary_file_name, 'utf8', (err, data) => {
+  fs.readFile(summary_file_name, 'utf8', (err, text) => {
     if (err) {
-      console.error(err);
+      log.error({ type: `run`, code: `ALK0056`, pre: `cucumber report`, data: err });
       return;
     }
 
     // Replace terminal color codes, if present
     // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode
-    data = data.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
+    text = text.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
 
     // Put it in the correct file in the correct folder
     let artifacts_path = session_vars.get_artifacts_path_name();
-    fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, data);
+    fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, `\n\n${text}`);
   });
 })();