Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MadaraUchiha wants to merge 9 commits into from
Closed

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ba7f38b
http2: add support for AbortSignal to http2Session.request
MadaraUchiha Nov 10, 2020
aec2c2b
http2: Document AbortSignalSupport
MadaraUchiha Nov 10, 2020
a88f87b
http2: Fix lint errors
MadaraUchiha Nov 10, 2020
90ab360
http2: Remove redundant empty line in docs
MadaraUchiha Nov 10, 2020
2cd337e
http2: Use existing signal constant
MadaraUchiha Nov 10, 2020
05f68a2
http2: Goodify test
MadaraUchiha Nov 10, 2020
dc99724
http2: Abort calls destroy with an AbortError
MadaraUchiha Nov 19, 2020
3d5177d
http2: Update documentation
MadaraUchiha Nov 19, 2020
9aca7c4
http2: Abort immediately if passed an already aborted signal
MadaraUchiha Nov 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
http2: Abort immediately if passed an already aborted signal 
- Also add test to that effect
  • Loading branch information
@MadaraUchiha
MadaraUchiha committed Nov 21, 2020
commit 9aca7c4e0f764cf6405868acbc8be9fd6d6cdd1a
14 changes: 9 additions & 5 deletions lib/internal/http2/core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1726,11 +1726,15 @@ class ClientHttp2Session extends Http2Session {
const { signal } = options;
if (signal) {
Copy link
Copy Markdown
Member

@mcollina mcollina Nov 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if this is aborted already?

Copy link
Copy Markdown
Contributor Author

@MadaraUchiha MadaraUchiha Nov 19, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's an excellent question.

Looking at the DOM implementation, it appears like the expected behavior is to abort immediately. I shall add this (and a test) after my 🍕 :D

Copy link
Copy Markdown
Member

@mcollina mcollina Nov 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it would need to abort immediately.

Copy link
Copy Markdown
Contributor Author

@MadaraUchiha MadaraUchiha Nov 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mcollina Done, PTALA.

Also @benjamingr this is likely something we'd want to do in http_client as well.

validateAbortSignal(signal, 'options.signal');
const listener = () => stream.destroy(new AbortError());
signal.addEventListener('abort', listener);
stream.once('close', () => {
signal.removeEventListener('abort', listener);
});
const aborter = () => stream.destroy(new AbortError());
if (signal.aborted) {
aborter();
} else {
signal.addEventListener('abort', aborter);
stream.once('close', () => {
signal.removeEventListener('abort', aborter);
});
}
}

const onConnect = FunctionPrototypeBind(requestOnConnect,
Expand Down
35 changes: 35 additions & 0 deletions test/parallel/test-http2-client-destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,3 +206,38 @@ const Countdown = require('../common/countdown');
assert.strictEqual(req.destroyed, true);
}));
}
// Pass an already destroyed signal to abort immediately.
{
const server = h2.createServer();
const controller = new AbortController();

server.on('stream', common.mustNotCall());
server.listen(0, common.mustCall(() => {
const client = h2.connect(`http://localhost:${server.address().port}`);
client.on('close', common.mustCall());

const { signal } = controller;
controller.abort();

assert.strictEqual(signal[kEvents].get('abort'), undefined);

client.on('error', common.mustCall(() => {
// After underlying stream dies, signal listener detached
assert.strictEqual(signal[kEvents].get('abort'), undefined);
}));

const req = client.request({}, { signal });
// Signal already aborted, so no event listener attached.
assert.strictEqual(signal[kEvents].get('abort'), undefined);

assert.strictEqual(req.aborted, false);
// Destroyed on same tick as request made
assert.strictEqual(req.destroyed, true);

req.on('error', common.mustCall((err) => {
assert.strictEqual(err.code, 'ABORT_ERR');
assert.strictEqual(err.name, 'AbortError');
}));
req.on('close', common.mustCall(() => server.close()));
}));
}