CHANGELOG.md

## 3.7.5

❤️ Thanks all to those who contributed to make this release! ❤️

## ✨ Features

- feat: Add configurable sensitive data masking with custom patterns (#5109)

### Backward Compatible Boolean Configuration

```js
// codecept.conf.js
exports.config = {
  maskSensitiveData: true, // Uses built-in patterns for common sensitive data
  // ... other config
}
```

### Advanced Custom Patterns Configuration

```js
// codecept.conf.js
exports.config = {
  maskSensitiveData: {
    enabled: true,
    patterns: [
      {
        name: 'Email',
        regex: /(\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b)/gi,
        mask: '[MASKED_EMAIL]'
      },
      {
        name: 'Credit Card',
        regex: /\b(?:\d{4}[- ]?){3}\d{4}\b/g,
        mask: '[MASKED_CARD]'
      },
      {
        name: 'Phone Number',
        regex: /(\+?1[-.\s]?)?\(?([0-9]{3})\)?[-.\s]?([0-9]{3})[-.\s]?([0-9]{4})/g,
        mask: '[MASKED_PHONE]'
      }
    ]
  },
  // ... other config
}

## Example Output

With the above configuration, sensitive data is automatically masked:

**Before:**

Given I have user email "john.doe@company.com"
And I have credit card "4111 1111 1111 1111"
And I have phone number "+1-555-123-4567"


**After:**

Given I have user email "[MASKED_EMAIL]"
And I have credit card "[MASKED_CARD]"
And I have phone number "[MASKED_PHONE]"
```

- feat(playwright): Add Custom Strategy Locators support (#5090)

```js
exports.config = {
  helpers: {
    Playwright: {
      url: 'http://localhost',
      browser: 'chromium',
      customLocatorStrategies: {
        byRole: (selector, root) => {
          return root.querySelector(`[role="${selector}"]`);
        },
        byTestId: (selector, root) => {
          return root.querySelector(`[data-testid="${selector}"]`);
        },
        byDataQa: (selector, root) => {
          const elements = root.querySelectorAll(`[data-qa="${selector}"]`);
          return Array.from(elements); // Return array for multiple elements
        }
      }
    }
  }
}

And used in tests with the same syntax as other locator types:

I.click({byRole: 'button'});           // Find by role attribute
I.see('Welcome', {byTestId: 'title'}); // Find by data-testid
I.fillField({byDataQa: 'email'}, 'test@example.com');
```

- feat(reporter): Enable HTML reporter by default in new projects (#5105)

```
plugins: {
  htmlReporter: {
    enabled: true
  }
}
```

![HTML report](https://github.com/codeceptjs/CodeceptJS/raw/3.x/docs/shared/html-reporter-main-dashboard.png)

- feat(cli): make test file hyperlink clickable (#5078) - by @kobenguyent
  ![test file hyperlink clickable](https://private-user-images.githubusercontent.com/7845001/479922301-a2a21480-00d8-4508-8bf6-d4bf5630e06a.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NTg1MzA1MTUsIm5iZiI6MTc1ODUzMDIxNSwicGF0aCI6Ii83ODQ1MDAxLzQ3OTkyMjMwMS1hMmEyMTQ4MC0wMGQ4LTQ1MDgtOGJmNi1kNGJmNTYzMGUwNmEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDkyMiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTA5MjJUMDgzNjU1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZDE2OGE2YTY5NGZiNmU1NWU2YjA0NmI1ZTZhN2M0MTgzODE3MDNhYTZiM2IzMGU0Y2U1NzY3OWNmNDVlZjJjNSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.iyq8LmTLSwoYIoCY4lBAIQRFGAEBYSq3JTO9ePfNWBg)

- feat: Introduce CodeceptJS WebElement Class to mirror helpers’ element instance (#5091)

### Unified API Methods

- **Element Properties**: `getText()`, `getAttribute()`, `getProperty()`, `getInnerHTML()`, `getValue()`
- **Element State**: `isVisible()`, `isEnabled()`, `exists()`, `getBoundingBox()`
- **Element Interactions**: `click()`, `type()`
- **Child Element Search**: `$()` and `$$()` methods for finding sub-elements
- **Native Access**: `getNativeElement()` and `getHelper()` for advanced operations

### Updated Helper Methods

- `grabWebElement()` and `grabWebElements()` now return `WebElement` instances instead of native elements
- Added missing `grabWebElement()` method to WebDriver and Puppeteer helpers
- Maintains backward compatibility through `getNativeElement()` method

```
// Works consistently across all helpers
const element = await I.grabWebElement('#button');
const text = await element.getText();
const childElements = await element.$$('.child');
await element.click();

// Element searching within elements
const form = await I.grabWebElement('#contact-form');
const nameInput = await form.$('#name');
await nameInput.type('John Doe');
```

- feat: support `feature.only` like `Scenario.only` (#5087)
  Example:

  ```js
  Feature.only('Checkout Flow', () => {
    Scenario('complete order', ({ I }) => {
      // test steps here
    })
  })
  ```

---

## 🐛 Bug Fixes

- fix(utils): resolve command injection vulnerability in `emptyFolder` (#5190) - by @mhassan1
- bugfix: prevent WebDriver error without Bidi protocol (#5095) - by @ngraf
- fix(playwright): relaunch browser correctly with `restart: 'session'` in `run-workers --by pool` (#5118) - by @Samuel-StO
- fix: JSONResponse helper to preserve original `onResponse` behavior (#5106) - by @myprivaterepo
- fix: use `platformName` for mobile click detection (Android touchClick bug) (#5107) - by @mirao
- fix: Properly stop network traffic recording (#5127) - by @Samuel-StO
- fix: mocha retries losing CodeceptJS-specific properties (#5099)
- fix: missing `codeceptjs/effects` types (#5094) - by @kobenguyent
- fix: tryTo steps appearing in test failure traces (#5088)
- fix: JUnit XML test case name inconsistency with retries (#5082)
- fix: waitForText timeout regression in Playwright helper (#5093)
- fix(Playwright): I.waitForText() caused unexpected delay (#5077)
- fix: I.seeResponseContainsJson not working (#5081)

## 3.7.4

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- **Test Suite Shuffling**: Randomize test execution order to discover test dependencies and improve test isolation (#5051) - by @NivYarmus

  ```bash
  # Shuffle tests to find order-dependent failures using lodash.shuffle algorithm
  npx codeceptjs run --shuffle

  # Combined with grep and other options
  npx codeceptjs run --shuffle --grep "@smoke" --steps
  ```

- **Enhanced Interactive Debugging**: Better logging for `I.grab*` methods in live interactive mode for clearer debugging output (#4986) - by @owenizedd

  ```js
  // Interactive pause() now shows detailed grab results with JSON formatting
  I.amOnPage('/checkout')
  pause()  // Interactive shell started
  > I.grabTextFrom('.price')
  Result $res= "Grabbed text: $29.99"  // Pretty-printed JSON output
  > I.grabValueFrom('input[name="email"]')
  {"value":"user@example.com"}  // Structured JSON response
  ```

  🐛 _Bug Fixes_

- **Playwright Session Traces**: Fixed trace file naming convention and improved error handling for multi-session test scenarios (#5073) - by @julien-ft-64 @kobenguyent

  ```js
  // Example outputs:
  // - a1b2c3d4-e5f6_checkout_login_test.failed.zip
  // - b2c3d4e5-f6g7_admin_dashboard_test.failed.zip
  ```

  _Trace files use UUID prefixes with `sessionName_testTitle.status.zip` format_

- **Worker Data Injection**: Resolved proxy object serialization preventing data sharing between parallel test workers (#5072) - by @kobenguyent

  ```js
  // Fixed: Complex objects can now be properly shared and injected between workers
  // Bootstrap data sharing in codecept.conf.js:
  exports.config = {
    bootstrap() {
      share({
        userData: { id: 123, preferences: { theme: 'dark' } },
        apiConfig: { baseUrl: 'https://api.test.com', timeout: 5000 },
      })
    },
  }

  // In tests across different workers:
  const testData = inject()
  console.log(testData.userData.preferences.theme) // 'dark' - deep nesting works
  console.log(Object.keys(testData)) // ['userData', 'apiConfig'] - key enumeration works

  // Dynamic sharing during test execution:
  share({ newData: 'shared across workers' })
  ```

- **Hook Exit Codes**: Fixed improper exit codes when test hooks fail, ensuring CI/CD pipelines properly detect failures (#5058) - by @kobenguyent

  ```bash
  # Before: Exit code 0 even when beforeEach/afterEach failed
  # After: Exit code 1 when any hook fails, properly failing CI builds
  ```

- **TypeScript Effects Support**: Added complete TypeScript definitions for effects functionality (#5027) - by @kobenguyent

  ```typescript
  // Import effects with full TypeScript type definitions
  import { tryTo, retryTo, within } from 'codeceptjs/effects'

  // tryTo returns Promise<boolean> for conditional actions
  const success: boolean = await tryTo(async () => {
    await I.see('Cookie banner')
    await I.click('Accept')
  })

  // retryTo with typed parameters for reliability
  await retryTo(() => {
    I.click('Submit')
    I.see('Success')
  }, 3) // retry up to 3 times
  ```

  _Note: Replaces deprecated global plugins - import from 'codeceptjs/effects' module_

- **Mochawesome Screenshot Uniqueness**: Fixed screenshot naming to prevent test failures from being overwritten when multiple tests run at the same time (#4959) - by @Lando1n

  ```js
  // Problem: When tests run in parallel, screenshots had identical names
  // This caused later test screenshots to overwrite earlier ones

  // Before: All failed tests saved as "screenshot.png"
  // Result: Only the last failure screenshot was kept

  // After: Each screenshot gets a unique name with timestamp
  // Examples:
  // - "login_test_1645123456.failed.png"
  // - "checkout_test_1645123789.failed.png"
  // - "profile_test_1645124012.failed.png"

  // Configuration in codecept.conf.js:
  helpers: {
    Mochawesome: {
      uniqueScreenshotNames: true // Enable unique naming
    }
  }
  ```

  _Ensures every failed test keeps its own screenshot for easier debugging_

📖 _Documentation_

- Fixed Docker build issues and improved container deployment process (#4980) - by @thomashohn
- Updated dependency versions to maintain security and compatibility (#4957, #4950, #4943) - by @thomashohn
- Fixed automatic documentation generation system for custom plugins (#4973) - by @Lando1n

## 3.7.3

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(cli): improve info command to return installed browsers (#4890) - by @kobenguyent

```
➜  helloworld npx codeceptjs info
Environment information:

codeceptVersion:  "3.7.2"
nodeInfo:  18.19.0
osInfo:  macOS 14.4
cpuInfo:  (8) x64 Apple M1 Pro
osBrowsers:  "chrome: 133.0.6943.143, edge: 133.0.3065.92, firefox: not installed, safari: 17.4"
playwrightBrowsers:  "chromium: 133.0.6943.16, firefox: 134.0, webkit: 18.2"
helpers:  {
"Playwright": {
"url": "http://localhost",
...
```

🐛 _Bug Fixes_

- fix: resolving path inconsistency in container.js and appium.js (#4866) - by @mjalav
- fix: broken screenshot links in mochawesome reports (#4889) - by @kobenguyent
- some internal fixes to make UTs more stable by @thomashohn
- dependencies upgrades by @thomashohn

## 3.7.2

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(playwright): Clear cookie by name (#4693) - by @ngraf

🐛 _Bug Fixes_

- fix(stepByStepReport): no records html is generated when running with run-workers (#4638)
- fix(webdriver): bidi error in log with webdriver (#4850)
- fix(types): TS types of methods (Feature|Scenario)Config.config (#4851)
- fix: redundant popup log (#4830)
- fix(webdriver): grab browser logs using bidi protocol (#4754)
- fix(webdriver): screenshots for sessions (#4748)

📖 _Documentation_

- fix(docs): mask sensitive data (#4636) - by @gkushang

## 3.7.1

- Fixed `reading charAt` error in `asyncWrapper.js`

## 3.7.0

This release introduces major new features and internal refactoring. It is an important step toward the 4.0 release planned soon, which will remove all deprecations introduced in 3.7.

🛩️ _Features_

### 🔥 **Native Element Functions**

A new [Els API](/els) for direct element interactions has been introduced. This API provides low-level element manipulation functions for more granular control over element interactions and assertions:

- `element()` - perform custom operations on first matching element
- `eachElement()` - iterate and perform operations on each matching element
- `expectElement()` - assert condition on first matching element
- `expectAnyElement()` - assert condition matches at least one element
- `expectAllElements()` - assert condition matches all elements

Example using all element functions:

```js
const { element, eachElement, expectElement, expectAnyElement, expectAllElements } = require('codeceptjs/els')

// ...

Scenario('element functions demo', async ({ I }) => {
  // Get attribute of first button
  const attr = await element('.button', async el => await el.getAttribute('data-test'))

  // Log text of each list item
  await eachElement('.list-item', async (el, idx) => {
    console.log(`Item ${idx}: ${await el.getText()}`)
  })

  // Assert first submit button is enabled
  await expectElement('.submit', async el => await el.isEnabled())

  // Assert at least one product is in stock
  await expectAnyElement('.product', async el => {
    return (await el.getAttribute('data-status')) === 'in-stock'
  })

  // Assert all required fields have required attribute
  await expectAllElements('.required', async el => {
    return (await el.getAttribute('required')) !== null
  })
})
```

[Els](/els) functions expose the native API of Playwright, WebDriver, and Puppeteer helpers. The actual `el` API will differ depending on which helper is used, which affects test code interoperability.

### 🔮 **Effects introduced**

[Effects](/effects) is a new concept that encompasses all functions that can modify scenario flow. These functions are now part of a single module. Previously, they were used via plugins like `tryTo` and `retryTo`. Now, it is recommended to import them directly:

```js
const { tryTo, retryTo } = require('codeceptjs/effects')

Scenario(..., ({ I }) => {
  I.amOnPage('/')
  // tryTo returns boolean if code in function fails
  // use it to execute actions that may fail but not affect the test flow
  // for instance, for accepting cookie banners
  const isItWorking = tryTo(() => I.see('It works'))

  // run multiple steps and retry on failure
  retryTo(() => {
    I.click('Start Working!');
    I.see('It works')
  }, 5);
})
```

Previously `tryTo` and `retryTo` were available globally via plugins. This behavior is deprecated as of 3.7 and will be removed in 4.0. Import these functions via effects instead. Similarly, `within` will be moved to `effects` in 4.0.

### ✅ `check` command added

```
npx codeceptjs check
```

This command can be executed locally or in CI environments to verify that tests can be executed correctly.

It checks:

- configuration
- tests
- helpers

And will attempt to open and close a browser if a corresponding helper is enabled. If something goes wrong, the command will fail with a message. Run `npx codeceptjs check` on CI before actual tests to ensure everything is set up correctly and all services and browsers are accessible.

For GitHub Actions, add this command:

```yaml
steps:
  # ...
  - name: check configuration and browser
    run: npx codeceptjs check

  - name: run codeceptjs tests
    run: npx codeceptjs run-workers 4
```

### 👨‍🔬 **analyze plugin introduced**

This [AI plugin](./plugins#analyze) analyzes failures in test runs and provides brief summaries. For more than 5 failures, it performs cluster analysis and aggregates failures into groups, attempting to find common causes. It is recommended to use Deepseek R1 model or OpenAI o3 for better reasoning on clustering:

```js
• SUMMARY The test failed because the expected text "Sign in" was not found on the page, indicating a possible issue with HTML elements or their visibility.
• ERROR expected web application to include "Sign in"
• CATEGORY HTML / page elements (not found, not visible, etc)
• URL http://127.0.0.1:3000/users/sign_in
```

For fewer than 5 failures, they are analyzed individually. If a visual recognition model is connected, AI will also scan screenshots to suggest potential failure causes (missing button, missing text, etc).

This plugin should be paired with the newly added [`pageInfo` plugin](./plugins/#pageInfo) which stores important information like URL, console logs, and error classes for further analysis.

### 👨‍💼 **autoLogin plugin** renamed to **auth plugin**

[`auth`](/plugins#auth) is the new name for the autoLogin plugin and aims to solve common authorization issues. In 3.7 it can use Playwright's storage state to load authorization cookies in a browser on start. So if a user is already authorized, a browser session starts with cookies already loaded for this user. If you use Playwright, you can enable this behavior using the `loginAs` method inside a `BeforeSuite` hook:

```js
BeforeSuite(({ loginAs }) => loginAs('user'))
```

The previous behavior where `loginAs` was called from a `Before` hook also works. However, cookie loading and authorization checking is performed after the browser starts.

#### Metadata introduced

Meta information in key-value format can be attached to Scenarios to provide more context when reporting tests:

```js
// add Jira issue to scenario
Scenario('...', () => {
  // ...
}).meta('JIRA', 'TST-123')

// or pass meta info in the beginning of scenario:
Scenario('my test linked to Jira', meta: { issue: 'TST-123' }, () => {
  // ...
})
```

By default, Playwright helpers add browser and window size as meta information to tests.

### 👢 Custom Steps API

Custom Steps or Sections API introduced to group steps into sections:

```js
const { Section } = require('codeceptjs/steps');

Scenario({ I } => {
  I.amOnPage('/projects');

  // start section "Create project"
  Section('Create a project');
  I.click('Create');
  I.fillField('title', 'Project 123')
  I.click('Save')
  I.see('Project created')
  // calling Section with empty param closes previous section
  Section()

  // previous section automatically closes
  // when new section starts
  Section('open project')
  // ...
});
```

To hide steps inside a section from output use `Section().hidden()` call:

```js
Section('Create a project').hidden()
// next steps are not printed:
I.click('Create')
I.fillField('title', 'Project 123')
Section()
```

Alternative syntax for closing section: `EndSection`:

```js
const { Section, EndSection } = require('codeceptjs/steps');

// ...
Scenario(..., ({ I }) =>  // ...

  Section('Create a project').hidden()
  // next steps are not printed:
  I.click('Create');
  I.fillField('title', 'Project 123')
  EndSection()
```

Also available BDD-style pre-defined sections:

```js
const { Given, When, Then } = require('codeceptjs/steps');

// ...
Scenario(..., ({ I }) =>  // ...

  Given('I have a project')
  // next steps are not printed:
  I.click('Create');
  I.fillField('title', 'Project 123')

  When('I open project');
  // ...

  Then('I should see analytics in a project')
  //....
```

### 🥾 Step Options

Better syntax to set general step options for specific tests.

Use it to set timeout or retries for specific steps:

```js
const step = require('codeceptjs/steps');

Scenario(..., ({ I }) =>  // ...
  I.click('Create', step.timeout(10).retry(2));
  //....
```

Alternative syntax:

```js
const { stepTimeout, stepRetry } = require('codeceptjs/steps');

Scenario(..., ({ I }) =>  // ...
  I.click('Create', stepTimeout(10));
  I.see('Created', stepRetry(2));
  //....
```

This change deprecates previous syntax:

- `I.limitTime().act(...)` => replaced with `I.act(..., stepTimeout())`
- `I.retry().act(...)` => replaced with `I.act(..., stepRetry())`

Step options should be passed as the very last argument to `I.action()` call.

Step options can be used to pass additional options to currently existing methods:

```js
const { stepOpts } = require('codeceptjs/steps')

I.see('SIGN IN', stepOpts({ ignoreCase: true }))
```

Currently this works only on `see` and only with `ignoreCase` param.
However, this syntax will be extended in next versions.

### Test object can be injected into Scenario

API for direct access to test object inside Scenario or hooks to add metadata or artifacts:

```js
BeforeSuite(({ suite }) => {
  // no test object here, test is not created yet
})

Before(({ test }) => {
  // add artifact to test
  test.artifacts.myScreenshot = 'screenshot'
})

Scenario('test store-test-and-suite test', ({ test }) => {
  // add custom meta data
  test.meta.browser = 'chrome'
})

After(({ test }) => {})
```

Object for `suite` is also injected for all Scenario and hooks.

### Notable changes

- Load official Gherkin translations into CodeceptJS. See #4784 by @ebo-zig
- 🇳🇱 `NL` translation introduced by @ebo-zig in #4784:
- [Playwright] Improved experience to highlight and print elements in debug mode
- `codeceptjs run` fails on CI if no tests were executed. This helps to avoid false positive checks. Use `DONT_FAIL_ON_EMPTY_RUN` env variable to disable this behavior
- Various console output improvements
- AI suggested fixes from `heal` plugin (which heals failing tests on the fly) shown in `run-workers` command
- `plugin/standatdActingHelpers` replaced with `Container.STANDARD_ACTING_HELPERS`

### 🐛 _Bug Fixes_

- Fixed timeouts for `BeforeSuite` and `AfterSuite`
- Fixed stucking process on session switch

### 🎇 Internal Refactoring

This section is listed briefly. A new dedicated page for internal API concepts will be added to documentation

- File structure changed:
  - mocha classes moved to `lib/mocha`
  - step is split to multiple classes and moved to `lib/step`
- Extended and exposed to public API classes for Test, Suite, Hook
  - [Test](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/test.js)
  - [Suite](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/suite.js)
  - [Hook](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/mocha/hooks.js) (Before, After, BeforeSuite, AfterSuite)
- Container:
  - refactored to be prepared for async imports in ESM.
  - added proxy classes to resolve circular dependencies
- Step
  - added different step types [`HelperStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/helper.js), [`MetaStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/meta.js), [`FuncStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/func.js), [`CommentStep`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/step/comment.js)
  - added `step.addToRecorder()` to schedule test execution as part of global promise chain
- [Result object](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/result.js) added
  - `event.all.result` now sends Result object with all failures and stats included
- `run-workers` refactored to use `Result` to send results from workers to main process
- Timeouts refactored `listener/timeout` => [`globalTimeout`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/listener/globalTimeout.js)
- Reduced usages of global variables, more attributes added to [`store`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/store.js) to share data on current state between different parts of system
- `events` API improved
  - Hook class is sent as param for `event.hook.passed`, `event.hook.finished`
  - `event.test.failed`, `event.test.finished` always sends Test. If test has failed in `Before` or `BeforeSuite` hook, event for all failed test in this suite will be sent
  - if a test has failed in a hook, a hook name is sent as 3rd arg to `event.test.failed`

---

## 3.6.10

❤️ Thanks all to those who contributed to make this release! ❤️

🐛 _Bug Fixes_
fix(cli): missing failure counts when there is failedHooks (#4633) - by @kobenguyent

## 3.6.9

❤️ Thanks all to those who contributed to make this release! ❤️

🐛 _Hot Fixes_
fix: could not run tests due to missing `invisi-data` lib - by @kobenguyent

## 3.6.8

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(cli): mask sensitive data in logs (#4630) - by @kobenguyent

```
export const config: CodeceptJS.MainConfig = {
  tests:  '**/*.e2e.test.ts',
  retry: 4,
  output: './output',
  maskSensitiveData: true,
  emptyOutputFolder: true,
...

    I login {"username":"helloworld@test.com","password": "****"}
      I send post request "https://localhost:8000/login", {"username":"helloworld@test.com","password": "****"}
      › [Request] {"baseURL":"https://localhost:8000/login","method":"POST","data":{"username":"helloworld@test.com","password": "****"},"headers":{}}
      › [Response] {"access-token": "****"}
```

- feat(REST): DELETE request supports payload (#4493) - by @schaudhary111

```js
I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' })
```

🐛 _Bug Fixes_

- fix(playwright): Different behavior of see* and waitFor* when used in within (#4557) - by @kobenguyent
- fix(cli): dry run returns no tests when using a regex grep (#4608) - by @kobenguyent

```bash
> codeceptjs dry-run --steps --grep "(?=.*Checkout process)"
```

- fix: Replace deprecated faker.name with faker.person (#4581) - by @thomashohn
- fix(wdio): Remove dependency to devtools (#4563) - by @thomashohn
- fix(typings): wrong defineParameterType (#4548) - by @kobenguyent
- fix(typing): `Locator.build` complains the empty locator (#4543) - by @kobenguyent
- fix: add hint to `I.seeEmailAttachment` treats parameter as regular expression (#4629) - by @ngraf

```
Add hint to "I.seeEmailAttachment" that under the hood parameter is treated as RegExp.
When you don't know it, it can cause a lot of pain, wondering why your test fails with I.seeEmailAttachment('Attachment(1).pdf') although it looks just fine, but actually I.seeEmailAttachment('Attachment\\(1\\).pdf is required to make the test green, in case the attachment is called "Attachment(1).pdf" with special character in it.
```

- fix(playwright): waitForText fails when text contains double quotes (#4528) - by @DavertMik
- fix(mock-server-helper): move to stand-alone package: https://www.npmjs.com/package/@codeceptjs/mock-server-helper (#4536) - by @kobenguyent
- fix(appium): issue with async on runOnIos and runOnAndroid (#4525) - by @kobenguyent
- fix: push ws messages to array (#4513) - by @kobenguyent

📖 _Documentation_

- fix(docs): typo in ai.md (#4501) - by @tomaculum

## 3.6.6

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(locator): add withAttrEndsWith, withAttrStartsWith, withAttrContains (#4334) - by @Maksym-Artemenko
- feat: soft assert (#4473) - by @kobenguyent
  - Soft assert

Zero-configuration when paired with other helpers like REST, Playwright:

```js
// inside codecept.conf.js
{
  helpers: {
    Playwright: {...},
    SoftExpectHelper: {},
  }
}
```

```js
// in scenario
I.softExpectEqual('a', 'b')
I.flushSoftAssertions() // Throws an error if any soft assertions have failed. The error message contains all the accumulated failures.
```

- feat(cli): print failed hooks (#4476) - by @kobenguyent
  - run command
    ![Screenshot 2024-09-02 at 15 25 20](https://github.com/user-attachments/assets/625c6b54-03f6-41c6-9d0c-cd699582404a)

  - run workers command
    ![Screenshot 2024-09-02 at 15 24 53](https://github.com/user-attachments/assets/efff0312-1229-44b6-a94f-c9b9370b9a64)

🐛 _Bug Fixes_

- fix(AI): minor AI improvements - by @DavertMik
- fix(AI): add missing await in AI.js (#4486) - by @tomaculum
- fix(playwright): no async save video page (#4472) - by @kobenguyent
- fix(rest): httpAgent condition (#4484) - by @kobenguyent
- fix: DataCloneError error when `I.executeScript` command is used with `run-workers` (#4483) - by @code4muktesh
- fix: no error thrown from rerun script (#4494) - by @lin-brian-l

```js
// fix the validation of httpAgent config. we could now pass ca, instead of key/cert.
{
  helpers: {
    REST: {
      endpoint: 'http://site.com/api',
      prettyPrintJson: true,
      httpAgent: {
         ca: fs.readFileSync(__dirname + '/path/to/ca.pem'),
         rejectUnauthorized: false,
         keepAlive: true
      }
    }
  }
}
```

📖 _Documentation_

- doc(AI): minor AI improvements - by @DavertMik

## 3.6.5

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(helper): playwright > wait for disabled (#4412) - by @kobenguyent

```
it('should wait for input text field to be disabled', () =>
      I.amOnPage('/form/wait_disabled').then(() => I.waitForDisabled('#text', 1)))

    it('should wait for input text field to be enabled by xpath', () =>
      I.amOnPage('/form/wait_disabled').then(() => I.waitForDisabled("//*[@name = 'test']", 1)))

    it('should wait for a button to be disabled', () =>
      I.amOnPage('/form/wait_disabled').then(() => I.waitForDisabled('#text', 1)))

Waits for element to become disabled (by default waits for 1sec).
Element can be located by CSS or XPath.

@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
@returns {void} automatically synchronized promise through #recorder
```

🐛 _Bug Fixes_

- fix(AI): AI is not triggered (#4422) - by @kobenguyent
- fix(plugin): stepByStep > report doesn't sync properly (#4413) - by @kobenguyent
- fix: Locator > Unsupported pseudo selector 'has' (#4448) - by @anils92

📖 _Documentation_

- docs: setup azure open ai using bearer token (#4434) - by @kobenguyent

## 3.6.4

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(rest): print curl (#4396) - by @kobenguyent

```
Config:

...
REST: {
 ...
 printCurl: true,
 ...
}
...

› [CURL Request] curl --location --request POST https://httpbin.org/post -H ...
```

- feat(AI): Generate PageObject, added types, shell improvement (#4319) - by @DavertMik
  - added `askForPageObject` method to generate PageObjects on the fly
  - improved AI types
  - interactive shell improved to restore history

![Screenshot from 2024-06-17 02-47-37](https://github.com/codeceptjs/CodeceptJS/assets/220264/12acd2c7-18d1-4105-a24b-84070ec4d393)

🐛 _Bug Fixes_

- fix(heal): wrong priority (#4394) - by @kobenguyent

📖 _Documentation_

- AI docs improvements by @DavertMik

## 3.6.3

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(plugin): coverage with WebDriver - devtools (#4349) - by @KobeNguyent
  ![Screenshot 2024-05-16 at 16 49 20](https://github.com/codeceptjs/CodeceptJS/assets/7845001/a02f0f99-ac78-4d3f-9774-2cb51c688025)

🐛 _Bug Fixes_

- fix(cli): stale process (#4367) - by @Horsty80 @kobenguyent
- fix(runner): screenshot error in beforeSuite/AfterSuite (#4385) - by @kobenguyent
- fix(cli): gherkin command init with TypeScript (#4366) - by @andonary
- fix(webApi): error message of dontSeeCookie (#4357) - by @a-stankevich

📖 _Documentation_

- fix(doc): Expect helper is not described correctly (#4370) - by @kobenguyent
- fix(docs): some strange characters (#4387) - by @kobenguyent
- fix: Puppeteer helper doc typo (#4369) - by @yoannfleurydev

## 3.6.2

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat(REST): support httpAgent conf (#4328) - by @KobeNguyent

Support the httpAgent conf to create the TSL connection via REST helper

```
{
  helpers: {
    REST: {
      endpoint: 'http://site.com/api',
      prettyPrintJson: true,
      httpAgent: {
         key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
         cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
         rejectUnauthorized: false,
         keepAlive: true
      }
    }
  }
}
```

- feat(wd): screenshots for sessions (#4322) - by @KobeNguyent

Currently only screenshot of the active session is saved, this PR aims to save the screenshot of every session for easy debugging

```
Scenario('should save screenshot for sessions @WebDriverIO @Puppeteer @Playwright', async ({ I }) => {
  await I.amOnPage('/form/bug1467');
  await I.saveScreenshot('original.png');
  await I.amOnPage('/');
  await I.saveScreenshot('main_session.png');
  session('john', async () => {
    await I.amOnPage('/form/bug1467');
    event.dispatcher.emit(event.test.failed, this);
  });

  const fileName = clearString('should save screenshot for active session @WebDriverIO @Puppeteer @Playwright');
  const [original, failed] = await I.getSHA256Digests([
    `${output_dir}/original.png`,
    `${output_dir}/john_${fileName}.failed.png`,
  ]);

  // Assert that screenshots of same page in same session are equal
  await I.expectEqual(original, failed);

  // Assert that screenshots of sessions are created
  const [main_original, session_failed] = await I.getSHA256Digests([
    `${output_dir}/main_session.png`,
    `${output_dir}/john_${fileName}.failed.png`,
  ]);
  await I.expectNotEqual(main_original, session_failed);
});
```

![Screenshot 2024-04-29 at 11 07 47](https://github.com/codeceptjs/CodeceptJS/assets/7845001/5dddf85a-ed77-474b-adfd-2f208d3c16a8)

- feat: locate element with withClassAttr (#4321) - by @KobeNguyent

Find an element with class attribute

```js
// find div with class contains 'form'
locate('div').withClassAttr('text')
```

- fix(playwright): set the record video resolution (#4311) - by @KobeNguyent
  You could now set the recording video resolution

```
  url: siteUrl,
  windowSize: '300x500',
  show: false,
  restart: true,
  browser: 'chromium',
  trace: true,
  video: true,
  recordVideo: {
    size: {
      width: 400,
      height: 600,
    },
  },
```

🐛 _Bug Fixes_

- fix: several issues of stepByStep report (#4331) - by @KobeNguyent

📖 _Documentation_

- fix: wrong format docs (#4330) - by @KobeNguyent
- fix(docs): wrong method is mentioned (#4320) - by @KobeNguyent
- fix: ChatGPT docs - by @davert

## 3.6.1

- Fixed regression in interactive pause.

## 3.6.0

🛩️ _Features_

- Introduced [healers](./heal) to improve stability of failed tests. Write functions that can perform actions to fix a failing test:

```js
heal.addRecipe('reloadPageIfModalIsNotVisisble', {
  steps: ['click'],
  fn: async ({ error, step }) => {
    // this function will be executed only if test failed with
    // "model is not visible" message
    if (error.message.include('modal is not visible')) return

    // we return a function that will refresh a page
    // and tries to perform last step again
    return async ({ I }) => {
      I.reloadPage()
      I.wait(1)
      await step.run()
    }
    // if a function succeeds, test continues without an error
  },
})
```

- **Breaking Change** **AI** features refactored. Read updated [AI guide](./ai):
  - **removed dependency on `openai`**
  - added support for **Azure OpenAI**, **Claude**, **Mistal**, or any AI via custom request function
  - `--ai` option added to explicitly enable AI features
  - heal plugin decoupled from AI to run custom heal recipes
  - improved healing for async/await scenarios
  - token limits added
  - token calculation introduced
  - `OpenAI` helper renamed to `AI`

- feat(puppeteer): network traffic manipulation. See #4263 by @KobeNguyenT
  - `startRecordingTraffic`
  - `grabRecordedNetworkTraffics`
  - `flushNetworkTraffics`
  - `stopRecordingTraffic`
  - `seeTraffic`
  - `dontSeeTraffic`

- feat(Puppeteer): recording WS messages. See #4264 by @KobeNguyenT

Recording WS messages:

```
      I.startRecordingWebSocketMessages();
      I.amOnPage('https://websocketstest.com/');
      I.waitForText('Work for You!');
      const wsMessages = I.grabWebSocketMessages();
      expect(wsMessages.length).to.greaterThan(0);
```

flushing WS messages:

```
      I.startRecordingWebSocketMessages();
      I.amOnPage('https://websocketstest.com/');
      I.waitForText('Work for You!');
      I.flushWebSocketMessages();
      const wsMessages = I.grabWebSocketMessages();
      expect(wsMessages.length).to.equal(0);
```

Examples:

```js
// recording traffics and verify the traffic
I.startRecordingTraffic()
I.amOnPage('https://codecept.io/')
I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' })
```

```js
// check the traffic with advanced params
I.amOnPage('https://openai.com/blog/chatgpt')
I.startRecordingTraffic()
I.seeTraffic({
  name: 'sentry event',
  url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
  parameters: {
    width: '1919',
    height: '1138',
  },
})
```

- Introduce the playwright locator: `_react`, `_vue`, `data-testid` attribute. See #4255 by @KobeNguyenT

```
Scenario('using playwright locator @Playwright', () => {
  I.amOnPage('https://codecept.io/test-react-calculator/');
  I.click('7');
  I.click({ pw: '_react=t[name = "="]' });
  I.seeElement({ pw: '_react=t[value = "7"]' });
  I.click({ pw: '_react=t[name = "+"]' });
  I.click({ pw: '_react=t[name = "3"]' });
  I.click({ pw: '_react=t[name = "="]' });
  I.seeElement({ pw: '_react=t[value = "10"]' });
});
```

```
Scenario('using playwright data-testid attribute @Playwright', () => {
    I.amOnPage('/');
    const webElements = await I.grabWebElements({ pw: '[data-testid="welcome"]' });
    assert.equal(webElements[0]._selector, '[data-testid="welcome"] >> nth=0');
    assert.equal(webElements.length, 1);
});
```

- feat(puppeteer): mockRoute support. See #4262 by @KobeNguyenT

Network requests & responses can be mocked and modified. Use `mockRoute` which strictly follows [Puppeteer's setRequestInterception API](https://pptr.dev/next/api/puppeteer.page.setrequestinterception).

```
I.mockRoute('https://reqres.in/api/comments/1', request => {
  request.respond({
    status: 200,
    headers: { 'Access-Control-Allow-Origin': '*' },
    contentType: 'application/json',
    body: '{"name": "this was mocked" }',
  });
})
```

```
I.mockRoute('**/*.{png,jpg,jpeg}', route => route.abort());

// To disable mocking for a route call `stopMockingRoute`
// for previously mocked URL
I.stopMockingRoute('**/*.{png,jpg,jpeg}');
```

To master request intercepting [use HTTPRequest object](https://pptr.dev/next/api/puppeteer.httprequest) passed into mock request handler.

🐛 _Bug Fixes_

- Fixed double help message #4278 by @masiuchi
- waitNumberOfVisibleElements always failed when passing num as 0. See #4274 by @KobeNguyenT

## 3.5.15

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat: improve code coverage plugin (#4252) - by @KobeNguyenT
  We revamp the coverage plugin to make it easier to use

Once all the tests are completed, `codecept` will create and store coverage in `output/coverage` folder, as shown below.

![](<(https://github.com/codeceptjs/CodeceptJS/assets/7845001/3b8b81a3-7c85-470c-992d-ecdc7d5b4a1e)>)

Open `index.html` in your browser to view the full interactive coverage report.

![](https://github.com/codeceptjs/CodeceptJS/assets/7845001/f45607ed-dbe8-4ed4-9b21-01ce25288d22)

![](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c821ce45-6590-4ace-b7ae-2cafb3a4e532)

🐛 _Bug Fixes_

- fix: bump puppeteer to v22.x (#4249) - by @KobeNguyenT
- fix: improve dry-run command (#4225) - by @KobeNguyenT

dry-run command now supports test level grep.

```
Tests from /Users/t/Desktop/projects/codeceptjs-rest-demo:@jaja

GET tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/GET_test.ts -- 4 tests
  ☐ Verify getting a single user @jaja
  ☐ Verify getting list of users @jaja
PUT tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 tests
  ☐ Verify creating new user @Jaja


  Total: 2 suites | 3 tests

--- DRY MODE: No tests were executed ---
➜  codeceptjs-rest-demo git:(master) ✗ npx codeceptjs dry-run
Tests from /Users/t/Desktop/projects/codeceptjs-rest-demo:

DELETE tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/DELETE_test.ts -- 4 tests
  ☐ Verify deleting a user
GET tests -- /Users/t/Desktop/projects/codeceptjs-rest-demo/src/GET_test.ts -- 4 tests
  ☐ Verify a successful call
  ☐ Verify a not found call
  ☐ Verify getting a single user @jaja
  ☐ Verify getting list of users @jaja
POST tests -- /Users/tDesktop/projects/codeceptjs-rest-demo/src/POST_test.ts -- 4 tests
  ☐ Verify creating new user
  ☐ Verify uploading a file
PUT tests -- /Users/tDesktop/projects/codeceptjs-rest-demo/src/PUT_test.ts -- 4 tests
  ☐ Verify creating new user @Jaja


  Total: 4 suites | 8 tests

--- DRY MODE: No tests were executed ---
```

- Several internal fixes and improvements for github workflows

## 3.5.14

❤️ Thanks all to those who contributed to make this release! ❤️

🐛 _Bug Fixes_

- **Hotfix** Fixed missing `joi` package - by @KobeNguyenT

## 3.5.13

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat: mock server helper (#4155) - by @KobeNguyenT
  ![Screenshot 2024-01-25 at 13 47 59](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8fe7aacf-f1c9-4d7e-89a6-3748b3ccb26c)
- feat(webdriver): network traffics manipulation (#4166) - by @KobeNguyenT
  [Webdriver] Added commands to check network traffics - supported only with devtoolsProtocol
  - `startRecordingTraffic`
  - `grabRecordedNetworkTraffics`
  - `flushNetworkTraffics`
  - `stopRecordingTraffic`
  - `seeTraffic`
  - `dontSeeTraffic`

Examples:

```js
// recording traffics and verify the traffic
I.startRecordingTraffic()
I.amOnPage('https://codecept.io/')
I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' })
```

```js
// check the traffic with advanced params
I.amOnPage('https://openai.com/blog/chatgpt')
I.startRecordingTraffic()
I.seeTraffic({
  name: 'sentry event',
  url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
  parameters: {
    width: '1919',
    height: '1138',
  },
})
```

- feat(webapi): add waitForCookie (#4169) - by @KobeNguyenT
  Waits for the specified cookie in the cookies.

```js
I.waitForCookie('token')
```

🐛 _Bug Fixes_

- fix(appium): update performSwipe with w3c protocol v2 (#4181) - by @MykaLev
- fix(webapi): selectOption method (#4157) - by @dyaroman
- fix: waitForText doesnt throw error when text doesnt exist (#4195) - by @KobeNguyenT
- fix: use this.options instead of this.config (#4186) - by @KobeNguyenT
- fix: config path without selenium (#4184) - by @KobeNguyenT
- fix: bring to front condition in \_setPage (#4173) - by @KobeNguyenT
- fix: complicated locator (#4170) - by @KobeNguyenT
  Adding of `':nth-child'` into the array

`const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang'];` fixes the issue. Then an old conversion way over `css-to-xpath` is used.

📖 _Documentation_

- fix(docs): missing docs for codecept UI (#4175) - by @KobeNguyenT
- fix(docs): Appium documentation sidebar menu links (#4188) - by @mirao

🛩️ **Several bugfixes and improvements for Codecept-UI**

- Several internal improvements
- fix: title is not showing when visiting a test
- fix: handle erros nicely

## 3.5.12

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat: upgrade wdio (#4123) - by @KobeNguyenT

  🛩️ With the release of WebdriverIO version `v8.14.0`, and onwards, all driver management hassles are now a thing of the past 🙌. Read more [here](https://webdriver.io/blog/2023/07/31/driver-management/).
  One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as
  `wdio-chromedriver-service`, `wdio-geckodriver-service`, `wdio-edgedriver-service`, `wdio-safaridriver-service`, and even `@wdio/selenium-standalone-service`.

For those who require custom driver options, fear not; WebDriver Helper allows you to pass in driver options through custom WebDriver configuration.
If you have a custom grid, use a cloud service, or prefer to run your own driver, there's no need to worry since WebDriver Helper will only start a driver when there are no other connection information settings like hostname or port specified.

Example:

```js
{
   helpers: {
     WebDriver : {
       smartWait: 5000,
       browser: "chrome",
       restart: false,
       windowSize: "maximize",
       timeouts: {
         "script": 60000,
         "page load": 10000
       }
     }
   }
}
```

Testing Chrome locally is now more convenient than ever. You can define a browser channel, and WebDriver Helper will take care of downloading the specified browser version for you.
For example:

```js
{
   helpers: {
     WebDriver : {
       smartWait: 5000,
       browser: "chrome",
       browserVersion: '116.0.5793.0', // or 'stable', 'beta', 'dev' or 'canary'
       restart: false,
       windowSize: "maximize",
       timeouts: {
         "script": 60000,
         "page load": 10000
       }
     }
   }
}
```

- feat: wdio with devtools protocol (#4105) - by @KobeNguyenT

Running with devtools protocol

```js
{
   helpers: {
     WebDriver : {
       url: "http://localhost",
       browser: "chrome",
       devtoolsProtocol: true,
       desiredCapabilities: {
         chromeOptions: {
           args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
         }
       }
     }
   }
}
```

- feat: add a locator builder method withTextEquals() (#4100) - by @mirao

Find an element with exact text

```js
locate('button').withTextEquals('Add')
```

- feat: waitForNumberOfTabs (#4124) - by @KobeNguyenT

Waits for number of tabs.

```js
I.waitForNumberOfTabs(2)
```

- feat: I.say would be added to Test.steps array (#4145) - by @KobeNguyenT

Currently `I.say` is not added into the `Test.steps` array. This PR aims to add this to steps array so that we could use it to print steps in ReportPortal for instance.

![Screenshot 2024-01-19 at 15 41 34](https://github.com/codeceptjs/CodeceptJS/assets/7845001/82af552a-aeb3-487e-ac10-b5bb7e42470f)

🐛 _Bug Fixes_

- fix: reduce the package size to 2MB (#4138) - by @KobeNguyenT
- fix(webapi): see attributes on elements (#4147) - by @KobeNguyenT
- fix: some assertion methods (#4144) - by @KobeNguyenT

Improve the error message for `seeElement`, `dontSeeElement`, `seeElementInDOM`, `dontSeeElementInDOM`

The current error message doesn't really help when debugging issue also causes some problem described in #4140

Actual

```
      expected visible elements '[ELEMENT]' to be empty
      + expected - actual

      -[
      -  "ELEMENT"
      -]
      +[]
```

Updated

```
     Error: Element "h1" is still visible
      at seeElementError (lib/helper/errors/ElementAssertion.js:9:9)
      at Playwright.dontSeeElement (lib/helper/Playwright.js:1472:7)
```

- fix: css to xpath backward compatibility (#4141) - by @KobeNguyenT

* [css-to-xpath](https://www.npmjs.com/package/css-to-xpath): old lib, which works perfectly unless you have hyphen in locator. (https://github.com/codeceptjs/CodeceptJS/issues/3563)
* [csstoxpath](https://www.npmjs.com/package/csstoxpath): new lib, to solve the issue locator with hyphen but also have some [limitations](https://www.npmjs.com/package/csstoxpath#limitations)

- fix: grabRecordedNetworkTraffics throws error when being called twice (#4143) - by @KobeNguyenT
- fix: missing steps of test when running with workers (#4127) - by @KobeNguyenT

```js
Scenario('Verify getting list of users', async () => {
  let res = await I.getUserPerPage(2)
  res.data = [] // this line causes the issue
  await I.expectEqual(res.data.data[0].id, 7)
})
```

at this time, res.data.data[0].id would throw undefined error and somehow the test is missing all its steps.

- fix: process.env.profile when --profile isn't set in run-multiple mode (#4131) - by @mirao

`process.env.profile` is the string "undefined" instead of type undefined when no --profile is specified in the mode "run-multiple"

- fix: session doesn't respect the context options (#4111) - by @KobeNguyenT

```js
Helpers: Playwright
Plugins: screenshotOnFail, tryTo, retryFailedStep, retryTo, eachElement

Repro --
[1]  Starting recording promises
Timeouts:
› [Session] Starting singleton browser session
Reproduce issue
I am on page "https://example.com"
› [Browser:Error] Failed to load resource: the server responded with a status of 404 ()
› [New Context] {}
user1: I am on page "https://example.com"
user1: I execute script () => {
return { width: window.screen.width, height: window.screen.height };
}
sessionScreen is {"width":375,"height":667}
✔ OK in 1890ms


OK  | 1 passed   // 4s
```

- fix(plugin): retryTo issue (#4117) - by @KobeNguyenT
  ![Screenshot 2024-01-08 at 17 36 54](https://github.com/codeceptjs/CodeceptJS/assets/7845001/39c97073-e2e9-4c4c-86ee-62540bc95015)

- fix(types): CustomLocator typing broken for custom strict locators (#4120) - by @KobeNguyenT
- fix: wrong output for skipped tests - by @KobeNguyenT
- fix: no retry failed step after tryto block (#4103) - by @KobeNguyenT
- fix: deprecate some JSON Wire Protocol commands (#4104) - by @KobeNguyenT

deprecate some JSON Wire Protocol commands: `grabGeoLocation`, `setGeoLocation`

- fix: cannot locate complicated locator (#4101) - by @KobeNguyenT

Locator issue due to the lib changes

```
The locator locate(".ps-menu-button").withText("Authoring").inside(".ps-submenu-root:nth-child(3)") is translated to
3.5.8: //*[contains(concat(' ', normalize-space(./@class), ' '), ' ps-menu-button ')][contains(., 'Authoring')][ancestor::*[(contains(concat(' ', normalize-space(./@class), ' '), ' ps-submenu-root ') and count(preceding-sibling::*) = 2)]] and works well
3.5.11: //*[contains(@class, "ps-menu-button")][contains(., 'Authoring')][ancestor::*[3][contains(@class, "ps-submenu-root")]] and doesn't work (no clickable element found). Even if you test it in browser inspector, it doesn't work.
```

## 3.5.11

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat: other locators from playwright (#4090) - by @KobeNguyenT
  - CodeceptJS - Playwright now supports other locators like
    - React (https://playwright.dev/docs/other-locators#react-locator),
    - Vue (https://playwright.dev/docs/other-locators#vue-locator)
      ![Vue Locators](https://github.com/codeceptjs/CodeceptJS/assets/7845001/841e9e54-847b-4326-b95f-f9406955a3ce)
      ![Example](https://github.com/codeceptjs/CodeceptJS/assets/7845001/763e6788-143b-4a00-a249-d9ca5f0b2a09)

🐛 _Bug Fixes_

- fix: step object is broken when step arg is a function (#4092) - by @KobeNguyenT
- fix: step object is broken when step arg contains joi object (#4084) - by @KobeNguyenT
- fix(expect helper): custom error message as optional param (#4082) - by @KobeNguyenT
- fix(puppeteer): hide deprecation info (#4075) - by @KobeNguyenT
- fix: seeattributesonelements throws error when attribute doesn't exist (#4073) - by @KobeNguyenT
- fix: typo in agrs (#4077) - by @KobeNguyenT
- fix: retryFailedStep is disabled for non tryTo steps (#4069) - by @KobeNguyenT
- fix(typings): scrollintoview complains scrollintoviewoptions (#4067) - by @KobeNguyenT

📖 _Documentation_

- fix(docs): some doc blocks are broken (#4076) - by @KobeNguyenT
- fix(docs): expect docs (#4058) - by @KobeNguyenT

## 3.5.10

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ _Features_

- feat: expose WebElement (#4043) - by @KobeNguyenT

```
Now we expose the WebElements that are returned by the WebHelper and you could make the subsequence actions on them.

// Playwright helper would return the Locator

I.amOnPage('/form/focus_blur_elements');
const webElements = await I.grabWebElements('#button');
webElements[0].click();
```

- feat(playwright): support HAR replaying (#3990) - by @KobeNguyenT

```
Replaying from HAR

 // Replay API requests from HAR.
 // Either use a matching response from the HAR,
 // or abort the request if nothing matches.
   I.replayFromHar('./output/har/something.har', { url: "*/**/api/v1/fruits" });
   I.amOnPage('https://demo.playwright.dev/api-mocking');
   I.see('CodeceptJS');
[Parameters]
harFilePath [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) Path to recorded HAR file
opts [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)? [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har)
```

- feat(playwright): support HAR recording (#3986) - by @KobeNguyenT

```
A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
It contains information about the request and response headers, cookies, content, timings, and more.
You can use HAR files to mock network requests in your tests. HAR will be saved to output/har.
More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har.

...
recordHar: {
    mode: 'minimal', // possible values: 'minimal'|'full'.
    content: 'embed' // possible values:  "omit"|"embed"|"attach".
}
...
```

- improvement(playwright): support partial string for option (#4016) - by @KobeNguyenT

```
await I.amOnPage('/form/select');
await I.selectOption('Select your age', '21-');
```

🐛 _Bug Fixes_

- fix(playwright): proceedSee could not find the element (#4006) - by @hatufacci
- fix(appium): remove the vendor prefix of 'bstack:options' (#4053) - by @mojtabaalavi
- fix(workers): event improvements (#3953) - by @KobeNguyenT

```
Emit the new event: event.workers.result.

CodeceptJS also exposes the env var `process.env.RUNS_WITH_WORKERS` when running tests with run-workers command so that you could handle the events better in your plugins/helpers.

const { event } = require('codeceptjs');

module.exports = function() {
    // this event would trigger the  `_publishResultsToTestrail` when running `run-workers` command
  event.dispatcher.on(event.workers.result, async () => {
    await _publishResultsToTestrail();
  });

  // this event would not trigger the  `_publishResultsToTestrail` multiple times when running `run-workers` command
  event.dispatcher.on(event.all.result, async () => {
      // when running `run` command, this env var is undefined
    if (!process.env.RUNS_WITH_WORKERS) await _publishResultsToTestrail();
  });
}
```

- fix: ai html updates (#3962) - by @DavertMik

```
replaced minify library with a modern and more secure fork. Fixes html-minifier@4.0.0 Regular Expression Denial of Service vulnerability #3829
AI class is implemented as singleton
refactored heal.js plugin to work on edge cases
add configuration params on number of fixes performed by ay heal
improved recorder class to add more verbose log
improved recorder class to ignore some of errors
```

- fix(appium): closeApp supports both Android/iOS (#4046) - by @KobeNguyenT
- fix: some security vulnerability of some packages (#4045) - by @KobeNguyenT
- fix: seeAttributesOnElements check condition (#4029) - by @KobeNguyenT
- fix: waitForText locator issue (#4039) - by @KobeNguyenT

```
Fixed this error:

locator.isVisible: Unexpected token "s" while parsing selector ":has-text('Were you able to resolve the resident's issue?') >> nth=0"
      at Playwright.waitForText (node_modules\codeceptjs\lib\helper\Playwright.js:2584:79)
```

- fix: move to sha256 (#4038) - by @KobeNguyenT
- fix: respect retries from retryfailedstep plugin in helpers (#4028) - by @KobeNguyenT

```
Currently inside the _before() of helpers for example Playwright, the retries is set there, however, when retryFailedStep plugin is enabled, the retries of recorder is still using the value from _before() not the value from retryFailedStep plugin.

Fix:

- introduce the process.env.FAILED_STEP_RETIRES which could be access everywhere as the helper won't know anything about the plugin.
- set default retries of Playwright to 3 to be on the same page with Puppeteer.
```

- fix: examples in test title (#4030) - by @KobeNguyenT

```
When test title doesn't have the data in examples:

Feature: Faker examples

  Scenario Outline: Below are the users
    Examples:
      | user   | role |
      | John  | admin |
      | Tim   | client  |

Faker examples --
    [1]  Starting recording promises
    Timeouts:
  Below are the users {"user":"John","role":"admin"}
  ✔ OK in 4ms

  Below are the users {"user":"Tim","role":"client"}
  ✔ OK in 1ms

When test title includes the data in examples:


Feature: Faker examples

  Scenario Outline: Below are the users - <user> - <role>
    Examples:
      | user   | role |
      | John  | admin |
      | Tim   | client  |


Faker examples --
    [1]  Starting recording promises
    Timeouts:
  Below are the users - John - admin
  ✔ OK in 4ms

  Below are the users - Tim - client
  ✔ OK in 1ms
```

- fix: disable retryFailedStep when using with tryTo (#4022) - by @KobeNguyenT
- fix: locator builder returns error when class name contains hyphen (#4024) - by @KobeNguyenT
- fix: seeCssPropertiesOnElements failed when font-weight is a number (#4026) - by @KobeNguyenT
- fix(appium): missing await on some steps of runOnIOS and runOnAndroid (#4018) - by @KobeNguyenT
- fix(cli): no error of failed tests when using retry with scenario only (#4020) - by @KobeNguyenT
- fix: set getPageTimeout to 30s (#4031) - by @KobeNguyenT
- fix(appium): expose switchToContext (#4015) - by @KobeNguyenT
- fix: promise issue (#4013) - by @KobeNguyenT
- fix: seeCssPropertiesOnElements issue with improper condition (#4057) - by @KobeNguyenT

📖 _Documentation_

- docs: Update clearCookie documentation for Playwright helper (#4005) - by @Hellosager
- docs: improve the example code for autoLogin (#4019) - by @KobeNguyenT
  ![Screenshot 2023-11-22 at 14 40 11](https://github.com/codeceptjs/CodeceptJS/assets/7845001/c05ac436-efd0-4bc0-a46c-386f915c0f17)

## 3.5.8

Thanks all to those who contributed to make this release!

🐛 _Bug Fixes_
fix(appium): type of setNetworkConnection() (#3994) - by @mirao
fix: improve the way to show deprecated appium v1 message (#3992) - by @KobeNguyenT
fix: missing exit condition of some wait functions - by @KobeNguyenT

## 3.5.7

Thanks all to those who contributed to make this release!

🐛 _Bug Fixes_

- Bump playwright to 1.39.0 - run `npx playwright install` to install the browsers as starting from 1.39.0 browsers are not installed automatically (#3924) - by @KobeNguyenT
- fix(playwright): some wait functions draw error due to switchTo iframe (#3918) - by @KobeNguyenT
- fix(appium): AppiumTestDistribution/appium-device-farm requires 'platformName' (#3950) - by @rock-tran
- fix: autologin with empty fetch (#3947) - by @andonary
- fix(cli): customLocator draws error in dry-mode (#3940) - by @KobeNguyenT
- fix: ensure docs include @returns Promise<void> where appropriate (#3954) - by @fwouts
- fix: long text in data table cuts off (#3936) - by @KobeNguyenT

```
#language: de
Funktionalität: Faker examples

   Szenariogrundriss: Atualizar senha do usuário
        Angenommen que estou logado via REST com o usuário "<customer>"
          | protocol             | https:               |
          | hostname             | https://cucumber.io/docs/gherkin/languages/            |


Faker examples --
  Atualizar senha do usuário {"product":"{{vehicle.vehicle}}","customer":"Dr. {{name.findName}}","price":"{{commerce.price}}","cashier":"cashier 2"}
   On Angenommen: que estou logado via rest com o usuário "dr. {{name.find name}}"
    protocol        | https:
    hostname        | https://cucumber.io/docs/gherkin/languages/

Dr. {{name.findName}}
  ✔ OK in 13ms

```

- fix(playwright): move to waitFor (#3933) - by @KobeNguyenT
- fix: relax grabCookie type (#3919) - by @KobeNguyenT
- fix: proceedSee error when being called inside within (#3939) - by @KobeNguyenT
- fix: rename haveRequestHeaders of ppt and pw helpers (#3937) - by @KobeNguyenT

```
Renamed haveRequestHeaders of Puppeteer, Playwright helper so that it would not confuse the REST helper.
Puppeteer: setPuppeteerRequestHeaders
Playwright: setPlaywrightRequestHeaders
```

- improvement: handle the way to load apifactory nicely (#3941) - by @KobeNguyenT

```
With this fix, we could now use the following syntax:

export = new Factory()
   .attr('name', () => faker.name.findName())
   .attr('job', () => 'leader');

export default new Factory()
   .attr('name', () => faker.name.findName())
   .attr('job', () => 'leader');

modules.export = new Factory()
   .attr('name', () => faker.name.findName())
   .attr('job', () => 'leader');
```

📖 _Documentation_

- docs(appium): update to v2 (#3932) - by @KobeNguyenT
- docs: improve BDD Gherkin docs (#3938) - by @KobeNguyenT
- Other docs improvements

🛩️ _Features_

- feat(puppeteer): support trace recording - by @KobeNguyenT

```
[Trace Recording Customization]
Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run. Traces will be saved to output/trace

trace: enables trace recording for failed tests; trace are saved into output/trace folder
keepTraceForPassedTests: - save trace for passed tests
```

- feat: expect helper (#3923) - by @KobeNguyenT

````
 * This helper allows performing assertions based on Chai.
 *
 * ### Examples
 *
 * Zero-configuration when paired with other helpers like REST, Playwright:
 *
 * ```js
 * // inside codecept.conf.js
 *{
 *   helpers: {
 *     Playwright: {...},
 *     ExpectHelper: {},
 *   }

  Expect Helper
    #expectEqual
    #expectNotEqual
    #expectContain
    #expectNotContain
    #expectStartsWith
    #expectNotStartsWith
    #expectEndsWith
    #expectNotEndsWith
    #expectJsonSchema
    #expectHasProperty
    #expectHasAProperty
    #expectToBeA
    #expectToBeAn
    #expectMatchRegex
    #expectLengthOf
    #expectTrue
    #expectEmpty
    #expectFalse
    #expectAbove
    #expectBelow
    #expectLengthAboveThan
    #expectLengthBelowThan
    #expectLengthBelowThan
    #expectDeepMembers
    #expectDeepIncludeMembers
    #expectDeepEqualExcluding
    #expectLengthBelowThan
````

- feat: run-workers with multiple browsers output folders - by @KobeNguyenT

* ![Screenshot 2023-11-04 at 10 49 56](https://github.com/codeceptjs/CodeceptJS/assets/7845001/8eaecc54-de14-4597-b148-1e087bec3c76)
* ![Screenshot 2023-11-03 at 15 56 38](https://github.com/codeceptjs/CodeceptJS/assets/7845001/715aed17-3535-48df-80dd-84f7024f08e3)

- feat: introduce new Playwright methods - by @hatufacci

```
- grabCheckedElementStatus
- grabDisabledElementStatus
```

- feat: gherkin supports i18n (#3934) - by @KobeNguyenT

```
#language: de
Funktionalität: Checkout-Prozess
  Um Produkte zu kaufen
  Als Kunde
  Möchte ich in der Lage sein, mehrere Produkte zu kaufen

  @i18n
  Szenariogrundriss: Bestellrabatt
    Angenommen ich habe ein Produkt mit einem Preis von <price>$ in meinem Warenkorb
    Und der Rabatt für Bestellungen über $20 beträgt 10 %
    Wenn ich zur Kasse gehe
    Dann sollte ich den Gesamtpreis von "<total>" $ sehen

    Beispiele:
      | price | total |
      | 10    | 10.0  |
```

- feat(autoLogin): improve the check method (#3935) - by @KobeNguyenT

```
Instead of asserting on page elements for the current user in check, you can use the session you saved in fetch

autoLogin: {
  enabled: true,
  saveToFile: true,
  inject: 'login',
  users: {
    admin: {
      login: async (I) => {  // If you use async function in the autoLogin plugin
         const phrase = await I.grabTextFrom('#phrase')
         I.fillField('username', 'admin'),
         I.fillField('password', 'password')
         I.fillField('phrase', phrase)
      },
      check: (I, session) => {
         // Throwing an error in `check` will make CodeceptJS perform the login step for the user
         if (session.profile.email !== the.email.you.expect@some-mail.com) {
              throw new Error ('Wrong user signed in');
        }
      },
    }
  }
}
Scenario('login', async ( {I, login} ) => {
  await login('admin') // you should use `await`
})
```

## 3.5.6

Thanks all to those who contributed to make this release!

🐛 _Bug Fixes_

- fix: switchTo/within block doesn't switch to expected iframe (#3892) - by @KobeNguyenT
- fix: highlight element doesn't work as expected (#3896) - by @KobeNguyenT

```
  verbose/ highlight	TRUE	TRUE -> highlight element
  verbose/ highlight	TRUE	FALSE -> no highlight element
  verbose/ highlight	FALSE	TRUE -> no highlight element
  verbose/ highlight	FALSE	FALSE -> no highlight element
```

- fix: masked value issue in data table (#3885) - by @KobeNguyenT

```
const accounts = new DataTable(['role', 'username', 'password']);
accounts.add([
  'ROLE_A',
  process.env['FIRST_USERNAME'],
  secret(process.env['FIRST_PASSWORD']),
]);
accounts.add([
  'ROLE_B',
  process.env['SECOND_USERNAME'],
  secret(process.env['SECOND_PASSWORD']),
]);

Data(accounts)
  .Scenario(
    'ScenarioTitle',
    ({ I, pageObject, current }) => {
      I.say("Given I'am logged in");
      I.amOnPage('/');
      loginPage.**sendForm**(current.username, current.password);
  )


 // output
 The test feature --
  The scenario | {"username":"Username","password": ***}
      'The real password: theLoggedPasswordInCleartext'
      I.fillField('somePasswordLocator', '****')
  ✔ OK in 7ms

  The scenario | {"username":"theSecondUsername","password": ***}
      'The real password: theLoggedPasswordInCleartext'
      I.fillField('somePasswordLocator', '****')
  ✔ OK in 1ms
```

- fix: debug info causes error (#3882) - by @KobeNguyenT

📖 _Documentation_

- fix: get rid of complaining when using session without await and returning nothing. (#3899) - by @KobeNguyenT
- fix(FileSystem): a typo in writeToFile() (#3897) - by @mirao

🛩️ _Features_

- feat(translation): add more french keywords and fix deprecated waitForClickable (#3906) - by @andonary

```
- Add some french keywords for translation
- I.waitForClickable has the same "attends" than I.wait. Using "attends" leads to use the deprecated waitForClickable. Fix it by using different words.
```

## 3.5.5

🐛 Bug Fixes

- fix(browserstack): issue with vendor prefix (#3845) - by @KobeNguyenT

```
export const caps = {
    androidCaps: {
        appiumV2: true,
        host: "hub-cloud.browserstack.com",
        port: 4444,
        user: process.env.BROWSERSTACK_USER,
        key: process.env.BROWSERSTACK_KEY,
        'app': `bs://c700ce60cf13ae8ed97705a55b8e022f1hjhkjh3c5827c`,
        browser: '',
        desiredCapabilities: {
            'appPackage': data.packageName,
            'deviceName': process.env.DEVICE || 'Google Pixel 3',
            'platformName': process.env.PLATFORM || 'android',
            'platformVersion': process.env.OS_VERSION || '10.0',
            'automationName': process.env.ENGINE || 'UIAutomator2',
            'newCommandTimeout': 300000,
            'androidDeviceReadyTimeout': 300000,
            'androidInstallTimeout': 90000,
            'appWaitDuration': 300000,
            'autoGrantPermissions': true,
            'gpsEnabled': true,
            'isHeadless': false,
            'noReset': false,
            'noSign': true,
            'bstack:options' : {
                "appiumVersion" : "2.0.1",
            },
        }
    },
}
```

- switchTo/within now supports strict locator (#3847) - by @KobeNguyenT

```
I.switchTo({ css: 'iframe[id^=number-frame]' }) // support the strict locator

I.amOnPage('/iframe');
within({
  frame: { css: '#number-frame-1234' }, // support the strict locator
}, () => {
  I.fillField('user[login]', 'User');
  I.fillField('user[email]', 'user@user.com');
  I.fillField('user[password]', 'user@user.com');
  I.click('button');
});
```

- Improve the IntelliSense when using other languages (#3848) - by @andonary

```
  include: {
    Je: './steps_file.js'
  }
```

- bypassCSP support for Playwright helper (#3865) - by @sammeel

```
  helpers: {
    Playwright: {
      bypassCSP: true
    }
```

- fix: missing requests when recording network (#3834) - by @KobeNguyenT

🛩️ Features and Improvements

- Show environment info in verbose mode (#3858) - by @KobeNguyenT

```
Environment information:-

codeceptVersion:  "3.5.4"
nodeInfo:  18.16.0
osInfo:  macOS 13.5
cpuInfo:  (8) arm64 Apple M1 Pro
chromeInfo:  116.0.5845.179
edgeInfo:  116.0.1938.69
firefoxInfo:  Not Found
safariInfo:  16.6
helpers:  {
"Playwright": {
"url": "https://github.com",
"show": false,
"browser": "chromium",
"waitForNavigation": "load",
"waitForTimeout": 30000,
"trace": false,
"keepTraceForPassedTests": true
},
"CDPHelper": {
"require": "./helpers/CDPHelper.ts"
},
"OpenAI": {
"chunkSize": 8000
},
"ExpectHelper": {
"require": "codeceptjs-expect"
},
"REST": {
"endpoint": "https://reqres.in",
"timeout": 20000
},
"AllureHelper": {
"require": "./helpers/AllureHelper.ts"
}
}
plugins:  {
"screenshotOnFail": {
"enabled": true
},
"tryTo": {
"enabled": true
},
"retryFailedStep": {
"enabled": true
},
"retryTo": {
"enabled": true
},
"eachElement": {
"enabled": true
},
"pauseOnFail": {}
}
***************************************
If you have questions ask them in our Slack: http://bit.ly/chat-codeceptjs
Or ask them on our discussion board: https://codecept.discourse.group/
Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues
***************************************
CodeceptJS v3.5.4 #StandWithUkraine
```

- some typings improvements (#3855) - by @nikzupancic
- support the puppeteer 21.1.1 (#3856) - by @KobeNguyenT
- fix: support secret value for some methods (#3837) - by @KobeNguyenT

```
await I.amOnPage('/form/field_values');
await I.dontSeeInField('checkbox[]', secret('not seen one'));
await I.seeInField('checkbox[]', secret('see test one'));
await I.dontSeeInField('checkbox[]', secret('not seen two'));
await I.seeInField('checkbox[]', secret('see test two'));
await I.dontSeeInField('checkbox[]', secret('not seen three'));
await I.seeInField('checkbox[]', secret('see test three'));
```

🛩️ **Several bugfixes and improvements for Codecept-UI**

- Mask the secret value in UI
- Improve UX/UI
- PageObjects are now showing in UI

## 3.5.4

🐛 Bug Fixes:

- [Playwright] When passing `userDataDir`, it throws error after test execution (#3814) - by @KobeNguyenT
- [CodeceptJS-CLI] Improve command to generate types (#3788) - by @KobeNguyenT
- Heal plugin fix (#3820) - by @davert
- Fix for error in using `all` with `run-workers` (#3805) - by @KobeNguyenT

```js
  helpers: {
    Playwright: {
      url: 'https://github.com',
      show: false,
      browser: 'chromium',
      waitForNavigation: 'load',
      waitForTimeout: 30_000,
      trace: true,
      keepTraceForPassedTests: true
    },
  },
  multiple: {
    profile1: {
      browsers: [
        {
          browser: "chromium",
        }
      ]
    },
  },
```

- Highlight elements issues (#3779) (#3778) - by @philkas
- Support `&nbsp` symbol in `I.see` method (#3815) - by @KobeNguyenT

```js
// HTML code uses &nbsp; instead of space
;<div class="dJHe_" style="color: rgb(255, 255, 255);">
  My&nbsp;Text!
</div>

I.see('My Text!') // this test would work with both &nbsp; and space
```

📖 Documentation

- Improve the configuration of electron testing when the app is build with electron-forge (#3802) - by @KobeNguyenT

```js
const path = require('path')

exports.config = {
  helpers: {
    Playwright: {
      browser: 'electron',
      electron: {
        executablePath: require('electron'),
        args: [path.join(__dirname, '.webpack/main/index.js')],
      },
    },
  },
  // rest of config
}
```

🛩️ Features

#### [Playwright] new features and improvements

- Parse the response in recording network steps (#3771) - by @KobeNguyenT

```js
const traffics = await I.grabRecordedNetworkTraffics()
expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1')
expect(traffics[0].response.status).to.equal(200)
expect(traffics[0].response.body).to.contain({ name: 'this was mocked' })

expect(traffics[1].url).to.equal('https://reqres.in/api/comments/1')
expect(traffics[1].response.status).to.equal(200)
expect(traffics[1].response.body).to.contain({ name: 'this was another mocked' })
```

- Grab metrics (#3809) - by @KobeNguyenT

```js
const metrics = await I.grabMetrics()

// returned metrics

;[
  { name: 'Timestamp', value: 1584904.203473 },
  { name: 'AudioHandlers', value: 0 },
  { name: 'AudioWorkletProcessors', value: 0 },
  { name: 'Documents', value: 22 },
  { name: 'Frames', value: 10 },
  { name: 'JSEventListeners', value: 366 },
  { name: 'LayoutObjects', value: 1240 },
  { name: 'MediaKeySessions', value: 0 },
  { name: 'MediaKeys', value: 0 },
  { name: 'Nodes', value: 4505 },
  { name: 'Resources', value: 141 },
  { name: 'ContextLifecycleStateObservers', value: 34 },
  { name: 'V8PerContextDatas', value: 4 },
  { name: 'WorkerGlobalScopes', value: 0 },
  { name: 'UACSSResources', value: 0 },
  { name: 'RTCPeerConnections', value: 0 },
  { name: 'ResourceFetchers', value: 22 },
  { name: 'AdSubframes', value: 0 },
  { name: 'DetachedScriptStates', value: 2 },
  { name: 'ArrayBufferContents', value: 1 },
  { name: 'LayoutCount', value: 0 },
  { name: 'RecalcStyleCount', value: 0 },
  { name: 'LayoutDuration', value: 0 },
  { name: 'RecalcStyleDuration', value: 0 },
  { name: 'DevToolsCommandDuration', value: 0.000013 },
  { name: 'ScriptDuration', value: 0 },
  { name: 'V8CompileDuration', value: 0 },
  { name: 'TaskDuration', value: 0.000014 },
  { name: 'TaskOtherDuration', value: 0.000001 },
  { name: 'ThreadTime', value: 0.000046 },
  { name: 'ProcessTime', value: 0.616852 },
  { name: 'JSHeapUsedSize', value: 19004908 },
  { name: 'JSHeapTotalSize', value: 26820608 },
  { name: 'FirstMeaningfulPaint', value: 0 },
  { name: 'DomContentLoaded', value: 1584903.690491 },
  { name: 'NavigationStart', value: 1584902.841845 },
]
```

- Grab WebSocket (WS) messages (#3789) - by @KobeNguyenT
  - `flushWebSocketMessages`
  - `grabWebSocketMessages`
  - `startRecordingWebSocketMessages`
  - `stopRecordingWebSocketMessages`

```js
await I.startRecordingWebSocketMessages()
I.amOnPage('https://websocketstest.com/')
I.waitForText('Work for You!')
I.flushNetworkTraffics()
const wsMessages = I.grabWebSocketMessages()
expect(wsMessages.length).to.equal(0)
```

```js
await I.startRecordingWebSocketMessages()
await I.amOnPage('https://websocketstest.com/')
I.waitForText('Work for You!')
const wsMessages = I.grabWebSocketMessages()
expect(wsMessages.length).to.greaterThan(0)
```

```js
await I.startRecordingWebSocketMessages()
await I.amOnPage('https://websocketstest.com/')
I.waitForText('Work for You!')
const wsMessages = I.grabWebSocketMessages()
await I.stopRecordingWebSocketMessages()
await I.amOnPage('https://websocketstest.com/')
I.waitForText('Work for You!')
const afterWsMessages = I.grabWebSocketMessages()
expect(wsMessages.length).to.equal(afterWsMessages.length)
```

- Move from `ElementHandle` to `Locator`. This change is quite major, but it happened under hood, so should not affect your code. (#3738) - by @KobeNguyenT

## 3.5.3

🛩️ Features

- [Playwright] Added commands to check network traffic #3748 - by @ngraf @KobeNguyenT
  - `startRecordingTraffic`
  - `grabRecordedNetworkTraffics`
  - `blockTraffic`
  - `mockTraffic`
  - `flushNetworkTraffics`
  - `stopRecordingTraffic`
  - `seeTraffic`
  - `grabTrafficUrl`
  - `dontSeeTraffic`

Examples:

```js
// recording traffics and verify the traffic
await I.startRecordingTraffic()
I.amOnPage('https://codecept.io/')
await I.seeTraffic({ name: 'traffics', url: 'https://codecept.io/img/companies/BC_LogoScreen_C.jpg' })
```

```js
// block the traffic
I.blockTraffic('https://reqres.in/api/comments/*')
await I.amOnPage('/form/fetch_call')
await I.startRecordingTraffic()
await I.click('GET COMMENTS')
await I.see('Can not load data!')
```

```js
// check the traffic with advanced params
I.amOnPage('https://openai.com/blog/chatgpt')
await I.startRecordingTraffic()
await I.seeTraffic({
  name: 'sentry event',
  url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
  parameters: {
    width: '1919',
    height: '1138',
  },
})
```

🐛 Bugfix

- [retryStepPlugin] Fix retry step when using global retry #3768 - by @KobeNguyenT

🗑 Deprecated

- Nightmare and Protractor helpers have been deprecated

## 3.5.2

🐛 Bug Fixes

- [Playwright] reverted `clearField` to previous implementation
- [OpenAI] fixed running helper in pause mode. #3755 by @KobeNguyenT

## 3.5.1

🛩️ Features

- [Puppeteer][WebDriver][TestCafe] Added methods by @KobeNguyenT in #3737
  - `blur`
  - `focus`
- Improved BDD output to print steps without `I.` commands` by @davertmik #3739
- Improved `codecept init` setup for Electron tests by @KobeNguyenT. See #3733

🐛 Bug Fixes

- Fixed serializing of custom errors making tests stuck. Fix #3739 by @davertmik.

📖 Documentation

- Fixed Playwright docs by @Horsty80
- Fixed ai docs by @ngraf
- Various fixes by @KobeNguyenT

## 3.5.0

🛩️ Features

- **🪄 [AI Powered Test Automation](/ai)** - use OpenAI as a copilot for test automation. #3713 By @davertmik
  ![](https://user-images.githubusercontent.com/220264/250418764-c382709a-3ccb-4eb5-b6bc-538f3b3b3d35.png)
  - [AI guide](/ai) added
  - added support for OpenAI in `pause()`
  - added [`heal` plugin](/plugins#heal) for self-healing tests
  - added [`OpenAI`](/helpers/openai) helper

- [Playwright][Puppeteer][WebDriver] Highlight the interacting elements in debug mode or with `highlightElement` option set (#3672) - by @KobeNguyenT

![](https://user-images.githubusercontent.com/220264/250415226-a7620418-56a4-4837-b790-b15e91e5d1f0.png)

- [Playwright] Support for APIs in Playwright (#3665) - by Egor Bodnar
  - `clearField` replaced to use new Playwright API
  - `blur` added
  - `focus` added

- **[Added support for multiple browsers](/parallel#Parallel-Execution-by-Workers-on-Multiple-Browsers)** in `run-workers` (#3606) by @karanshah-browserstack :

Multiple browsers configured as profiles:

```js
exports.config = {
  helpers: {
    WebDriver: {
      url: 'http://localhost:3000',
    }
  },
  multiple: {
    profile1: {
      browsers: [
        {
          browser: "firefox",
        },
        {
          browser: "chrome",
        }
      ]
    },
```

And executed via `run-workers` with `all` argument

```
npx codeceptjs run-workers 2 all
```

- [Appium] Add Appium v2 support (#3622) - by @KobeNguyenT
- Improve `gpo` command to create page objects as modules or as classes (#3625) - by @KobeNguyenT
- Added `emptyOutputFolder` config to clean up output before running tests (#3604) - by @KobeNguyenT
- Add `secret()` function support to `append()` and `type()` (#3615) - by @anils92
- [Playwright] Add `bypassCSP` option to helper's config (#3641) - by @KobeNguyenT
- Print number of tests for each suite in dryRun (#3620) - by @KobeNguyenT

🐛 Bug Fixes

- Support `--grep` in dry-run command (#3673) - by @KobeNguyenT
- Fix typings improvements in playwright (#3650) - by @KobeNguyenT
- Fixed global retry #3667 by @KobeNguyenT
- Fixed creating JavaScript test using "codeceptjs gt" (#3611) - by Jaromir Obr

## 3.4.1

- Updated mocha to v 10.2. Fixes #3591
- Fixes executing a faling Before hook. Resolves #3592

## 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

- **Promise-based typings** for TypeScript definitions in #3465 by @nlespiaucq. If you use TypeScript or use linters [check how it may be useful to you](https://bit.ly/3XIMq6n).
- **Translation** improved to use [custom vocabulary](https://codecept.io/translation/).
- [Playwright] Added methods in #3398 by @mirao
  - `restartBrowser` - to restart a browser (with different config)
  - `_createContextPage` - to create a new browser context with a page from a helper
- Added [Cucumber custom types](/bdd#custom-types) for BDD in #3435 by @Likstern
- Propose using JSONResponse helper when initializing project for API testing. #3455 by @PeterNgTr
- When translation enabled, generate tests using localized aliases. By @davertmik
- [Appium] Added `checkIfAppIsInstalled` in #3507 by @PeterNgTr

🐛 Bugfixes

- Fixed #3462 `TypeError: Cannot read properties of undefined (reading 'setStatus')` by @dwentland24 in #3438
- Fixed creating steps file for TypeScript setup #3459 by @PeterNgTr
- Fixed issue of after all event in `run-rerun` command after complete execution #3464 by @jain-neeeraj
- [Playwright][WebDriver][Appium] Do not change `waitForTimeout` value on validation. See #3478 by @pmajewski24. Fixes #2589
- [Playwright][WebDriver][Protractor][Puppeteer][TestCafe] Fixes `Element "{null: undefined}" was not found` and `element ([object Object]) still not present` messages when using object locators. See #3501 and #3502 by @pmajewski24
- [Playwright] Improved file names when downloading file in #3449 by @PeterNgTr. Fixes #3412 and #3409
- Add default value to `profile` env variable. See #3443 by @dwentland24. Resolves #3339
- [Playwright] Using system-native path separator when saving artifacts in #3460 by @PeterNgTr
- [Playwright] Saving videos and traces from multiple sessions in #3505 by @davertmik
- [Playwright] Fixed `amOnPage` to navigate to `about:blank` by @zaxoavoki in #3470 Fixes #2311
- Various typing improvements by @AWolf81 @PeterNgTr @mirao

📖 Documentation

- Updated [Quickstart](https://codecept.io/quickstart/) with detailed explanation of questions in init
- Added [Translation](/translation/) guide
- Updated [TypeScript](https://bit.ly/3XIMq6n) guide for promise-based typings
- Reordered guides list on a website

## 3.3.6

- [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests
- Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26
- [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401
- [REST] Changed "endpoint" to optional by @mirao in #3404
- [REST] Use [`secret`](/secrets) for form encoded string by @PeterNgTr:

```js
const secretData = secret('name=john&password=123456')
const response = await I.sendPostRequest('/user', secretData)
```

- [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407
- [Playwright]Fixed parameters of startActivity() by @mirao in #3408
- Move semver to prod dependencies by @timja in #3413
- check if browser is W3C instead of Android by @mikk150 in #3414
- Pass service configs with options and caps as array for browsers… by @07souravkunda in #3418
- fix for type of "webdriver.port" by @ngraf in #3421
- fix for type of "webdriver.smartWait" by @pmajewski24 in #3426
- fix(datatable): mask secret text by @PeterNgTr in #3432
- fix(playwright) - video name and missing type by @PeterNgTr in #3430
- fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424
- Improve generate pageobject `gpo` command to work with TypeScript by @PeterNgTr in #3411
- Fixed dry-run to always return 0 code and exit
- Added minimal version notice for NodeJS >= 12
- fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431

## 3.3.5

🛩️ Features

- Added **TypeScript types for CodeceptJS config**.

Update `codecept.conf.js` to get intellisense when writing config file:

```js
/**@type {CodeceptJS.MainConfig}**/
exports.config = {
  //...
}
```

- Added TS types for helpers config:
  - Playwright
  - Puppeteer
  - WebDriver
  - REST
- Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik)
- Includes `node-ts` automatically when using TypeScript setup.

🐛 Bugfixes

- [Puppeteer] Fixed support for Puppeteer > 14.4 by @PeterNgTr
- Don't report files as existing when non-directory is in path by @jonathanperret. See #3374
- Fixed TS type for `secret` function by @PeterNgTr
- Fixed wrong order for async MetaSteps by @dwentland24. See #3393
- Fixed same param substitution in BDD step. See #3385 by @snehabhandge

📖 Documentation

- Updated [configuration options](https://codecept.io/configuration/) to match TypeScript types
- Updated [TypeScript documentation](https://codecept.io/typescript/) on simplifying TS installation
- Added codecept-tesults plugin documentation by @ajeetd

## 3.3.4

- Added support for masking fields in objects via `secret` function:

```js
I.sendPostRequest('/auth', secret({ name: 'jon', password: '123456' }, 'password'))
```

- Added [a guide about using of `secret`](/secrets) function
- [Appium] Use `touchClick` when interacting with elements in iOS. See #3317 by @mikk150
- [Playwright] Added `cdpConnection` option to connect over CDP. See #3309 by @Hmihaly
- [customLocator plugin] Allowed to specify multiple attributes for custom locator. Thanks to @aruiz-caritsqa

```js
plugins: {
 customLocator: {
   enabled: true,
   prefix: '$',
   attribute: ['data-qa', 'data-test'],
 }
}
```

- [retryTo plugin] Fixed #3147 using `pollInterval` option. See #3351 by @cyonkee
- [Playwright] Fixed grabbing of browser console messages and window resize in new tab. Thanks to @mirao
- [REST] Added `prettyPrintJson` option to print JSON in nice way by @PeterNgTr
- [JSONResponse] Updated response validation to iterate over array items if response is array. Thanks to @PeterNgTr

```js
// response.data == [
//   { user: { name: 'jon', email: 'jon@doe.com' } },
//   { user: { name: 'matt', email: 'matt@doe.com' } },
//]

I.seeResponseContainsKeys(['user'])
I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } })
I.seeResponseContainsJson({ user: { email: 'matt@doe.com' } })
I.dontSeeResponseContainsJson({ user: 2 })
```

## 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:

- [**API Testing introduced**](/api)
  - Introduced [`JSONResponse`](/helpers/JSONResponse) helper which connects to REST, GraphQL or Playwright helper
  - [REST] Added `amBearerAuthenticated` method
  - [REST] Added `haveRequestHeaders` method
  - Added dependency on `joi` and `chai`
- [Playwright] Added `timeout` option to set [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) for all Playwright actions. If an action fails, Playwright keeps retrying it for a time set by timeout.
- [Playwright] **Possible breaking change.** By default `timeout` is set to 1000ms. _Previous default was set by Playwright internally to 30s. This was causing contradiction to CodeceptJS retries, so triggered up to 3 retries for 30s of time. This timeout option was lowered so retryFailedStep plugin would not cause long delays._
- [Playwright] Updated `restart` config option to include 3 restart strategies:
  - 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
  - 'browser' or **true** - closes browser and opens it again between tests.
  - 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default prior CodeceptJS 3.1
- [Playwright] Extended methods to provide more options from engine. These methods were updated so additional options can be be passed as the last argument:
  - [`click`](/helpers/Playwright#click)
  - [`dragAndDrop`](/helpers/Playwright#dragAndDrop)
  - [`checkOption`](/helpers/Playwright#checkOption)
  - [`uncheckOption`](/helpers/Playwright#uncheckOption)

```js
// use Playwright click options as 3rd argument
I.click('canvas', '.model', { position: { x: 20, y: 40 } })
// check option also has options
I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
```

- `eachElement` plugin introduced. It allows you to iterate over elements and perform some action on them using direct engines API

```js
await eachElement('click all links in .list', '.list a', (el) => {
  await el.click();
})
```

- [Playwright] Added support to `playwright-core` package if `playwright` is not installed. See #3190, fixes #2663.
- [Playwright] Added `makeApiRequest` action to perform API requests. Requires Playwright >= 1.18
- Added support to `codecept.config.js` for name consistency across other JS tools. See motivation at #3195 by @JiLiZART
- [ApiDataFactory] Added options arg to `have` method. See #3197 by @JJlokidoki
- Improved pt-br translations to include keywords: 'Funcionalidade', 'Cenário', 'Antes', 'Depois', 'AntesDaSuite', 'DepoisDaSuite'. See #3206 by @danilolutz
- [allure plugin] Introduced `addStep` method to add comments and attachments. See #3104 by @EgorBodnar

🐛 Bugfixes:

- Fixed #3212: using Regex flags for Cucumber steps. See #3214 by @anils92

📖 Documentation

- Added [Testomat.io reporter](/reports#testomatio)
- Added [api testing](/api) guides
- Added [internal api](/internal-api) guides
- [Appium] Fixed documentation for `performSwipe`
- [Playwright] update docs for `usePlaywrightTo` method by @dbudzins

## 3.2.3

- Documentation improvements by @maojunxyz
- Guard mocha cli reporter from registering step logger multiple times #3180 by @nikocanvacom
- [Playwright] Fixed "tracing.stop: tracing.stop: ENAMETOOLONG: name too long" by @hatufacci
- Fixed #2889: return always the same error contract from simplifyTest. See #3168 by @andremoah

## 3.2.2

- [Playwright] Reverted removal of retry on context errors. Fixes #3130
- Timeout improvements by @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
- [Appium] Fixed logging error when `manualStart` is true. See #3140 by @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 by @nikocanvacom)

```js
// set step timeout to 5 secs
I.limitTime(5).click('Link')
```

- `stepTimeout` plugin introduced to automatically add timeouts for each step (#3059 by @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 by @abhimanyupandian
- [Puppeteer] always close remote browser on test end. See #3054 by @mattonem
- stepbyStepReport Plugin: Disabled screenshots after test has failed. See #3119 by @ioannisChalkias

## 3.1.3

🛩️ Features:

- BDD Improvement. Added `DataTableArgument` class to work with table data structures.

```js
const { DataTableArgument } = require('codeceptjs');
//...
Given('I have an employee card', (table) => {
  const dataTableArgument = new DataTableArgument(table);
  const hashes = dataTableArgument.hashes();
  // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
  const rows = dataTableArgument.rows();
  // rows = [['Harry', 'Potter', Seeker]];
  }
```

See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to @EgorBodnar

- Support `cjs` file extensions for config file: `codecept.conf.cjs`. See #3052 by @kalvenschraut
- API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins.

🐛 Bugfixes:

- [Playwright] Fixed resetting `test.artifacts` for failing tests. See #3033 by @jancorvus. Fixes #3032
- [Playwright] Apply `basicAuth` credentials to all opened browser contexts. See #3036 by @nikocanvacom. Fixes #3035
- [WebDriver] Updated `webdriverio` default version to `^6.12.1`. See #3043 by @sridhareaswaran
- [Playwright] `I.haveRequestHeaders` affects all tabs. See #3049 by @jancorvus
- BDD: Fixed unhandled empty feature files. Fix #3046 by @abhimanyupandian
- Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.
- [Appium] Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by @mirao

📖 Documentation:

- Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail)

## 3.1.2

🛩️ Features:

- Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By @anirudh-modi
- Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By @anirudh-modi
- Configuration: `config.tests` to accept array of file patterns. See #2994 by @monsteramba

```js
exports.config = {
  tests: ['./*_test.js', './sampleTest.js'],
  // ...
}
```

- Notification is shown for test files without `Feature()`. See #3011 by @PeterNgTr

🐛 Bugfixes:

- [Playwright] Fixed #2986 error is thrown when deleting a missing video. Fix by @hatufacci
- Fixed false positive result when invalid function is called in a helper. See #2997 by @abhimanyupandian
- [Appium] Removed full page mode for `saveScreenshot`. See #3002 by @nlespiaucq
- [Playwright] Fixed #3003 saving trace for a test with a long name. Fix by @hatufacci

🎱 Other:

- Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin.

## 3.1.1

- [Appium] Fixed #2759
  `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators.

## 3.1.0

- [Plawyright] Updated to Playwright 1.13
- [Playwright] **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests.
- [Puppeteer] Updated to Puppeteer 10.2.
- [Protractor] Helper deprecated

🛩️ Features:

- [Playwright] Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by @davertmik
- [Playwritght] [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by @davertmik
- [Playwright] Added **support for [React locators](https://codecept.io/react/#locators)** in #2912 by @AAAstorga

🐛 Bugfixes:

- [Puppeteer] Fixed #2244 `els[0]._clickablePoint is not a function` by @karunandrii.
- [Puppeteer] Fixed `fillField` to check for invisible elements. See #2916 by @anne-open-xchange
- [Playwright] Reset of dialog event listener before registration of new one. #2946 by @nikocanvacom
- Fixed running Gherkin features with `run-multiple` using chunks. See #2900 by @andrenoberto
- Fixed #2937 broken typings for subfolders on Windows by @jancorvus
- Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See #2942 by @ilangv
- Fixed #2952 finished job with status code 0 when playwright cannot connect to remote wss url. By @davertmik

## 3.0.7

📖 Documentation fixes:

- Remove broken link from `Nightmare helper`. See #2860 by @Arhell
- Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr
- Fix mocha-multi config example. See #2881 by @rimesc
- Fix small errors in email documentation file. See #2884 by @mkrtchian
- Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf

🛩️ Features:

- [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang
- [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr
- Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4
- Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis
- Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr:

```
npx codeceptjs shell -c foo.conf.js
```

Bug fixes:

- [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg
- A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr
- [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97

## 3.0.6

- [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97
- [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376.
- Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852
- Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes
- Improved workers processes output. See #2804 by @drfiresign
- BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr

```js
"features": [
  "./features/*.feature",
  "./features/api_features/*.feature"
],
```

- Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask
- **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco

```feature
Scenario Outline: ...
  Given ...
  When ...
  Then ...

  Examples:
  | productName          | customer              | email              | anythingMore |
  | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
```

- [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg
- [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains

## 3.0.5

Features:

- **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin
- Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov
- Propagate more events for custom parallel script. See #2796 by @jccguimaraes
- [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard
- CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz
- [REST] Mask sensitive data from log messages.

```js
I.sendPatchRequest('/api/users.json', secret({ email: 'user@user.com' }))
```

See #2786 by @PeterNgTr

Bug fixes:

- Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682
- Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See #2743 by @stedman
- [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol
- [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov
- [Allure] fix report for multi sessions. See #2771 by @cbayer97
- [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov

Documentation fixes:

- Fixed some broken examples. See #2756 by @danielrentz
- Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov
- Added missing type for xFeature. See #2754 by @PeterNgTr
- Fixed code example in Page Object documentation. See #2793 by @mkrtchian

Library updates:

- Updated Axios to 0.21.1. See by @sseide
- Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana

## 3.0.4

- **Hotfix** Fixed `init` script by adding `cross-spawn` package. By @vipulgupta2048
- Fixed handling error during initialization of `run-multiple`. See #2730 by @wagoid

## 3.0.3

- **Playwright 1.7 support**
- [Playwright] Fixed handling null context in click. See #2667 by @matthewjf
- [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf
- Command `npx codeceptjs init` improved
  - auto-installing required packages
  - better error messages
  - fixed generating type definitions
- Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff
- [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ
- Enabled autocompletion for custom helpers. #2695 by @PeterNgTr
- Emit test.after on workers. Fix #2693 by @jccguimaraes
- TypeScript: Allow .ts config files. See #2708 by @elukoyanov
- Fixed definitions generation errors by @elukoyanov. See #2707 and #2718
- Fixed handing error in \_after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See #2715 by @elukoyanov
- Emit hook.failed in workers. Fix #2723 by @jccguimaraes
- [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao
- [allure plugin] Added `addParameter` method in #2717 by @jancorvus. Fixes #2716
- Added mocha-based `--reporter-options` and `--reporter <name>` commands to `run-workers` command by in #2691 @Ameterezu
- Fixed infinite loop for junit reports. See #2691 @Ameterezu
- Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol
- [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao

## 3.0.2

- [Playwright] Fix connection close with remote browser. See #2629 by @dipiash
- [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr
- Duplicate Scenario names (combined with Feature name) are now detected via a warning message.
  Duplicate test names can cause `codeceptjs run-workers` to not function. See #2656 by @Georgegriff
- Documentation fixes

Bug Fixes:

- --suites flag now should function correctly for `codeceptjs run-workers`. See #2655 by @Georgegriff
- [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See #2658 by @Georgegriff, resolves #2620

## 3.0.1

♨️ Hot fix:

- Lock the mocha version to avoid the errors. See #2624 by PeterNgTr

🐛 Bug Fix:

- Fixed error handling in Scenario.js. See #2607 by haveac1gar
- Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun

- Some updates/changes on documentations

## 3.0.0

> [ 👌 **LEARN HOW TO UPGRADE TO CODECEPTJS 3 ➡**](https://bit.ly/codecept3Up)

- Playwright set to be a default engine.
- **NodeJS 12+ required**
- **BREAKING CHANGE:** Syntax for tests has changed.

```js
// Previous
Scenario('title', (I, loginPage) => {})

// Current
Scenario('title', ({ I, loginPage }) => {})
```

- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up).
- **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate)
- [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default
- Introduced one-line installer:

```
npx create-codeceptjs .
```

Read changelog to learn more about version 👇

## 3.0.0-rc

- Moved [Helper class into its own package](https://github.com/codeceptjs/helper) to simplify publishing standalone helpers.
- Fixed typings for `I.say` and `I.retry` by @Vorobeyko
- Updated documentation:
  - [Quickstart](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/quickstart.md#quickstart)
  - [Best Practices](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/best.md)
  - [Custom Helpers](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/custom-helpers.md)
  - [TypeScript](https://github.com/codeceptjs/CodeceptJS/blob/codeceptjs-v3.0/docs/typescript.md)

## 3.0.0-beta.4

🐛 Bug Fix:

- PageObject was broken when using "this" inside a simple object.
- The typings for all WebDriver methods work correctly.
- The typings for "this.helper" and helper constructor work correctly, too.

🧤 Internal:

- Our TS Typings will be tested now! We strarted using [dtslint](https://github.com/microsoft/dtslint) to check all typings and all rules for linter.
  Example:

```ts
const psp = wd.grabPageScrollPosition() // $ExpectType Promise<PageScrollPosition>
psp.then(result => {
  result.x // $ExpectType number
  result.y // $ExpectType number
})
```

- And last: Reducing package size from 3.3Mb to 2.0Mb

## 3.0.0-beta-3

- **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up).
- Test artifacts introduced. Each test object has `artifacts` property, to keep attachment files. For instance, a screenshot of a failed test is attached to a test as artifact.
- Improved output for test execution
  - Changed colors for steps output, simplified
  - Added stack trace for test failures
  - Removed `Event emitted` from log in `--verbose` mode
  - List artifacts of a failed tests

![](https://user-images.githubusercontent.com/220264/82160052-397bf800-989b-11ea-81c0-8e58b3d33525.png)

- Steps & metasteps refactored by @Vorobeyko. Logs to arguments passed to page objects:

```js
// TEST:
MyPage.hasFiles('first arg', 'second arg');

// OUTPUT:
MyPage: hasFile "First arg", "Second arg"
  I see file "codecept.js"
  I see file "codecept.po.json"
```

- Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by @Vorobeyko.

## 3.0.0-beta

- **NodeJS 12+ required**
- **BREAKING CHANGE:** Syntax for tests has changed.

```js
// Previous
Scenario('title', (I, loginPage) => {})

// Current
Scenario('title', ({ I, loginPage }) => {})
```

- **BREAKING CHANGE:** [WebDriver][Protractor][Puppeteer][Playwright][Nightmare] `grab*` functions unified:
  - `grab*From` => **returns single value** from element or throws error when no matchng elements found
  - `grab*FromAll` => returns array of values, or empty array when no matching elements
- Public API for workers introduced by @koushikmohan1996. [Customize parallel execution](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/docs/parallel.md#custom-parallel-execution) with workers by building custom scripts.

- [Playwright] Added `usePlaywrightTo` method to access Playwright API in tests directly:

```js
I.usePlaywrightTo('do something special', async ({ page }) => {
  // use page or browser objects here
})
```

- [Puppeteer] Introduced `usePuppeteerTo` method to access Puppeteer API:

```js
I.usePuppeteerTo('do something special', async ({ page, browser }) => {
  // use page or browser objects here
})
```

- [WebDriver] Introduced `useWebDriverTo` method to access webdriverio API:

```js
I.useWebDriverTo('do something special', async ({ browser }) => {
  // use browser object here
})
```

- [Protractor] Introduced `useProtractorTo` method to access protractor API
- `tryTo` plugin introduced. Allows conditional action execution:

```js
const isSeen = await tryTo(() => {
  I.see('Some text')
})
// we are not sure if cookie bar is displayed, but if so - accept cookies
tryTo(() => I.click('Accept', '.cookies'))
```

- **Possible breaking change** In semantic locators `[` char indicates CSS selector.

## 2.6.11

- [Playwright] Playwright 1.4 compatibility
- [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains
- Added French translation by @vimar
- [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01

## 2.6.10

- Fixed saving options for suite via `Feature('title', {key: value})` by @Diokuz. See #2553 and [Docs](https://codecept.io/advanced/#dynamic-configuration)

## 2.6.9

- [Puppeteer][Playwright] SessionStorage is now cleared in after hook. See #2524
- When helper load failed the error stack is now logged by @SkReD. See #2541
- Small documentation fixes.

## 2.6.8

- [WebDriver][Protractor][Playwright][Puppeteer][Nightmare] `saveElementScreenshot` method added to make screenshot of an element. By @suniljaiswal01
- [Playwright][Puppeteer] Added `type` method to type a text using keyboard with an optional delay.
- [WebDriver] Added optional `delay` argument to `type` method to slow down typing.
- [Puppeteer] Fixed `amOnPage` freeze when `getPageTimeout` is 0"; set 30 sec as default timeout by @Vorobeyko.
- Fixed printing step with null argument in custom helper by @sjana-aj. See #2494
- Fix missing screenshot on failure when REST helper is in use #2513 by @PeterNgTr
- Improve error logging in the `screenshotOnFail` plugin #2512 by @pablopaul

## 2.6.7

- Add REST helper into `standardActingHelpers` array #2474 by @PeterNgTr
- Add missing `--invert` option for `run-workers` command #2504 by @pablopaul
- [WebDriver] Introduce `forceRightClick` method #2485 bylsuniljaiswal01
- [Playwright] Fix `setCookie` method #2491 by @bmbarker90
- [TypeScript] Update compilerOptions.target to es2017 #2483 by @shanplourde
- [Mocha] Honor reporter configuration #2465 by @trinhpham

## 2.6.6

- Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3
- Added `xFeature` and `Feature.skip` to skip all tests in a suite. By @Georgegriff
- [Appium] Fixed #2428 Android native locator support by @idxn
- [WebDriver] Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By @ilangv
- [Puppeteer] Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix #2436 by @Georgegriff
- [Puppeteer] Print error on page crash by @Georgegriff

## 2.6.5

- Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996
- [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff

## 2.6.4

- [Playwright] **Playwright 1.0 support** by @Georgegriff.

## 2.6.3

- [stepByStepReport plugin] Fixed when using plugin with BeforeSuite. Fixes #2337 by @mirao
- [allure plugin] Fixed reporting of tests skipped by failure in before hook. Refer to #2349 & #2354. Fix by @koushikmohan1996

## 2.6.2

- [WebDriver][Puppeteer] Added `forceClick` method to emulate click event instead of using native events.
- [Playwright] Updated to 0.14
- [Puppeteer] Updated to Puppeteer v3.0
- [wdio] Fixed undefined output directory for wdio plugns. Fix By @PeterNgTr
- [Playwright] Introduced `handleDownloads` method to download file. Please note, this method has slightly different API than the same one in Puppeteer.
- [allure] Fixed undefined output directory for allure plugin on using custom runner. Fix by @charliepradeep
- [WebDriver] Fixed `waitForEnabled` fix for webdriver 6. Fix by @dsharapkou
- Workers: Fixed negative failure result if use scenario with the same names. Fix by @Vorobeyko
- [MockRequest] Updated documentation to match new helper version
- Fixed: skipped tests are not reported if a suite failed in `before`. Refer #2349 & #2354. Fix by @koushikmohan1996

## 2.6.1

- [screenshotOnFail plugin] Fixed saving screenshot of active session.
- [screenshotOnFail plugin] Fix issue #2301 when having the flag `uniqueScreenshotNames`=true results in `undefined` in screenshot file name by @PeterNgTr
- [WebDriver] Fixed `waitForElement` not applying the optional second argument to override the default timeout in webdriverio 6. Fix by @Mooksc
- [WebDriver] Updated `waitUntil` method which is used by all of the wait\* functions. This updates the `waitForElement` by the same convention used to update `waitForVisible` and `waitInUrl` to be compatible with both WebDriverIO v5 & v6. See #2313 by @Mooksc

## 2.6.0

- **[Playwright] Updated to Playwright 0.12** by @Georgegriff.

Upgrade playwright to ^0.12:

```
npm i playwright@^0.12 --save
```

[Notable changes](https://github.com/microsoft/playwright/releases/tag/v0.12.0):

- Fixed opening two browsers on start
- `executeScript` - passed function now accepts only one argument. Pass in objects or arrays if you need multtple arguments:

```js
// Old style, does not work anymore:
I.executeScript((x, y) => x + y, x, y)
// New style, passing an object:
I.executeScript(({ x, y }) => x + y, { x, y })
```

- `click` - automatically waits for element to become clickable (visible, not animated) and waits for navigation.
- `clickLink` - deprecated
- `waitForClickable` - deprecated
- `forceClick` - added
- Added support for custom locators. See #2277
- Introduced [device emulation](/playwright/#device-emulation):
  - globally via `emulate` config option
  - per session

**[WebDriver] Updated to webdriverio v6** by @PeterNgTr.

Read [release notes](https://webdriver.io/blog/2020/03/26/webdriverio-v6-released.html), then
upgrade webdriverio to ^6.0:

```
npm i webdriverio@^6.0 --save
```

_(webdriverio v5 support is deprecated and will be removed in CodeceptJS 3.0)_

[WebDriver] Introduced [Shadow DOM support](/shadow) by @gkushang

```js
I.click({ shadow: ['my-app', 'recipe-hello', 'button'] })
```

- **Fixed parallel execution of `run-workers` for Gherkin** scenarios by @koushikmohan1996
- [MockRequest] Updated and **moved to [standalone package](https://github.com/codeceptjs/mock-request)**:
  - full support for record/replay mode for Puppeteer
  - added `mockServer` method to use flexible PollyJS API to define mocks
  - fixed stale browser screen in record mode.
- [Playwright] Added support on for `screenshotOnFail` plugin by @amonkc
- Gherkin improvement: setting different tags per examples. See #2208 by @acuper
- [TestCafe] Updated `click` to take first visible element. Fixes #2226 by @theTainted
- [Puppeteer][WebDriver] Updated `waitForClickable` method to check for element overlapping. See #2261 by @PiQx
- [Puppeteer] Dropped `puppeteer-firefox` support, as Puppeteer supports Firefox natively.
- [REST] Rrespect Content-Type header. See #2262 by @pmarshall-legacy
- [allure plugin] Fixes BeforeSuite failures in allure reports. See #2248 by @Georgegriff
- [WebDriver][Puppeteer][Playwright] A screenshot of for an active session is saved in multi-session mode. See #2253 by @ChexWarrior
- Fixed `--profile` option by @pablopaul. Profile value to be passed into `run-multiple` and `run-workers`:

```
npx codecept run-workers 2 --profile firefox
```

Value is available at `process.env.profile` (previously `process.profile`). See #2302. Fixes #1968 #1315

- [commentStep Plugin introduced](/plugins#commentstep). Allows to annotate logical parts of a test:

```js
__`Given`
I.amOnPage('/profile')

__`When`
I.click('Logout')

__`Then`
I.see('You are logged out')
```

## 2.5.0

- **Experimental: [Playwright](/playwright) helper introduced**.

> [Playwright](https://github.com/microsoft/playwright/) is an alternative to Puppeteer which works very similarly to it but adds cross-browser support with Firefox and Webkit. Until v1.0 Playwright API is not stable but we introduce it to CodeceptJS so you could try it.

- [Puppeteer] Fixed basic auth support when running in multiple sessions. See #2178 by @ian-bartholomew
- [Puppeteer] Fixed `waitForText` when there is no `body` element on page (redirect). See #2181 by @Vorobeyko
- [Selenoid plugin] Fixed overriding current capabilities by adding deepMerge. Fixes #2183 by @koushikmohan1996
- Added types for `Scenario.todo` by @Vorobeyko
- Added types for Mocha by @Vorobeyko. Fixed typing conflicts with Jest
- [FileSystem] Added methods by @nitschSB
  - `waitForFile`
  - `seeFileContentsEqualReferenceFile`
- Added `--colors` option to `run` and `run-multiple` so you force colored output in dockerized environment. See #2189 by @mirao
- [WebDriver] Added `type` command to enter value without focusing on a field. See #2198 by @xMutaGenx
- Fixed `codeceptjs gt` command to respect config pattern for tests. See #2200 and #2204 by @matheo

## 2.4.3

- Hotfix for interactive pause

## 2.4.2

- **Interactive pause improvements** by @koushikmohan1996
  - allows using in page objects and variables: `pause({ loginPage, a })`
  - enables custom commands inside pause with `=>` prefix: `=> loginPage.open()`
- [Selenoid plugin](/plugins#selenoid) added by by @koushikmohan1996
  - uses Selenoid to launch browsers inside Docker containers
  - automatically **records videos** and attaches them to allure reports
  - can delete videos for successful tests
  - can automatically pull in and start Selenoid containers
  - works with WebDriver helper
- Avoid failiure report on successful retry in worker by @koushikmohan1996
- Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996
  - 📢 Please help us translate context methods to your language! See [italian translation](https://github.com/codeceptjs/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/codeceptjs/CodeceptJS/tree/master/translations).
- allurePlugin: Added `say` comments to allure reports by @PeterNgTr.
- Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr
- [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr
- [WebDriver] Fixed `waitForClickable` to wait for exact number of seconds by @mirao. Resolves #2166
- Fixed setting `compilerOptions` in `jsconfig.json` file on init by @PeterNgTr
- [Filesystem] Added method by @nitschSB
  - `seeFileContentsEqualReferenceFile`
  - `waitForFile`

## 2.4.1

- [Hotfix] - Add missing lib that prevents codeceptjs from initializing.

## 2.4.0

- Improved setup wizard with `npx codecept init`:
  - **enabled [retryFailedStep](/plugins/#retryfailedstep) plugin for new setups**.
  - enabled [@codeceptjs/configure](/configuration/#common-configuration-patterns) to toggle headless/window mode via env variable
  - creates a new test on init
  - removed question on "steps file", create it by default.
- Added [pauseOnFail plugin](/plugins/#pauseonfail). _Sponsored by Paul Vincent Beigang and his book "[Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)"_.
- Added [`run-rerun` command](/commands/#run-rerun) to run tests multiple times to detect and fix flaky tests. By @Ilrilan and @Vorobeyko.
- Added [`Scenario.todo()` to declare tests as pending](/basics#todotest). See #2100 by @Vorobeyko
- Added support for absolute path for `output` dir. See #2049 by @elukoyanov
- Fixed error in `npx codecept init` caused by calling `console.print`. See #2071 by @Atinux.
- [Filesystem] Methods added by @aefluke:
  - `seeFileNameMatching`
  - `grabFileNames`
- [Puppeteer] Fixed grabbing attributes with hyphen by @Holorium
- [TestCafe] Fixed `grabAttributeFrom` method by @elukoyanov
- [MockRequest] Added support for [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) by @ecrmnn
- [TestCafe] Fixes exiting with zero code on failure. Fixed #2090 with #2106 by @koushikmohan1996
- [WebDriver][Puppeteer] Added basicAuth support via config. Example: `basicAuth: {username: 'username', password: 'password'}`. See #1962 by @PeterNgTr
- [WebDriver][Appium] Added `scrollIntoView` by @pablopaul
- Fixed #2118: No error stack trace for syntax error by @senthillkumar
- Added `parse()` method to data table inside Cucumber tests. Use it to obtain rows and hashes for test data. See #2082 by @Sraime

## 2.3.6

- Create better Typescript definition file through JSDoc. By @lemnis
- `run-workers` now can use glob pattern. By @Ilrilan

```js
// Example:
exports.config = {
  tests: '{./workers/base_test.workers.js,./workers/test_grep.workers.js}',
}
```

- Added new command `npx codeceptjs info` which print information about your environment and CodeceptJS configs. By @jamesgeorge007
- Fixed some typos in documantation. By @pablopaul @atomicpages @EricTendian
- Added PULL_REQUEST template.
- [Puppeteer][WebDriver] Added `waitForClickable` for waiting clickable element on page.
- [TestCafe] Added support for remote connection. By @jvdieten
- [Puppeteer] Fixed `waitForText` XPath context now works correctly. By @Heavik
- [TestCafe] Fixed `clearField` clear field now awaits TestCafe's promise. By @orihomie
- [Puppeteer] Fixed fails when executing localStorage on services pages. See #2026
- Fixed empty tags in test name. See #2038

## 2.3.5

- Set "parse-function" dependency to "5.2.11" to avoid further installation errors.

## 2.3.4

- Fixed installation error "Cannot find module '@babel/runtime/helpers/interopRequireDefault'". The issue came from `parse-function` package. Fixed by @pablopaul.
- [Puppeteer] Fixed switching to iframe without an ID by @johnyb. See #1974
- Added `--profile` option to `run-workers` by @orihomie
- Added a tag definition to `FeatureConfig` and `ScenarioConfig` by @sseliverstov

## 2.3.3

- **[customLocator plugin](#customlocator) introduced**. Adds a locator strategy for special test attributes on elements.

```js
// when data-test-id is a special test attribute
// enable and configure plugin to replace this
I.click({ css: '[data-test-id=register_button]');
// with this
I.click('$register_button');
```

- [Puppeteer][WebDriver] `pressKey` improvements by @martomo:
  Changed pressKey method to resolve issues and extend functionality.
  - Did not properly recognize 'Meta' (or 'Command') as modifier key.
  - Right modifier keys did not work in WebDriver using JsonWireProtocol.
  - 'Shift' + 'key' combination would not reflect actual keyboard behavior.
  - Respect sequence with multiple modifier keys passed to pressKey.
  - Added support to automatic change operation modifier key based on operating system.
- [Puppeteer][WebDriver] Added `pressKeyUp` and `pressKeyDown` to press and release modifier keys like `Control` or `Shift`. By @martomo.
- [Puppeteer][WebDriver] Added `grabElementBoundingRect` by @PeterNgTr.
- [Puppeteer] Fixed speed degradation introduced in #1306 with accessibility locators support. See #1953.
- Added `Config.addHook` to add a function that will update configuration on load.
- Started [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with a collection of common configuration patterns.
- [TestCafe] port's management removed (left on TestCafe itself) by @orihomie. Fixes #1934.
- [REST] Headers are no more declared as singleton variable. Fixes #1959
- Updated Docker image to include run tests in workers with `NUMBER_OF_WORKERS` env variable. By @PeterNgTr.

## 2.3.2

- [Puppeteer] Fixed Puppeteer 1.20 support by @davertmik
- Fixed `run-workers` to run with complex configs. See #1887 by @nitschSB
- Added `--suites` option to `run-workers` to split suites by workers (tests of the same suite goes to teh same worker). Thanks @nitschSB.
- Added a guide on [Email Testing](https://codecept.io/email).
- [retryFailedStepPlugin] Improved to ignore wait\* steps and others. Also added option to ignore this plugin per test bases. See [updated documentation](https://codecept.io/plugins#retryfailedstep). By @davertmik
- Fixed using PageObjects as classes by @Vorobeyko. See #1896
- [WebDriver] Fixed opening more than one tab. See #1875 by @jplegoff. Fixes #1874
- Fixed #1891 when `I.retry()` affected retries of next steps. By @davertmik

## 2.3.1

- [MockRequest] Polly helper was renamed to MockRequest.
- [MockRequest][WebDriver] [Mocking requests](https://codecept.io/webdriver#mocking-requests) is now available in WebDriver. Thanks @radhey1851
- [Puppeteer] Ensure configured user agent and/or window size is applied to all pages. See #1862 by @martomo
- Improve handling of xpath locators with round brackets by @nitschSB. See #1870
- Use WebDriver capabilities config in wdio plugin. #1869 by @quekshuy

## 2.3.0

- **[Parallel testing by workers](https://codecept.io/parallel#parallel-execution-by-workers) introduced** by @VikalpP and @davertmik. Use `run-workers` command as faster and simpler alternative to `run-multiple`. Requires NodeJS v12

```
# run all tests in parallel using 3 workers
npx codeceptjs run-workers 3
```

- [GraphQL][GraphQLDataFactory] **Helpers for data management over GraphQL** APIs added. By @radhey1851.
  - Learn how to [use GraphQL helper](https://codecept.io/data#graphql) to access GarphQL API
  - And how to combine it with [GraphQLDataFactory](https://codecept.io/data#graphql-data-factory) to generate and persist test data.
- **Updated to use Mocha 6**. See #1802 by @elukoyanov
- Added `dry-run` command to print steps of test scenarios without running them. Fails to execute scenarios with `grab*` methods or custom code. See #1825 for more details.

```
npx codeceptjs dry-run
```

- [Appium] Optimization when clicking, searching for fields by accessibility id. See #1777 by @gagandeepsingh26
- [TestCafe] Fixed `switchTo` by @KadoBOT
- [WebDriver] Added geolocation actions by @PeterNgTr
  - `grabGeoLocation()`
  - `setGeoLocation()`
- [Polly] Check typeof arguments for mock requests by @VikalpP. Fixes #1815
- CLI improvements by @jamesgeorge007
  - `codeceptjs` command prints list of all available commands
  - added `codeceptjs -V` flag to print version information
  - warns on unknown command
- Added TypeScript files support to `run-multiple` by @z4o4z
- Fixed element position bug in locator builder. See #1829 by @AnotherAnkor
- Various TypeScript typings updates by @elukoyanov and @Vorobeyko
- Added `event.step.comment` event for all comment steps like `I.say` or gherking steps.

## 2.2.1

- [WebDriver] A [dedicated guide](https://codecept.io/webdriver) written.
- [TestCafe] A [dedicated guide](https://codecept.io/testcafe) written.
- [Puppeteer] A [chapter on mocking](https://codecept.io/puppeteer#mocking-requests) written
- [Puppeteer][Nightmare][TestCafe] Window mode is enabled by default on `codeceptjs init`.
- [TestCafe] Actions implemented by @hubidu
  - `grabPageScrollPosition`
  - `scrollPageToTop`
  - `scrollPageToBottom`
  - `scrollTo`
  - `switchTo`
- Intellisense improvements. Renamed `tsconfig.json` to `jsconfig.json` on init. Fixed autocompletion for Visual Studio Code.
- [Polly] Take configuration values from Puppeteer. Fix #1766 by @VikalpP
- [Polly] Add preconditions to check for puppeteer page availability by @VikalpP. Fixes #1767
- [WebDriver] Use filename for `uploadFile` by @VikalpP. See #1797
- [Puppeteer] Configure speed of input with `pressKeyDelay` option. By @hubidu
- Fixed recursive loading of support objects by @davertmik.
- Fixed support object definitions in steps.d.ts by @johnyb. Fixes #1795
- Fixed `Data().Scenario().injectDependencies()` is not a function by @andrerleao
- Fixed crash when using xScenario & Scenario.skip with tag by @VikalpP. Fixes #1751
- Dynamic configuration of helpers can be performed with async function. See #1786 by @cviejo
- Added TS definitions for internal objects by @Vorobeyko
- BDD improvements:
  - Fix for snippets command with a .feature file that has special characters by @asselin
  - Fix `--path` option on `gherkin:snippets` command by @asselin. See #1790
  - Added `--feature` option to `gherkin:snippets` to enable creating snippets for a subset of .feature files. See #1803 by @asselin.
- Fixed: dynamic configs not reset after test. Fixes #1776 by @cviejo.

## 2.2.0

- **EXPERIMENTAL** [**TestCafe** helper](https://codecept.io/helpers/TestCafe) introduced. TestCafe allows to run cross-browser tests it its own very fast engine. Supports all browsers including mobile. Thanks to @hubidu for implementation! Please test it and send us feedback.
- [Puppeteer] Mocking requests enabled by introducing [Polly.js helper](https://codecept.io/helpers/Polly). Thanks @VikalpP

```js
// use Polly & Puppeteer helpers
I.mockRequest('GET', '/api/users', 200)
I.mockRequest('POST', '/users', { user: { name: 'fake' } })
```

- **EXPERIMENTAL** [Puppeteer] [Firefox support](https://codecept.io/helpers/Puppeteer-firefox) introduced by @ngadiyak, see #1740
- [stepByStepReportPlugin] use md5 hash to generate reports into unique folder. Fix #1744 by @chimurai
- Interactive pause improvements:
  - print result of `grab` commands
  - print message for successful assertions
- `run-multiple` (parallel execution) improvements:
  - `bootstrapAll` must be called before creating chunks. #1741 by @Vorobeyko
  - Bugfix: If value in config has falsy value then multiple config does not overwrite original value. #1756 by @LukoyanovE
- Fixed hooks broken in 2.1.5 by @Vorobeyko
- Fix references to support objects when using Dependency Injection. Fix by @johnyb. See #1701
- Fix dynamic config applied for multiple helpers by @VikalpP #1743

## 2.1.5

- **EXPERIMENTAL** [Wix Detox support](https://github.com/codeceptjs/detox-helper) introduced as standalone helper. Provides a faster alternative to Appium for mobile testing.
- Saving successful commands inside interactive pause into `_output/cli-history` file. By @hubidu
- Fixed hanging error handler inside scenario. See #1721 by @haily-lgc.
- Fixed by @Vorobeyko: tests did not fail when an exception was raised in async bootstrap.
- [WebDriver] Added window control methods by @emmonspired
  - `grabAllWindowHandles` returns all window handles
  - `grabCurrentWindowHandle` returns current window handle
  - `switchToWindow` switched to window by its handle
- [Appium] Fixed using `host` as configuration by @trinhpham
- Fixed `run-multiple` command when `tests` config option is undefined (in Gherkin scenarios). By @gkushang.
- German translation introduced by @hubidu

## 2.1.4

- [WebDriver][Puppeteer][Protractor][Nightmare] A11y locator support introduced by @Holorium. Clickable elements as well as fields can be located by following attributes:
  - `aria-label`
  - `title`
  - `aria-labelledby`
- [Puppeteer] Added support for React locators.
  - New [React Guide](https://codecept.io/react) added.
- [Puppeteer] Deprecated `downloadFile`
- [Puppeteer] Introduced `handleDownloads` replacing `downloadFile`
- [puppeteerCoverage plugin] Fixed path already exists error by @seta-tuha.
- Fixed 'ERROR: ENAMETOOLONG' creating directory names in `run-multiple` with long config. By @artvinn
- [REST] Fixed url autocompletion combining base and relative paths by @LukoyanovE
- [Nightmare][Protractor] `uncheckOption` method introduced by @PeterNgTr
- [autoLogin plugin] Enable to use without `await` by @tsuemura
- [Puppeteer] Fixed `UnhandledPromiseRejectionWarning: "Execution context was destroyed...` by @adrielcodeco
- [WebDriver] Keep browser window dimensions when starting a new session by @spiroid
- Replace Ghekrin plceholders with values in files that combine a scenerio outline and table by @medtoure18.
- Added Documentation to [locate elements in React Native](https://codecept.io/mobile-react-native-locators) apps. By @DimGun.
- Adding optional `path` parameter to `bdd:snippets` command to append snippets to a specific file. By @cthorsen31.
- Added optional `output` parameter to `def` command by @LukoyanovE.
- [Puppeteer] Added `grabDataFromPerformanceTiming` by @PeterNgTr.
- axios updated to `0.19.0` by @SteveShaffer
- TypeScript defitions updated by @LukoyanovE. Added `secret` and `inject` function.

## 2.1.3

- Fixed autoLogin plugin to inject `login` function
- Fixed using `toString()` in DataTablewhen it is defined by @tsuemura

## 2.1.2

- Fixed `inject` to load objects recursively.
- Fixed TypeScript definitions for locators by @LukoyanovE
- **EXPERIMENTAL** [WebDriver] ReactJS locators support with webdriverio v5.8+:

```js
// locating React element by name, prop, state
I.click({ react: 'component-name', props: {}, state: {} })
I.seeElement({ react: 'component-name', props: {}, state: {} })
```

## 2.1.1

- Do not retry `within` and `session` calls inside `retryFailedStep` plugin. Fix by @tsuemura

## 2.1.0

- Added global `inject()` function to require actor and page objects using dependency injection. Recommended to use in page objects, step definition files, support objects:

```js
// old way
const I = actor()
const myPage = require('../page/myPage')

// new way
const { I, myPage } = inject()
```

- Added global `secret` function to fill in sensitive data. By @RohanHart:

```js
I.fillField('password', secret('123456'))
```

- [wdioPlugin](https://codecept.io/plugins/#wdio) Added a plugin to **support webdriverio services** including _selenium-standalone_, _sauce_, _browserstack_, etc. **Sponsored by @GSasu**
- [Appium] Fixed `swipe*` methods by @PeterNgTr
- BDD Gherkin Improvements:
  - Implemented `run-multiple` for feature files. **Sponsored by @GSasu**
  - Added `--features` and `--tests` options to `run-multiple`. **Sponsored by @GSasu**
  - Implemented `Before` and `After` hooks in [step definitions](https://codecept.io/bdd#before)
- Fixed running tests by absolute path. By @batalov.
- Enabled the adding screenshot to failed test for moch-junit-reporter by @PeterNgTr.
- [Puppeteer] Implemented `uncheckOption` and fixed behavior of `checkOption` by @aml2610
- [WebDriver] Fixed `seeTextEquals` on empty strings by @PeterNgTr
- [Puppeteer] Fixed launch with `browserWSEndpoint` config by @ngadiyak.
- [Puppeteer] Fixed switching back to main window in multi-session mode by @davertmik.
- [autoLoginPlugin] Fixed using async functions for auto login by @nitschSB

> This release was partly sponsored by @GSasu. Thanks for the support!
> Do you want to improve this project? [Learn more about sponsorin CodeceptJS

## 2.0.8

- [Puppeteer] Added `downloadFile` action by @PeterNgTr.

Use it with `FileSystem` helper to test availability of a file:

```js
const fileName = await I.downloadFile('a.file-link')
I.amInPath('output')
I.seeFile(fileName)
```

> Actions `amInPath` and `seeFile` are taken from [FileSystem](https://codecept.io/helpers/FileSystem) helper

- [Puppeteer] Fixed `autoLogin` plugin with Puppeteer by @davertmik
- [WebDriver] `seeInField` should throw error if element has no value attrubite. By @PeterNgTr
- [WebDriver] Fixed `seeTextEquals` passes for any string if element is empty by @PeterNgTr.
- [WebDriver] Internal refctoring to use `el.isDisplayed` to match latest webdriverio implementation. Thanks to @LukoyanovE
- [allure plugin] Add ability enable [screenshotDiff plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md) by @Vorobeyko
- [Appium] Fixed `locator.stringify` call by @LukoyanovE

## 2.0.7

- [WebDriver][Protractor][Nightmare] `rightClick` method implemented (fixed) in a standard way. By @davertmik
- [WebDriver] Updated WebDriver API calls in helper. By @PeterNgTr
- [stepByStepReportPlugin] Added `screenshotsForAllureReport` config options to automatically attach screenshots to allure reports. By @PeterNgTr
- [allurePlugin] Added `addLabel` method by @Vorobeyko
- Locator Builder: fixed `withChild` and `withDescendant` to match deep nested siblings by @Vorobeyko.

## 2.0.6

- Introduced [Custom Locator Strategies](https://codecept.io/locators#custom-locators).
- Added [Visual Testing Guide](https://codecept.io/visual) by @puneet0191 and @MitkoTschimev.
- [Puppeteer] [`puppeteerCoverage`](https://codecept.io/plugins#puppeteercoverage) plugin added to collect code coverage in JS. By @dvillarama
- Make override option in `run-multiple` to respect the generated overridden config by @kinyat
- Fixed deep merge for `container.append()`. Introduced `lodash.merge()`. By @Vorobeyko
- Fixed saving screenshot on Windows by
- Fix errors on using interactive shell with Allure plugin by tsuemura
- Fixed using dynamic injections with `Scenario().injectDependencies` by @tsemura
- [WebDriver][Puppeteer][Nightmare][Protractor] Fixed url protocol detection for non-http urls by @LukoyanovE
- [WebDriver] Enabled compatibility with `stepByStepReport` by @tsuemura
- [WebDriver] Fixed `grabHTMLFrom` to return innerHTML value by @Holorium. Fixed compatibility with WebDriverIO.
- [WebDriver] `grabHTMLFrom` to return one HTML vlaue for one element matched, array if multiple elements found by @davertmik.
- [Nightmare] Added `grabHTMLFrom` by @davertmik
- Fixed `bootstrapAll` and `teardownAll` launch with path as argument by @LukoyanovE
- Fixed `bootstrapAll` and `teardownAll` calls from exported object by @LukoyanovE
- [WebDriver] Added possibility to define conditional checks interval for `waitUntil` by @LukoyanovE
- Fixed storing current data in data driven tests in a test object. By @Vorobeyko
- [WebDriver] Fixed `hostname` config option overwrite when setting a cloud provider. By @LukoyanovE
- [WebDriver] `dragSlider` method implemented by @DavertMik
- [WebDrover] Fixed `scrollTo` to use new webdriverio API by @PeterNgTr
- Added Japanese translation file by @tsemura
- Added `Locator.withDescendant()` method to find an element which contains a descendant (child, grandchild) by @Vorobeyko
- [WebDriver] Fixed configuring capabilities for Selenoid and IE by @Vorobeyko
- [WebDriver] Restore original window size when taking full size screenshot by @tsuemura
- Enabled `throws()`,` fails()`, `retry()`, `timeout()`, `config()` functions for data driven tests. By @jjm409

## 2.0.5

[Broken Release]

## 2.0.4

- [WebDriver][Protractor][Nightmare][Puppeteer] `grabAttributeFrom` returns an array when multiple elements matched. By @PeterNgTr
- [autoLogin plugin] Fixed merging users config by @nealfennimore
- [autoDelay plugin] Added WebDriver to list of supported helpers by @mattin4d
- [Appium] Fixed using locators in `waitForElement`, `waitForVisible`, `waitForInvisible`. By @eduardofinotti
- [allure plugin] Add tags to allure reports by @Vorobeyko
- [allure plugin] Add skipped tests to allure reports by @Vorobeyko
- Fixed `Logged Test name | [object Object]` when used Data().Scenario(). By @Vorobeyko
- Fixed Data().only.Scenario() to run for all datasets. By @Vorobeyko
- [WebDriver] `attachFile` to work with hidden elements. Fixed in #1460 by @tsuemura

## 2.0.3

- [**autoLogin plugin**](https://codecept.io/plugins#autologin) added. Allows to log in once and reuse browser session. When session expires - automatically logs in again. Can persist session between runs by saving cookies to file.
- Fixed `Maximum stack trace` issue in `retryFailedStep` plugin.
- Added `locate()` function into the interactive shell.
- [WebDriver] Disabled smartWait for interactive shell.
- [Appium] Updated methods to use for mobile locators
  - `waitForElement`
  - `waitForVisible`
  - `waitForInvisible`
- Helper and page object generators no longer update config automatically. Please add your page objects and helpers manually.

## 2.0.2

- [Puppeteer] Improved handling of connection with remote browser using Puppeteer by @martomo
- [WebDriver] Updated to webdriverio 5.2.2 by @martomo
- Interactive pause improvements by @davertmik
  - Disable retryFailedStep plugin in in interactive mode
  - Removes `Interface: parseInput` while in interactive pause
- [ApiDataFactory] Improvements
  - added `fetchId` config option to override id retrieval from payload
  - added `onRequest` config option to update request in realtime
  - added `returnId` config option to return ids of created items instead of items themvelves
  - added `headers` config option to override default headers.
  - added a new chapter into [DataManagement](https://codecept.io/data#api-requests-using-browser-session)
- [REST] Added `onRequest` config option

## 2.0.1

- Fixed creating project with `codecept init`.
- Fixed error while installing webdriverio@5.
- Added code beautifier for generated configs.
- [WebDriver] Updated to webdriverio 5.1.0

## 2.0.0

- [WebDriver] **Breaking Change.** Updated to webdriverio v5. New helper **WebDriver** helper introduced.
  - **Upgrade plan**:
    1. Install latest webdriverio

    ```
    npm install webdriverio@5 --save
    ```

    2. Replace `WebDriverIO` => `WebDriver` helper name in config.
    3. Read [webdriverio changelog](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md). If you were using webdriver API in your helpers, upgrade accordingly.
    4. We made WebDriver helper to be compatible with old API so no additional changes required.

    > If you face issues using webdriverio v5 you can still use webdriverio 4.x and WebDriverIO helper. Make sure you have `webdriverio: ^4.0` installed.

  - Known issues: `attachFile` doesn't work with proxy server.

- [Appium] **Breaking Change.** Updated to use webdriverio v5 as well. See upgrade plan ↑
- [REST] **Breaking Change.** Replaced `unirest` library with `axios`.
  - **Upgrade plan**:
    1. Refer to [axios API](https://github.com/axios/axios).
    2. If you were using `unirest` requests/responses in your tests change them to axios format.

- **Breaking Change.** Generators support in tests removed. Use `async/await` in your tests
- **Using `codecept.conf.js` as default configuration format**
- Fixed "enametoolong" error when saving screenshots for data driven tests by @PeterNgTr
- Updated NodeJS to 10 in Docker image
- [Pupeteer] Add support to use WSEndpoint. Allows to execute tests remotely. [See #1350] by @gabrielcaires (https://github.com/codeceptjs/CodeceptJS/pull/1350)
- In interactive shell [Enter] goes to next step. Improvement by @PeterNgTr.
- `I.say` accepts second parameter as color to print colorful comments. Improvement by @PeterNgTr.

```js
I.say('This is red', 'red') //red is used
I.say('This is blue', 'blue') //blue is used
I.say('This is by default') //cyan is used
```

- Fixed allure reports for multi session testing by @PeterNgTr
- Fixed allure reports for hooks by @PeterNgTr

## 1.4.6

- [Puppeteer] `dragSlider` action added by @PeterNgTr
- [Puppeteer] Fixed opening browser in shell mode by @allenhwkim
- [Puppeteer] Fixed making screenshot on additional sessions by @PeterNgTr. Fixes #1266
- Added `--invert` option to `run-multiple` command by @LukoyanovE
- Fixed steps in Allure reports by @PeterNgTr
- Add option `output` to customize output directory in [stepByStepReport plugin](https://codecept.io/plugins/#stepbystepreport). By @fpsthirty
- Changed type definition of PageObjects to get auto completion by @rhicu
- Fixed steps output for async/arrow functions in CLI by @LukoyanovE. See #1329

## 1.4.5

- Add **require** param to main config. Allows to require Node modules before executing tests. By @LukoyanovE. For example:
  - Use `ts-node/register` to register TypeScript parser
  - Use `should` to register should-style assertions

```js
"require": ["ts-node/register", "should"]
```

- [WebDriverIO] Fix timeouts definition to be compatible with W3C drivers. By @LukoyanovE
- Fixed: exception in Before block w/ Mocha causes test not to report failure. See #1292 by @PeterNgTr
- Command `run-parallel` now accepts `--override` flag. Thanks to @ClemCB
- Fixed Allure report with Before/BeforeSuite/After/AfterSuite steps. By @PeterNgTr
- Added `RUN_MULTIPLE` env variable to [Docker config](https://codecept.io/docker/). Allows to run tests in parallel inside a container. Thanks to @PeterNgTr
- [Mochawesome] Fixed showing screenshot on failure. Fix by @PeterNgTr
- Fixed running tests filtering by tag names defined via `Scenario.tag()`

## 1.4.4

- [autoDelay plugin](https://codecept.io/plugins/#autoDelay) added. Adds tiny delay before and after an action so the page could react to actions performed.
- [Puppeteer] improvements by @luismanuel001
  - `click` no longer waits for navigation
  - `clickLink` method added. Performs a click and waits for navigation.
- Bootstrap scripts to be started only for `run` command and ignored on `list`, `def`, etc. Fix by @LukoyanovE

## 1.4.3

- Groups renamed to Tags for compatibility with BDD layer
- Test and suite objects to contain tags property which can be accessed from internal API
- Fixed adding tags for Scenario Outline in BDD
- Added `tag()` method to ScenarioConfig and FeatureConfig:

```js
Scenario('update user profile', () => {
  // test goes here
}).tag('@slow')
```

- Fixed attaching Allure screenshot on exception. Fix by @DevinWatson
- Improved type definitions for custom steps. By @Akxe
- Fixed setting `multiple.parallel.chunks` as environment variable in config. See #1238 by @ngadiyak

## 1.4.2

- Fixed setting config for plugins (inclunding setting `outputDir` for allure) by @jplegoff

## 1.4.1

- Added `plugins` option to `run-multiple`
- Minor output fixes
- Added Type Definition for Helper class by @Akxe
- Fixed extracing devault extension in generators by @Akxe

## 1.4.0

- [**Allure Reporter Integration**](https://codecept.io/reports/#allure). Full inegration with Allure Server. Get nicely looking UI for tests,including steps, nested steps, and screenshots. Thanks **Natarajan Krishnamurthy @krish** for sponsoring this feature.
- [Plugins API introduced](https://codecept.io/hooks/#plugins). Create custom plugins for CodeceptJS by hooking into event dispatcher, and using promise recorder.
- **Official [CodeceptJS plugins](https://codecept.io/plugins) added**:
  - **`stepByStepReport` - creates nicely looking report to see test execution as a slideshow**. Use this plugin to debug tests in headless environment without recording a video.
  - `allure` - Allure reporter added as plugin.
  - `screenshotOnFail` - saves screenshot on fail. Replaces similar functionality from helpers.
  - `retryFailedStep` - to rerun each failed step.
- [Puppeteer] Fix `executeAsyncScript` unexpected token by @jonathanz
- Added `override` option to `run-multiple` command by @svarlet

## 1.3.3

- Added `initGlobals()` function to API of [custom runner](https://codecept.io/hooks/#custom-runner).

## 1.3.2

- Interactve Shell improvements for `pause()`
  - Added `next` command for **step-by-step debug** when using `pause()`.
  - Use `After(pause);` in a to start interactive console after last step.
- [Puppeteer] Updated to Puppeteer 1.6.0
  - Added `waitForRequest` to wait for network request.
  - Added `waitForResponse` to wait for network response.
- Improved TypeScript definitions to support custom steps and page objects. By @xt1
- Fixed XPath detection to accept XPath which starts with `./` by @BenoitZugmeyer

## 1.3.1

- BDD-Gherkin: Fixed running async steps.
- [Puppeteer] Fixed process hanging for 30 seconds. Page loading timeout default via `getPageTimeout` set 0 seconds.
- [Puppeteer] Improved displaying client-side console messages in debug mode.
- [Puppeteer] Fixed closing sessions in `restart:false` mode for multi-session mode.
- [Protractor] Fixed `grabPopupText` to not throw error popup is not opened.
- [Protractor] Added info on using 'direct' Protractor driver to helper documentation by @xt1.
- [WebDriverIO] Added a list of all special keys to WebDriverIO helper by @davertmik and @xt1.
- Improved TypeScript definitions generator by @xt1

## 1.3.0

- **Cucumber-style BDD. Introduced [Gherkin support](https://codecept.io/bdd). Thanks to [David Vins](https://github.com/dvins) and [Omedym](https://www.omedym.com) for sponsoring this feature**.

Basic feature file:

```gherkin
Feature: Business rules
  In order to achieve my goals
  As a persona
  I want to be able to interact with a system

  Scenario: do anything in my life
    Given I need to open Google
```

Step definition:

```js
const I = actor()

Given('I need to open Google', () => {
  I.amOnPage('https://google.com')
})
```

Run it with `--features --steps` flag:

```
codeceptjs run --steps --features
```

---

- **Brekaing Chnage** `run` command now uses relative path + test name to run exactly one test file.

Previous behavior (removed):

```
codeceptjs run basic_test.js
```

Current behavior (relative path to config + a test name)

```
codeceptjs run tests/basic_test.js
```

This change allows using auto-completion when running a specific test.

---

- Nested steps output enabled for page objects.
  - to see high-level steps only run tests with `--steps` flag.
  - to see PageObjects implementation run tests with `--debug`.
- PageObjects simplified to remove `_init()` extra method. Try updated generators and see [updated guide](https://codecept.io/pageobjects/#pageobject).
- [Puppeteer] [Multiple sessions](https://codecept.io/acceptance/#multiple-sessions) enabled. Requires Puppeteer >= 1.5
- [Puppeteer] Stability improvement. Waits for for `load` event on page load. This strategy can be changed in config:
  - `waitForNavigation` config option introduced. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
  - `getPageTimeout` config option to set maximum navigation time in milliseconds. Default is 30 seconds.
  - `waitForNavigation` method added. Explicitly waits for navigation to be finished.
- [WebDriverIO][Protractor][Puppeteer][Nightmare] **Possible BC** `grabTextFrom` unified. Return a text for single matched element and an array of texts for multiple elements.
- [Puppeteer]Fixed `resizeWindow` by @sergejkaravajnij
- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForFunction` added. Waits for client-side JavaScript function to return true by @GREENpoint.
- [Puppeteer] `waitUntil` deprecated in favor of `waitForFunction`.
- Added `filter` function to DataTable.
- Send non-nested array of files to custom parallel execution chunking by @mikecbrant.
- Fixed invalid output directory path for run-multiple by @mikecbrant.
- [WebDriverIO] `waitUntil` timeout accepts time in seconds (as all other wait\* functions). Fix by @truesrc.
- [Nightmare] Fixed `grabNumberOfVisibleElements` to work similarly to `seeElement`. Thx to @stefanschenk and Jinbo Jinboson.
- [Protractor] Fixed alert handling error with message 'no such alert' by @truesrc.

## 1.2.1

- Fixed running `I.retry()` on multiple steps.
- Fixed parallel execution wih chunks.
- [Puppeteer] Fixed `grabNumberOfVisibleElements` to return `0` instead of throwing error if no elements are found.

## 1.2.0

- [WebDriverIO][Protractor][Multiple Sessions](https://codecept.io/acceptance/#multiple-sessions). Run several browser sessions in one test. Introduced `session` command, which opens additional browser window and closes it after a test.

```js
Scenario('run in different browsers', I => {
  I.amOnPage('/hello')
  I.see('Hello!')
  session('john', () => {
    I.amOnPage('/bye')
    I.dontSee('Hello')
    I.see('Bye')
  })
  I.see('Hello')
})
```

- [Parallel Execution](https://codecept.io/advanced/#parallel-execution) by @sveneisenschmidt. Run tests in parallel specifying number of chunks:

```js
"multiple": {
  "parallel": {
    // run in 2 processes
    "chunks": 2,
    // run all tests in chrome
    "browsers": ["chrome"]
  },
}
```

- [Locator Builder](https://codecept.io/locators). Write complex locators with simplest API combining CSS and XPath:

```js
// select 'Edit' link inside 2nd row of a table
locate('//table').find('tr').at(2).find('a').withText('Edit')
```

- [Dynamic configuration](https://codecept.io/advanced/#dynamic-configuration) to update helpers config per test or per suite.
- Added `event.test.finished` which fires synchronously for both failed and passed tests.
- [WebDriverIO][Protractor][Nightmare][Puppeteer] Full page screenshots on failure disabled by default. See [issue#1600. You can enabled them with `fullPageScreenshots: true`, however they may work unstable in Selenium.
- `within` blocks can return values. See [updated documentation](https://codecept.io/basics/#within).
- Removed doublt call to `_init` in helpers. Fixes issue #1036
- Added scenario and feature configuration via fluent API:

```js
Feature('checkout').timeout(3000).retry(2)

Scenario('user can order in firefox', I => {
  // see dynamic configuration
})
  .config({ browser: 'firefox' })
  .timeout(20000)

Scenario('this test should throw error', I => {
  // I.amOnPage
}).throws(new Error())
```

## 1.1.8

- Fixed generating TypeScript definitions with `codeceptjs def`.
- Added Chinese translation ("zh-CN" and "zh-TW") by @TechQuery.
- Fixed running tests from a different folder specified by `-c` option.
- [Puppeteer] Added support for hash handling in URL by @gavoja.
- [Puppeteer] Fixed setting viewport size by @gavoja. See [Puppeteer issue](https://github.com/GoogleChrome/puppeteer/issues/1183)

## 1.1.7

- Docker Image updateed. [See updated reference](https://codecept.io/docker/):
  - codeceptjs package is mounted as `/codecept` insde container
  - tests directory is expected to be mounted as `/tests`
  - `codeceptjs` global runner added (symlink to `/codecept/bin/codecept.js`)
- [Protractor] Functions added by @reubenmiller:
  - `_locateCheckable (only available from other helpers)`
  - `_locateClickable (only available from other helpers)`
  - `_locateFields (only available from other helpers)`
  - `acceptPopup`
  - `cancelPopup`
  - `dragAndDrop`
  - `grabBrowserLogs`
  - `grabCssPropertyFrom`
  - `grabHTMLFrom`
  - `grabNumberOfVisibleElements`
  - `grabPageScrollPosition (new)`
  - `rightClick`
  - `scrollPageToBottom`
  - `scrollPageToTop`
  - `scrollTo`
  - `seeAttributesOnElements`
  - `seeCssPropertiesOnElements`
  - `seeInPopup`
  - `seeNumberOfVisibleElements`
  - `switchTo`
  - `waitForEnabled`
  - `waitForValue`
  - `waitInUrl`
  - `waitNumberOfVisibleElements`
  - `waitToHide`
  - `waitUntil`
  - `waitUrlEquals`
- [Nightmare] added:
  - `grabPageScrollPosition` (new)
  - `seeNumberOfVisibleElements`
  - `waitToHide`
- [Puppeteer] added:
  - `grabPageScrollPosition` (new)
- [WebDriverIO] added"
  - `grabPageScrollPosition` (new)
- [Puppeteer] Fixed running wait\* functions without setting `sec` parameter.
- [Puppeteer][Protractor] Fixed bug with I.click when using an object selector with the xpath property. By @reubenmiller
- [WebDriverIO][Protractor][Nightmare][Puppeteer] Fixed I.switchTo(0) and I.scrollTo(100, 100) api inconsistencies between helpers.
- [Protractor] Fixing bug when `seeAttributesOnElements` and `seeCssPropertiesOnElement` were incorrectly passing when the attributes/properties did not match by @reubenmiller
- [WebDriverIO] Use inbuilt dragAndDrop function (still doesn't work in Firefox). By @reubenmiller
- Support for Nightmare 3.0
- Enable glob patterns in `config.test` / `Codecept.loadTests` by @sveneisenschmidt
- Enable overriding of `config.tests` for `run-multiple` by @sveneisenschmidt

## 1.1.6

- Added support for `async I =>` functions syntax in Scenario by @APshenkin
- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForInvisible` waits for element to hide or to be removed from page. By @reubenmiller
- [Protractor][Puppeteer][Nightmare] Added `grabCurrentUrl` function. By @reubenmiller
- [WebDriverIO] `grabBrowserUrl` deprecated in favor of `grabCurrentUrl` to unify the API.
- [Nightmare] Improved element visibility detection by @reubenmiller
- [Puppeteer] Fixing function calls when clearing the cookies and localstorage. By @reubenmiller
- [Puppeteer] Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by @reubenmiller
- [WebDriverIO] Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By @michaltrunek
- Helpers API improvements (by @reubenmiller)
  - `_passed` hook runs after a test passed successfully
  - `_failed` hook runs on a failed test
- Hooks API. New events added by @reubenmiller:
  - `event.all.before` - executed before all tests
  - `event.all.after` - executed after all tests
  - `event.multiple.before` - executed before all processes in run-multiple
  - `event.multiple.after` - executed after all processes in run-multiple
- Multiple execution
- Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By @reubenmiller
- [Nightmare] Prevent `I.amOnpage` navigation if the browser is already at the given url
- Multiple-Run: Added new `bootstrapAll` and `teardownAll` hooks to be executed before and after all processes
- `codeceptjs def` command accepts `--config` option. By @reubenmiller

## 1.1.5

- [Puppeteer] Rerun steps failed due to "Cannot find context with specified id" Error.
- Added syntax to retry a single step:

```js
// retry action once on failure
I.retry().see('Hello')

// retry action 3 times on failure
I.retry(3).see('Hello')

// retry action 3 times waiting for 0.1 second before next try
I.retry({ retries: 3, minTimeout: 100 }).see('Hello')

// retry action 3 times waiting no more than 3 seconds for last retry
I.retry({ retries: 3, maxTimeout: 3000 }).see('Hello')

// retry 2 times if error with message 'Node not visible' happens
I.retry({
  retries: 2,
  when: err => err.message === 'Node not visible',
}).seeElement('#user')
```

- `Scenario().injectDependencies` added to dynamically add objects into DI container by @Apshenkin. See [Dependency Injection section in PageObjects](https://codecept.io/pageobjects/#dependency-injection).
- Fixed using async/await functions inside `within`
- [WebDriverIO][Protractor][Puppeteer][Nightmare] **`waitUntilExists` deprecated** in favor of `waitForElement`
- [WebDriverIO][Protractor] **`waitForStalenessOf` deprecated** in favor of `waitForDetached`
- [WebDriverIO][Protractor][Puppeteer][Nightmare] `waitForDetached` added
- [Nightmare] Added `I.seeNumberOfElements()` by @pmoncadaisla
- [Nightmare] Load blank page when starting nightmare so that the .evaluate function will work if \_failed/saveScreenshot is triggered by @reubenmiller
- Fixed using plain arrays for data driven tests by @reubenmiller
- [Puppeteer] Use default tab instead of opening a new tab when starting the browser by @reubenmiller
- [Puppeteer] Added `grabNumberOfTabs` function by @reubenmiller
- [Puppeteer] Add ability to set user-agent by @abidhahmed
- [Puppeteer] Add keepCookies and keepBrowserState @abidhahmed
- [Puppeteer] Clear value attribute instead of innerhtml for TEXTAREA by @reubenmiller
- [REST] fixed sending string payload by @michaltrunek
- Fixed unhandled rejection in async/await tests by @APshenkin

## 1.1.4

- Removed `yarn` call in package.json
- Fixed `console.log` in Puppeteer by @othree
- [Appium] `runOnAndroid` and `runOnIOS` can receive a function to check capabilities dynamically:

```js
I.runOnAndroid(
  caps => caps.platformVersion >= 7,
  () => {
    // run code only on Android 7+
  },
)
```

## 1.1.3

- [Puppeteer] +25 Functions added by @reubenmiller
  - `_locateCheckable`
  - `_locateClickable`
  - `_locateFields`
  - `closeOtherTabs`
  - `dragAndDrop`
  - `grabBrowserLogs`
  - `grabCssPropertyFrom`
  - `grabHTMLFrom`
  - `grabNumberOfVisibleElements`
  - `grabSource`
  - `rightClick`
  - `scrollPageToBottom`
  - `scrollPageToTop`
  - `scrollTo`
  - `seeAttributesOnElements`
  - `seeCssPropertiesOnElements`
  - `seeInField`
  - `seeNumberOfElements`
  - `seeNumberOfVisibleElements`
  - `seeTextEquals`
  - `seeTitleEquals`
  - `switchTo`
  - `waitForInvisible`
  - `waitInUrl`
  - `waitUrlEquals`
- [Protractor] +8 functions added by @reubenmiller
  - `closeCurrentTab`
  - `grabSource`
  - `openNewTab`
  - `seeNumberOfElements`
  - `seeTextEquals`
  - `seeTitleEquals`
  - `switchToNextTab`
  - `switchToPreviousTab`
- [Nightmare] `waitForInvisible` added by @reubenmiller
- [Puppeteer] Printing console.log information in debug mode.
- [Nightmare] Integrated with `nightmare-har-plugin` by mingfang. Added `enableHAR` option. Added HAR functions:
  - `grabHAR`
  - `saveHAR`
  - `resetHAR`
- [WebDriverIO] Fixed execution stability for parallel requests with Chromedriver
- [WebDriverIO] Fixed resizeWindow when resizing to 'maximize' by @reubenmiller
- [WebDriverIO] Fixing resizing window to full screen when taking a screenshot by @reubenmiller

## 1.1.2

- [Puppeteer] Upgraded to Puppeteer 1.0
- Added `grep` option to config to set default matching pattern for tests.
- [Puppeteer] Added `acceptPopup`, `cancelPopup`, `seeInPopup` and `grabPopupText` functions by @reubenmiller
- [Puppeteer] `within` iframe and nested iframe support added by @reubenmiller
- [REST] Added support for JSON objects since payload (as a JSON) was automatically converted into "URL query" type of parameter by @Kalostrinho
- [REST] Added `resetRequestHeaders` method by @Kalostrinho
- [REST] Added `followRedirect` option and `amFollowingRequestRedirects`/`amNotFollowingRequestRedirects` methods by @Kalostrinho
- [WebDriverIO] `uncheckOption` implemented by @brunobg
- [WebDriverIO] Added `grabBrowserUrl` by @Kalostrinho
- Add ability to require helpers from node_modules by @APshenkin
- Added `--profile` option to `run-multiple` command by @jamie-beck
- Custom output name for multiple browser run by @tfiwm
- Fixed passing data to scenarios by @KennyRules

## 1.1.1

- [WebDriverIO] fixed `waitForInvisible` by @Kporal

## 1.1.0

Major update to CodeceptJS. **NodeJS v 8.9.1** is now minimal Node version required.
This brings native async-await support to CodeceptJS. It is recommended to start using await for tests instead of generators:

```js
;async () => {
  I.amOnPage('/page')
  const url = await I.grabTextFrom('.nextPage')
  I.amOnPage(url)
}
```

Thanks to [@Apshenkin](https://github.com/apshenkin) for implementation. Also, most helpers were refactored to use async-await. This made our code simpler. We hope that this encourages more users to send pull requests!

We also introduced strict ESLint policies for our codebase. Thanks to [@Galkin](https://github.com/galkin) for that.

- **[Puppeteer] Helper introduced**. [Learn how to run tests headlessly with Google Chrome's Puppeteer](http://codecept.io/puppeteer/).
- [SeleniumWebdriver] Helper is deprecated, it is recommended to use Protractor with config option `angular: false` instead.
- [WebDriverIO] nested iframe support in the within block by @reubenmiller. Example:

```js
within({frame: ['#wrapperId', '[name=content]']}, () => {
  I.click('Sign in!');
  I.see('Email Address');
});
I.see('Nested Iframe test');
I.dontSee('Email Address');
});
```

- [WebDriverIO] Support for `~` locator to find elements by `aria-label`. This behavior is similar as it is in Appium and helps testing cross-platform React apps. Example:

```html
<Text accessibilityLabel="foobar"> CodeceptJS is awesome </Text>
```

↑ This element can be located with `~foobar` in WebDriverIO and Appium helpers. Thanks to @flyskywhy

- Allow providing arbitrary objects in config includes by @rlewan
- [REST] Prevent from mutating default headers by @alexashley. See #789
- [REST] Fixed sending empty helpers with `haveRequestHeaders` in `sendPostRequest`. By @petrisorionel
- Fixed displaying undefined args in output by @APshenkin
- Fixed NaN instead of seconds in output by @APshenkin
- Add browser name to report file for `multiple-run` by @trollr
- Mocha updated to 4.x

## 1.0.3

- [WebDriverIO][Protractor][Nightmare] method `waitUntilExists` implemented by @sabau
- Absolute path can be set for `output` dir by @APshenkin. Fix #571\* Data table rows can be ignored by using `xadd`. By @APhenkin
- Added `Data(table).only.Scenario` to give ability to launch only Data tests. By @APhenkin
- Implemented `ElementNotFound` error by @BorisOsipov.
- Added TypeScript compiler / configs to check the JavaScript by @KennyRules
- [Nightmare] fix executeScript return value by @jploskonka
- [Nightmare] fixed: err.indexOf not a function when waitForText times out in nightmare by @joeypedicini92
- Fixed: Retries not working when using .only. By @APhenkin

## 1.0.2

- Introduced generators support in scenario hooks for `BeforeSuite`/`Before`/`AfterSuite`/`After`
- [ApiDataFactory] Fixed loading helper; `requireg` package included.
- Fix #485`run-multiple`: the first browser-resolution combination was be used in all configurations
- Fixed unique test names:
  - Fixed #447 tests failed silently if they have the same name as other tests.
  - Use uuid in screenshot names when `uniqueScreenshotNames: true`
- [Protractor] Fixed testing non-angular application. `amOutsideAngularApp` is executed before each step. Fixes #458\* Added output for steps in hooks when they fail

## 1.0.1

- Reporters improvements:
  - Allows to execute [multiple reporters](http://codecept.io/advanced/#Multi-Reports)
  - Added [Mochawesome](http://codecept.io/helpers/Mochawesome/) helper
  - `addMochawesomeContext` method to add custom data to mochawesome reports
  - Fixed Mochawesome context for failed screenshots.
- [WebDriverIO] improved click on context to match clickable element with a text inside. Fixes #647\* [Nightmare] Added `refresh` function by @awhanks
- fixed `Unhandled promise rejection (rejection id: 1): Error: Unknown wait type: pageLoad`
- support for tests with retries in html report
- be sure that change window size and timeouts completes before test
- [Nightmare] Fixed `[Wrapped Error] "codeceptjs is not defined"`; Reinjectiing client scripts to a webpage on changes.
- [Nightmare] Added more detailed error messages for `Wait*` methods
- [Nightmare] Fixed adding screenshots to Mochawesome
- [Nightmare] Fix unique screenshots names in Nightmare
- Fixed CodeceptJS work with hooks in helpers to finish codeceptJS correctly if errors appears in helpers hooks
- Create a new session for next test If selenium grid error received
- Create screenshots for failed hooks from a Feature file
- Fixed `retries` option

## 1.0

CodeceptJS hits first stable release. CodeceptJS provides a unified API for [web testing for Webdriverio](http://codecept.io/acceptance/), [Protractor](http://codecept.io/angular/), and [NightmareJS](http://codecept.io/nightmare/). Since 1.0 you can also **test mobile applications** in the similar manner with Appium.

Sample test:

```js
I.seeAppIsInstalled("io.super.app");
I.click('~startUserRegistrationCD');
I.fillField('~email of the customer', 'Nothing special'));
I.see('davert@codecept.io', '~email of the customer'));
I.clearField('~email of the customer'));
I.dontSee('Nothing special', '~email of the customer'));
```

- Read [the Mobile Testing guide](http://codecept.io/mobile).
- Discover [Appium Helper](http://codecept.io/helpers/Appium/)

---

We also introduced two new **helpers for data management**.
Using them you can easily prepare and cleanup data for your tests using public REST API.

Sample test

```js
// create a user using data factories and REST API
I.have('user', { name: 'davert', password: '123456' })
// use it to login
I.amOnPage('/login')
I.fillField('login', 'davert')
I.fillField('password', '123456')
I.click('Login')
I.see('Hello, davert')
// user will be removed after the test
```

- Read [Data Management guide](http://codecept.io/data)
- [REST Helper](http://codecept.io/helpers/REST)
- [ApiDataFactory](http://codecept.io/helpers/ApiDataFactory/)

---

Next notable feature is **[SmartWait](http://codecept.io/acceptance/#smartwait)** for WebDriverIO, Protractor, SeleniumWebdriver. When `smartwait` option is set, script will wait for extra milliseconds to locate an element before failing. This feature uses implicit waits of Selenium but turns them on only in applicable pieces. For instance, implicit waits are enabled for `seeElement` but disabled for `dontSeeElement`

- Read more about [SmartWait](http://codecept.io/acceptance/#smartwait)

##### Changelog

- Minimal NodeJS version is 6.11.1 LTS
- Use `within` command with generators.
- [Data Driven Tests](http://codecept.io/advanced/#data-driven-tests) introduced.
- Print execution time per step in `--debug` mode. #591 by @APshenkin
- [WebDriverIO][Protractor][Nightmare] Added `disableScreenshots` option to disable screenshots on fail by @Apshenkin
- [WebDriverIO][Protractor][Nightmare] Added `uniqueScreenshotNames` option to generate unique names for screenshots on failure by @Apshenkin
- [WebDriverIO][Nightmare] Fixed click on context; `click('text', '#el')` will throw exception if text is not found inside `#el`.
- [WebDriverIO][Protractor][SeleniumWebdriver] [SmartWait introduced](http://codecept.io/acceptance/#smartwait).
- [WebDriverIO][Protractor][Nightmare]Fixed `saveScreenshot` for PhantomJS, `fullPageScreenshots` option introduced by @HughZurname #549
- [Appium] helper introduced by @APshenkin
- [REST] helper introduced by @atrevino in #504
- [WebDriverIO][SeleniumWebdriver] Fixed "windowSize": "maximize" for Chrome 59+ version #560 by @APshenkin
- [Nightmare] Fixed restarting by @APshenkin #581
- [WebDriverIO] Methods added by @APshenkin:
  - [grabCssPropertyFrom](http://codecept.io/helpers/WebDriverIO/#grabcsspropertyfrom)
  - [seeTitleEquals](http://codecept.io/helpers/WebDriverIO/#seetitleequals)
  - [seeTextEquals](http://codecept.io/helpers/WebDriverIO/#seetextequals)
  - [seeCssPropertiesOnElements](http://codecept.io/helpers/WebDriverIO/#seecsspropertiesonelements)
  - [seeAttributesOnElements](http://codecept.io/helpers/WebDriverIO/#seeattributesonelements)
  - [grabNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#grabnumberofvisibleelements)
  - [waitInUrl](http://codecept.io/helpers/WebDriverIO/#waitinurl)
  - [waitUrlEquals](http://codecept.io/helpers/WebDriverIO/#waiturlequals)
  - [waitForValue](http://codecept.io/helpers/WebDriverIO/#waitforvalue)
  - [waitNumberOfVisibleElements](http://codecept.io/helpers/WebDriverIO/#waitnumberofvisibleelements)
  - [switchToNextTab](http://codecept.io/helpers/WebDriverIO/#switchtonexttab)
  - [switchToPreviousTab](http://codecept.io/helpers/WebDriverIO/#switchtoprevioustab)
  - [closeCurrentTab](http://codecept.io/helpers/WebDriverIO/#closecurrenttab)
  - [openNewTab](http://codecept.io/helpers/WebDriverIO/#opennewtab)
  - [refreshPage](http://codecept.io/helpers/WebDriverIO/#refreshpage)
  - [scrollPageToBottom](http://codecept.io/helpers/WebDriverIO/#scrollpagetobottom)
  - [scrollPageToTop](http://codecept.io/helpers/WebDriverIO/#scrollpagetotop)
  - [grabBrowserLogs](http://codecept.io/helpers/WebDriverIO/#grabbrowserlogs)
- Use mkdirp to create output directory. #592 by @vkramskikh
- [WebDriverIO] Fixed `seeNumberOfVisibleElements` by @BorisOsipov #574
- Lots of fixes for promise chain by @APshenkin #568
  - Fix #543- After block not properly executed if Scenario fails
  - Expected behavior in promise chains: `_beforeSuite` hooks from helpers -> `BeforeSuite` from test -> `_before` hooks from helpers -> `Before` from test - > Test steps -> `_failed` hooks from helpers (if test failed) -> `After` from test -> `_after` hooks from helpers -> `AfterSuite` from test -> `_afterSuite` hook from helpers.
  - if during test we got errors from any hook (in test or in helper) - stop complete this suite and go to another
  - if during test we got error from Selenium server - stop complete this suite and go to another
  - [WebDriverIO][Protractor] if `restart` option is false - close all tabs expect one in `_after`.
  - Complete `_after`, `_afterSuite` hooks even After/AfterSuite from test was failed
  - Don't close browser between suites, when `restart` option is false. We should start browser only one time and close it only after all tests.
  - Close tabs and clear local storage, if `keepCookies` flag is enabled
- Fix TypeError when using babel-node or ts-node on node.js 7+ #586 by @vkramskikh
- [Nightmare] fixed usage of `_locate`

Special thanks to **Andrey Pshenkin** for his work on this release and the major improvements.

## 0.6.3

- Errors are printed in non-verbose mode. Shows "Selenium not started" and other important errors.
- Allowed to set custom test options:

```js
Scenario('My scenario', { build_id: 123, type: 'slow' }, function (I)
```

those options can be accessed as `opts` property inside a `test` object. Can be used in custom listeners.

- Added `docs` directory to a package.
- [WebDriverIO][Protractor][SeleniumWebdriver] Bugfix: cleaning session when `restart: false` by @tfiwm #519
- [WebDriverIO][Protractor][Nightmare] Added second parameter to `saveScreenshot` to allow a full page screenshot. By @HughZurname
- Added suite object to `suite.before` and `suite.after` events by @implico. #496

## 0.6.2

- Added `config` object to [public API](http://codecept.io/hooks/#api)
- Extended `index.js` to include `actor` and `helpers`, so they could be required:

```js
const actor = require('codeceptjs').actor
```

- Added [example for creating custom runner](http://codecept.io/hooks/#custom-runner) with public API.
- run command to create `output` directory if it doesn't exist
- [Protractor] fixed loading globally installed Protractor
- run-multiple command improvements:
  - create output directories for each process
  - print process ids in output

## 0.6.1

- Fixed loading hooks

## 0.6.0

Major release with extension API and parallel execution.

- **Breaking** Removed path argument from `run`. To specify path other than current directory use `--config` or `-c` option:

Instead of: `codeceptjs run tests` use:

```
# load config and run from tests directory
codeceptjs run -c tests/

# or load codecept.json from tests directory
codeceptjs run -c tests/codecept.json

# run users_test.js inside tests directory
codeceptjs run users_test.js -c tests
```

- **Command `multiple-run` added**, to execute tests in several browsers in parallel by @APshenkin and @davertmik. [See documentation](http://codecept.io/advanced/#multiple-execution).
- **Hooks API added to extend CodeceptJS** with custom listeners and plugins. [See documentation](http://codecept.io/hooks/#hooks_1).
- [Nightmare][WebDriverIO] `within` can work with iframes by @imvetri. [See documentation](http://codecept.io/acceptance/#iframes).
- [WebDriverIO][SeleniumWebdriver][Protractor] Default browser changed to `chrome`
- [Nightmare] Fixed globally locating `nightmare-upload`.
- [WebDriverIO] added `seeNumberOfVisibleElements` method by @elarouche.
- Exit with non-zero code if init throws an error by @rincedd
- New guides published:
  - [Installation](http://codecept.io/installation/)
  - [Hooks](http://codecept.io/hooks/)
  - [Advanced Usage](http://codecept.io/advanced/)
- Meta packages published:
  - [codecept-webdriverio](https://www.npmjs.com/package/codecept-webdriverio)
  - [codecept-protractor](https://www.npmjs.com/package/codecept-protractor)
  - [codecept-nightmare](https://www.npmjs.com/package/codecept-nightmare)

## 0.5.1

- [Polish translation](http://codecept.io/translation/#polish) added by @limes.
- Update process exit code so that mocha saves reports before exit by @romanovma.
- [Nightmare] fixed `getAttributeFrom` for custom attributes by @robrkerr
- [Nightmare] Fixed _UnhandledPromiseRejectionWarning error_ when selecting the dropdown using `selectOption` by @robrkerr. [Se PR.
- [Protractor] fixed `pressKey` method by @romanovma

## 0.5.0

- Protractor ^5.0.0 support (while keeping ^4.0.9 compatibility)
- Fix 'fullTitle() is not a function' in exit.js by @hubidu. See #388.
- [Nightmare] Fix for `waitTimeout` by @HughZurname. See #391. Resolves #236\* Dockerized CodeceptJS setup by @artiomnist. [See reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docker/README.md)

## 0.4.16

- Fixed steps output synchronization (regression since 0.4.14).
- [WebDriverIO][Protractor][SeleniumWebdriver][Nightmare] added `keepCookies` option to keep cookies between tests with `restart: false`.
- [Protractor] added `waitForTimeout` config option to set default waiting time for all wait\* functions.
- Fixed `_test` hook for helpers by @cjhille.

## 0.4.15

- Fixed regression in recorder sessions: `oldpromise is not defined`.

## 0.4.14

- `_beforeStep` and `_afterStep` hooks in helpers are synchronized. Allows to perform additional actions between steps.

Example: fail if JS error occur in custom helper using WebdriverIO:

```js
_before() {
  this.err = null;
  this.helpers['WebDriverIO'].browser.on('error', (e) => this.err = e);
}

_afterStep() {
 if (this.err) throw new Error('Browser JS error '+this.err);
}
```

Example: fail if JS error occur in custom helper using Nightmare:

```js
_before() {
  this.err = null;
  this.helpers['Nightmare'].browser.on('page', (type, message, stack) => {
    this.err = `${message} ${stack}`;
  });
}

_afterStep() {
 if (this.err) throw new Error('Browser JS error '+this.err);
}
```

- Fixed `codecept list` and `codecept def` commands.
- Added `I.say` method to print arbitrary comments.

```js
I.say('I am going to publish post')
I.say('I enter title and body')
I.say('I expect post is visible on site')
```

- [Nightmare] `restart` option added. `restart: false` allows to run all tests in a single window, disabled by default. By @nairvijays99
- [Nightmare] Fixed `resizeWindow` command.
- [Protractor][SeleniumWebdriver] added `windowSize` config option to resize window on start.
- Fixed "Scenario.skip causes 'Cannot read property retries of undefined'" by @MasterOfPoppets
- Fixed providing absolute paths for tests in config by @lennym

## 0.4.13

- Added **retries** option `Feature` and `Scenario` to rerun fragile tests:

```js
Feature('Complex JS Stuff', { retries: 3 })

Scenario('Not that complex', { retries: 1 }, I => {
  // test goes here
})
```

- Added **timeout** option `Feature` and `Scenario` to specify timeout.

```js
Feature('Complex JS Stuff', { timeout: 5000 })

Scenario('Not that complex', { timeout: 1000 }, I => {
  // test goes here
})
```

- [WebDriverIO] Added `uniqueScreenshotNames` option to set unique screenshot names for failed tests. By @APshenkin. See #299
- [WebDriverIO] `clearField` method improved to accept name/label locators and throw errors.
- [Nightmare][SeleniumWebdriver][Protractor] `clearField` method added.
- [Nightmare] Fixed `waitForElement`, and `waitForVisible` methods.
- [Nightmare] Fixed `resizeWindow` by @norisk-it
- Added italian [translation](http://codecept.io/translation/#italian).

## 0.4.12

- Bootstrap / Teardown improved with [Hooks](http://codecept.io/configuration/#hooks). Various options for setup/teardown provided.
- Added `--override` or `-o` option for runner to dynamically override configs. Valid JSON should be passed:

```
codeceptjs run -o '{ "bootstrap": "bootstrap.js"}'
codeceptjs run -o '{ "helpers": {"WebDriverIO": {"browser": "chrome"}}}'
```

- Added [regression tests](https://github.com/codeceptjs/CodeceptJS/tree/master/test/runner) for codeceptjs tests runner.

## 0.4.11

- Fixed regression in 0.4.10
- Added `bootstrap`/`teardown` config options to accept functions as parameters by @pscanf. See updated [config reference](http://codecept.io/configuration/) #319

## 0.4.10

- [Protractor] Protrctor 4.0.12+ support.
- Enabled async bootstrap file by @abachar. Use inside `bootstrap.js`:

```js
module.exports = function (done) {
  // async instructions
  // call done() to continue execution
  // otherwise call done('error description')
}
```

- Changed 'pending' to 'skipped' in reports by @timja-kainos. See #315

## 0.4.9

- [SeleniumWebdriver][Protractor][WebDriverIO][Nightmare] fixed `executeScript`, `executeAsyncScript` to work and return values.
- [Protractor][SeleniumWebdriver][WebDriverIO] Added `waitForInvisible` and `waitForStalenessOf` methods by @Nighthawk14.
- Added `--config` option to `codeceptjs run` to manually specify config file by @cnworks
- [Protractor] Simplified behavior of `amOutsideAngularApp` by using `ignoreSynchronization`. Fixes #278
- Set exit code to 1 when test fails at `Before`/`After` hooks. Fixes #279

## 0.4.8

- [Protractor][SeleniumWebdriver][Nightmare] added `moveCursorTo` method.
- [Protractor][SeleniumWebdriver][WebDriverIO] Added `manualStart` option to start browser manually in the beginning of test. By @cnworks. [PR#250
- Fixed `codeceptjs init` to work with nested directories and file masks.
- Fixed `codeceptjs gt` to generate test with proper file name suffix. By @Zougi.
- [Nightmare] Fixed: Error is thrown when clicking on element which can't be locate. By @davetmik
- [WebDriverIO] Fixed `attachFile` for file upload. By @giuband and @davetmik
- [WebDriverIO] Add support for timeouts in config and with `defineTimeouts` method. By @easternbloc #258 and #267 by @davetmik
- Fixed hanging of CodeceptJS when error is thrown by event dispatcher. Fix by @Zougi and @davetmik

## 0.4.7

- Improved docs for `BeforeSuite`; fixed its usage with `restart: false` option by @APshenkin.
- Added `Nightmare` to list of available helpers on `init`.
- [Nightmare] Removed double `resizeWindow` implementation.

## 0.4.6

- Added `BeforeSuite` and `AfterSuite` hooks to scenario by @APshenkin. See [updated documentation](http://codecept.io/basics/#beforesuite)

## 0.4.5

- Fixed running `codecept def` command by @jankaspar
- [Protractor][SeleniumWebdriver] Added support for special keys in `pressKey` method. Fixes #216

## 0.4.4

- Interactive shell fixed. Start it by running `codeceptjs shell`
- Added `--profile` option to `shell` command to use dynamic configuration.
- Added `--verbose` option to `shell` command for most complete output.

## 0.4.3

- [Protractor] Regression fixed to ^4.0.0 support
- Translations included into package.
- `teardown` option added to config (opposite to `bootstrap`), expects a JS file to be executed after tests stop.
- [Configuration](http://codecept.io/configuration/) can be set via JavaScript file `codecept.conf.js` instead of `codecept.json`. It should export `config` object:

```js
// inside codecept.conf.js
exports.config = {
  // contents of codecept.js
}
```

- Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration).
- Documentation for [StepObjects, PageFragments](http://codecept.io/pageobjects#PageFragments) updated.
- Documentation for [Configuration](http://codecept.io/configuration/) added.

## 0.4.2

- Added ability to localize tests with translation #189. Thanks to @abner
  - [Translation] ru-RU translation added.
  - [Translation] pt-BR translation added.
- [Protractor] Protractor 4.0.4 compatibility.
- [WebDriverIO][SeleniumWebdriver][Protractor] Fixed single browser session mode for `restart: false`
- Fixed using of 3rd party reporters (xunit, mocha-junit-reporter, mochawesome). Added guide.
- Documentation for [Translation](http://codecept.io/translation/) added.
- Documentation for [Reports](http://codecept.io/reports/) added.

## 0.4.1

- Added custom steps to step definition list. See #174 by @jayS-de
- [WebDriverIO] Fixed using `waitForTimeout` option by @stephane-ruhlmann. See #178

## 0.4.0

- **[Nightmare](http://codecept.io/nightmare) Helper** added for faster web testing.
- [Protractor][SeleniumWebdriver][WebDriverIO] added `restart: false` option to reuse one browser between tests (improves speed).
- **Protractor 4.0** compatibility. Please upgrade Protractor library.
- Added `--verbose` option for `run` command to log and print global promise and events.
- Fixed errors with shutting down and cleanup.
- Fixed starting interactive shell with `codeceptjs shell`.
- Fixed handling of failures inside within block

## 0.3.5

- Introduced IDE autocompletion support for Visual Studio Code and others. Added command for generating TypeScript definitions for `I` object. Use it as

```
codeceptjs def
```

to generate steps definition file and include it into tests by reference. By @kaflan

## 0.3.4

- [Protractor] version 3.3.0 comptaibility, NPM 3 compatibility. Please update Protractor!
- allows using absolute path for helpers, output, in config and in command line. By @denis-sokolov
- Fixes 'Cannot read property '1' of null in generate.js:44' by @seethislight

## 0.3.3

**Fixed global installation**. CodeceptJS can now locate globally located modules.
CodeceptJS is also recommended for local installation.
Depending on installation type additional modules (webdriverio, protractor, ...) will be loaded either from local or from global path.

## 0.3.2

- Added `codeceptjs list` command which shows all available methods of `I` object.
- [Protractor][SeleniumWebdriver] fixed closing browser instances
- [Protractor][SeleniumWebdriver] `doubleClick` method added
- [WebDriverIO][Protractor][SeleniumWebdriver] `doubleClick` method to locate clickable elements by text, `context` option added.
- Fixed using assert in generator without yields #89

## 0.3.1

- Fixed `init` command

## 0.3.0

**Breaking Change**: webdriverio package removed from dependencies list. You will need to install it manually after the upgrade.
Starting from 0.3.0 webdriverio is not the only backend for running selenium tests, so you are free to choose between Protractor, SeleniumWebdriver, and webdriverio and install them.

- **[Protractor] helper added**. Now you can test AngularJS applications by using its official library within the unigied CodeceptJS API!
- **[SeleniumWebdriver] helper added**. You can switch to official JS bindings for Selenium.
- [WebDriverIO] **updated to webdriverio v 4.0**
- [WebDriverIO] `clearField` method added by @fabioel
- [WebDriverIO] added `dragAndDrop` by @fabioel
- [WebDriverIO] fixed `scrollTo` method by @sensone
- [WebDriverIO] fixed `windowSize: maximize` option in config
- [WebDriverIO] `seeElement` and `dontSeeElement` check element for visibility by @fabioel and @davertmik
- [WebDriverIO] `seeElementInDOM`, `dontSeeElementInDOM` added to check element exists on page.
- [WebDriverIO] fixed saving screenshots on failure. Fixes #70
- fixed `within` block doesn't end in output not #79

## 0.2.8

- [WebDriverIO] added `seeNumberOfElements` by @fabioel

## 0.2.7

- process ends with exit code 1 on error or failure #49
- fixed registereing global Helper #57
- fixed handling error in within block #50

## 0.2.6

- Fixed `done() was called multiple times`
- [WebDriverIO] added `waitToHide` method by @fabioel
- Added global `Helper` (alias `codecept_helper)`, object use for writing custom Helpers. Generator updated. Changes to #48

## 0.2.5

- Fixed issues with using yield inside a test #45 #47 #43
- Fixed generating a custom helper. Helper class is now accessible with `codecept_helper` var. Fixes #48

## 0.2.4

- Fixed accessing helpers from custom helper by @pim.

## 0.2.3

- [WebDriverIO] fixed `seeInField` to work with single value elements like: input[type=text], textareas, and multiple: select, input[type=radio], input[type=checkbox]
- [WebDriverIO] fixed `pressKey`, key modifeiers (Control, Command, Alt, Shift) are released after the action

## 0.2.2

Fixed generation of custom steps file and page objects.
Please replace `require('codeceptjs/actor')` to `actor` in your `custom_steps.js`.
Whenever you need to create `I` object (in page objects, custom steps, but not in tests) just call `actor()`;

## 0.2.0

- **within** context hook added
- `--reporter` option supported
- [WebDriverIO] added features and methods:
  - elements: `seeElement`, ...
  - popups: `acceptPopup`, `cancelPopup`, `seeInPopup`,...
  - navigation: `moveCursorTo`, `scrollTo`
  - saving screenshots on failure; `saveScreenshot`
  - cookies: `setCookie`, `seeCookie`, ...
  - source: `seeInSource`
  - form: `seeCheckboxIsChecked`, `selectOption` to support multiple selects
  - keyboard: `appendField`, `pressKey`
  - mouse: `rightClick`
- tests added
- [WebDriverIO] proxy configuration added by @petehouston
- [WebDriverIO] fixed `waitForText` method by @roadhump. Fixes #11
- Fixed creating output dir when it already exists on init by @alfirin
- Fixed loading of custom helpers