Skip to content
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

fix: correct support for AbortSignal:timeout() #2388

Merged
merged 2 commits into from
Nov 4, 2024
Merged

fix: correct support for AbortSignal:timeout() #2388

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec31144
fix: correct support for AbortSignal:timeout()
katsanva Nov 2, 2024
0f49611
chore: use const for TimeoutError code in tests
katsanva Nov 3, 2024
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
Next Next commit
fix: correct support for AbortSignal:timeout()
  • Loading branch information
@katsanva
katsanva committed Nov 2, 2024
commit ec311440b0c5d25b978aa49a9622e52a1dcfafe8
7 changes: 6 additions & 1 deletion source/core/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,12 @@ export default class Request extends Duplex implements RequestEvents<Request> {

if (this.options.signal) {
const abort = () => {
this.destroy(new AbortError(this));
// See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout_static#return_value
if (this.options.signal?.reason?.name === 'TimeoutError') {
this.destroy(new TimeoutError(this.options.signal.reason, this.timings!, this));
} else {
this.destroy(new AbortError(this));
}
};

if (this.options.signal.aborted) {
Expand Down
51 changes: 51 additions & 0 deletions test/abort.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,3 +324,54 @@ test('support setting the signal as a default option', async t => {

t.true(signalHandlersRemoved(), 'Abort signal event handlers not removed');
});

// See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout_static
test('support AbortSignal.timeout()', async t => {
const signal = AbortSignal.timeout(1);

const p = got('http://example.com', {signal});

await t.throwsAsync(p, {
code: 23,
katsanva marked this conversation as resolved.
Show resolved Hide resolved
message: 'The operation was aborted due to timeout',
});
});

test('support AbortSignal.timeout() without user abort', async t => {
const {controller, signalHandlersRemoved} = createAbortController();
const timeoutSignal = AbortSignal.timeout(1);
const signal = AbortSignal.any([
controller.signal,
timeoutSignal,
]);
const p = got('http://example.com', {signal});

await t.throwsAsync(p, {
code: 23,
message: 'The operation was aborted due to timeout',
});

t.true(signalHandlersRemoved(), 'Abort signal event handlers not removed');
});

test('support AbortSignal.timeout() with user abort', async t => {
const {controller, signalHandlersRemoved} = createAbortController();
const timeoutSignal = AbortSignal.timeout(1000);
const signal = AbortSignal.any([
controller.signal,
timeoutSignal,
]);

setTimeout(() => {
controller.abort();
}, 10);

const p = got('http://example.com', {signal});

await t.throwsAsync(p, {
code: 'ERR_ABORTED',
message: 'This operation was aborted.',
});

t.true(signalHandlersRemoved(), 'Abort signal event handlers not removed');
});