Skip to content

fixed minor TS typing issues in class Result and output.result #5252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 113 commits into
base: 4.x
Choose a base branch
from
Open

fixed minor TS typing issues in class Result and output.result #5252

wants to merge 113 commits into from

Conversation

@danielrentz
Copy link
Contributor

@danielrentz danielrentz commented Oct 6, 2025

Motivation/Description of the PR

Two small fixes for Typescript typings:

  • the function output.result misses a declaration for the optional parameter "failedHooks".
  • the "failures" in class Result may contain numbers or strings. The exact type for a single failure report is [string, number, string, string, string] but that is not possible to declare with vanilla JSDoc. Added typedef Failure as string/number array, and replaced string[] with the new type.

Unrelated changes in plugins.md have been auto-generated by npm run docs.

Applicable helpers:

  • Playwright
  • Puppeteer
  • WebDriver
  • REST
  • FileHelper
  • Appium
  • TestCafe

Applicable plugins:

  • allure
  • autoDelay
  • autoLogin
  • customLocator
  • pauseOnFail
  • coverage
  • retryFailedStep
  • screenshotOnFail
  • selenoid
  • stepByStepReport
  • stepTimeout
  • wdio
  • subtitles

Type of change

  • 🔥 Breaking changes
  • 🚀 New functionality
  • 🐛 Bug fix
  • 🧹 Chore
  • 📋 Documentation changes/updates
  • ♨️ Hot fix
  • 🔨 Markdown files fix - not related to source code
  • 💅 Polish code

Checklist:

  • Tests have been added
  • Documentation has been added (Run npm run docs)
  • Lint checking (Run npm run lint)
  • Local tests are passed (Run npm test)

