@suffolklitlab/alkiln 5.12.0 → 5.13.0-logs1

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 () {
@@ -226,7 +233,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 +249,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),
+  });
+}