@suffolklitlab/alkiln 5.10.3 → 5.11.0

package/lib/steps.js

@@ -186,7 +186,7 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   // TODO: Move this to the `download` Step and only do it once per scenario
   // Allow developer to save download files
   let custom_download_behavior_timeout = new Promise(async ( resolve, reject ) => {
-    let page_timeout = setTimeout(function() {reject( `Took too long to set download behavior.` ); }, scope.timeout);
+    let page_timeout = setTimeout(function() {reject( `🤕 ALK0057 ERROR: Took too long to set download behavior.` ); }, scope.timeout);
     // self-invoke an anonymous async function so we don't have to
     // abstract the details of resolving and rejecting.
     (async function() {
@@ -263,10 +263,11 @@ Given(/I go to "([^"]+)"/i, {timeout: -1}, async ( url ) => {
   let result = await wrapPromiseWithTimeout(
     scope.page.goto( url, { waitUntil: 'domcontentloaded', timeout: scope.timeout }),
     scope.timeout,
-    `It took to long to get to "${ url }"`
+    // TODO: Turn this into a function
+    `🤕 ALK0058 ERROR: It took to long to get to "${ url }"`
   );
 
-  reports.addToReport(scope, { type: `info`, value: `Successfully went to "${ url }"` });
+  reports.addToReport(scope, { type: `info`, code: `ALK0059`, value: `Successfully went to "${ url }"` });
   return result;
 });
 
@@ -355,7 +356,10 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
         + `too long to try to reach it (over ${ scope.timeout/1000/60 } min). The `
         + `test got stuck on "${ id }".`
         let error = non_reload_report_msg;
-        await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
+          code: `ALK0060`,
+          message: non_reload_report_msg,
+        }, error });
       };  // Ends on_page_timeout()
       let page_timeout_id = setTimeout(on_page_timeout, scope.timeout);
 
@@ -376,9 +380,11 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
             from_story_table: true,
           });
 
-          if ( session_vars.get_debug() ) {
-            console.log( `Rows, including special rows:`, JSON.stringify( ensured_var_data ));
-          }
+          log.debug({
+            type: `info`,
+            code: `ALK0061`,
+            pre: `Rows, including special rows:, ${JSON.stringify( ensured_var_data )}`,
+          });
 
           // THIS FUNCTION ACTUALLY MATTERS
           // Some errors happen in there to be closer to the relevant code. We'd have to try/catch anyway.
@@ -388,7 +394,7 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
           resolve();
         } catch ( err ) {
           let err_msg = `Error occurred when tried to answer fields on question "${ id }".`
-          reports.addToReport( scope, { type: `error`, value: err_msg });
+          reports.addToReport( scope, { type: `error`, code: `ALK0062`, value: err_msg });
           // Throw error instead?
           reject( err );
         } finally {
@@ -418,13 +424,13 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
 
   // Add full used table to report so it can be copied if needed.
   // TODO: Should we/How do we get this in the final scenario report instead of here?
-  reports.addToReport( scope, { type: `note`, value: `\n${ ' '.repeat(2) }Rows that got set:` });
-  reports.addToReport( scope, { type: `step`, value: `${ ' '.repeat(4) }And I get to the question id "${ target_id }" with this data:` });
-  reports.addToReport(scope, { type: `row`, value: `${ ' '.repeat(6) }| var | value | trigger |`, });
+  reports.addToReport( scope, { type: `note info`, code: `ALK0063`, value: `\n${ ' '.repeat(2) }Rows that got set:` });
+  reports.addToReport( scope, { type: `step info`, code: `ALK0064`, value: `${ ' '.repeat(4) }And I get to the question id "${ target_id }" with this data:` });
+  reports.addToReport(scope, { type: `row info`, code: `ALK0065`, value: `${ ' '.repeat(6) }| var | value | trigger |`, });
   let at_least_one_row_was_NOT_used = false;
   for ( let row of sorted_rows ) {
     if ( row.times_used > 0 ) {
-      reports.addToReport(scope, { type: `row`, value: row.report_str, });
+      reports.addToReport(scope, { type: `row info`, code: `ALK0066`, value: row.report_str, });
     } else {
       at_least_one_row_was_NOT_used = true;
     }
@@ -432,135 +438,19 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
 
   // Add unused rows if needed
   if ( at_least_one_row_was_NOT_used ) {
-    reports.addToReport( scope, { type: `note`, value: `${ ' '.repeat(2) }Unused rows:` });
+    reports.addToReport( scope, { type: `note info`, code: `ALK0067`, value: `${ ' '.repeat(2) }Unused rows:` });
     for ( let row of sorted_rows ) {
       if ( row.times_used === 0 ) {
-        reports.addToReport(scope, { type: `row`, value: row.report_str, });
+        reports.addToReport(scope, { type: `row info`, code: `ALK0068`, value: row.report_str, });
       }
     }
   } else {
-    reports.addToReport(scope, { type: `note`, value: `${ ' '.repeat(2) }All rows were used` });
+    reports.addToReport(scope, { type: `note info`, code: `ALK0069`, value: `${ ' '.repeat(2) }All rows were used` });
   }
 
-  reports.addToReport(scope, { type: `note`, value: `` });
+  reports.addToReport(scope, { type: `plain`, value: `` });
 });
 
