net: use actual Timeout instances on Sockets #11154

Fishrock123 · 2017-02-03T21:16:19Z

This makes net.Sockets use actual Timeout objects in a _timeout property, rather than making the socket itself a timer and appending properties to it directly.

This should make the code generally easier to understand, and might also prevent some deopts from properties being changes on the socket itself.

It is possible this could effect performance either better or worse, but I highly doubt it would be a significant difference. I'll try to run benchmarks on it in the coming days, but if anyone else would like to that would also be appreciated.

This also exposes timers.Timeout so as to avoid a circular dependency with the new lib/internal/timers.js, but we might not want that so I should be able to refactor more of timers into the internals file if necessary. Tagging as semver-minor for now due to this. I could also split that into separate commits.

Made live on https://twitch.tv/nodesource

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

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)

net, timers

cjihrig · 2017-02-03T21:28:05Z

lib/net.js

-  for (var s = this; s !== null; s = s._parent)
-    timers._unrefActive(s);
+  for (var s = this; s !== null; s = s._parent) {
+    // if (!s._timeout || s._timeout._idleTimeout === -1) continue;


Can you remove the commented code.

cjihrig · 2017-02-03T21:29:46Z

lib/net.js

-    timers._unrefActive(s);
+  for (var s = this; s !== null; s = s._parent) {
+    // if (!s._timeout || s._timeout._idleTimeout === -1) continue;
+    if (!s._timeout) continue;


Maybe a result of the commented code, but this could be

if (s._timeout) timers._unrefActive(s._timeout);

Fishrock123 · 2017-02-03T21:37:07Z

Ah right, forgot to remove that before PRing. Updated, new CI: https://ci.nodejs.org/job/node-test-pull-request/6203/

jasnell · 2017-02-03T21:44:48Z

lib/net.js

@@ -133,6 +134,7 @@ function Socket(options) {
  this._handle = null;
  this._parent = null;
  this._host = null;
+  this._timeout = null;


Rather than introducing yet another _ prefixed property, I'd much prefer to use a Symbol.
Also, given that I'm following an identical pattern in the http2 work, I'd like that Symbol to be reusable (perhaps as an export off the internal/timers.js this PR creates

Isn't that part of the implementation of a Timeout instance? i.e. didn't a socket already have it, it just wasn't declared in the constructor?

Not that I'm able to see. There are zero hits anywhere in the source for a _timeout property

It gets added if Socket#setTimeout() is called iirc https://github.com/nodejs/node/blob/master/lib/net.js#L330

Again, not that I'm able to see: https://github.com/nodejs/node/blob/master/lib/timers.js#L296-L317

Apologies, I was thinking of ._idleTimeout. Disregard

Fishrock123 · 2017-02-03T22:00:59Z

It should be noted that in situations where timer properties were previously available on the Socket object, they will not be after this patch. I highly doubt people rely on those though, since they may not always be there to begin with.

addaleax · 2017-02-04T05:35:34Z

lib/internal/timers.js

+const timers = require('timers');
+
+// Timeout values > TIMEOUT_MAX are set to 1.
+const TIMEOUT_MAX = 2147483647; // 2^31-1


Can timers.js re-use this value by importing it from here?

lpinca · 2017-02-04T11:59:25Z

Isn't this semver-major?

jasnell · 2017-02-04T15:45:42Z

I think I would lean more towards semver-major on this, just to be careful

evanlucas · 2017-02-04T15:52:18Z

+1 to Semver-major

Fishrock123 · 2017-02-04T19:37:57Z

Theoretically semver-major yes. If people seem to think it should be then so be it, I don't hold strongly one way or other.

Fishrock123 · 2017-02-10T19:54:48Z

CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/571/

Fishrock123 · 2017-02-10T20:05:24Z

Addressed most of the remaining comments.

@jasnell I made the new property hidden using a kTimeout symbol. I'm slightly worried if anyone still needed to access the timeout directly on a socket after this change. Maybe we could just expose a new API if that was really necessary, or perhaps the existing APIs already cover anything that could be needed.

jasnell · 2017-02-10T20:31:04Z

We should be safe but if someone really needed that access then adding a new API shouldn't be out of the question.

jasnell · 2017-03-22T21:59:15Z

@Fishrock123 ... ping... what's the status on this one?

Fishrock123 · 2017-03-22T22:13:55Z

Ugh, I'm just worried that we will end up breaking some module or something.

Would anyone be calling e.g. timers.active() directly on a Socket? timers.unenroll()? I mean I highly doubt it so probably not but who knows?

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

Guess we might as well land if it looks good. @nodejs/ctc if anyone else has significant reservations.

mscdex · 2017-03-22T22:16:23Z

Can the new internal module use the module.exports = {} format for consistency?

Fishrock123 · 2017-03-22T22:58:16Z

@mscdex Done, updated and rebased.

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

mscdex · 2017-04-23T18:45:45Z

lib/internal/timers.js

+
+  if (msecs < 0 || !isFinite(msecs)) {
+    throw new RangeError('"msecs" argument must be ' +
+                         'a non-negative finite number, was ' + msecs);


I prefer 'positive, finite number'. I recall having a similar discussion in a previous PR about using 'non-negative' vs 'positive' in error messages. To me it sounds more straight-forward.

As far as including the original value in the error message goes, I don't know if we've "standardized" on how it's presented, but to me the current wording is a little awkward. Perhaps it could be more explicit, like

'... must be a positive, finite number. Saw value: ' + msecs

or

'... must be a positive, finite number. Received value: ' + msecs

Zero is an allowed value but is not a positive number, though.

Zero can be positive or negative, at least as far as Javascript is concerned.

FWIW here was the previous PR I had in mind where "non-negative" was dropped in favor of "positive": #10769

Fishrock123 · 2017-04-23T19:01:51Z

@mscdex Does any of this really matter, since it is internal anyways?

mscdex · 2017-04-23T19:02:32Z

I think to check the performance difference of these changes, we'd need to either create a new benchmark or possibly run one of the http benchmarks (since timeouts may be used there) because those in benchmarks/net do not exercise socket.setTimeout().

mscdex · 2017-04-23T19:02:57Z

@Fishrock123 What do you mean "any of this?"

mscdex · 2017-04-24T16:54:50Z

Just to add, just because this function is internal does not mean suggestions should be ignored, especially because functions like setUnrefTimeout() are both used during runtime and are passed user values like msecs.

BridgeAR · 2017-08-30T19:43:46Z

@Fishrock123 this needs a rebase

BridgeAR · 2017-09-20T00:45:20Z

I am closing this due to long inactivity and no response.

@Fishrock123 please reopen if you would like to follow up on this.

Fishrock123 · 2017-10-07T21:20:21Z

This is something I am still interested in pursuing in the very near future.

Fishrock123 · 2017-11-14T23:00:08Z

Still very busy but on my short-term todo list

BridgeAR · 2017-11-22T13:09:38Z

@Fishrock123 I did not fully check if all comments were addressed or if you just rebased. Could you have another look? :-)

BridgeAR · 2017-11-22T13:10:33Z

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

Fishrock123 · 2017-11-23T01:02:53Z

FUN FACT: this patch still needed all those internal checks!

...

Fishrock123 · 2017-11-23T01:20:11Z

This should fail: https://ci.nodejs.org/job/node-test-pull-request/11650/

I can't get these to pass, I'm not sure why a clientError is emitted (this was not a problem when the patch was first ready to land).

Edit: to clarify, it fails to parse the request chunk... somehow.

=== release test-http-server-keep-alive-timeout-slow-client-headers ===
Path: sequential/test-http-server-keep-alive-timeout-slow-client-headers
'HTTP/1.1 200 OK\r\nDate: Thu, 23 Nov 2017 01:12:46 GMT\r\nConnection: keep-alive\r\nContent-Length: 0\r\n\r\n'
{ Error: Parse Error
    at socketOnEnd (_http_server.js:424:20)
    at Socket.emit (events.js:164:20)
    at endReadableNT (_stream_readable.js:1062:12)
    at _combinedTickCallback (internal/process/next_tick.js:137:11)
    at process._tickCallback (internal/process/next_tick.js:179:9) bytesParsed: 0, code: 'HPE_INVALID_EOF_STATE' }
events.js:136
      throw er; // Unhandled 'error' event
      ^

Error [ERR_STREAM_WRITE_AFTER_END]: write after end
    at writeAfterEnd (_stream_writable.js:237:12)
    at Socket.Writable.write (_stream_writable.js:288:5)
    at Socket.write (net.js:739:40)
    at Timeout.setTimeout [as _onTimeout] (/Users/Jeremiah/Documents/node/test/sequential/test-http-server-keep-alive-timeout-slow-client-headers.js:41:14)
    at ontimeout (timers.js:489:11)
    at tryOnTimeout (timers.js:313:5)
    at Timer.listOnTimeout (timers.js:273:5)
Command: out/Release/node /Users/Jeremiah/Documents/node/test/sequential/test-http-server-keep-alive-timeout-slow-client-headers.js
=== release test-http-server-keep-alive-timeout-slow-server ===
Path: sequential/test-http-server-keep-alive-timeout-slow-server
events.js:136
      throw er; // Unhandled 'error' event
      ^

Error: socket hang up
    at createHangUpError (_http_client.js:330:15)
    at Socket.socketOnEnd (_http_client.js:423:23)
    at Socket.emit (events.js:164:20)
    at endReadableNT (_stream_readable.js:1062:12)
    at _combinedTickCallback (internal/process/next_tick.js:137:11)
    at process._tickCallback (internal/process/next_tick.js:179:9)
Command: out/Release/node /Users/Jeremiah/Documents/node/test/sequential/test-http-server-keep-alive-timeout-slow-server.js

cc @nodejs/http

Fishrock123 · 2017-11-23T01:20:51Z

All type checking done in this patch is necessary for consistency with other parts of the code. If you want it changed open a separate PR.

Fishrock123 · 2017-12-15T22:05:46Z

Just gona open a new PR.

Fishrock123 added net Issues and PRs related to the net subsystem. semver-minor PRs that contain new features and should be released in the next minor version. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. labels Feb 3, 2017

nodejs-github-bot added build Issues and PRs related to build files or the CI. net Issues and PRs related to the net subsystem. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. labels Feb 3, 2017

Fishrock123 changed the title ~~net: use actual Timeout instance on Sockets~~ net: use actual Timeout instances on Sockets Feb 3, 2017

cjihrig reviewed Feb 3, 2017

View reviewed changes

Fishrock123 force-pushed the use-timeout-in-net-socket branch from 14bebdf to 18ef0d0 Compare February 3, 2017 21:36

jasnell requested changes Feb 3, 2017

View reviewed changes

addaleax reviewed Feb 4, 2017

View reviewed changes

Fishrock123 added semver-major PRs that contain breaking changes and should be released in the next major version. and removed semver-minor PRs that contain new features and should be released in the next minor version. labels Feb 4, 2017

jasnell approved these changes Feb 10, 2017

View reviewed changes

Fishrock123 force-pushed the use-timeout-in-net-socket branch from 768f5ec to 3c49be6 Compare March 22, 2017 22:57

mscdex reviewed Apr 23, 2017

View reviewed changes

BridgeAR added the stalled Issues and PRs that are stalled. label Sep 8, 2017

BridgeAR closed this Sep 20, 2017

Fishrock123 reopened this Oct 7, 2017

Fishrock123 force-pushed the use-timeout-in-net-socket branch from 8ca9329 to 0113d10 Compare November 17, 2017 01:57

BridgeAR added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed stalled Issues and PRs that are stalled. labels Nov 22, 2017

Fishrock123 removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. build Issues and PRs related to build files or the CI. labels Nov 23, 2017

Fishrock123 added 2 commits November 22, 2017 17:17

net: use actual Timeout instance on Sockets

4ec0510

TEMP - debugging for a test

606abb3

Fishrock123 force-pushed the use-timeout-in-net-socket branch from 0113d10 to 606abb3 Compare November 23, 2017 01:18

MylesBorins force-pushed the master branch from b7405ab to 7f086dd Compare December 8, 2017 16:37

Fishrock123 closed this Dec 15, 2017

Fishrock123 deleted the use-timeout-in-net-socket branch December 15, 2017 23:54

Fishrock123 mentioned this pull request Dec 16, 2017

net/http2: use actual Timeout instances #17704

Merged

3 tasks

net: use actual Timeout instances on Sockets #11154

net: use actual Timeout instances on Sockets #11154

Conversation

Fishrock123 commented Feb 3, 2017 • edited Loading

Checklist

Affected core subsystem(s)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fishrock123 commented Feb 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fishrock123 commented Feb 3, 2017

Choose a reason for hiding this comment

lpinca commented Feb 4, 2017

jasnell commented Feb 4, 2017

evanlucas commented Feb 4, 2017

Fishrock123 commented Feb 4, 2017

Fishrock123 commented Feb 10, 2017

Fishrock123 commented Feb 10, 2017

jasnell commented Feb 10, 2017

jasnell commented Mar 22, 2017

Fishrock123 commented Mar 22, 2017

mscdex commented Mar 22, 2017

Fishrock123 commented Mar 22, 2017

mscdex Apr 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mscdex Apr 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fishrock123 commented Apr 23, 2017

mscdex commented Apr 23, 2017 • edited Loading

mscdex commented Apr 23, 2017

mscdex commented Apr 24, 2017 • edited Loading

BridgeAR commented Aug 30, 2017

BridgeAR commented Sep 20, 2017

Fishrock123 commented Oct 7, 2017

Fishrock123 commented Nov 14, 2017

BridgeAR commented Nov 22, 2017

BridgeAR commented Nov 22, 2017

Fishrock123 commented Nov 23, 2017

Fishrock123 commented Nov 23, 2017 • edited Loading

Fishrock123 commented Nov 23, 2017 • edited Loading

Fishrock123 commented Dec 15, 2017

Fishrock123 commented Feb 3, 2017 •

edited

Loading

mscdex Apr 23, 2017 •

edited

Loading

mscdex Apr 23, 2017 •

edited

Loading

mscdex commented Apr 23, 2017 •

edited

Loading

mscdex commented Apr 24, 2017 •

edited

Loading

Fishrock123 commented Nov 23, 2017 •

edited

Loading

Fishrock123 commented Nov 23, 2017 •

edited

Loading