http: disable OutgoingMessage pipe method by Kasher · Pull Request #14358 · nodejs/node

Kasher · 2017-07-19T03:39:30Z

OutgoingMessage should be a write-only stream, and it shouldn't
be piped. This commit disables the pipe method by throwing
an exception (if this method is called).

Checklist

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

Affected core subsystem(s)

http

Additional data

As was suggested here: #14024, I disabled the use of the method pipe in OutgoingMessage. OutgoingMessage should be write-only, and shouldn't be piped.

OutgoingMessage should be a write-only stream, and it shouldn't be piped. This commit disables the `pipe` method by throwing an exception (if this method is called).

mscdex · 2017-07-19T04:19:30Z

Perhaps we should just remove it altogether to be more in line with what would happen with a normal Writable stream.

Kasher · 2017-07-19T13:46:54Z

@mscdex, this sounds right as well. The thing is, OutgoingMessage has a pipe method since it inherits from stream: https://github.com/nodejs/node/blob/master/lib/_http_outgoing.js#L126
We can go with delete this.pipe or something similar, but it feels a bit odd and kind of "breaks" to rules of OOP...
If (by any chance) someone looks at an instance of OutgoingMessage as a stream, he should be able to assume it has a pipe method. I would say that a "Pipe from a write-only stream" exception is a bit better than "OutgoingMessage.pipe is not a function" exception...
But again, this is JS and we actually can delete it.

What do you think? I can go with the delete approach as well if you believe it is better :)

jasnell · 2017-07-19T21:24:44Z

ping @nodejs/streams @mcollina

mcollina · 2017-07-20T07:32:33Z

@mscdex this is what we do with Writable: https://github.com/nodejs/node/blob/master/lib/_stream_writable.js#L213-L216.

@Kasher I would normalize the error message to the one in Writable, for consistency.

I flagged this as semver-major as it might be breaking.

mcollina

LGTM with the error message updated.

mcollina · 2017-07-20T07:33:50Z

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

Kasher · 2017-07-20T15:14:36Z

@mcollina , fixed.
Thanks a lot!

mcollina · 2017-07-20T17:10:06Z

This is a semver-major change, so it would need two @nodejs/ctc signoffs.

jasnell · 2017-07-21T21:56:06Z

Not sure if throwing is the right approach. The other options are either: make it a non-op such that it immediately emits terminal events, or delete the method entirely from OutgoingMessage instances.

mcollina · 2017-07-21T21:57:52Z

Throwing is the current behavior we have on Writable. I'd prefer it to be consistent.

gireeshpunathil

Overfamiliar through over-use, pipe as a function has established it's most natural meaning as: "connect the receiver object's (read) descriptor into the input object's (write) descriptor." However, pipe as a verb can also mean the reverse - "connect the input object's read side into the receiver object's writer." - essentially leading up to redefining the meaning of pipe() for Writables as pipeFrom().

That calls for a wider design decisions and not in the purview of this PR, but just mentioning as we are here.

mcollina · 2017-07-25T17:29:26Z

CI: https://ci.nodejs.org/job/node-test-pull-request/9347/
CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/927/ (cc @refack)

mcollina · 2017-07-25T23:18:53Z

Landed as 156549d.

OutgoingMessage should be a write-only stream, and it shouldn't be piped. This commit disables the `pipe` method by throwing an exception (if this method is called). PR-URL: #14358 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

refack · 2017-07-26T13:48:52Z

CitGM is clean

