Customize timeouts and generally improve the whole thing #534

jstewmon · 2018-07-23T21:30:43Z

Refactor timed-out to optimistically defer errors until after the poll
phase of the current event loop tick.
Timeouts begin and end when their respective phase of the lifecycle
begins and ends.
Timeouts result in a got.TimeoutError

This includes the controversial change discussed in #525: removal of setImmediate around response handling and the addition of setImmediate in the timeout handling. Those change are not strictly required and can be reverted if necessary and everything in this PR will still work.

- Refactor timed-out to optimistically defer errors until after the poll phase of the current event loop tick. - Timeouts begin and end when their respective phase of the lifecycle begins and ends. - Timeouts result in a `got.TimeoutError`

jstewmon · 2018-07-23T21:33:06Z

readme.md

@@ -188,7 +188,13 @@ Type: `number` `Object`

 Milliseconds to wait for the server to end the response before aborting request with `ETIMEDOUT` error (a.k.a. `request` property). By default there's no timeout.

-This also accepts an object with separate `connect`, `socket`, and `request` fields for connection, socket, and entire request timeouts.
+This also accepts an object with separate `lookup`, `connect`, `socket`, `response` and `request` fields to specify granular timeouts for each phase of the request.


Being able to set timeouts around each phase is more useful that timing each phase from the beginning of the request.

A concrete example is being able to time the response phase (TTFB) when the target is a load-balanced java service which may be undergoing garbage collection. We often want to set a very aggressive response timeout in this case, so that we can retry the request immediately against another instance.

jstewmon · 2018-07-23T21:34:11Z

source/request-as-event-emitter.js

@@ -119,23 +117,23 @@ module.exports = (options = {}) => {
 					return;
 				}

-				const err = new RequestError(error, options);
-				emitter.emit('retry', err, retried => {
+				if (!(error instanceof GotError)) {


I wasn't sure that this was the precise change needed. My objective was to expose the TimeoutError to a client using the Promise interface.

https://docs.travis-ci.com/user/reference/precise/#Networking

szmarczak · 2018-07-24T17:26:16Z

readme.md

+- `connect` starts when `lookup` completes (or when the socket is assigned if lookup does not apply to the request) and ends when the socket is connected.
+- `socket` starts when the socket is connected. See [request.setTimeout](https://nodejs.org/api/http.html#http_request_settimeout_timeout_callback).
+- `response` starts when the socket is connected and ends when the response headers are received.
+- `request` starts when the request is initiated and ends when the response's end event fires.


I'm curious about the naming of response timeout and request timeout.
Should be these names swapped (as the timeouts say how much time can pass until it reaches the event)?

I think the names should be as transparent as possible. lookup, connect and response are nice because they map directly to the event that ends the phase.

request and socket are the outliers, but I left them as they were to maximize backwards compatibility.

If we want to forego backwards compatibility, I'd suggest renaming request to overall or total. socket may be more expressive as idleSocket, but I think it's too pedantic to justify the incompatibility.

I'd suggest renaming request to overall or total.

👍

socket may be more expressive as idleSocket, but I think it's too pedantic to justify the incompatibility.

Agreed. socket is enough IMO.

@sindresorhus what do you think about changing request to overall or total?

Following up on this, I realized that the response timer would start too soon if the request spent significant time writing to the socket, so I implemented a fix for that by emitting a custom event on the request when the body has been written.

This also enabled the addition of a send timer.

If we were starting from scratch I would name the send timer request and I would name the request timer overall. But, I worry that changing the meaning of those names is subtle enough to go overlooked by users, leading to bugs that can be avoided by just keeping the imperfect names.

szmarczak · 2018-07-24T17:38:44Z

source/request-as-event-emitter.js

+				getResponse(response, options, emitter, redirects);
+			} catch (error) {
+				emitter.emit('error', error);
+			}


Can we leave this unchanged as this is being discussed in #525? Try not to duplicate PRs.

I agree, this should not have been included here, but since I'm gonna accept #525, I'll allow it.

szmarczak · 2018-07-24T17:49:44Z

source/timed-out.js

+				});
+			} else {
+				req.once('response', timeResponse());
+			}


