Add nav wait after sign in to allow a screenshot

Author: plocket

lib/scope.js

@@ -3090,6 +3090,7 @@ module.exports = {
       /** Allow the developer to log a user into their server using GitHub
       * secrets to authenticate.
       */
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-1.jpg`});
       // Don't take a picture of a failed login in case one of the inputs is correct
       scope.disable_error_screenshot = true;
 
@@ -3101,24 +3102,30 @@ module.exports = {
 
       // Go to the sign in page
       let login_url = `${ session_vars.get_da_server_url() }/user/sign-in`;
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-2.jpg`});
 
       // TODO: implement and use scope.handle_possible_timeout()
       try {
         // puppeteer will ensure proper timeout.
         await scope.page.goto( login_url, { waitUntil: `domcontentloaded`, timeout: scope.timeout });
         await scope.page.waitForSelector( `.dabody` );
 
+        await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-3.jpg`});
+
       } catch ( error ) {
 
         let err_msg = `Error occurred when ALKiln tried to go to "${ login_url }".`
         if ( error.name === `TimeoutError` ) {
+          console.log(`🖊️ 110`);
           let non_reload_report_msg = `It took too long to load "${ login_url }"`;
           await scope.handle_page_timeout_error( scope, { non_reload_report_data: {
             code: `ALK0159`,
             message: non_reload_report_msg,
           }, error });
         } else {
           // Throw any non-timeout error
+          console.log(`🖊️ 111`);
+          await scope.take_a_screenshot(scope, {path:`./_alkiln_temp/Temp-4.jpg`});
           reports.addToReport( scope, { type: `error`, code: `ALK0160`, value: err_msg });
           throw error;
         }  // ends if error is timeout error
@@ -3159,6 +3166,8 @@ module.exports = {
           scope.scenarios.get( scope.scenario_id ).api_keys.push( api_key );
         }
       }
+      console.log(`🖊️ 112`);
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-4.jpg`});
 
       expect( email, email_msg ).to.not.equal( undefined );
       expect( password, password_msg ).to.not.equal( undefined );
@@ -3168,9 +3177,14 @@ module.exports = {
       await scope.page.type( `#password`, password );
       let elem = await scope.page.$( `button[type="submit"]` );
       await scope.guard_against_missing_tap_element(scope, { elem });
+      console.log(`🖊️ 113`);
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-5.jpg`});
 
       // Submit and see what happens
-      let winner = await scope.steps.race_sign_in_navigation( scope, { elem });
+      let winner = await scope.steps.race_sign_in_navigation( scope, { elem, login_url });
+      console.log(`🖊️ 113.5 ${ winner }`);
+      // await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-6.jpg`});
+      // console.log(`🖊️ 113.6 ${ winner }`);
       // Add the result to the report and possibly throw errors
       if ( winner[0] === `success` ) {
         reports.addToReport( scope, {
@@ -3183,6 +3197,7 @@ module.exports = {
           type: `error`, code: `ALK0209`,
           value: `Failed to sign into ${ login_url }. Make sure you followed the instructions at https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in.`
         });
+        console.log(`🍉 ${ error_msg }`);
         throw new Error( error_msg );
       } else if ( winner[0] === `error` ) {
         let error_msg = reports.addToReport( scope, {
@@ -3191,59 +3206,94 @@ module.exports = {
         });
         throw new Error( error_msg );
       }
+      console.log(`🖊️ 114`);
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp-7.jpg`});
+      if (error_msg) {
+        return [ error_msg ];
+      } else {
+        return [];
+      }
     },  // Ends scope.steps.sign_in()
 
-    race_sign_in_navigation: async function ( scope, { elem }) {
+    race_sign_in_navigation: async function ( scope, { elem, login_url='unknown' }) {
       /** Wait for sign in navigation success or failure, or system error. */
 
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-0.jpg`});
+
       // After everything, clean up incomplete promises
       const controller = new AbortController;
+      console.log(`⏳ 200`);
 
       // Redirect
