stream: fix stream.finished on Duplex by ronag · Pull Request #33133 · nodejs/node

ronag · 2020-04-28T17:38:00Z

finished would incorrectly believe that a Duplex is already
closed if either the readable or writable side has completed.

Fixes: #33130

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

finished would incorrectly believe that a Duplex is already closed if either the readable or writable side has completed. Fixes: nodejs#33130

ronag · 2020-04-28T17:38:19Z

@nodejs/streams @mafintosh @szmarczak

ronag · 2020-04-28T17:38:24Z

fast-track?

szmarczak · 2020-04-28T17:52:10Z

https://gist.github.com/szmarczak/ca602173432113092bb89ba2c21d456a

szmarczak · 2020-04-28T17:55:03Z

@ronag You need to delay the write to response, so the readable event is emitted after the finish one. See the gist above.

nodejs-github-bot · 2020-04-28T18:12:13Z

CI: https://ci.nodejs.org/job/node-test-pull-request/31065/

mcollina

lgtm

mscdex · 2020-04-29T00:58:42Z

- (wState && wState.errorEmitted) || (rState && rState.errorEmitted) ||
- (wState && wState.finished) || (rState && rState.endEmitted) ||
- (rState && stream.req && stream.aborted);
+ const closed = (


Can we simplify this a bit? Perhaps at the very least group together similar dependencies, like:
constclosed=((wState&&(wState.closed||wState.errorEmitted))||(rState&&(rState.closed||rState.errorEmitted||(stream.req&&stream.aborted)))||((!writable||(wState&&wState.finished))&&(!readable||(rState&&rState.endEmitted))));

They are grouped? See below.

Unless there is a performance benefit to the above suggestion, I prefer @ronag's grouping because it's easier to read. Though it has more lines, it has less parentheses and the lines are ordered by the properties (e.g. closed) of the states. It reads like "is either state closed, or either state errorEmitted, or ..".

I have not personally benchmarked it, so I cannot say if it is measurable or not. However, it is reducing the number of duplicate checks so V8 should be performing less work.
However, my code suggestion was merely one possibility. I'm not opposed to rearranging the checks in other ways, such as introducing separate if statements, etc.

I prefer the current formatting and believe any performance implication here would be negligible in practice. This is not a hot path as far as I'm aware. A future simplification could be to use the ?. operator.

nodejs-github-bot · 2020-04-29T08:09:38Z

CI: https://ci.nodejs.org/job/node-test-pull-request/31088/ ✅

mscdex · 2020-04-29T15:10:04Z

 // TODO(ronag): Throw some kind of error? Does it make sense
 // to call finished() on a "finished" stream?
+ // TODO(ronag): willEmitClose?
 process.nextTick(() => {


For bonus points this could also be simplified to process.nextTick(callback); if you want to change it while we're in here. Either way is fine though.

@mscdex Strangely CI fails with your suggestion. Not sure why. Leaving it as is for the purposes of this PR.

Ah, it's because we re-assign callback in the disposer.

nodejs-github-bot · 2020-04-29T16:23:11Z

CI: https://ci.nodejs.org/job/node-test-pull-request/31097/

This reverts commit 882f704.

nodejs-github-bot · 2020-04-30T09:40:30Z

CI: https://ci.nodejs.org/job/node-test-pull-request/31115/

ronag · 2020-04-30T12:22:55Z

Landed in d84f131

finished would incorrectly believe that a Duplex is already closed if either the readable or writable side has completed. Fixes: #33130 PR-URL: #33133 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

stream: fix stream.finished on Duplex
45c27c6
finished would incorrectly believe that a Duplex is already closed if either the readable or writable side has completed. Fixes: nodejs#33130

ronag added the stream Issues and PRs related to the stream subsystem. label Apr 28, 2020

ronag requested a review from mcollina April 28, 2020 17:38

ronag mentioned this pull request Apr 28, 2020
v14.1.0 proposal #33103
Merged

addaleax approved these changes Apr 28, 2020
View reviewed changes

Comment threadtest/parallel/test-stream-finished.js Outdated
Comment threadtest/parallel/test-stream-finished.js Outdated

fixup: test
bfd17cd

szmarczak approved these changes Apr 28, 2020
View reviewed changes

addaleax approved these changes Apr 28, 2020
View reviewed changes

Comment threadtest/parallel/test-stream-finished.js Outdated
Comment threadtest/parallel/test-stream-finished.js Outdated

ronag added 4 commits April 28, 2020 19:48

fixup: test
5bd8e7c

fixup: test
02be7f3

fixup: test
9b83b7e

fixup: test
327dcb3

addaleax approved these changes Apr 28, 2020
View reviewed changes

Comment threadtest/parallel/test-stream-finished.js Outdated

fixup: test
1fc6c3e

szmarczak reviewed Apr 28, 2020
View reviewed changes

Comment threadtest/parallel/test-stream-finished.js Outdated

ronag added 2 commits April 28, 2020 20:05

fixup: test
20fe402

fixup: test
8cab4dd

addaleax added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 28, 2020

mcollina approved these changes Apr 28, 2020
View reviewed changes

mscdex reviewed Apr 29, 2020
View reviewed changes

fixup: simplify according to suggestion
882f704

Revert "fixup: simplify according to suggestion"
c7899a9
This reverts commit 882f704.

ronag closed this Apr 30, 2020

ronag added dont-land-on-v10.x labels Apr 30, 2020

targos mentioned this pull request May 4, 2020
v14.2.0 release proposal #33232
Merged

Uh oh!

Uh oh!

Conversation

ronag commented Apr 28, 2020

Checklist

Uh oh!

ronag commented Apr 28, 2020

Uh oh!

ronag commented Apr 28, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

szmarczak commented Apr 28, 2020

Uh oh!

Uh oh!

szmarczak commented Apr 28, 2020

Uh oh!

Uh oh!

nodejs-github-bot commented Apr 28, 2020

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

mscdexApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

ronagApr 29, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vweeversApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

mscdexApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

ronagApr 29, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Apr 29, 2020• edited by ronag Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mscdexApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

ronagApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

ronagApr 30, 2020

Choose a reason for hiding this comment

Uh oh!

ronagApr 30, 2020

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Apr 29, 2020

Uh oh!

nodejs-github-bot commented Apr 30, 2020

Uh oh!

ronag commented Apr 30, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ronagApr 29, 2020•
edited
Loading

ronagApr 29, 2020•
edited
Loading

nodejs-github-bot commented Apr 29, 2020•
edited by ronag
Loading