Releases · codeceptjs/CodeceptJS

19 Aug 12:16

kobenguyent

3.7.4

2e4d0bb

3.7.4 Latest

Latest

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

# 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

// 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":"[email protected]"}  // 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
```
// 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

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

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

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

New Contributors

@Lando1n made their first contribution in #4973
@owenizedd made their first contribution in #4986
@NivYarmus made their first contribution in #5051

Full Changelog: 3.7.3...3.7.4

Contributors

thomashohn, kobenguyent, and 4 other contributors

Assets 2

19 Mar 10:06

kobenguyent

3.7.3

233838e

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

New Contributors

@mjalav made their first contribution in #4866

Full Changelog: 3.7.2...3.7.3

Contributors

thomashohn, kobenguyent, and mjalav

Assets 2

12 Feb 08:09

kobenguyent

3.7.2

52b6e74

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

Contributors

gkushang and ngraf

Assets 2

11 Dec 09:50

kobenguyent

3.6.10

5abda10

3.6.10

What's Changed

fix(cli): missing failure counts when there is failedHooks by @kobenguyent in #4633

Full Changelog: 3.6.9...3.6.10

Contributors

kobenguyent

Assets 2

10 Dec 13:52

kobenguyent

3.6.9

831f13e

3.6.9

What's Changed

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":"[email protected]","password": "****"}
      I send post request "https://localhost:8000/login", {"username":"[email protected]","password": "****"}
      › [Request] {"baseURL":"https://localhost:8000/login","method":"POST","data":{"username":"[email protected]","password": "****"},"headers":{}}
      › [Response] {"access-token": "****"}

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

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

> 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
fix: missing invisi-data lib when upgrading codeceptjs

📖 Documentation

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

New Contributors

@schaudhary111 made their first contribution in #4493
@thomashohn made their first contribution in #4551

Full Changelog: 3.6.6...3.6.9

Contributors

DavertMik, thomashohn, and 4 other contributors

Assets 2

10 Dec 12:56

kobenguyent

3.6.8

ec40b1e

3.6.8

What's Changed

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":"[email protected]","password": "****"}
      I send post request "https://localhost:8000/login", {"username":"[email protected]","password": "****"}
      › [Request] {"baseURL":"https://localhost:8000/login","method":"POST","data":{"username":"[email protected]","password": "****"},"headers":{}}
      › [Response] {"access-token": "****"}

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

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

> 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

New Contributors

@schaudhary111 made their first contribution in #4493
@thomashohn made their first contribution in #4551

Full Changelog: 3.6.6...3.6.8

Contributors

DavertMik, thomashohn, and 4 other contributors

Assets 2

17 Sep 14:54

kobenguyent

3.6.6

63b1d50

3.6.6

What's Changed

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:

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

// 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
- run workers command

🐛 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

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

New Contributors

@Maksym-Artemenko made their first contribution in #4334
@code4muktesh made their first contribution in #4483
@tomaculum made their first contribution in #4486
@lin-brian-l made their first contribution in #4494

Full Changelog: 3.6.5...3.6.6

Contributors

DavertMik, code4muktesh, and 4 other contributors

Assets 2

31 Jul 10:06

kobenguyent

3.6.5

dd826d0

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

Full Changelog: 3.6.4...3.6.5

Contributors

kobenguyent and anils92

Assets 2

19 Jun 08:11

kobenguyent

3.6.4

cac208c

3.6.4

What's Changed

❤️ 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

🐛 Bug Fixes

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

📖 Documentation

AI docs improvements

Full Changelog: 3.6.3...3.6.4

Contributors

DavertMik and kobenguyent

Assets 2

10 Jun 07:56

kobenguyent

3.6.3

26dccb3

3.6.3

What's Changed

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

🛩️ Features

feat(plugin): coverage with WebDriver - devtools (#4349) - by @kobenguyent

🐛 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

New Contributors

@yoannfleurydev made their first contribution in #4369

Full Changelog: 3.6.2...3.6.3

Contributors

yoannfleurydev, a-stankevich, and 3 other contributors

Assets 2

Uh oh!

Releases: codeceptjs/CodeceptJS

3.7.4

3.7.4

New Contributors

Contributors

Uh oh!

3.7.3

3.7.3

New Contributors

Contributors

Uh oh!

3.7.2

3.7.2

Contributors

Uh oh!

3.6.10

What's Changed

Contributors

Uh oh!

3.6.9

What's Changed

3.6.8

New Contributors

Contributors

Uh oh!

3.6.8

What's Changed

3.6.8

New Contributors

Contributors

Uh oh!

3.6.6

What's Changed

3.6.6

New Contributors

Contributors

Uh oh!

3.6.5

3.6.5

Contributors

Uh oh!

3.6.4

What's Changed

Contributors

Uh oh!

3.6.3

What's Changed

New Contributors

Contributors

Uh oh!