Skip to content

fix(wdio-cli): respect maxInstancesPerCapability for dynamic capabili…#14880

Merged
christian-bromann merged 1 commit intowebdriverio:mainfrom
mccmrunal:bug/14730
Nov 29, 2025
Merged

fix(wdio-cli): respect maxInstancesPerCapability for dynamic capabili…#14880
christian-bromann merged 1 commit intowebdriverio:mainfrom
mccmrunal:bug/14730

Conversation

@mccmrunal
Copy link
Contributor

…ties

Proposed changes

Fixes #14730

When capabilities are dynamically added in the onPrepare hook, maxInstancesPerCapability was being ignored if not explicitly set in the config. This caused the availableInstances to be undefined, allowing multiple workers to launch on the same device simultaneously, leading to Appium session crashes.

capabilities['wdio:maxInstances'] || config.maxInstancesPerCapability
If both were undefined, availableInstances became undefined, breaking the worker scheduling logic.
Solution: Added a fallback to the default value (100) by:
Creating a DEFAULT_MAX_INSTANCES_PER_CAPABILITY constant in wdio-config
Using it as the final fallback in the availableInstances calculation
Exporting it for reusability across packages
//: # (Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.)

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 Nov 22, 2025

Open in StackBlitz

create-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/create-wdio@14880

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/appium-service

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

@wdio/xvfb

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/xvfb@14880

webdriver

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

webdriverio

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

commit: d5bf0aa

@mccmrunal mccmrunal force-pushed the bug/14730 branch 2 times, most recently from adc1557 to 34f078f Compare November 22, 2025 17:04
@mccmrunal
Copy link
Contributor Author

@christian-bromann review this please

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 merged commit c726477 into webdriverio:main Nov 29, 2025
177 of 187 checks passed
@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Nov 29, 2025
@wdio-bot
Copy link
Contributor

Hey mccmrunal 👋

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 $50 💸 PR: Bug Fix 🐛 PRs that contain bug fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🐛 Bug]: dynamic capabilities ignores maxInstancesPerCapability

3 participants