doc: clarify socket and keepAliveTimeout interaction #25748

inversion · 2019-01-27T23:19:55Z

doc: clarify socket and keepAliveTimeout interaction

Socket timeouts set using the connection event are replaced by
server.keepAliveTimeout when a response is handled.

Socket timeouts set in the connection event are replaced after a response is sent in the resOnFinish handler

server.on('connection', function(socket) {
  socket.setTimeout(60000);
});

In this case, the socket timeout is 60 seconds until a response is sent, at which point it becomes 5 seconds (the server.keepAliveTimeout default). This bit me when working with load balancers that maintain long-lived connections.

I have added a note to the connection event docs to the effect that is preferred to use server.keepAliveTimeout.

Checklist

documentation is changed or added
commit message follows commit guidelines

mscdex · 2019-01-28T00:28:33Z

The subsystem prefix in commit messages for doc-only changes should be doc instead of the specific core module name.

Trott · 2019-01-28T00:33:03Z

doc/api/http.md

@@ -901,6 +901,10 @@ also be accessed at `request.connection`.
 This event can also be explicitly emitted by users to inject connections
 into the HTTP server. In that case, any [`Duplex`][] stream can be passed.

+If `socket.setTimeout()` is called here, note that the timeout will


Suggested change

If `socket.setTimeout()` is called here, note that the timeout will

If `socket.setTimeout()` is called here, the timeout will

@Trott Are we landing as is or can we add this fix on landing?

@inversion are you ok with @Trott suggestion? If so please accept it so this can land.
Thank you.

My change is non-blocking. It's not crucial that note that be removed. (It can also be removed by someone else who is landing this--just push to the branch. Or it can be removed in a subsequent PR as I imagine there are lots of opportunities for cleanup in the doc file.)

Trott · 2019-01-28T00:35:13Z

Hi, @inversion! Welcome and thanks for the pull request! Sorry to hear that this behavior caused you some grief!

/ping @nodejs/http to confirm that the behavior described here is correct and is currently undocumented.

/ping @nodejs/documentation Maybe there's a way to simplify or clarify the wording here a bit? Maybe a small piece of sample code with comments indicating the values and when they change? Or is that too much documentation real estate to describe what is likely an edge case?

inversion · 2019-01-28T09:07:00Z

The subsystem prefix in commit messages for doc-only changes should be doc instead of the specific core module name.

I'll fix this, probably worth adding it to https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines

Socket timeouts set using the `connection` event are replaced by server.keepAliveTimeout when a response is handled.

Trott · 2019-01-28T20:56:25Z

I fixed up the commit message subsystem, rebased against master, and force-pushed.

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2423/

inversion · 2019-01-29T22:56:27Z

Thanks very much @Trott !

Trott · 2019-02-03T20:32:34Z

@nodejs/collaborators This could use another review.

doc/api/http.md

`Socket.prototype.setTimeout()` clears the previous timer before setting a new one. Refs: nodejs#25748 (comment)

`Socket.prototype.setTimeout()` clears the previous timer before setting a new one. Refs: #25748 (comment) PR-URL: #25928 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

mcollina

LGTM

lpinca · 2019-02-08T10:40:17Z

CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2545/

lpinca · 2019-02-09T06:26:44Z

Landed in 02601c2.

Socket timeouts set using the `'connection'` event are replaced by `server.keepAliveTimeout` when a response is handled. PR-URL: #25748 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels Jan 27, 2019

inversion force-pushed the doc-clarify-http-keepAliveTimeout branch from 344dfc6 to 4696232 Compare January 28, 2019 00:21

Trott reviewed Jan 28, 2019

View reviewed changes

lpinca approved these changes Jan 28, 2019

View reviewed changes

doc: clarify http timeouts

5f761e9

Socket timeouts set using the `connection` event are replaced by server.keepAliveTimeout when a response is handled.

Trott force-pushed the doc-clarify-http-keepAliveTimeout branch from 4696232 to 5f761e9 Compare January 28, 2019 20:56

Trott changed the title ~~http: Clarify socket and keepAliveTimeout interaction~~ doc: clarify socket and keepAliveTimeout interaction Jan 28, 2019

Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 28, 2019

mcollina reviewed Feb 4, 2019

View reviewed changes

doc/api/http.md Show resolved Hide resolved

lpinca added a commit to lpinca/node that referenced this pull request Feb 4, 2019

http: remove redundant call to socket.setTimeout()

bdd2da2

`Socket.prototype.setTimeout()` clears the previous timer before setting a new one. Refs: nodejs#25748 (comment)

lpinca mentioned this pull request Feb 4, 2019

http: remove redundant call to socket.setTimeout() #25928

Closed

2 tasks

mcollina approved these changes Feb 8, 2019

View reviewed changes

lpinca closed this Feb 9, 2019

inversion deleted the doc-clarify-http-keepAliveTimeout branch February 9, 2019 11:16

targos mentioned this pull request Feb 14, 2019

v11.10.0 proposal #26098

Merged

This was referenced Feb 15, 2019

2019-02-14 Version 11.10.0 (Current) @targos beevelop/docker-nodejs#263

Closed

2019-02-14 Version 11.10.0 (Current) @targos beevelop/docker-android-nodejs#286

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: clarify socket and keepAliveTimeout interaction #25748

doc: clarify socket and keepAliveTimeout interaction #25748

inversion commented Jan 27, 2019 •

edited by Trott

mscdex commented Jan 28, 2019

Trott Jan 28, 2019

vsemozhetbyt Feb 3, 2019

lpinca Feb 8, 2019 •

edited

Trott Feb 9, 2019

Trott commented Jan 28, 2019

inversion commented Jan 28, 2019

Trott commented Jan 28, 2019

inversion commented Jan 29, 2019

Trott commented Feb 3, 2019

mcollina left a comment

lpinca commented Feb 8, 2019

lpinca commented Feb 9, 2019

	If `socket.setTimeout()` is called here, note that the timeout will
	If `socket.setTimeout()` is called here, the timeout will

doc: clarify socket and keepAliveTimeout interaction #25748

doc: clarify socket and keepAliveTimeout interaction #25748

Conversation

inversion commented Jan 27, 2019 • edited by Trott

Checklist

mscdex commented Jan 28, 2019

Trott Jan 28, 2019

Choose a reason for hiding this comment

vsemozhetbyt Feb 3, 2019

Choose a reason for hiding this comment

lpinca Feb 8, 2019 • edited

Choose a reason for hiding this comment

Trott Feb 9, 2019

Choose a reason for hiding this comment

Trott commented Jan 28, 2019

inversion commented Jan 28, 2019

Trott commented Jan 28, 2019

inversion commented Jan 29, 2019

Trott commented Feb 3, 2019

mcollina left a comment

Choose a reason for hiding this comment

lpinca commented Feb 8, 2019

lpinca commented Feb 9, 2019

inversion commented Jan 27, 2019 •

edited by Trott

lpinca Feb 8, 2019 •

edited