@suffolklitlab/alkiln 5.10.4 → 5.11.0

package/lib/utils/reports.js

@@ -11,7 +11,7 @@ reports.addReportHeading = function (scope, { scenario }) {
   /** Return printable heading based on Scenario name and tags.
   *    Allow characters from other languages.
   */
-  if ( session_vars.get_debug() ) { console.log(`reports.addReportHeading(): ${scenario.pickle.name} \n`); }
+  if ( session_vars.get_debug() ) { console.log(`🔎 ALK0175 INFO: reports.addReportHeading(): ${scenario.pickle.name} \n`); }
 
   // Collect all tag names
   let tag_names = [];
@@ -29,36 +29,48 @@ reports.addReportHeading = function (scope, { scenario }) {
   heading += `\n---------------`;
 
   reports.addToReport( scope, {
-    type: `heading`,
+    code: `ALK0176`,
+    type: `heading info`,
     value: heading,
   });
 };  // Ends reports.addReportHeading()
 
-reports.addToReport = function( scope, { type, value }) {
+// TODO: Maybe return line so it can be used in error messages, etc.
+reports.addToReport = function( scope, { type, code, value }) {
   /** Add an item to a specific list in a scenario's report.
   * Create report if necessary.
   * 
   * The report has a key for each scenario and each of those
-  * keys should correspond to a list containing the relevant data. */
-  if ( session_vars.get_debug() ) { console.log(`reports.addToReport():\ntype: ${ type }, value: ${ value }\n`) }
-  let scenario = makeSureReportPartsExist( scope );
-  scenario.lines.push({ type, value });
+  * keys should correspond to a list containing the relevant data.
+  *
+  * @params code {string} (Optional) Error or warning code. Default
+  *    is unspecified error or warning.
+  * */
+  // Debugging logs
+  let debug_line = getDebugLine({ type, code, value });
+  if ( session_vars.get_debug() ) {
+    console.log( `Report: ${ debug_line }` );
+  }
 
+  // Ensure default file path for saving internal unit test logs
   const MISC_ARTIFACTS_DIR = `_alkiln-misc_artifacts`;
-  // Ensure filepath for saving local unit test logs
   if ( !scope.paths ) {
-    // TODO: would it be useful to put in existing artifacts folder if possible.
     // Can this be usefully abstracted?
     scope.paths = { debug_log: `${ MISC_ARTIFACTS_DIR }/unit_tests_logs-${ files.readable_date() }.txt` };
   }
 
   try {
-    fs.appendFileSync(scope.paths.debug_log, `\nReport:\ntype: ${ type }, value: ${ value }`);
-  } catch (err) {
+    fs.appendFileSync( scope.paths.debug_log, `\nReport:\n${debug_line}` );
+  } catch ( err ) {
     fs.mkdirSync( MISC_ARTIFACTS_DIR );
-    fs.appendFileSync(scope.paths.debug_log, `\nReport:\ntype: ${ type }, value: ${ value }`);
+    fs.appendFileSync( scope.paths.debug_log, `\nReport:\n${debug_line}` );
+    // An error in here should throw (for now)
   }
 
+  // Report stuff
+  let scenario = makeSureReportPartsExist( scope );
+  scenario.lines.push({ type, code, value });
+
   return scenario;
 };  // Ends reports.addToReport()
 
@@ -125,9 +137,9 @@ reports.getPrintableReport = function( scope ) {
     else { other_reports += report; }
   };  // ends for every scenario
 
-  if ( failed_reports !== `` ) { report += `\n\n===============================\n===============================\nFailed scenarios:\n${ failed_reports }`; }
-  if ( other_reports !== `` ) { report += `\n\n===============================\n===============================\nScenarios that did not pass:\n${ other_reports }`; }
-  if ( passed_reports !== `` ) { report += `\n\n===============================\n===============================\nPassed scenarios:\n${ passed_reports }`; }
+  if ( failed_reports !== `` ) { report += `\n\n===============================\n===============================\n🤕 Failed scenarios:\n${ failed_reports }`; }
+  if ( other_reports !== `` ) { report += `\n\n===============================\n===============================\n🔎 Scenarios that did not pass:\n${ other_reports }`; }
+  if ( passed_reports !== `` ) { report += `\n\n===============================\n===============================\n🌈 Passed scenarios:\n${ passed_reports }`; }
 
   return report;
 };  // Ends reports.getPrintableReport()
@@ -137,11 +149,56 @@ reports.getPrintableScenario = function( scenario ) {
   let [ scenario_id, data ] = scenario;
   let report = ``;
   for ( let line of data.lines ) {
-    if ( line.type === `page_id` ) { report += `screen id: `; }
-    else if ( line.type === `outcome` ) { report += `\n`; }
-    else if ( line.type === `warning` ) { report += `WARNING: `; }
-    else if ( line.type === `error` ) { report += `\nERROR: ` }
-    report += `${ line.value }\n`;
+    let { type, code, value } = line;
+    report += `${ getLineText({ type, code, value }) }\n`;
   }
   return report;
 };  // Ends reports.getPrintableScenario()
+
+let getLineText = function ({ type=`no type`, code=`ALK0000`, value=`` }) {
+  let start = ``;
+  if ( type.includes(`page_id`) ) { start += `screen id: `; }
+  else if ( type.includes(`outcome`) ) { start += `\n`; }  // extra new line
+  else if ( type.includes(`warning`) ) { start += `🔎 ${ code } WARNING: `; }
+  else if ( type.includes(`error`) ) { start += `\n🤕 ${ code } ERROR: `; }  // extra new line
+  return `${ start }${ value }`;
+};  // Ends getLine()
+
+let getDebugLine = function ({ type=``, code=`ALK0000`, value=`` }) {
+  /** In debug log lines, include all the information possible. */
+
+  // `plain` is usually used for visual clarity and shouldn't have
+  // codes and such associated with it. Return right away.
+  if ( type.includes(`plain`) ) { return value; }
+
+  let start = ``;
+
+  // Get all the relevant emoji
+  if ( type.includes(`debug`) ) { start += `🐞`; }
+  if ( type.includes(`info`) ) { start += `💡`; }
+  if ( type.includes(`success`) ) { start += `🌈`; }
+  if ( type.includes(`warning`) ) { start += `🔎`; }
+  if ( type.includes(`error`) ) { start += `🤕`; }
+  // Default
+  if ( start === `` ) { start += `?`; }
+
+  start += ` ${ code }`;
+
+  // TODO: This doesn't take care
+  let extra_types = type.replace(/debug|info|success|warning|error/i, ``).replace(/  +/g, ' ').trim();
+  if ( extra_types.length > 0 ) { start += ` ${ extra_types } `; }
+
+  // Get all the relevant descriptive text
+  let description_parts = [];
+  if ( type.includes(`debug`) ) { description_parts.push( `DEBUG` ); }
+  if ( type.includes(`info`) ) { description_parts.push( `INFO` ); }
+  if ( type.includes(`success`) ) { description_parts.push( `SUCCESS` ); }
+  if ( type.includes(`warning`) ) { description_parts.push( `WARNING` ); }
+  if ( type.includes(`error`) ) { description_parts.push( `ERROR` ); }
+  // Default
+  if ( description_parts.length <= 0 ) { description_parts.push( `UNKNOWN` ); }
+
+  start = [ start, ...description_parts ].join(` `);
+
+  return `${ start }: ${ value }`;
+};  // Ends getLine()

package/lib/utils/session_vars.js

@@ -120,7 +120,7 @@ session_vars.save_project_name = function ( project_name ) {
   // Warn local developers if file already exists
   if ( fs.existsSync( runtime_config_path ) ) {
     let old_project_name = session_vars.get_project_name();
-    let session_project_already_exists_msg = `ALKiln WARNING: `
+    let session_project_already_exists_msg = `🔎 ALK0035 WARNING: `
       + `This session had a project name already: ${ old_project_name }. `
       + `A new project has now been created called ${ project_name }. `
       + `Remember to delete ${ old_project_name }`;
@@ -136,7 +136,7 @@ session_vars.save_project_name = function ( project_name ) {
   let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
 
   if ( session_vars.get_debug() ) {
-    console.log( `ALKiln debug: Stored name of Project "${ project_name }" locally.` );
+    console.log( `🐞 ALK0036 DEBUG: Stored name of Project "${ project_name }" locally.` );
   }
   return file;
 };  // Ends save_project_name()
@@ -148,7 +148,7 @@ session_vars.get_project_name = function () {
   }
   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
   let project_name = json[ project_name_key ] || null;
-  if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Project name from file is "${ project_name }".` ); }
+  if ( session_vars.get_debug() ) { console.log( `🐞 ALK0037 DEBUG: Project name from file is "${ project_name }".` ); }
   return project_name;
 };  // Ends get_project_name()
 
@@ -158,11 +158,11 @@ session_vars.delete_project_name = function () {
     // Get the json, changing it, and re-write the file from scratch
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     json[ project_name_key ] = ``;
-    console.log( `ALKiln: Deleted the data that stored the name of the Project.` );
+    console.log( `💡 ALK0038 INFO: Deleted the data that stored the name of the Project.` );
     fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
     return true;
   } catch ( error ) {
-    console.warn( `ALKiln WARNING: Could not delete the Project name data. Error: ${ error }.` );
+    console.warn( `🔎 ALK0039 WARNING: Could not delete the Project name data. Error: ${ error }.` );
     return false;
   }
 };
@@ -226,7 +226,7 @@ session_vars.save_runtime_config_var = function ({ key, value }) {
   let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
 
   if ( session_vars.get_debug() ) {
-    console.log( `ALKiln debug runtime config var: Stored "${key}" locally as "${value}".` );
+    console.log( `🐞 ALK0040 DEBUG: Stored runtime config var "${key}" locally as "${value}".` );
   }
   return file;
 };  // Ends session_vars.save_runtime_config_var()
@@ -242,7 +242,7 @@ session_vars.get_runtime_config_var = function ( key ) {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     let value = json[ key ];
     if ( session_vars.get_debug() ) {
-      console.log( `ALKiln debug runtime config var: "${key}"" is "${value}".` );
+      console.log( `🐞 ALK0041 DEBUG: Runtime config var "${key}"" is "${value}".` );
     }
 
     return value;
@@ -280,13 +280,6 @@ session_vars.set_sources_paths = function ( paths ) {
     }
   }
 
-  // Warn about missing paths
-  if ( missing_paths.length > 0 ) {
-    console.warn(
-      `ALKiln WARNING: ALKiln can't find folders at "${ paths.join('", "') }".`
-    );
-  }
-
   // If no paths were valid
   if ( existing_paths.length <= 0 ) {
     session_vars._sources_paths = null;
@@ -294,7 +287,7 @@ session_vars.set_sources_paths = function ( paths ) {
   }
 
   console.info(
-    `ALKiln SUCCESS: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
+    `🌈 ALK0042 SUCCESS: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
   )
 
   // Otherwise, store valid paths
@@ -334,7 +327,7 @@ session_vars.validateEnvironment = function() {
 
   let origin = session_vars.get_origin();
   if ( origin !== 'github' && origin !== 'local' && origin !== 'playground' ) {
-    errorMessage += `\nThe _ORIGIN environment variable should be set to a valid value automatically. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It must be defined as either 'playground', 'github', or 'local', but its value was ${origin}`;
+    errorMessage += `\nThe _ORIGIN environment variable should be set to a valid value automatically. If you see this error, file an issue at https://github.com/SuffolkLITLab/docassemble-ALKilnInThePlayground. It must be defined as either 'playground', 'github', or 'local', but its value was ${origin}`;
 
   // If origin has one of the allowed values, we can do the rest of the validations
   } else {
@@ -358,10 +351,10 @@ session_vars.validateEnvironment = function() {
     // We're the ones ensuring these exist for Playground runs
     if ( origin === 'playground' ) {
       if ( !session_vars.get_user_project_name() ) {
-        errorMessage += `\nThe _PROJECT_NAME environment variable should automatically exist. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It is the name of the Project the developer chose to test.`
+        errorMessage += `\nThe _PROJECT_NAME environment variable should automatically exist. If you see this error, file an issue at https://github.com/SuffolkLITLab/docassemble-ALKilnInThePlayground. It is the name of the Project the developer chose to test.`
       }
       if ( !session_vars.get_user_id() ) {
-        errorMessage += `\nThe _USER_ID environment variable should automatically exist. If you see this error, file an issue at https://github.com/suffolkLITLab/docassemble-ALKilnInThePlayground. It is the user ID of the developer on the server.`
+        errorMessage += `\nThe _USER_ID environment variable should automatically exist. If you see this error, file an issue at https://github.com/SuffolkLITLab/docassemble-ALKilnInThePlayground. It is the user ID of the developer on the server.`
       }
       // Tags are optional
     }  // ends Playground env vars
@@ -371,6 +364,6 @@ session_vars.validateEnvironment = function() {
   errorMessage = errorMessage.trim();
 
   if (errorMessage !== '') {
-    throw new ReferenceError(`ALKiln error:\n${errorMessage}`);
+    throw new ReferenceError(`🤕 ALK0043 ERROR:\n${errorMessage}`);
   }
 };

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.10.4",
+  "version": "5.11.0",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
-    "test": "npm run unit && npm run cucumber",
+    "test": "npm run unit && npm run codes && npm run cucumber",
     "cucumber": "./lib/run_cucumber.js",
     "local": "npm run setup && npm run cucumber; npm run takedown",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
     "server_install": "./lib/docassemble/server_install.js",
-    "unit": "mocha tests/unit_tests/*.test.*"
+    "unit": "mocha tests/unit_tests/*.test.*",
+    "codes": "tests/log_codes/check_codes.sh ."
   },
   "repository": {
     "type": "git",

package/tests/log_codes/check_codes.sh

@@ -0,0 +1,138 @@
+#!/bin/bash
+
+# Identify missing and duplicate message code issues
+
+exit_code=0
+
+# Check if the caller sent an argument to the script
+if [ $# -eq 0 ]; then
+    # If there was no argument, set a default value
+    directory="../.."
+else
+    # If there was an argument, use it
+    directory="$1"
+fi
+
+# The grepped files will include the list of all the codes that have been
+# removed and are no longer used. Syntax used works with GitHub cli ([[:digit:]])
+# https://stackoverflow.com/a/6901221
+lines=$(grep -roh --exclude="tests/log_codes/check_codes.sh" --exclude="debug_log.txt" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
+sorted=$(echo "$lines" | sort -n)
+
+
+echo "=== Missing codes ==="
+
+# # -- Version 1 --
+# # More understandable version that doesn't yet come out with a final variable
+# # Keeping it here for discussion
+# nums=$(echo "$sorted" | sed 's/^ALK0*//')
+
+# missing_numbers=()
+# prev_number=0
+# echo "$nums" | while read -r current_number; do
+
+#   diff=$((current_number - prev_number))
+#   # If the difference is more than 1, print the missing
+#   # numbers until we catch up with the current number
+#   if [ $diff -gt 1 ]; then
+#     for ((i=prev_number+1; i<current_number; i++)); do
+#       printf -v missing_number "ALK%04d" $i
+#       missing_numbers+=("$missing_number")
+#       echo $missing_number
+#       # missing_numbers+=$(echo "%04d\n" $missing_number)
+#     done
+#     echo "---"
+#   fi
+
+#   prev_number=$current_number
+
+# done
+
+# missing_numbers_str=$(printf '%s' "${missing_numbers[@]}")
+# echo "missing: $missing_numbers_str"
+
+
+# -- Version 2 --
+# Version that is opaque, but generates a variable to check at the end
+
+# 0's in front of numbers confuses bash about the number format. Remove them.
+just_numbers=$(echo "$sorted" | sed 's/^ALK0*//')
+
+# Convert the list into an array
+IFS=$'\n' read -rd '' -a num_array <<<"$just_numbers"
+# Find the minimum and maximum numbers in the array
+min_num=$(printf "%s\n" "${num_array[@]}" | sort -n | head -n 1)
+max_num=$(printf "%s\n" "${num_array[@]}" | sort -n | tail -n 1)
+
+# Generate a sequence of numbers from min to max with leading zeros
+expected_sequence=""
+for ((i=min_num; i<=max_num; i++)); do
+    # Make sure these won't look like numbers to avoid confusing bash
+    expected_sequence+=$(printf "ALK%04d" $i)$'\n'
+done
+# # Alternative code for above. seq doesn't exist everywhere. Keep this
+# till we look up installing seq to avoid loop)
+# expected_sequence=$(printf "ALK%04d\n" $(seq $min_num $max_num))
+
+# Compare the expected sequence with the actual numbers
+missing_numbers=$(comm -23 <(printf "%s\n" "$expected_sequence" | sort -n) <(printf "%s\n" "$sorted"))
+if [ -z "$missing_numbers" ]; then
+  echo "None"
+else
+  echo "$missing_numbers"
+  ((exit_code+=2))
+fi
+
+
+echo "
+=== Duplicate codes ==="
+
+# We know these duplicates are ok
+accepted_duplicates="ALK0000
+ALK0002
+ALK0003
+ALK0006
+ALK0007
+ALK0008
+ALK0009
+ALK0010
+ALK0011
+ALK0012
+ALK0018
+ALK0019
+ALK0023
+ALK0024
+ALK0026
+ALK0027
+ALK0028
+ALK0030
+ALK0049"
+
+# Use a sorted list. `uniq` only detects consecutive duplicates
+duplicates=$(echo "$sorted" | uniq -d)
+unaccepted_duplicates=$(echo "$duplicates" | grep -v -f <(echo "$accepted_duplicates"))
+
+if [ -z "$unaccepted_duplicates" ]; then
+  echo "None"
+else
+  echo "$unaccepted_duplicates"
+  ((exit_code+=20))
+fi
+
+# === Final messages ===
+echo "
+Exit code meanings:
+- code 2: missing codes
+- code 20: duplicate codes
+- code 22: both
+"
+
+if test $exit_code -eq 0; then
+  echo "🌈 Passed! The codes for logs are as they should be."
+  highest=$(echo "$sorted" | tail -n 1)
+  echo "The highest log code is $highest"
+else
+  echo "🤕 ERROR: Log codes are messed up. Exited with exit code $exit_code. See above for more details."
+fi
+
+exit $exit_code

package/tests/log_codes/deleted_codes.json

@@ -0,0 +1,8 @@
+[
+  "== Actual deleted codes ==",
+  "None",
+  "== Tests ==",
+  "ALK test 0059",
+  "ALK test 0092",
+  "ALK test 0225"
+]