test_runner: make signal handling configurable#59674
Open
mete0rfish wants to merge 7 commits intonodejs:mainfrom
Open
test_runner: make signal handling configurable#59674mete0rfish wants to merge 7 commits intonodejs:mainfrom
mete0rfish wants to merge 7 commits intonodejs:mainfrom
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
needs-ci
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #59674 +/- ##
==========================================
+ Coverage 89.91% 89.93% +0.02%
==========================================
Files 667 667
Lines 196600 196793 +193
Branches 38594 38421 -173
==========================================
+ Hits 176766 176981 +215
+ Misses 12270 12211 -59
- Partials 7564 7601 +37
🚀 New features to boost your workflow:
|
Member
|
Hey @mete0rfish, thanks for the contribution! I'll take a look ASAP. In the meantime, I noticed that the commit validation is failing...could you please take a look at it? 😁 |
pmarchini
reviewed
Aug 29, 2025
lib/internal/test_runner/runner.js
Outdated
| argv = [], | ||
| cwd = process.cwd(), | ||
| rerunFailuresFilePath, | ||
| hookSignal = false, |
Member
There was a problem hiding this comment.
If we decide to add a new property to the run method, we also need to update the documentation:
https://github.com/nodejs/node/blob/fb614c43240158fa6c5b988571746fadff8e22d7/doc/api/test.md?#runoptions
MoLow
reviewed
Aug 31, 2025
lib/internal/test_runner/harness.js
Outdated
| process.on('beforeExit', exitHandler); | ||
| // TODO(MoLow): Make it configurable to hook when isTestRunner === false. | ||
| if (globalOptions.isTestRunner) { | ||
| if (globalOptions.isTestRunner || globalOptions.hookSignal === true) { |
Member
There was a problem hiding this comment.
Suggested change
| if (globalOptions.isTestRunner || globalOptions.hookSignal === true) { | |
| if (globalOptions.isTestRunner && globalOptions.hookSignal !== false) { |
MoLow
reviewed
Aug 31, 2025
lib/internal/test_runner/runner.js
Outdated
| argv = [], | ||
| cwd = process.cwd(), | ||
| rerunFailuresFilePath, | ||
| hookSignal = false, |
Member
There was a problem hiding this comment.
Suggested change
| hookSignal = false, | |
| hookSignal = true, |
please preserve the current behavior as the default behavior
mete0rfish
force-pushed
the
feat-configure-signal-with-global-options
branch
from
1e772a1 to
54a6e25
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR resolves a TODO in the test runner to allow signal handling to be enabled.
Purpose
The test runner's signal handlers are only attached when it is invoked via the
--testCLI flag (isTestRunner === true). Thisprevents users from opting into the same behavior in scenarios where
isTestRunner === false, such as when calling the run() API from a JS file. In these cases, aSIGINTsignal would terminate the process abruptly without proper test reporting.Therefore this PR introduces a new
hookSignaloption to the run() function, allowing developers to enable signal handling for these scenarios.I would appreciate your feedback😄
Related Issues