Emit end event on streams when process fails
#518
Merged
Conversation
This file contains 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
ehmicky
commented
Feb 11, 2023
| @@ -173,6 +174,11 @@ test('buffer: false > promise rejects when process returns non-zero', async t => | |||
| t.is(exitCode, 2); | |||
| }); | |||
|
|
|||
| test('buffer: false > emits end event when promise is rejected', async t => { | |||
| const subprocess = execa('wrong command', {buffer: false, reject: false}); | |||
| await t.notThrowsAsync(Promise.all([subprocess, pEvent(subprocess.stdout, 'end')])); | |||
There was a problem hiding this comment.
Before the code fix above, the end event would never be emitted on subprocess.stdout in that test case.
| @@ -36,7 +36,7 @@ export const makeAllStream = (spawned, {all}) => { | |||
|
|
|||
| // On failure, `result.stdout|stderr|all` should contain the currently buffered stream | |||
| const getBufferedData = async (stream, streamPromise) => { | |||
| if (!stream) { | |||
| if (!stream || streamPromise === undefined) { | |||
There was a problem hiding this comment.
A short code comment here would be great.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #517
When a process (or one of its standard streams) errors, we return what could have been buffered so far from stdout/stderr as
error.stdoutanderror.stderr(which are also appended toerror.message). To do this, we firstdestroy()those streams, then retrieve the buffered value fromget-stream.However, calling
destroy()prevents theendevent from being emitted on those streams. This behavior differs from howchild_process.spawn()and might be unexpected.This PR fixes this for the case where the
bufferoption isfalse. When that's the case, there is no need to destroy the streams since we do not need to do anything with them anymore. We can just let Node.js destroy them naturally as part of the child process exit.