Love the new timed-out.js. ❤️ 🙌

szmarczak

Excellent piece of work. 😺

… socket

jstewmon · 2018-07-24T21:56:54Z

@szmarczak thanks for the flattering review :-)

jstewmon · 2018-07-24T21:58:32Z

test/timeout.js

+});
+
+test('response timeout (slow upload)', async t => {
+	const body = fs.createReadStream('/dev/urandom', {


Ugh, I forgot about AppVeyor. I'll look for an alternative. Suggestions welcome.

I made https://github.com/sindresorhus/random-bytes-readable-stream, but I see you already solved the problem :)

That looks handy :-)

- add response timeout tests for slow upload and download - add send test with keepalive - increase timeouts to mitigate intermittent false negatives

sindresorhus · 2018-07-25T07:44:42Z

@jstewmon This is great! Thanks for doing such a thorough investigating into timeouts. 🙌

jstewmon commented Jul 23, 2018

View reviewed changes

fix: hardcode ipv4 loopback address in tests to appease travis-ci

0ff85f5

https://docs.travis-ci.com/user/reference/precise/#Networking

szmarczak reviewed Jul 24, 2018

View reviewed changes

szmarczak approved these changes Jul 24, 2018

View reviewed changes

szmarczak changed the title ~~feat: add timeouts for lookup and response events~~ Customize timeouts and generally improve the whole thing Jul 24, 2018

Jonathan Stewmon added 3 commits July 24, 2018 16:44

fix: response timer should start when request has been written to the…

a8bee05

… socket

fix: remove connect timeout from retry tests to mitigate false-negatives

e54cc20

feat: add send timeout

77a96c9

jstewmon force-pushed the more-timeouts branch from 9042dad to 77a96c9 Compare July 24, 2018 21:45

jstewmon commented Jul 24, 2018

View reviewed changes

Jonathan Stewmon and others added 2 commits July 24, 2018 22:32

fix: response timer should cancel on response

0975372

- add response timeout tests for slow upload and download - add send test with keepalive - increase timeouts to mitigate intermittent false negatives

Update readme.md

caae921

sindresorhus merged commit da4f236 into sindresorhus:master Jul 25, 2018

sindresorhus mentioned this pull request Jul 25, 2018

Use events to wire upload tracking instead of racing with setImmediate #525

Closed

This was referenced Jul 25, 2018

Tests for timed-out.js file #527

Closed

docs: DRY the timeout object section #535

Merged

jstewmon deleted the more-timeouts branch July 25, 2018 15:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Customize timeouts and generally improve the whole thing #534

Customize timeouts and generally improve the whole thing #534

jstewmon commented Jul 23, 2018

jstewmon Jul 23, 2018

jstewmon Jul 23, 2018

szmarczak Jul 24, 2018

jstewmon Jul 24, 2018

szmarczak Jul 24, 2018

jstewmon Jul 24, 2018

jstewmon Jul 24, 2018

szmarczak Jul 24, 2018

sindresorhus Jul 25, 2018

szmarczak Jul 24, 2018 •

edited

szmarczak left a comment •

edited

jstewmon commented Jul 24, 2018

jstewmon Jul 24, 2018

sindresorhus Jul 25, 2018

jstewmon Jul 25, 2018

sindresorhus commented Jul 25, 2018 •

edited

Customize timeouts and generally improve the whole thing #534

Customize timeouts and generally improve the whole thing #534

Conversation

jstewmon commented Jul 23, 2018

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szmarczak Jul 24, 2018 • edited

Choose a reason for hiding this comment

szmarczak left a comment • edited

Choose a reason for hiding this comment

jstewmon commented Jul 24, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Jul 25, 2018 • edited

szmarczak Jul 24, 2018 •

edited

szmarczak left a comment •

edited

sindresorhus commented Jul 25, 2018 •

edited