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.

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

lib: add brand checks to AbortController and AbortSignal #37720

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
32 changes: 29 additions & 3 deletions lib/internal/abort_controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ const {
customInspectSymbol,
} = require('internal/util');
const { inspect } = require('internal/util/inspect');
const {
codes: {
ERR_INVALID_THIS,
}
} = require('internal/errors');

const kAborted = Symbol('kAborted');

Expand All @@ -37,13 +42,21 @@ function customInspect(self, obj, depth, options) {
return `${self.constructor.name} ${inspect(obj, opts)}`;
}

function validateAbortSignal(obj) {
if (obj?.[kAborted] === undefined)
throw new ERR_INVALID_THIS('AbortSignal');
}

class AbortSignal extends EventTarget {
constructor() {
// eslint-disable-next-line no-restricted-syntax
throw new TypeError('Illegal constructor');
}

get aborted() { return !!this[kAborted]; }
get aborted() {
validateAbortSignal(this);
return !!this[kAborted];
}

[customInspectSymbol](depth, options) {
return customInspect(this, {
Expand Down Expand Up @@ -89,13 +102,26 @@ function abortSignal(signal) {
// initializers for now:
// https://bugs.chromium.org/p/v8/issues/detail?id=10704
const kSignal = Symbol('signal');

function validateAbortController(obj) {
if (obj?.[kSignal] === undefined)
throw new ERR_INVALID_THIS('AbortController');
}

class AbortController {
constructor() {
this[kSignal] = createAbortSignal();
}

get signal() { return this[kSignal]; }
abort() { abortSignal(this[kSignal]); }
get signal() {
validateAbortController(this);
return this[kSignal];
}

abort() {
validateAbortController(this);
abortSignal(this[kSignal]);
}

[customInspectSymbol](depth, options) {
return customInspect(this, {
Expand Down
58 changes: 58 additions & 0 deletions test/parallel/test-abortcontroller.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,61 @@ const { ok, strictEqual, throws } = require('assert');
const signal = AbortSignal.abort();
ok(signal.aborted);
}

{
// Test that AbortController properties and methods validate the receiver
const acSignalGet = Object.getOwnPropertyDescriptor(
AbortController.prototype,
'signal'
).get;
const acAbort = AbortController.prototype.abort;

const goodController = new AbortController();
ok(acSignalGet.call(goodController));
acAbort.call(goodController);

const badAbortControllers = [
null,
0,
NaN,
true,
'AbortController',
Object.create(AbortController.prototype)
];
for (const badController of badAbortControllers) {
throws(
() => acSignalGet.call(badController),
{ code: 'ERR_INVALID_THIS', name: 'TypeError' }
);
throws(
() => acAbort.call(badController),
{ code: 'ERR_INVALID_THIS', name: 'TypeError' }
);
}
}

{
// Test that AbortSignal properties validate the receiver
const signalAbortedGet = Object.getOwnPropertyDescriptor(
AbortSignal.prototype,
'aborted'
).get;

const goodSignal = new AbortController().signal;
strictEqual(signalAbortedGet.call(goodSignal), false);

const badAbortSignals = [
null,
0,
NaN,
true,
'AbortSignal',
Object.create(AbortSignal.prototype)
];
for (const badSignal of badAbortSignals) {
throws(
() => signalAbortedGet.call(badSignal),
{ code: 'ERR_INVALID_THIS', name: 'TypeError' }
);
}
}