codeceptjs 3.5.13-beta.3 → 3.5.13

package/lib/helper/Playwright.js

@@ -6,7 +6,6 @@ const { v4: uuidv4 } = require('uuid');
 const assert = require('assert');
 const promiseRetry = require('promise-retry');
 const Locator = require('../locator');
-const store = require('../store');
 const recorder = require('../recorder');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals } = require('../assert/equal');
@@ -2679,6 +2678,7 @@ class Playwright extends Helper {
    */
   async waitForText(text, sec = null, context = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
+    const errorMessage = `Text "${text}" was not found on page after ${waitTimeout / 1000} sec.`;
     let waiter;
 
     const contextObject = await this._getContext();
@@ -2689,18 +2689,21 @@ class Playwright extends Helper {
         try {
           await contextObject.locator(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()} >> text=${text}`).first().waitFor({ timeout: waitTimeout, state: 'visible' });
         } catch (e) {
-          console.log(e);
-          throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec\n${e.message}`);
+          throw new Error(`${errorMessage}\n${e.message}`);
         }
       }
 
       if (locator.isXPath()) {
-        waiter = contextObject.waitForFunction(([locator, text, $XPath]) => {
-          eval($XPath); // eslint-disable-line no-eval
-          const el = $XPath(null, locator);
-          if (!el.length) return false;
-          return el[0].innerText.indexOf(text) > -1;
-        }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
+        try {
+          await contextObject.waitForFunction(([locator, text, $XPath]) => {
+            eval($XPath); // eslint-disable-line no-eval
+            const el = $XPath(null, locator);
+            if (!el.length) return false;
+            return el[0].innerText.indexOf(text) > -1;
+          }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
+        } catch (e) {
+          throw new Error(`${errorMessage}\n${e.message}`);
+        }
       }
     } else {
       // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
@@ -2714,7 +2717,7 @@ class Playwright extends Helper {
         count += 1000;
       } while (count <= waitTimeout);
 
-      if (!waiter) throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec`);
+      if (!waiter) throw new Error(`${errorMessage}`);
     }
   }
 

package/lib/helper/Puppeteer.js

@@ -486,7 +486,7 @@ class Puppeteer extends Helper {
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page.$('body');
-    if (this.config.browser === 'chrome') {
+    if (this.options.browser === 'chrome') {
       await page.bringToFront();
     }
   }
@@ -658,9 +658,9 @@ class Puppeteer extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
+    if (this.options.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        await this.page.authenticate(this.config.basicAuth);
+        await this.page.authenticate(this.options.basicAuth);
         this.isAuthenticated = true;
       }
     }

package/lib/helper/REST.js

@@ -72,9 +72,12 @@ class REST extends Helper {
       this.options.maxBodyLength = maxContentLength;
     }
 
-    this.options = { ...this.options, ...config };
+    // override defaults with config
+    this._setConfig(config);
+
     this.headers = { ...this.options.defaultHeaders };
     this.axios = axios.create();
+    // @ts-ignore
     this.axios.defaults.headers = this.options.defaultHeaders;
   }
 

package/lib/helper/WebDriver.js

@@ -977,12 +977,12 @@ class WebDriver extends Helper {
    */
   amOnPage(url) {
     let split_url;
-    if (this.config.basicAuth) {
+    if (this.options.basicAuth) {
       if (url.startsWith('/')) {
-        url = this.config.url + url;
+        url = this.options.url + url;
       }
       split_url = url.split('//');
-      url = `${split_url[0]}//${this.config.basicAuth.username}:${this.config.basicAuth.password}@${split_url[1]}`;
+      url = `${split_url[0]}//${this.options.basicAuth.username}:${this.options.basicAuth.password}@${split_url[1]}`;
     }
     return this.browser.url(url);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.13-beta.3",
+  "version": "3.5.13",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -75,7 +75,7 @@
     "@xmldom/xmldom": "0.8.10",
     "acorn": "8.11.3",
     "arrify": "2.0.1",
-    "axios": "1.6.3",
+    "axios": "1.6.7",
     "chai": "5.0.3",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "2.1.0",
@@ -106,7 +106,7 @@
     "openai": "3.2.1",
     "ora-classic": "5.4.2",
     "pactum": "3.6.0",
-    "parse-function": "5.6.4",
+    "parse-function": "5.6.10",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
     "resq": "1.11.0",
@@ -121,7 +121,7 @@
     "@faker-js/faker": "7.6.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
-    "@types/chai": "4.3.7",
+    "@types/chai": "4.3.11",
     "@types/inquirer": "9.0.3",
     "@types/node": "20.11.16",
     "@wdio/sauce-service": "8.29.1",
@@ -162,7 +162,7 @@
     "typedoc-plugin-markdown": "3.17.1",
     "typescript": "5.3.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.28.8",
+    "webdriverio": "8.31.1",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },
@@ -171,4 +171,4 @@
     "npm": ">=5.6.0"
   },
   "es6": true
