http: add support for abortsignal to http.request #36048

benjamingr · 2020-11-09T10:53:48Z

This is the last one from #35877 (comment) - if you have any more APIs you want me to add support for AbortSignal in before I go back to that list I started making back then please let me know :]

Also we should talk about streams and this probably.

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 · 2020-11-09T10:53:52Z

Review requested:

@nodejs/http
@nodejs/net

addaleax · 2020-11-09T11:02:18Z

test/parallel/test-http-client-abort-destroy.js

+  const server = http.createServer(common.mustNotCall((req, res) => {
+  }));


Suggested change

const server = http.createServer(common.mustNotCall((req, res) => {

}));

const server = http.createServer(common.mustNotCall());

lundibundi · 2020-11-09T11:06:33Z

doc/api/http.md

@@ -2596,6 +2601,10 @@ events will be emitted in the following order:
 Setting the `timeout` option or using the `setTimeout()` function will
 not abort the request or do anything besides add a `'timeout'` event.

+Passing an `AbortSignal` and then calling `abort` on the corrosponding


Suggested change

Passing an `AbortSignal` and then calling `abort` on the corrosponding

Passing an `AbortSignal` and then calling `abort` on the corresponding

lundibundi · 2020-11-09T11:09:09Z

lib/_http_client.js

+  if (options.signal) {
+    validateAbortSignal(options.signal, 'options.signal');
+    const listener = (e) => this.destroy();
+    options.signal.addEventListener('abort', listener);


Nit: perhaps use once here as well ({ once: true })?

I feel like it would be more hacky since we're removing the listener below even if it is invoked since close should be fired.

If I pass once and someone abortss the controller - the signal will fire abort, the listener will be removed, then close will fire and we will try removing a non-existing listener which will technically be no harm but will be slightly confusing.

rickyes · 2020-11-09T11:11:03Z

doc/api/http.md

@@ -2336,6 +2336,9 @@ This can be overridden for servers and client requests by passing the
 <!-- YAML
 added: v0.3.6
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/319999


Suggested change

pr-url: https://github.com/nodejs/node/pull/319999

pr-url: https://github.com/nodejs/node/pull/36048

rickyes · 2020-11-09T11:13:03Z

test/parallel/test-http-client-abort-destroy.js

+
+
+{
+  // destroy with AbortSignal


Suggested change

// destroy with AbortSignal

// Destroy with AbortSignal

targos · 2020-11-09T11:35:17Z

doc/api/http.md

@@ -2596,6 +2601,10 @@ events will be emitted in the following order:
 Setting the `timeout` option or using the `setTimeout()` function will
 not abort the request or do anything besides add a `'timeout'` event.

+Passing an `AbortSignal` and then calling `abort` on the corresponding
+`AbortConttoller` will behave the same way as calling `.destroy()` on the


Suggested change

`AbortConttoller` will behave the same way as calling `.destroy()` on the

`AbortController` will behave the same way as calling `.destroy()` on the

targos · 2020-11-09T11:36:54Z

lib/_http_client.js

@@ -169,6 +172,14 @@ function ClientRequest(input, options, cb) {
  if (options.timeout !== undefined)
    this.timeout = getTimerDuration(options.timeout, 'timeout');

+  if (options.signal) {


Should we extract the value in a variable to be safe? Options could be changed later or the property could be a getter that throws afterwards

mcollina · 2020-11-09T16:47:21Z

lib/_http_client.js

+  const signal = options.signal;
+  if (signal) {
+    validateAbortSignal(signal, 'options.signal');
+    const listener = (e) => this.destroy();


I would call .destroy() with an error.

I... think you're right. If cancellation is abnormal elsewhere it should likely be abnormal termination here and abort with an AbortError with a .code

I... think I changed my mind again. Lol, I think calling .destroy without an error is probably right and the error the user is getting should probably be ECONNRESET and not an AbortError anyway.

I'd rather users get consistent errors on request aborts than always getting AbortErrors consistent errors when using AbortController.

I'm really not sure here tbh.

I don't think it will ECONNRESET if aborted before a socket is assigned.

@ronag it does (there is a test for it)

cc @jasnell

ronag

This is a bit weird to me... if we are going to do this isn't it better to just add signal support generically to streams?

I don't really see the point of this since streams have .destroy().

benjamingr · 2020-11-09T19:56:55Z

if we are going to do this isn't it better to just add signal support generically to streams?

@ronag even if http.request returns a stream and we make those cancelable with signals, it should still take a signal as a parameter for ownership.

If we make stream.Readable cancellable with signals through a AbortSignal known symbol property or constructor parameter that would be useful but not help in this case since the stream isn't constructed by the user - it's just returned to the caller.

Allowing users to destroy an http.request (and other streams) by passing in a signal is very useful ergonomics wise. It's the same way users cancel other things (like timers) and the standard web platform cancellation mechanism.

ronag · 2020-11-09T20:07:19Z

Allowing users to destroy an http.request (and other streams) by passing in a signal is very useful ergonomics wise. It's the same way users cancel other things (like timers) and the standard web platform cancellation mechanism.

I don't quite see if but don't have a strong opinion. However, I do think if we do this we should do it on the streams level.

benjamingr · 2020-11-09T20:52:59Z

I will follow up with a PR for readable

Edit: very much wip @ronag https://github.com/nodejs/node/compare/master...benjamingr:abort-signal-stream?expand=1 will make a PR sometime this week hopefully

nodejs-github-bot · 2020-11-09T21:32:10Z

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

ronag · 2020-11-09T22:02:38Z

Why not have this PR also destroy with lazyDOMException('The operation was aborted', 'AbortError')?

benjamingr · 2020-11-09T23:10:38Z

@ronag I think users would probably expect an ECONNRESET - no?

nodejs-github-bot · 2020-11-10T07:29:53Z

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

ronag · 2020-11-11T11:50:51Z

@ronag I think users would probably expect an ECONNRESET - no?

Not necessarily. What about the case when aborting before 'socket'? I would not expect a ECONNRESET then.

I don't have a strong opinion.

benjamingr · 2020-11-11T12:44:39Z

@ronag the test here aborts synchronously, that is before socket iiuc.

Note I am not sure what's the right thing either - and also in http2, I don't understand the implications of why aborting with an error here would matter so if there is a good reason to .destroy with an error here (and in HTTP2) please let me know :]

My involvement in the project and willingness to do the work does not excuse my ignorance in this case. So if I'm missing something please let me know.

(The more general AbortSignal for Readable will .destroy with an error)

lib/internal/errors.js

nodejs-github-bot · 2020-11-19T11:24:53Z

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

nodejs-github-bot · 2020-11-19T11:58:57Z

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

nodejs-github-bot · 2020-11-19T13:09:00Z

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

github-actions · 2020-11-19T14:32:47Z

Landed in a46b21f...2097ffd

PR-URL: #36048 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Ricky Zhou <0x19951125@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

- Builds on nodejs#36048 and nodejs#36084 - Modify test to verify this fact

PR-URL: #36048 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Ricky Zhou <0x19951125@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Notable changes: dns: * (SEMVER-MINOR) add a cancel() method to the promise Resolver (Szymon Marczak) #33099 events: * (SEMVER-MINOR) add max listener warning for EventTarget (James M Snell) #36001 http: * (SEMVER-MINOR) add support for abortsignal to http.request (Benjamin Gruenbaum) #36048 http2: * (SEMVER-MINOR) allow setting the local window size of a session (Yongsheng Zhang) #35978 lib: * (SEMVER-MINOR) add throws option to fs.f/l/statSync (Andrew Casey) #33716 path: * (SEMVER-MINOR) add `path/posix` and `path/win32` alias modules (ExE Boss) #34962 readline: * (SEMVER-MINOR) add getPrompt to get the current prompt (Mattias Runge-Broberg) #33675 src: * (SEMVER-MINOR) add loop idle time in diagnostic report (Gireesh Punathil) #35940 util: * (SEMVER-MINOR) add `util/types` alias module (ExE Boss) #34055 PR-URL: TODO

Notable changes: dns: * (SEMVER-MINOR) add a cancel() method to the promise Resolver (Szymon Marczak) #33099 events: * (SEMVER-MINOR) add max listener warning for EventTarget (James M Snell) #36001 http: * (SEMVER-MINOR) add support for abortsignal to http.request (Benjamin Gruenbaum) #36048 http2: * (SEMVER-MINOR) allow setting the local window size of a session (Yongsheng Zhang) #35978 lib: * (SEMVER-MINOR) add throws option to fs.f/l/statSync (Andrew Casey) #33716 path: * (SEMVER-MINOR) add `path/posix` and `path/win32` alias modules (ExE Boss) #34962 readline: * (SEMVER-MINOR) add getPrompt to get the current prompt (Mattias Runge-Broberg) #33675 src: * (SEMVER-MINOR) add loop idle time in diagnostic report (Gireesh Punathil) #35940 util: * (SEMVER-MINOR) add `util/types` alias module (ExE Boss) #34055 PR-URL: #36232

PR-URL: nodejs#36048 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Ricky Zhou <0x19951125@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

PR-URL: #36048 Backport-PR-URL: #38386 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Ricky Zhou <0x19951125@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

nodejs-github-bot added the http Issues or PRs related to the http subsystem. label Nov 9, 2020

benjamingr requested a review from ronag November 9, 2020 10:53

benjamingr changed the title ~~add support for abortsignal to http.request~~ http: add support for abortsignal to http.request Nov 9, 2020

benjamingr force-pushed the add-abortsignal-http-request branch from aa6a902 to bb957b5 Compare November 9, 2020 10:54

addaleax approved these changes Nov 9, 2020

View reviewed changes

lundibundi approved these changes Nov 9, 2020

View reviewed changes

rickyes approved these changes Nov 9, 2020

View reviewed changes

benjamingr force-pushed the add-abortsignal-http-request branch from bb957b5 to 728d4ad Compare November 9, 2020 11:28

targos reviewed Nov 9, 2020

View reviewed changes

benjamingr force-pushed the add-abortsignal-http-request branch from 728d4ad to 89c38be Compare November 9, 2020 11:39

benjamingr added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

Trott approved these changes Nov 9, 2020

View reviewed changes

benjamingr added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

mcollina reviewed Nov 9, 2020

View reviewed changes

ronag reviewed Nov 9, 2020

View reviewed changes

benjamingr added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 9, 2020

MadaraUchiha mentioned this pull request Nov 10, 2020

http2: add support for AbortSignal to http2Session.request #36070

Closed

4 tasks

ronag reviewed Nov 19, 2020

View reviewed changes

lib/internal/errors.js Show resolved Hide resolved

benjamingr removed the blocked PRs that are blocked by other issues or PRs. label Nov 19, 2020

benjamingr added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 19, 2020

github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 19, 2020

github-actions bot closed this Nov 19, 2020

MadaraUchiha added a commit to MadaraUchiha/node that referenced this pull request Nov 21, 2020

http2: Abort calls destroy with an AbortError

dc99724

- Builds on nodejs#36048 and nodejs#36084 - Modify test to verify this fact

codebytere mentioned this pull request Nov 22, 2020

v15.3.0 proposal #36232

Merged

targos added the backport-open-v14.x label Apr 24, 2021

targos mentioned this pull request Apr 24, 2021

[v14.x] Backport AbortController and friends #38386

Closed

targos added backported-to-v14.x and removed backport-open-v14.x labels Apr 30, 2021

danielleadams mentioned this pull request May 3, 2021

v14.17.0 proposal #38507

Merged

aicanfly mentioned this pull request May 25, 2021

Error: socket hang up with 15.7.0 or newer #37510

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http: add support for abortsignal to http.request #36048

http: add support for abortsignal to http.request #36048

benjamingr commented Nov 9, 2020

nodejs-github-bot commented Nov 9, 2020

addaleax Nov 9, 2020

lundibundi Nov 9, 2020

lundibundi Nov 9, 2020

benjamingr Nov 9, 2020

rickyes Nov 9, 2020

rickyes Nov 9, 2020

targos Nov 9, 2020

targos Nov 9, 2020

mcollina Nov 9, 2020

benjamingr Nov 9, 2020

benjamingr Nov 9, 2020

mcollina Nov 9, 2020

ronag Nov 9, 2020

benjamingr Nov 11, 2020

benjamingr Nov 11, 2020

ronag left a comment •

edited

Loading

benjamingr commented Nov 9, 2020

ronag commented Nov 9, 2020

benjamingr commented Nov 9, 2020 •

edited

Loading

nodejs-github-bot commented Nov 9, 2020

ronag commented Nov 9, 2020

benjamingr commented Nov 9, 2020

nodejs-github-bot commented Nov 10, 2020

ronag commented Nov 11, 2020

benjamingr commented Nov 11, 2020

nodejs-github-bot commented Nov 19, 2020

nodejs-github-bot commented Nov 19, 2020

nodejs-github-bot commented Nov 19, 2020

github-actions bot commented Nov 19, 2020

		const server = http.createServer(common.mustNotCall((req, res) => {
		}));

	Passing an `AbortSignal` and then calling `abort` on the corrosponding
	Passing an `AbortSignal` and then calling `abort` on the corresponding

	pr-url: https://github.com/nodejs/node/pull/319999
	pr-url: https://github.com/nodejs/node/pull/36048

	`AbortConttoller` will behave the same way as calling `.destroy()` on the
	`AbortController` will behave the same way as calling `.destroy()` on the

http: add support for abortsignal to http.request #36048

http: add support for abortsignal to http.request #36048

Conversation

benjamingr commented Nov 9, 2020

Checklist

nodejs-github-bot commented Nov 9, 2020

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

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

ronag left a comment • edited Loading

Choose a reason for hiding this comment

benjamingr commented Nov 9, 2020

ronag commented Nov 9, 2020

benjamingr commented Nov 9, 2020 • edited Loading

nodejs-github-bot commented Nov 9, 2020

ronag commented Nov 9, 2020

benjamingr commented Nov 9, 2020

nodejs-github-bot commented Nov 10, 2020

ronag commented Nov 11, 2020

benjamingr commented Nov 11, 2020

nodejs-github-bot commented Nov 19, 2020

nodejs-github-bot commented Nov 19, 2020

nodejs-github-bot commented Nov 19, 2020

github-actions bot commented Nov 19, 2020

ronag left a comment •

edited

Loading

benjamingr commented Nov 9, 2020 •

edited

Loading