fix: Emit browser custom command `beforeCommand` to fix broken reports by dprevost-LMI · Pull Request #14581 · webdriverio/webdriverio

dprevost-LMI · 2025-06-20T13:50:26Z

Proposed changes

As described in this issue, when using browser custom command, it can break reports since we only emit a result event, which translates to triggering only a onAfterCommand, which stops a step not belonging to that command.

Now, we emit the command so that onBeforeCommand gets called correctly, and we also ensure, with the catch, that onAfterCommand is always called. We have also reviewed the emitted data to align with the already existing command emitting when doing a HTTP request/response

Other:

Fix reporter attachJSON to ensure it outputs the proper JSON file type when needed and any compatible JSON in a beautified format
On afterCommand, stop generating a response file if the result or error is undefined

fixes #14580

Types of changes

Polish (an improvement for an existing feature)
Bugfix (non-breaking change which fixes an issue)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

I have read the CONTRIBUTING doc

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

This change is solely for v9 and doesn't need to be back-ported

Further comments

Reviewers: @webdriverio/project-committers

pkg-pr-new · 2025-06-20T13:52:51Z

Open in StackBlitz

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14581

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14581

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14581

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14581

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14581

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14581

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14581

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14581

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14581

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14581

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14581

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14581

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14581

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14581

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14581

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14581

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14581

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14581

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14581

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14581

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14581

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14581

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14581

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14581

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14581

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14581

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14581

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14581

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14581

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14581

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14581

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14581

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14581

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14581

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14581

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14581

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14581

commit: d33426f

packages/wdio-reporter/src/types.ts

packages/wdio-allure-reporter/src/reporter.ts

packages/wdio-browserstack-service/src/Percy/Percy-Handler.ts

packages/wdio-reporter/src/types.ts

packages/wdio-utils/src/monad.ts

packages/wdio-reporter/src/types.ts

packages/webdriverio/tests/addCommand.test.ts

packages/wdio-reporter/src/types.ts

Co-authored-by: Christian Bromann <git@bromann.dev>

packages/wdio-allure-reporter/src/reporter.ts

christian-bromann · 2025-07-01T21:32:46Z

Once I managed to fix the build (see #14592) I can update the branch and merge once tests pass. Sorry for the delay.

christian-bromann

Awesome 🎉

wdio-bot · 2025-07-08T23:16:03Z

Hey dprevost-LMI 👋

Thank you for your contribution to WebdriverIO! Your pull request has been marked as an "Expensable" contribution.

We've sent you an email with further instructions on how to claim your expenses from our development fund.
Please make sure to check your spam folder as well. If you have any questions, feel free to reach out to us at expense@webdriver.io or in the contributing channel on Discord.

We are looking forward to more contributions from you in the future 🙌

Have a nice day,
The WebdriverIO Team 🤖

dprevost-LMI commented Jun 20, 2025

View reviewed changes

packages/wdio-reporter/src/types.ts Outdated Show resolved Hide resolved

dprevost-LMI mentioned this pull request Jun 20, 2025

[🐛 Bug]: Custom command triggers only Reporter.onAfterCommand without the onBeforeCommand breaking reports #14580

Closed

3 tasks

christian-bromann reviewed Jun 20, 2025

View reviewed changes

dprevost-LMI commented Jun 21, 2025

View reviewed changes

packages/wdio-utils/src/monad.ts Outdated Show resolved Hide resolved

dprevost-LMI force-pushed the fix-reports-broke-by-missing-beforeCommand branch from a1ebc24 to 692884c Compare June 21, 2025 19:28

dprevost-LMI commented Jun 21, 2025

View reviewed changes

packages/wdio-reporter/src/types.ts Show resolved Hide resolved

dprevost-LMI force-pushed the fix-reports-broke-by-missing-beforeCommand branch from 268dd4e to 7650f22 Compare June 21, 2025 21:45

dprevost-LMI marked this pull request as ready for review June 21, 2025 22:11

christian-bromann reviewed Jun 25, 2025

View reviewed changes

dprevost-LMI and others added 11 commits June 25, 2025 06:40

Compiling fix with type breaking changes

eb303e3

Preliminary unit tests show problem with the result wrapped in promise

d0ee06b

Fix bad import

ca8c5cc

Working code but weird unit tests failures

e54a3d6

Test simple custom command function instead of promise

fead322

Use an approach more compliant with existing code

0d8bd9b

Code review

3fad405

Review attachJSON so it works as expected in all cases

32e25b2

Coe review

f83108f

Apply suggestions from code review

4ec500f

Co-authored-by: Christian Bromann <git@bromann.dev>

Deprecate name instead of removing it + keep legacy emit!

3180e1d

dprevost-LMI force-pushed the fix-reports-broke-by-missing-beforeCommand branch from 38e6a21 to 3180e1d Compare June 25, 2025 10:55

dprevost-LMI commented Jun 25, 2025

View reviewed changes

packages/wdio-allure-reporter/src/reporter.ts Outdated Show resolved Hide resolved

dprevost-LMI and others added 2 commits June 25, 2025 06:59

Update packages/wdio-allure-reporter/src/reporter.ts

4a16fcc

Merge branch 'main' into fix-reports-broke-by-missing-beforeCommand

f8fbcc6

christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jul 1, 2025

Merge branch 'main' into fix-reports-broke-by-missing-beforeCommand

d33426f

christian-bromann approved these changes Jul 8, 2025

View reviewed changes

christian-bromann merged commit 97c8f8a into webdriverio:main Jul 8, 2025
43 checks passed

wdio-bot added the Expensable $35 💸 label Jul 8, 2025

goosewobbler mentioned this pull request Aug 8, 2025

Auto-update of mocks broken in WDIO 9.17.0 webdriverio-community/wdio-electron-service#1137

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Emit browser custom command `beforeCommand` to fix broken reports#14581

fix: Emit browser custom command `beforeCommand` to fix broken reports#14581
christian-bromann merged 14 commits intowebdriverio:mainfrom
dprevost-LMI:fix-reports-broke-by-missing-beforeCommand

dprevost-LMI commented Jun 20, 2025 •

edited by christian-bromann

Loading

Uh oh!

pkg-pr-new bot commented Jun 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann commented Jul 1, 2025

Uh oh!

christian-bromann left a comment

Uh oh!

Uh oh!

wdio-bot commented Jul 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

dprevost-LMI commented Jun 20, 2025 • edited by christian-bromann Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Types of changes

Checklist

Backport Request

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

pkg-pr-new bot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann commented Jul 1, 2025

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wdio-bot commented Jul 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dprevost-LMI commented Jun 20, 2025 •

edited by christian-bromann

Loading

pkg-pr-new bot commented Jun 20, 2025 •

edited

Loading