@suffolklitlab/alkiln 5.0.0-playground-2 → 5.0.0-pre-3

package/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+In this PR, I have:
+
+* [ ] Added tests for any new features or bug fixes (if relevant)
+* [ ] Added my changes to the CHANGELOG.md at the top, under the "Unreleased" section
+* [ ] Ensured issues that this PR closes will be [automatically closed](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
+
+### Reason for this PR
+
+<Insert reasons for this PR>
+
+### Links to any solved or related issues
+
+<Insert links>
+
+### Any manual testing I have done to ensure my PR is working
+
+<Insert description>

package/CHANGELOG.md

@@ -39,8 +39,8 @@ Format:
 - 
 -->
 ## [Unreleased]
-
 ### Added
+- added additional functionality to the sign method to allow developers to take a name argument to sign on canvas: issue #596
 - A new script: `alkiln-run`, which acts like `npm run cucumber`, but can
   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)
@@ -54,6 +54,10 @@ Format:
     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
+
+### Fixed
+- Projects created in da each have a unique name. https://github.com/SuffolkLITLab/ALKiln/issues/663
 
 ### Security
 - Pass docassemble API keys through HTTP headers instead of as parameters.

package/lib/docassemble/docassemble_api_interface.js

@@ -225,16 +225,17 @@ da_i.loop_to_create_project = async function( creation_options ) {
   let wait_seconds = creation_options.wait_seconds || 5;
 
   let project_name = null;
-  let name_incrementor = 0;
+  // Unlikely, but 2 devs could run locally and create the same Project name
+  let num_tries = 0;
 
   // Try to create a project. If the project name is already taken, increment and loop again.
-  while ( name_incrementor <= max_tries ) {
-    name_incrementor++;
+  while ( num_tries <= max_tries ) {
+    num_tries++;
     try {
 
       // 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, '') + name_incrementor;
+      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
       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 }` });
@@ -247,7 +248,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
       if ( response && response.data ) {
         if ( response.data.includes( `Invalid project` ) ) {
-          if ( name_incrementor < max_tries ) {
+          if ( num_tries < max_tries ) {
             // A non-unique project name. Try the next project name.
             continue;
 
@@ -275,11 +276,11 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
         // 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 ) && name_incrementor < max_tries ) {
+        if ( is_timeout_error( error ) && num_tries < max_tries ) {
           log.info({ pre: `The docassemble server was busy when we tried to `
-            + `create the Project. Attempt ${ name_incrementor } of `
+            + `create the Project. Attempt ${ num_tries } of `
             + `${ max_tries }. Will try again in ${ wait_seconds } seconds.` });
-          name_incrementor--;  // Try this name again next time
+          num_tries--;  // Don't count this try
           await time.waitForTimeout( wait_seconds * 1000 );
           continue;
 

package/lib/docassemble/setup.js

@@ -25,6 +25,7 @@ const setup = async () => {
   // avoids showing confusing node errors to users that they shouldn't have to fix
   try {
     project_name = await da_i.loop_to_create_project();
+    log.info({type: `setup`, pre: `Created a Project named ${ project_name }`});
   } 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

package/lib/scope.js

@@ -1871,16 +1871,26 @@ module.exports = {
     }, 500)
   },
 
-  draw_signature: async function ( scope ) {
+  draw_signature: async function ( scope, name ) {
     /* On a signature page, there should only be a single signature canvas
     * and a continue button. Draw in the #dasigcanvas element. `<canvas>`
     * takes a while to load. */
-    let handle = await scope.page.waitForSelector( `#dasigcanvas` );
+    let canvas = await scope.page.waitForSelector( `#dasigcanvas` );
     let msg = `Could not find a signature field.`;
-    if ( !handle ) { await scope.addToReport(scope, { type: `error`, value: msg }); }
-    expect( handle, msg ).to.exist;
-
-    let bounding_box = await handle.boundingBox();
+    if ( !canvas ) { await scope.addToReport(scope, { type: `error`, value: msg }); }
+    expect( canvas, msg ).to.exist;
+
+    // Provides functionality to draw name arg on canvas
+    if (name !== undefined) {
+      await scope.page.$eval(`#dasigcanvas`, (canvas, name) => {
+        const ctx = canvas.getContext("2d");
+        ctx.font = "24px serif";
+        ctx.fillText(name, 10, 50);
+      }, name);
+    }
+    let bounding_box = await canvas.boundingBox();
+    // We draw the dot because it allows the developer to tap continue
+    // Docassemble does not allow to tap continue unless the user interacts with the canvas
     await scope.page.mouse.move(bounding_box.x + bounding_box.width / 2, bounding_box.y + bounding_box.height / 2);
     await scope.page.mouse.down();
     // await scope.page.mouse.move(1, 1);  // Too big? Wait a while before drawing?
@@ -2405,9 +2415,9 @@ module.exports = {
       await scope.afterStep(scope, {waitForShowIf: true});
     },  // Ends scope.steps.tap_term()
 
-    sign: async ( scope ) => {
+    sign: async ( scope, name ) => {
       /** Sign on a signature page. */
-      await scope.draw_signature( scope );
+      await scope.draw_signature( scope, name );
       await scope.afterStep(scope);
     },  // Ends scope.steps.sign()
 

package/lib/steps.js

@@ -979,13 +979,21 @@ When('I tap the defined text link {string}', { timeout: -1 }, async ( phrase ) =
   await scope.steps.tap_term( scope, phrase );
 });
 
-Then('I sign', { timeout: -1 }, async () => {
+Then(/^I sign$/, { timeout: -1 }, async () => {
   return wrapPromiseWithTimeout(
     scope.steps.sign( scope ),
     scope.timeout
   );
 });
 
+Then('I sign with the name {string}', { timeout: -1 }, async ( name ) => {
+  /* Signs with the string argument */
+  return wrapPromiseWithTimeout(
+    scope.steps.sign( scope, name ),
+    scope.timeout
+  );
+});
+
 When(/I download "([^"]+)"$/, { timeout: -1 }, async ( filename ) => {
   /* Taps the link that leads to the given filename to trigger downloading.
   *    and waits till the file has been downloaded before allowing the tests to continue.

package/lib/utils/session_vars.js

@@ -93,7 +93,7 @@ session_vars.get_package_name = function () {
 };
 
 session_vars.get_project_base_name = function () {
-  let name = `testing${ session_vars.get_package_name() }${ session_vars.get_branch_name() }`;
+  let name = `ALKilnTest${ session_vars.get_package_name() }${ session_vars.get_branch_name() }`;
   let sanitized_name = name.replace( /[^A-Za-z0-9]/g, '' );
   return sanitized_name;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.0.0-playground-2",
+  "version": "5.0.0-pre-3",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {