Skip to content

Commit 6673eba

Browse files
mertcanaltinaduh95
mertcanaltin
authored and
aduh95
committed
fs: abort in-flight stat operations
Signed-off-by: Mert Can Altin <[email protected]> PR-URL: #63143 Refs: #57775 Reviewed-By: Chemi Atlow <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 74234ee commit 6673eba

4 files changed

Lines changed: 200 additions & 34 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1542,6 +1542,10 @@ link(2) documentation for more detail.
15421542
<!-- YAML
15431543
added: v10.0.0
15441544
changes:
1545+
- version: REPLACEME
1546+
pr-url: https://github.com/nodejs/node/pull/63143
1547+
description: Accepts an additional `signal` option to allow aborting the
1548+
operation.
15451549
- version: v10.5.0
15461550
pr-url: https://github.com/nodejs/node/pull/20220
15471551
description: Accepts an additional `options` object to specify whether
@@ -1552,6 +1556,8 @@ changes:
15521556
* `options` {Object}
15531557
* `bigint` {boolean} Whether the numeric values in the returned
15541558
{fs.Stats} object should be `bigint`. **Default:** `false`.
1559+
* `signal` {AbortSignal} An AbortSignal to cancel the operation.
1560+
**Default:** `undefined`.
15551561
* Returns: {Promise} Fulfills with the {fs.Stats} object for the given
15561562
symbolic link `path`.
15571563
@@ -2080,6 +2086,10 @@ Removes files and directories (modeled on the standard POSIX `rm` utility).
20802086
<!-- YAML
20812087
added: v10.0.0
20822088
changes:
2089+
- version: REPLACEME
2090+
pr-url: https://github.com/nodejs/node/pull/63143
2091+
description: Accepts an additional `signal` option to allow aborting the
2092+
operation.
20832093
- version: v25.7.0
20842094
pr-url: https://github.com/nodejs/node/pull/61178
20852095
description: Accepts a `throwIfNoEntry` option to specify whether
@@ -2097,6 +2107,8 @@ changes:
20972107
* `throwIfNoEntry` {boolean} Whether an exception will be thrown
20982108
if no file system entry exists, rather than returning `undefined`.
20992109
**Default:** `true`.
2110+
* `signal` {AbortSignal} An AbortSignal to cancel the operation.
2111+
**Default:** `undefined`.
21002112
* Returns: {Promise} Fulfills with the {fs.Stats} object for the
21012113
given `path`.
21022114
@@ -3437,6 +3449,10 @@ exception are given to the completion callback.
34373449
<!-- YAML
34383450
added: v0.1.95
34393451
changes:
3452+
- version: REPLACEME
3453+
pr-url: https://github.com/nodejs/node/pull/63143
3454+
description: Accepts an additional `signal` option to allow aborting the
3455+
operation.
34403456
- version: v18.0.0
34413457
pr-url: https://github.com/nodejs/node/pull/41678
34423458
description: Passing an invalid callback to the `callback` argument
@@ -3460,6 +3476,8 @@ changes:
34603476
* `options` {Object}
34613477
* `bigint` {boolean} Whether the numeric values in the returned
34623478
{fs.Stats} object should be `bigint`. **Default:** `false`.
3479+
* `signal` {AbortSignal} An AbortSignal to cancel the operation.
3480+
**Default:** `undefined`.
34633481
* `callback` {Function}
34643482
* `err` {Error}
34653483
* `stats` {fs.Stats}
@@ -3802,6 +3820,10 @@ exception are given to the completion callback.
38023820
<!-- YAML
38033821
added: v0.1.30
38043822
changes:
3823+
- version: REPLACEME
3824+
pr-url: https://github.com/nodejs/node/pull/63143
3825+
description: Accepts an additional `signal` option to allow aborting the
3826+
operation.
38053827
- version: v18.0.0
38063828
pr-url: https://github.com/nodejs/node/pull/41678
38073829
description: Passing an invalid callback to the `callback` argument
@@ -3829,6 +3851,8 @@ changes:
38293851
* `options` {Object}
38303852
* `bigint` {boolean} Whether the numeric values in the returned
38313853
{fs.Stats} object should be `bigint`. **Default:** `false`.
3854+
* `signal` {AbortSignal} An AbortSignal to cancel the operation.
3855+
**Default:** `undefined`.
38323856
* `callback` {Function}
38333857
* `err` {Error}
38343858
* `stats` {fs.Stats}

