codeceptjs 3.3.8-beta.1 → 3.4.0-beta.1

package/CHANGELOG.md

@@ -1,3 +1,50 @@
+## 3.4.0
+
+* **Updated to latest mocha and modern Cucumber**
+* **Allure plugin moved to [@codeceptjs/allure-legacy](https://github.com/codeceptjs/allure-legacy) package**. This happened because allure-commons package v1 was not updated and caused vulnarabilities. Fixes #3422. We don't plan to maintain allure v2 plugin so it's up to community to take this initiative. Current allure plugin will print a warning message without interfering the run, so it won't accidentally fail your builds.
+* Added ability to **[retry Before](https://codecept.io/basics/#retry-before), BeforeSuite, After, AfterSuite** hooks by @davertmik:
+```js
+Feature('flaky Before & BeforeSuite', { retryBefore: 2, retryBeforeSuite: 3 })
+```
+
+* **Flexible [retries configuration](https://codecept.io/basics/#retry-configuration) introduced** by @davertmik:
+
+```js
+retry: [
+  {
+    // enable this config only for flaky tests
+    grep: '@flaky', 
+    Before: 3 // retry Before 3 times
+    Scenario: 3 // retry Scenario 3 times
+  }, 
+  {
+    // retry less when running slow tests
+    grep: '@slow' 
+    Scenario: 1
+    Before: 1
+  }, {
+    // retry all BeforeSuite 3 times
+    BeforeSuite: 3
+  }
+]
+```
+* **Flexible [timeout configuration](https://codecept.io/advanced/#timeout-configuration)** introduced by @davertmik:
+
+```js
+timeout: [
+  10, // default timeout is 10secs  
+  {   // but increase timeout for slow tests
+    grep: '@slow',
+    Feature: 50
+  },
+]
+```
+
+* JsDoc: Removed promise from `I.say`. See #3535 by @danielrentz
+* [Playwright] `handleDownloads` requires now a filename param. See #3511 by @PeterNgTr 
+* [WebDriver] Added support for v8, removed support for webdriverio v5 and lower. See #3578 by @PeterNgTr
+
+
 ## 3.3.7
 
 🛩️ Features

package/README.md

@@ -101,8 +101,7 @@ npx codeceptjs def .
 Later you can even automagically update Type Definitions to include your own custom [helpers methods](docs/helpers.md).
 
 Note:
-- CodeceptJS requires Node.js version `8.9.1+` or later. 
-- To use the parallel tests execution, requiring Node.js version `11.7` or later.
+- CodeceptJS requires Node.js version `12+` or later. 
 
 ## Usage
 
@@ -294,36 +293,36 @@ When using Typescript, replace `module.exports` with `export` for autocompletion
 Thanks all to those who are and will have contributing to this awesome project!
 
 [//]: contributor-faces
-<a href="https://github.com/DavertMik"><img src="https://avatars0.githubusercontent.com/u/220264?v=4" title="DavertMik" width="80" height="80"></a>
-<a href="https://github.com/PeterNgTr"><img src="https://avatars0.githubusercontent.com/u/7845001?v=4" title="PeterNgTr" width="80" height="80"></a>
-<a href="https://github.com/Vorobeyko"><img src="https://avatars3.githubusercontent.com/u/11293201?v=4" title="Vorobeyko" width="80" height="80"></a>
-<a href="https://github.com/APshenkin"><img src="https://avatars1.githubusercontent.com/u/14344430?v=4" title="APshenkin" width="80" height="80"></a>
-<a href="https://github.com/reubenmiller"><img src="https://avatars0.githubusercontent.com/u/3029781?v=4" title="reubenmiller" width="80" height="80"></a>
-<a href="https://github.com/fabioel"><img src="https://avatars1.githubusercontent.com/u/9824235?v=4" title="fabioel" width="80" height="80"></a>
-<a href="https://github.com/pablopaul"><img src="https://avatars1.githubusercontent.com/u/635526?v=4" title="pablopaul" width="80" height="80"></a>
-<a href="https://github.com/koushikmohan1996"><img src="https://avatars3.githubusercontent.com/u/24666922?v=4" title="koushikmohan1996" width="80" height="80"></a>
-<a href="https://github.com/Arhell"><img src="https://avatars2.githubusercontent.com/u/26163841?v=4" title="Arhell" width="80" height="80"></a>
-<a href="https://github.com/tsuemura"><img src="https://avatars1.githubusercontent.com/u/17092259?v=4" title="tsuemura" width="80" height="80"></a>
-<a href="https://github.com/VikalpP"><img src="https://avatars2.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
-<a href="https://github.com/elukoyanov"><img src="https://avatars3.githubusercontent.com/u/11647141?v=4" title="elukoyanov" width="80" height="80"></a>
-<a href="https://github.com/MercifulCode"><img src="https://avatars2.githubusercontent.com/u/1740822?v=4" title="MercifulCode" width="80" height="80"></a>
-<a href="https://github.com/Georgegriff"><img src="https://avatars3.githubusercontent.com/u/9056958?v=4" title="Georgegriff" width="80" height="80"></a>
-<a href="https://github.com/hubidu"><img src="https://avatars2.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
-<a href="https://github.com/BorisOsipov"><img src="https://avatars0.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
-<a href="https://github.com/jploskonka"><img src="https://avatars3.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
-<a href="https://github.com/martomo"><img src="https://avatars2.githubusercontent.com/u/1850135?v=4" title="martomo" width="80" height="80"></a>
-<a href="https://github.com/denis-sokolov"><img src="https://avatars0.githubusercontent.com/u/113721?v=4" title="denis-sokolov" width="80" height="80"></a>
-<a href="https://github.com/lennym"><img src="https://avatars3.githubusercontent.com/u/117398?v=4" title="lennym" width="80" height="80"></a>
-<a href="https://github.com/petehouston"><img src="https://avatars0.githubusercontent.com/u/9006720?v=4" title="petehouston" width="80" height="80"></a>
-<a href="https://github.com/Holorium"><img src="https://avatars1.githubusercontent.com/u/10815542?v=4" title="Holorium" width="80" height="80"></a>
-<a href="https://github.com/nitschSB"><img src="https://avatars0.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
-<a href="https://github.com/johnyb"><img src="https://avatars2.githubusercontent.com/u/86358?v=4" title="johnyb" width="80" height="80"></a>
-<a href="https://github.com/jamesgeorge007"><img src="https://avatars2.githubusercontent.com/u/25279263?v=4" title="jamesgeorge007" width="80" height="80"></a>
-<a href="https://github.com/jinjorge"><img src="https://avatars3.githubusercontent.com/u/2208083?v=4" title="jinjorge" width="80" height="80"></a>
-<a href="https://github.com/gkushang"><img src="https://avatars1.githubusercontent.com/u/3663389?v=4" title="gkushang" width="80" height="80"></a>
-<a href="https://github.com/galkin"><img src="https://avatars3.githubusercontent.com/u/5930544?v=4" title="galkin" width="80" height="80"></a>
-<a href="https://github.com/orihomie"><img src="https://avatars2.githubusercontent.com/u/29889683?v=4" title="orihomie" width="80" height="80"></a>
-<a href="https://github.com/radhey1851"><img src="https://avatars2.githubusercontent.com/u/22446528?v=4" title="radhey1851" width="80" height="80"></a>
+<a href="https://github.com/DavertMik"><img src="https://avatars.githubusercontent.com/u/220264?v=4" title="DavertMik" width="80" height="80"></a>
+<a href="https://github.com/PeterNgTr"><img src="https://avatars.githubusercontent.com/u/7845001?v=4" title="PeterNgTr" width="80" height="80"></a>
+<a href="https://github.com/Vorobeyko"><img src="https://avatars.githubusercontent.com/u/11293201?v=4" title="Vorobeyko" width="80" height="80"></a>
+<a href="https://github.com/reubenmiller"><img src="https://avatars.githubusercontent.com/u/3029781?v=4" title="reubenmiller" width="80" height="80"></a>
+<a href="https://github.com/Arhell"><img src="https://avatars.githubusercontent.com/u/26163841?v=4" title="Arhell" width="80" height="80"></a>
+<a href="https://github.com/APshenkin"><img src="https://avatars.githubusercontent.com/u/14344430?v=4" title="APshenkin" width="80" height="80"></a>
+<a href="https://github.com/fabioel"><img src="https://avatars.githubusercontent.com/u/9824235?v=4" title="fabioel" width="80" height="80"></a>
+<a href="https://github.com/pablopaul"><img src="https://avatars.githubusercontent.com/u/635526?v=4" title="pablopaul" width="80" height="80"></a>
+<a href="https://github.com/Georgegriff"><img src="https://avatars.githubusercontent.com/u/9056958?v=4" title="Georgegriff" width="80" height="80"></a>
+<a href="https://github.com/mirao"><img src="https://avatars.githubusercontent.com/u/12584138?v=4" title="mirao" width="80" height="80"></a>
+<a href="https://github.com/KMKoushik"><img src="https://avatars.githubusercontent.com/u/24666922?v=4" title="KMKoushik" width="80" height="80"></a>
+<a href="https://github.com/nikocanvacom"><img src="https://avatars.githubusercontent.com/u/83254493?v=4" title="nikocanvacom" width="80" height="80"></a>
+<a href="https://github.com/elukoyanov"><img src="https://avatars.githubusercontent.com/u/11647141?v=4" title="elukoyanov" width="80" height="80"></a>
+<a href="https://github.com/gkushang"><img src="https://avatars.githubusercontent.com/u/3663389?v=4" title="gkushang" width="80" height="80"></a>
+<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/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/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" 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/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>
+<a href="https://github.com/abhimanyupandian"><img src="https://avatars.githubusercontent.com/u/36107381?v=4" title="abhimanyupandian" width="80" height="80"></a>
+<a href="https://github.com/martomo"><img src="https://avatars.githubusercontent.com/u/1850135?v=4" title="martomo" width="80" height="80"></a>
+<a href="https://github.com/denis-sokolov"><img src="https://avatars.githubusercontent.com/u/113721?v=4" title="denis-sokolov" width="80" height="80"></a>
+<a href="https://github.com/lennym"><img src="https://avatars.githubusercontent.com/u/117398?v=4" title="lennym" width="80" height="80"></a>
+<a href="https://github.com/petehouston"><img src="https://avatars.githubusercontent.com/u/9006720?v=4" title="petehouston" width="80" height="80"></a>
+<a href="https://github.com/Holorium"><img src="https://avatars.githubusercontent.com/u/10815542?v=4" title="Holorium" width="80" height="80"></a>
+<a href="https://github.com/jancorvus"><img src="https://avatars.githubusercontent.com/u/67001310?v=4" title="jancorvus" 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>
 
 [//]: contributor-faces
 

package/docs/advanced.md

@@ -186,7 +186,7 @@ You can use this options for build your own [plugins](https://codecept.io/hooks/
   });
 ```
 
-## Timeout <Badge text="Updated in 3.2" type="warning"/>
+## Timeout
 
 Tests can get stuck due to various reasons such as network connection issues, crashed browser, etc.
 This can make tests process hang. To prevent these situations timeouts can be used. Timeouts can be set explicitly for flaky parts of code, or implicitly in a config.
@@ -236,38 +236,62 @@ A timeout for a group of tests can be set on Feature level via options.
 Feature('flaky tests', { timeout: 30 })
 ```
 
-### Sum Up
+### Timeout Confguration 
 
-Let's list all available timeout options.
+<Badge text="Updated in 3.4" type="warning"/>
 
-Timeouts can be set globally in config:
+Timeout rules can be set globally via config.
+
+To set a timeout for all running tests provide a **number of seconds** to `timeout` config option:
 
-```js
-// in codecept.confg.js:
-{ // ...
-   timeout: 30, // limit all tests in all suites to 30 secs
-
-   plugins: {
-     stepTimeout: {
-       enabled: true,
-       timeout: 10, // limit all steps except waiters to 10 secs
-     }
-   }
-} 
 
+```js
+// inside codecept.conf.js or codecept.conf.ts
+timeout: 30, // limit all tests in all suites to 30 secs
 ```
 
-or inside a test file:
+It is possible to tune this configuration for a different groups of tests passing options as array and using `grep` option to filter tests:
 
 ```js
-// limit all tests in this suite to 10 secs
-Feature('tests with timeout', { timeout: 10 });
+// inside codecept.conf.js or codecept.conf.ts
 
-// limit this test to 20 secs
-Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {
-   // limit step to 5 seconds
-   I.limitTime(5).click('Link');
-});
+timeout: [
+  10, // default timeout is 10secs  
+
+  // but increase timeout for slow tests
+  {
+    grep: '@slow',
+    Feature: 50
+  },
+]
+```
+
+> ℹ️ `grep` value can be string or regexp
+
+It is possible to set a timeout for Scenario or Feature:
+
+```js
+// inside codecept.conf.js or codecept.conf.ts
+timeout: [
+
+  // timeout for Feature with @slow in title
+  {
+    grep: '@slow',
+    Feature: 50
+  },
+  
+  // timeout for Scenario with 'flaky0' .. `flaky1` in title
+  {
+    // regexp can be passed to grep
+    grep: /flaky[0-9]/,
+    Scenario: 10
+  },
+
+  // timeout for all suites
+  {    
+    Feature: 20
+  }
+]
 ```
 
 Global timeouts will be overridden by explicit timeouts of a test or steps.

package/docs/basics.md

@@ -345,7 +345,7 @@ If you face that error please make sure that all async functions are called with
 
 ## Running Tests
 
-To launch tests use the `run` command, and to execute tests in [multiple browsers](/advanced/#multiple-browsers-execution) or [multiple threads](/advanced/#parallel-execution) use the `run-multiple` command.
+To launch tests use the `run` command, and to execute tests in [multiple threads](/advanced/parallel) using `run-workers` command.
 
 ### Level of Detail
 
@@ -394,7 +394,7 @@ It is recommended to [filter tests by tags](/advanced/#tags).
 
 ### Parallel Run
 
-Since CodeceptJS 2.3, you can run tests in parallel by using NodeJS workers. This feature requires NodeJS >= 11.6. Use `run-workers` command with the number of workers (threads) to split tests.
+Tests can be executed in parallel mode by using [NodeJS workers](https://nodejs.org/api/worker_threads.html). Use `run-workers` command with the number of workers (threads) to split tests into different workers.
 
 ```
 npx codeceptjs run-workers 3
@@ -532,13 +532,55 @@ This can be configured in [screenshotOnFail Plugin](/plugins/#screenshotonfail)
 
 To see how the test was executed, use [stepByStepReport Plugin](/plugins/#stepbystepreport). It saves a screenshot of each passed step and shows them in a nice slideshow.
 
+## Before
+
+Common preparation steps like opening a web page or logging in a user, can be placed in the `Before` or `Background` hooks:
+
+```js
+Feature('CodeceptJS Demonstration');
+
+Before(({ I }) => { // or Background
+  I.amOnPage('/documentation');
+});
+
+Scenario('test some forms', ({ I }) => {
+  I.click('Create User');
+  I.see('User is valid');
+  I.dontSeeInCurrentUrl('/documentation');
+});
+
+Scenario('test title', ({ I }) => {
+  I.seeInTitle('Example application');
+});
+```
+
+Same as `Before` you can use `After` to run teardown for each scenario.
+
+## BeforeSuite
+
+If you need to run complex a setup before all tests and have to teardown this afterwards, you can use the `BeforeSuite` and `AfterSuite` functions.
+`BeforeSuite` and `AfterSuite` have access to the `I` object, but `BeforeSuite/AfterSuite` don't have any access to the browser, because it's not running at this moment.
+You can use them to execute handlers that will setup your environment. `BeforeSuite/AfterSuite` will work only for the file it was declared in (so you can declare different setups for files)
+
+```js
+BeforeSuite(({ I }) => {
+  I.syncDown('testfolder');
+});
+
+AfterSuite(({ I }) => {
+  I.syncUp('testfolder');
+  I.clearDir('testfolder');
+});
+```
+
 ## Retries
 
 ### Auto Retry
 
-You can auto-retry a failed step by enabling [retryFailedStep Plugin](/plugins/#retryfailedstep).
+Each failed step is auto-retried by default via [retryFailedStep Plugin](/plugins/#retryfailedstep).
+If this is not expected, this plugin can be disabled in a config. 
 
-> **[retryFailedStep plugin](/plugins/#retryfailedstep) is enabled by default** for new setups
+> **[retryFailedStep plugin](/plugins/#retryfailedstep) is enabled by default** incide global configuration
 
 ### Retry Step
 
@@ -608,69 +650,102 @@ Scenario('Really complex', { retries: 2 },({ I }) => {});
 This scenario will be restarted two times on a failure.
 Unlike retry step, there is no `when` condition supported for retries on a scenario level.
 
+### Retry Before <Badge text="Since 3.4" type="warning"/>
+
+To retry `Before`, `BeforeSuite`, `After`, `AfterSuite` hooks, add corresponding option to a `Feature`:
+
+* `retryBefore`
+* `retryBeforeSuite`
+* `retryAfter`
+* `retryAfterSuite`
+
+For instance, to retry Before hook 3 times:
+
+```js
+Feature('this have a flaky Befure', { retryBefore: 3 })
+```
+
+Multiple options of different values can be set at the same time
+
 ### Retry Feature
 
 To set this option for all scenarios in a file, add `retry` to a feature:
 
 ```js
 Feature('Complex JS Stuff').retry(3);
+// or
+Feature('Complex JS Stuff', { retries: 3 })
 ```
 
 Every Scenario inside this feature will be rerun 3 times.
 You can make an exception for a specific scenario by passing the `retries` option to a Scenario.
 
-### Retry Run 
-
-On the highest level of the "retry pyramid" there is an option to retry a complete run multiple times.
-Even this is the slowest option of all, it can be helpful to detect flaky tests. 
+### Retry Configuration <Badge text="Since 3.4" type="warning"/>
 
-[`run-rerun`](https://codecept.io/commands/#run-rerun) command will restart the run multiple times to values you provide. You can set minimal and maximal number of restarts in configuration file.
+It is possible to set retry rules globally via `retry` config option. The configuration is flexible and allows multiple formats.
+The simplest config would be:
 
+```js
+// inside codecept.conf.js
+retry: 3
 ```
-npx codeceptjs run-rerun
-```
-
 
-## Before
+This will enable Feature Retry for all executed feature, retrying failing tests 3 times.
 
-Common preparation steps like opening a web page or logging in a user, can be placed in the `Before` or `Background` hooks:
+An object can be used to tune retries of a Before/After hook, Scenario or Feature
 
 ```js
-Feature('CodeceptJS Demonstration');
+// inside codecept.conf.js
+retry: {
+  Feature: ...,
+  Scenario: ...,
+  Before: ...,
+  BeforeSuite: ...,
+  After: ...,
+  AfterSuite: ..., 
+}
+```
 
-Before(({ I }) => { // or Background
-  I.amOnPage('/documentation');
-});
+Multiple retry configs can be added via array. To use different retry configs for different subset of tests use `grep` option inside a retry config:
+
+```js
+// inside codecept.conf.js
+retry: [
+  {
+    // enable this config only for flaky tests
+    grep: '@flaky', 
+    Before: 3
+    Scenario: 3
+  }, 
+  {
+    // retry less when running slow tests
+    grep: '@slow' 
+    Scenario: 1
+    Before: 1
+  }, {
+    // retry all BeforeSuite 
+    BeforeSuite: 3
+  }
+]
+```
 
-Scenario('test some forms', ({ I }) => {
-  I.click('Create User');
-  I.see('User is valid');
-  I.dontSeeInCurrentUrl('/documentation');
-});
+When using `grep` with `Before`, `After`, `BeforeSuite`, `AfterSuite`, a suite title will be checked for included value. 
 
-Scenario('test title', ({ I }) => {
-  I.seeInTitle('Example application');
-});
-```
+> ℹ️ `grep` value can be string or regexp
 
-Same as `Before` you can use `After` to run teardown for each scenario.
+Rules are applied in the order of array element, so the last option will override a previous one. Global retries config can be overridden in a file as described previously.
 
-## BeforeSuite
+### Retry Run 
 
-If you need to run complex a setup before all tests and have to teardown this afterwards, you can use the `BeforeSuite` and `AfterSuite` functions.
-`BeforeSuite` and `AfterSuite` have access to the `I` object, but `BeforeSuite/AfterSuite` don't have any access to the browser, because it's not running at this moment.
-You can use them to execute handlers that will setup your environment. `BeforeSuite/AfterSuite` will work only for the file it was declared in (so you can declare different setups for files)
+On the highest level of the "retry pyramid" there is an option to retry a complete run multiple times.
+Even this is the slowest option of all, it can be helpful to detect flaky tests. 
 
-```js
-BeforeSuite(({ I }) => {
-  I.syncDown('testfolder');
-});
+[`run-rerun`](https://codecept.io/commands/#run-rerun) command will restart the run multiple times to values you provide. You can set minimal and maximal number of restarts in configuration file.
 
-AfterSuite(({ I }) => {
-  I.syncUp('testfolder');
-  I.clearDir('testfolder');
-});
 ```
+npx codeceptjs run-rerun
+```
+
 
 [Here are some ideas](https://github.com/codeceptjs/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
 

package/docs/best.md

@@ -74,7 +74,7 @@ When a project is growing and more and more tests are required, it's time to thi
 Here is a recommended strategy what to store where:
 
 * Move site-wide actions into an **Actor** file (`custom_steps.js` file). Such actions like `login`, using site-wide common controls, like drop-downs, rich text editors, calendars.
-* Move page-based actions and selectors into **Page Object**. All acitivities made on that page can go into methods of page object. If you test Single Page Application a PageObject should represent a screen of your application.
+* Move page-based actions and selectors into **Page Object**. All activities made on that page can go into methods of page object. If you test Single Page Application a PageObject should represent a screen of your application.
 * When site-wide widgets are used, interactions with them should be placed in **Page Fragments**. This should be applied to global navigation, modals, widgets.
 * A custom action that requires some low-level driver access, should be placed into a **Helper**. For instance, database connections, complex mouse actions, email testing, filesystem, services access.
 
@@ -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-js/faker');
+const { faker } = require('@faker-js/faker');
 const { I } = inject();
 const { output } = require('codeceptjs');
 

package/docs/build/ApiDataFactory.js

@@ -46,8 +46,8 @@ const REST = require('./REST');
  * ```js
  * // tests/factories/posts.js
  *
- * const Factory = require('rosie').Factory;
- * const faker = require('@faker-js/faker');
+ * const { Factory } = require('rosie');
+ * const { faker } = require('@faker-js/faker');
  *
  * module.exports = new Factory()
  *    // no need to set id, it will be set by REST API
@@ -262,8 +262,8 @@ class ApiDataFactory extends Helper {
    * ```
    *
    * @param {*} factory factory to use
-   * @param {*} params predefined parameters
-   * @param {*} options options for programmatically generate the attributes
+   * @param {*} [params] predefined parameters
+   * @param {*} [options] options for programmatically generate the attributes
    * @returns {Promise<*>}
    */
   have(factory, params, options) {
@@ -288,8 +288,8 @@ class ApiDataFactory extends Helper {
    *
    * @param {*} factory
    * @param {*} times
-   * @param {*} params
-   * @param {*} options
+   * @param {*} [params]
+   * @param {*} [options]
    */
   haveMultiple(factory, times, params, options) {
     const promises = [];

package/docs/build/Appium.js

@@ -1,5 +1,4 @@
 let webdriverio;
-let wdioV4;
 
 const fs = require('fs');
 const axios = require('axios').default;
@@ -131,6 +130,7 @@ class Appium extends Webdriver {
    * @augments WebDriver
    */
 
+  // @ts-ignore
   constructor(config) {
     super(config);
 
@@ -138,7 +138,6 @@ class Appium extends Webdriver {
     this.axios = axios.create();
 
     webdriverio = require('webdriverio');
-    (!webdriverio.VERSION || webdriverio.VERSION.indexOf('4') !== 0) ? wdioV4 = false : wdioV4 = true;
   }
 
   _validateConfig(config) {
@@ -516,10 +515,6 @@ class Appium extends Webdriver {
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, supportedPlatform.android);
 
-    if (wdioV4) {
-      return this.browser.removeApp(bundleId);
-    }
-
     return this.axios({
       method: 'post',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/device/remove_app`,
@@ -610,19 +605,13 @@ class Appium extends Webdriver {
    */
   async seeOrientationIs(orientation) {
     onlyForApps.call(this);
-    let currentOrientation;
-
-    if (wdioV4) {
-      const res = await this.browser.orientation();
-      currentOrientation = res;
-    }
 
     const res = await this.axios({
       method: 'get',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
     });
 
-    currentOrientation = res.data.value;
+    const currentOrientation = res.data.value;
     return truth('orientation', `to be ${orientation}`).assert(currentOrientation === orientation);
   }
 
@@ -640,9 +629,6 @@ class Appium extends Webdriver {
    */
   async setOrientation(orientation) {
     onlyForApps.call(this);
-    if (wdioV4) {
-      return this.browser.setOrientation(orientation);
-    }
 
     return this.axios({
       method: 'post',
@@ -916,9 +902,6 @@ class Appium extends Webdriver {
    */
   async sendDeviceKeyEvent(keyValue) {
     onlyForApps.call(this, supportedPlatform.android);
-    if (wdioV4) {
-      return this.browser.sendKeyEvent(keyValue);
-    }
     return this.browser.pressKeyCode(keyValue);
   }
 

package/docs/build/FileSystem.js

@@ -71,10 +71,10 @@ class FileSystem extends Helper {
   }
 
   /**
-   * Waits for file to be present in current directory.
+   * Waits for the file to be present in the current directory.
    *
    * ```js
-   * I.handleDownloads();
+   * I.handleDownloads('downloads/largeFilesName.txt');
    * I.click('Download large File');
    * I.amInPath('output/downloads');
    * I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file

package/docs/build/GraphQLDataFactory.js

@@ -46,8 +46,8 @@ const GraphQL = require('./GraphQL');
  * ```js
  * // tests/factories/users.js
  *
- * const Factory = require('rosie').Factory;
- * const faker = require('@faker-js/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/Playwright.js

@@ -66,6 +66,7 @@ const pathSeparator = path.sep;
  * @prop {boolean} [video=false] - enables video recording for failed tests; videos are saved into `output/videos` folder
  * @prop {boolean} [keepVideoForPassedTests=false] - save videos for passed tests; videos are saved into `output/videos` folder
  * @prop {boolean} [trace=false] - record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
+ * @prop {boolean} [keepTraceForPassedTests=false] - save trace for passed tests.
  * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
  * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
  * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to 'session'.
@@ -1413,7 +1414,7 @@ class Playwright extends Helper {
    *
    * ```
    *
-   * @param {string} [fileName] set filename for downloaded file
+   * @param {string} fileName set filename for downloaded file
    * @return {Promise<void>}
    */
   async handleDownloads(fileName) {
@@ -3968,7 +3969,7 @@ async function refreshContextSession() {
 
 async function saveVideoForPage(page, name) {
   if (!page.video()) return null;
-  const fileName = `${global.output_dir}${pathSeparator}videos${pathSeparator}${Date.now()}_${clearString(name).slice(0, 245)}.webm`;
+  const fileName = `${`${global.output_dir}${pathSeparator}videos${pathSeparator}${Date.now()}_${clearString(name)}`.slice(0, 245)}.webm`;
   page.video().saveAs(fileName).then(() => {
     if (!page) return;
     page.video().delete().catch(e => {});