tls: make tls.connect() accept a timeout option #25517

lpinca · 2019-01-15T15:32:14Z

If specified, and only when a socket is created internally, the option
will make socket.setTimeout() to be called on the created socket with
the given timeout.

This is consistent with the timeout option of net.connect() and
prevents the timeout option of the https.Agent from being ignored
when a socket is created.

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

nodejs-github-bot · 2019-01-15T15:32:15Z

@lpinca sadly an error occured when I tried to trigger a build :(

cjihrig · 2019-01-15T15:36:27Z

doc/api/tls.md

@@ -1023,6 +1023,9 @@ being issued by trusted CA (`options.ca`).
 <!-- YAML
 added: v0.11.3
 changes:
+  - version: REPLACEME
+    pr-url: REPLACEME


https://github.com/nodejs/node/pull/25517. Just pointing it out because I know it's easy to forget.

Yes will do just wasn't sure what id to use before submitting.

sam-github · 2019-01-15T15:42:04Z

doc/api/tls.md

@@ -1088,6 +1091,9 @@ changes:
    `tls.createSecureContext()`.
  * `lookup`: {Function} Custom lookup function. **Default:**
    [`dns.lookup()`][].
+  * `timeout`: {number} If set and if a socket is created internally, will call
+    `socket.setTimeout(timeout)` after the socket is created, but before it


maybe hyperlink to the setTimeout docs?

If specified, and only when a socket is created internally, the option will make `socket.setTimeout()` to be called on the created socket with the given timeout. This is consistent with the `timeout` option of `net.connect()` and prevents the `timeout` option of the `https.Agent` from being ignored when a socket is created.

silverwind · 2019-01-15T21:04:15Z

lib/_tls_wrap.js

@@ -1256,6 +1256,11 @@ exports.connect = function connect(...args) {
      localAddress: options.localAddress,
      lookup: options.lookup
    };
+
+    if (options.timeout) {


typeof options.timeout === 'number' to allow setting a timeout of 0.

0 == disabled idle timeout so I'm not sure if it's very useful. I mean it's like not setting it at all.

Right, keep it as is.

This code for tls.connect() is identical to that in net.connect(),

node/lib/net.js

Lines 158 to 160 in 2c7f4f4

if (options.timeout) {

socket.setTimeout(options.timeout);

}

, which is what I'd expect, so LGTM as is.

lpinca · 2019-01-16T10:52:15Z

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

lpinca · 2019-01-20T11:26:08Z

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

lpinca · 2019-01-20T13:57:50Z

Landed in aaa7547.

If specified, and only when a socket is created internally, the option will make `socket.setTimeout()` to be called on the created socket with the given timeout. This is consistent with the `timeout` option of `net.connect()` and prevents the `timeout` option of the `https.Agent` from being ignored when a socket is created. PR-URL: #25517 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

Notable Changes: * events: * For unhandled `error` events with an argument that is not an `Error` object, the resulting exeption will have more information about the argument. #25621 * child_process: * When the `maxBuffer` option is passed, `stdout` and `stderr` will be truncated rather than unavailable in case of an error. #24951 * policy: * Experimental support for module integrity checks through a manifest file is implemented now. #23834 * n-api: * The `napi_threadsafe_function` feature is now stable. #25556 * report: * An experimental diagnostic API for capturing process state is available as `process.report` and through command line flags. #22712 * tls: * `tls.connect()` takes a `timeout` option analogous to the `net.connect()` one. #25517 * worker: * `process.umask()` is available as a read-only function inside Worker threads now. #25526 * An `execArgv` option that supports a subset of Node.js command line options is supported now. #25467 PR-URL: #25687

If specified, and only when a socket is created internally, the option will make `socket.setTimeout()` to be called on the created socket with the given timeout. This is consistent with the `timeout` option of `net.connect()` and prevents the `timeout` option of the `https.Agent` from being ignored when a socket is created. PR-URL: #25517 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

nodejs-github-bot added the tls Issues and PRs related to the tls subsystem. label Jan 15, 2019

cjihrig reviewed Jan 15, 2019

View reviewed changes

sam-github approved these changes Jan 15, 2019

View reviewed changes

richardlau mentioned this pull request Jan 15, 2019

sadly an error occured when I tried to trigger a build :( nodejs/github-bot#210

Closed

lpinca force-pushed the add/timeout-option branch from ef94920 to cad7708 Compare January 15, 2019 17:05

lpinca force-pushed the add/timeout-option branch from cad7708 to 7c158bf Compare January 15, 2019 17:07

silverwind approved these changes Jan 15, 2019

View reviewed changes

silverwind reviewed Jan 15, 2019

View reviewed changes

BridgeAR approved these changes Jan 16, 2019

View reviewed changes

lpinca closed this Jan 20, 2019

lpinca deleted the add/timeout-option branch January 20, 2019 13:58

addaleax added the semver-minor PRs that contain new features and should be released in the next minor version. label Jan 24, 2019

MylesBorins mentioned this pull request Jan 24, 2019

v11.8.0 proposal #25687

Merged

lpinca mentioned this pull request Mar 4, 2019

Socket connection timeouts don't fire websockets/ws#1523

Closed

1 task

BethGriggs mentioned this pull request May 1, 2019

v10.16.0 proposal #27514

Merged

Nyaran mentioned this pull request Aug 1, 2021

Password not reading koalazak/dorita980#134

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tls: make tls.connect() accept a timeout option #25517

tls: make tls.connect() accept a timeout option #25517

lpinca commented Jan 15, 2019

nodejs-github-bot commented Jan 15, 2019

cjihrig Jan 15, 2019

lpinca Jan 15, 2019

sam-github Jan 15, 2019

silverwind Jan 15, 2019

lpinca Jan 15, 2019 •

edited

Loading

silverwind Jan 15, 2019

sam-github Jan 15, 2019

lpinca commented Jan 16, 2019

lpinca commented Jan 20, 2019

lpinca commented Jan 20, 2019

tls: make tls.connect() accept a timeout option #25517

tls: make tls.connect() accept a timeout option #25517

Conversation

lpinca commented Jan 15, 2019

Checklist

nodejs-github-bot commented Jan 15, 2019

cjihrig Jan 15, 2019

Choose a reason for hiding this comment

lpinca Jan 15, 2019

Choose a reason for hiding this comment

sam-github Jan 15, 2019

Choose a reason for hiding this comment

silverwind Jan 15, 2019

Choose a reason for hiding this comment

lpinca Jan 15, 2019 • edited Loading

Choose a reason for hiding this comment

silverwind Jan 15, 2019

Choose a reason for hiding this comment

sam-github Jan 15, 2019

Choose a reason for hiding this comment

lpinca commented Jan 16, 2019

lpinca commented Jan 20, 2019

lpinca commented Jan 20, 2019

lpinca Jan 15, 2019 •

edited

Loading