fix: return correct type from process.send stub #11799
Merged
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.
Summary
The
process.send
stub created by Jest always returnsundefined
but Node actually always returnsboolean
value fromprocess.send
(see types 1 and 2, as well as Node docs)By default, it returns
true
and only returnsfalse
when the IPC message is buffered or the child process had already exited, see related docs on child_process.Current behavior of Jest stub causes quirks when user code actually checks for returned values (e.g. to implement backpressure for IPC calls)
Test plan
Not sure how to actually test it. I don't see existing tests for this feature in the original PR #5904