@suffolklitlab/alkiln 5.15.4-ref-paths-1 → 5.15.4

package/CHANGELOG.md

@@ -43,15 +43,7 @@ Format:
 - 
 -->
 
-## [Unreleased]
-
-### Changed
-
-- Use `cwd` as the base of file paths. Motivated by ALKiP's need to change the way it handles its own file paths.
-
-### Fixed
-
-- Print error correctly when missing sources paths
+<!-- ## [Unreleased] -->
 
 ## [5.15.4] - 2025-11-29
 

package/lib/scope.js

@@ -2768,7 +2768,7 @@ module.exports = {
         pic_name = `pic_on-${ short_id }-${ timestamp }`;
       }
 
-      await scope.take_a_screenshot( scope, { path: `${ scope.paths.scenario }/${ pic_name }.jpg` });
+      await scope.take_a_screenshot( scope, { path: `./${ scope.paths.scenario }/${ pic_name }.jpg` });
 
       await scope.afterStep( scope );
     },  // Ends scope.steps.screenshot()

package/lib/setup/artifacts.js

@@ -2,19 +2,19 @@
 
 const session_vars = require(`../utils/session_vars`);
 const files = require(`../utils/files`);
-const Log = require(`../utils/Log.js`);
+const Log = require(`../setup/artifacts.js`);
 
-/**
- * Reset and refresh artifacts path name. Use this at the start of every test
- * run for that run's unique results.
- * */
+/** Reset and refresh artifacts path name */
 
 session_vars.delete_artifacts_path_name();
 
-const artifacts_path = files.make_artifacts_folder();
+// 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) );
+const artifacts_path = files.make_artifacts_folder( argv.path );
+
 session_vars.save_artifacts_path_name( artifacts_path );
 
-const log = new Log({ path: artifacts_path, context: `artifacts` });
-log.info({ code: `ALK0278`, context: `artifacts`,},
-  `Created the artifacts folder at "${ artifacts_path }"`
-);
+// Leave the config Project name value as it is. Local developers find it
+//    useful to re-use that value.

package/lib/utils/Log.js

@@ -228,7 +228,6 @@ class Log {
       }
 
       if ( !fs.existsSync( dir )) {
-        process.stdout.write(`Making artifacts folder in Log at ${ dir }`)
         files.make_artifacts_folder( dir );
       }
 

package/lib/utils/files.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const safe_filename = require('sanitize-filename');
-const path = require(`path`);
 
 let files = {};
 
@@ -22,30 +21,27 @@ files.readable_date = function() {
   return fancy_str;
 };  // Ends files.readable_date()
 
