Skip to content

fix(@wdio/local-runner): added graceful exit on SIGINT#14611

Merged
christian-bromann merged 3 commits intowebdriverio:mainfrom
DQRI:fix/local-runner-graceful-exit-14609
Jul 8, 2025
Merged

fix(@wdio/local-runner): added graceful exit on SIGINT#14611
christian-bromann merged 3 commits intowebdriverio:mainfrom
DQRI:fix/local-runner-graceful-exit-14609

Conversation

@DQRI
Copy link
Contributor

@DQRI DQRI commented Jul 1, 2025

Proposed changes

After migrating from async-exit-hook to exit-hook in #14511, the new exitHook() was used in a way that runs synchronously, causing Node.js to exit before cleanup could complete. As a result, after I press Ctrl+C during a WDIO run, deleteSession() was never called on SIGINT, and browser sessions remained hanging

In this PR this problem has been solved:

  • Restored asynchronous graceful shutdown in @wdio/local-runner by replacing exitHook(() => Promise) with asyncExitHook and gracefulExit.
  • Ensured deleteSession() is called on SIGINT and no browser sessions are left hanging.
  • Only delays shutdown for SHUTDOWN_TIMEOUT ms when SIGINT is received, otherwise, exits immediately.
  • Added tests to cover all code paths

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

Closes #14609

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 1, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@christian-bromann
Copy link
Member

Thanks for raising the PR, I will look into it once I was able to fix the build on main.

@nextlevelbeard
Copy link
Member

@DQRI great work here, it could be a nice opportunity to also fix/solve issue #10720 .

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.

Thank you 👍

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jul 8, 2025

Open in StackBlitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/appium-service

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: bbffd76

@christian-bromann christian-bromann merged commit e887022 into webdriverio:main Jul 8, 2025
75 of 76 checks passed
@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jul 8, 2025
@wdio-bot
Copy link
Contributor

wdio-bot commented Jul 8, 2025

Hey DQRI 👋

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.

[🐛 Bug]: @wdio/local-runner exits on SIGINT before cleanup - deleteSession() never called

4 participants