Skip to content

fix(webdriver): use undici for requests in Node.js #13852

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.

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

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented Nov 5, 2024

Proposed changes

This is another attempt to fix the request timeout in webdriver by falling back to undici for making requests in Node.js. This time we will change the interface of the WebdriverRequest class and provide a Node.js version and a cross platform version using native fetch.

This PR introduces the same approach to deliver to different environments, e.g. browser, Node.js, CJS, as Puppeteer does it.

fixes #13778

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

@erwinheitzman
Copy link
Member

Hi @christian-bromann could you explain a little bit about why we need another tool to retry? I'd think that we could simply have a solution that catches errors and in case of a timeout, puts it in a queue to retry?

@christian-bromann
Copy link
Member Author

@erwinheitzman introducing undici is not to fix anything about the retry mechanism. It fixes two regressions we introduced in v9:

  • requests timeout after 5min which is a restriction in Node.js native fetch
  • we don't support proxies anymore

The package is very lightweight so I don't think it has any impact on the user.

@christian-bromann christian-bromann marked this pull request as ready for review November 26, 2024 05:23
Copy link

pkg-pr-new bot commented Nov 26, 2024

Open in Stackblitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/appium-service

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: 6a0c018

@christian-bromann christian-bromann merged commit 5218796 into main Nov 26, 2024
46 checks passed
@christian-bromann christian-bromann deleted the cb/node-request branch November 26, 2024 07:26
@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Bug Fix 🐛 PRs that contain bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🐛 Bug]: connectionRetryTimeout does not affect the actual fetch timeout for greater values
2 participants