-files.make_artifacts_folder = function ( file_path ) {
+files.make_artifacts_folder = function (path) {
   /** Makes a folder in the root of the project if it doesn't
    *  already exist, either with the given name or with a default name.
    *
    * Works for local development as well, without action.yml or workflow files.
    * */
-  if (file_path) {
-    let name_parts = file_path.split(`/`);
+  if (path) {
+    let name_parts = path.split(`/`);
     let safe_parts = [];
     for ( let part of name_parts ) {
       safe_parts.push(safe_filename( part ));
     }
-    file_path = path.join( ...safe_parts );
+    path = safe_parts.join(`/`);
   } else {
-    file_path = `alkiln-${ files.readable_date() }`
+    path = `alkiln-${ files.readable_date() }`
   }
 
-  const root = process.cwd();
-  root_path = path.join( root, file_path );
-
   // `recursive` avoids errors if folder already exists
   // https://nodejs.org/docs/latest-v18.x/api/fs.html#fspromisesmkdirpath-options
-  fs.mkdirSync( root_path, { recursive: true });
-  return root_path;
+  fs.mkdirSync( path, { recursive: true });
+  return path;
 };  // Ends files.make_artifacts_folder()
 
 module.exports = files;

package/lib/utils/session_vars.js

@@ -52,10 +52,6 @@ session_vars.get_origin = function () {
 };
 session_vars.get_user_project_name = function () { return process.env._PROJECT_NAME || null; };
 session_vars.get_user_id = function () { return process.env._USER_ID || null; };
-session_vars.get_runtime_config_path = function () {
-  const root = process.cwd();  // absolute path just to be sure
-  return path.join( root, `runtime_config.json` );
-}
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -137,6 +133,7 @@ session_vars.get_languages = function () {
 };  // Ends session_vars.get_languages()
 
 
+const runtime_config_path = `runtime_config.json`;
 const project_name_key = `da_project_name`;
 session_vars.save_project_name = function ( project_name ) {
   /* Saves the name of the project to a json obj so deletion can use it later.
@@ -145,7 +142,6 @@ session_vars.save_project_name = function ( project_name ) {
   *    Should we try to prevent someone overwriting a previous project name?
   * 
   * @param project_name { string } - purely alphanumeric string */
-  const runtime_config_path = session_vars.get_runtime_config_path();
 
   // Warn local developers if file already exists
   if ( fs.existsSync( runtime_config_path ) ) {
@@ -176,8 +172,6 @@ session_vars.get_project_name = function () {
   if ( session_vars.get_origin() === 'playground' ) {
     return session_vars.get_user_project_name();
   }
-
-  const runtime_config_path = session_vars.get_runtime_config_path();
   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
   let project_name = json[ project_name_key ] || null;
   if ( session_vars.get_debug() ) { console.debug( `🐛 ALK0037 DEBUG: Project name from file is "${ project_name }".` ); }
@@ -186,7 +180,6 @@ session_vars.get_project_name = function () {
 
 session_vars.delete_project_name = function () {
   /* Empty the key storing the name of the docassemble Project */
-  const runtime_config_path = session_vars.get_runtime_config_path();
   try {
     // Get the json, changing it, and re-write the file from scratch
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
@@ -259,7 +252,6 @@ session_vars.save_runtime_config_var = function ({ key, value }) {
   * 
   * @returns {binary?} file Runtime config file
   */
-  const runtime_config_path = session_vars.get_runtime_config_path();
 
   // Ensure runtime config file exists
   if ( !fs.existsSync( runtime_config_path ) ) {
@@ -285,7 +277,6 @@ session_vars.get_runtime_config_var = function ( key ) {
    * 
    * @returns {any} - Value of given key in runtime config file or null
    */
-  const runtime_config_path = session_vars.get_runtime_config_path();
   try {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     let value = json[ key ];
@@ -309,7 +300,6 @@ session_vars.delete_runtime_config_var = function ({ key }) {
    * 
    * @returns {null}
    * */
-  const runtime_config_path = session_vars.get_runtime_config_path();
   try {
     if ( !fs.existsSync( runtime_config_path )) { return null; }
     

package/lib/utils/set_sources_paths.js

@@ -1,5 +1,4 @@
 const fast_glob = require(`fast-glob`);
-const path = require(`path`);
 
 const session_vars = require(`./session_vars`);
 
@@ -19,7 +18,7 @@ module.exports = function set_sources_paths({ log }) {
   let maybe_paths = get_potential_paths();
 
   let sources_paths = get_sources_paths({ maybe_paths });
-  if ( sources_paths.length === 0 ) {
+  if ( sources_paths === 0 ) {
     // If we don't throw, it'll be more confusing when no tests run
     log.throw({ code: `ALK0050`, context: `sources`,
       error: new ReferenceError(
@@ -46,7 +45,6 @@ function get_potential_paths() {
   // `project` is the name in the server docassemble "Project" page
   let project = session_vars.get_user_project_name();
   let id = session_vars.get_user_id();
-  let root = process.cwd();  // Assumes correct root. See docs about root path.
 
   // process.argv is a list of strings of commands and args.
   // Internal note: If using `npm run cucumber`, use `--` before
@@ -55,8 +53,8 @@ function get_potential_paths() {
     default: {
       sources: [
         `./docassemble/*/data/sources`,  // In GitHub folder
-        `/usr/share/docassemble/files/playgroundsources/${id}/${project}`, // From playground without S3
-        path.join( root, `/playgroundsources/${id}/${project}`), // From playground with S3
+        `/usr/share/docassemble/files/playgroundsources/${id}/${project}/*.feature`, // From playground without S3
+        `/tmp/playgroundsources/${id}/${project}/*.feature` // From playground with S3
       ],
     }
   });
@@ -83,16 +81,16 @@ function get_sources_paths({ maybe_paths }) {
   // Check every path, tracking which exist and which are missing
   let existing_paths = [];
   let missing_paths = [];
-  for ( let maybe_path of maybe_paths ) {
+  for ( let path of maybe_paths ) {
     let dirs = fast_glob.sync(
-      [ maybe_path ],
+      [ path ],
       { onlyFiles: false, suppressErrors: true }
     );
 
     if ( dirs.length > 0 ) {
       existing_paths.push( ...dirs );
     } else {
-      missing_paths.push( maybe_path );
+      missing_paths.push( path );
     }
   }
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.15.4-ref-paths-1",
+  "version": "5.15.1-update-deps2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@suffolklitlab/alkiln",
-      "version": "5.15.4-ref-paths-1",
+      "version": "5.15.1-update-deps2",
       "license": "MIT",
       "dependencies": {
         "@axe-core/puppeteer": "4.7.3",
@@ -380,6 +380,7 @@
       "version": "4.0.1",
       "resolved": "https://registry.npmjs.org/@cucumber/message-streams/-/message-streams-4.0.1.tgz",
       "integrity": "sha512-Kxap9uP5jD8tHUZVjTWgzxemi/0uOsbGjd4LBOSxcJoOCRbESFwemUzilJuzNTB8pcTQUh8D5oudUyxfkJOKmA==",
+      "peer": true,
       "peerDependencies": {
         "@cucumber/messages": ">=17.1.1"
       }
@@ -388,6 +389,7 @@
       "version": "19.1.4",
       "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-19.1.4.tgz",
       "integrity": "sha512-Pksl0pnDz2l1+L5Ug85NlG6LWrrklN9qkMxN5Mv+1XZ3T6u580dnE6mVaxjJRdcOq4tR17Pc0RqIDZMyVY1FlA==",
+      "peer": true,
       "dependencies": {
         "@types/uuid": "8.3.4",
         "class-transformer": "0.5.1",
@@ -1482,7 +1484,8 @@
     "node_modules/devtools-protocol": {
       "version": "0.0.1312386",
       "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.1312386.tgz",
-      "integrity": "sha512-DPnhUXvmvKT2dFA/j7B+riVLUt9Q6RKJlcppojL5CoRywJJKLDYnRlw0gTFKfgDPHP5E04UoB71SxoJlVZy8FA=="
+      "integrity": "sha512-DPnhUXvmvKT2dFA/j7B+riVLUt9Q6RKJlcppojL5CoRywJJKLDYnRlw0gTFKfgDPHP5E04UoB71SxoJlVZy8FA==",
+      "peer": true
     },
     "node_modules/diff": {
       "version": "5.0.0",
@@ -3008,6 +3011,7 @@
       "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-22.15.0.tgz",
       "integrity": "sha512-XjCY1SiSEi1T7iSYuxS82ft85kwDJUS7wj1Z0eGVXKdtr5g4xnVcbjwxhq5xBnpK/E7x1VZZoJDxpjAOasHT4Q==",
       "hasInstallScript": true,
+      "peer": true,
       "dependencies": {
         "@puppeteer/browsers": "2.3.0",
         "cosmiconfig": "^9.0.0",

package/package.json

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

package/docs/016_root_path_2026_04_09.md

@@ -1,17 +0,0 @@
-# Root path
-
-This code assumes the current root directory will contain the necessary files and folders to get files like `.feature` files and the test run runtime config file.
-
-When you run ALKiln on the command line, run the tests in the root directory of the docassemble package with the tests. There are other ways to tell processes where the root directory is. For example, ALKiP, a docassemble package that uses ALKiln inside an author's server, runs `subprocess.run()` or `subprocess.Popen()` with `cwd=`. In ALKiP the `cwd` is most likely `/tmp`.
-
-Files that make this root path assumption:
-
-- lib/utils/set_sources_paths.js
-- lib/utils/files.js
-- lib/utils/session_vars.js
-
-ALKiln makes assumptions about specific folder names inside the root directory. See `lib/utils/set_sources_paths.js` and `validate.js` for where it looks for `.feature` files.
-
-## Anti-goals
-
-It is possible for us to make the root path configurable in a few ways (env vars, command line args, etc.), but we are avoiding adding that maintenance cost until we see a need.