codeceptjs 3.5.12 → 3.5.13-beta.2

package/lib/helper/Puppeteer.js

@@ -5,6 +5,7 @@ const path = require('path');
 
 const Helper = require('@codeceptjs/helper');
 const { v4: uuidv4 } = require('uuid');
+const promiseRetry = require('promise-retry');
 const Locator = require('../locator');
 const recorder = require('../recorder');
 const store = require('../store');
@@ -1635,6 +1636,38 @@ class Puppeteer extends Helper {
     if (cookie[0]) return cookie[0];
   }
 
+  /**
+   * {{> waitForCookie }}
+   */
+  async waitForCookie(name, sec) {
+    // by default, we will retry 3 times
+    let retries = 3;
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
+
+    if (sec) {
+      retries = sec;
+    } else {
+      retries = Math.ceil(waitTimeout / 1000) - 1;
+    }
+
+    return promiseRetry(async (retry, number) => {
+      const _grabCookie = async (name) => {
+        const cookies = await this.page.cookies();
+        const cookie = cookies.filter(c => c.name === name);
+        if (cookie.length === 0) throw Error(`Cookie ${name} is not found after ${retries}s`);
+      };
+
+      this.debugSection('Wait for cookie: ', name);
+      if (number > 1) this.debugSection('Retrying... Attempt #', number);
+
+      try {
+        await _grabCookie(name);
+      } catch (e) {
+        retry(e);
+      }
+    }, { retries, maxTimeout: 1000 });
+  }
+
   /**
    * {{> clearCookie }}
    */

package/lib/helper/WebDriver.js

@@ -6,6 +6,7 @@ const fs = require('fs');
 
 const Helper = require('@codeceptjs/helper');
 const crypto = require('crypto');
+const promiseRetry = require('promise-retry');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
 const { debug } = require('../output');
@@ -1860,6 +1861,37 @@ class WebDriver extends Helper {
     return cookie[0];
   }
 
+  /**
+   * {{> waitForCookie }}
+   */
+  async waitForCookie(name, sec) {
+    // by default, we will retry 3 times
+    let retries = 3;
+    const waitTimeout = sec || this.options.waitForTimeoutInSeconds;
+
+    if (sec) {
+      retries = sec;
+    } else {
+      retries = waitTimeout - 1;
+    }
+
+    return promiseRetry(async (retry, number) => {
+      const _grabCookie = async (name) => {
+        const cookie = await this.browser.getCookies([name]);
+        if (cookie.length === 0) throw Error(`Cookie ${name} is not found after ${retries}s`);
+      };
+
+      this.debugSection('Wait for cookie: ', name);
+      if (number > 1) this.debugSection('Retrying... Attempt #', number);
+
+      try {
+        await _grabCookie(name);
+      } catch (e) {
+        retry(e);
+      }
+    }, { retries, maxTimeout: 1000 });
+  }
+
   /**
    * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
    * Don't confuse popups with modal windows, as created by [various

package/lib/locator.js

@@ -163,7 +163,7 @@ class Locator {
    */
   toXPath(pseudoSelector = '') {
     const locator = `${this.value}${pseudoSelector}`;
-    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang'];
+    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang', ':nth-child'];
 
     if (limitation.some(item => locator.includes(item))) {
       cssToXPath = require('css-to-xpath');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.12",
+  "version": "3.5.13-beta.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -25,7 +25,8 @@
     "bin",
     "lib",
     "translations",
-    "typings/**/*.d.ts"
+    "typings/**/*.d.ts",
+    "docs/webapi/**"
   ],
   "main": "lib/index.js",
   "typings": "typings/index.d.ts",
@@ -55,6 +56,7 @@
     "test:unit:webbapi:webDriver:devtools": "mocha test/helper/WebDriver_devtools_test.js --exit",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
     "test:unit:expect": "mocha test/helper/Expect_test.js",
+    "test:unit:mockServer": "mocha test/helper/MockServer_test.js",
     "test:plugin": "mocha test/plugin/plugin_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
@@ -71,10 +73,10 @@
     "@cucumber/gherkin": "26",
     "@cucumber/messages": "24.0.1",
     "@xmldom/xmldom": "0.8.10",
-    "acorn": "8.11.2",
+    "acorn": "8.11.3",
     "arrify": "2.0.1",
     "axios": "1.6.3",
-    "chai": "4.3.8",
+    "chai": "5.0.3",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "2.1.0",
     "chai-json-schema": "1.5.1",
@@ -86,7 +88,7 @@
     "cross-spawn": "7.0.3",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "devtools": "8.27.2",
+    "devtools": "8.29.1",
     "envinfo": "7.11.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
@@ -95,7 +97,6 @@
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
-    "joi": "17.11.0",
     "js-beautify": "1.14.11",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -104,6 +105,7 @@
     "ms": "2.1.3",
     "openai": "3.2.1",
     "ora-classic": "5.4.2",
+    "pactum": "3.6.0",
     "parse-function": "5.6.4",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
@@ -121,8 +123,8 @@
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.7",
     "@types/inquirer": "9.0.3",
-    "@types/node": "20.10.7",
-    "@wdio/sauce-service": "8.27.0",
+    "@types/node": "20.11.16",
+    "@wdio/sauce-service": "8.29.1",
     "@wdio/selenium-standalone-service": "8.3.2",
     "@wdio/utils": "8.28.8",
     "@xmldom/xmldom": "0.8.10",
@@ -152,7 +154,7 @@
     "runok": "0.9.3",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
-    "testcafe": "3.3.0",
+    "testcafe": "3.5.0",
     "ts-morph": "21.0.1",
     "ts-node": "10.9.2",
     "tsd-jsdoc": "2.5.0",
@@ -169,4 +171,4 @@
     "npm": ">=5.6.0"
   },
   "es6": true
