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

package/CHANGELOG.md

@@ -38,12 +38,19 @@ Format:
 ### Security
 - 
 -->
+
 ## [Unreleased]
-## Added
-- Contribution docs.
+### 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.10.4] - 2023-02-15
+### Added
+- Contribution docs
+
+### Fixed
+- #511, couldn't take screenshots of signature pages https://github.com/SuffolkLITLab/ALKiln/issues/511
+
 ## [4.10.3] - 2023-01-11
 ### Removed
 - Internal - ignore local test output files. Part 2 of the process out of 2.

package/lib/scope.js

@@ -2295,6 +2295,23 @@ module.exports = {
     return scope;
   },  // Ends scope.throwPageError()
 
+  take_a_screenshot: async ( scope,{ path }) => {
+    /* Takes a jpeg screenshot. Avoids destroying signatures. */
+
+    let fullPage = true;
+    let signature_elem = await scope.page.$(scope.signature_selector);
+    if ( signature_elem !== null ) {
+      fullPage = false;
+    }
+
+    await scope.page.screenshot({
+      path: path,
+      type: 'jpeg',
+      fullPage: fullPage,
+    });
+
+  },  // Ends scope.take_a_screenshot()
+
 
   //#####################################
   //#####################################
@@ -2317,11 +2334,7 @@ module.exports = {
         name = `screenshot_on-${ id }-${ date }`;
       }
 
-      await scope.page.screenshot({
-        path: `./${ scope.paths.scenario }/${ name }.jpg`,
-        type: 'jpeg',
-        fullPage: true
-      });
+      await scope.take_a_screenshot( scope, { path: `./${ scope.paths.scenario }/${ name }.jpg` });
 
       await scope.afterStep( scope );
     },  // Ends scope.steps.screenshot()

package/lib/steps.js

@@ -852,11 +852,8 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
           let buttons = await scope.steps.set_random_page_vars( scope );
 
           // Take a screenshot of the page before continuing or ending
-          await scope.page.screenshot({
-            path: `${ scope.paths.random_screenshots }/random-${ Date.now() }.jpg`,
-            type: `jpeg`,
-            fullPage: true
-          });
+          let path = `${ scope.paths.random_screenshots }/random-${ Date.now() }.jpg`;
+          await scope.take_a_screenshot( scope, { path: path });
 
           // Prep for the next loop to possibly stop. Signature page buttons
           // don't count as buttons in the way our field detects them
@@ -1125,27 +1122,23 @@ After(async function(scenario) {
       if ( !!scope.disable_error_screenshot ) {
         scope.addToReport(scope, {
           type: `row`,
-          value: `For security, ALKiln will not create a screenshot for this error. It's possible a secret is being used on this screen.`
+          value: `For security, ALKiln will avoid creating a screenshot for this error. It's possible a secret is being used on this screen.`
         });
       } else {
 
         // Save/download a picture of the screen that's showing during the unexpected status
         // Save one copy in the outer-most artifact folder
         let scenario_filename = await scope.getSafeScenarioFilename( scope, { prefix: `error_on` });
-        await scope.page.screenshot({
-          path: `${ scope.paths.artifacts }/${ scenario_filename }.jpg`,
-          type: `jpeg`,
-          fullPage: true
-        });
+        let path_outer = `${ scope.paths.artifacts }/${ scenario_filename }.jpg`;
+        await scope.take_a_screenshot( scope, { path: path_outer });
+
         // Save another copy in the artifact's Scenario folder
         let screenshot_name = `error_on`;
         let { id } = await scope.examinePageID( scope, 'none to match' );
         screenshot_name += `-${ id }`;
-        await scope.page.screenshot({
-          path: `${ scope.paths.scenario }/${ screenshot_name }.jpg`,
-          type: `jpeg`,
-          fullPage: true
-        });
+        let path_scenario = `${ scope.paths.scenario }/${ screenshot_name }.jpg`;
+        await scope.take_a_screenshot( scope, { path: path_scenario });
+
       }  // ends if scope.disable_error_screenshot
     }  // ends if scope.page exists
 

package/package.json

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