codeceptjs 3.5.12-beta.9 → 3.5.13-beta.1

package/README.md

@@ -313,10 +313,10 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/tsuemura"><img src="https://avatars.githubusercontent.com/u/17092259?v=4" title="tsuemura" width="80" height="80"></a>
 <a href="https://github.com/EgorBodnar"><img src="https://avatars.githubusercontent.com/u/63167966?v=4" title="EgorBodnar" width="80" height="80"></a>
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
-<a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
-<a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
+<a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
 <a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
+<a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
 <a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>

package/lib/actor.js

@@ -13,15 +13,18 @@ const output = require('./output');
  */
 class Actor {
   /**
-   * add print comment method`
+   * Print the comment on log. Also, adding a step in the `Test.steps` object
    * @param {string} msg
    * @param {string} color
    * @inner
    *
    * ⚠️ returns a promise which is synchronized internally by recorder
    */
-  say(msg, color = 'cyan') {
-    return recorder.add(`say ${msg}`, () => {
+  async say(msg, color = 'cyan') {
+    const step = new Step('say', 'say');
+    step.status = 'passed';
+    return recordStep(step, [msg]).then(() => {
+      // this is backward compatibility as this event may be used somewhere
       event.emit(event.step.comment, msg);
       output.say(msg, `${color}`);
     });

package/lib/helper/Appium.js

@@ -2,6 +2,7 @@ let webdriverio;
 
 const fs = require('fs');
 const axios = require('axios').default;
+const { v4: uuidv4 } = require('uuid');
 
 const Webdriver = require('./WebDriver');
 const AssertionFailedError = require('../assert/error');
@@ -1088,17 +1089,40 @@ class Appium extends Webdriver {
    * Appium: support Android and iOS
    */
   async performSwipe(from, to) {
-    await this.browser.touchPerform([{
-      action: 'press',
-      options: from,
-    }, {
-      action: 'wait',
-      options: { ms: 1000 },
-    }, {
-      action: 'moveTo',
-      options: to,
-    }, {
-      action: 'release',
+    await this.browser.performActions([{
+      id: uuidv4(),
+      type: 'pointer',
+      parameters: {
+        pointerType: 'touch',
+      },
+      actions: [
+        {
+          duration: 0,
+          x: from.x,
+          y: from.y,
+          type: 'pointerMove',
+          origin: 'viewport',
+        },
+        {
+          button: 1,
+          type: 'pointerDown',
+        },
+        {
+          duration: 200,
+          type: 'pause',
+        },
+        {
+          duration: 600,
+          x: to.x,
+          y: to.y,
+          type: 'pointerMove',
+          origin: 'viewport',
+        },
+        {
+          button: 1,
+          type: 'pointerUp',
+        },
+      ],
     }]);
     await this.browser.pause(1000);
   }
@@ -1128,7 +1152,7 @@ class Appium extends Webdriver {
       yoffset = 100;
     }
 
-    return this.swipe(locator, 0, yoffset, speed);
+    return this.swipe(parseLocator.call(this, locator), 0, yoffset, speed);
   }
 
   /**

package/lib/helper/Expect.js

@@ -1,12 +1,15 @@
-const chai = require('chai');
 const output = require('../output');
 
-const { expect } = chai;
+let expect;
 
-chai.use(require('chai-string'));
-// @ts-ignore
-chai.use(require('chai-exclude'));
-chai.use(require('chai-match-pattern'));
+import('chai').then(chai => {
+  expect = chai.expect;
+  chai.use(require('chai-string'));
+  // @ts-ignore
+  chai.use(require('chai-exclude'));
+  chai.use(require('chai-match-pattern'));
+  chai.use(require('chai-json-schema'));
+});
 
 /**
  * This helper allows performing assertions based on Chai.
@@ -179,7 +182,7 @@ class ExpectHelper {
   expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
     // @ts-ignore
     output.step(`I expect "${JSON.stringify(targetData)}" to match this JSON schema "${JSON.stringify(jsonSchema)}"`);
-    chai.use(require('chai-json-schema'));
+
     return expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema);
   }
 

package/lib/helper/JSONResponse.js

@@ -1,12 +1,13 @@
-const assert = require('assert');
-const chai = require('chai');
-const joi = require('joi');
-const chaiDeepMatch = require('chai-deep-match');
 const Helper = require('@codeceptjs/helper');
 
-chai.use(chaiDeepMatch);
+let expect;
+
+import('chai').then(chai => {
+  expect = chai.expect;
+  chai.use(require('chai-deep-match'));
+});
 
-const { expect } = chai;
+const joi = require('joi');
 
 /**
  * This helper allows performing assertions on JSON responses paired with following helpers:
@@ -91,7 +92,6 @@ class JSONResponse extends Helper {
   static _checkRequirements() {
     try {
       require('joi');
-      require('chai');
     } catch (e) {
       return ['joi'];
     }
@@ -194,7 +194,7 @@ class JSONResponse extends Helper {
           fails++;
         }
       }
-      assert.ok(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`);
+      expect(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`).to.be.true;
     } else {
       expect(this.response.data).to.deep.match(json);
     }

package/lib/helper/Playwright.js

@@ -4,6 +4,7 @@ const fs = require('fs');
 const Helper = require('@codeceptjs/helper');
 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');
@@ -50,6 +51,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
 const {
   seeElementError, dontSeeElementError, dontSeeElementInDOMError, seeElementInDOMError,
 } = require('./errors/ElementAssertion');
+const { log } = require('../output');
 
 const pathSeparator = path.sep;
 
@@ -748,9 +750,7 @@ class Playwright extends Helper {
     });
     this.context = await this.page;
     this.contextLocator = null;
-    if (this.options.browser === 'chrome') {
-      await page.bringToFront();
-    }
+    await page.bringToFront();
   }
 
   /**
@@ -1805,7 +1805,7 @@ class Playwright extends Helper {
     let optionToSelect = '';
 
     try {
-      optionToSelect = await el.locator('option', { hasText: option }).textContent();
+      optionToSelect = (await el.locator('option', { hasText: option }).textContent()).trim();
     } catch (e) {
       optionToSelect = option;
     }
@@ -2890,6 +2890,38 @@ class Playwright extends Helper {
     }
   }
 
+  /**
+   * {{> 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.browserContext.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 });
+  }
+
   async _waitForAction() {
     return this.wait(this.options.waitForAction / 1000);
   }

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/lib/step.js

@@ -119,7 +119,9 @@ class Step {
     }
     let result;
     try {
-      result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      if (this.helperMethod !== 'say') {
+        result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      }
       this.setStatus('success');
     } catch (err) {
       this.setStatus('failed');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.12-beta.9",
+  "version": "3.5.13-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -72,10 +72,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",
@@ -87,7 +87,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",
@@ -96,7 +96,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",
@@ -123,10 +122,10 @@
     "@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.27.2",
+    "@wdio/utils": "8.28.8",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
@@ -154,7 +153,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",

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
@@ -11448,7 +11481,7 @@ declare namespace CodeceptJS {
     }
     interface ActorStatic {
         /**
-         * add print comment method`
+         * Print the comment on log. Also, adding a step in the `Test.steps` object
          */
         say(msg: string, color?: string): void;
         /**