@suffolklitlab/alkiln 4.2.1-custom-setup-timeout.1 → 4.3.0

package/.github/workflows/test_tests.yml

@@ -78,12 +78,12 @@ jobs:
         with:
           name: report
           path: ./**/*_report_*
-      - name: log artifact
+      - name: upload debug_log artifact
         uses: actions/upload-artifact@v2
         if: ${{ always() }}
         with:
-          name: log file
-          path: ./log.txt
+          name: debug_log file
+          path: ./debug_log.txt
       - name: Cleanup
         if: ${{ always() }}
         run: npm run takedown

package/CHANGELOG.md

@@ -38,9 +38,17 @@ Format:
 ### Security
 - 
 -->
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [4.3.0] - 2022-04-07
 ### Added
-- GitHub environment variable MAX_SECONDS_FOR_SETUP to set a custom maximum time for setup and takedown for packages that take a long time to load.
+- GitHub environment variable `MAX_SECONDS_FOR_SETUP` to set a custom maximum time for setup and takedown for packages that take a long time to load.
+
+## [4.2.0] - 2022-04-05
+### Changed
+- Pin versions of dependencies in action.yml and package.json
+- Change log.txt file to debug_log.txt and upload as github artifact.
+- Update cheerio version to remove vulnerabilities.
 
 ## [4.1.1] - 2022-04-01
 ### Added

package/action.yml

@@ -82,7 +82,7 @@ runs:
           },
           "dependencies": {
             "colors": "1.4.0",
-            "@cucumber/cucumber": "^7.3.2",
+            "@cucumber/cucumber": "7.3.2",
             "@suffolklitlab/alkiln": "$ALKILN_VERSION"
           }
         }

package/lib/docassemble/docassemble_api_interface.js

@@ -181,10 +181,9 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
   // Defaults
   creation_options = creation_options || {};
-  let default_opts = { timeout: DEFAULT_MAX_REQUEST_MS, max_tries: 15, wait_seconds: 5 };
-  let timeout = creation_options.timeout || default_opts.timeout;
-  let max_tries = creation_options.max_tries || default_opts.max_tries;
-  let wait_seconds = creation_options.wait_seconds || default_opts.wait_seconds;
+  let timeout = creation_options.timeout || DEFAULT_MAX_REQUEST_MS;
+  let max_tries = creation_options.max_tries || 15;
+  let wait_seconds = creation_options.wait_seconds || 5;
 
   let project_name = null;
   let name_incrementor = 0;
