stream: fix writable.end callback behavior #34101

ronag · 2020-06-28T15:46:07Z

Changes so that the end() callback behaves the same way in relation to _final as write() does to _write/_writev.

Also avoids the listen to 'error' hack. Which was also inconsistent/confusing with the documentation which said the callback is attached to 'error' but it would still cause unhandled exceptions.

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

Changes so that the end() callback behaves the same way in relation to _final as write() does to _write/_writev.

ronag · 2020-06-28T15:52:08Z

lib/_stream_writable.js

@@ -185,6 +187,8 @@ function WritableState(options, stream, isDuplex) {
  // True if close has been emitted or would have been emitted
  // depending on emitClose.
  this.closeEmitted = false;
+
+  this[kOnFinished] = [];


Possible optimization to start this as null.

nodejs-github-bot · 2020-06-28T20:57:44Z

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

mcollina

lgtm

ronag · 2020-06-29T04:05:54Z

@nodejs/streams

ronag · 2020-06-29T06:51:45Z

@nodejs/tsc

nodejs-github-bot · 2020-06-29T06:51:56Z

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

doc/api/stream.md

test/parallel/test-stream-writable-destroy.js

mcollina

lgtm

nodejs-github-bot · 2020-06-29T08:43:41Z

CI: https://ci.nodejs.org/job/node-test-pull-request/32142/ ✅
CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/2398/
CITGM (master): https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/2407/

doc/api/stream.md

ronag · 2020-06-29T21:32:36Z

@Trott Can you help me with the CITGM? It's hard to tell whether this PR is introducing new failures or not. :/

ronag · 2020-07-01T16:18:25Z

Landed in c7e55c6

Changes so that the end() callback behaves the same way in relation to _final as write() does to _write/_writev. PR-URL: #34101 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Trott · 2020-07-01T22:18:55Z

@Trott Can you help me with the CITGM? It's hard to tell whether this PR is introducing new failures or not. :/

Sorry, I'm only catching up to this now. I take it that since this landed, I don't need to do anything. Let me know if I'm wrong!

Notable changes: Deprecations and Removals: - **build**: remove --build-v8-with-gn configure option (Yang Guo) (#27576) - **build**: drop support for VS2017 (Michaël Zasso) (#33694) - **doc**: move DEP0018 to End-of-Life (Rich Trott) (#35316) - **fs**: deprecation warning on recursive rmdir (Ian Sutherland) (#35562) - **lib**: add EventTarget-related browser globals (Anna Henningsen) (#35496) - **net**: remove long deprecated server.connections property (James M Snell) (#33647) - **repl**: remove deprecated repl.memory function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated repl.turnOffEditorMode() function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated repl.parseREPLKeyword() function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated bufferedCommand property (Ruben Bridgewater) (#33286) - **repl**: remove deprecated .rli (Ruben Bridgewater) (#33286) - **src**: remove deprecated node debug command (James M Snell) (#33648) - **timers**: introduce timers/promises (James M Snell) (#33950) - **util**: change default value of `maxStringLength` to 10000 (unknown) (#32744) - **wasi**: drop --experimental-wasm-bigint requirement (Colin Ihrig) (#35415) npm 7 (#35631): Node.js 15 comes with a new major release of npm, npm 7. npm 7 comes with many new features - including npm workspaces and a new package-lock.json format. npm 7 also includes yarn.lock file support. One of the big changes in npm 7 is that peer dependencies are now installed by default. Throw On Unhandled Rejections (#33021): As of Node.js 15, the default mode for `unhandledRejection` is changed to `throw` (from `warn`). In `throw` mode, if an `unhandledRejection` hook is not set, the `unhandledRejection` is raised as an uncaught exception. Users that have an `unhandledRejection` hook should see no change in behavior, and it’s still possible to switch modes using the `--unhandled-rejections=mode` process flag. QUIC (#32379): Node.js 15 comes with experimental support QUIC, which can be enabled by compiling Node.js with the `--experimental-quic` configuration flag. The Node.js QUIC implementation is exposed by the core `net` module. V8 8.6 (#35415): The V8 JavaScript engine has been updated to V8 8.6 (V8 8.4 is the latest available in Node.js 14). Along with performance tweaks and improvements the V8 update also brings the following language features: * `Promise.any()` (from V8 8.5) * `AggregateError` (from V8 8.5) * `String.prototype.replaceAll()` (from V8 8.5) * Logical assignment operators `&&=`, `||=`, and `??=` (from V8 8.5) Other Notable Changes: - **assert**: add `assert/strict` alias module (ExE Boss) (#34001) - **dns**: add dns/promises alias (shisama) (#32953) - **fs**: reimplement read and write streams using stream.construct (Robert Nagy) (#29656) - **http2**: allow Host in HTTP/2 requests (Alba Mendez) (#34664) - **lib**: add EventTarget-related browser globals (Anna Henningsen) (#35496) - **lib**: unflag AbortController (James M Snell) (#33527) - **lib**: initial experimental AbortController implementation (James M Snell) (#33527) - **net**: autoDestroy Socket (Robert Nagy) (#31806) - **src**: disallow JS execution inside FreeEnvironment (Anna Henningsen) (#33874) - **stream**: construct (Robert Nagy) (#29656) - **worker**: make MessageEvent class more Web-compatible (Anna Henningsen) (#35496) Semver-Major Commits: - **assert**: add `assert/strict` alias module (ExE Boss) (#34001) - **build**: reset embedder string to "-node.0" (Michaël Zasso) (#35415) - **build**: remove --build-v8-with-gn configure option (Yang Guo) (#27576) - **build**: drop support for VS2017 (Michaël Zasso) (#33694) - **crypto**: refactoring internals, add WebCrypto (James M Snell) (#35093) - **crypto**: move node\_crypto files to src/crypto (James M Snell) (#35093) - **deps**: V8: cherry-pick d76abfed3512 (Michaël Zasso) (#35415) - **deps**: V8: cherry-pick 717543bbf0ef (Michaël Zasso) (#35415) - **deps**: V8: cherry-pick 6be2f6e26e8d (Michaël Zasso) (#35415) - **deps**: fix V8 build issue with inline methods (Jiawen Geng) (#35415) - **deps**: fix platform-embedded-file-writer-win for ARM64 (Michaël Zasso) (#35415) - **deps**: update V8 postmortem metadata script (Colin Ihrig) (#35415) - **deps**: update V8 to 8.6.395 (Michaël Zasso) (#35415) - **deps**: upgrade npm to 7.0.0 (Myles Borins) (#35631) - **deps**: update npm to 7.0.0-rc.3 (Myles Borins) (#35474) - **deps**: V8: cherry-pick 0d6debcc5f08 (Gus Caplan) (#33600) - **dns**: add dns/promises alias (shisama) (#32953) - **doc**: move DEP0018 to End-of-Life (Rich Trott) (#35316) - **doc**: update support macos version for 15.x (Ash Cripps) (#35022) - **fs**: deprecation warning on recursive rmdir (Ian Sutherland) (#35562) - **fs**: reimplement read and write streams using stream.construct (Robert Nagy) (#29656) - **http**: fixed socket.setEncoding fatal error (iskore) (#33405) - **http**: emit 'error' on aborted server request (Robert Nagy) (#33172) - **http**: cleanup end argument handling (Robert Nagy) (#31818) - **http2**: allow Host in HTTP/2 requests (Alba Mendez) (#34664) - **http2**: add `invalidheaders` test (Pranshu Srivastava) (#33161) - **http2**: refactor state code validation for the http2Stream class (rickyes) (#33535) - **http2**: header field valid checks (Pranshu Srivastava) (#33193) - **lib**: add EventTarget-related browser globals (Anna Henningsen) (#35496) - **lib**: remove ERR\_INVALID\_OPT\_VALUE and ERR\_INVALID\_OPT\_VALUE\_ENCODING (Denys Otrishko) (#34682) - **lib**: handle one of args case in ERR\_MISSING\_ARGS (Denys Otrishko) (#34022) - **lib**: remove NodeError from the prototype of errors with code (Michaël Zasso) (#33857) - **lib**: unflag AbortController (James M Snell) (#33527) - **lib**: initial experimental AbortController implementation (James M Snell) (#33527) - **net**: check args in net.connect() and socket.connect() calls (Denys Otrishko) (#34022) - **net**: remove long deprecated server.connections property (James M Snell) (#33647) - **net**: autoDestroy Socket (Robert Nagy) (#31806) - **process**: update v8 fast api calls usage (Maya Lekova) (#35415) - **process**: change default --unhandled-rejections=throw (Dan Fabulich) (#33021) - **process**: use v8 fast api calls for hrtime (Gus Caplan) (#33600) - **process**: delay throwing an error using `throwDeprecation` (Ruben Bridgewater) (#32312) - **repl**: remove deprecated repl.memory function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated repl.turnOffEditorMode() function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated repl.parseREPLKeyword() function (Ruben Bridgewater) (#33286) - **repl**: remove deprecated bufferedCommand property (Ruben Bridgewater) (#33286) - **repl**: remove deprecated .rli (Ruben Bridgewater) (#33286) - **src**: implement NodePlatform::PostJob (Clemens Backes) (#35415) - **src**: update NODE\_MODULE\_VERSION to 88 (Michaël Zasso) (#35415) - **src**: error reporting on CPUUsage (Yash Ladha) (#34762) - **src**: use node:moduleName as builtin module filename (Michaël Zasso) (#35498) - **src**: enable wasm trap handler on windows (Gus Caplan) (#35033) - **src**: update NODE\_MODULE\_VERSION to 86 (Michaël Zasso) (#33579) - **src**: disallow JS execution inside FreeEnvironment (Anna Henningsen) (#33874) - **src**: remove \_third\_party\_main support (Anna Henningsen) (#33971) - **src**: remove deprecated node debug command (James M Snell) (#33648) - **src**: remove unused CancelPendingDelayedTasks (Anna Henningsen) (#32859) - **stream**: try to wait for flush to complete before 'finish' (Robert Nagy) (#34314) - **stream**: cleanup and fix Readable.wrap (Robert Nagy) (#34204) - **stream**: add promises version to utility functions (rickyes) (#33991) - **stream**: fix writable.end callback behavior (Robert Nagy) (#34101) - **stream**: construct (Robert Nagy) (#29656) - **stream**: write should throw on unknown encoding (Robert Nagy) (#33075) - **stream**: fix \_final and 'prefinish' timing (Robert Nagy) (#32780) - **stream**: simplify Transform stream implementation (Robert Nagy) (#32763) - **stream**: use callback to properly propagate error (Robert Nagy) (#29179) - **test**: update tests after increasing typed array size to 4GB (Kim-Anh Tran) (#35415) - **test**: fix tests for npm 7.0.0 (Myles Borins) (#35631) - **test**: fix test suite to work with npm 7 (Myles Borins) (#35474) - **test**: update WPT harness and tests (Michaël Zasso) (#33770) - **timers**: introduce timers/promises (James M Snell) (#33950) - **tools**: disable x86 safe exception handlers in V8 (Michaël Zasso) (#35415) - **tools**: update V8 gypfiles for 8.6 (Ujjwal Sharma) (#35415) - **tools**: update V8 gypfiles for 8.5 (Ujjwal Sharma) (#35415) - **url**: file URL path normalization (Daijiro Wachi) (#35477) - **url**: verify domain is not empty after "ToASCII" (Michaël Zasso) (#33770) - **url**: remove U+0000 case in the fragment state (Michaël Zasso) (#33770) - **url**: remove gopher from special schemes (Michaël Zasso) (#33325) - **url**: forbid lt and gt in url host code point (Yash Ladha) (#33328) - **util**: change default value of `maxStringLength` to 10000 (unknown) (#32744) - **wasi**: drop --experimental-wasm-bigint requirement (Colin Ihrig) (#35415) - **win, child_process**: sanitize env variables (Bartosz Sosnowski) (#35210) - **worker**: make MessageEvent class more Web-compatible (Anna Henningsen) (#35496) - **worker**: set trackUnmanagedFds to true by default (Anna Henningsen) (#34394) - **worker**: rename error code to be more accurate (Anna Henningsen) (#33872) PR-URL: #35014

On Node.js 15, as a result of nodejs/node#34101 the callback passed to #end() is not called if an error occurs in that the InflateAuto behavior matches the stream.Transform behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

nodejs-github-bot added the stream Issues and PRs related to the stream subsystem. label Jun 28, 2020

ronag force-pushed the writable-end-cb branch 2 times, most recently from 0ca8d16 to bf6828a Compare June 28, 2020 15:48

stream: fix writable.end callback behavior

c563977

Changes so that the end() callback behaves the same way in relation to _final as write() does to _write/_writev.

ronag force-pushed the writable-end-cb branch from bf6828a to c563977 Compare June 28, 2020 15:48

ronag requested a review from mcollina June 28, 2020 15:51

ronag commented Jun 28, 2020

View reviewed changes

ronag mentioned this pull request Jun 28, 2020

Stream Issues #34108

Open

25 tasks

mcollina added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jun 28, 2020

mcollina approved these changes Jun 28, 2020

View reviewed changes

github-actions bot mentioned this pull request Jun 29, 2020

CI Relability 2020-06-29 JaneaSystems/nodejs-reliability#22

Open

16 tasks

mcollina reviewed Jun 29, 2020

View reviewed changes

doc/api/stream.md Show resolved Hide resolved

test/parallel/test-stream-writable-destroy.js Show resolved Hide resolved

mcollina approved these changes Jun 29, 2020

View reviewed changes

ronag added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 29, 2020

addaleax approved these changes Jun 29, 2020

View reviewed changes

doc/api/stream.md Show resolved Hide resolved

fixup: add changes

5d901cb

This was referenced Jun 30, 2020

CI Relability 2020-06-30 JaneaSystems/nodejs-reliability#23

Open

CI Relability 2020-07-01 JaneaSystems/nodejs-reliability#24

Open

ronag closed this Jul 1, 2020

This was referenced Jul 2, 2020

CI Relability 2020-07-02 JaneaSystems/nodejs-reliability#25

Open

CI Relability 2020-07-03 JaneaSystems/nodejs-reliability#26

Open

github-actions bot mentioned this pull request Jul 4, 2020

CI Relability 2020-07-04 JaneaSystems/nodejs-reliability#27

Open

32 tasks

This was referenced Jul 5, 2020

CI Relability 2020-07-05 JaneaSystems/nodejs-reliability#28

Open

CI Relability 2020-07-06 JaneaSystems/nodejs-reliability#29

Open

CI Relability 2020-07-07 JaneaSystems/nodejs-reliability#30

Open

BethGriggs mentioned this pull request Sep 1, 2020

2020-10-20, Version 15.0.0 (Current) #35014

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stream: fix writable.end callback behavior #34101

stream: fix writable.end callback behavior #34101

ronag commented Jun 28, 2020 •

edited

ronag Jun 28, 2020

nodejs-github-bot commented Jun 28, 2020

mcollina left a comment

ronag commented Jun 29, 2020

ronag commented Jun 29, 2020

nodejs-github-bot commented Jun 29, 2020

mcollina left a comment

nodejs-github-bot commented Jun 29, 2020 •

edited by ronag

ronag commented Jun 29, 2020

ronag commented Jul 1, 2020

Trott commented Jul 1, 2020

stream: fix writable.end callback behavior #34101

stream: fix writable.end callback behavior #34101

Conversation

ronag commented Jun 28, 2020 • edited

Checklist

ronag Jun 28, 2020

Choose a reason for hiding this comment

nodejs-github-bot commented Jun 28, 2020

mcollina left a comment

Choose a reason for hiding this comment

ronag commented Jun 29, 2020

ronag commented Jun 29, 2020

nodejs-github-bot commented Jun 29, 2020

mcollina left a comment

Choose a reason for hiding this comment

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

ronag commented Jun 29, 2020

ronag commented Jul 1, 2020

Trott commented Jul 1, 2020

ronag commented Jun 28, 2020 •

edited

nodejs-github-bot commented Jun 29, 2020 •

edited by ronag