* **async_hooks** * Older experimental `async_hooks` APIs have been removed [[`d731369b1d`](d731369b1d)] **(SEMVER-MAJOR)** [#14414](#14414) * **Errors** * Multiple built in modules have been migrated to use static error codes * **Domains** * The long deprecated `.dispose()` method has been removed [[`602fd36d95`](602fd36d95)] **(SEMVER-MAJOR)** [#15412](#15412) * **File system** * `fs.ReadStream` and `fs.WriteStream` now make use of `.destroy()` [[`e5c290bed9`](e5c290bed9)] **(SEMVER-MAJOR)** [#15407](#15407) * `fs` callbacks are now invoked with an undefined `this` context [[`2249234fee`](2249234fee)] **(SEMVER-MAJOR)** [#14645](#14645) * **HTTP** * Socket timeout is set when the socket connects [[`10be20a0e8`](10be20a0e8)] **(SEMVER-MAJOR)** [#8895](#8895) * A bug causing the request `error` event to fire twice has been fixed [[`620ba41694`](620ba41694)] **(SEMVER-MAJOR)** [#14659](#14659) * The `pipe` method on `OutgoingMessage` has been disabled [[`156549d8ff`](156549d8ff)] **(SEMVER-MAJOR)** [#14358](#14358) * **HTTP/2** * The `--expose-http2` command-line argument is no longer required [[`f55ee6e24a`](f55ee6e24a)] **(SEMVER-MAJOR)** [#15535](#15535) * **Internationalization** * The `Intl.v8BreakIterator` class has been removed [[`668ad44922`](668ad44922)] **(SEMVER-MAJOR)** [#15238](#15238) * **OS** * `os.EOL` is now read-only [[`f6caeb9526`](f6caeb9526)] **(SEMVER-MAJOR)** [#14622](#14622) * **Process** * It is now possible to pass additional flags to `dlopen` [[`5f22375922`](5f22375922)] **(SEMVER-MAJOR)** [#12794](#12794) * **Timers** * Using a timeout duration larger than 32-bits will now emit a warning [[`ce3586da31`](ce3586da31)] **(SEMVER-MAJOR)** [#15627](#15627) * **TLS** * `parseCertString` has been deprecated [[`468110b327`](468110b327)] **(SEMVER-MAJOR)** [#14249](#14249) * Type-checking for `key`, `cert`, and `ca` options has been added [[`a7dccd040d`](a7dccd040d)] **(SEMVER-MAJOR)** [#14807](#14807)

http: disable OutgoingMessage pipe method
2516488
OutgoingMessage should be a write-only stream, and it shouldn't be piped. This commit disables the `pipe` method by throwing an exception (if this method is called).

nodejs-github-bot added the http Issues or PRs related to the http subsystem. label Jul 19, 2017

mcollina added the semver-major PRs that contain breaking changes and should be released in the next major version. label Jul 20, 2017

mcollina approved these changes Jul 20, 2017
View reviewed changes

Review fixes.
4aa3f4b

jasnell approved these changes Jul 21, 2017
View reviewed changes

gireeshpunathil approved these changes Jul 22, 2017
View reviewed changes

mcollina closed this Jul 25, 2017

mcollina mentioned this pull request Jul 30, 2017
Proxy server question nodejs/help#760
Closed

jasnell mentioned this pull request Oct 30, 2017
Proposal: 2017-10-31, Version 9.0.0 (Current) #15135
Merged

gireeshpunathil mentioned this pull request Oct 29, 2019
After update to Node 10-alpine - ERR_STREAM_CANNOT_PIPE #29690
Closed

Uh oh!

Uh oh!

Conversation

Kasher commented Jul 19, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Additional data

Uh oh!

mscdex commented Jul 19, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kasher commented Jul 19, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell commented Jul 19, 2017

Uh oh!

mcollina commented Jul 20, 2017

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

mcollina commented Jul 20, 2017

Uh oh!

Kasher commented Jul 20, 2017

Uh oh!

mcollina commented Jul 20, 2017

Uh oh!

jasnell commented Jul 21, 2017

Uh oh!

mcollina commented Jul 21, 2017

Uh oh!

gireeshpunathil left a comment

Choose a reason for hiding this comment

Uh oh!

mcollina commented Jul 25, 2017

Uh oh!

mcollina commented Jul 25, 2017

Uh oh!

refack commented Jul 26, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Kasher commented Jul 19, 2017•
edited
Loading

mscdex commented Jul 19, 2017•
edited
Loading

Kasher commented Jul 19, 2017•
edited
Loading