-}
+}

package/typings/index.d.ts

@@ -382,6 +382,22 @@ declare namespace CodeceptJS {
     [key: string]: any;
   };
 
+  type MockRequest = {
+    method: 'GET'|'PUT'|'POST'|'PATCH'|'DELETE'|string;
+    path: string;
+    queryParams?: object;
+  }
+
+  type MockResponse = {
+    status: number;
+    body?: object;
+  }
+
+  type MockInteraction = {
+    request: MockRequest;
+    response: MockResponse;
+  }
+
   interface PageScrollPosition {
     x: number;
     y: number;

package/typings/promiseBasedTypes.d.ts

@@ -4646,6 +4646,16 @@ declare namespace CodeceptJS {
          * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
          */
         waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Grab the data from performance timing using Navigation Timing API.
          * The returned data will contain following things in ms:
@@ -7296,6 +7306,16 @@ declare namespace CodeceptJS {
          * @param [name = null] - cookie name.
          */
         grabCookie(name?: string): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Clears a cookie by name,
          * if none provided clears all cookies.
@@ -10146,6 +10166,16 @@ declare namespace CodeceptJS {
          * @param [name = null] - cookie name.
          */
         grabCookie(name?: string): Promise<any>;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         */
+        waitForCookie(name: string, sec?: number): Promise<any>;
         /**
          * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
          * Don't confuse popups with modal windows, as created by [various

package/typings/types.d.ts

@@ -4892,6 +4892,17 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForCookie(name: string, sec?: number): void;
         /**
          * Grab the data from performance timing using Navigation Timing API.
          * The returned data will contain following things in ms:
@@ -7757,6 +7768,17 @@ declare namespace CodeceptJS {
          * Returns cookie in JSON format. If name not passed returns all cookies for this domain.
          */
         grabCookie(name?: string): any;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForCookie(name: string, sec?: number): void;
         /**
          * Clears a cookie by name,
          * if none provided clears all cookies.
@@ -10852,6 +10874,17 @@ declare namespace CodeceptJS {
          * @returns attribute value
          */
         grabCookie(name?: string): any;
+        /**
+         * Waits for the specified cookie in the cookies.
+         *
+         * ```js
+         * I.waitForCookie("token");
+         * ```
+         * @param name - expected cookie name.
+         * @param [sec = 3] - (optional, `3` by default) time in seconds to wait
+         * @returns automatically synchronized promise through #recorder
+         */
+        waitForCookie(name: string, sec?: number): void;
         /**
          * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
          * Don't confuse popups with modal windows, as created by [various