@suffolklitlab/alkiln 4.10.4-feat-debug-cache → 4.11.0

package/CHANGELOG.md

@@ -38,11 +38,11 @@ Format:
 ### Security
 - 
 -->
+<!-- ## [Unreleased] -->
 
-## [Unreleased]
-### Added
-- Story table can take screenshots after each visited page.
-- Projects created in da each have a unique name. We assume for now this will not build up test packages in the server.
+## [4.11.0] - 2023-03-13
+### Changed
+- Shorten Axios errors to make them more readable (https://github.com/SuffolkLITLab/ALKiln/pull/632)
 
 ## [4.10.4] - 2023-02-15
 ### Added

package/lib/docassemble/docassemble_api_REST.js

@@ -24,7 +24,11 @@ da.get_dev_id = async function ( timeout ) {
     timeout: timeout,
   };
 
-  return await axios.request( options );
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    throw error.toJSON();
+  }
 };  // Ends da.get_dev_id()
 
 
@@ -41,8 +45,11 @@ da.create_project = async function ( project_name, timeout ) {
     timeout: timeout,
   };
 
-  return await axios.request( options );
-
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    throw error.toJSON();
+  }
 };  // Ends da.create_project()
 
 
@@ -61,7 +68,11 @@ da.pull = async function ( timeout ) {
     timeout: timeout,
   };
 
-  return await axios.request( options );
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    throw error.toJSON();
+  }
 };  // Ends da.pull()
 
 
@@ -78,7 +89,11 @@ da.has_task_finished = async function ( task_id, timeout ) {
     timeout: timeout,
   };
 
-  return await axios.request( options );
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    throw error.toJSON();
+  }
 };  // Ends da.has_task_finished()
 
 
@@ -95,7 +110,11 @@ da.delete_project = async function ( timeout ) {
     timeout: timeout,
   };
 
-  return await axios.request( options );
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    throw error.toJSON();
+  }
 };  // Ends da.delete_project()
 
 
@@ -121,9 +140,9 @@ da.__delete_projects_starting_with = async function ( base_name, starting_num=1,
         timeout: 30 * 1000,
       };
 
-      await axios.request( options ); 
+      await axios.request( options );
     } catch ( error ) {
-      console.log( error )
+      console.log( error.toJSON() )
     }
     name_incrementor++;
   }

package/lib/docassemble/docassemble_api_interface.js

