@suffolklitlab/alkiln 5.13.2 → 5.13.4

package/lib/utils/session_vars.js

@@ -3,19 +3,22 @@ const fg = require('fast-glob');
 const path = require('path'); 
 require('dotenv').config();
 
-/**
- * This code assumes that this module is run as part of a GitHub Action.  If the
- * customer is running it as a CLI tool, then they won't get useful messages yet.
- */
-
-/* This file provides user info variables. E.g. server address. They're either
-*    `process.env` vars or vars that have been built from `process.env` vars.
-*    It is meant to avoid duplication, make testing easier, and leave room for
-*    future manipulation. No other file should need to use `process.env`.
-*
-* We have a bunch of `.get_foo()` functions partly because it makes the code
-*    much easier to test.
-*/
+/** WARNING: Avoid importing other project files into here. Every other
+ *  file should be able to reference this one without worrying
+ *  about circular references.
+ * */
+
+/** This file provides user info variable getters and setters.
+ *  E.g. server address. It often uses `process.env` vars or
+ *  vars that have been built from `process.env` vars. It is
+ *  meant to avoid duplication, make testing easier, and leave
+ *  room for future manipulation.
+ *
+ * No other file should need to use `process.env`.
+ *
+ * We use `.get_foo()` functions partly because it makes the code
+ * easier to test.
+ * */
 
 const session_vars = {};
 
@@ -136,7 +139,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( `🐞 ALK0036 DEBUG: Stored name of Project "${ project_name }" locally.` );
+    console.debug( `🐛 ALK0036 DEBUG: Stored name of Project "${ project_name }" locally.` );
   }
   return file;
 };  // Ends save_project_name()
@@ -148,7 +151,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( `🐞 ALK0037 DEBUG: Project name from file is "${ project_name }".` ); }
+  if ( session_vars.get_debug() ) { console.debug( `🐛 ALK0037 DEBUG: Project name from file is "${ project_name }".` ); }
   return project_name;
 };  // Ends get_project_name()
 
@@ -172,7 +175,11 @@ session_vars.delete_project_name = function () {
 // const file_storing_artifact_path = `_alkiln_test_artifacts_dir_name.json`;
 const artifacts_path_key = `artifacts_path`;
 session_vars.save_artifacts_path_name = function ( path_name ) {
-  /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
+  /** Save a key with the name of the current artifacts folder
+   *  in case it doesn't exist. Should we create the path in here
+   *  if it doesn't exist? Should we reserve this file for getting
+   *  and setting?
+   * */
   return session_vars.save_runtime_config_var({ key: artifacts_path_key, value: path_name });
 };  // Ends save_artifacts_path_name()
 session_vars.get_artifacts_path_name = function () {
@@ -181,20 +188,26 @@ session_vars.get_artifacts_path_name = function () {
 };  // Ends get_artifacts_path_name()
 
 
+/** We use `da_install_method` for temp server vs. author's account (Playground)
+ *  on author's server. For example, for deciding how to get the url of a
+ *  server. See docs on 4 environments. TODO: Change `_method` to `_location`?
+ * */
 const install_method_key = `da_install_method`;
 session_vars.save_install_method = function ( install_method ) {
-  /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
+  /** Save a key with the name of the current artifacts folder in case it
+   *  doesn't exist. */
   return session_vars.save_runtime_config_var({ key: install_method_key, value: install_method });
 };  // Ends save_install_method()
 session_vars.get_install_method = function () {
-  /* Get the name of the current install method. */
+  /** Get the name of the current install method. */
   return session_vars.get_runtime_config_var( install_method_key );
 };  // Ends get_install_method()
 
 
 const repo_folder_key = `da_repo_folder_name`;
 session_vars.save_repo_folder_name = function (repo_folder_name) {
-  /** Save a key with the name of the main package folder in the repository. */
+  /** Save a key with the name of the main package folder in the repository. For
+   *  example, EvictionDefense in the docassemble-EvictionDefense folder. */
   return session_vars.save_runtime_config_var({ key: repo_folder_key, value: repo_folder_name });
 };  // Ends session_vars.save_repo_folder_name()
 session_vars.get_repo_folder_name = function () {
@@ -226,7 +239,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( `🐞 ALK0040 DEBUG: Stored runtime config var "${key}" locally as "${value}".` );
+    console.debug( `🐛 ALK0040 DEBUG: Stored runtime config var "${key}" locally as "${value}".` );
   }
   return file;
 };  // Ends session_vars.save_runtime_config_var()
@@ -242,7 +255,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( `🐞 ALK0041 DEBUG: Runtime config var "${key}" is "${value}".` );
+      console.debug( `🐛 ALK0041 DEBUG: Runtime config var "${key}" is "${value}".` );
     }
 
     return value;

