@suffolklitlab/alkiln 5.11.2 → 5.12.0-delete2

package/lib/scope.js

@@ -627,7 +627,7 @@ module.exports = {
       interview_url = `${ base_url }${ file_name }`;
     }
 
-    reports.addToReport(scope,{
+    reports.addToReport(scope, {
       code: `ALK0113`,
       type: `row info`,
       value: `Trying to load the interview at "${ interview_url }"`
@@ -638,7 +638,17 @@ module.exports = {
     // TODO: implement and use scope.handle_possible_timeout()
     try {
 
-      await scope.page.goto(interview_url, { waitUntil: 'domcontentloaded', timeout: scope.timeout })
+      await scope.page.goto(interview_url, { waitUntil: 'domcontentloaded', timeout: scope.timeout });
+      // Get interview session values, if possible, so we can delete the session later
+      let interview_vars = await scope.page.evaluate(async function() {
+        try {
+          // won't exist on non-da interview pages
+          return await get_interview_variables();
+        } catch (error) {
+          return null;
+        }
+      });
+      scope.set_interview_session_data( scope, { vars: interview_vars });
 
     } catch ( error ) {
 
@@ -682,6 +692,36 @@ module.exports = {
     return scope.page;
   },  // Ends scope.load()
 
+  set_interview_session_data: function ( scope, { vars = null }) {
+    /** Sets this interview's session data for this scenario if it doesn't
+     *    already exist.
+     *
+     * @returns final_vars { object | null }
+     * @returns final_vars.i { str } File path of interview
+     * @returns final_vars.uid { str } UID of interview
+     * */
+    if ( vars && vars.i ) {
+      let scenario = scope.scenarios.get( scope.scenario_id );
+      if ( !scenario.interviews ) { scenario.interviews = {}; }
+      if ( !scenario.interviews[ vars.uid ] ) {
+        scenario.interviews[ vars.uid ] = vars;
+        log.debug({
+          code: `ALK0185`, type: `info`,
+          pre: `Saved new interview data. File path: ${ vars.i }. Session id: ${ vars.uid }.`
+        });
+      } else {
+        log.debug({
+          code: `ALK0186`, type: `info`,
+          pre: `Interview data already existed. File path: ${ vars.i }. Session id: ${ vars.uid }.`
+        });
+      }
+      return vars;
+    } else {
+      log.debug({ code: `ALK0187`, type: `info`, pre: `Found no interview data.` });
+      return null;
+    }
+  },  // Ends scope.set_interview_session_data()
+
   getLoadData: async function ( scope ) {
     /* Return elements that could load on the page, like #daMainQuestion
     * and #da-retry. If there's a system error on the page, return its main text.
@@ -771,7 +811,7 @@ module.exports = {
             if ( row_raw.length > 3 ) { more_or_less = `less`; }
             let bad_table_msg = `Your Story Table should have ${ more_or_less } than`
               + ` ${ row_raw.length } columns. Take another look at Story Table documentation at`
-              + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables.`
+              + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#story-table.`
             reports.addToReport( scope, { type: `error`, code: `ALK0120`, value: bad_table_msg})
             throw Error(bad_table_msg);
           }
@@ -798,7 +838,7 @@ module.exports = {
           let not_in_env_msg = `ALKiln could not find the GitHub secret "${ row.flags.secret_name }".`
             + ` Check for a typo and check your workflow file.`
             + ` Read more about using GitHub secrets in your workflow file at`
-            + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#github-secrets.`
+            + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#secrets.`
           reports.addToReport( scope, { type: `error`, code: `ALK0121`, value: not_in_env_msg });
           throw ReferenceError(not_in_env_msg);
         }
@@ -1317,6 +1357,7 @@ module.exports = {
     * setting fields, and an object for a DOM field, returns list of the
     * rows that match the DOM field. That list of story table rows may be empty.
     *
+    * Using a `trigger` column is deprecated, but still used in many tests in the wild.
     * For notes on trigger var, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger
     * 
     * @param var_data {arr} - fields and the values they can be set to
@@ -1411,9 +1452,13 @@ module.exports = {
 
       // field/page trigger name is needed but is missing.
       if ( !page_trigger_name ) {
-        let page_trigger_warning = `A field on this page uses an index `
-          + `variable or a generic object, but the page is missing `
-          + `the ALKiln "trigger" variable's name. See `
+        let page_trigger_warning = `You are using a 3-column Story Table. If possible, you should `
+          + `think about switching to the newer, easier, 2-column Story Table. That will probably `
+          + `get rid of this warning. Read more at `
+          + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/trouble#deprecated-story-tables. `
+          + `If you still want to use this 3-column format, here is more info about the warning: `
+          + `A field on this page uses an index variable or a generic object in a 3-column `
+          + `Story Table, but the page is missing the ALKiln "trigger" variable's name. See `
           + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#a-missing-trigger-variable.`;
         reports.addToReport(scope, { type: `warning`, code: `ALK0127`, value: page_trigger_warning });
       }
@@ -1430,7 +1475,7 @@ module.exports = {
 
           // First, make the row data more readable to humans.
           let row_as_story_table = reports.convertToOriginalStoryTableRow( scope, { row_data: row_that_matches_this_field });
-          let row_trigger_warning = `This Story Table row needs a value in the "trigger" `
+          let row_trigger_warning = `This 3-column Story Table row needs a value in the "trigger" `
             + `column, but it is empty. The test might get unexpected results. See `
             + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
             + `\nThe rows:\n${ row_as_story_table }`;
@@ -1467,7 +1512,7 @@ module.exports = {
 
         let all_trigger_names_conflict_msg = `${ rows_that_match_field_names.length } `
           + `Story Table row(s) matched a field name, but didn't match a trigger `
-          + `variable. The Story Table might be missng a row or a trigger variable. `
+          + `variable. This 3-column Story Table might be missing a row or a trigger variable. `
           + `The test will have to ignore this field. See `
           + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
           + `\nThe row(s) data:\n${ conflicts_as_story_table_rows.join( `\n` )}`
@@ -2893,7 +2938,9 @@ module.exports = {
       await scope.afterStep(scope, {waitForShowIf: true});
     },  // Ends scope.steps.set_al_address()
 
-    sign_in: async function ( scope, { email_secret_name, password_secret_name }) {
+    sign_in: async function ( scope, {
+      email_secret_name, password_secret_name, api_key_secret_name
+    }) {
       /** Allow the developer to log a user into their server using GitHub
       * secrets to authenticate.
       */
@@ -2946,6 +2993,16 @@ module.exports = {
       if ( password === undefined ) {
         reports.addToReport( scope, { type: `error`, code: `ALK0162`, value: password_msg })
       }
+      // Save API key to clean up interviews later. Nice to have, not critical
+      if ( api_key_secret_name ) {
+        let api_key = process.env[ api_key_secret_name ];
+        let api_key_msg = `The api_key GitHub SECRET "${ api_key_secret_name }" doesn't exist. Check for a typo and check your workflow file.`
+        if ( api_key === undefined ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0199`, value: api_key_msg });
+        } else {
+          scope.scenarios.get( scope.scenario_id ).api_keys.push( api_key );
+        }
+      }
 
       expect( email, email_msg ).to.not.equal( undefined );
       expect( password, password_msg ).to.not.equal( undefined );
@@ -3228,8 +3285,7 @@ module.exports = {
     * 
     * @param expected {array} Arr of strs that should appear in the report.
     */
-    let current_report_obj = scope.report.get( scope.scenario_id );
-    let scenario = [ scope.scenario_id, current_report_obj ];  // Mimic how loop works with `Map`
+    let scenario = scope.report.get( scope.scenario_id );
     let report = reports.getPrintableScenario( scenario );
     let all_are_included = true;
     for ( let one_expectation of expected ) {
@@ -3248,8 +3304,7 @@ module.exports = {
     * 
     * @param not_expected {array} Arr of strs that should not appear in the report.
     */
-    let current_report_obj = scope.report.get( scope.scenario_id );
-    let scenario = [ scope.scenario_id, current_report_obj ];  // Mimic how loop works with `Map`
+    let scenario = scope.report.get( scope.scenario_id );
     let report = reports.getPrintableScenario( scenario );
     let none_included = true;
     for ( let one_expectation of not_expected ) {
@@ -3262,4 +3317,6 @@ module.exports = {
     return none_included;
   },
 
+  // Test that all interviews have been deleted
+
 };

package/lib/steps.js

@@ -22,6 +22,7 @@ const log = require('./utils/log');
 const session_vars = require('./utils/session_vars');
 const files = require('./utils/files' );
 const reports = require(`./utils/reports`);
+const da_api = require('./docassemble/docassemble_api_interface');
 
 /* Of Note:
 - We're using `*=` for selectors because sometimes da text has funny characters in it that are hard to anticipate
@@ -83,6 +84,9 @@ let click_with = {
 
 BeforeAll(async () => {
   scope.showif_timeout = 600;
+  // TODO: Do these really need to be maps? As sets, they may make the output
+  // more predictable to the user, but they add complexity.
+  scope.scenarios = new Map();
   scope.report = new Map();
 
   // Start tracking whether server is up and running
@@ -93,7 +97,7 @@ BeforeAll(async () => {
 
   // TODO: figure out how to test file and folder creation stuff,
   // especially when setup is excluded from the flow.
-  
+
   // Make the folder to store all the files for this run of the tests
   scope.paths.artifacts = files.make_artifacts_folder();
   // Save its name in a file. `session_vars` can get it back later.
@@ -101,8 +105,11 @@ BeforeAll(async () => {
   session_vars.save_artifacts_path_name( scope.paths.artifacts );
 
   scope.paths.report = `${ scope.paths.artifacts }/report.txt`;
+  scope.paths.failures = `${ scope.paths.artifacts }/${ log.unexpected_filename }`;
   scope.paths.debug_log = `${ scope.paths.artifacts }/${ log.debug_log_file }`;
   fs.writeFileSync( scope.paths.debug_log, "" );
+
+  reports.create( scope );
 });
 
 Before(async (scenario) => {
@@ -124,13 +131,16 @@ Before(async (scenario) => {
     }
   }
   // Clean up all previously existing pages
-  for (const page of await scope.browser.pages()) { 
+  for (const page of await scope.browser.pages()) {
     await page.close();
   }
   // Make a new page
   scope.page = await scope.browser.newPage()
 
   scope.scenario_id = uuidv4();
+  scope.scenarios.set( scope.scenario_id, {} );
+  scope.scenarios.get( scope.scenario_id ).interviews = {};
+  scope.scenarios.get( scope.scenario_id ).api_keys = [ session_vars.get_dev_api_key() ];
   scope.expected_status = null;
   scope.expected_in_report = null;
   scope.expected_not_in_report = null;
@@ -176,7 +186,7 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
 
   // Load the right interview page
   await scope.load( scope, file_name );
-  
+
   // The page timeout is set in here too in case someone set a custom timeout
   // just before a page was loaded for the Scenario. Move this to just after page creation?
   // The function itself won't really timeout here, so we don't need to wrap it in
@@ -271,7 +281,10 @@ Given(/I go to "([^"]+)"/i, {timeout: -1}, async ( url ) => {
   return result;
 });
 
-Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)" and(?: the password)? "([^"]+)"(?: SECRETs)?/i, {timeout: -1}, async ( email, password ) => {
+Given(
+  /I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)",?(?: and)?(?: the password)? "([^"]+)"(?: SECRETs)?(?:,?(?: and)?(?: the API key)? "([^"]+)")?/i,
+  { timeout: -1 },
+  async ( email, password, api_key ) => {
   /** Uses the names of environment variables (most often GitHub SECRETs) to
   *     log into an account on the user's server. Must be SECRETs to stay secure.
   * 
@@ -279,13 +292,16 @@ Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^
   * I sign into the server with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
   * I sign on with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
   * I log in with "USER1_EMAIL" and "USER1_PASSWORD"
+  * I sign in with the email "USER1_EMAIL", the password "USER1_PASSWORD", and the API key "USER1_API_KEY"
+  * I sign in with "USER1_EMAIL", "USER1_PASSWORD", "USER1_API_KEY"
   */
   // `page` timeout will deal with custom timeout
   // Couldn't test the timeout for tapping the button because there's not
   // enough of a pause between initial navigation and pressing button.
   await scope.steps.sign_in( scope, {
     email_secret_name: email,
-    password_secret_name: password
+    password_secret_name: password,
+    api_key_secret_name: api_key
   });
 });
 
@@ -310,7 +326,7 @@ Given(/the max(?:imum)? sec(?:ond)?s for each step (?:in this scenario )?is (\d+
   /* At any time, set a custom timeout for the scenario. */
   // TODO: Add 1 second to this to allow other steps to not fail, like "I wait n seconds"
   scope.timeout = parseInt( seconds ) * 1000;
-  
+
   // Cucumber timeouts are made custom for each step that needs it
 
   // If there is no page yet, we've ensured custom timeout will still be set
@@ -650,7 +666,7 @@ Then('I should see the link to {string}', async ( url ) => {  // √
   let msg = `Cannot find a link to "${ url }".`;
   if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0080`, value: msg }); }
   expect(link, msg ).to.exist;
-  
+
   await scope.afterStep(scope);
 });
 
@@ -659,7 +675,7 @@ Then(/the "([^"]+)" link leads to "([^"]+)"/, async (linkText, expected_url) =>
   let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
   // TODO: Possibly add a check here for the link text, though note this
   // Step is not currently supported.
-  
+
   let prop_obj = await link.getProperty('href');
   let actual_url = await prop_obj.jsonValue();
 
@@ -753,7 +769,7 @@ Then(/I expect the baseline PDF "([^"]+)" and the new PDF "([^"]+)" to be the sa
   * Variations:
   * Then I expect the baseline PDF "simple-doc-Baseline.pdf" and the new PDF "simple-doc.pdf" to be the same
   */
-  
+
   return await wrapPromiseWithTimeout(
     scope.steps.compare_pdfs(scope, {existing_pdf_path, new_pdf_path}),
     scope.timeout
@@ -877,7 +893,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
 
       // Set up timeout to stop infinite loops
       let page_timeout_id = setTimeout(async function() {
-        
+
         // Make sure to only throw once
         if ( has_thrown ) { return; }
         else { has_thrown = true; }
@@ -1175,6 +1191,72 @@ Given(/the final Scenario status should be "([^"]+)"/i, async ( expected_status
   scope.expected_status = expected_status.toUpperCase();
 });
 
+Then(/of two interviews, I delete one __internal__/i, async () => {
+  /** Test that an interview does get successfully deleted. This tests whether
+   *    the API code is working correctly.
+   */
+  // Make sure we have two interviews in `scope.scenario.interviews` (two session ids)
+  let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+  let interview_keys = Object.keys( interviews );
+  expect(
+    interview_keys.length,
+    `Of 2 interview sessions, ALKiln only saved ${ interview_keys.length }`
+  ).to.equal( 2 );
+
+  // Check that both interviews exist on the server. 1 √ 2 √
+  let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+  let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let existing_keys = Object.keys( existing_interviews );
+  expect(
+    existing_keys.length,
+    `2 interviews should be on the server. Instead: "${ existing_keys.join(', ') }"`
+  ).to.equal( 2 );
+
+  // Delete one. 1 x 2 √
+  let to_delete = interviews[ interview_keys[ 0 ]];
+  await da_api.quietly_try_to_delete_interviews({
+    interviews: { [interview_keys[ 0 ]]: to_delete },
+    api_keys
+  });
+
+  // Check that only one session exists on the server. This tests that
+  // 1. An interview has been deleted and
+  // 2. We are fetching interviews correctly because we are getting one
+  // back (e.g. not passing null into the api function)
+  // 1 x 2 √
+  let after_deletion = await da_api.get_interviews({ interviews, api_keys });
+  let keys_after_deletion = Object.keys( after_deletion );
+  expect(
+    keys_after_deletion.length,
+    `1 interviews should be on the server: ${ keys_after_deletion.join(', ') }`
+  ).to.equal( 1 )
+  // In After(), the other session should get deleted
+});
+
+Then(/as an anonymous user, I fail to delete an interview and get no error __internal__/i, async () => {
+  /** Test that an interview passes even when unable to delete an interview.
+   *    An API test
+   */
+  // Make sure we started an interview
+  let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+  expect(
+    Object.keys( interviews ).length,
+    `The test should have saved one interview session`
+  ).to.equal( 1 );
+
+  // There should be no error about an unauthorized user
+  let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+  let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let existing_keys = Object.keys( existing_interviews );
+  expect(
+    existing_keys.length,
+    `Anonymous user should detect 0 interviews on the server. Instead: "${ existing_keys.join(', ') }"`
+  ).to.equal( 0 );
+
+  // Deleting with an anonymous user should fail silently
+  await da_api.quietly_try_to_delete_interviews({ interviews, api_keys });
+});
+
 
 //#####################################
 //#####################################
@@ -1202,17 +1284,17 @@ After(async function(scenario) {
   }
 
   if ( scope.failed_pdf_compares.length > 0) {
-    let msg = scope.failed_pdf_compares.reduce((str, new_msg) => `${ str }\n---\n${ new_msg }`)
+    let msg = scope.failed_pdf_compares.reduce((str, new_msg) => `${ str }\n―――\n${ new_msg }`)
     changeable_test_status = `FAILED`;
     reports.addToReport(scope, {
       type: `error`,
       code: `ALK0093`,
-      value: `PDF comparison failed ${ scope.failed_pdf_compares.length } time(s)\n---\n${ msg }\n---\n`
+      value: `PDF comparison failed ${ scope.failed_pdf_compares.length } time(s)\n―――\n${ msg }\n―――\n`
     });
   }
 
   // Record status before internal report tests can interfere with values
-  reports.setReportScenarioStatus( scope, { status: changeable_test_status });
+  reports.saveFinalScenarioData( scope, { status: changeable_test_status });
 
   if (changeable_test_status !== `PASSED`) {
     log.debug({
@@ -1256,11 +1338,11 @@ After(async function(scenario) {
   }  // ends if not passed
 
   // Add report text to Scenario folder after everything has been added to the report
-  let current_report_obj = scope.report.get( scope.scenario_id );
-  let scenario_report_obj = [ scope.scenario_id, current_report_obj ];  // Mimic how loop works with `Map`
+  let scenario_report_obj = scope.report.get( scope.scenario_id );
   let report = reports.getPrintableScenario( scenario_report_obj );
   // Save the report as in the Scenario folder
   fs.writeFileSync( scope.paths.scenario_report, report );
+  // TODO: Save any cucumber failure message for the Scenario here (instead of waiting till run_cucumber.js)
 
   // ---------------- Check internal test results ----------------
 
@@ -1273,7 +1355,7 @@ After(async function(scenario) {
     // Reset report values no matter what so they don't mess up future scenarios
     scope.expected_in_report = null;
   }
-  
+
   if (scope.expected_not_in_report && scope.expected_not_in_report.length > 0) {
     let all_prohibited_strings_were_absent = await scope.reportDoesNotInclude(
       scope,
@@ -1311,8 +1393,8 @@ After(async function(scenario) {
       // it as failed too.
       expected_status_was_met = false;
       // Keep it general. Users may see this message, e.g. for a11y tests.
-      let msg = `Test failed. Expected status: ${scope.expected_status}. `
-          + `ALKiln's assessed status: ${ changeable_test_status }. `
+      let msg = `Test ${ changeable_test_status }. `
+          + `Expected status: ${scope.expected_status}. `
           + `See the report for details.`;
       let code = `ALK0099`;
       log.debug({ type: `error`, code: code, pre: msg, })
@@ -1354,7 +1436,7 @@ After(async function(scenario) {
     // Catch a possible reload error.
     try {
       // puppeteer will ensure proper timeout.
-      await scope.page.goto(`${ session_vars.get_da_server_url() }/user/sign-out`, {waitUntil: `domcontentloaded`});  
+      await scope.page.goto(`${ session_vars.get_da_server_url() }/user/sign-out`, {waitUntil: `domcontentloaded`});
 
     } catch ( error ) {
       signout_succeeded = false;
@@ -1369,7 +1451,7 @@ After(async function(scenario) {
             code: code,
             message: non_reload_report_msg,
           }, error });
-        } catch {
+        } catch ( error ) {
           signout_error_msg = `🤕 ${ code } ERROR: ${ non_reload_report_msg }`;
         }
       } else {
@@ -1384,10 +1466,42 @@ After(async function(scenario) {
 
   }  // ends if scope.page
 
+  // Now that we're no longer on the interview page, one way or
+  // another, try to delete the interviews created during the test
+  // Authors running this manually get to choose what to do with
+  // the interviews they're creating unless we hear otherwise.
+  if ( session_vars.get_origin() !== `playground` ) {
+    try {
+      let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+      let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+      await da_api.quietly_try_to_delete_interviews({ interviews, api_keys });
+      let existing_interviews = await da_api.get_interviews({ interviews, api_keys });
+      let existing_keys = Object.keys( existing_interviews );
+      // Deleting interviews is nice, but not non-critical. Don't bother the
+      // user with it. Don't want to cover up a more meaningful failure (like
+      // going to the wrong file). If it becomes a problem we can track it down later.
+      if ( existing_keys.length > 0 ) {
+        log.debug({ type: `internal warning`, code: `ALK0197`,
+          pre: `${ existing_keys.length } interviews were not deleted: ${ existing_keys.join( ', ' ) }`
+        });
+      }
+    } catch ( error ) {
+      // Deleting interviews is nice, but not non-critical. Don't bother the
+      // user with it. Don't want to cover up a more meaningful failure (like
+      // going to the wrong file). Example of OK failure: the user owns the
+      // interview is different than the API key that's trying to delete the
+      // interview. If it becomes a problem we can track it down later.
+      // Consider add "internal" to docs: "If you see this, make an
+      // issue in ALKiln with your debug/verbose log"
+      log.debug({ type: `internal warning`, code: `ALK0198`, pre: `Error while cleaning up interviews.`, data: error });
+    }
+  }
+
+  // Handle all the accumulated errors
   let errors = []
   if ( !expected_status_was_met ) { errors.push( expected_status_err_msg ); }
   if ( !signout_succeeded ) { errors.push( signout_error_msg ); }
-  if ( !expected_status_was_met || !signout_succeeded ) {
+  if ( errors.length > 0 ) {
     throw new Error( `${errors.join( errors, '\n')}` );
   }
 
@@ -1405,17 +1519,14 @@ After(async function(scenario) {
 AfterAll(async function() {
   // Stop collecting server response statuses
   scope.stop_tracking_server_status = true;
-  
+
   let report = reports.getPrintableReport( scope );
   // Log the report. Can't get this.attach() or this.log() to work in `After()` or here.
   // May need newest version of cucumberjs
   console.log( `\n\n${ report }` );
 
-  // Save/download the report as an artifact
-  fs.writeFileSync( scope.paths.report, report );
-
   // If there is a browser open, then close it
   if (scope.browser) {
     await scope.browser.close();
   }
-});
+});

package/lib/utils/log.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const session_vars = require( './session_vars' );
 
 // ? 🌈 💡 🔎 🤕 🐞
+// Alternatives: 🩹 ❤️‍🩹 🚑
 // TODO: return full message so it can be passed to manually
 // thrown errors if needed.
 
@@ -91,4 +92,5 @@ log.add_to_debug_log = function(value) {
   fs.appendFileSync(log.debug_log_file, value);
 };
 
-log.debug_log_file = 'debug_log.txt'
+log.debug_log_file = `debug_log.txt`;
+log.unexpected_filename = `unexpected_results.txt`;