Skip to content

Reduce wait port retry interval#14311

Merged
christian-bromann merged 1 commit intowebdriverio:mainfrom
dragosMC91:reduce-chromedriver-start-time
Mar 23, 2025
Merged

Reduce wait port retry interval#14311
christian-bromann merged 1 commit intowebdriverio:mainfrom
dragosMC91:reduce-chromedriver-start-time

Conversation

@dragosMC91
Copy link
Contributor

Proposed changes

This is a patch for #14310

I am currently trying to upgrade to wdio 9 from 8 but it's 10-20% slower.

If we reduce the wait connection retry interval, which is currently set to default (1000ms), the execution will continue much faster.

The 1 sec retry is excessive because the driver process spawn time is ~10ms

driverProcess = cp.spawn(chromedriverExcecuteablePath, driverParams, {...})

and the time before the port is open and ready to use is another ~10ms

await waitPort({ port, output: 'silent', timeout: DRIVER_WAIT_TIMEOUT })

Ironically, this delay is more visible on wdio 9 than it is on wdio 8 because the execution time between driver process spawn -> waitPort is actually smaller than it is on wdio 8, and during the 1st iteration of waitPort, the port is not available, so it waits the default 1 sec.

The tweak presented here is one of the factors which cause the slower overall test execution time.

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

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 23, 2025

Open in Stackblitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/appium-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: 0e48a7d

}

await waitPort({ port, output: 'silent', timeout: DRIVER_WAIT_TIMEOUT })
await waitPort({ port, output: 'silent', timeout: DRIVER_WAIT_TIMEOUT, interval: DRIVER_RETRY_INTERVAL })
Copy link
Member

Choose a reason for hiding this comment

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

I don't see an interval option in the documentation of the package

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.

Good catch 👌

@erwinheitzman I found the parameter in the code:

  /** The number of milliseconds to wait on each connection attempt
   * (defaults to 1000) */
  interval?: number;

@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Mar 23, 2025
@christian-bromann christian-bromann merged commit 9cda1c9 into webdriverio:main Mar 23, 2025
43 checks passed
@wdio-bot
Copy link
Contributor

Hey dragosMC91 👋

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 🤖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants