codeceptjs 3.1.3 → 3.2.3

package/docs/build/WebDriver.js

@@ -582,7 +582,7 @@ class WebDriver extends Helper {
     this.context = this.root;
     if (this.options.restart && !this.options.manualStart) return this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
-    this.$$ = this.browser.$$.bind(this.browser);
+    if (this.browser) this.$$ = this.browser.$$.bind(this.browser);
     return this.browser;
   }
 
@@ -875,7 +875,7 @@ class WebDriver extends Helper {
    * I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
    * ```
    *
-   * @param {WebdriverIO.Timeouts} timeouts WebDriver timeouts object.
+   * @param {*} timeouts WebDriver timeouts object.
    */
   defineTimeout(timeouts) {
     return this._defineBrowserTimeout(this.browser, timeouts);
@@ -3259,28 +3259,6 @@ class WebDriver extends Helper {
     return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), { timeout: aSec * 1000, timeoutMsg: '' });
   }
 
-  /**
-   * Waits for a function to return true (waits for 1sec by default).
-   * 
-   * ```js
-   * I.waitUntil(() => window.requests == 0);
-   * I.waitUntil(() => window.requests == 0, 5);
-   * ```
-   * 
-   * @param {function|string} fn function which is executed in browser context.
-   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @param {string} [timeoutMsg=''] message to show in case of timeout fail.
-   * @param {?number} [interval=null]
-   */
-  async waitUntil(fn, sec = null, timeoutMsg = null, interval = null) {
-    const aSec = sec || this.options.waitForTimeout;
-    const _interval = typeof interval === 'number' ? interval * 1000 : null;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(fn, aSec * 1000, timeoutMsg, _interval);
-    }
-    return this.browser.waitUntil(fn, { timeout: aSec * 1000, timeoutMsg, interval: _interval });
-  }
-
   /**
    * Switches frame or in case of null locator reverts to parent.
    * 

package/docs/changelog.md

@@ -7,6 +7,79 @@ layout: Section
 
 # Releases
 
+## 3.2.3
+
+* Documentation improvements by **[maojunxyz](https://github.com/maojunxyz)**
+* Guard mocha cli reporter from registering step logger multiple times [#3180](https://github.com/codeceptjs/CodeceptJS/issues/3180) by **[nikocanvacom](https://github.com/nikocanvacom)** 
+* **[Playwright]** Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by **[hatufacci](https://github.com/hatufacci)**
+* Fixed [#2889](https://github.com/codeceptjs/CodeceptJS/issues/2889): return always the same error contract from simplifyTest. See [#3168](https://github.com/codeceptjs/CodeceptJS/issues/3168) by **[andremoah](https://github.com/andremoah)** 
+
+## 3.2.2
+
+* **[Playwright]** Reverted removal of retry on context errors. Fixes [#3130](https://github.com/codeceptjs/CodeceptJS/issues/3130)
+* Timeout improvements by **[nikocanvacom](https://github.com/nikocanvacom)**:
+  * Added priorites to timeouts
+  * Added `overrideStepLimits` to [stepTimeout plugin](https://codecept.io/plugins/#steptimeout) to override steps timeouts set by `limitTime`.
+  * Fixed step timeout not working due to override by NaN by test timeout [#3126](https://github.com/codeceptjs/CodeceptJS/issues/3126)
+* **[Appium]** Fixed logging error when `manualStart` is true. See [#3140](https://github.com/codeceptjs/CodeceptJS/issues/3140) by **[nikocanvacom](https://github.com/nikocanvacom)**
+
+
+## 3.2.1
+
+> ♻️ This release fixes hanging of tests by reducing timeouts for automatic retries on failures.
+
+* [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2)
+* **[Playwright]** - disabled retry on failed context actions (not needed anymore)
+* **[Puppeteer]** - reduced retries on context failures to 3 times.
+* **[Playwright]** Handling `crash` event to automatically close crashed pages.
+
+## 3.2.0
+
+🛩️ Features:
+
+**[Timeouts](https://codecept.io/advanced/#timeout) implemented**
+  * global timeouts (via `timeout` config option). 
+    * _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously.
+  * test timeouts (via `Scenario` and `Feature` options)
+    * _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated
+
+```js
+// set timeout for every test in suite to 10 secs
+Feature('tests with timeout', { timeout: 10 });
+
+// set timeout for this test to 20 secs
+Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {});
+```  
+
+  * step timeouts (See [#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**)
+
+```js
+// set step timeout to 5 secs
+I.limitTime(5).click('Link');
+```  
+ * `stepTimeout` plugin introduced to automatically add timeouts for each step ([#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**).
+
+[**retryTo**](/plugins/#retryto) plugin introduced to rerun a set of steps on failure:
+
+```js
+// editing in text in iframe
+// if iframe was not loaded - retry 5 times
+await retryTo(() => {
+  I.switchTo('#editor frame');
+  I.fillField('textarea', 'value');
+}, 5);
+```
+
+* **[Playwright]** added `locale` configuration
+* **[WebDriver]** upgraded to webdriverio v7
+
+🐛 Bugfixes:
+
+* Fixed  allure plugin "Unexpected endStep()" error in [#3098](https://github.com/codeceptjs/CodeceptJS/issues/3098) by **[abhimanyupandian](https://github.com/abhimanyupandian)** 
+* **[Puppeteer]** always close remote browser on test end. See [#3054](https://github.com/codeceptjs/CodeceptJS/issues/3054) by **[mattonem](https://github.com/mattonem)**
+* stepbyStepReport Plugin: Disabled screenshots after test has failed. See [#3119](https://github.com/codeceptjs/CodeceptJS/issues/3119) by **[ioannisChalkias](https://github.com/ioannisChalkias)**
+
+
 ## 3.1.3
 
 🛩️ Features:
@@ -24,7 +97,7 @@ Given('I have an employee card', (table) => {
   // rows = [['Harry', 'Potter', Seeker]];
   }
 ```