‎lib/fs.js‎

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ const {
139139
const {
140140
isInt32,
141141
parseFileMode,
142+
validateAbortSignal,
142143
validateBoolean,
143144
validateBuffer,
144145
validateEncoding,
@@ -383,6 +384,25 @@ function checkAborted(signal, callback) {
383384
return false;
384385
}
385386

387+
function bindSignalToReq(req, signal, callback) {
388+
if (!signal) {
389+
req.oncomplete = callback;
390+
return;
391+
}
392+
let aborted = false;
393+
const onAbort = () => {
394+
aborted = true;
395+
callback(new AbortError(undefined, { cause: signal.reason }));
396+
};
397+
kResistStopPropagation ??= require('internal/event_target').kResistStopPropagation;
398+
signal.addEventListener('abort', onAbort, { __proto__: null, [kResistStopPropagation]: true });
399+
req.oncomplete = function(err, result) {
400+
signal.removeEventListener('abort', onAbort);
401+
if (aborted) return;
402+
callback(err, result);
403+
};
404+
}
405+
386406
/**
387407
* Asynchronously reads the entire contents of a file.
388408
* @param {string | Buffer | URL | number} path
@@ -1954,7 +1974,7 @@ function readdirSync(path, options) {
19541974
* Invokes the callback with the `fs.Stats`
19551975
* for the file descriptor.
19561976
* @param {number} fd
1957-
* @param {{ bigint?: boolean; }} [options]
1977+
* @param {{ bigint?: boolean, signal?: AbortSignal }} [options]
19581978
* @param {(
19591979
* err?: Error,
19601980
* stats?: Stats
@@ -1965,23 +1985,28 @@ function fstat(fd, options = { __proto__: null, bigint: false }, callback) {
19651985
if (typeof options === 'function') {
19661986
callback = options;
19671987
options = kEmptyObject;
1988+
} else if (options === null || typeof options !== 'object') {
1989+
options = kEmptyObject;
19681990
}
19691991

19701992
const h = vfsState.handlers;
19711993
if (h !== null && vfsResult(h.fstat(fd, options), callback)) return;
19721994

19731995
callback = makeStatsCallback(callback);
19741996

1997+
if (options.signal !== undefined) validateAbortSignal(options.signal, 'options.signal');
1998+
if (checkAborted(options.signal, callback)) return;
1999+
19752000
const req = new FSReqCallback(options.bigint);
1976-
req.oncomplete = callback;
2001+
bindSignalToReq(req, options.signal, callback);
19772002
binding.fstat(fd, options.bigint, req);
19782003
}
19792004

19802005
/**
19812006
* Retrieves the `fs.Stats` for the symbolic link
19822007
* referred to by the `path`.
19832008
* @param {string | Buffer | URL} path
1984-
* @param {{ bigint?: boolean; }} [options]
2009+
* @param {{ bigint?: boolean, signal?: AbortSignal }} [options]
19852010
* @param {(
19862011
* err?: Error,
19872012
* stats?: Stats
@@ -1992,6 +2017,10 @@ function lstat(path, options = { __proto__: null, bigint: false }, callback) {
19922017
if (typeof options === 'function') {
19932018
callback = options;
19942019
options = kEmptyObject;
2020+
} else if (options === null || typeof options !== 'object') {
2021+
options = kEmptyObject;
2022+
} else {
2023+
options = getOptions(options, { bigint: false });
19952024
}
19962025

19972026
const h = vfsState.handlers;
@@ -2005,8 +2034,11 @@ function lstat(path, options = { __proto__: null, bigint: false }, callback) {
20052034
return;
20062035
}
20072036

2037+
if (options.signal !== undefined) validateAbortSignal(options.signal, 'options.signal');
2038+
if (checkAborted(options.signal, callback)) return;
2039+
20082040
const req = new FSReqCallback(options.bigint);
2009-
req.oncomplete = callback;
2041+
bindSignalToReq(req, options.signal, callback);
20102042
binding.lstat(path, options.bigint, req);
20112043
}
20122044

@@ -2036,11 +2068,12 @@ function stat(path, options = { __proto__: null, bigint: false, throwIfNoEntry:
20362068
callback = makeStatsCallback(callback);
20372069
path = getValidatedPath(path);
20382070

2071+
if (options.signal !== undefined) validateAbortSignal(options.signal, 'options.signal');
20392072
if (checkAborted(options.signal, callback)) return;
20402073

20412074
const req = new FSReqCallback(options.bigint);
2042-
req.oncomplete = callback;
2043-
binding.stat(getValidatedPath(path), options.bigint, req, options.throwIfNoEntry);
2075+
bindSignalToReq(req, options.signal, callback);
2076+
binding.stat(path, options.bigint, req, options.throwIfNoEntry);
20442077
}
20452078

20462079
function statfs(path, options = { __proto__: null, bigint: false }, callback) {

‎lib/internal/fs/promises.js‎

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ const {
1212
PromisePrototypeThen,
1313
PromiseReject,
1414
PromiseResolve,
15+
PromiseWithResolvers,
1516
SafeArrayIterator,
1617
SafePromisePrototypeFinally,
18+
SafePromiseRace,
1719
Symbol,
1820
SymbolAsyncDispose,
1921
SymbolAsyncIterator,
@@ -1126,6 +1128,21 @@ function checkAborted(signal) {
11261128
throw new AbortError(undefined, { cause: signal.reason });
11271129
}
11281130

1131+
function rejectWithReason(signal, reject) {
1132+
return () => {
1133+
reject(new AbortError(undefined, { cause: signal.reason }));
1134+
};
1135+
}
1136+
1137+
async function raceWithSignal(opPromise, signal) {
1138+
if (!signal) return opPromise;
1139+
const { promise: abortPromise, reject } = PromiseWithResolvers();
1140+
// eslint-disable-next-line no-unused-vars
1141+
using _ = EventEmitter.addAbortListener(signal,
1142+
rejectWithReason(signal, reject));
1143+
return await SafePromiseRace([opPromise, abortPromise]);
1144+
}
1145+
11291146
async function writeFileHandle(filehandle, data, signal, encoding) {
11301147
checkAborted(signal);
11311148
if (isCustomIterable(data)) {
@@ -1779,15 +1796,26 @@ async function symlink(target, path, type) {
17791796
}
17801797

17811798
async function fstat(handle, options = { __proto__: null, bigint: false }) {
1782-
const result = await PromisePrototypeThen(
1783-
binding.fstat(handle.fd, options.bigint, kUsePromises),
1784-
undefined,
1785-
handleErrorFromBinding,
1799+
validateObject(options, 'options');
1800+
const { signal } = options;
1801+
if (signal !== undefined) validateAbortSignal(signal, 'options.signal');
1802+
checkAborted(signal);
1803+
const result = await raceWithSignal(
1804+
PromisePrototypeThen(
1805+
binding.fstat(handle.fd, options.bigint, kUsePromises),
1806+
undefined,
1807+
handleErrorFromBinding,
1808+
),
1809+
signal,
17861810
);
17871811
return getStatsFromBinding(result);
17881812
}
17891813

17901814
async function lstat(path, options = { __proto__: null, bigint: false }) {
1815+
validateObject(options, 'options');
1816+
const { signal } = options;
1817+
if (signal !== undefined) validateAbortSignal(signal, 'options.signal');
1818+
checkAborted(signal);
17911819
const h = vfsState.handlers;
17921820
if (h !== null) {
17931821
const promise = h.lstat(path, options);
@@ -1798,24 +1826,34 @@ async function lstat(path, options = { __proto__: null, bigint: false }) {
17981826
const resource = pathModule.toNamespacedPath(BufferIsBuffer(path) ? BufferToString(path) : path);
17991827
throw new ERR_ACCESS_DENIED('Access to this API has been restricted', 'FileSystemRead', resource);
18001828
}
1801-
const result = await PromisePrototypeThen(
1802-
binding.lstat(path, options.bigint, kUsePromises),
1803-
undefined,
1804-
handleErrorFromBinding,
1829+
const result = await raceWithSignal(
1830+
PromisePrototypeThen(
1831+
binding.lstat(path, options.bigint, kUsePromises),
1832+
undefined,
1833+
handleErrorFromBinding,
1834+
),
1835+
signal,
18051836
);
18061837
return getStatsFromBinding(result);
18071838
}
18081839

18091840
async function stat(path, options = { __proto__: null, bigint: false, throwIfNoEntry: true }) {
1841+
validateObject(options, 'options');
1842+
const { signal } = options;
1843+
if (signal !== undefined) validateAbortSignal(signal, 'options.signal');
1844+
checkAborted(signal);
18101845
const h = vfsState.handlers;
18111846
if (h !== null) {
18121847
const promise = h.stat(path, options);
18131848
if (promise !== undefined) return await promise;
18141849
}
1815-
const result = await PromisePrototypeThen(
1816-
binding.stat(getValidatedPath(path), options.bigint, kUsePromises, options.throwIfNoEntry),
1817-
undefined,
1818-
handleErrorFromBinding,
1850+
const result = await raceWithSignal(
1851+
PromisePrototypeThen(
1852+
binding.stat(getValidatedPath(path), options.bigint, kUsePromises, options.throwIfNoEntry),
1853+
undefined,
1854+
handleErrorFromBinding,
1855+
),
1856+
signal,
18191857
);
18201858

18211859
// Binding will resolve undefined if UV_ENOENT or UV_ENOTDIR and throwIfNoEntry is false

0 commit comments

Comments
 (0)