@suffolklitlab/alkiln 5.13.0-logs3 → 5.13.1

package/lib/docassemble/docassemble_api_interface.js

@@ -1,5 +1,5 @@
 const _da_REST = require('./docassemble_api_REST');
-const Log = require('../utils/log');
+const log = require('../utils/log');
 const session_vars = require('../utils/session_vars' );
 const time = require('../utils/time');
 
@@ -61,10 +61,6 @@ const time = require('../utils/time');
 let da_i = {};
 module.exports = da_i;
 
-const artifacts_path = session_vars.get_artifacts_path_name();
-const log = new Log({ path: artifacts_path, context: `api` });
-const context = `da api`;
-
 
 // Constants
 const DEFAULT_MAX_REQUEST_MS = session_vars.get_setup_timeout_ms();
@@ -96,9 +92,7 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
 
   // Defaults
   let { timeout } = options || { timeout: DEFAULT_MAX_REQUEST_MS };
-  log.info({ code: `ALK0166`, context: `da api`, },
-    `Waiting for the docassemble server to respond. Will wait for ${ timeout/1000 } seconds at most.`
-  );
+  log.info({ type: `da api`, code: `ALK0166`, pre: `Waiting for the docassemble server to respond. Will wait for ${ timeout/1000 } seconds at most.` });
   
   try {
     let start_time = Date.now()
@@ -106,9 +100,7 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
     let response = await _da_REST.get_dev_id( timeout );
     let end_time = Date.now()
     if ( response && response.data && response.data.id ) {
-      log.info({ code: `ALK0167`, context: `da api`, },
-        `The docassemble server responded after ${ (end_time - start_time)/1000 } seconds.`
-      );
+      log.info({ type: `da api`, code: `ALK0167`, pre: `The docassemble server responded after ${ (end_time - start_time)/1000 } seconds.` });
       return false;
     }
 
@@ -117,16 +109,17 @@ da_i.throw_an_error_if_server_is_not_responding = async function ( options ) {
     if ( is_timeout_error( error ) ) {
       // Anything that's waiting for the server to not be busy does not want
       // to move forward without a free server.
-      log.info({ code: `ALK0168`, context: `da api`, },
-        `The docassemble server was still busy after ${ timeout/1000 } seconds.`
-      );
+      log.info({ type: `da api`, code: `ALK0168`, pre: `The docassemble server was still busy after ${ timeout/1000 } seconds.` });
     } else {
       // Not sure what to do for other errors. It could be a server
       // error, like an 'Access Denied' error, which should be handled.
-      log.warning({ code: `ALK0169`, context: `da api` },
-        `Checked if the server was busy and ran into a different error`,
-        error
-      );
+      log.error({
+        type: `da api`,
+        code: `ALK0169`,
+        pre: `Tried to check if the docassemble server was busy, but `
+        + `ran into an unexpected error. The error didn't indicate a busy server, though. Error message:\n`
+        + error
+      });
     }
 
     throw error;
@@ -239,12 +232,8 @@ da_i.get_api_key_access_status = async function ({ timeout = null, api_key = nul
     }  // ends try
   }  // ends auth_data.codes only has the first code
 
-  // log.debug({ type: `da api info`, code: `ALKx0202`,
-  //   pre: `API key authentication info`, data: auth_data });
-  log.debug({ code: `ALK0202`, context: `da api`, },
-    `API key authentication info`,
-    auth_data
-  );
+  log.debug({ type: `da api info`, code: `ALK0202`,
+    pre: `API key authentication info`, data: auth_data });
 
   return auth_data;
 };  // Ends da_i.get_api_key_access_status()
@@ -258,20 +247,16 @@ da_i.delete_project = async function ( delete_options ) {
   let { timeout } = delete_options || { timeout: DEFAULT_MAX_REQUEST_MS };
 
   let project_name = session_vars.get_project_name()
-  log.info({ code: `ALK0170`, context: `da api`, },
-    `Trying to delete Project ${ project_name }`
-  );
+  log.info({ type: `da api`, code: `ALK0170`, pre: `Trying to delete Project ${ project_name }` });
 
   try {
     let response = await _da_REST.delete_project( timeout );
-    log.info({ code: `ALK0171`, context: `da api`, },
-      `Deleted Project "${ project_name }"`
-    );
+    log.info({ type: `da api`, code: `ALK0171`, pre: `Deleted Project "${ project_name }"` });
   } catch ( error ) {
-    log.throw({ code: `ALK0172`, context: `da api`, error: error },
-      `Ran into an error when deleting Project "${ project_name }". See https://docassemble.org/docs/api.html#playground_delete_project.`
-    );
-    // throw error;
+    let msg = `Ran into an error when deleting Project "${ project_name }". See https://docassemble.org/docs/api.html#playground_delete_project.`
+    log.error({ type: `da api`, code: `ALK0172`, pre: msg });
+    log.debug({ type: `da api`, code: `ALK0173`, pre: msg });
+    throw error;
   }
 
 };  // Ends da_i.delete_project()
@@ -295,9 +280,7 @@ da_i.quietly_try_to_delete_interviews = async function ({ interviews = {}, api_k
       });
       responses.push( sub_responses );
     } else {
-      log.debug({ code: `ALK0191`, context: `da api` },
-        `There is no interview to delete.`
-      );
+      log.debug({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
     }
   }
   return responses;
@@ -312,9 +295,9 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
   let responses = [];
   for ( let api_key of api_keys ) {
     try {
-      log.debug({ code: `ALK0188`, context: `da api` },
-        `Trying to delete the interview with the id ${ interview.uid } and an API key.`
-      );
+      log.debug({ type: `da api info`, code: `ALK0188`,
+        pre: `Trying to delete the interview with the id ${ interview.uid } and an API key.`
+      });
 
       // Actual work:
       let response = await _da_REST.delete_interview( timeout, {
@@ -323,15 +306,13 @@ da_i.quietly_delete_one_interview = async function ( timeout, { interview = {},
       });
       responses.push( response );
 
-      log.debug({ code: `ALK0189`, context: `da api` },
-        `No error when trying to delete interview ${ interview.uid } at ${ interview.i }.`
-      );
+      log.debug({ type: `da api info`, code: `ALK0189`,
+        pre: `No error when trying to delete interview ${ interview.uid } at ${ interview.i }.`
+      });
     } catch ( error ) {
       error.interview = interview;
-      log.debug({ code: `ALK0190`, context: `da api` },
-        `Error when deleting the interview. See https://docassemble.org/docs/api.html#session_delete.`,
-        error
-      );
+      let msg = `Error when deleting the interview. See https://docassemble.org/docs/api.html#session_delete.`
+      log.debug({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
     }
   }  // ends for api keys
   return responses;
@@ -366,9 +347,7 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
   if ( interview && interview.uid ) {
     for ( let api_key of api_keys ) {
       try {
-        log.debug({ code: `ALK0192`, context: `da api` },
-          `Trying to get the interview with the id ${ interview.uid } and an API key.`
-        );
+        log.debug({ type: `da api info`, code: `ALK0192`, pre: `Trying to get the interview with the id ${ interview.uid } and an API key.` });
 
         // Actual work:
         let response = await _da_REST.get_interview( timeout, {
@@ -377,28 +356,20 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
         });
 
         if ( response && response.data && response.data.items && response.data.items[0] && response.data.items[0].session ) {
-          log.debug({ code: `ALK0193`, context: `da api` },
-            `Status ${ response.status }. Got ${ response.data.items[0].session }.`
-          );
+          log.debug({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
           return response.data.items[0];
         } else {
-          log.debug({ code: `ALK0194`, context: `da api` },
-            `Status ${ response.status }. Cannot find ${ interview.uid }`
-          );
+          log.debug({ type: `da api info`, code: `ALK0194`, pre: `Status ${ response.status }. Cannot find ${ interview.uid }`});
         }
 
       } catch ( error ) {
         error.interview = interview;
-        log.debug({ code: `ALK0195`, context: `da api` },
-          `${ error.status || `No error.status.` } ${ error.statusText || error.data || `No error.statusText.` } Ran into an error when getting the interview ${ interview.uid }. See https://docassemble.org/docs/api.html#interviews.`,
-          error
-        );
+        let msg = `${ error.status || `No error.status.` } ${ error.statusText || error.data || `No error.statusText.` } Ran into an error when getting the interview ${ interview.uid }. See https://docassemble.org/docs/api.html#interviews.`
+        log.debug({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
       }
     }  // ends for api_keys
   } else {
-    log.debug({ code: `ALK0196`, context: `da api` },
-      `There is no interview to get.`
-    );
+    log.debug({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
   }
 
   return null;

package/lib/docassemble/server_install.js

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
 const session_vars = require('../utils/session_vars');
-const Log = require('../utils/log');
+const log = require('../utils/log');
 const fg = require('fast-glob');
 
 const server_install = async () => {
-  /** Finds out where in this directory the package's folders are. */
   session_vars.save_install_method(`server`);
 
   // Get path to folders inside repo main "docassemble" folder
@@ -24,33 +23,20 @@ const server_install = async () => {
   // Get names of all folders in repo "docassemble" folder
   let chosen_folder = folders[0];
   if ( folders.length === 0 ) {
-    let msg = `ALKiln cannot find the package's files. There are 0 folders at "${ path }". Stopping tests.`;
-    log.throw({ code: `ALK0044`, context: `server_install`,
-      error: new ReferenceError( msg )  // no logs
-    });
+    let msg = `There are 0 folders at ${path}. Stopping tests.`;
+    log.error({ type: `setup`, code: `ALK0044`, data: msg })
+    throw new ReferenceError( msg );
   }
 
   if ( folders.length > 1 ) {
-    log.warn({ code: `ALK0045`, context: `setup`, },
-      `There are ${ folders.length } folders at "${ path }": "${ folders.join('", "') }". ALKiln chose to use the folder "${ chosen_folder }".`
-    );
-  } else {
-    log.info({ code: `ALK0218`, context: `setup`, },
-      `ALKiln found the package folder at "${ chosen_folder }".`
-    );
+    log.warn({
+      type: `setup`,
+      code: `ALK0045`,
+      data: `There are ${folders.length} folders at ${path}: "${folders.join('", "')}". ALKiln chose to use the folder "${chosen_folder}".`
+    })
   }
   
   session_vars.save_repo_folder_name( chosen_folder );
 };  // Ends server_install();
 
-// 1. session_vars - make sure all the required env vars exist
-session_vars.validateEnvironment();
-
-// 2. Prepare logs
-// Local devs: This will be separate from your test paths
-// unless you pass a `path` argument into the cucumber run command
-const argv = require(`minimist`)(process.argv.slice(2));
-const log = new Log({ path: argv.path, context: `server_install` });
-
-// 3. run
 server_install();

package/lib/docassemble/setup.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
+// TODO: Rename to playground_install?
+
 const child_process = require(`child_process`);
 
-const Log = require(`../utils/log`);
+const log = require(`../utils/log`);
 const session_vars = require(`../utils/session_vars` );
-const files = require(`../utils/files` );
-const time = require(`../utils/time` );
 
 const setup = async () => {
   /** In the docassemble testing account identified by the
@@ -18,14 +18,9 @@ const setup = async () => {
   let project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
   session_vars.save_project_name( project_name );
 
-  const starting_msg = `Starting to upload this package to `
+  log.info({ type: `setup`, code: `ALK0046`, pre: `Starting to upload this package to `
     + `a new Project called ${project_name} in the Playground `
-    + `of your server's testing account. It may take a couple of minutes.`;
-  log.info({ code: `ALK0046`, context: `setup` },
-    starting_msg
-  );
-
-  // TODO: 1. Start listening to the normal console here (for debug logging)
+    + `of your server's testing account. It may take a couple of minutes.` });
 
   // dainstall . --apiurl https://site.org --apikey $API_KEY --playground --project=name
   // I think this won't run on windows? Why do I think this? Where on the
@@ -39,37 +34,29 @@ const setup = async () => {
       `--playground`, `--project=${ project_name }`
     ],
     // Prints messages from the process to the console while it's running
-    // result.stderr, result.stdout, etc. will be `null`
     { stdio: 'inherit', }
   );
 
-  // TODO: 2. Stop listening to the normal console here
-
   // 403 is invalid API key, but I'm not sure how to output
-  // the response to find out the error code. stderr is `null`.
+  // the response to find out the error code
+
   if ( result.status !== 0 ) {
-    const install_err_msg = `Status code ${ result.status }. Could not `
-      + `dainstall this package on your server. See above for more details.`;
-    log.throw({ code: `ALK0047`, context: `setup`,
-      before: `☝️ ☝️ ☝️  Error data ☝️ ☝️ ☝️\n`,
-      error: `Error while installing project` },
-      install_err_msg
-    );
+    log.error({
+      type: `setup`,
+      code: `ALK0047`,
+      pre: `Status code ${ result.status }. Could not dainstall this package on your server. See above for more details.`
+    });
+    throw(result.stderr);
   }
 
-  log.success({ code: `ALK0048`, context: `setup`, },
-    `ALKiln created a Project in your Playground named "${ project_name }"!`
-  );
+  log.success({
+    type: `setup`,
+    code: `ALK0048`,
+    pre: `ALKiln created a Project in your Playground named "${ project_name }"!`
+  });
 };  // Ends setup();
 
-// 1. session_vars - make sure all the required env vars exist
-session_vars.validateEnvironment();
-
-// 2. Prepare logs
-// Local devs: This will be separate from your test paths
-// unless you pass a `path` argument into the cucumber run command
-const argv = require(`minimist`)(process.argv.slice(2));
-const log = new Log({ path: argv.path, context: `setup` });
 
-// 3. run
+// Before everything, make sure all the required env vars exist
+session_vars.validateEnvironment();
 setup();

package/lib/docassemble/takedown.js

@@ -1,46 +1,26 @@
 #!/usr/bin/env node
 
 const da_i = require('./docassemble_api_interface');
-const session_vars = require('../utils/session_vars');
-const Log = require('../utils/log');
+const log = require('../utils/log');
+const session_vars = require('../utils/session_vars' );
 
 const takedown = async () => {
-  /** In the docassemble testing account identified by the
+  /* In the docassemble testing account identified by the
   *   DOCASSEMBLE_DEVELOPER_API_KEY secret, delete the
   *   Project created for this test.
   *   For local development, clean up project name file. */
-  log.info({ code: `ALK0177`, context: `takedown`, },
-    `Trying to remove the docassemble Project from the testing account.`
-  );
+  log.info({ type: `takedown`, code: `ALK0177`, pre: `Trying to remove the docassemble Project from the testing account.` });
   // Explicit try-catch prevents "Unhandled promise rejection error"
   // avoids showing confusing node errors to users that they shouldn't have to fix
   try {
     await da_i.delete_project();
     session_vars.delete_project_name();
-    log.info({ code: `ALK0178`, context: `takedown`, },
-      `Test takedown finished successfully!`
-    );
+    log.success({ type: `takedown`, code: `ALK0178`, pre: `Test takedown has finished successfully!` });
   } catch (error) {
-    log.throw({ code: `ALK0179`, context: `takedown`, error: error },
-      `Unable to delete project`,
-    );
-    // we don't re-throw the exception, so make sure to exit
-    // with 1 to let GitHub Actions know the script failed
+    log.error({type: `takedown`, code: `ALK0179`, pre: `Could not delete project`, data: JSON.stringify(error, null, 4)})
+    // we don't re-throw the exception, so make sure to exit with 1 to let GitHub Actions know the script failed
     process.exitCode = 1;
   }
-
-  // TODO: ? Build the final setup, run, & takedown verbose log
-  // file in here. Add to it in the GitHub action ?
 };
 
-// 1. session_vars - make sure all the required env vars exist
-session_vars.validateEnvironment();
-
-// 2. Prepare logs
-// Local devs: This will be separate from your test artifacts paths
-// unless you pass a `path` argument into the `cucumber` run command
-const argv = require(`minimist`)( process.argv.slice(2) );
-const log = new Log({ path: argv.path, context: `takedown` });
-
-// 3. run
 takedown();

package/lib/run_cucumber.js

@@ -1,10 +1,9 @@
 #!/usr/bin/env node
 
 const fs = require('fs');
-const path = require(`path`);
 const cucumber_api = require('@cucumber/cucumber/api');
 
-const Log = require('./utils/log');
+const log = require('./utils/log');  // These always log in the console
 const session_vars = require('./utils/session_vars');
 
 const SUMMARY_FILENAME = `cucumber-report.txt`;
@@ -54,14 +53,11 @@ function build_config( command_args ) {
 };  // Ends build_config()
 
 
-async function main() {
+(async function main() {
   /** Create the cucumber config, run the tests, create and
   *   manipluate the output. */
-
   const environment = { cwd: process.cwd() };
-  log.info({ code: `ALK0049`, context: `pre_run environment` },
-    environment
-  );
+  log.info({ type: `run`, code: `ALK0049`, pre: `environment`, data: environment });
 
   // We'll use the user info to construct the possible paths to /sources
   let id = session_vars.get_user_id();
@@ -69,9 +65,8 @@ async function main() {
   let project = session_vars.get_user_project_name();
 
   // process.argv is a list of strings of commands and args.
-  // If using `npm run cucumber` (as opposed to the bin commands),
-  // use `--` before `--sources=./foo`
-  const argv = require(`minimist`)( process.argv.slice(2), {
+  // If using `npm run cucumber`, use `--` before `--sources=./foo`
+  let argv = require(`minimist`)( process.argv.slice(2), {
     default: {
       sources: [
         `./docassemble/*/data/sources`,  // In GitHub folder
@@ -90,45 +85,35 @@ async function main() {
   let one_dir_exists = session_vars.set_sources_paths( sources_list );
   if ( !one_dir_exists ) {
     // If we don't throw, it'll be more confusing when no tests run
-    log.throw({ code: `ALK0050`, context: `pre_run`,
-      error: new ReferenceError(
-        `ALKiln can't find your "sources" folder(s). See above for details.`
-      ),
-    });
+    let msg = `ALKiln can't find your "sources" folder(s). See above for details.`;
+    let code = `ALK0050`
+    log.error({ type: `run`, code: code, pre: msg });
+    throw new ReferenceError(`🤕 ${ code } run ERROR: ${ msg }`);
   }
   
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: build_config( argv ),
   }, environment);
-  log.info({ code: `ALK0051`, context: `pre_run config`, },
-    runConfiguration
-  );
-
-  const codeDir = path.dirname(require.main.filename);
-  log.info({ code: `ALK0052`, context: `pre_run directory`, },
-    codeDir, `\n\n`
-  );
+
+  log.info({ type: `run`, code: `ALK0051`, pre: `runConfiguration`, data: runConfiguration });
+
+  var path = require(`path`);
+  var codeDir = path.dirname(require.main.filename);
+  log.info({ type: `run`, code: `ALK0052`, pre: `working directory`, data: codeDir });
   const support = await cucumber_api.loadSupport({ support: {
     requireModules: [ `${ codeDir }/index.js` ],
     requirePaths: [ `${ codeDir }/index.js` ],
     importPaths: [],
   }, sources: {paths: []}}, environment);
 
-  // ====================
-  // Run
-  // ====================
-  const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
-  // ====================
+  log.info({ type: `run`, code: `ALK0053`, pre: `working directory`, data: codeDir });
+  log.info({ type: `plain`, pre: `\n\n` });
 
+  const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
   if ( success ) {
-    log.success({ code: `ALK0054`, context: `post_run`, },
-      `Tests succeeded!`
-    );
+    log.success({ type: `run`, code: `ALK0054`, pre: `Tests succeeded!` });
   } else {
-    // Don't want to throw error here, so don't pass error object
-    log.warn({ code: `ALK0055`, context: `post_run`, },
-      `The tests ran into something unexpected. Look above for more details.`
-    );
+    log.error({ type: `run`, code: `ALK0055`, pre: `The test run ran into something unexpected. Look above for more details.` });
   }
   // Custom exit code. May overlap with other systems.
   // Best info I've found via stack overflow: https://tldp.org/LDP/abs/html/exitcodes.html
@@ -138,64 +123,31 @@ async function main() {
   // This is hardcoded information from `provide_config` above.
   // This code isn't used for anything other than detecting and removing color codes.
   let summary_file_name = SUMMARY_FILENAME;
-  fs.readFile(summary_file_name, 'utf8', (read_error, text) => {
-    if ( read_error ) {
+  fs.readFile(summary_file_name, 'utf8', (err, text) => {
+    if (err) {
       // Something else will probably show an error that's more relevant
-      log.warn({ code: `ALK0056`, context: `post_run error`, },
-        `Failed to read cucumber report`, read_error
-      );
+      log.info({ type: `run`, code: `ALK0056`, pre: `Failed to read cucumber report`, data: err });
       return;
     }
 
     // Replace terminal color codes, if present
     // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode
     text = text.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
-    // Add to the debug file
+
+    // Put it in the correct file in the correct folder
+    let artifacts_path = session_vars.get_artifacts_path_name();
     try {
-      // fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, `\n\n${text}`);
-      log.debug({ code: `ALK0216`, context: `post_run`, },
-        `\n\n`, text
-      );
+      fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, `\n\n${text}`);
     } catch ( error ) {
-      log.warn({ code: `ALK0182`, context: `post_run error`, },
-        `Something probably went wrong earlier. Look above for more details. Problem when writing to ${ log.path }/${ log.debug_log_filename }.`,
-        error
-      );
+      log.info({ type: `run`, code: `ALK0182`, pre: `Something probably went wrong earlier. Look above for more details, but here is more information just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.debug_log_file }.`, data: error });
     }
-
-    // Add to the non-passed test output file
     try {
-      // Save only non-passing test output to cut out cruft.
-      // cucumber only outputs non-success details anyway.
-      // Our reports only non-passing tests to this file.
+      // Add to a unexpected results file when tests themselves fail
       if ( exitCode === 50 ) {
-        // fs.appendFileSync( `${ log.path }/${ Log.unexpected_filename }`, `\n\n${ text }` );
-        log.unexpected({ text });
+        fs.appendFileSync( `${ artifacts_path }/${ log.unexpected_filename }`, `\n\n${ text }` );
       }
-    } catch ( unexpected_file_error ) {
-      console.warn(
-        `🔎 ALK0181 internal WARNING: Something probably went wrong earlier. Problem when writing to ${ log.path }/${ log.unexpected_filename }`,
-        unexpected_file_error
-      );
+    } catch ( error ) {
+      log.info({ type: `run`, code: `ALK0181`, pre: `Something probably went wrong earlier. Look above for more details, but here is more information just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.unexpected_filename }.`, data: error });
     }
-
-    return;
   });
-}
-
-
-// 1. session_vars - make sure all the required env vars exist
-session_vars.validateEnvironment();
-
-// 2. Prepare logs
-// process.argv is a list of strings of commands and args.
-// If using `npm run cucumber` (as opposed to the bin commands),
-// use `--` before `--sources=./foo`
-const argv = require(`minimist`)( process.argv.slice(2) );
-// The artifacts folder might be getting created for the first
-// time right here. The tests themselves should avoid creating
-// their own file.
-const log = new Log({ path: argv.path, context: `run` });
-
-// 3. run
-main();
+})();