codeceptjs 3.3.0 → 3.3.3

package/CHANGELOG.md

@@ -1,3 +1,52 @@
+## 3.3.3
+
+* Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers
+* 🇺🇦 Added #StandWithUkraine notice to CLI
+
+
+## 3.3.2
+
+* [REST] Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See #3304 by @mirao
+* Reverted typings change introduced in #3245. [More details on this](https://twitter.com/CodeceptJS/status/1519725963856207873) 
+
+## 3.3.1
+
+🛩️ Features:
+
+* Add option to avoid duplicate gherkin step definitions (#3257) - @raywiis
+* Added `step.*` for run-workers #3272. Thanks to @abhimanyupandian
+* Fixed loading tests for `codecept run` using glob patterns. By @jayudey-wf 
+
+```
+npx codeceptjs run test-dir/*"
+```
+
+* [Playwright] **Possible breaking change.** By default `timeout` is changed to 5000ms. The value set in 3.3.0 was too low. Please set `timeout` explicitly to not depend on release values.
+* [Playwright] Added for color scheme option by @PeterNgTr
+
+```js
+ helpers: {
+  Playwright : {
+    url: "http://localhost",
+    colorScheme: "dark",
+  }
+ }
+```
+
+
+🐛 Bugfixes:
+
+* [Playwright] Fixed `Cannot read property 'video' of undefined`
+* Fixed haveRequestHeaders() and amBearerAuthenticated() of REST helper (#3260) - @mirao
+* Fixed: allure attachment fails if screenshot failed #3298 by @ruudvanderweijde 
+* Fixed #3105 using autoLogin() plugin with TypeScript. Fix #3290 by @PeterNgTr 
+* [Playwright] Added extra params for click and dragAndDrop to type definitions by @mirao
+
+
+📖 Documentation
+* Improving the typings in many places
+* Improving the return type of helpers for TS users (#3245) - @nlespiaucq
+
 ## 3.3.0
 
 🛩️ Features:
@@ -46,7 +95,7 @@ await eachElement('click all links in .list', '.list a', (el) => {
 
 📖 Documentation
 
-* Added [Testomat.io reporter](/reporters#testomatio)
+* Added [Testomat.io reporter](/reports#testomatio)
 * Added [api testing](/api) guides
 * Added [internal api](/internal-api) guides
 * [Appium] Fixed documentation for `performSwipe`

package/README.md

@@ -1,4 +1,9 @@
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)
+
+
+
 [<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url]
+[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) 
 
 Build Status:
 
@@ -8,7 +13,7 @@ Build Status:
 [![Appium Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml)
 [![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml)
 
-# CodeceptJS
+# CodeceptJS [![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua)
 
 Reference: [Helpers API](https://github.com/codeceptjs/CodeceptJS/tree/master/docs/helpers)
 

package/docs/api.md

@@ -300,7 +300,7 @@ To perform arbitrary assertions on a response object use `seeResponseValidByCall
 It allows you to do any kind of assertions by using `expect` from [`chai`](https://www.chaijs.com) library.
 
 ```js
-I.seeResponseValidByCallback({ data, status, expect } => {
+I.seeResponseValidByCallback(({ data, status, expect }) => {
   // we receive data and expect to combine them for good assertion
   expect(data.users.length).to.be.gte(10);
 })

package/docs/bdd.md

@@ -399,6 +399,7 @@ Tag should be placed before *Scenario:* or before *Feature:* keyword. In the las
 * `gherkin`
   * `features` - path to feature files, or an array of feature file paths
   * `steps` - array of files with step definitions
+  * `avoidDuplicateSteps` - attempts to avoid duplicate step definitions by shallow compare
 
 ```js
 "gherkin": {

package/docs/best.md

@@ -215,7 +215,7 @@ include: {
 * When you need to customize access to API and go beyond what ApiDataFactory provides, implement DAO:
 
 ```js
-const faker = require('faker');
+const faker = require('@faker-js/faker');
 const { I } = inject();
 const { output } = require('codeceptjs');
 

package/docs/build/ApiDataFactory.js

@@ -36,7 +36,7 @@ const REST = require('./REST');
  * Install [Rosie](https://github.com/rosiejs/rosie) and [Faker](https://www.npmjs.com/package/faker) libraries.
  *
  * ```sh
- * npm i rosie faker --save-dev
+ * npm i rosie @faker-js/faker --save-dev
  * ```
  *
  * Create a factory file for a resource.
@@ -46,8 +46,8 @@ const REST = require('./REST');
  * ```js
  * // tests/factories/posts.js
  *
- * var Factory = require('rosie').Factory;
- * var faker = require('faker');
+ * const Factory = require('rosie').Factory;
+ * const faker = require('@faker-js/faker');
  *
  * module.exports = new Factory()
  *    // no need to set id, it will be set by REST API
@@ -264,6 +264,7 @@ class ApiDataFactory extends Helper {
    * @param {*} factory factory to use
    * @param {*} params predefined parameters
    * @param {*} options options for programmatically generate the attributes
+   * @returns {Promise<*>}
    */
   have(factory, params, options) {
     const item = this._createItem(factory, params, options);

package/docs/build/Appium.js

@@ -124,6 +124,7 @@ const webRoot = 'body';
 class Appium extends Webdriver {
   /**
    * Appium Special Methods for Mobile only
+   * @augments WebDriver
    */
 
   constructor(config) {
@@ -331,7 +332,6 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
@@ -374,7 +374,6 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
-   * @return {Promise<any>}
    */
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
@@ -395,7 +394,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {*} fn
-   * @return {Promise<any>}
    */
   /* eslint-disable */
   async runInWeb(fn) {
@@ -599,7 +597,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
-   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -728,7 +725,6 @@ class Appium extends Webdriver {
    * Switch to the specified context.
    *
    * @param {*} context the context to switch to
-
    */
   async _switchToContext(context) {
     return this.browser.switchContext(context);
@@ -774,7 +770,7 @@ class Appium extends Webdriver {
    * // or set context explicitly
    * I.switchToNative('SOME_OTHER_CONTEXT');
    * ```
-   * @param {*} context
+   * @param {*} [context]
    * @return {Promise<void>}
    */
   async switchToNative(context = null) {
@@ -834,7 +830,6 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {object} settings object
-   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -1337,6 +1332,7 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async appendField(field, value) {
@@ -1357,6 +1353,7 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async checkOption(field) {
@@ -1388,7 +1385,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
@@ -1407,7 +1405,7 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1423,6 +1421,7 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSeeElement(locator) {
     if (this.isWeb) return super.dontSeeElement(locator);
@@ -1440,6 +1439,7 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async dontSeeInField(field, value) {
@@ -1458,7 +1458,7 @@ class Appium extends Webdriver {
    * 
    * @param {string} text which is not present.
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    */
   async dontSee(text, context = null) {
     if (this.isWeb) return super.dontSee(text, context);
@@ -1481,7 +1481,7 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async fillField(field, value) {
@@ -1642,7 +1642,7 @@ class Appium extends Webdriver {
    * 
    * @param {LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * Supported only for web testing
    */
@@ -1660,7 +1660,7 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeCheckboxIsChecked(field) {
@@ -1676,6 +1676,7 @@ class Appium extends Webdriver {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeElement(locator) {
@@ -1695,7 +1696,7 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async seeInField(field, value) {
@@ -1714,6 +1715,7 @@ class Appium extends Webdriver {
    * ```
    * @param {string} text expected on page.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async see(text, context) {
@@ -1742,7 +1744,7 @@ class Appium extends Webdriver {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    * Supported only for web testing
    */
@@ -1762,6 +1764,7 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForElement(locator, sec = null) {
@@ -1779,7 +1782,7 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * 
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForVisible(locator, sec = null) {
@@ -1797,6 +1800,7 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForInvisible(locator, sec = null) {
@@ -1817,6 +1821,7 @@ class Appium extends Webdriver {
    * @param {string }text to wait for.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
+   * [!] returns a _promise_ which is synchronized internally by recorder
    *
    */
   async waitForText(text, sec = null, context = null) {

package/docs/build/GraphQL.js

@@ -112,15 +112,15 @@ class GraphQL extends Helper {
    *
    * @param {object} operation
    * @param {object} headers
+   * @return {object} graphQLRequest
    */
   _prepareGraphQLRequest(operation, headers) {
-    const request = {
+    return {
       baseURL: this.options.endpoint,
       method: 'POST',
       data: operation,
       headers,
     };
-    return request;
   }
 
   /**
@@ -142,6 +142,7 @@ class GraphQL extends Helper {
    * @param {object} variables that may go along with the query
    * @param {object} options are additional query options
    * @param {object} headers
+   * @return Promise<any>
    */
   async sendQuery(query, variables, options = {}, headers = {}) {
     if (typeof query !== 'string') {
@@ -181,6 +182,7 @@ class GraphQL extends Helper {
    * @param {object} variables that may go along with the mutation
    * @param {object} options are additional query options
    * @param {object} headers
+   * @return Promise<any>
    */
   async sendMutation(mutation, variables, options = {}, headers = {}) {
     if (typeof mutation !== 'string') {

package/docs/build/GraphQLDataFactory.js

@@ -36,7 +36,7 @@ const GraphQL = require('./GraphQL');
  * Install [Rosie](https://github.com/rosiejs/rosie) and [Faker](https://www.npmjs.com/package/faker) libraries.
  *
  * ```sh
- * npm i rosie faker --save-dev
+ * npm i rosie @faker-js/faker --save-dev
  * ```
  *
  * Create a factory file for a resource.
@@ -46,8 +46,8 @@ const GraphQL = require('./GraphQL');
  * ```js
  * // tests/factories/users.js
  *
- * var Factory = require('rosie').Factory;
- * var faker = require('faker');
+ * const Factory = require('rosie').Factory;
+ * const faker = require('@faker-js/faker');
  *
  * // Used with a constructor function passed to Factory, so that the final build
  * // object matches the necessary pattern to be sent as the variables object.

package/docs/build/JSONResponse.js

@@ -218,7 +218,7 @@ class JSONResponse extends Helper {
    * Use it to perform custom checks of response data
    *
    * ```js
-   * I.seeResponseValidByCallback({ data, status, expect } => {
+   * I.seeResponseValidByCallback(({ data, status, expect }) => {
    *   expect(status).to.eql(200);
    *   expect(data).keys.to.include(['user', 'company']);
    * });