Skip to content

refactor(wdio-local-runner): replace async-exit-hook with exit-hook#14511

Merged
christian-bromann merged 4 commits intowebdriverio:mainfrom
harsha509:fix-zombie-process
Jun 2, 2025
Merged

refactor(wdio-local-runner): replace async-exit-hook with exit-hook#14511
christian-bromann merged 4 commits intowebdriverio:mainfrom
harsha509:fix-zombie-process

Conversation

@harsha509
Copy link
Member

@harsha509 harsha509 commented May 28, 2025 •
edited
Loading

Proposed changes

async-exit-hook is unmaintained and has potential issues which is causing zombie processes
and processes are not terminated gracefully (see Tapppi/async-exit-hook#10).

When running tests in parallel and performing SIGINT, potential node processes stay alive. Replacing it with exit-hook resolves these issues.

  • Replace deprecated async-exit-hook (v2.0.1) with exit-hook (v4.0.0)
  • Remove exitHookFn export and integrate exit hook directly
  • Update exit hook to return a Promise for graceful shutdown
  • Maintain SHUTDOWN_TIMEOUT functionality (5000ms)
  • Update tests to work with new exit-hook implementation
  • Remove @types/async-exit-hook dev dependency

This change modernizes the exit hook implementation while preserving
the existing graceful shutdown behavior with timeout.

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 May 28, 2025 •
edited
Loading

Open in StackBlitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/appium-service

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: 9bfc1fc

@harsha509 harsha509 marked this pull request as ready for review May 28, 2025 01:28
christian-bromann
christian-bromann approved these changes May 28, 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
Copy link
Member

christian-bromann commented Jun 2, 2025

@harsha509 mind rebasing the PR on top of current main?

@harsha509
Copy link
Member Author

harsha509 commented Jun 2, 2025

@harsha509 mind rebasing the PR on top of current main?

Hi @christian-bromann,

Updated the PR!

@christian-bromann
Copy link
Member

christian-bromann commented Jun 2, 2025

Thank you!

@christian-bromann christian-bromann merged commit eafdc05 into webdriverio:main Jun 2, 2025
43 checks passed
@christian-bromann christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jun 2, 2025
@harsha509 harsha509 deleted the fix-zombie-process branch June 4, 2025 14:30
@yashuatla yashuatla mentioned this pull request Jun 24, 2025
Open
This was referenced Jul 1, 2025
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Assignees

@christian-bromann christian-bromann

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.

2 participants

@harsha509 @christian-bromann