-      let redirect_promise = scope.page.waitForResponse(function ( response ) {
+      let redirect_promise = scope.page.waitForResponse(async ( response ) => {
+        console.log(`⏳ 300`);
         return response.status() === 302;
       }, { signal: controller.signal })
-      .catch(( catch_info ) => {
+      .catch(async ( catch_info ) => {
+        console.log(`⏳ 201`);
+        // await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-1.jpg`});
         log.debug({ code: `ALK0204`, context: `nav`, },
           `302 sign-in wait catch error:`, catch_info.name, catch_info,
         );
       });
 
       // Invalid credentials, no navigation, no sign in
-      let wrong_sign_in_promise = scope.page.waitForResponse(function ( response ) {
+      let wrong_sign_in_promise = scope.page.waitForResponse(async ( response ) => {
+        console.log(`⏳ 301`);
         return response.status() >= 200 && response.status() < 300 && response.url().includes(`/sign-in`);
       }, { signal: controller.signal })
-      .catch(( catch_info ) => {
+      .catch(async ( catch_info ) => {
+        // errors?
+        console.log(`⏳ 202`);
+        // await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-2.jpg`});
         log.debug({ code: `ALK0205`, context: `nav`, },
           `200s sign-in wait catch error:`, catch_info.name, catch_info,
         );
       });
 
       // System error
-      let error_promise = scope.page.waitForResponse(function ( response ) {
+      let error_promise = scope.page.waitForResponse(async ( response ) => {
+        console.log(`⏳ 302`);
         return response.status() >= 500 && response.status() < 600;
       }, { signal: controller.signal })
-      .catch(( catch_info ) => {
+      .catch(async ( catch_info ) => {
+        console.log(`⏳ 203`);
+        await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-3.jpg`});
         log.debug({ code: `ALK0206`, context: `nav`, },
           `500s sign-in wait catch error:`, catch_info.name, catch_info,
         );
       });
 
+      // Duh, the other catches were triggered because those promises were aborted
+
       let click_promise = elem.click();  // MUST complete
+      let nav_promise = scope.nav_race(scope, {}).result;
+      let pic_promise = true; // scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-10.jpg`});
+      console.log(`⏳ 204`);
       const winner = await Promise.race([
-        Promise.all([ `success`, click_promise, redirect_promise ]),
-        Promise.all([ `failure`, click_promise, wrong_sign_in_promise ]),
-        Promise.all([ `error`, click_promise, error_promise ]),
-      ]).catch(function ( error ) {
+        Promise.all([ `success`, click_promise, pic_promise, redirect_promise ]),
+        Promise.all([ `failure`, click_promise, pic_promise, wrong_sign_in_promise ]),
+        Promise.all([ `error`, click_promise, pic_promise, error_promise ]),
+      ]).catch(async ( error ) => {
+        console.log(`⏳ 205`);
+        // await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-4.jpg`});
         let error_msg = reports.addToReport( scope, {
           type: `error`, code: `ALK0207`,
           value: `Unknown error waiting for results during sign in at ${ login_url }.`
         });
-        throw new Error( error );
+        console.log(`⏳ 205.1`, error);
+        throw error;
       });
 
+      console.log(`⏳ 206`);
+      // // await waitForTimeout(500);
+      // await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp2-5.jpg`});
+
       // Clean up unresolved promises
       controller.abort();
+      console.log(`⏳ 207`);
+      await nav_promise;
+      await scope.take_a_screenshot(scope, {path:`${scope.paths.artifacts}/Temp3-1.jpg`});
 
       log.debug({ code: `ALK0208`, context: `nav` },
         `Sign-in winner:`, winner
@@ -3517,14 +3567,15 @@ module.exports = {
     let scenario = scope.report.get( scope.scenario_id );
     let report = reports.getPrintableScenario( scenario );
     let all_are_included = true;
+    let missing = [];
     for ( let one_expectation of expected ) {
       if ( !report.includes( one_expectation )) {
         all_are_included = false;
-        expect( report ).to.contain( one_expectation );
+        missing.push( one_expectation );
       }
     }
 
-    return all_are_included;
+    return { all_included: all_are_included, missing };
   },  // Ends scope.reportIncludesAllExpected()
 
   reportDoesNotInclude: async function ( scope, { not_expected=[] }) {