@@ -353,13 +352,14 @@ da_i.wait_for_server_to_restart = async ( task_id, options ) => {
   // Base default
   options = options || {};
   // Default timeout
-  let default_timeout = DEFAULT_MAX_REQUEST_MS;
-  let timeout = options.timeout || default_timeout;
+  let timeout = options.timeout || DEFAULT_MAX_REQUEST_MS;
   // Other defaults
-  let default_wait_per_loop = 5 * 1000;
-  let default_max_loops = timeout/default_wait_per_loop;
+  let default_wait_between_loops = 4 * 1000;
+  let default_wait_for_response = 1 * 1000;
+  let default_max_loops = timeout/( default_wait_between_loops + default_wait_for_response );
   // Actual values
-  let wait_ms_per_loop = options.wait_ms_per_loop || default_wait_per_loop;
+  let wait_between_loops = options.wait_between_loops || default_wait_between_loops;
+  let wait_for_response = options.wait_for_response || default_wait_for_response;
   let max_loops = options.max_loops || default_max_loops;
 
   // Flags for stopping the `while` loop
@@ -372,7 +372,7 @@ da_i.wait_for_server_to_restart = async ( task_id, options ) => {
   while ( !done_restarting && num_tries <= max_loops ) {
     num_tries++;
     // Wait only a short time for the task to finish, not the full default timeout
-    done_restarting = await da_i.has_task_finished( task_id, { timeout: 1 * 1000 } );
+    done_restarting = await da_i.has_task_finished( task_id, { timeout: wait_for_response } );
     if ( !done_restarting ) {
       if ( num_tries < max_loops ) {
         // Show a slightly different message after a number of tries to reassure
@@ -381,16 +381,17 @@ da_i.wait_for_server_to_restart = async ( task_id, options ) => {
         if ( num_tries > 3 ) { msg_start = `Still not complete`; }
 
         // When the server is busy, the task timeout causes this loop to actually
-        // take 6 seconds to complete, not 5, but I'm not sure how to make that clear
+        // take 5 seconds to complete, but this only waits for 4. I'm not sure how
+        // to make that clear
         log.info({ pre: `${ msg_start }. Check ${ num_tries } of ${ max_loops }. `
-          + `Will check again in ${ wait_ms_per_loop/1000 } seconds.`
+          + `Will check again in ${( wait_between_loops + wait_for_response )/1000 } seconds.`
         });
-        await time.waitForTimeout( wait_ms_per_loop );
+        await time.waitForTimeout( wait_between_loops );
 
       } else {
         // This is our last round, let's wrap it up
         let server_msg = `ALKiln setup: It seems like the docassemble server `
-          + `didn't finish uploading the code after ${ max_loops * (wait_ms_per_loop/1000) } `
+          + `didn't finish uploading the code after ${ timeout/1000 } `
           + `seconds. Some things you can try: check your server is up, try `
           + `re-running the test, and try pulling the package manually `
           + `into the playground.`;
@@ -421,8 +422,6 @@ da_i.delete_project = async function ( delete_options ) {
     log.info({ pre: `Deleted Project "${ project_name }"` });
 
   } catch ( error ) {
-    // TODO: Add more useful error messages, like project doesn't exist. The devs
-    // shouldn't be deleting projects by hand, but it's still very possible they would
     // Status 400
     log.error({ pre: `Ran into an error when deleting Project "${ project_name }"` });
     log.debug({ pre: `See https://docassemble.org/docs/api.html#playground_delete_project.` });

package/lib/scope.js

@@ -60,7 +60,7 @@ module.exports = {
     let scenario = await scope.makeSureReportPartsExist( scope );
     scenario.lines.push({ type, value });
 
-    fs.appendFileSync('log.txt', `Report:\ntype: ${ type }, value: ${ value }`);
+    fs.appendFileSync('debug_log.txt', `Report:\ntype: ${ type }, value: ${ value }`);
     return scenario;
     
   },  // Ends scope.addToReport()

package/lib/steps.js

@@ -68,7 +68,7 @@ BeforeAll(async () => {
   scope.timeout = 30 * 1000;
   scope.showif_timeout = 600;
   scope.report = new Map();
-  fs.writeFileSync('log.txt', "");
+  fs.writeFileSync('debug_log.txt', "");
 });
 
 Before(async (scenario) => {

package/lib/utils/session_vars.js

@@ -20,7 +20,7 @@ const session_vars = {};
 
 module.exports = session_vars;
 
-// Default to null
+// These default to null
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
 session_vars.get_repo_url = function () { return process.env.REPO_URL || null; };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.2.1-custom-setup-timeout.1",
+  "version": "4.3.0",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -34,16 +34,16 @@
   },
   "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/",
   "dependencies": {
-    "@cucumber/cucumber": "^7.3.2",
-    "axios": "^0.24.0",
-    "chai": "^4.2.0",
-    "cheerio": "^1.0.0-rc.5",
-    "dotenv": "^8.2.0",
-    "mocha": "^9.2.0",
-    "puppeteer": "^13.1.3",
-    "qs": "^6.10.2",
-    "sanitize-filename": "^1.6.3",
-    "uuid": "^8.3.2"
+    "@cucumber/cucumber": "7.3.2",
+    "axios": "0.24.0",
+    "chai": "4.2.0",
+    "cheerio": "1.0.0-rc.10",
+    "dotenv": "8.2.0",
+    "mocha": "9.2.0",
+    "puppeteer": "13.1.3",
+    "qs": "6.10.2",
+    "sanitize-filename": "1.6.3",
+    "uuid": "8.3.2"
   },
   "bin": {
     "alkiln-setup": "./lib/docassemble/setup.js",