@suffolklitlab/alkiln 5.4.1 → 5.4.2

package/CHANGELOG.md

@@ -42,8 +42,14 @@ Format:
 ### Internal
 - 
 -->
+
 <!-- ## [Unreleased] -->
 
+## [5.4.2] - 2023-10-22
+
+### Changed
+- Downloads are now faster! You won't have to wait for the full duration of a step (30 seconds by default) to download a file anymore. See [this PR](https://github.com/SuffolkLITLab/ALKiln/pull/798) for more details.
+
 ## [5.4.1] - 2023-10-18
 
 ### Internal

package/lib/scope.js

@@ -2485,10 +2485,39 @@ module.exports = {
       if ( !elem ) { reports.addToReport(scope, { type: `error`, value: msg }); }
       expect( elem, msg ).to.exist;
 
-      scope.toDownload = filename;
-      // Should this be using `scope.tapElement()`?
-      await elem.evaluate( elem => { return elem.click(); });
-      await scope.detectDownloadComplete( scope );
+      let failed_to_download = false;
+      let err_msg = "";
+      try {
+        const binaryStr = await scope.page.evaluate(el => {
+          const url = el.getAttribute("href");
+          return new Promise(async (resolve, reject) => {
+            const response = await fetch(url, {method: "GET"});
+            const reader = new FileReader();
+            reader.readAsBinaryString(await response.blob());
+            reader.onload = () => resolve(reader.result);
+            reader.onerror = () => reject(`Error occurred on page when downloading ${ url }: ${ reader.error }`);
+          });
+        }, elem);
+        if (binaryStr !== '') {
+          const fileData = Buffer.from(binaryStr, 'binary');
+          fs.writeFileSync(`${ scope.paths.scenario }/${ filename }`, fileData);
+          reports.addToReport(scope, { type: `info`, value: `Downloaded ${ filename } (${ fileData.length } bytes) to ${ scope.paths.scenario }`});
+        } else {
+          failed_to_download = true;
+          err_msg = `Couldn't download ${ filename }, binary data for download was empty`;
+        }
+      } catch (error) {
+        failed_to_download = true;
+        err_msg = error;
+      }
+
+      if (failed_to_download) {
+        reports.addToReport(scope, { type: `warning`, value: `Could not download file using fetch (${ err_msg }). ALKiln will now fallback to the click download method` });
+        scope.toDownload = filename;
+        // Should this be using `scope.tapElement()`?
+        await elem.evaluate( elem => { return elem.click(); });
+        await scope.detectDownloadComplete( scope );
+      }
     },  // Ends scope.steps.download()
 
     compare_pdfs: async function (scope, {existing_pdf_path, new_pdf_path}) {

package/lib/steps.js

@@ -203,7 +203,6 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   scope.page.on('response', async response => {
     // Note: We can expect that only one file will be getting downloaded
     // 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}`) ) {

package/package.json

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