@suffolklitlab/alkiln 5.2.0 → 5.2.1

package/CHANGELOG.md

@@ -44,7 +44,20 @@ Format:
 -->
 <!-- ## [Unreleased] -->
 
+## [5.2.1] - 2023-09-29
+
+### Added
+- New warning message to the developer when their date string doesn't have a `/` in it.
+
+### Changed
+- Told the user the url of the interview ALKiln tried to load. See https://github.com/SuffolkLITLab/ALKiln/issues/696.
+
+### Fixed
+- Restored Assembly Line custom datatype three-parts dates functionality. See https://github.com/SuffolkLITLab/ALKiln/issues/764.
+- Fixed "today" not being converted into a date for custom datatypes.
+
 ## [5.2.0] - 2023-09-16
+
 ### Changed
 - Make `I tap to continue` case insensitive to allow the author to match the capitalization of the button in Docassemble.
 

package/lib/scope.js

@@ -616,22 +616,22 @@ module.exports = {
     * https://github.com/puppeteer/puppeteer/issues/299 and
     */
 
+    // If file has finished downloading
+    if ( scope.downloadComplete ) {
+      // reset the flag and resolve
+      scope.downloadComplete = false;
+      return true;
+    }
+
     // Stop/resolve if too much time has passed
     let expirationTime = scope.timeout - 200;  // ms
     if ( !endTime ) { endTime = new Date((new Date()).getTime() + expirationTime); }
     let diff = endTime.getTime() - Date.now();
     if ( diff <= 0 ) { return false; }
 
-    // If time hasn't expired
-    if ( scope.downloadComplete ) {
-      // If download is complete, reset the flag and resolve
-      scope.downloadComplete = false;
-      return true;
-    } else {
-      // Otherwise wait and then check again
-      await scope.page.waitForTimeout( 100 );
-      await scope.detectDownloadComplete(scope, endTime);
-    }
+    // If time hasn't expired, wait and then check again
+    await scope.page.waitForTimeout( 100 );
+    await scope.detectDownloadComplete(scope, endTime);
 
     return false;
   },
@@ -732,11 +732,6 @@ module.exports = {
     /* Try to load the page. Should we also pass a `timeout` arg or just
     *    use scope.timeout? */
 
-    await scope.addToReport(scope,{
-      type: `row`,
-      value: `Trying to load the interview`
-    });
-
     let interview_url = null;
     // If the file is already a full url, just use that arbitrary url
     if ( /^http/.test( file_name ) ) {
@@ -752,7 +747,11 @@ module.exports = {
       let base_url = await get_base_interview_url();
       interview_url = `${ base_url }${ file_name }`;
     }
-    if ( session_vars.get_debug() ) { console.log( `interview_url:`, interview_url ); }
+
+    await scope.addToReport(scope,{
+      type: `row`,
+      value: `Trying to load the interview at "${interview_url}"`
+    });
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
 
@@ -1477,11 +1476,6 @@ module.exports = {
    */
     let row_used = null;
 
-    // Skip hidden fields right away. When a date field was above a combobox,
-    // interacting with the hidden field caused the date field to open its
-    // calendar which blocked input to the combobox
-    if ( field.type === `hidden` ) { return row_used; }
-
     let matching_input_rows = await scope.getMatchingRows( scope, { var_data, field });
 
     // Nothing to set if there are no matching table rows
@@ -1597,8 +1591,16 @@ module.exports = {
       row_was_used = await scope.setCustomDatatype[ custom_datatype ]( scope, { handle: custom_handle, answer });
     } else {
       // If no custom datatype, set a regular field
-      row_was_used = await scope.enter_answer[ field.tag ]( scope, { handle, answer });
-    }
+
+      // Skip hidden fields. When a `show if` date field is above a combobox,
+      // interacting with the hidden field causes the date field to open its
+      // calendar which blocks input to the combobox
+      if ( field.type === `hidden` ) {
+        row_was_used = false;
+      } else {
+        row_was_used = await scope.enter_answer[ field.tag ]( scope, { handle, answer });
+      }
+    }  // ends if custom datatype
 
     return row_was_used;
   },  // Ends scope.funnel_the_answer()
@@ -1614,8 +1616,12 @@ module.exports = {
 
       // If it doesn't have the right format
       if ( answer === null || !answer.includes(`/`) ) {
-        // Do nothing
-        return;
+        // Return field unused.
+        await scope.addToReport( scope, {
+          type: `warning`,
+          value: `Invalid date. Value given: "${ answer }".`
+        });
+        return false;
       }
 
       let date_parts = answer.split(`/`);
@@ -1636,18 +1642,20 @@ module.exports = {
             handle: field,
             answer: date_parts[ field_i ]
           });
+          await handle.press(`Tab`);
         }
 
       }  // For each field
 
       await scope.afterStep( scope );
+      return true;
     },  // Ends scope.setCustomDatatype.al_date()
 
     BirthDate: async function ( scope, { handle, answer }) {
       /** Given a date of the format 'mm/dd/yyyy' and the handle of the
       * custom field container, sets the ALToolbox custom birthdate
       * field values. */
-
+      answer = await scope.today_to_date(scope, { date: answer });
       await scope.setCustomDatatype.al_date( scope, { handle, answer })
     },  // Ends scope.setCustomDatatype.BirthDate()
 