-// When(/^foo id "([^"]+)"/, {timeout: -1}, async (target_id, raw_var_data) => {
-//   /* NO CUCUMBER TIMEOUT. Must handle timeout ourselves:
-//   * https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/timeouts.md#disable-timeouts
-//   * Iterate in here to keep timeout reasonable */
-
-//   // Note: Why do we not just stop when we've used all the vars in the table or
-//   // reach the last var? Vars are not required to be given in sequence and pages that
-//   // have non-button fields don't usually have a var assigned to the 'continue' button.
-//   // Alternative: require vars even for 'continue' pages. Then in loop require at least one var
-//   // to be found on a page before hitting 'continue'. That requires detecting navigation because
-//   // pages with fields will not have a var for the continue button, so there will
-//   // still have to be some automatic continuing.
-//   // It also seems harsh, but more reliable.
-//   // Ask developers what they'd like.
-
-
-//   let supported_table = await scope.normalizeTable( scope, { raw_var_data });
-
-//   let { question_has_id, id, id_matches } = await scope.examinePageID( scope, target_id );
-//   // Until we reach the target page, hit an error, or time out (take too long)
-//   while ( !id_matches ) {
-//     let custom_timeout = new Promise(function( resolve, reject ) {
-
-//       // Set up the timeout that avoids infinite loops
-//       let on_page_timeout = async function() {
-
-//         let non_reload_report_msg = `The target id was "${ target_id }", but it took `
-//         + `too long to try to reach it (over ${ scope.timeout/1000/60 } min). The `
-//         + `test got stuck on "${ id }".`
-//         let error = non_reload_report_msg;
-//         await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
-//       };  // Ends on_page_timeout()
-//       let page_timeout_id = setTimeout(on_page_timeout, scope.timeout);
-
-//       // self-invoke an anonymous async function so we don't have to
-//       // abstract the details of resolving and rejecting.
-//       // If we need to call recursively, signature function might look like:
-//       // func( scope, { resolve, reject, supported_table, page_timeout_id })
-//       // Maybe list of timeout and/or interval ids in state that can all be cleared at once?
-//       (async function() {
-//         try {
-//           let { question_has_id, id, id_matches } = await scope.examinePageID( scope );
-
-//           // Add special rows. Basically, do weirder things.
-//           // TODO: Remove from_story_table - no longer needed if only called from in here
-//           let ensured_var_data = await scope.ensureSpecialRows( scope, {
-//             var_data: supported_table,
-//             from_story_table: true,
-//           });
-
-//           if ( session_vars.get_debug() ) {
-//             console.log( `Rows, including special rows:`, JSON.stringify( ensured_var_data ));
-//           }
-
-//           // Some errors happen in there to be closer to the relevant code. We'd have to try/catch anyway.
-//           let error = await scope.setFields(scope, { var_data: ensured_var_data, id, ensure_navigation: true });
-//           if ( error.was_found ) { await scope.throwPageError( scope, { id: id }); }
-//           resolve();
-//         } catch ( err ) {
-//           let err_msg = `Error occurred when tried to answer fields on question "${ id }".`
-//           reports.addToReport( scope, { type: `error`, value: err_msg });
-//           // Throw error instead?
-//           reject( err );
-//         } finally {
-//           clearTimeout( page_timeout_id );  // prevent temporary hang at end of tests
-//         }
-//       })();
-//     });  // ends custom_timeout for setFields
-
-//     await custom_timeout;
-
-//     // Prep for next loop
-//     ({ question_has_id, id, id_matches } = await scope.examinePageID( scope, target_id ));
-
-//   }  // ends while !id_matches
-//   // Can anything unsatisfactory get through here?
-
-//   // Add report strings from supported table, not an altered one
-//   for ( let row of supported_table ) {
-//     row.report_str = `${ reports.convertToOriginalStoryTableRow(scope, { row_data: row }) }`;
-//   }
-//   // 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; }
-//     return 0;
-//   });
-
-//   // Add full used table to report so it can be copied if needed.
-//   // TODO: Should we/How do we get this in the final scenario report instead of here?
-//   reports.addToReport( scope, { type: `note`, value: `\n${ ' '.repeat(2) }Rows that got set:` });
-//   reports.addToReport( scope, { type: `step`, value: `${ ' '.repeat(4) }And I get to the question id "${ target_id }" with this data:` });
-//   reports.addToReport(scope, { type: `row`, value: `${ ' '.repeat(6) }| var | value | trigger |`, });
-//   let at_least_one_row_was_NOT_used = false;
-//   for ( let row of sorted_rows ) {
-//     if ( row.times_used > 0 ) {
-//       reports.addToReport(scope, { type: `row`, value: row.report_str, });
-//     } else {
-//       at_least_one_row_was_NOT_used = true;
-//     }
-//   }
-
-//   // Add unused rows if needed
-//   if ( at_least_one_row_was_NOT_used ) {
-//     reports.addToReport( scope, { type: `note`, value: `${ ' '.repeat(2) }Unused rows:` });
-//     for ( let row of sorted_rows ) {
-//       if ( row.times_used === 0 ) {
-//         reports.addToReport(scope, { type: `row`, value: row.report_str, });
-//       }
-//     }
-//   } else {
-//     reports.addToReport(scope, { type: `note`, value: `${ ' '.repeat(2) }All rows were used` });
-//   }
-
-//   reports.addToReport(scope, { type: `note`, value: `` });
-// });
 
 //#####################################
 //#####################################
