@suffolklitlab/alkiln 5.0.0-pre-4 → 5.0.0-pre-6

package/CHANGELOG.md

@@ -45,20 +45,22 @@ Format:
   be run in any directory, not just in an npm package.
 - Additional environment variables and their validation to allow for tests that run on a developer's server/Playground instead of through GitHub. Also, other functionality for that purpose. [Issue #661](https://github.com/SuffolkLITLab/ALKiln/issues/661)
 - Tests for new session_vars behavior and improve previous tests.
+- Adds `npm-shrinkwrap.json`, so installs from npm will have fixed version dependencies
 
 ### Changed
+- BREAKING: the github action no longer runs `npm run XYZ`; it directly calls scripts,
+    e.g. `alkiln-setup`, `alkiln-run`, `alkiln-takedown`
 - upgraded cucumber v8.6.0
 - using cucumber's JS API to run tests. For more details on how it works,
     see [the cucumber-js docs](https://github.com/cucumber/cucumber-js/blob/main/docs/javascript_api.md).
-- the github action no longer runs `npm run XYZ`; it directly calls scripts,
-    e.g. `alkiln-setup`, `alkiln-run`, `alkiln-takedown`
 - don't print the ["publish this cucumber report" message](https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#options)
 - Adjusted validation of some environment variables to account for Playground vs. GitHub or local test runs. [Issue #661](https://github.com/SuffolkLITLab/ALKiln/issues/661)
-- Project name prefix now includes ALKiln in it for clarity
+- Docassemble Project name prefix now includes ALKiln in it for clarity
 
 ### Fixed
 - Projects created in da each have a unique name. https://github.com/SuffolkLITLab/ALKiln/issues/663
 - Shorten path names to try to accommodate limitations of windows systems while still keeping enough useful information to help devs identify the test outputs. https://github.com/SuffolkLITLab/ALKiln/issues/618
+- Updated field decoding to handle new object field encoding. See [#711](https://github.com/SuffolkLITLab/ALKiln/issues/711)
 
 ### Security
 - Pass docassemble API keys through HTTP headers instead of as parameters.

package/CONTRIBUTING.md

@@ -112,6 +112,12 @@ Our tests require the user/developer to have a docassemble server on which they
 
 When the developer commits code to GitHub, their account triggers our code, passing along variables that our code needs, like their GitHub secret of the API key for their docassemble server developer account.
 
+## Updating dependencies
+
+Sometimes you will have to add dependencies to ALKiln. You can do so by adding the dependency in the `package.json` "dependencies" section, specifying an exact version. Then, run `npm install` to update `npm-shrinkwrap.json` to have the new dependency.
+
+If you have to update an existing dependency, you can change the version in `package.json`, and run `npm install` to update `npm-shrankwrap.json`.
+
 ## Very general architecture of files and folders
 
 An honest look at our current project architecture—some of our files and folders, what they do, and how they interact.

package/lib/scope.js

@@ -285,7 +285,8 @@ module.exports = {
   getJSONFilename: async function( scope ) {
     // Get a unique path for a json file
     let { id } = await scope.examinePageID( scope, 'none to match' );
-    let json_path = path.join( scope.paths.scenario, `json_for-${ id }-${ Date.now() }.json` );
+    let short_id = `${ id }`.substring(0, 20);
+    let json_path = path.join( scope.paths.scenario, `json_for-${ short_id }-${ Date.now() }.json` );
     return json_path;
   },
 
@@ -1211,7 +1212,7 @@ module.exports = {
     // Some fields have a key hidden inside them.
     // This gets the variable name before the final brackets, and the likely
     // still base64 encoded string inside the brackets
-    let before_and_in_brackets = expr_str.match( /^(.*)\[[BR]'(.*)'\]/ );
+    let before_and_in_brackets = expr_str.match( /^(.*)\[[BRO]'(.*)'\]/ );
 
     // Of the format `foo[B'encoded']` or `foo[R'encoded']`
     // The B means internal to docassemble, the encoded portion is a string,