codeceptjs 3.6.2-beta.2 → 3.6.3-beta.2

package/README.md

@@ -46,7 +46,7 @@ CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently,
 
 * [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API.
 * [**Puppeteer**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Puppeteer.md) - uses Google Chrome's Puppeteer for fast headless testing.
-* [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver protocol.
+* [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver or Devtools protocol.
 * [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation.
 * [**Appium**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Appium.md) - for **mobile testing** with Appium
 * [**Detox**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Detox.md) - This is a wrapper on top of Detox library, aimed to unify testing experience for CodeceptJS framework. Detox provides a grey box testing for mobile applications, playing especially well for React Native apps.

package/lib/cli.js

@@ -186,20 +186,24 @@ class Cli extends Base {
           }
         }
 
-        let stack = err.stack ? err.stack.split('\n') : [];
-        if (stack[0] && stack[0].includes(err.message)) {
-          stack.shift();
-        }
+        try {
+          let stack = err.stack ? err.stack.split('\n') : [];
+          if (stack[0] && stack[0].includes(err.message)) {
+            stack.shift();
+          }
 
-        if (output.level() < 3) {
-          stack = stack.slice(0, 3);
-        }
+          if (output.level() < 3) {
+            stack = stack.slice(0, 3);
+          }
 
-        err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`;
+          err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`;
 
-        // clone err object so stack trace adjustments won't affect test other reports
-        test.err = err;
-        return test;
+          // clone err object so stack trace adjustments won't affect test other reports
+          test.err = err;
+          return test;
+        } catch (e) {
+          throw Error(e);
+        }
       });
 
       const originalLog = Base.consoleLog;

package/lib/helper/Playwright.js

@@ -3115,8 +3115,6 @@ class Playwright extends Helper {
   /**
    * Returns full URL of request matching parameter "urlMatch".
    *
-   * @param {string|RegExp} urlMatch Expected URL of request in network traffic. Can be a string or a regular expression.
-   *
    * Examples:
    *
    * ```js
@@ -3124,6 +3122,7 @@ class Playwright extends Helper {
    * I.grabTrafficUrl(/session.*start/);
    * ```
    *
+   * @param {string|RegExp} urlMatch Expected URL of request in network traffic. Can be a string or a regular expression.
    * @return {Promise<*>}
    */
   grabTrafficUrl(urlMatch) {

package/lib/helper/WebDriver.js

@@ -642,6 +642,7 @@ class WebDriver extends Helper {
 
     if (this.options.automationProtocol) {
       this.puppeteerBrowser = await this.browser.getPuppeteer();
+      this.page = (await this.puppeteerBrowser.pages())[0];
     }
 
     return this.browser;
@@ -1795,14 +1796,21 @@ class WebDriver extends Helper {
    * {{> saveScreenshot }}
    */
   async saveScreenshot(fileName, fullPage = false) {
-    const outputFile = screenshotOutputFolder(fileName);
+    let outputFile = screenshotOutputFolder(fileName);
 
     if (this.activeSessionName) {
       const browser = this.sessionWindows[this.activeSessionName];
 
-      if (browser) {
-        this.debug(`Screenshot of ${this.activeSessionName} session has been saved to ${outputFile}`);
-        return browser.saveScreenshot(outputFile);
+      for (const sessionName in this.sessionWindows) {
+        const activeSessionPage = this.sessionWindows[sessionName];
+        outputFile = screenshotOutputFolder(`${sessionName}_${fileName}`);
+
+        this.debug(`${sessionName} - Screenshot is saving to ${outputFile}`);
+
+        if (browser) {
+          this.debug(`Screenshot of ${sessionName} session has been saved to ${outputFile}`);
+          return browser.saveScreenshot(outputFile);
+        }
       }
     }
 
@@ -2724,7 +2732,6 @@ class WebDriver extends Helper {
     this.recording = true;
     this.recordedAtLeastOnce = true;
 
-    this.page = (await this.puppeteerBrowser.pages())[0];
     await this.page.setRequestInterception(true);
 
     this.page.on('request', (request) => {

package/lib/plugin/coverage.js

@@ -11,7 +11,7 @@ const defaultConfig = {
   outputDir: 'output/coverage',
 };
 
-const supportedHelpers = ['Puppeteer', 'Playwright'];
+const supportedHelpers = ['Puppeteer', 'Playwright', 'WebDriver'];
 
 const v8CoverageHelpers = {
   Playwright: {
@@ -61,6 +61,33 @@ const v8CoverageHelpers = {
       await coverageReport.add(coverageList);
     },
   },
+  WebDriver: {
+    startCoverage: async (page) => {
+      await Promise.all([
+        page.coverage.startJSCoverage({
+          resetOnNavigation: false,
+          includeRawScriptCoverage: true,
+        }),
+        page.coverage.startCSSCoverage({
+          resetOnNavigation: false,
+        }),
+      ]);
+    },
+    takeCoverage: async (page, coverageReport) => {
+      const [jsCoverage, cssCoverage] = await Promise.all([
+        page.coverage.stopJSCoverage(),
+        page.coverage.stopCSSCoverage(),
+      ]);
+      // to raw V8 script coverage
+      const coverageList = [...jsCoverage.map((it) => {
+        return {
+          source: it.text,
+          ...it.rawScriptCoverage,
+        };
+      }), ...cssCoverage];
+      await coverageReport.add(coverageList);
+    },
+  },
 };
 
 /**
@@ -109,11 +136,17 @@ module.exports = function (config) {
   const debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
 
   const helper = helpers[helperName];
+
+  if (helperName === 'WebDriver' && !helper.config.devtoolsProtocol) throw Error('Coverage is currently supporting the WebDriver running with Devtools protocol.');
+
   const v8Helper = v8CoverageHelpers[helperName];
 
   const coverageOptions = {
     ...config,
   };
+
+  if (helperName === 'WebDriver') coverageOptions.coverageProvider = 'v8';
+
   const coverageReport = new CoverageReport(coverageOptions);
   coverageReport.cleanCache();
 

package/lib/plugin/screenshotOnFail.js

@@ -110,7 +110,8 @@ module.exports = function (config) {
           allureReporter.addAttachment('Main session - Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), dataType);
 
           if (helper.activeSessionName) {
-            for (const sessionName in helper.sessionPages) {
+            const sessions = helper.sessionPages || helper.sessionWindows;
+            for (const sessionName in sessions) {
               const screenshotFileName = `${sessionName}_${fileName}`;
               test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(global.output_dir, screenshotFileName);
               allureReporter.addAttachment(`${sessionName} - Last Seen Screenshot`, fs.readFileSync(path.join(global.output_dir, screenshotFileName)), dataType);

package/lib/plugin/stepByStepReport.js

@@ -112,11 +112,13 @@ module.exports = function (config) {
   });
 
   event.dispatcher.on(event.test.failed, (test, err) => {
+    // BeforeSuite/AfterSuite don't have any access to the browser, hence it could not take screenshot.
+    if (test.ctx._runnable.title.includes('hook: BeforeSuite')) return;
     persist(test, err);
   });
 
   event.dispatcher.on(event.all.result, () => {
-    if (!Object.keys(slides).length) return;
+    if (Object.keys(recordedTests).length === 0 || !Object.keys(slides).length) return;
 
     let links = '';
 
@@ -148,7 +150,7 @@ module.exports = function (config) {
     stepNum++;
     slides[fileName] = step;
     try {
-      await helper.saveScreenshot(path.relative(reportDir, path.join(dir, fileName)), config.fullPageScreenshots);
+      await helper.saveScreenshot(path.join(dir, fileName), config.fullPageScreenshots);
     } catch (err) {
       output.plugin(`Can't save step screenshot: ${err}`);
       error = err;

package/lib/utils.js

@@ -291,7 +291,7 @@ module.exports.screenshotOutputFolder = function (fileName) {
   const fileSep = path.sep;
 
   if (!fileName.includes(fileSep) || fileName.includes('record_')) {
-    return path.join(global.output_dir, fileName);
+    return path.resolve(global.output_dir, fileName);
   }
   return path.resolve(global.codecept_dir, fileName);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.2-beta.2",
+  "version": "3.6.3-beta.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -77,7 +77,7 @@
     "acorn": "8.11.3",
     "arrify": "2.0.1",
     "axios": "1.6.7",
-    "chai": "5.1.0",
+    "chai": "5.1.1",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "2.1.0",
     "chai-json-schema": "1.5.1",
@@ -89,7 +89,7 @@
     "cross-spawn": "7.0.3",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "devtools": "8.33.1",
+    "devtools": "8.36.1",
     "envinfo": "7.11.1",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
@@ -98,16 +98,16 @@
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
-    "joi": "17.12.3",
+    "joi": "17.13.0",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
     "mocha": "10.4.0",
-    "monocart-coverage-reports": "2.7.4",
+    "monocart-coverage-reports": "2.8.3",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
-    "pactum": "3.6.7",
+    "pactum": "3.6.9",
     "parse-function": "5.6.10",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
@@ -116,7 +116,7 @@
     "uuid": "9.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.0.5"
+    "@codeceptjs/detox-helper": "1.0.7"
   },
   "devDependencies": {
     "@codeceptjs/mock-request": "0.3.1",
@@ -128,43 +128,43 @@
     "@types/node": "20.11.30",
     "@wdio/sauce-service": "8.35.1",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.33.1",
+    "@wdio/utils": "8.36.1",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
-    "chai-as-promised": "7.1.1",
+    "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
-    "electron": "30.0.1",
-    "eslint": "8.56.0",
+    "electron": "30.0.3",
+    "eslint": "9.2.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "6.3.0",
+    "eslint-plugin-mocha": "10.4.3",
     "expect": "29.7.0",
     "express": "4.19.2",
     "graphql": "14.6.0",
     "husky": "8.0.3",
     "inquirer-test": "2.0.1",
-    "jsdoc": "3.6.11",
+    "jsdoc": "4.0.3",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.43.1",
-    "puppeteer": "22.6.3",
+    "playwright": "1.44.0",
+    "puppeteer": "22.10.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
-    "sinon": "17.0.1",
+    "sinon": "18.0.0",
     "sinon-chai": "3.7.0",
     "testcafe": "3.5.0",
     "ts-morph": "21.0.1",
     "ts-node": "10.9.2",
     "tsd": "^0.31.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.25.12",
+    "typedoc": "0.25.13",
     "typedoc-plugin-markdown": "3.17.1",
     "typescript": "5.3.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.35.1",
+    "webdriverio": "8.36.1",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },

package/typings/promiseBasedTypes.d.ts

@@ -4825,7 +4825,6 @@ declare namespace CodeceptJS {
         stopRecordingTraffic(): Promise<any>;
         /**
          * Returns full URL of request matching parameter "urlMatch".
-         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          *
          * Examples:
          *
@@ -4833,6 +4832,7 @@ declare namespace CodeceptJS {
          * I.grabTrafficUrl('https://api.example.com/session');
          * I.grabTrafficUrl(/session.*start/);
          * ```
+         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          */
         grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
         /**

package/typings/types.d.ts

@@ -5076,7 +5076,6 @@ declare namespace CodeceptJS {
         stopRecordingTraffic(): void;
         /**
          * Returns full URL of request matching parameter "urlMatch".
-         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          *
          * Examples:
          *
@@ -5084,6 +5083,7 @@ declare namespace CodeceptJS {
          * I.grabTrafficUrl('https://api.example.com/session');
          * I.grabTrafficUrl(/session.*start/);
          * ```
+         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          */
         grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
         /**