-See updated [BDD section](https://codecept.io/bdd/) for more API options.
+See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to **[EgorBodnar](https://github.com/EgorBodnar)**
 
 * Support `cjs` file extensions for config file: `codecept.conf.cjs`. See [#3052](https://github.com/codeceptjs/CodeceptJS/issues/3052) by **[kalvenschraut](https://github.com/kalvenschraut)**
 * API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 
@@ -37,6 +110,7 @@ See updated [BDD section](https://codecept.io/bdd/) for more API options.
 * **[Playwright]** `I.haveRequestHeaders` affects all tabs. See [#3049](https://github.com/codeceptjs/CodeceptJS/issues/3049) by **[jancorvus](https://github.com/jancorvus)**
 * BDD: Fixed unhandled empty feature files. Fix [#3046](https://github.com/codeceptjs/CodeceptJS/issues/3046) by **[abhimanyupandian](https://github.com/abhimanyupandian)** 
 * Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.  
+* **[Appium]** Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by **[mirao](https://github.com/mirao)** 
 
 📖 Documentation:
 

package/docs/configuration.md

@@ -17,15 +17,15 @@ Here is an overview of available options with their defaults:
 * **timeout**: `10000` - default tests timeout
 * **output**: `"./output"` - where to store failure screenshots, etc
 * **helpers**: `{}` - list of enabled helpers
-* **mocha**: `{}` - mocha options, [reporters](http://codecept.io/reports/) can be configured here
-* **multiple**: `{}` - multiple options, see [Multiple Execution](http://codecept.io/parallel#multiple-browsers-execution)
-* **bootstrap**: `"./bootstrap.js"` - an option to run code _before_ tests are run. See [Hooks](http://codecept.io/hooks/#bootstrap-teardown)).
-* **bootstrapAll**: `"./bootstrap.js"` - an option to run code _before_ all test suites are run when using the run-multiple mode. See [Hooks](http://codecept.io/hooks/#bootstrap-teardown)).
-* **teardown**: - an option to run code _after_  all test suites are run when using the run-multiple mode. See [Hooks](http://codecept.io/hooks/#bootstrap-teardown).
-* **teardownAll**: - an option to run code _after_ tests are run. See [Hooks](http://codecept.io/hooks/#bootstrap-teardown).
+* **mocha**: `{}` - mocha options, [reporters](https://codecept.io/reports/) can be configured here
+* **multiple**: `{}` - multiple options, see [Multiple Execution](https://codecept.io/parallel#multiple-browsers-execution)
+* **bootstrap**: `"./bootstrap.js"` - an option to run code _before_ tests are run. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown)).
+* **bootstrapAll**: `"./bootstrap.js"` - an option to run code _before_ all test suites are run when using the run-multiple mode. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown)).
+* **teardown**: - an option to run code _after_  all test suites are run when using the run-multiple mode. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown).
+* **teardownAll**: - an option to run code _after_ tests are run. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown).
 * **noGlobals**: `false` - disable registering global variables like `Actor`, `Helper`, `pause`, `within`, `DataTable`
-* **hooks**: - include custom listeners to plug into execution workflow. See [Custom Hooks](http://codecept.io/hooks/#custom-hooks)
-* **translation**: - [locale](http://codecept.io/translation/) to be used to print s  teps output, as well as used in source code.
+* **hooks**: - include custom listeners to plug into execution workflow. See [Custom Hooks](https://codecept.io/hooks/#custom-hooks)
+* **translation**: - [locale](https://codecept.io/translation/) to be used to print s  teps output, as well as used in source code.
 * **require**: `[]` - array of module names to be required before codecept starts. See [Require](#require)
 
 

package/docs/custom-helpers.md

@@ -108,7 +108,7 @@ If you need to get access to web elements, it is recommended to implement operat
 
 To get access for elements, connect to a corresponding helper and use `_locate` function to match web elements by CSS or XPath, like you usually do:
 
-### Acessing Elements in WebDriver
+### Accessing Elements in WebDriver
 
 ```js
 // inside a custom helper
@@ -264,7 +264,7 @@ class MyHelper extends Helper {
     const { WebDriver } = this.helpers
     const { browser } = WebDriver;
 
-    // get all cookies according to http://webdriver.io/api/protocol/cookie.html
+    // get all cookies according to https://webdriver.io/api/protocol/cookie.html
     // any helper method should return a value in order to be added to promise chain
     const res = await browser.cookie();
     // get values
@@ -304,38 +304,3 @@ class MyHelper extends Helper {
 
 module.exports = MyHelper;
 ```
-
-### Protractor Example
-
-Protractor example demonstrates usage of global `element` and `by` objects.
-However `browser` should be accessed from a helper instance via `this.helpers['Protractor']`;
-We also use `chai-as-promised` library to have nice assertions with promises.
-
-```js
-const Helper = require('@codeceptjs/helper');
-
-// use any assertion library you like
-const chai = require('chai');
-const chaiAsPromised = require('chai-as-promised');
-chai.use(chaiAsPromised);
-const expect = chai.expect;
-
-class MyHelper extends Helper {
-  /**
-   * checks that authentication cookie is set
-   */
-  seeInHistory(historyPosition, value) {
-    // access browser instance from Protractor helper
-    this.helpers['Protractor'].browser.refresh();
-
-    // you can use `element` as well as in protractor
-    const history = element.all(by.repeater('result in memory'));
-
-    // use chai as promised for better assertions
-    // end your method with `return` to handle promises
-    return expect(history.get(historyPosition).getText()).to.eventually.equal(value);
-  }
-}
-
-module.exports = MyHelper;
-```

package/docs/data.md

@@ -5,7 +5,7 @@ title: Data Management
 
 # Data Management
 
-> This chapter describes data management for external sources. If you are looking for using Data Sets in tests, see [Data Driven Tests](http://codecept.io/advanced/#data-drivern-tests) section*
+> This chapter describes data management for external sources. If you are looking for using Data Sets in tests, see [Data Driven Tests](https://codecept.io/advanced/#data-drivern-tests) section*
 
 Managing data for tests is always a tricky issue. How isolate data between tests, how to prepare data for different tests, etc.
 There are different approaches to solve it:
@@ -22,7 +22,7 @@ API is supposed to be a stable interface and it can be used by acceptance tests.
 
 ## REST
 
-[REST helper](http://codecept.io/helpers/REST/) allows sending raw HTTP requests to application.
+[REST helper](https://codecept.io/helpers/REST/) allows sending raw HTTP requests to application.
 This is a tool to make shortcuts and create your data pragmatically via API. However, it doesn't provide tools for testing APIs, so it should be paired with WebDriver, Nightmare or Protractor helpers for browser testing.
 
 Enable REST helper in the config. It is recommended to set `endpoint`, a base URL for all API requests. If you need some authorization you can optionally set default headers too.
@@ -87,11 +87,11 @@ This can also be used to emulate Ajax requests:
 I.sendPostRequest('/update-status', {}, { http_x_requested_with: 'xmlhttprequest' });
 ```
 
-> See complete reference on [REST](http://codecept.io/helpers/REST) helper
+> See complete reference on [REST](https://codecept.io/helpers/REST) helper
 
 ## GraphQL
 
-[GraphQL helper](http://codecept.io/helpers/GraphQL/) allows sending GraphQL queries and mutations to application, over Http.
+[GraphQL helper](https://codecept.io/helpers/GraphQL/) allows sending GraphQL queries and mutations to application, over Http.
 This is a tool to make shortcuts and create your data pragmatically via GraphQL endpoint. However, it doesn't provide tools for testing the endpoint, so it should be paired with WebDriver, Nightmare or Protractor helpers for browser testing.
 
 Enable GraphQL helper in the config. It is recommended to set `endpoint`, the URL to which the requests go to. If you need some authorization you can optionally set default headers too.
@@ -160,13 +160,13 @@ After(({ I }) => {
 });
 ```
 
-> See complete reference on [GraphQL](http://codecept.io/helpers/GraphQL) helper
+> See complete reference on [GraphQL](https://codecept.io/helpers/GraphQL) helper
 
 ## Data Generation with Factories
 
 This concept is extended by:
-- [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/) helper, and,
-- [GraphQLDataFactory](http://codecept.io/helpers/GraphQLDataFactory/) helper.
+- [ApiDataFactory](https://codecept.io/helpers/ApiDataFactory/) helper, and,
+- [GraphQLDataFactory](https://codecept.io/helpers/GraphQLDataFactory/) helper.
 
 These helpers build data according to defined rules and use REST API or GraphQL mutations to store them and automatically clean them up after a test.
 
@@ -238,7 +238,7 @@ At the end of a test ApiDataFactory will clean up created record for you. This i
 ids from crated records and running `DELETE /api/users/{id}` requests at the end of a test.
 This rules can be customized in helper configuration.
 
-> See complete reference on [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory) helper
+> See complete reference on [ApiDataFactory](https://codecept.io/helpers/ApiDataFactory) helper
 
 ### GraphQL Data Factory
 
@@ -303,7 +303,7 @@ data from crated records, creating deletion mutation objects by passing the data
 This behavior is according the `revert` function be customized in helper configuration.
 The revert function returns an object, that contains the query for deletion, and the variables object to go along with it.
 
-> See complete reference on [GraphQLDataFactory](http://codecept.io/helpers/GraphQLDataFactory) helper
+> See complete reference on [GraphQLDataFactory](https://codecept.io/helpers/GraphQLDataFactory) helper
 
 ## Requests Using Browser Session