-}
+}

package/typings/promiseBasedTypes.d.ts

@@ -4725,11 +4725,10 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
+         * Resets all recorded network requests.
          *
          * ```js
-         * I.startRecordingTraffic();
+         * I.flushNetworkTraffics();
          * ```
          */
         startRecordingTraffic(): Promise<any>;
@@ -4743,7 +4742,7 @@ declare namespace CodeceptJS {
          * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
          * ```
          */
-        grabRecordedNetworkTraffics(): Promise<any[]>;
+        grabRecordedNetworkTraffics(): Promise<any>;
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -4780,6 +4779,10 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): Promise<any>;
         /**
          * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
          */
         flushNetworkTraffics(): Promise<any>;
         /**
@@ -4798,13 +4801,13 @@ declare namespace CodeceptJS {
          * I.amOnPage('https://openai.com/blog/chatgpt');
          * I.startRecordingTraffic();
          * await I.seeTraffic({
-         *    name: 'sentry event',
-         *    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-         *    parameters: {
-         *       width: '1919',
-         *       height: '1138',
+         *     name: 'sentry event',
+         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+         *     parameters: {
+         *     width: '1919',
+         *     height: '1138',
          *     },
-         * });
+         *   });
          * ```
          *
          * ```js
@@ -4812,12 +4815,12 @@ declare namespace CodeceptJS {
          * I.amOnPage('https://openai.com/blog/chatgpt');
          * I.startRecordingTraffic();
          * await I.seeTraffic({
-         *    name: 'event',
-         *    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-         *    requestPostData: {
-         *       st: 2,
+         *     name: 'event',
+         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+         *     requestPostData: {
+         *     st: 2,
          *     },
-         * });
+         *   });
          * ```
          * @param opts - options when checking the traffic network.
          * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
@@ -10735,6 +10738,114 @@ declare namespace CodeceptJS {
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
         runInWeb(): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
+         */
+        flushNetworkTraffics(): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         */
+        startRecordingTraffic(): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Grab the recording network traffics
+         *
+         * ```js
+         * const traffics = await I.grabRecordedNetworkTraffics();
+         * expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+         * expect(traffics[0].response.status).to.equal(200);
+         * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+         * ```
+         */
+        grabRecordedNetworkTraffics(): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Verifies that a certain request is part of network traffic.
+         *
+         * ```js
+         * // checking the request url contains certain query strings
+         * I.amOnPage('https://openai.com/blog/chatgpt');
+         * I.startRecordingTraffic();
+         * await I.seeTraffic({
+         *     name: 'sentry event',
+         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+         *     parameters: {
+         *     width: '1919',
+         *     height: '1138',
+         *     },
+         *   });
+         * ```
+         *
+         * ```js
+         * // checking the request url contains certain post data
+         * I.amOnPage('https://openai.com/blog/chatgpt');
+         * I.startRecordingTraffic();
+         * await I.seeTraffic({
+         *     name: 'event',
+         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+         *     requestPostData: {
+         *     st: 2,
+         *     },
+         *   });
+         * ```
+         * @param opts - options when checking the traffic network.
+         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+         * @param opts.url - Expected URL of request in network traffic
+         * @param [opts.parameters] - Expected parameters of that request in network traffic
+         * @param [opts.requestPostData] - Expected that request contains post data in network traffic
+         * @param [opts.timeout] - Timeout to wait for request in seconds. Default is 10 seconds.
+         */
+        seeTraffic(opts: {
+            name: string;
+            url: string;
+            parameters?: any;
+            requestPostData?: any;
+            timeout?: number;
+        }): Promise<any>;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Verifies that a certain request is not part of network traffic.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
+         * I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
+         * ```
+         * @param opts - options when checking the traffic network.
+         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+         * @param opts.url - Expected URL of request in network traffic. Can be a string or a regular expression.
+         */
+        dontSeeTraffic(opts: {
+            name: string;
+            url: string | RegExp;
+        }): Promise<any>;
     }
 }
 

package/typings/types.d.ts

@@ -4973,11 +4973,10 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): void;
         /**
-         * Starts recording the network traffics.
-         * This also resets recorded network requests.
+         * Resets all recorded network requests.
          *
          * ```js
-         * I.startRecordingTraffic();
+         * I.flushNetworkTraffics();
          * ```
          */
         startRecordingTraffic(): void;
@@ -4990,8 +4989,9 @@ declare namespace CodeceptJS {
          * expect(traffics[0].response.status).to.equal(200);
          * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
          * ```
+         * @returns recorded network traffics
          */
-        grabRecordedNetworkTraffics(): Promise<any[]>;
+        grabRecordedNetworkTraffics(): any[];
         /**
          * Blocks traffic of a given URL or a list of URLs.
          *
@@ -5028,6 +5028,10 @@ declare namespace CodeceptJS {
         mockTraffic(urls: any, responseString: any, contentType?: any): void;
         /**
          * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
          */
         flushNetworkTraffics(): void;
         /**
@@ -5046,13 +5050,13 @@ declare namespace CodeceptJS {
          * I.amOnPage('https://openai.com/blog/chatgpt');
          * I.startRecordingTraffic();
          * await I.seeTraffic({
-         *    name: 'sentry event',
-         *    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-         *    parameters: {
-         *       width: '1919',
-         *       height: '1138',
+         *     name: 'sentry event',
+         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+         *     parameters: {
+         *     width: '1919',
+         *     height: '1138',
          *     },
-         * });
+         *   });
          * ```
          *
          * ```js
@@ -5060,12 +5064,12 @@ declare namespace CodeceptJS {
          * I.amOnPage('https://openai.com/blog/chatgpt');
          * I.startRecordingTraffic();
          * await I.seeTraffic({
-         *    name: 'event',
-         *    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-         *    requestPostData: {
-         *       st: 2,
+         *     name: 'event',
+         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+         *     requestPostData: {
+         *     st: 2,
          *     },
-         * });
+         *   });
          * ```
          * @param opts - options when checking the traffic network.
          * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
@@ -5073,6 +5077,7 @@ declare namespace CodeceptJS {
          * @param [opts.parameters] - Expected parameters of that request in network traffic
          * @param [opts.requestPostData] - Expected that request contains post data in network traffic
          * @param [opts.timeout] - Timeout to wait for request in seconds. Default is 10 seconds.
+         * @returns automatically synchronized promise through #recorder
          */
         seeTraffic(opts: {
             name: string;
@@ -5080,7 +5085,7 @@ declare namespace CodeceptJS {
             parameters?: any;
             requestPostData?: any;
             timeout?: number;
-        }): Promise<any>;
+        }): 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.
@@ -5105,6 +5110,7 @@ declare namespace CodeceptJS {
          * @param opts - options when checking the traffic network.
          * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
          * @param opts.url - Expected URL of request in network traffic. Can be a string or a regular expression.
+         * @returns automatically synchronized promise through #recorder
          */
         dontSeeTraffic(opts: {
             name: string;
@@ -11478,6 +11484,118 @@ declare namespace CodeceptJS {
          * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
          */
         runInWeb(): void;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Resets all recorded network requests.
+         *
+         * ```js
+         * I.flushNetworkTraffics();
+         * ```
+         */
+        flushNetworkTraffics(): void;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): void;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         * @returns automatically synchronized promise through #recorder
+         */
+        startRecordingTraffic(): void;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Grab the recording network traffics
+         *
+         * ```js
+         * const traffics = await I.grabRecordedNetworkTraffics();
+         * expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+         * expect(traffics[0].response.status).to.equal(200);
+         * expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+         * ```
+         * @returns recorded network traffics
+         */
+        grabRecordedNetworkTraffics(): any[];
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Verifies that a certain request is part of network traffic.
+         *
+         * ```js
+         * // checking the request url contains certain query strings
+         * I.amOnPage('https://openai.com/blog/chatgpt');
+         * I.startRecordingTraffic();
+         * await I.seeTraffic({
+         *     name: 'sentry event',
+         *     url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+         *     parameters: {
+         *     width: '1919',
+         *     height: '1138',
+         *     },
+         *   });
+         * ```
+         *
+         * ```js
+         * // checking the request url contains certain post data
+         * I.amOnPage('https://openai.com/blog/chatgpt');
+         * I.startRecordingTraffic();
+         * await I.seeTraffic({
+         *     name: 'event',
+         *     url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+         *     requestPostData: {
+         *     st: 2,
+         *     },
+         *   });
+         * ```
+         * @param opts - options when checking the traffic network.
+         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+         * @param opts.url - Expected URL of request in network traffic
+         * @param [opts.parameters] - Expected parameters of that request in network traffic
+         * @param [opts.requestPostData] - Expected that request contains post data in network traffic
+         * @param [opts.timeout] - Timeout to wait for request in seconds. Default is 10 seconds.
+         * @returns automatically synchronized promise through #recorder
+         */
+        seeTraffic(opts: {
+            name: string;
+            url: string;
+            parameters?: any;
+            requestPostData?: any;
+            timeout?: number;
+        }): void;
+        /**
+         * _Note:_ Only works when devtoolsProtocol is enabled.
+         *
+         * Verifies that a certain request is not part of network traffic.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
+         * I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
+         * ```
+         * @param opts - options when checking the traffic network.
+         * @param opts.name - A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+         * @param opts.url - Expected URL of request in network traffic. Can be a string or a regular expression.
+         * @returns automatically synchronized promise through #recorder
+         */
+        dontSeeTraffic(opts: {
+            name: string;
+            url: string | RegExp;
+        }): void;
     }
     interface ActorStatic {
         /**