@suffolklitlab/alkiln 5.10.3 → 5.11.0

package/lib/scope.js

@@ -228,7 +228,7 @@ module.exports = {
         let error_text_prop = await error_elem.getProperty( 'textContent' );
         let system_error_text = await error_text_prop.jsonValue();
 
-        reports.addToReport(scope, { type: `error`, value: system_error_text });
+        reports.addToReport(scope, { type: `error`, code: `ALK0101`, value: system_error_text });
         throw system_error_text;
       };
 
@@ -289,7 +289,7 @@ module.exports = {
     *  `click_promise can be any kind of Promise, including a Promise.all()
     */
     let msg = `Cannot find the element to tap.`;
-    if ( !elem ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+    if ( !elem ) { reports.addToReport(scope, { type: `error`, code: `ALK0102`, value: msg }); }
     expect( elem, msg ).to.exist;
 
     // Get the text on the button or link for a potential error message later
@@ -312,11 +312,14 @@ module.exports = {
 
       if ( error.name === `TimeoutError` ) {
         let non_reload_report_msg = `After ALKiln tapped "${ tapperText }" it took too long to load the next page.`;
-        await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
+          code: `ALK0103`,
+          message: non_reload_report_msg,
+        }, error });
       } else {
         // Throw any non-timeout error
         let err_msg = `An error occurred when ALKiln tried to tap "${ tapperText }".`
-        reports.addToReport( scope, { type: `error`, value: err_msg });
+        reports.addToReport( scope, { type: `error`, code: `ALK0104`, value: err_msg });
         throw error;
       }  // ends if error is timeout error
 
@@ -367,10 +370,10 @@ module.exports = {
   //   actual_error: ,
   // }) {},  // Ends scope.handle_possible_timeout()
 
-  handle_page_timeout_error: async function( scope, { non_reload_report_msg, error } ) {
+  handle_page_timeout_error: async function( scope, { non_reload_report_data, error } ) {
     /* For a page timeout error, handles server reload vs. other timeout errors
     
-    @param options.non_reload_report_msg { str } Non-reload message to add to
+    @param options.non_reload_report_data { str } Non-reload message to add to
         the report as an error.
     @param options.error { object | str } Error to throw. It can be the actual
         error object or a string that will show up as a message in the error.
@@ -387,7 +390,8 @@ module.exports = {
       // Otherwise just throw the error
       reports.addToReport( scope, {
         type: `error`,
-        value: non_reload_report_msg });
+        code: non_reload_report_data.code,
+        value: non_reload_report_data.message });
       throw error;
     }
   },  // Ends scope.handle_page_timeout_error()
@@ -447,7 +451,7 @@ module.exports = {
           + `${ Math.round( ms_till_server_timeout/1000 ) } seconds to respond. `
           + `If the server was just reloading and needed more time, try setting the `
           + `"SERVER_RELOAD_TIMEOUT_SECONDS" GitHub secret to a longer amount of time.`
-        reports.addToReport( scope, { type: `error`, value: timeout_message });
+        reports.addToReport( scope, { type: `error`, code: `ALK0105`, value: timeout_message });
       }
 
       // Once server has responded, throw an error to end the test. After the first
@@ -467,8 +471,7 @@ module.exports = {
     let reload_failure_msg = `The test was unable to continue because it `
       + `took too long to reach the server. ALKiln will try this Scenario a total of `
       + `2 times. A full error will be printed for the second attempt.`;
-    reports.addToReport( scope, { type: `error`, value: reload_failure_msg });
-    // reports.addToReport( scope, { type: `error`, value: timeout_message });
+    reports.addToReport( scope, { type: `error`, code: `ALK0106`, value: reload_failure_msg });
     // clearTimeout( server_timeout_id );
     throw( reload_failure_msg );
   },  // Ends scope.throw_server_was_reloading_error()
@@ -541,7 +544,7 @@ module.exports = {
     let elem = await scope.page.$(`#${tab_id}`); 
     let error_msg = `Couldn't find the tab with id "#${tab_id}" on the page, is there a typo?`;
     if ( !elem ) {
-      reports.addToReport(scope, { type: `error`, value: error_msg }); 
+      reports.addToReport(scope, { type: `error`, code: `ALK0107`, value: error_msg });
     }
     expect( elem, error_msg ).to.exist;
     await scope.tapElementAndStayOnPage(scope, { elem });
@@ -552,7 +555,7 @@ module.exports = {
     /** Return if there were any violations and the file containing aXe output with more details of the checks */
     let { id } = await scope.examinePageID( scope, 'none to match' );
     if ( scope.page_id !== id ) {
-      reports.addToReport(scope, { type: `page_id`, value: `${ id }`, });
+      reports.addToReport(scope, { type: `page_id info`, code: `ALK0108`, value: `${ id }`, });
       scope.page_id = id;
     }
     const axe = new AxePuppeteer(scope.page);
@@ -573,9 +576,9 @@ module.exports = {
       axe_path = await scope.getA11yPath( scope );
       fs.writeFileSync( axe_path, JSON.stringify( axe_result, null, 2 ));
       let msg = `Found potential accessibility issues on the ${ scope.page_id } screen. Details in ${ axe_path }.`;
-      reports.addToReport( scope, { type: `error`, value: msg });
+      reports.addToReport( scope, { type: `error`, code: `ALK0109`, value: msg });
     } else {
-      reports.addToReport(scope, { type: `info`, value: `Accessibility on ${ scope.page_id } passed!`})
+      reports.addToReport(scope, { type: `row info`, code: `ALK0110`, value: `Accessibility on ${ scope.page_id } passed!`})
     }
     return {
       passed: axe_result.violations.length == 0,
@@ -587,7 +590,7 @@ module.exports = {
     let elem = await scope.page.$(`${ selector }`);
     let error_msg = `Couldn't find "${ selector }" on the page, is there a typo?`;
     if ( !elem ) {
-      reports.addToReport(scope, { type: `error`, value: error_msg });
+      reports.addToReport(scope, { type: `error`, code: `ALK0111`, value: error_msg });
     }
     expect( elem, error_msg ).to.exist;
     await scope.tapElementAndNavigate( scope, { elem, waitForTimeout });
@@ -597,7 +600,7 @@ module.exports = {
     let elem = await scope.page.$(`${ selector }`);
     let error_msg = `Couldn't find "${ selector }" on the page, is there a typo?`;
     if ( !elem ) {
-      reports.addToReport(scope, { type: `error`, value: error_msg });
+      reports.addToReport(scope, { type: `error`, code: `ALK0112`, value: error_msg });
     }
     expect( elem, error_msg ).to.exist;
     await scope.tapElementAndStayOnPage(scope, { elem });
@@ -625,7 +628,8 @@ module.exports = {
     }
 
     reports.addToReport(scope,{
-      type: `row`,
+      code: `ALK0113`,
+      type: `row info`,
       value: `Trying to load the interview at "${ interview_url }"`
     });
 
@@ -642,7 +646,10 @@ module.exports = {
       if ( error.name === `TimeoutError` ) {
 
         let non_reload_report_msg = `Timeout error occurred when ALKiln tried to go to the interview at ${ interview_url }`;
-        await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
+          code: `ALK0114`,
+          message: non_reload_report_msg,
+        }, error });
         // TODO: Should this throw to avoid multiple error messages?
 
       // If the page didn't load because of any other reason
@@ -651,6 +658,7 @@ module.exports = {
         // Throw any non-timeout error
         reports.addToReport( scope, {
           type: `error`,
+          code: `ALK0115`,
           value: `Error occurred when ALKiln tried to go to the interview at ${ interview_url }`
         });
         throw( error );
@@ -661,10 +669,14 @@ module.exports = {
     let load_result = await scope.getLoadData( scope );
     // da page invalidation errors or timeout will show an error to the developer at the end
     if ( load_result.error ) {
-      reports.addToReport(scope, { type: `error`, value: `On final attempt to load interview at "${ interview_url }", got "${ load_result.error }"` });
+      reports.addToReport(scope, {
+        type: `error`,
+        code: `ALK0116`,
+        value: `On final attempt to load interview at "${ interview_url }", got "${ load_result.error }"`
+      });
       expect( load_result.error ).to.equal( '' );
     } else {
-      reports.addToReport(scope, { type: `info`, value: `Successfully found the interview at "${ interview_url }"` });
+      reports.addToReport(scope, { type: `row info`, code: `ALK0117`, value: `Successfully found the interview at "${ interview_url }"` });
     }
 
     return scope.page;
@@ -698,7 +710,8 @@ module.exports = {
       } else {
         reports.addToReport(scope, {
           type: `error`,
-          value: `ALKiln got an error when it tried to load the interview page`,
+          code: `ALK0118`,
+          value: `ALKiln got an error when it tried to load the interview page.`,
           data: error
         });
         throw error;
@@ -738,7 +751,7 @@ module.exports = {
     if (!var_data && !raw_var_data) {
       let no_data_msg = `ALKiln Internal error: normalizeTable called w/o var_data or raw_var_data:` +
           ` open an issue at https://github.com/SuffolkLITLab/ALKiln/issues/new if you see this!`;
-      reports.addToReport( scope, { type: `error`, value: no_data_msg });
+      reports.addToReport( scope, { type: `error`, code: `ALK0119`, value: no_data_msg });
       throw Error(no_data_msg);
     }
 
@@ -759,7 +772,7 @@ module.exports = {
             let bad_table_msg = `Your Story Table should have ${ more_or_less } than`
               + ` ${ row_raw.length } columns. Take another look at Story Table documentation at`
               + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables.`
-            reports.addToReport( scope, { type: `error`, value: bad_table_msg})
+            reports.addToReport( scope, { type: `error`, code: `ALK0120`, value: bad_table_msg})
             throw Error(bad_table_msg);
           }
 
@@ -786,7 +799,7 @@ module.exports = {
             + ` Check for a typo and check your workflow file.`
             + ` Read more about using GitHub secrets in your workflow file at`
             + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#github-secrets.`
-          reports.addToReport( scope, { type: `error`, value: not_in_env_msg });
+          reports.addToReport( scope, { type: `error`, code: `ALK0121`, value: not_in_env_msg });
           throw ReferenceError(not_in_env_msg);
         }
       }  // ends if is secret var
@@ -812,9 +825,10 @@ module.exports = {
     }  // ends for every row
 
     log.debug({
+      code: `ALK0122`,
       type: `info`,
       pre: `scope.normalizedTable():\n ${JSON.stringify( supported_table )}`
-    })
+    });
 
     return supported_table;
   },  // Ends scope.normalizeTable()
@@ -894,6 +908,7 @@ module.exports = {
         } else {
           reports.addToReport(scope, {
             type: `error`,
+            code: `ALK0123`,
             value: `You cannot sign a signature page this way because the `
               + `interview's HTML is missing data. Use the "I sign" Step `
               + `instead. You can also read documentation about `
@@ -963,7 +978,11 @@ module.exports = {
       fields.push( field_data );
     }  // ends for every node
 
-    if ( session_vars.get_debug() ) { console.log( `page fields:\n${ JSON.stringify( fields )}`); }
+    log.debug({
+      code: `ALK0124`,
+      type: `info`,
+      pre: `page fields:\n${ JSON.stringify( fields )}`
+    });
     return fields;
   },  // Ends scope.getAllFields()
 
@@ -1003,7 +1022,7 @@ module.exports = {
     // Exceptions: Some specific fields can be duplicates without being dangerous
     if ( matching_nodes.length > 1 && !selector.includes(`[class="file-caption-name"]`) ) {
       let msg = `${ matching_nodes.length } items on this page matched the base64 encoded name '${ selector }'. You may be setting the same variable in multiple places on this page.`;
-      reports.addToReport(scope, { type: `warning`, value: msg });
+      reports.addToReport(scope, { type: `warning`, code: `ALK0125`, value: msg });
     }
 
     return selector;
@@ -1013,7 +1032,11 @@ module.exports = {
     /* Return variable names and values combined in ways that can
     * try to match table rows. Tables can have two properties:
     * variable name and value. */
-    if ( session_vars.get_debug() ) { console.log(`scope.getPossibleTableRowMatchers() var_names:`, var_names, `values:`, values); }
+    log.debug({
+      code: `ALK0126`,
+      type: `info`,
+      pre: `scope.getPossibleTableRowMatchers() var_names: ${JSON.stringify(var_names)} values: ${JSON.stringify(values)}`
+    });
     let possible_table_rows = [];
     for ( let var_name of var_names ) {
       // Inputs like textareas don't have values
@@ -1392,7 +1415,7 @@ module.exports = {
           + `variable or a generic object, but the page is missing `
           + `the ALKiln "trigger" variable's name. See `
           + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#a-missing-trigger-variable.`;
-        reports.addToReport(scope, { type: `warning`, value: page_trigger_warning });
+        reports.addToReport(scope, { type: `warning`, code: `ALK0127`, value: page_trigger_warning });
       }
 
       for ( let row_that_matches_this_field of rows_that_match_field_names ) {
@@ -1411,7 +1434,7 @@ module.exports = {
             + `column, but it is empty. The test might get unexpected results. See `
             + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
             + `\nThe rows:\n${ row_as_story_table }`;
-          reports.addToReport(scope, { type: `warning`, value: row_trigger_warning });
+          reports.addToReport(scope, { type: `warning`, code: `ALK0128`, value: row_trigger_warning });
 
           rows_without_a_trigger_name.push( row_that_matches_this_field );
         } else {
@@ -1451,6 +1474,7 @@ module.exports = {
           + `\nThis field's data:\n${ JSON.stringify( field )}`;
         reports.addToReport(scope, {
           type: `warning`,
+          code: `ALK0129`,
           value: all_trigger_names_conflict_msg
         });
       }
@@ -1479,15 +1503,22 @@ module.exports = {
       }
       multiple_matches_msg += `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
         + `\nThis field's data:\n${ JSON.stringify( field )}`;
-      reports.addToReport(scope, { type: `warning`, value: multiple_matches_msg });
+      reports.addToReport(scope, { type: `warning`, code: `ALK0130`, value: multiple_matches_msg });
     }
 
-    if ( session_vars.get_debug() ) { 
-      console.log( `final_matching_rows:\n`, JSON.stringify( final_matching_rows )); 
-      if ( final_matching_rows.length == 0) {
-        console.log(` field:\n`, JSON.stringify( field ) );
-      }
+    log.debug({
+      code: `ALK0131`,
+      type: `info`,
+      pre: `final_matching_rows:\n${JSON.stringify( final_matching_rows )}`
+    });
+    if ( final_matching_rows.length == 0) {
+      log.debug({
+        code: `ALK0132`,
+        type: `info`,
+        pre: `field:\n${JSON.stringify( field )}`
+      });
     }
+
     return final_matching_rows;
   },  // Ends scope.getMatchingRows()
 
@@ -1571,9 +1602,11 @@ module.exports = {
 
   get_handle_from_field: async function ( scope, { field }) {
     /** Get the element's puppeteer handle using the field's selector. */
-    if ( session_vars.get_debug() ) {
-      console.log(`scope.get_handle_from_field() field.selector:`, field.selector );
-    }
+    log.debug({
+      code: `ALK0133`,
+      type: `info`,
+      pre: `scope.get_handle_from_field() field.selector: ${JSON.stringify(field.selector)}`
+    });
     let handle = await scope.page.evaluateHandle(( selector ) => {
       let elem = document.querySelector( selector );
       // If the element has a sibling that's a label, we need to
@@ -1664,6 +1697,7 @@ module.exports = {
         // Return field unused.
         reports.addToReport( scope, {
           type: `warning`,
+          code: `ALK0134`,
           value: `Invalid date. Value given: "${ answer }".`
         });
         return false;
@@ -1882,6 +1916,7 @@ module.exports = {
     if ( to_find_names.length === 0 ) {
       reports.addToReport( scope, {
         type: `warning`,
+        code: `ALK0135`,
         value: `Your Step is missing the names of which file(s) to use.`
       });
       return [];
@@ -1914,6 +1949,7 @@ module.exports = {
     if ( missing_files.length > 0 ) {
       reports.addToReport( scope, {
         type: `warning`,
+        code: `ALK0136`,
         value: `ALKiln could not find "${ missing_files.join('", "') }" in the folder(s) at "${ sources_dirs.join('", "') }".`
       });
     }
@@ -1979,6 +2015,9 @@ module.exports = {
     const typing_cutoff = 300;
     const slice_value = -3;
 
+    // Deleting preexisting text here is slower, but more clear and maintainable
+    await handle.evaluate(( elem ) => { elem.value = ``; });
+
     let is_ajax = await handle.evaluate(( elem, text, typing_cutoff, slice_value ) => {
       // For long strings or ajax comboboxes, set the value of the field to
       // most of the text. This will be faster in those cases.
@@ -2011,7 +2050,7 @@ module.exports = {
     * takes a while to load. */
     let canvas = await scope.page.waitForSelector( `#dasigcanvas` );
     let msg = `Could not find a signature field.`;
-    if ( !canvas ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+    if ( !canvas ) { reports.addToReport(scope, { type: `error`, code: `ALK0137`, value: msg }); }
     expect( canvas, msg ).to.exist;
 
     // Provides functionality to draw name arg on canvas
@@ -2079,12 +2118,12 @@ module.exports = {
     * @param ensure_all_vars_used {bool} [false] = Default false. If true, errors if any
     *     object in var_data is not used during running of this function.
     */
-    if ( session_vars.get_debug() ) { console.log( `~~~~~~~~~~~~~~ scope.setFields() ~~~~~~~~~~~~~~` ); }
+    log.debug({ type: `plain`, pre: `~~~~~~~~~~~~~~ scope.setFields() ~~~~~~~~~~~~~~` });
 
     // Only record the page id once for each page to which we navigate
     let { id } = await scope.examinePageID( scope, 'none to match' );
     if ( scope.page_id !== id ) {
-      reports.addToReport(scope, { type: `page_id`, value: `${ id }`, });
+      reports.addToReport(scope, { type: `page_id info`, code: `ALK0138`, value: `${ id }`, });
       scope.page_id = id;
     }
 
@@ -2115,7 +2154,8 @@ module.exports = {
           something_new_was_set = true;
           field.was_set = true;
           reports.addToReport(scope, {
-            type: `row`,
+            type: `row info`,
+            code: `ALK0139`,
             value: `${ reports.convertToOriginalStoryTableRow(scope, { row_data: row_used }) }`
           });
 
@@ -2142,7 +2182,8 @@ module.exports = {
         if ( row_used ) {
 
           reports.addToReport(scope, {
-            type: `row`,
+            type: `row info`,
+            code: `ALK0140`,
             value: `${ reports.convertToOriginalStoryTableRow(scope, { row_data: row_used }) }`
           });
 
@@ -2187,7 +2228,7 @@ module.exports = {
           let msg = `In a linear Step all the values you give MUST be filled in, but ALKiln was unable `
             + `to find a field on the page "${id}" for the variable "${ original_row.var }" that `
             + `could be set to "${ original_row.value }". See this Scenario's HTML file for details.`;
-          reports.addToReport(scope, { type: `error`, value: msg });
+          reports.addToReport(scope, { type: `error`, code: `ALK0141`, value: msg });
           expect( values_used_status, msg ).to.equal( '' );
         }
       }
@@ -2378,12 +2419,14 @@ module.exports = {
         // probably add a confusing message to the report, so mutating seems, sadly, more useful.
         var_datum.value = `False`;  // The original value is still preserved
         // Warn the developer not to use `.there_is_another`.
-        reports.addToReport( scope, { type: `warning`, 
-            value: 'The attribute `.there_is_another` is invalid in story table tests. Replace it with '
-              + '`.target_number` in your `var` and `trigger` columns. 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/alkiln#there_is_another. `
-              + `The row data is\n${ JSON.stringify( var_datum.original )}` });
+        reports.addToReport( scope, {
+          type: `warning`,
+          code: `ALK0142`,
+          value: 'The attribute `.there_is_another` is invalid in story table tests. Replace it with '
+            + '`.target_number` in your `var` and `trigger` columns. 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/alkiln/writing/#there_is_another. `
+            + `The row data is\n${ JSON.stringify( var_datum.original )}` });
       }  // ends if it's a `target_number` row
     }  // ends for each row
 
@@ -2412,10 +2455,10 @@ module.exports = {
     } else if ( value.match( /(true|yes|checked|check|selected|select)/i )) {
       if ( from_story_table && !row.artificial ) {
         if ( row.var.match( /\.there_is_another$/ ) ) {
-          reports.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/alkiln#there_is_another-loop. The row data is\n${ JSON.stringify( row.original )}` });
+          reports.addToReport( scope, { type: `warning`, code: `ALK0143`, 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/alkiln/writing/#there_is_another. The row data is\n${ JSON.stringify( row.original )}` });
         } else {
           // If `target_number` is set to True instead of a number
-          reports.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.` });
+          reports.addToReport( scope, { type: `warning`, code: `ALK0144`, 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`; }
@@ -2423,7 +2466,7 @@ module.exports = {
     } else if ( isNaN( desired_num )) {  // Story table loop will end
       // I can't figure out how to trigger this warning, so maybe we're
       // already handling everything we need to
-      reports.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.` });
+      reports.addToReport( scope, { type: `warning`, code: `ALK0145`, 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`;
 
 	    // Check that the number of elements in the list hits our desired number.
@@ -2479,7 +2522,7 @@ module.exports = {
     }
 
     let timeout_err_message = `The test tried to continue to the next page, but it took longer than ${ (scope.timeout/1000)/60 } min. Check the picture of this page. If a secret variable was used, there will be no picture.`
-    if ( timedOut ) { reports.addToReport(scope, { type: `error`, value: timeout_err_message }); }
+    if ( timedOut ) { reports.addToReport(scope, { type: `error`, code: `ALK0146`, value: timeout_err_message }); }
     expect( timedOut, timeout_err_message ).to.be.false;
 
     clearTimeout( cont_timeout );
@@ -2523,13 +2566,13 @@ module.exports = {
     /* 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 after ${ id }, but there was a system error. Check the picture of this page.`
-      reports.addToReport(scope, { type: `error`, value: sys_err_message });
+      reports.addToReport(scope, { type: `error`, code: `ALK0147`, 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 after ${ id }, but the user got an error. Check the picture of this page.`
-      reports.addToReport(scope, { type: `error`, value: user_err_message });
+      reports.addToReport(scope, { type: `error`, code: `ALK0148`, value: user_err_message });
       expect( true, user_err_message ).to.be.false;
     }
 
@@ -2607,7 +2650,8 @@ module.exports = {
 
       // In future, may be saved to artifact file
       reports.addToReport( scope, {
-        type: `json`,
+        type: `json info`,
+        code: `ALK0149`,
         value: JSON.stringify( data, null, 2 )
       });
     },  // Ends scope.steps.add_json_vars_to_report()
@@ -2622,7 +2666,7 @@ module.exports = {
       let response = await linkPage.goto( actual_url, { waitUntil: 'domcontentloaded' });
 
       let msg = `The "${ linkText }" link is broken.`;
-      if ( !response.ok() ) { reports.addToReport( scope, { type: `error`, value: msg }); }
+      if ( !response.ok() ) { reports.addToReport( scope, { type: `error`, code: `ALK0150`, value: msg }); }
       expect( response.ok(), msg ).to.be.true;
 
       // This may cause problems if the linked page is the interview page
@@ -2674,7 +2718,7 @@ module.exports = {
       const [link] = await scope.page.$x(`//a[contains(text(), "${phrase}")]`);
 
       let msg = `The term "${ phrase }" seems to be missing.`;
-      if ( !link ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+      if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0151`, value: msg }); }
       expect( link, msg ).to.exist;
       await scope.tapElementAndStayOnPage(scope, { elem: link });
       await scope.page.waitForTimeout(10000);
@@ -2699,7 +2743,7 @@ module.exports = {
       let [elem] = await scope.page.$x(`//a[contains(@href, "${ filename }")]`);
 
       let msg = `"${ filename }" seems to be missing. Cannot find a link to that document.`;
-      if ( !elem ) { reports.addToReport(scope, { type: `error`, value: msg }); }
+      if ( !elem ) { reports.addToReport(scope, { type: `error`, code: `ALK0152`, value: msg }); }
       expect( elem, msg ).to.exist;
 
       let failed_to_download = false;
@@ -2712,13 +2756,13 @@ module.exports = {
             const reader = new FileReader();
             reader.readAsBinaryString(await response.blob());
             reader.onload = () => resolve(reader.result);
-            reader.onerror = () => reject(`Error occurred on page when downloading ${ url }: ${ reader.error }`);
+            reader.onerror = () => reject(`🤕 ALK0153 ERROR: Error occurred on page when downloading ${ url }: ${ reader.error }`);
           });
         }, elem);
         if (binaryStr !== '') {
           const fileData = Buffer.from(binaryStr, 'binary');
           fs.writeFileSync(`${ scope.paths.scenario }/${ filename }`, fileData);
-          reports.addToReport(scope, { type: `info`, value: `Downloaded ${ filename } (${ fileData.length } bytes) to ${ scope.paths.scenario }`});
+          reports.addToReport(scope, { type: `row info`, code: `ALK0154`, value: `Downloaded ${ filename } (${ fileData.length } bytes) to ${ scope.paths.scenario }`});
         } else {
           failed_to_download = true;
           err_msg = `Couldn't download ${ filename }, binary data for download was empty`;
@@ -2729,7 +2773,7 @@ module.exports = {
       }
 
       if (failed_to_download) {
-        reports.addToReport(scope, { type: `warning`, value: `Could not download file using fetch (${ err_msg }). ALKiln will now fallback to the click download method` });
+        reports.addToReport(scope, { type: `warning`, code: `ALK0155`, value: `Could not download file using fetch (${ err_msg }). ALKiln will now fallback to the click download method.` });
         scope.toDownload = filename;
         // Should this be using `scope.tapElement`?
         await elem.evaluate( elem => { return elem.click(); });
@@ -2742,7 +2786,7 @@ module.exports = {
       if (existing_paths.length == 0) {
         // The row wasn't used
         let msg = `Could not find the existing PDF at ${ existing_pdf_path }`;
-        reports.addToReport(scope, { type: `error`, value: msg });
+        reports.addToReport(scope, { type: `error`, code: `ALK0156`, value: msg });
         scope.failed_pdf_compares.push(msg);
         // Return early since we couldn't find the PDF
         return;
@@ -2758,7 +2802,7 @@ module.exports = {
           return err_str + `- ${ part.value }\n`
         }, 'The new PDF removed: \n');
         let msg = `The PDFs were not the same.\n${ added_str }\n${removed_str}\n\n You can see the full PDFs at ${ full_existing_path } and ${ full_new_pdf_path}`;
-        reports.addToReport(scope, { type: `error`, value: msg });
+        reports.addToReport(scope, { type: `error`, code: `ALK0157`, value: msg });
         scope.failed_pdf_compares.push(msg);
       }
     },
@@ -2793,6 +2837,7 @@ module.exports = {
       
         reports.addToReport(scope, {
           type: `warning`,
+          code: `ALK0158`,
           value: `The name "${name_str}" has more than 4 parts, but 4 is the maximum allowed. The test will set the name to "${name_parts.join(" ")}".`
         });
       }
@@ -2875,10 +2920,13 @@ module.exports = {
         let err_msg = `Error occurred when ALKiln tried to go to "${ login_url }".`
         if ( error.name === `TimeoutError` ) {
           let non_reload_report_msg = `It took too long to load "${ login_url }"`;
-          await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+          await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
+            code: `ALK0159`,
+            message: non_reload_report_msg,
+          }, error });
         } else {
           // Throw any non-timeout error
-          reports.addToReport( scope, { type: `error`, value: err_msg });
+          reports.addToReport( scope, { type: `error`, code: `ALK0160`, value: err_msg });
           throw error;
         }  // ends if error is timeout error
 
@@ -2892,11 +2940,11 @@ module.exports = {
       // this is complex
       let email_msg = `The email address GitHub SECRET "${ email_secret_name }" doesn't exist. Check for a typo and check your workflow file.`
       if ( email === undefined ) {
-        reports.addToReport( scope, { type: `error`, value: email_msg })
+        reports.addToReport( scope, { type: `error`, code: `ALK0161`, value: email_msg })
       }
       let password_msg = `The password GitHub SECRET "${ password_secret_name }" doesn't exist. Check for a typo and check your workflow file.`
       if ( password === undefined ) {
-        reports.addToReport( scope, { type: `error`, value: password_msg })
+        reports.addToReport( scope, { type: `error`, code: `ALK0162`, value: password_msg })
       }
 
       expect( email, email_msg ).to.not.equal( undefined );
@@ -2909,7 +2957,8 @@ module.exports = {
       await scope.tapElementAndNavigate( scope, { elem });
 
       reports.addToReport( scope, {
-        type: `row`,
+        type: `row info`,
+        code: `ALK0163`,
         value: `Signed into ${ session_vars.get_da_server_url() }/user/sign-in successfully.`
       });
 
@@ -2970,9 +3019,11 @@ module.exports = {
       }
       if (field == null) {
         // Just skip it? Shouldn't happen but has before. Dig in more
-        if (session_vars.get_debug()) {
-          console.log(`A random button field choice was null. These were the fields to choose from:\n${ JSON.stringify(fields, null, 2) }`);
-        }
+        log.debug({
+          code: `ALK0164`,
+          type: `info`,
+          pre: `A random button field choice was null. These were the fields to choose from:\n${ JSON.stringify(fields, null, 2) }`,
+        });
         return;
       }
       let handle = await scope.get_handle_from_field( scope, { field: field });
@@ -3074,6 +3125,7 @@ module.exports = {
           if ( type === `file` ) {
             reports.addToReport( scope, {
               type: `warning`,
+              code: `ALK0165`,
               value: `Sorry, ALKiln's random input tests cannot yet handle "${ type }" fields.`
             });
           } else {