@@ -204,16 +204,16 @@ da_i.loop_to_create_project = async function( creation_options ) {
   let wait_seconds = creation_options.wait_seconds || 5;
 
   let project_name = null;
-  let num_tries = 0;
+  let name_incrementor = 0;
 
   // Try to create a project. If the project name is already taken, increment and loop again.
-  while ( num_tries <= max_tries ) {
-    num_tries++;
+  while ( name_incrementor <= max_tries ) {
+    name_incrementor++;
     try {
 
-      // Try adding a new timestamp to the name. Must remove all non-valid characters
+      // Try next name that could be unique. Must remove all non-valid characters
       // TODO: This sanitization is already done in session_vars, so remove it from here
-      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
+      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + name_incrementor;
       log.info({ pre: `Trying to create a docassemble Project with the name ${ project_name }` });
       let response = await _da_REST.create_project( project_name, timeout );
       log.info({ pre: `The docassemble server is ready. Created a Project named ${ project_name }` });
@@ -226,7 +226,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
       if ( response && response.data ) {
         if ( response.data.includes( `Invalid project` ) ) {
-          if ( num_tries < max_tries ) {
+          if ( name_incrementor < max_tries ) {
             // A non-unique project name. Try the next project name.
             continue;
 
@@ -250,17 +250,15 @@ da_i.loop_to_create_project = async function( creation_options ) {
           });
           throw ( error );
         }
-
-      // ends if error.response
-      } else {
+      } else { // for if error.response
 
         // If it's a timeout error, server is busy. Try again after waiting.
         // Why are we using `max_tries` for timeout error as well?
-        if ( is_timeout_error( error ) && num_tries < max_tries ) {
+        if ( is_timeout_error( error ) && name_incrementor < max_tries ) {
           log.info({ pre: `The docassemble server was busy when we tried to `
-            + `create the Project. Attempt ${ num_tries } of `
+            + `create the Project. Attempt ${ name_incrementor } of `
             + `${ max_tries }. Will try again in ${ wait_seconds } seconds.` });
-          num_tries--;  // Try this name again next time
+          name_incrementor--;  // Try this name again next time
           await time.waitForTimeout( wait_seconds * 1000 );
           continue;
 
@@ -272,8 +270,6 @@ da_i.loop_to_create_project = async function( creation_options ) {
         }  // ends type of non-response error
       }  // ends type of response error
     }  // ends try
-
-    // TODO: Add a message that we're done trying to create a project, successful or not
   }  // ends while
 };  // Ends da_i.loop_to_create_project()
 
@@ -437,12 +433,9 @@ da_i.delete_project = async function ( delete_options ) {
   log.info({ pre: `Trying to delete Project ${ project_name }` });
 
   try {
-
     let response = await _da_REST.delete_project( timeout );
     log.info({ pre: `Deleted Project "${ project_name }"` });
-
   } catch ( error ) {
-    // 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.` });
     throw error;

package/lib/docassemble/setup.js

@@ -20,7 +20,17 @@ const setup = async () => {
 
   // Create a project on the da server's account with a unique name then
   // store it locally for later deleting the project. 
-  let project_name = await da_i.loop_to_create_project();
+  let project_name = null;
+  // Explicit try-catch prevents "Unhandled promise rejection error"
+  // avoids showing confusing node errors to users that they shouldn't have to fix
+  try {
+    project_name = await da_i.loop_to_create_project();
+  } catch (error) {
+    log.error({type: `setup`, pre: `an unexpected error occurred while trying to create a docassemble project in the user's account`, 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;
+    return;
+  }
   // Once the name is created, save that name to a local file.
   session_vars.save_project_name( project_name );
 

package/lib/docassemble/takedown.js

@@ -10,9 +10,17 @@ const takedown = async () => {
   *   Project created for this test.
   *   For local development, clean up project name file. */
   log.info({ type: `takedown`, pre: `Trying to remove the docassemble Project from the testing account.` });
-  await da_i.delete_project();
-  session_vars.delete_project_name();
-  log.info({ type: `takedown`, pre: `Success! Test takedown has finished successfully.` });
+  // 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({ type: `takedown`, pre: `Success! Test takedown has finished successfully.` });
+  } catch (error) {
+    log.error({type: `takedown`, 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;
+  }
 };
 
 takedown();

package/lib/scope.js

@@ -2002,13 +2002,6 @@ module.exports = {
           if ( row_used.source ) { row_used.source.times_used += 1 }
           row_used.times_used += 1;
 
-          let { id } = scope.examinePageID( scope );
-          await scope.page.screenshot({
-            path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-            type: 'jpeg',
-            fullPage: true
-          });
-
           // TODO: special continue/navigation button function that handles url and all?
           
           // Have to catch errors right now or may get stuck in an infinite loop?
@@ -2022,7 +2015,6 @@ module.exports = {
           // Discuss moving this out of here. Having to pass in `id` just for
           // these messages smells bad. Con: Already a lot of code out there.
           error = await scope.waitUntilContinued( scope, { url: page_url, id });
-
           // if ( error.was_found ) {
           //   await scope.throwPageError( scope, { id: id });
           // }
@@ -2061,14 +2053,6 @@ module.exports = {
     if ( !did_navigate && ensure_navigation  ) {
       // All fields on this page should be taken care of
       let page_url = await scope.page.url();
-
-      let { id } = scope.examinePageID( scope );
-      await scope.page.screenshot({
-        path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-        type: 'jpeg',
-        fullPage: true
-      });
-
       await scope.continue( scope );
       // Have to catch errors right now or may get stuck in an infinite loop?
       // TODO: Don't catch errors - maybe the developer expected/wanted an error

package/lib/steps.js

@@ -386,12 +386,6 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
     if( row1.report_str > row2.report_str ) { return 1; }
     return 0;
   });
-  
-  await scope.page.screenshot({
-    path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-    type: 'jpeg',
-    fullPage: true
-  });
 
   // Add full used table to report so it can be copied if needed.
   // TODO: Should we/How do we get this in the final scenario report instead of here?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.10.4-feat-debug-cache",
+  "version": "4.11.0",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {