codeceptjs 3.5.2 → 3.5.4-beta.1

package/lib/helper/extras/PlaywrightReact.js

@@ -0,0 +1,9 @@
+module.exports = async function findReact(matcher, locator) {
+  let _locator = `_react=${locator.react}`;
+
+  if (locator.props && locator.props.name) {
+    _locator += `[name = "${locator.props.name}"]`;
+  }
+
+  return matcher.locator(_locator).all();
+};

package/lib/plugin/standardActingHelpers.js

@@ -4,8 +4,6 @@ const standardActingHelpers = [
   'Puppeteer',
   'Appium',
   'TestCafe',
-  'Protractor',
-  'Nightmare',
 ];
 
 module.exports = standardActingHelpers;

package/lib/plugin/wdio.js

@@ -51,7 +51,6 @@ let restartsSession;
  * }
  * ```
  *
- * Please note, this service can be used with Protractor helper as well!
  *
  * #### Sauce Service
  *

package/lib/recorder.js

@@ -94,7 +94,8 @@ module.exports = {
     oldPromises = [];
     tasks = [];
     this.session.running = false;
-    this.retries = [];
+    // reset this retries makes the retryFailedStep plugin won't work if there is Before/BeforeSuit block due to retries is undefined on Scenario
+    // this.retries = [];
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.2",
+  "version": "3.5.4-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -40,7 +40,7 @@
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
     "docs": "./runok.js docs",
-    "test:unit": "mocha test/unit --recursive",
+    "test:unit": "mocha test/unit --recursive --timeout 5000",
     "test:runner": "mocha test/runner --recursive --timeout 5000",
     "test": "npm run test:unit && npm run test:runner",
     "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
@@ -59,7 +59,7 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.8.0",
+    "@codeceptjs/configure": "^0.10.0",
     "@codeceptjs/helper": "^1.0.2",
     "@cucumber/cucumber-expressions": "^16",
     "@cucumber/gherkin": "^26",
@@ -116,26 +116,24 @@
     "documentation": "^12.3.0",
     "dtslint": "^4.1.6",
     "electron": "^25.2.0",
-    "eslint": "^6.8.0",
+    "eslint": "^8.45.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-mocha": "^6.3.0",
     "expect": "^26.6.2",
     "express": "^4.17.2",
-    "form-data": "^3.0.1",
     "graphql": "^14.6.0",
     "husky": "^8.0.1",
     "inquirer-test": "^2.0.1",
     "jsdoc": "^3.6.10",
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
-    "nightmare": "^3.0.2",
     "playwright": "^1.35.1",
     "puppeteer": "^10.4.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^2.1.0",
     "runok": "^0.9.2",
-    "sinon": "^9.2.4",
+    "sinon": "^15.2.0",
     "sinon-chai": "^3.7.0",
     "testcafe": "^2.1.0",
     "ts-morph": "^3.1.3",

package/typings/index.d.ts

@@ -524,7 +524,6 @@ declare const After: CodeceptJS.IHook;
 declare const __: any
 
 interface Window {
-  codeceptjs: typeof CodeceptJS.browserCodecept;
   resq: any;
 }
 

package/typings/promiseBasedTypes.d.ts

@@ -4519,6 +4519,133 @@ declare namespace CodeceptJS {
          * @param [handler] - a function to process reques
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
+        /**
+         * Starts recording of network traffic.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         */
+        startRecordingTraffic(): Promise<void>;
+        /**
+         * Grab the recording network traffics
+         */
+        grabRecordedNetworkTraffics(): Promise<any>;
+        /**
+         * Blocks traffic for URL.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.blockTraffic('http://example.com/css/style.css');
+         * I.blockTraffic('http://example.com/css/*.css');
+         * I.blockTraffic('http://example.com/**');
+         * I.blockTraffic(/\.css$/);
+         * ```
+         * @param url - URL to block . URL can contain * for wildcards. Example: https://www.example.com** to block all traffic for that domain. Regexp are also supported.
+         */
+        blockTraffic(url: any): Promise<any>;
+        /**
+         * Mocks traffic for URL(s).
+         * This is a powerful feature to manipulate network traffic. Can be used e.g. to stabilize your tests, speed up your tests or as a last resort to make some test scenarios even possible.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.mockTraffic('/api/users/1', '{ id: 1, name: 'John Doe' }');
+         * I.mockTraffic('/api/users/*', JSON.stringify({ id: 1, name: 'John Doe' }));
+         * I.mockTraffic([/^https://api.example.com/v1/, 'https://api.example.com/v2/**'], 'Internal Server Error', 'text/html');
+         * ```
+         * @param urls - string|Array These are the URL(s) to mock, e.g. "/fooapi/*" or "['/fooapi_1/*', '/barapi_2/*']". Regular expressions are also supported.
+         * @param responseString - string The string to return in fake response's body.
+         * @param contentType - Content type of fake response. If not specified default value 'application/json' is used.
+         */
+        mockTraffic(urls: any, responseString: any, contentType?: any): Promise<any>;
+        /**
+         * Resets all recorded network requests.
+         */
+        flushNetworkTraffics(): Promise<any>;
+        /**
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): Promise<any>;
+        /**
+         * 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>;
+        /**
+         * 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:
+         *
+         * ```js
+         * I.grabTrafficUrl('https://api.example.com/session');
+         * I.grabTrafficUrl(/session.*start/);
+         * ```
+         */
+        grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
+        /**
+         * 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>;
     }
     /**
      * This helper works the same as MockRequest helper. It has been included for backwards compatibility

package/typings/types.d.ts

@@ -4602,6 +4602,133 @@ declare namespace CodeceptJS {
          * @param [handler] - a function to process reques
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): void;
+        /**
+         * Starts recording of network traffic.
+         * This also resets recorded network requests.
+         *
+         * ```js
+         * I.startRecordingTraffic();
+         * ```
+         */
+        startRecordingTraffic(): Promise<void>;
+        /**
+         * Grab the recording network traffics
+         */
+        grabRecordedNetworkTraffics(): any[];
+        /**
+         * Blocks traffic for URL.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.blockTraffic('http://example.com/css/style.css');
+         * I.blockTraffic('http://example.com/css/*.css');
+         * I.blockTraffic('http://example.com/**');
+         * I.blockTraffic(/\.css$/);
+         * ```
+         * @param url - URL to block . URL can contain * for wildcards. Example: https://www.example.com** to block all traffic for that domain. Regexp are also supported.
+         */
+        blockTraffic(url: any): void;
+        /**
+         * Mocks traffic for URL(s).
+         * This is a powerful feature to manipulate network traffic. Can be used e.g. to stabilize your tests, speed up your tests or as a last resort to make some test scenarios even possible.
+         *
+         * Examples:
+         *
+         * ```js
+         * I.mockTraffic('/api/users/1', '{ id: 1, name: 'John Doe' }');
+         * I.mockTraffic('/api/users/*', JSON.stringify({ id: 1, name: 'John Doe' }));
+         * I.mockTraffic([/^https://api.example.com/v1/, 'https://api.example.com/v2/**'], 'Internal Server Error', 'text/html');
+         * ```
+         * @param urls - string|Array These are the URL(s) to mock, e.g. "/fooapi/*" or "['/fooapi_1/*', '/barapi_2/*']". Regular expressions are also supported.
+         * @param responseString - string The string to return in fake response's body.
+         * @param contentType - Content type of fake response. If not specified default value 'application/json' is used.
+         */
+        mockTraffic(urls: any, responseString: any, contentType?: any): void;
+        /**
+         * Resets all recorded network requests.
+         */
+        flushNetworkTraffics(): void;
+        /**
+         * Stops recording of network traffic. Recorded traffic is not flashed.
+         *
+         * ```js
+         * I.stopRecordingTraffic();
+         * ```
+         */
+        stopRecordingTraffic(): void;
+        /**
+         * 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>;
+        /**
+         * 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:
+         *
+         * ```js
+         * I.grabTrafficUrl('https://api.example.com/session');
+         * I.grabTrafficUrl(/session.*start/);
+         * ```
+         */
+        grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
+        /**
+         * 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;
+        }): void;
     }
     /**
      * This helper works the same as MockRequest helper. It has been included for backwards compatibility
@@ -11114,31 +11241,6 @@ declare namespace CodeceptJS {
          */
         function cleanDispatcher(): void;
     }
-    namespace browserCodecept {
-        /**
-         * all found elements are stored here for reuse
-         */
-        var elements: Node[];
-        /**
-         * global context changer
-         */
-        var within: Node;
-        /**
-         * finders
-         */
-        function fetchElement(id: number): Node;
-        function findAndStoreElements(by: string, locator: CodeceptJS.ILocator, contextEl?: any): number[];
-        function findAndStoreElement(by: string, locator: CodeceptJS.ILocator, contextEl?: any): number | undefined;
-        function setWithin(by: string, locator: CodeceptJS.ILocator): void;
-        function findElements(by: string, locator: CodeceptJS.ILocator, contextEl?: any): Node[];
-        function findElement(by: string, locator: CodeceptJS.ILocator, context?: any): Node;
-        function clickEl(el: number): boolean;
-        function doubleClickEl(el: number): void;
-        function hoverEl(el: number, x: number | undefined, y: number | undefined): void;
-        function rightClickEl(el: number): void;
-        function checkEl(el: number): boolean | undefined;
-        function unCheckEl(el: number): boolean;
-    }
     /**
      * Index file for loading CodeceptJS programmatically.
      *