package/lib/utils/time.js

@@ -24,3 +24,47 @@ time.waitForTimeout = function( milliseconds ) {
     setTimeout(resolve, milliseconds);
   });
 };
+time.sleep = time.waitForTimeout;
+time.wait = time.waitForTimeout;
+
+time.filename_date = function() {
+  /** Return the current timestamp in a human-readable
+  *   filename-safe format to match the workflow artifact
+  *   date format.
+  *   See https://stackoverflow.com/a/48729396/14144258 and https://stackoverflow.com/a/6040556/14144258
+  */
+  // let date = new Date();  // now
+  // let day = ("0" + date.getUTCDate()).slice(-2);
+  // let month = ("0" + (date.getUTCMonth() + 1)).slice(-2);
+  // let year = date.getUTCFullYear();
+  // let hours = ("0" + date.getUTCHours()).slice(-2);
+  // let mins = ("0" + date.getUTCMinutes()).slice(-2);
+  // let secs = ("0" + date.getUTCSeconds()).slice(-2);
+
+  let dt = time.get_time_parts();
+  let safe_date = `${ dt.y }-${ dt.mon }-${ dt.d } at ${ dt.h }h${ dt.min }m${ dt.s }sUTC`;
+  return safe_date;
+};  // Ends time.filename_date()
+
+time.log_date = function () {
+  /** Return the current timestamp in a human-readable
+  *   more compact log format.
+  * See https://stackoverflow.com/a/48729396/14144258 and https://stackoverflow.com/a/6040556/14144258
+  */
+  let dt = time.get_time_parts();
+  let short_date = `${ dt.y }-${ dt.mon }-${ dt.d } ${ dt.h }:${ dt.min }:${ dt.s }UTC`;
+  return short_date;
+};  // Ends time.log_date()
+
+time.get_time_parts = function () {
+  /** Get all the parts of the date as numbers. */
+  let date = new Date();  // now
+  return ({
+    y: date.getUTCFullYear(),
+    mon: ("0" + (date.getUTCMonth() + 1)).slice(-2),
+    d: ("0" + date.getUTCDate()).slice(-2),
+    h: ("0" + date.getUTCHours()).slice(-2),
+    min: ("0" + date.getUTCMinutes()).slice(-2),
+    s: ("0" + date.getUTCSeconds()).slice(-2),
+  });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.13.2",
+  "version": "5.13.4",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/tests/log_codes/check_codes.sh

@@ -55,7 +55,8 @@ fi
 
 # removed and are no longer used. Syntax used works with GitHub cli - [[:digit:]]
 # https://stackoverflow.com/a/6901221
-instances=$(find "$where_to_look" -type f ! -name "check_codes.sh" ! -name "CONTRIBUTING.md" ! -name "$expected_instances_file" ! -name "debug_log.txt" ! -name "cucumber-report.txt" ! -path "*/node_modules/*" ! -path "*/ALKilnTests/*" ! -path "*/alkiln-*/*" ! -path "*/_alkiln*/*" -print0 | xargs -0 -P 4 grep -0 -ro 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' | grep -v -- '--' )
+# Exclude files and paths
+instances=$(find "$where_to_look" -type f ! -name "CONTRIBUTING.md" ! -name "$expected_instances_file" ! -name "debug_log.txt" ! -name "cucumber-report.txt" ! -path "*/tests/*" ! -path "*/node_modules/*" ! -path "*/ALKilnTests/*" ! -path "*/alkiln-*/*" ! -path "*/_alkiln*/*" ! -path "*/docs/decisions/*" ! -path "*/\.*" -print0 | xargs -0 -P 4 grep -0 -ro 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' | grep -v -- '--' )
 
 if [[ "$loudness" != "0" ]]; then
   total_instances=$(echo "$instances" | wc -l)

package/tests/log_codes/log_code_expected_instances.txt

@@ -4,7 +4,11 @@ Why we need duplicate codes sometimes: GitHub actions sometimes don't have ways
 
 The script that tests the log codes will ignore this file (or any file with this name), and any file with these names: check_codes.sh, debug_log.txt, cucumber-report.txt. It will also ignore files in folders with these names:, node_modules, ALKilnTests, alkiln-*, _alkiln*. That list might get updated, so for an up-to-date list, always check the file check_codes.sh where we use `--exclude=` and such.
 
-ALK0000:8
+Reasons for deletion:
+0053 - duplicate log
+0173 - redundant
+
+ALK0000:0
 ALK0001:1
 ALK0002:2
 ALK0003:2
@@ -22,7 +26,7 @@ ALK0014:1
 ALK0015:1
 ALK0016:1
 ALK0017:1
-ALK0018:2
+ALK0018:1
 ALK0019:2
 ALK0020:1
 ALK0021:1
@@ -33,10 +37,10 @@ ALK0025:1
 ALK0026:2
 ALK0027:2
 ALK0028:3
-ALK0029:1
+ALK0029:2
 ALK0030:2
-ALK0031:1
-ALK0032:1
+ALK0031:2
+ALK0032:2
 ALK0033:1
 ALK0034:1
 ALK0035:1
@@ -57,7 +61,7 @@ ALK0049:1
 ALK0050:1
 ALK0051:1
 ALK0052:1
-ALK0053:1
+ALK0053:0
 ALK0054:1
 ALK0055:1
 ALK0056:1
@@ -177,7 +181,7 @@ ALK0169:1
 ALK0170:1
 ALK0171:1
 ALK0172:1
-ALK0173:1
+ALK0173:0
 ALK0174:1
 ALK0175:1
 ALK0176:1
@@ -185,7 +189,7 @@ ALK0177:1
 ALK0178:1
 ALK0179:1
 ALK0180:1
-ALK0181:1
+ALK0181:0
 ALK0182:1
 ALK0183:1
 ALK0184:2
@@ -206,4 +210,24 @@ ALK0198:1
 ALK0199:1
 ALK0200:1
 ALK0201:1
-ALK0202:1
+ALK0202:1
+ALK0203:1
+ALK0204:1
+ALK0205:1
+ALK0206:1
+ALK0207:1
+ALK0208:1
+ALK0209:1
+ALK0210:1
+ALK0211:1
+ALK0212:1
+ALK0213:1
+ALK0214:1
+ALK0215:1
+ALK0216:1
+ALK0217:1
+ALK0218:1
+ALK0219:1
+ALK0220:1
+ALK0221:1
+ALK0222:1

package/tests/unit_tests/getAllFields.test.js

@@ -7,6 +7,11 @@ chai.use(deepEqualInAnyOrder);
 const html = require('./html.fixtures.js');
 const fields = require('./fields.fixtures.js');
 const scope = require('../../lib/scope.js');
+
+const Log = require(`../../lib/utils/Log.js`);
+const log = new Log({ path: `_alkiln-misc_artifacts/all_fields_${ Date.now() }`, context: `unit_tests getAllFields` });
+scope.set_log({ log_obj: log });
+
 const getAllFields = scope.getAllFields;
 
 chai.config.truncateThreshold = 0

package/tests/unit_tests/getMatchingRows.test.js

@@ -6,6 +6,11 @@ const tables = require('./tables.fixtures.js');
 const fields = require('./fields.fixtures.js');
 const matches = require('./matches.fixtures.js');
 const scope = require('../../lib/scope.js');
+
+const Log = require(`../../lib/utils/Log.js`);
+const log = new Log({ path: `_alkiln-misc_artifacts/matching_rows_${ Date.now() }`, context: `unit_tests getMatchingRows` });
+scope.set_log({ log_obj: log });
+
 const getMatchingRows = scope.getMatchingRows;
 // Match state var instantiated in steps.js. TODO: Add tests for such rows.
 scope.row_needs_trigger_flag = `ALKiln: no trigger variable needed`;