Skip to content

stream, http, http2: make all stream.end() call return this#18780

Closed
mcollina wants to merge 3 commits intonodejs:masterfrom
mcollina:end-this
Closed

stream, http, http2: make all stream.end() call return this#18780
mcollina wants to merge 3 commits intonodejs:masterfrom
mcollina:end-this

Conversation

@mcollina
Copy link
Member

@mcollina mcollina commented Feb 14, 2018

This PR make all the instances of stream.end() return this. This includes both http and http2 pseudo-writables.

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
Affected core subsystem(s)

stream, http, http2

@mcollina mcollina requested a review from addaleax February 14, 2018 13:47
@nodejs-github-bot nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Feb 14, 2018
@mcollina
Copy link
Member Author

mcollina commented Feb 14, 2018

cc @mafintosh @nodejs/streams

@mscdex
Copy link
Contributor

mscdex commented Feb 14, 2018

Can this change in return type really be justified?

Also:

  • an early return is missed in OutgoingMessage.end()
  • shouldn't this be semver-major because of the change in return type?

@benjamingr benjamingr added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 14, 2018
@benjamingr
Copy link
Member

benjamingr commented Feb 14, 2018

@mcollina I'm guessing we missed some context - any reading material about this change or some rationale?

@jasnell
Copy link
Member

jasnell commented Feb 14, 2018

Adding a return type where there was previously not one should not be semver-major as it shouldn't break any prior assumptions.

@benjamingr
Copy link
Member

benjamingr commented Feb 14, 2018

@jasnell uhh.. I think it can break assumptions?

I've seen return somethingThatReturnsUndefined() in JavaScript quite a few times in order to avoid doing somethingThatReturnsUndefined(); return; in two lines. I don't like it, but it's definitely there - and this isn't a change in an experimental library - it's core HTTP which everyone builds on.

@jasnell
Copy link
Member

jasnell commented Feb 14, 2018

Bleh, ok. Major it is then.

@mcollina
Copy link
Member Author

mcollina commented Feb 14, 2018

I forgot to put the label on it, the intention is it to be semver-major.

Basically this cleans up the situation for .end() in streams. Currently we have net and tls that return this, the stream module that returns undefined, and http that return whatever _send() returns. I thought that the least disruptive change would be to have it return this everywhere.

benjamingr
benjamingr approved these changes Feb 14, 2018
View reviewed changes
Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that explains it and this does bring consistency. Actual code LGTM

@mcollina
Copy link
Member Author

mcollina commented Feb 15, 2018

@mscdex PTAL

CI: https://ci.nodejs.org/job/node-test-pull-request/13182/
CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1293/

lpinca
lpinca approved these changes Feb 15, 2018
View reviewed changes
doc/api/http.md Outdated
Copy link
Member

@lpinca lpinca Feb 15, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: how about using just ClientRequest to be consistent with the other comments?

Copy link
Member Author

@mcollina mcollina Feb 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 16, 2018
@mcollina
Copy link
Member Author

mcollina commented Feb 16, 2018

@mscdex are you ok with this change then?

@BridgeAR
Copy link
Member

BridgeAR commented Feb 17, 2018

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

@mcollina
Copy link
Member Author

mcollina commented Feb 19, 2018

Landed as f6721c2, 8118da7 and 3d93f39.

@mcollina mcollina closed this Feb 19, 2018
@mcollina mcollina deleted the end-this branch February 19, 2018 10:32
mcollina added a commit that referenced this pull request Feb 19, 2018
@mcollina
stream: writable.end should return this.
f6721c2 
PR-URL: #18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
mcollina added a commit that referenced this pull request Feb 19, 2018
@mcollina
http: OutgoingMessage.end() should return this
8118da7 
PR-URL: #18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
mcollina added a commit that referenced this pull request Feb 19, 2018
@mcollina
http2: make response.end() return this
3d93f39 
PR-URL: #18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@benjamingr
Copy link
Member

benjamingr commented Feb 19, 2018

Awesome work, adding "don't land on" tags.

MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@mcollina @MayaLekova
stream: writable.end should return this.
35ee7c7 
PR-URL: nodejs#18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@mcollina @MayaLekova
http: OutgoingMessage.end() should return this
39e12f1 
PR-URL: nodejs#18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@mcollina @MayaLekova
http2: make response.end() return this
1fb36fc 
PR-URL: nodejs#18780
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@benjamingr benjamingr benjamingr approved these changes

@lpinca lpinca lpinca approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. lib / src Issues and PRs related to general changes in the lib or src directory. semver-major PRs that contain breaking changes and should be released in the next major version.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@mcollina @mscdex @benjamingr @jasnell @BridgeAR @addaleax @lpinca @nodejs-github-bot