Skip to content

Commit

Permalink
lib: fix fs.readdir recursive async
Browse files Browse the repository at this point in the history
Fixes: #56006
  • Loading branch information
RafaelGSS committed Nov 27, 2024
1 parent b17a1fb commit 982a50e
Show file tree
Hide file tree
Showing 2 changed files with 126 additions and 39 deletions.
160 changes: 121 additions & 39 deletions lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -1369,6 +1369,109 @@ function mkdirSync(path, options) {
}
}

/*
* An recurssive algorithm for reading the entire contents of the `basePath` directory.
* This function does not validate `basePath` as a directory. It is passed directly to
* `binding.readdir`.
* @param {string} basePath
* @param {{ encoding: string, withFileTypes: boolean }} options
* @param {(
* err?: Error,
* files?: string[] | Buffer[] | Dirent[]
* ) => any} callback
* @returns {void}
*/
function readdirRecursive(basePath, options, callback) {
const context = {
withFileTypes: Boolean(options.withFileTypes),
encoding: options.encoding,
basePath,
readdirResults: [],
pathsQueue: [basePath],
};

let i = 0;

function read(path) {
const req = new FSReqCallback();
req.oncomplete = (err, result) => {
if (err) {
callback(err);
return;
}

if (result === undefined) {
callback(null, context.readdirResults);
return;
}

processReaddirResult({
result,
currentPath: path,
context,
});

if (i < context.pathsQueue.length) {
read(context.pathsQueue[i++]);
} else {
callback(null, context.readdirResults);
}
};

binding.readdir(
path,
context.encoding,
context.withFileTypes,
req,
);
}

read(context.pathsQueue[i++]);
}

function processReaddirResult({ result, currentPath, context }) {
// Calling `readdir` with `withFileTypes=true`, the result is an array of arrays.
// The first array is the names, and the second array is the types.
// They are guaranteed to be the same length; hence, setting `length` to the length
// of the first array within the result.
if (context.withFileTypes) {
handleDirents({ result, currentPath, context });
} else {
handleFilePaths({ result, currentPath, context });
}
}

function handleDirents({ result, currentPath, context }) {
const { 0: names, 1: types } = result;
const length = names.length;

for (let i = 0; i < length; i++) {
// Avoid excluding symlinks, as they are not directories.
// Refs: https://github.com/nodejs/node/issues/52663
const fullPath = pathModule.join(currentPath, names[i]);
const stat = binding.internalModuleStat(binding, fullPath);
const dirent = getDirent(currentPath, names[i], types[i]);
ArrayPrototypePush(context.readdirResults, dirent);

if (dirent.isDirectory() || stat === 1) {
ArrayPrototypePush(context.pathsQueue, fullPath);
}
}
}

function handleFilePaths({ result, currentPath, context }) {
for (let i = 0; i < result.length; i++) {
const resultPath = pathModule.join(currentPath, result[i]);
const relativeResultPath = pathModule.relative(context.basePath, resultPath);
const stat = binding.internalModuleStat(binding, resultPath);
ArrayPrototypePush(context.readdirResults, relativeResultPath);

if (stat === 1) {
ArrayPrototypePush(context.pathsQueue, resultPath);
}
}
}

/**
* An iterative algorithm for reading the entire contents of the `basePath` directory.
* This function does not validate `basePath` as a directory. It is passed directly to
Expand All @@ -1378,58 +1481,37 @@ function mkdirSync(path, options) {
* @returns {string[] | Dirent[]}
*/
function readdirSyncRecursive(basePath, options) {
const withFileTypes = Boolean(options.withFileTypes);
const encoding = options.encoding;

const readdirResults = [];
const pathsQueue = [basePath];
const context = {
withFileTypes: Boolean(options.withFileTypes),
encoding: options.encoding,
basePath,
readdirResults: [],
pathsQueue: [basePath],
};

function read(path) {
const readdirResult = binding.readdir(
path,
encoding,
withFileTypes,
context.encoding,
context.withFileTypes,
);

if (readdirResult === undefined) {
return;
}

if (withFileTypes) {
// Calling `readdir` with `withFileTypes=true`, the result is an array of arrays.
// The first array is the names, and the second array is the types.
// They are guaranteed to be the same length; hence, setting `length` to the length
// of the first array within the result.
const length = readdirResult[0].length;
for (let i = 0; i < length; i++) {
// Avoid excluding symlinks, as they are not directories.
// Refs: https://github.com/nodejs/node/issues/52663
const stat = binding.internalModuleStat(binding, pathModule.join(path, readdirResult[0][i]));
const dirent = getDirent(path, readdirResult[0][i], readdirResult[1][i]);
ArrayPrototypePush(readdirResults, dirent);
if (dirent.isDirectory() || stat === 1) {
ArrayPrototypePush(pathsQueue, pathModule.join(dirent.parentPath, dirent.name));
}
}
} else {
for (let i = 0; i < readdirResult.length; i++) {
const resultPath = pathModule.join(path, readdirResult[i]);
const relativeResultPath = pathModule.relative(basePath, resultPath);
const stat = binding.internalModuleStat(binding, resultPath);
ArrayPrototypePush(readdirResults, relativeResultPath);
// 1 indicates directory
if (stat === 1) {
ArrayPrototypePush(pathsQueue, resultPath);
}
}
}
processReaddirResult({
result: readdirResult,
currentPath: path,
context,
});
}

for (let i = 0; i < pathsQueue.length; i++) {
read(pathsQueue[i]);
for (let i = 0; i < context.pathsQueue.length; i++) {
read(context.pathsQueue[i]);
}

return readdirResults;
return context.readdirResults;
}

/**
Expand All @@ -1455,7 +1537,7 @@ function readdir(path, options, callback) {
}

if (options.recursive) {
callback(null, readdirSyncRecursive(path, options));
readdirRecursive(path, options, callback);
return;
}

Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/permission/fs-read.js
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,11 @@ const regularFile = __filename;
permission: 'FileSystemRead',
resource: path.toNamespacedPath(blockedFolder),
}));
fs.readdir(blockedFolder, { recursive: true }, common.expectsError({
code: 'ERR_ACCESS_DENIED',
permission: 'FileSystemRead',
resource: path.toNamespacedPath(blockedFolder),
}));
assert.throws(() => {
fs.readdirSync(blockedFolder);
}, common.expectsError({
Expand Down

0 comments on commit 982a50e

Please sign in to comment.