Skip to content

fix(wdio-xvfb): autoXvfb should disable xvfb completely#14700

Merged
christian-bromann merged 47 commits intowebdriverio:mainfrom
goosewobbler:fix-xvfb-toggle
Aug 24, 2025
Merged

fix(wdio-xvfb): autoXvfb should disable xvfb completely#14700
christian-bromann merged 47 commits intowebdriverio:mainfrom
goosewobbler:fix-xvfb-toggle

Conversation

@goosewobbler
Copy link
Contributor

@goosewobbler goosewobbler commented Aug 12, 2025 •
edited
Loading

Proposed changes

Following up from #14698, we have an issue with the xvfb feature in that when autoXvfb is disabled and xvfb is available, xvfb is still used to wrap the WDIO testrunner process, which is not the intended behaviour.

Additional changes:

  • CI detection no longer used as CI is too broad a signal for enabling xvfb. Many CI jobs provide a valid DISPLAY or a custom X server/WM. Using isCI forces xvfb even when not needed, which may break these setups.
  • Reworked xvfbAutoInstall option to cover sudo issues raised in [🐛 Bug]: Undocumented dependency on "sudo" #14701
  • Custom install command to cover esoteric install requirements
  • Types improvements
  • Website page under Testrunner documenting WDIO options around headless testing and xvfb.

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 Aug 12, 2025 •
edited
Loading

Open in StackBlitz

create-wdio

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

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/appium-service

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

@wdio/xvfb

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

webdriver

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

webdriverio

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

commit: 1d969ce

@goosewobbler goosewobbler mentioned this pull request Aug 12, 2025
Closed
3 tasks
@christian-bromann
Copy link
Member

christian-bromann commented Aug 12, 2025

@goosewobbler thanks for the patch, are you working on the failing CI pipelines?

@goosewobbler
Copy link
Contributor Author

goosewobbler commented Aug 12, 2025

@christian-bromann Yes, in progress. I'm doing the sudo improvements first

@goosewobbler goosewobbler force-pushed the fix-xvfb-toggle branch 3 times, most recently from fd01cd7 to 9510711 Compare August 20, 2025 02:11
erwinheitzman
erwinheitzman reviewed Aug 21, 2025
View reviewed changes
Copy link
Member

@erwinheitzman erwinheitzman left a comment

Choose a reason for hiding this comment

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

I haven't been able to finish the review yet so I'll continue another time but at least you have some feedback 👍

christian-bromann
christian-bromann reviewed Aug 24, 2025
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 Aug 24, 2025
@christian-bromann christian-bromann merged commit 3ac2341 into webdriverio:main Aug 24, 2025
58 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erwinheitzman erwinheitzman erwinheitzman left review comments

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

Assignees

No one assigned

Labels

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

@goosewobbler @christian-bromann @erwinheitzman