@@ -609,15 +499,15 @@ Then(/the (?:question|page|screen) id should be "([^"]+)"/i, { timeout: -1 }, as
   // No question id exists
   let no_id_msg = `Did not find any question id.`;
   if ( !question_has_id ) {
-    reports.addToReport( scope, { type: `error`, value: no_id_msg });
+    reports.addToReport( scope, { type: `error`, code: `ALK0070`, value: no_id_msg });
   }
   expect( question_has_id , no_id_msg ).to.be.true;
 
   // Wrong question id
   let no_match_msg = `The question id was supposed to be "${ question_id }"`
-    + `, but it's actually "${ id }".`;
+    + `, but it is actually "${ id }".`;
   if ( !id_matches ) {
-    reports.addToReport( scope, { type: `error`, value: no_match_msg });
+    reports.addToReport( scope, { type: `error`, code: `ALK0071`, value: no_match_msg });
   }
   expect( id_matches, no_match_msg ).to.be.true;
 
@@ -630,7 +520,7 @@ Then(/I ?(?:should)? see the phrase "([^"]+)"/i, async ( phrase ) => {  // √
   const bodyText = await scope.page.$eval('body', elem => elem.innerText);
 
   let msg = `The text "${ phrase }" SHOULD be on this page, but it's NOT.`;
-  if ( !bodyText.includes( phrase )) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !bodyText.includes( phrase )) { reports.addToReport(scope, { type: `error`, code: `ALK0072`, value: msg }); }
   expect( bodyText, msg ).to.contain( phrase );
 
   await scope.afterStep(scope);
@@ -644,7 +534,7 @@ Then(/I should not see the phrase "([^"]+)"/i, async ( phrase ) => {  // √
   const bodyText = await scope.page.$eval('body', elem => elem.innerText);
 
   let msg = `The text "${ phrase }" should NOT be on this page, but it IS here.`;
-  if ( bodyText.includes( phrase )) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( bodyText.includes( phrase )) { reports.addToReport(scope, { type: `error`, code: `ALK0073`, value: msg }); }
   expect( bodyText, msg ).not.to.contain( phrase );
 
   await scope.afterStep(scope);
