stream: fix finished regression when working with legacy Stream #40858

mcollina · 2021-11-18T15:44:55Z

Fixes a regression introduced in Node v17 that made Fastify test fails.
The reason is that using finished() and pipeline() with the send module started to error with "premature close" even if the stream did not close prematurely.

mcollina · 2021-11-18T15:45:48Z

@ronag do you know which of the PRs introduced this?

ronag · 2021-11-18T15:48:19Z

Something is weird here. I want to understand why this happens. I’ll investigate today.

nodejs-github-bot · 2021-11-18T15:50:16Z

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

mcollina · 2021-11-18T15:51:52Z

Something is weird here. I want to understand why this happens. I’ll investigate today.

The test exposes what would be the correct behavior when used on a legacy stream. As long as it pass that test we should be good.

Note that this fix does not break any other test.

mscdex · 2021-11-18T16:14:34Z

test/parallel/test-stream-finished.js

@@ -630,3 +631,9 @@ testClosed((opts) => new Writable({ write() {}, ...opts }));
    }));
  }));
 }
+
+{
+  // This case is needed to support the send module


This comment is a bit confusing because it sounds like send is an internal module. Explaining what the test is checking for would be more useful than referencing a 3rd party module on npm, especially since as time goes on send may change its implementation and this comment will be outdated.

updated, good idea.

ronag · 2021-11-18T16:51:35Z

diff --git a/lib/internal/streams/end-of-stream.js b/lib/internal/streams/end-of-stream.js
index 91316f495c..ab60f5a7ea 100644
--- a/lib/internal/streams/end-of-stream.js
+++ b/lib/internal/streams/end-of-stream.js
@@ -165,13 +165,13 @@ function eos(stream, options, callback) {
   } else if (
     !readable &&
     (!willEmitClose || isReadable(stream)) &&
-    (writableFinished || !isWritable(stream))
+    (writableFinished || isWritable(stream) === false)
   ) {
     process.nextTick(onclose);
   } else if (
     !writable &&
     (!willEmitClose || isWritable(stream)) &&
-    (readableFinished || !isReadableNodeStream(stream))
+    (readableFinished || isReadable(stream) === false)
   ) {
     process.nextTick(onclose);
   } else if ((rState && stream.req && stream.aborted)) {
diff --git a/test/parallel/test-stream-finished.js b/test/parallel/test-stream-finished.js

This is a better fix. Basically what it says is that if we don't know (i.e. === null) then we don't call the callback (at the risk of deadlock).

ronag

See my proposal above.

Signed-off-by: Matteo Collina <hello@matteocollina.com>

ronag · 2021-11-18T17:38:59Z

@nodejs/streams

nodejs-github-bot · 2021-11-18T17:43:10Z

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

nodejs-github-bot · 2021-11-18T17:46:04Z

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

test/parallel/test-stream-finished.js

nodejs-github-bot · 2021-11-19T14:17:41Z

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

nodejs-github-bot · 2021-11-20T08:26:13Z

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

nodejs-github-bot · 2021-11-22T09:32:04Z

Landed in cb75dec

Signed-off-by: Matteo Collina <hello@matteocollina.com> PR-URL: #40858 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

Notable changes: build: * (SEMVER-MINOR) reset embedder string to "-node.0" (Michaël Zasso) #40488 deps: * (SEMVER-MINOR) disable trap handler for Windows cross-compiler (Michaël Zasso) #40488 * (SEMVER-MINOR) update V8 to 9.6.180.14 (Michaël Zasso) #40488 lib: * (SEMVER-MINOR) add reason to AbortSignal (James M Snell) #40807 src: * (SEMVER-MINOR) add x509.fingerprint512 to crypto module (3nprob) #39809 stream: * deprecate thenable support (Antoine du Hamel) #40860 * fix finished regression when working with legacy Stream (Matteo Collina) #40858 tools: * (SEMVER-MINOR) disable trap handler for Windows cross-compiler (Michaël Zasso) #40488 * (SEMVER-MINOR) update V8 gypfiles for 9.6 (Michaël Zasso) #40488 PR-URL: TODO

Notable changes: async_hooks: * (SEMVER-MINOR) expose async_wrap providers (Rafael Gonzaga) #40760 deps: * (SEMVER-MINOR) update V8 to 9.6.180.14 (Michaël Zasso) #40488 lib: * (SEMVER-MINOR) add reason to AbortSignal (James M Snell) #40807 src: * (SEMVER-MINOR) add x509.fingerprint512 to crypto module (3nprob) #39809 stream: * deprecate thenable support (Antoine du Hamel) #40860 * fix finished regression when working with legacy Stream (Matteo Collina) #40858 PR-URL: #40983

danielleadams · 2022-01-30T22:03:06Z

@mcollina can you create a backport PR for this if this also appears in 16.x? It broke a test in 16.x when trying to pull it in for the next release.

Notable changes: async_hooks: * (SEMVER-MINOR) expose async_wrap providers (Rafael Gonzaga) nodejs#40760 deps: * (SEMVER-MINOR) update V8 to 9.6.180.14 (Michaël Zasso) nodejs#40488 lib: * (SEMVER-MINOR) add reason to AbortSignal (James M Snell) nodejs#40807 src: * (SEMVER-MINOR) add x509.fingerprint512 to crypto module (3nprob) nodejs#39809 stream: * deprecate thenable support (Antoine du Hamel) nodejs#40860 * fix finished regression when working with legacy Stream (Matteo Collina) nodejs#40858 PR-URL: nodejs#40983

mcollina · 2022-02-01T13:19:59Z

This change does not backport cleanly and I don't think backporting it without the previous changes make sense. I have put the dont-land-x labels

mcollina requested review from ronag, addaleax, aduh95 and jasnell November 18, 2021 15:44

nodejs-github-bot added the needs-ci PRs that need a full CI run. label Nov 18, 2021

mcollina requested a review from lpinca November 18, 2021 15:45

mcollina mentioned this pull request Nov 18, 2021

lookup: skip some permanently failing modules nodejs/citgm#880

Merged

mscdex reviewed Nov 18, 2021

View reviewed changes

mcollina requested a review from targos November 18, 2021 16:39

mcollina force-pushed the fix-fastify-regression branch from ab9104f to fe41a9d Compare November 18, 2021 16:42

ronag requested changes Nov 18, 2021

View reviewed changes

stream: fix finished regression when working with legacy Stream

144a216

Signed-off-by: Matteo Collina <hello@matteocollina.com>

mcollina force-pushed the fix-fastify-regression branch from fe41a9d to 144a216 Compare November 18, 2021 17:37

ronag approved these changes Nov 18, 2021

View reviewed changes

ronag added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. stream Issues and PRs related to the stream subsystem. and removed needs-ci PRs that need a full CI run. labels Nov 18, 2021

lpinca approved these changes Nov 18, 2021

View reviewed changes

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 18, 2021

aduh95 approved these changes Nov 18, 2021

View reviewed changes

test/parallel/test-stream-finished.js Outdated Show resolved Hide resolved

github-actions bot mentioned this pull request Nov 19, 2021

CI Reliability 2021-11-19 nodejs/reliability#122

Open

31 tasks

github-actions bot mentioned this pull request Nov 20, 2021

CI Reliability 2021-11-20 nodejs/reliability#123

Open

47 tasks

github-actions bot mentioned this pull request Nov 21, 2021

CI Reliability 2021-11-21 nodejs/reliability#124

Open

41 tasks

benjamingr approved these changes Nov 21, 2021

View reviewed changes

github-actions bot mentioned this pull request Nov 22, 2021

CI Reliability 2021-11-22 nodejs/reliability#125

Open

40 tasks

aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Nov 22, 2021

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 22, 2021

nodejs-github-bot merged commit cb75dec into nodejs:master Nov 22, 2021

mcollina deleted the fix-fastify-regression branch November 22, 2021 12:21

mcollina added the notable-change PRs with changes that should be highlighted in changelogs. label Nov 22, 2021

This was referenced Nov 23, 2021

CI Reliability 2021-11-23 nodejs/reliability#126

Open

CI Reliability 2021-11-24 nodejs/reliability#127

Open

CI Reliability 2021-11-25 nodejs/reliability#128

Open

targos mentioned this pull request Nov 26, 2021

v17.2.0 release proposal #40983

Merged

danielleadams added the backport-requested-v16.x label Jan 30, 2022

mcollina added dont-land-on-v12.x and removed backport-requested-v16.x labels Feb 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stream: fix finished regression when working with legacy Stream #40858

stream: fix finished regression when working with legacy Stream #40858

mcollina commented Nov 18, 2021 •

edited

Loading

mcollina commented Nov 18, 2021

ronag commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

mcollina commented Nov 18, 2021

mscdex Nov 18, 2021 •

edited

Loading

mcollina Nov 18, 2021 •

edited

Loading

ronag commented Nov 18, 2021 •

edited

Loading

ronag left a comment

ronag commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

nodejs-github-bot commented Nov 19, 2021

nodejs-github-bot commented Nov 20, 2021

nodejs-github-bot commented Nov 22, 2021

danielleadams commented Jan 30, 2022

mcollina commented Feb 1, 2022

stream: fix finished regression when working with legacy Stream #40858

stream: fix finished regression when working with legacy Stream #40858

Conversation

mcollina commented Nov 18, 2021 • edited Loading

mcollina commented Nov 18, 2021

ronag commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

mcollina commented Nov 18, 2021

mscdex Nov 18, 2021 • edited Loading

Choose a reason for hiding this comment

mcollina Nov 18, 2021 • edited Loading

Choose a reason for hiding this comment

ronag commented Nov 18, 2021 • edited Loading

ronag left a comment

Choose a reason for hiding this comment

ronag commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

nodejs-github-bot commented Nov 18, 2021

nodejs-github-bot commented Nov 19, 2021

nodejs-github-bot commented Nov 20, 2021

nodejs-github-bot commented Nov 22, 2021

danielleadams commented Jan 30, 2022

mcollina commented Feb 1, 2022

mcollina commented Nov 18, 2021 •

edited

Loading

mscdex Nov 18, 2021 •

edited

Loading

mcollina Nov 18, 2021 •

edited

Loading

ronag commented Nov 18, 2021 •

edited

Loading