Fixed screenshot on failure for active session of WebDriver (#2312)

* Fixed session for WebDriver

* fix to a session test

* fixed tests for Playwright

Author: DavertMik

lib/helper/WebDriver.js

@@ -594,6 +594,7 @@ class WebDriver extends Helper {
         return browser;
       },
       stop: async (browser) => {
+        if (!browser) return;
         return browser.deleteSession();
       },
       loadVars: async (browser) => {

lib/plugin/screenshotOnFail.js

@@ -118,6 +118,7 @@ module.exports = function (config) {
             || err.message.indexOf('no such window: target window already closed') > -1
           )
         ) {
+          output.log(`Can't make screenshot, ${err}`);
           helper.isRunning = false;
         }
       }

lib/session.js

@@ -58,7 +58,9 @@ function session(sessionName, config, fn) {
       delete savedSessions[sessionName];
     };
 
-    event.dispatcher.once(event.test.finished, () => closeBrowsers());
+    event.dispatcher.once(event.test.after, () => {
+      recorder.add('close session browsers', closeBrowsers);
+    });
 
     if (!savedSessions[sessionName]) {
       throw new Error('Configured helpers do not support starting sessions. Please use a helper with session support.');

test/acceptance/codecept.Playwright.js

@@ -19,6 +19,11 @@ module.exports.config = {
   include: {},
   bootstrap: false,
   mocha: {},
+  plugins: {
+    screenshotOnFail: {
+      enabled: true,
+    },
+  },
   name: 'acceptance',
   gherkin: {
     features: './gherkin/*.feature',

test/acceptance/codecept.Puppeteer.js

@@ -24,6 +24,11 @@ module.exports.config = {
   include: {},
   bootstrap: false,
   mocha: {},
+  plugins: {
+    screenshotOnFail: {
+      enabled: true,
+    },
+  },
   name: 'acceptance',
   gherkin: {
     features: './gherkin/*.feature',

test/acceptance/codecept.WebDriver.js

@@ -27,6 +27,11 @@ module.exports.config = {
   bootstrap: done => setTimeout(done, 5000), // let's wait for selenium
   mocha: {},
   name: 'acceptance',
+  plugins: {
+    screenshotOnFail: {
+      enabled: true,
+    },
+  },
   gherkin: {
     features: './gherkin/*.feature',
     steps: ['./gherkin/steps.js'],

test/acceptance/session_test.js

@@ -1,5 +1,6 @@
 const assert = require('assert');
-const path = require('path');
+
+const { event } = codeceptjs;
 
 Feature('Session');
 
@@ -76,6 +77,28 @@ Scenario('Different cookies for different sessions @WebDriverIO @Protractor @Pla
   assert.notEqual(cookies.john, cookies.mary);
 });
 
+
+Scenario('should save screenshot for active session @WebDriverIO @Puppeteer @Playwright', async function (I) {
+  I.amOnPage('/form/bug1467');
+  I.saveScreenshot('original.png');
+  I.amOnPage('/');
+  session('john', async () => {
+    await I.amOnPage('/form/bug1467');
+    event.dispatcher.emit(event.test.failed, this);
+  });
+
+  const fileName = clearString(this.title);
+
+  const [original, failed] = await I.getMD5Digests([
+    `${output_dir}/original.png`,
+    `${output_dir}/${fileName}.failed.png`,
+  ]);
+
+  // Assert that screenshots of same page in same session are equal
+  assert.equal(original, failed);
+});
+
+
 Scenario('should throw exception and close correctly @WebDriverIO @Protractor @Puppeteer @Playwright', (I) => {
   I.amOnPage('/form/bug1467#session1');
   I.checkOption('Yes');
@@ -85,6 +108,7 @@ Scenario('should throw exception and close correctly @WebDriverIO @Protractor @P
     I.seeCheckboxIsChecked({ css: 'input[value=No]' });
   });
   I.seeCheckboxIsChecked({ css: 'input[value=Yes]' });
+  I.amOnPage('/info');
 }).fails();
 
 Scenario('async/await @WebDriverIO @Protractor', (I) => {
@@ -203,3 +227,11 @@ Scenario('should return a value @WebDriverIO @Protractor @Puppeteer @Playwright
   I.click('Submit');
   I.see('[description] => Information');
 });
+
+function clearString(str) {
+  if (!str) return '';
+  /* Replace forbidden symbols in string
+     */
+  return str
+    .replace(/ /g, '_');
+}

test/unit/plugin/screenshotOnFail_test.js

@@ -13,7 +13,7 @@ describe('screenshotOnFail', () => {
     recorder.reset();
     screenshotSaved = sinon.spy();
     container.clear({
-      WebDriverIO: {
+      WebDriver: {
         options: {},
         saveScreenshot: screenshotSaved,
       },