@suffolklitlab/alkiln 5.0.0-pre-5 → 5.0.0-pre-7

package/CHANGELOG.md

@@ -48,18 +48,21 @@ Format:
 - 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
+- Change interface for testing languages. See [#713](https://github.com/SuffolkLITLab/ALKiln/issues/713).
 
 ### 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)
+- Allow multiple languages to be tested again. See [#713](https://github.com/SuffolkLITLab/ALKiln/issues/713).
 
 ### Security
 - Pass docassemble API keys through HTTP headers instead of as parameters.

package/lib/run_cucumber.js

@@ -33,20 +33,23 @@ const cucumber_api = require('@cucumber/cucumber/api');
   }
 
   if (tags.length > 0) {
+    let joined_tags = '';
     // Cucumber expects tags in boolean expressions, like (@a0 or @a1) and @random.
     // If we get a list of only tags, then "or" them all together
     if (tags.every((val) => val.startsWith("@"))) {
-      provided_config.tags = tags.join(' or ');
+      joined_tags = tags.join(' or ');
     }
     // If we get a list of seemingly no tags, assume they meant to use tags
     else if (tags.every((val) => !val.startsWith("@"))) {
-      provided_config.tags = tags.map((val) => "@" + val).join(' or ');
+      joined_tags = tags.map((val) => "@" + val).join(' or ');
     }
     // If it's a mix of tags and no tags, it's probably a boolean expression!
     else {
-      provided_config.tags = tags.join(' ');
+      joined_tags = tags.join(' ');
     }
-  }
+
+    provided_config.tags = joined_tags;
+  }  // end if there are tags
 
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: provided_config

package/lib/scope.js

@@ -1212,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,

package/lib/steps.js

@@ -160,7 +160,7 @@ Before(async (scenario) => {
 //#####################################
 //#####################################
 
-Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}, async (file_name, language) => {  // √
+Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) => {  // √
 
   // Load the right interview page
   await scope.load( scope, file_name );
@@ -180,7 +180,7 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
       // I've seen stuff take an extra moment or two. Shame to have it everywhere
       try {
         // Interview files should get downloaded to downloads folder
-        await scope.page._client.send('Page.setDownloadBehavior', {
+        await scope.page._client().send('Page.setDownloadBehavior', {
           behavior: 'allow',
           downloadPath: path.resolve( scope.paths.scenario ),  // Save in root of this scenario
         });
@@ -203,7 +203,7 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
     // at any one time since each step completes synchronously
 
     // If response has a file in it that matches the file we are downloading
-    if ( response._headers['content-disposition'] && (response._headers['content-disposition']).includes(`attachment;filename=${scope.toDownload}`) ) {
+    if ( response.headers()['content-disposition'] && (response.headers()['content-disposition']).includes(`attachment;filename=${scope.toDownload}`) ) {
       // We're choosing to avoid removing the event listener in case removal
       // would prevent downloading other files. The listener should get
       // destroyed when the page closes anyway.
@@ -211,7 +211,7 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
       // Watch event on download folder or file
       await fs.watchFile( scope.paths.scenario, function (curr, prev) {
         // If current size eq to size from response then close
-        if (parseInt(curr.size) === parseInt(response._headers['content-length'])) {
+        if (parseInt(curr.size) === parseInt(response.headers()['content-length'])) {
           // Lets the related function in `scope` know that the download
           // is done so that the next step can start.
           scope.downloadComplete = true;
@@ -224,25 +224,6 @@ Given(/I start the interview at "([^"]+)"(?: in lang "([^"]+)")?/, {timeout: -1}
     }  // ends if this is the file the developer expected
   });  // ends page.on 'response'
 
-
-  // TODO: Move language into a different step
-  scope.language = language;
-  let custom_lang_timeout = new Promise(async ( resolve, reject ) => {
-    let page_timeout = setTimeout(function() { reject( `It took to long to try to set the language "${ language }".` ); }, scope.timeout);
-    // self-invoke an anonymous async function so we don't have to
-    // abstract the details of resolving and rejecting.
-    (async function() {
-      try {
-        await scope.setLanguage( scope, { language });
-        resolve();
-      } catch ( err ) { reject( err ); }
-      // prevent temporary hang at end of tests
-      finally { clearTimeout( page_timeout ); }
-    })();
-  });  // ends custom_lang_timeout
-  await custom_lang_timeout;
-
-
   let custom_afterStep_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() { reject(`\`afterStep()\` took too long.`); }, scope.timeout);
     // self-invoke an anonymous async function so we don't have to