Skip to content

fix(webdriver): stop cloning request so await response.json() can abort properly#14463

Merged
christian-bromann merged 1 commit intowebdriverio:mainfrom
dprevost-LMI:fix-aborted-request-raising-empty-error
May 10, 2025
Merged

fix(webdriver): stop cloning request so await response.json() can abort properly#14463
christian-bromann merged 1 commit intowebdriverio:mainfrom
dprevost-LMI:fix-aborted-request-raising-empty-error

Conversation

@dprevost-LMI
Copy link
Contributor

@dprevost-LMI dprevost-LMI commented May 10, 2025

Proposed changes

As demonstrated in this issue, if we reach the connectionRetryTimeout while reading the JSON from the response, using a cloned version throws an empty error since the abort signal data is not properly synced on the cloned version.

However, removing this line removes a potential fix done in this commit by @tamil777selvan

At the same time, I do not see why we need to clone the request since it is solely scoped to this code, and cloning means more resources. Is there any filter that also tries to read the stream? If so, it could be the code that clones it before we start the JSON parsing.

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

//: # (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
  • Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

@dprevost-LMI dprevost-LMI changed the title fix: stop cloning request so await response.json() can abort properly fix(webdriver): stop cloning request so await response.json() can abort properly May 10, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented May 10, 2025

Open in StackBlitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/appium-service

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: d17e178

@dprevost-LMI dprevost-LMI marked this pull request as ready for review May 10, 2025 16:30
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 May 10, 2025
@christian-bromann christian-bromann merged commit 5b07ffe into webdriverio:main May 10, 2025
44 checks passed
@wdio-bot
Copy link
Contributor

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 deleted the fix-aborted-request-raising-empty-error branch June 8, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants