Skip to content

fix: Catch requests failure to trigger the result and onAfterCommand event#13922

Merged
christian-bromann merged 4 commits intowebdriverio:mainfrom
dprevost-LMI:fix-afterCommand-not-called-on-request-failures
Nov 30, 2024
Merged

fix: Catch requests failure to trigger the result and onAfterCommand event#13922
christian-bromann merged 4 commits intowebdriverio:mainfrom
dprevost-LMI:fix-afterCommand-not-called-on-request-failures

Conversation

@dprevost-LMI
Copy link
Contributor

@dprevost-LMI dprevost-LMI commented Nov 26, 2024 •
edited
Loading

Proposed changes

As described in #13921 and #13915, we can trigger onBeforeCommand without the expected onAfterCommand, resulting, for example, in the case of allure-reporter, in generating more start steps than stopStep and, in the end, making the generator hang in a specific scenario.

Here is a proposition to catch all errors on request.makeRequest to ensure we trigger the result event, which consequently triggers the onAfterCommand. In the end, it now ensures the allure-reporter has the same amount of startStep and endStep.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

Example in allure report:

Screenshot 2024-11-26 at 7 30 57 AM

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 26, 2024 •
edited
Loading

Open in Stackblitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/appium-service

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-service

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

@wdio/smoke-test-reporter

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: 3f84741

@dprevost-LMI dprevost-LMI marked this pull request as ready for review November 26, 2024 14:33
christian-bromann
christian-bromann requested changes Nov 26, 2024
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

Thanks for raising the PR, could we have unit tests for this?

@dprevost-LMI
Copy link
Contributor Author

dprevost-LMI commented Nov 26, 2024

Thanks for raising the PR, could we have unit tests for this?

I am trying, but I have difficulties finding how to enter the catch in the tests; maybe tomorrow I will have something!

@dprevost-LMI dprevost-LMI force-pushed the fix-afterCommand-not-called-on-request-failures branch from 4887a79 to 0ffe3d2 Compare November 28, 2024 01:33
@dprevost-LMI
Copy link
Contributor Author

dprevost-LMI commented Nov 28, 2024

@christian-bromann it is ✅ with unit test, just missing approval and merge 🎉

@dprevost-LMI dprevost-LMI mentioned this pull request Nov 30, 2024
Closed
3 tasks
christian-bromann
christian-bromann approved these changes Nov 30, 2024
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Nov 30, 2024
@christian-bromann christian-bromann merged commit 689c7b7 into webdriverio:main Nov 30, 2024
@wdio-bot
Copy link
Contributor

wdio-bot commented Nov 30, 2024

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 dprevost-LMI mentioned this pull request Dec 9, 2024
Closed
3 tasks
@dprevost-LMI dprevost-LMI deleted the fix-afterCommand-not-called-on-request-failures branch June 8, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christian-bromann christian-bromann christian-bromann approved these changes

Assignees

No one assigned

Labels

Expensable $35 💸 PR: Bug Fix 🐛 PRs that contain bug fixes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dprevost-LMI @wdio-bot @christian-bromann