@@ -654,7 +544,7 @@ Then('an element should have the id {string}', async ( id ) => {  // √
   const element = await scope.page.$('#' + id);
 
   let msg = `No element on this page has the ID "${ id }".`;
-  if ( !element ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !element ) { reports.addToReport(scope, { type: `error`, code: `ALK0074`, value: msg }); }
   expect( element, msg ).to.exist;
 
   await scope.afterStep(scope);
@@ -709,7 +599,7 @@ Then(/I (don't|can't|don’t|can’t|cannot|do not) continue/, async (unused) =>
   *    Can other things trigger navigation? Re: other inputs things
   *    like 'Enter' acting like a click is a test for docassemble */
   let msg = `The page should have stopped the user from continuing, but the user was able to continue.`;
-  if ( scope.navigated ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( scope.navigated ) { reports.addToReport(scope, { type: `error`, code: `ALK0075`, value: msg }); }
   expect( scope.navigated, msg ).to.be.false;
 
   await scope.afterStep(scope);
@@ -720,12 +610,12 @@ Then('I will be told an answer is invalid', async () => {  // √
   let { was_found, error_handlers } = await scope.checkForError( scope );
 
   let no_error_msg = `No error message was found on the page`;
-  if ( !was_found ) { reports.addToReport(scope, { type: `error`, value: no_error_msg }); }
+  if ( !was_found ) { reports.addToReport(scope, { type: `error`, code: `ALK0076`, value: no_error_msg }); }
   expect( was_found, no_error_msg ).to.be.true;
 
   let was_user_error = error_handlers.complex_user_error !== undefined || error_handlers.simple_user_error !== undefined;
-  let not_user_error_msg = `The error was a system error, not an invalid user answer. Check for the picture of the page's error if the step did not use any secret variables.`;
-  if ( !was_user_error ) { reports.addToReport(scope, { type: `error`, value: not_user_error_msg }); }
+  let not_user_error_msg = `The error was a system error, not an invalid user answer. Check for the picture of the page's error if the Step did not use any secret variables.`;
+  if ( !was_user_error ) { reports.addToReport(scope, { type: `error`, code: `ALK0077`, value: not_user_error_msg }); }
   expect( was_user_error, not_user_error_msg ).to.be.true;
 
   await scope.afterStep(scope);
@@ -736,7 +626,7 @@ Then('I arrive at the next page', async () => {  // √
   *    Can other things trigger navigation? Re: other inputs things
   *    like 'Enter' acting like a click is a test for docassemble */
   let msg = `User did not arrive at the next page.`
-  if ( !scope.navigated ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !scope.navigated ) { reports.addToReport(scope, { type: `error`, code: `ALK0078`, value: msg }); }
   expect( scope.navigated, msg ).to.be.true;
   await scope.afterStep(scope);
 });
@@ -747,7 +637,7 @@ Then('I should see the link {string}', async ( linkText ) => {  // √
   let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
 
   let msg = `Cannot find a link with the text "${ linkText }".`;
-  if ( !link ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0079`, value: msg }); }
   expect( link, msg ).to.exist;
 
   await scope.afterStep(scope);
@@ -758,7 +648,7 @@ Then('I should see the link to {string}', async ( url ) => {  // √
   let link = await scope.page.$(`*[href="${ url }"]`);
 
   let msg = `Cannot find a link to "${ url }".`;
-  if ( !link ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0080`, value: msg }); }
   expect(link, msg ).to.exist;
   
   await scope.afterStep(scope);
@@ -774,7 +664,7 @@ Then(/the "([^"]+)" link leads to "([^"]+)"/, async (linkText, expected_url) =>
   let actual_url = await prop_obj.jsonValue();
 
   let msg = `Cannot find a link with the text "${ linkText }" leading to ${ expected_url }.`;
-  if ( actual_url !== expected_url ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( actual_url !== expected_url ) { reports.addToReport(scope, { type: `error`, code: `ALK0081`, value: msg }); }
   expect( actual_url ).to.equal( expected_url );
 
   await scope.afterStep(scope);
@@ -793,7 +683,7 @@ Then(/the "([^"]+)" link opens in (a new window|the same window)/, async (linkTe
     || ( !should_open_a_new_window && !opens_a_new_window );
 
   let msg = `The link "${ linkText }" does NOT open in ${ which_window }.`;
-  if ( !hasCorrectWindowTarget ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+  if ( !hasCorrectWindowTarget ) { reports.addToReport(scope, { type: `error`, code: `ALK0082`, value: msg }); }
   expect( hasCorrectWindowTarget, msg ).to.be.true;
 
   await scope.afterStep(scope);
@@ -828,6 +718,7 @@ Then(/(?:the )?text(?: in)?(?: the)?(?: JSON)?(?: var)?(?:iable)?(?: )?"([^"]+)"
   if ( actual_value !== expected_value ) {
     reports.addToReport( scope, {
       type: `error`,
+      code: `ALK0083`,
       value: `The variable "${ var_name }" was not equal to the expected `
         + `value on the "${ scope.page_id }" screen. Check `
         + `${ json_path } to see the page's JSON variables.`
@@ -925,7 +816,11 @@ When(/I check the page for (?:accessibility|a11y) issues/i, {timeout: -1}, async
     scope.checkForA11y(scope),
     scope.timeout
   )
-  let msg = `Found potential accessibility issues on the ${ scope.page_id } screen. Details in ${ axe_filepath }.`;
+
+  let msg = `Found potential accessibility issues on the "${ scope.page_id }" screen. Details in ${ axe_filepath }.`;
+  if ( !passed ) {
+    reports.addToReport( scope, { type: `error`, code: `ALK0084`, value: msg });
+  }
   expect( passed, msg ).to.be.true;
 });
 
@@ -955,7 +850,8 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
   scope.paths.random_screenshots = random_input_path;
   fs.mkdirSync( scope.paths.random_screenshots );
   reports.addToReport( scope, {
-    type: 'row',
+    type: 'row info',
+    code: `ALK0085`,
     value: `Testing interview with random input (in ${ random_input_path })`
   });
 
@@ -996,6 +892,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
         if ( !has_content ) {
           reports.addToReport( scope, {
             type: `error`,
+            code: `ALK0086`,
             value: no_content_err
           });
           reject( no_content_err );
@@ -1003,7 +900,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
         } else {
           let timeout_message = `The page with an id of "${ id }" took too long`
             + ` to fill with random answers (over ${ scope.timeout/1000/60 } min).`
-          reports.addToReport( scope, { type: `error`, value: timeout_message });
+          reports.addToReport( scope, { type: `error`, code: `ALK0087`, value: timeout_message });
           reject( timeout_message );
         }
 
@@ -1050,6 +947,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
               has_thrown = true;
               reports.addToReport( scope, {
                 type: `error`,
+                code: `ALK0088`,
                 value: no_content_err
               });
               reject( no_content_err );
@@ -1079,6 +977,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
           if ( !has_content ) {
             reports.addToReport( scope, {
               type: `error`,
+              code: `ALK0089`,
               value: no_content_err
             });
             reject( no_content_err );
@@ -1087,7 +986,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
           } else {
             let err_msg = `The page with the question id "${ id }" errored when trying to fill`
               + ` it with random answers: ${ error.name }`
-            reports.addToReport( scope, { type: `error`, value: err_msg });
+            reports.addToReport( scope, { type: `error`, code: `ALK0090`, value: err_msg });
             reject( error );
           }  // ends if !has_content
 
@@ -1287,8 +1186,7 @@ After(async function(scenario) {
 
   // Log errors
   if ( scenario.result.message ) {
-    log.debug({ type: `error`, pre: scenario.result.message });
-    // log.debug({ type: `error`, pre: scenario.result.message, verbose: true });
+    log.debug({ type: `info`, code: `ALK0091`, pre: `cucumber error: ${ scenario.result.message }` }); //, verbose: true });
   }
 
   let changeable_test_status = scenario.result.status;
@@ -1298,7 +1196,8 @@ After(async function(scenario) {
     changeable_test_status = `FAILED`;
     reports.addToReport(scope, {
       type: `error`,
-      value: `Accessibility standards weren't met. See information above.`
+      code: `ALK0092`,
+      value: `Accessibility standards tests failed. See information above.`
     });
   }
 
@@ -1307,6 +1206,7 @@ After(async function(scenario) {
     changeable_test_status = `FAILED`;
     reports.addToReport(scope, {
       type: `error`,
+      code: `ALK0093`,
       value: `PDF comparison failed ${ scope.failed_pdf_compares.length } time(s)\n---\n${ msg }\n---\n`
     });
   }
@@ -1315,15 +1215,18 @@ After(async function(scenario) {
   reports.setReportScenarioStatus( scope, { status: changeable_test_status });
 
   if (changeable_test_status !== `PASSED`) {
-    if ( session_vars.get_debug() ) {
-      console.log( `Non-passed status occurred while running test:`, changeable_test_status );
-    }
+    log.debug({
+      type: `error`,
+      code: `ALK0094`,
+      pre: `Non-passed status occurred while running test: ${changeable_test_status}`,
+    });
 
     if ( scope.page ) {
 
       if ( !!scope.disable_error_screenshot ) {
         reports.addToReport(scope, {
-          type: `row`,
+          type: `row info`,
+          code: `ALK0095`,
           value: `For security, ALKiln will avoid creating a picture of the page for this error. It's possible a secret is being used on this screen.`
         });
       } else {
@@ -1347,7 +1250,7 @@ After(async function(scenario) {
 
     // This has to come after the security message or security message doesn't print. Not sure why.
     if (changeable_test_status === `FAILED`) {
-      reports.addToReport(scope, { type: `outcome`, value: `**-- Scenario Failed --**` });
+      reports.addToReport(scope, { type: `outcome failure info`, code: `ALK0096`, value: `**-- Scenario Failed --**` });
     }
 
   }  // ends if not passed
@@ -1407,11 +1310,14 @@ After(async function(scenario) {
         // TODO: Should a more specific message about signing out get into the report no matter what?
         // If so, what should the message be in order to not get confused with these other messages?
         let non_reload_report_msg = `It took too long to sign out in preparation for the next test.`;
-        await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
+          code: `ALK0097`,
+          message: non_reload_report_msg,
+        }, error });
       } else {
         // Throw any non-timeout error
         let err_msg = `Error occurred when ALKiln tried to sign out in preparation for the next test.`
-        reports.addToReport( scope, { type: `error`, value: err_msg });
+        reports.addToReport( scope, { type: `error`, code: `ALK0098`, value: err_msg });
         throw error;
       }  // ends if error is timeout error
 
@@ -1419,13 +1325,22 @@ After(async function(scenario) {
 
   }  // ends if scope.page
 
+  // INTERNAL WARNING: TODO: A console.log here prevents the try/catch from
+  // throwing an error. Why is that? Does it somehow make sure that scope.page
+  // gets destroyed?
+
+  // console.log('This stops try/catch from throwing an error in some cases.');
+
+  // More internal testing stuff
   if ( changeable_test_status === `FAILED` ) {
     // If the result object status wasn't failure and we still want
     // the tests to fail, as with a11y tests, we can't mess with the
     // cucumber result.status object because it will cause unwanted
     // errors. We have to throw an error here instead.
     if ( scenario.result.status !== `FAILED` ) {
-      throw new Error(`The test failed. See the report above for more information.`);
+      let msg = `The test unexpectedly didn't fail. Scenario status: ${scenario.result.status}.`
+      reports.addToReport( scope, { type: `error`, code: `ALK0099`, value: msg });
+      throw new Error(msg);
     }
   } else {
     // Some internal test failures should be ok
@@ -1434,6 +1349,11 @@ After(async function(scenario) {
     // https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/api_reference.md#setdefinitionfunctionwrapperwrapper
     scenario.result.status = changeable_test_status;
   }
+  // Ends more internal testing stuff
+
+  // WARNING: TODO: console.log can prevent a sign-out error. What race condition is going on?
+  log.debug({ type: `cucumber`, code: `ALK0100`, verbose: true, pre: `Scenario AfterStep() message`, data: scenario.result.message });
+
 });
 
 AfterAll(async function() {

package/lib/utils/log.js

@@ -1,64 +1,87 @@
 const fs = require('fs');
 const session_vars = require( './session_vars' );
 
+// ? 🌈 💡 🔎 🤕 🐞
+
 let log = {};
 module.exports = log;
 
-let create_msg_start = function ( types, pre='' ) {
-  let parts = [ `ALKiln`, ...types ];
-  let start = parts.join(` `);
-  return `${ start }: ${ pre }`;
+let create_msg_start = function ( types, pre='', code=`? ALK0000` ) {
+  // ? - unknown (fallback)
+  let types_str = types.join(` `);
+  if ( types_str.includes(`plain`) ) {
+    return pre;
+  } else {
+    return `${ code } ${ types_str }: ${ pre }`;
+  }
 };
 
-log.info = function ({ type='', pre='', data='', post='' }) {
-  /* Log info msg with the given information and strings, prepended with `ALKiln`.
-  *    `type` is often something like 'setup', 'takedown', etc. */
-  let start = create_msg_start([ type ], pre );
+// Where is this used?
+log.success = function ({ type='', pre='', data='', post='', code=`ALK0000` }) {
+  /** Log success msg with the given information and strings, prepended with `ALKiln`.
+   *  `type` is often something like 'setup', 'takedown', etc. */
+  // √ - info (fallback)
+  let start = create_msg_start([ type, `SUCCESS` ], pre, `🌈 ${code}` );
   // Log them each on a separate line
   console.info( `${ start }` );
   if ( data ) { console.info( data ); }
   if ( post ) { console.info( post ); }
 };
 
-log.warn = function ({ type='', pre='', data='', post='' }) {
-  /* Log warning msg with the given information and strings, prepended with `ALKiln`.
-  *    `type` is often something like 'setup', 'takedown', etc. */
-  let start = create_msg_start([ type, `WARNING` ], pre );
+// Where is this used?
+log.info = function ({ type='', pre='', data='', post='', code=`ALK0000` }) {
+  /** Log info msg with the given information and strings, prepended with `ALKiln`.
+   *  `type` is often something like 'setup', 'takedown', etc. */
+  // & - info (fallback)
+  let start = create_msg_start([ type, `INFO` ], pre, `💡 ${code}` );
+  // Log them each on a separate line
+  console.info( `${ start }` );
+  if ( data ) { console.info( data ); }
+  if ( post ) { console.info( post ); }
+};
+
+// Where is this used?
+log.warn = function ({ type='', pre='', data='', post='', code=`ALK0000` }) {
+  /** Log warning msg with the given information and strings, prepended with `ALKiln`.
+   *  `type` is often something like 'setup', 'takedown', etc. */
+  // ! - warning (fallback)
+  let start = create_msg_start([ type, `WARNING` ], pre, `🔎 ${code}` );
   // Log them each on a separate line
   console.warn( `${ start }` );
   if ( data ) { console.warn( data ); }
   if ( post ) { console.warn( post ); }
 };
 
-log.error = function ({ type='', pre='', data='', post='' }) {
-  /* Log error msg with the given information and strings, prepended with `ALKiln`.
-  *    `type` is often something like 'setup', 'takedown', etc. */
-  let start = create_msg_start([ type, `ERROR` ], pre );
+// Where is this used?
+log.error = function ({ type='', pre='', data='', post='', code=`ALK0000` }) {
+  /** Log error msg with the given information and strings, prepended with `ALKiln`.
+   *  `type` is often something like 'setup', 'takedown', etc. */
+  // X - error (fallback)
+  let start = create_msg_start([ type, `ERROR` ], pre, `🤕 ${code}` );
   // Log them each on a separate line with extra new lines around the whole thing
   console.error( `\n${ start }` );
   if ( data ) { console.error( data ); }
   if ( post ) { console.error( post, `\n` ); }
 };
 
-log.debug = function ({ type='', pre='', data='', post='', verbose=false }) {
-  /* If debugging is turned on, log a message that includes `ALKiln` and `debug` */
-  if ( session_vars.get_debug() || verbose ) {
-    let start = create_msg_start([ type, 'debug' ], pre );
-    let full = `\n${ start }`;
+log.debug = function ({ type='', pre='', data='', post='', verbose=false, code=`ALK0000` }) {
+  /** If debugging is turned on, log a message that includes `ALKiln` and `debug` */
+  // @ - debug (fallback)
+  let start = create_msg_start([ type, `DEBUG` ], pre, `🐞 ${ code }` );
+  let full = `\n${ start }`;
+  if ( data ) { full += `\n${ data }`; }
+  if ( post ) { full += `\n${ post }`; }
+
+  // TODO: Make a verbose log instead of adding to the debug one and always add to it
+  if ( verbose ) {
+    log.add_to_debug_log( full );
+  }
+
+  if ( session_vars.get_debug() ) {
     // Log them each on a separate line
     console.log( `\n${ start }` );
-    if ( data ) {
-      full += `\n${ data }`;
-      console.log( data );
-    }
-    if ( post ) {
-      full += `\n${ post }`;
-      console.log( post );
-    }
-    // TODO: Make a verbose log instead of adding to the debug one and always add to it
-    if ( verbose ) {
-      log.add_to_debug_log( full );
-    }
+    console.log( data );
+    console.log( post );
   }
 };