@@ -1655,6 +1663,7 @@ module.exports = {
       /** Given a date of the format 'mm/dd/yyyy' and the handle of the
       * custom field container, sets the ALToolbox custom ThreePartsDate
       * field values. */
+      answer = await scope.today_to_date(scope, { date: answer });
       await scope.setCustomDatatype.al_date( scope, { handle, answer })
     },  // Ends scope.setCustomDatatype.ThreePartsDate()
 
@@ -1729,36 +1738,20 @@ module.exports = {
         await scope.afterStep(scope, { waitForShowIf: true });
 
       } else if (type == `date`) {
-        let answer_date = answer;
-        // If the date is specified in the format "today" or "today + 2" or "today-1"
-        // it will need some pre-processing. 
-        if (answer.indexOf(`today`) !== -1) {
-          // Find out how many days to add/subtract
-          let date_delta = answer.replace(/\s/g, '');
-          date_delta = date_delta.match(/today([+-]\d+)?/)[1];
-          date_delta = date_delta == undefined ? 0 : date_delta;
-          date_delta = parseInt(date_delta);
-          // Get today's date
-          answer_date = new Date(); 
-          // Add/subtract required number of days
-          answer_date.setDate(answer_date.getDate() + date_delta);
-          // Convert to the docassemble date field format: mm/dd/yyyy
-          // Reference: https://gomakethings.com/setting-a-date-input-to-todays-date-with-vanilla-js/
-          answer_date = ((answer_date.getMonth() + 1).toString().padStart(2, 0) + '/' + 
-                         answer_date.getDate().toString().padStart(2, 0) + '/' +
-                         answer_date.getFullYear().toString());
-        }
+        let answer_date = await scope.today_to_date(scope, { date: answer });
         await scope.setText( scope, { handle, answer: answer_date });
+        await handle.press(`Tab`);
         await scope.afterStep(scope, { waitForShowIf: true });
       } else if (type == `time`) {
         // Authors should enter the time like 12:34 PM, but we shouldn't type ":", space, or M.
         let answer_time = answer.replace(":", "").replace(" ", "").replace("M", "");
         await handle.focus();
         await handle.type( answer );
-        await handle.press("Enter");
+        await handle.press(`Enter`);
         await scope.afterStep(scope, { waitForShowIf: true });
       } else {
         await scope.setText( scope, { handle, answer });
+        await handle.press(`Tab`);
         await scope.afterStep(scope, { waitForShowIf: true });
       }
 
@@ -1774,7 +1767,50 @@ module.exports = {
       return;
     },
 
-  },  // ends scope.enter_answer
+  },  // ends scope.enter_answer()
+
+  today_to_date: async function ( scope, { date }) {
+    /** Return `date` or, if the date is specified in the format
+    *   "today" or "today + 2" or "today-1", return a date of the format
+    *   "mm/dd/yyyy".
+    * 
+    * @param scope { obj } REQUIRED. Object with test state.
+    * @param date { str } REQUIRED. Input from the developer.
+    * 
+    * @returns { str } `date` or "today" math as date str
+    * 
+    * WARNING: If the developer is counting on date boundaries to trigger
+    *   other logic then timezone differences may interfere with that. They
+    *   should:
+    * 
+    *   1. Test with a day well within the date range they're testing instead
+    *   of near a boundary. For example, test 8 days from now instead of 10.
+    *   This is because their test may run around 12am and thus be vulnerable
+    *   to failure.
+    *   2. Warn the user explicitly and let them know when they need to file by
+    *   in case the user doesn't know and files a few days from the day they filled
+    *   out the form.
+    */
+    let valid_date = date;
+    if (date.indexOf(`today`) !== -1) {
+      // Find out how many days to add/subtract
+      let date_delta = date.replace(/\s/g, '');
+      date_delta = date_delta.match(/today([+-]\d+)?/)[1];
+      date_delta = date_delta == undefined ? 0 : date_delta;
+      date_delta = parseInt(date_delta);
+      // Get today's date
+      valid_date = new Date(); 
+      // Add/subtract required number of days
+      valid_date.setDate(valid_date.getDate() + date_delta);
+      // Convert to the docassemble date field format: mm/dd/yyyy
+      // Reference: https://gomakethings.com/setting-a-date-input-to-todays-date-with-vanilla-js/
+      valid_date = ((valid_date.getMonth() + 1).toString().padStart(2, 0) + '/' + 
+                     valid_date.getDate().toString().padStart(2, 0) + '/' +
+                     valid_date.getFullYear().toString());
+    }
+
+    return valid_date;
+  },  // Ends scope.today_to_date()
 
   uploadFiles: async function ( scope, { handle, answer }) {
     /* Try to upload one or more files to a file-type input field.

package/lib/steps.js

@@ -203,6 +203,7 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
     // at any one time since each step completes synchronously
 
     // If response has a file in it that matches the file we are downloading
+    // Sadly, 'content-disposition' isn't working. We're not sure what will.
     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

package/package.json

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