dependabot bot and others added 30 commits July 16, 2025 09:36
@dependabot
chore(deps-dev): bump playwright from 1.53.0 to 1.54.1 (codeceptjs#5043)
c8d933f 
Bumps [playwright](https://github.com/microsoft/playwright) from 1.53.0 to 1.54.1.
- [Release notes](https://github.com/microsoft/playwright/releases)
- [Commits](microsoft/playwright@v1.53.0...v1.54.1)

---
updated-dependencies:
- dependency-name: playwright
  dependency-version: 1.54.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump @eslint/js from 9.30.0 to 9.31.0 (codeceptjs#5044)
4ef395f 
---
updated-dependencies:
- dependency-name: "@eslint/js"
  dependency-version: 9.31.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump expect from 29.7.0 to 30.0.4 (codeceptjs#5036)
7c764fc 
Bumps [expect](https://github.com/jestjs/jest/tree/HEAD/packages/expect) from 29.7.0 to 30.0.4.
- [Release notes](https://github.com/jestjs/jest/releases)
- [Changelog](https://github.com/jestjs/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/jestjs/jest/commits/v30.0.4/packages/expect)

---
updated-dependencies:
- dependency-name: expect
  dependency-version: 30.0.4
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump graphql from 16.10.0 to 16.11.0 (codeceptjs#5049)
6b45b27 
Bumps [graphql](https://github.com/graphql/graphql-js) from 16.10.0 to 16.11.0.
- [Release notes](https://github.com/graphql/graphql-js/releases)
- [Commits](graphql/graphql-js@v16.10.0...v16.11.0)

---
updated-dependencies:
- dependency-name: graphql
  dependency-version: 16.11.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump electron from 37.1.0 to 37.2.3 (codeceptjs#5047)
a130ba3 
Bumps [electron](https://github.com/electron/electron) from 37.1.0 to 37.2.3.
- [Release notes](https://github.com/electron/electron/releases)
- [Changelog](https://github.com/electron/electron/blob/main/docs/breaking-changes.md)
- [Commits](electron/electron@v37.1.0...v37.2.3)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 37.2.3
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump puppeteer from 24.8.0 to 24.15.0 (codeceptjs#5054)
2aef872
@dependabot
chore(deps): bump axios from 1.8.4 to 1.11.0 (codeceptjs#5055)
af27fc9 
Bumps [axios](https://github.com/axios/axios) from 1.8.4 to 1.11.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](axios/axios@v1.8.4...v1.11.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-version: 1.11.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump typedoc-plugin-markdown from 4.7.0 to 4.7.1 (co…
2ad213a 
…deceptjs#5046)

Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.7.0 to 4.7.1.
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.7.1/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-version: 4.7.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps): bump browser-actions/setup-chrome from 1 to 2 (codeceptj…
4cc3c84 
…s#5041)

Bumps [browser-actions/setup-chrome](https://github.com/browser-actions/setup-chrome) from 1 to 2.
- [Release notes](https://github.com/browser-actions/setup-chrome/releases)
- [Changelog](https://github.com/browser-actions/setup-chrome/blob/master/CHANGELOG.md)
- [Commits](browser-actions/setup-chrome@v1...v2)

---
updated-dependencies:
- dependency-name: browser-actions/setup-chrome
  dependency-version: '2'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump expect from 30.0.4 to 30.0.5 (codeceptjs#5064)
e090eb9
@kobenguyent
fix: 5070 issue (codeceptjs#5071)
220b73f
@dependabot
chore(deps-dev): bump typedoc from 0.28.7 to 0.28.10 (codeceptjs#5059)
5c14df4 
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.7 to 0.28.10.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.28.7...v0.28.10)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.10
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@kobenguyent
fix: hook exit code (codeceptjs#5058)
a27b99e 
* fix: hook exit code

* Update asyncWrapper.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update asyncWrapper.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update asyncWrapper.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update asyncWrapper.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update asyncWrapper.js

* Update asyncWrapper.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@kobenguyent
5066 unable to inject data between workers because of proxy object (c…
3cf5fe2 
…odeceptjs#5072)

* fix share workers

* fix share workers
@dependabot
chore(deps): bump actions/checkout from 4 to 5 (codeceptjs#5062)
5476a9d 
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump tsd from 0.32.0 to 0.33.0 (codeceptjs#5063)
3408489 
Bumps [tsd](https://github.com/tsdjs/tsd) from 0.32.0 to 0.33.0.
- [Release notes](https://github.com/tsdjs/tsd/releases)
- [Commits](tsdjs/tsd@v0.32.0...v0.33.0)

---
updated-dependencies:
- dependency-name: tsd
  dependency-version: 0.33.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore(deps-dev): bump typedoc-plugin-markdown from 4.7.1 to 4.8.1 (co…
eceb2a3 
…deceptjs#5067)

Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.7.1 to 4.8.1.
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.8.1/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-version: 4.8.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@NivYarmus
feat: shuffle test suite order in run command (codeceptjs#5051)
4daabc8
@kobenguyent
fix: sessions playwright traces - naming convention and error handling (
ff63f70 
codeceptjs#5073)
@kobenguyent
release 3.7.4 (codeceptjs#5075)
a483106 
* release 3.7.4
@kobenguyent
update docs
2e4d0bb
@kobenguyent
fix: Update inquirer (codeceptjs#5076)
376c758
@kobenguyent
add docs
f0759ca
@kobenguyent
feat(cli): make test file hyperlink (codeceptjs#5078)
04ec768
@kobenguyent
Playwright: I.waitForText() causes unexpected delay equal to `waitFor…
e3a195d 
…Timeout` value at the end of test suite (codeceptjs#5077)

* Initial plan

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
@kobenguyent
3.7.3 I.seeResponseContainsJson not working (codeceptjs#5081)
93ab75d 
* Initial plan

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
@kobenguyent
Fix JUnit XML test case name inconsistency when using scenario retries (
58f83a1 
codeceptjs#5082)

* Initial plan

* Fix JUnit XML test case name inconsistency in scenario retries

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Improve edge case handling for empty suite titles in cloned tests

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
@kobenguyent
fix: testcafe workflow failed (codeceptjs#5085)
f295302 
* fix: TestCafe_test.js

* Fix TestCafe form submission timeout with efficient polling mechanism (codeceptjs#5080)

* Initial plan

* Fix failed TestCafe tests by skipping doubleClick test

* Update testcafe.yml

* Update testcafe.yml

* Update TestCafe_test.js

* Update TestCafe_test.js

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Fix TestCafe form submission timeout in CI environments

* Improve TestCafe form submission timeout handling with polling mechanism

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Improve TestCafe form submission timeout with efficient polling mechanism

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Update testcafe.yml

* fix: Chrome popup causes problems with TestCafe

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
Co-authored-by: kobenguyent <kobenguyent@gmail.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
@kobenguyent
[FR] - Support feature.only like Scenario.only (codeceptjs#5087)
ce16e92 
* Initial plan

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Add TypeScript types for Feature.only method

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Fix TypeScript test expectations for hook return types

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
@kobenguyent
Fix tryTo steps appearing in test failure traces (codeceptjs#5088)
2047cf2 
* Initial plan

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>
kobenguyent and others added 19 commits September 26, 2025 09:57
@kobenguyent
fix: wrong stats when running with workers (codeceptjs#5215)
db7d0fc 
* fix: wrong stats when running with workers

* fix: failed runner tests
@danielrentz
fixed: TS typings for Codecept and MainConfig (codeceptjs#5216)
aed3123
@thomashohn
Bump various deps to keep them in sync (codeceptjs#5220)
2857e96
@danielrentz
fixed: remove deprecated fs.rmdirSync with recursive option (codecept…
50eb7f4 
…js#5218)
@kobenguyent
fix: flaky UTs (codeceptjs#5221)
2505ac7
@Samuel-StO @kobenguyent
feat: Add support for Playwright storageState configuration (codecept…
0345fc7 
…js#5192)

* feat: add support for Playwright storageState configuration and helper methods

* doc : run docs

---------

Co-authored-by: kobenguyent <kobenguyent@gmail.com>
@danielrentz
fix(docs): update some deprecated links of puppeteer and playwright (c…
3e9b799 
…odeceptjs#5222)

* fixed: types: PupeteerConfig.waitForNavigation can be an array

* restore original formatting

* fix Puppeteer links

* fixed more links
@actions-user
DOC: Autogenerate and update documentation
2c4a7d9
@kobenguyent
fix: flaky tests (codeceptjs#5225)
dcbcc81
@kobenguyent
fix: max listeners exceeded warning (codeceptjs#5227)
5826298
@kobenguyent
fix: show only verbose or debug mode (codeceptjs#5232)
1075552
@kobenguyent
fix: appium tests (codeceptjs#5230)
743d0a1
@kobenguyent
improvement: workers cli log (codeceptjs#5235)
5defdf9 
* enhance workers cli log

* fix: make worker enhancements backward compatible with all test suites

- Made feature name display conditional (only in workers mode)
- Preserved run-multiple process format [X.suite:browser]
- Updated test expectations to match new enhanced format
- All test suites now passing (221 runner + 477 unit tests)

Changes:
- lib/output.js: Conditional feature names + run-multiple detection
- test/unit/output_test.js: Updated worker badge test expectation
- test/runner/run_workers_test.js: Updated 3 test expectations

Fixes codeceptjs#5234
@danielrentz
fixed: add typings for class Result (codeceptjs#5236)
3db47c8 
* fixed: typings for class Result

* fix docs for getters
@kobenguyent
fix: mock server for internal tests (codeceptjs#5238)
c1c0a51 
* mock server

* mock server

* lint fix

* fix: acceptance tests cannot access mock server

* fix: acceptance tests cannot access mock server

* fix: flaky timeout test
@kobenguyent
fix: address HTML reporter issues (codeceptjs#5240)
0db01c6 
* address HTML reporter issues

* address HTML reporter issues

* fix UTs and lint issue
@kobenguyent
fix: html reporter improvements (codeceptjs#5242)
1584113
@danielrentz
fixed minor TS typing issues in class Result and output.result
886bbe7
@kobenguyent
Update dependabot.yml
9085269
@kobenguyent kobenguyent changed the base branch from 3.x to 4.x October 8, 2025 00:27
@danielrentz danielrentz changed the base branch from 4.x to 3.x October 22, 2025 14:32
mirao added 2 commits October 29, 2025 13:45
@mirao
fix: handle missing opts in retryFailedStep plugin (Shell: Command fa…
2418a1e 
…ils: TypeError: Chaining cycle detected for promise Fixes codeceptjs#4844) (codeceptjs#5276)
@mirao
fix: global timeout before suite (codeceptjs#5275)
aaf4fef 
* Fix: preserve global timeout with BeforeSuite hook

* test: clarify feature name for global timeout with BeforeSuite

* chore: remove unused plugins field from beforeSuiteTimeout config
kobenguyent
kobenguyent reviewed Oct 29, 2025
View reviewed changes
docs/plugins.md Outdated
## reportData
TypeScript: Explicitly type reportData arrays as any\[] to avoid 'never' errors
Copy link
Collaborator

@kobenguyent kobenguyent Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielrentz I'm not sure if the \ here is intended?

Copy link
Contributor Author

@danielrentz danielrentz Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kobenguyent As mentioned above... "Unrelated changes in plugins.md have been auto-generated by npm run docs."

No idea what to do about it. Even the git commit hooks manipulate these files, and confusingly in another way than the local build scripts. Will try to remove this change.

Another question... You changed the target branch from 3.x to 4.x a few weeks ago ... I did not notice this and thought I did that by mistake somehow, and therefore changed it back to 3.x. I remember that the PR did show dozens or hundrets of changed files when it has targeted 4.x. What is the desired way here? Is 3.x dead, and work continues in 4.x?

Copy link
Collaborator

@kobenguyent kobenguyent Nov 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, great news! The 4.x version is now synced with 3.x. As you know, 4.x is an ESM migration, and I believe we’d like to merge into 4.x as much as possible, rather than keeping both 2 branches separate. Perhaps @DavertMik has a different perspective, and I’d love to hear your thoughts. Thanks!

@kobenguyent kobenguyent changed the base branch from 3.x to 4.x November 8, 2025 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kobenguyent kobenguyent kobenguyent left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.