fs: stop stat()ing every entry in recursive readdir#65487

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

Merged
nodejs-github-bot merged 1 commit into from
Aug 25, 2026
+112 −150
Merged

fs: stop stat()ing every entry in recursive readdir #65487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions benchmark/fs/bench-readdir.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
n: [10],
dir: [ 'lib', 'test/parallel'],
withFileTypes: ['true', 'false'],
recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
withFileTypes = withFileTypes === 'true';
recursive = recursive === 'true';
const fullPath = path.resolve(__dirname, '../../', dir);
bench.start();
(function r(cntr) {
if (cntr-- <= 0)
return bench.end(n);
fs.readdir(fullPath, { withFileTypes }, () => {
fs.readdir(fullPath, { withFileTypes, recursive }, () => {
r(cntr);
});
}(n));
Expand Down
6 changes: 4 additions & 2 deletions benchmark/fs/bench-readdirSync.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
n: [10],
dir: [ 'lib', 'test/parallel'],
withFileTypes: ['true', 'false'],
recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
withFileTypes = withFileTypes === 'true';
recursive = recursive === 'true';
const fullPath = path.resolve(__dirname, '../../', dir);
bench.start();
for (let i = 0; i < n; i++) {
fs.readdirSync(fullPath, { withFileTypes });
fs.readdirSync(fullPath, { withFileTypes, recursive });
}
bench.end(n);
}
152 changes: 71 additions & 81 deletions lib/fs.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
F_OK,
O_WRONLY,
O_SYMLINK,
UV_DIRENT_DIR,
UV_DIRENT_LINK,
UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
}
}

/**
* Appends one directory's entries to `context.results` and the subdirectories
* still to visit to `context.dirs` (with the prefix their entries get in
* string results in `context.prefixes`). `result` is a `binding.readdir()`
* result with file types, so only symbolic links and entries of unknown type
* need a stat() to find out whether they lead to a directory.
* @param {string} dir
* @param {string} prefix
* @param {[string[], number[]]} result
* @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
*/
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
const { length } = names;
for (let i = 0; i < length; i++) {
const name = names[i];
const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
let isDirectory;
if (context.withFileTypes) {
const dirent = getDirent(dir, name, types[i]);
ArrayPrototypePush(context.results, dirent);
// Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
isDirectory = dirent.isDirectory() ||
(dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
} else {
ArrayPrototypePush(context.results, relative);
const type = types[i];
isDirectory = type === UV_DIRENT_DIR ||
((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
binding.internalModuleStat(pathModule.join(dir, name)) === 1);
}
if (isDirectory) {
ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
ArrayPrototypePush(context.prefixes, relative);
}
}
}

/*
* An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
const context = {
withFileTypes: Boolean(options.withFileTypes),
encoding: options.encoding,
basePath,
readdirResults: [],
pathsQueue: [basePath],
results: [],
dirs: [basePath],
prefixes: [''],
};

let i = 0;

function read(path) {
Comment thread
codebytere marked this conversation as resolved.
/**
* Reads one directory from `context.dirs` and then moves on to the next
* one, or calls back once none are left.
* @param {string} path
* @param {string} prefix path of this directory relative to `basePath`
*/
function read(path, prefix) {
const req = new FSReqCallback();
req.oncomplete = (err, result) => {
if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
}

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

processReaddirResult({
result,
currentPath: path,
context,
});
try {
collectRecursiveReaddirResult(path, prefix, result, context);
} catch (err) {
callback(err);
return;
}

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

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 dirent = getDirent(currentPath, names[i], types[i]);
ArrayPrototypePush(context.readdirResults, dirent);

if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
ArrayPrototypePush(context.pathsQueue, fullPath);
}
binding.readdir(path, options.encoding, true, req);
}
}

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(resultPath);
ArrayPrototypePush(context.readdirResults, relativeResultPath);

if (stat === 1) {
ArrayPrototypePush(context.pathsQueue, resultPath);
}
}
read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
const context = {
withFileTypes: Boolean(options.withFileTypes),
encoding: options.encoding,
basePath,
readdirResults: [],
pathsQueue: [basePath],
results: [],
dirs: [basePath],
prefixes: [''],
};

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

if (readdirResult === undefined) {
return;
for (let i = 0; i < context.dirs.length; i++) {
const dir = context.dirs[i];
const result = binding.readdir(dir, options.encoding, true);
if (result !== undefined) {
collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
}

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

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

return context.readdirResults;
return context.results;
}

/**
Expand Down
96 changes: 32 additions & 64 deletions lib/internal/fs/promises.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
O_WRONLY,
S_IFMT,
S_IFREG,
UV_DIRENT_DIR,
UV_DIRENT_LINK,
UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
kWriteFileMaxChunkSize,
},
copyObject,
getDirent,
getDirents,
getOptions,
getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
const withFileTypes = !!options.withFileTypes;
const readdirWithTypes = (path) => PromisePrototypeThen(
binding.readdir(path, options.encoding, true, kUsePromises),
undefined,
handleErrorFromBinding,
);
const result = [];
const queue = [
[
originalPath,
await PromisePrototypeThen(
binding.readdir(
originalPath,
options.encoding,
!!options.withFileTypes,
kUsePromises,
),
undefined,
handleErrorFromBinding,
),
],
];


if (options.withFileTypes) {
while (queue.length > 0) {
// If we want to implement BFS make this a `shift` call instead of `pop`
const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
for (const dirent of getDirents(path, readdir)) {
const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

while (queue.length > 0) {
// If we want to implement BFS make this a `shift` call instead of `pop`
const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
for (let i = 0; i < names.length; i++) {
const name = names[i];
const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
let isDirectory;
if (withFileTypes) {
const dirent = getDirent(path, name, types[i]);
ArrayPrototypePush(result, dirent);
if (dirent.isDirectory()) {
const direntPath = pathModule.join(path, dirent.name);
ArrayPrototypePush(queue, [
direntPath,
await PromisePrototypeThen(
binding.readdir(
direntPath,
options.encoding,
true,
kUsePromises,
),
undefined,
handleErrorFromBinding,
),
]);
}
isDirectory = dirent.isDirectory();
} else {
ArrayPrototypePush(result, relative);
// Entries that are, or may be, symbolic links to directories are followed.
const type = types[i];
isDirectory = type === UV_DIRENT_DIR ||
((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
binding.internalModuleStat(pathModule.join(path, name)) === 1);
}
}
} else {
while (queue.length > 0) {
const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
for (const ent of readdir) {
const direntPath = pathModule.join(path, ent);
const stat = binding.internalModuleStat(direntPath);
ArrayPrototypePush(
result,
pathModule.relative(originalPath, direntPath),
);
if (stat === 1) {
ArrayPrototypePush(queue, [
direntPath,
await PromisePrototypeThen(
binding.readdir(
direntPath,
options.encoding,
false,
kUsePromises,
),
undefined,
handleErrorFromBinding,
),
]);
}
if (isDirectory) {
const direntPath = pathModule.join(path, name);
ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion test/known_issues/test-fs-readdir-recursive-with-buffer.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fs: stop stat()ing every entry in recursive readdir#65487

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Aug 25, 2026

+112

−150

 Merged


fs: stop stat()ing every entry in recursive readdir
#65487
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdir.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,18 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});

function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 (function r(cntr) {
 if (cntr-- <= 0)
 return bench.end(n);
 fs.readdir(fullPath, { withFileTypes }, () => {
 fs.readdir(fullPath, { withFileTypes, recursive }, () => {
 r(cntr);
 });
 }(n));
Expand Down

6 changes: 4 additions & 2 deletions
benchmark/fs/bench-readdirSync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,15 +8,17 @@ const bench = common.createBenchmark(main, {
 n: [10],
 dir: [ 'lib', 'test/parallel'],
 withFileTypes: ['true', 'false'],
 recursive: ['true', 'false'],
});


function main({ n, dir, withFileTypes }) {
function main({ n, dir, withFileTypes, recursive }) {
 withFileTypes = withFileTypes === 'true';
 recursive = recursive === 'true';
 const fullPath = path.resolve(__dirname, '../../', dir);
 bench.start();
 for (let i = 0; i < n; i++) {
 fs.readdirSync(fullPath, { withFileTypes });
 fs.readdirSync(fullPath, { withFileTypes, recursive });
 }
 bench.end(n);
}

152 changes: 71 additions & 81 deletions
lib/fs.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ const {
 F_OK,
 O_WRONLY,
 O_SYMLINK,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const pathModule = require('path');
Expand DownExpand Up@@ -1720,6 +1723,43 @@ function mkdirSync(path, options) {
 }
}

/**
 * Appends one directory's entries to `context.results` and the subdirectories
 * still to visit to `context.dirs` (with the prefix their entries get in
 * string results in `context.prefixes`). `result` is a `binding.readdir()`
 * result with file types, so only symbolic links and entries of unknown type
 * need a stat() to find out whether they lead to a directory.
 * @param {string} dir
 * @param {string} prefix
 * @param {[string[], number[]]} result
 * @param {{ withFileTypes: boolean, results: (string | Dirent)[], dirs: string[], prefixes: string[] }} context
 */
function collectRecursiveReaddirResult(dir, prefix, { 0: names, 1: types }, context) {
 const { length } = names;
 for (let i = 0; i < length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (context.withFileTypes) {
 const dirent = getDirent(dir, name, types[i]);
 ArrayPrototypePush(context.results, dirent);
 // Follow symbolic links to directories, see https://github.com/nodejs/node/issues/52663
 isDirectory = dirent.isDirectory() ||
 (dirent.isSymbolicLink() && binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 } else {
 ArrayPrototypePush(context.results, relative);
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(dir, name)) === 1);
 }
 if (isDirectory) {
 ArrayPrototypePush(context.dirs, pathModule.join(dir, name));
 ArrayPrototypePush(context.prefixes, relative);
 }
 }
}

/*
 * An recursive 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@@ -1735,15 +1775,20 @@ function mkdirSync(path, options) {
function readdirRecursive(basePath, options, callback) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

 let i = 0;

 function read(path) {
Comment thread
codebytere marked this conversation as resolved.

 /**
 * Reads one directory from `context.dirs` and then moves on to the next
 * one, or calls back once none are left.
 * @param {string} path
 * @param {string} prefix path of this directory relative to `basePath`
 */
 function read(path, prefix) {
 const req = new FSReqCallback();
 req.oncomplete = (err, result) => {
 if (err) {
Expand All@@ -1752,68 +1797,28 @@ function readdirRecursive(basePath, options, callback) {
 }

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

 processReaddirResult({
 result,
 currentPath: path,
 context,
 });
 try {
 collectRecursiveReaddirResult(path, prefix, result, context);
 } catch (err) {
 callback(err);
 return;
 }

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

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

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

// 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 processReaddirResult = (args) => (args.context.withFileTypes ? handleDirents(args) : handleFilePaths(args));

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

 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 dirent = getDirent(currentPath, names[i], types[i]);
 ArrayPrototypePush(context.readdirResults, dirent);

 if (dirent.isDirectory() || binding.internalModuleStat(fullPath) === 1) {
 ArrayPrototypePush(context.pathsQueue, fullPath);
 }
 binding.readdir(path, options.encoding, true, req);
 }
}

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(resultPath);
 ArrayPrototypePush(context.readdirResults, relativeResultPath);

 if (stat === 1) {
 ArrayPrototypePush(context.pathsQueue, resultPath);
 }
 }
 read(context.dirs[i], context.prefixes[i++]);
}

/**
Expand All@@ -1827,35 +1832,20 @@ function handleFilePaths({ result, currentPath, context }) {
function readdirSyncRecursive(basePath, options) {
 const context = {
 withFileTypes: Boolean(options.withFileTypes),
 encoding: options.encoding,
 basePath,
 readdirResults: [],
 pathsQueue: [basePath],
 results: [],
 dirs: [basePath],
 prefixes: [''],
 };

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

 if (readdirResult === undefined) {
 return;
 for (let i = 0; i < context.dirs.length; i++) {
 const dir = context.dirs[i];
 const result = binding.readdir(dir, options.encoding, true);
 if (result !== undefined) {
 collectRecursiveReaddirResult(dir, context.prefixes[i], result, context);
 }

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

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

 return context.readdirResults;
 return context.results;
}

/**
Expand Down

96 changes: 32 additions & 64 deletions
lib/internal/fs/promises.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,9 @@ const {
 O_WRONLY,
 S_IFMT,
 S_IFREG,
 UV_DIRENT_DIR,
 UV_DIRENT_LINK,
 UV_DIRENT_UNKNOWN,
} = constants;

const binding = internalBinding('fs');
Expand DownExpand Up@@ -61,6 +64,7 @@ const {
 kWriteFileMaxChunkSize,
 },
 copyObject,
 getDirent,
 getDirents,
 getOptions,
 getStatFsFromBinding,
Expand DownExpand Up@@ -1621,73 +1625,37 @@ async function mkdir(path, options) {
}

async function readdirRecursive(originalPath, options) {
 const withFileTypes = !!options.withFileTypes;
 const readdirWithTypes = (path) => PromisePrototypeThen(
 binding.readdir(path, options.encoding, true, kUsePromises),
 undefined,
 handleErrorFromBinding,
 );
 const result = [];
 const queue = [
 [
 originalPath,
 await PromisePrototypeThen(
 binding.readdir(
 originalPath,
 options.encoding,
 !!options.withFileTypes,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ],
 ];


 if (options.withFileTypes) {
 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const dirent of getDirents(path, readdir)) {
 const queue = [[originalPath, '', await readdirWithTypes(originalPath)]];

 while (queue.length > 0) {
 // If we want to implement BFS make this a `shift` call instead of `pop`
 const { 0: path, 1: prefix, 2: { 0: names, 1: types } } = ArrayPrototypePop(queue);
 for (let i = 0; i < names.length; i++) {
 const name = names[i];
 const relative = prefix === '' ? name : `${prefix}${pathModule.sep}${name}`;
 let isDirectory;
 if (withFileTypes) {
 const dirent = getDirent(path, name, types[i]);
 ArrayPrototypePush(result, dirent);
 if (dirent.isDirectory()) {
 const direntPath = pathModule.join(path, dirent.name);
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 true,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 isDirectory = dirent.isDirectory();
 } else {
 ArrayPrototypePush(result, relative);
 // Entries that are, or may be, symbolic links to directories are followed.
 const type = types[i];
 isDirectory = type === UV_DIRENT_DIR ||
 ((type === UV_DIRENT_LINK || type === UV_DIRENT_UNKNOWN) &&
 binding.internalModuleStat(pathModule.join(path, name)) === 1);
 }
 }
 } else {
 while (queue.length > 0) {
 const { 0: path, 1: readdir } = ArrayPrototypePop(queue);
 for (const ent of readdir) {
 const direntPath = pathModule.join(path, ent);
 const stat = binding.internalModuleStat(direntPath);
 ArrayPrototypePush(
 result,
 pathModule.relative(originalPath, direntPath),
 );
 if (stat === 1) {
 ArrayPrototypePush(queue, [
 direntPath,
 await PromisePrototypeThen(
 binding.readdir(
 direntPath,
 options.encoding,
 false,
 kUsePromises,
 ),
 undefined,
 handleErrorFromBinding,
 ),
 ]);
 }
 if (isDirectory) {
 const direntPath = pathModule.join(path, name);
 ArrayPrototypePush(queue, [direntPath, relative, await readdirWithTypes(direntPath)]);
 }
 }
 }
Expand Down

2 changes: 1 addition & 1 deletion
test/known_issues/test-fs-readdir-recursive-with-buffer.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,4 +12,4 @@ const { readdir } = require('node:fs');
const { join } = require('node:path');

const testDirPath = join(__dirname, '..', '..');
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustCall());
readdir(Buffer.from(testDirPath), { recursive: true }, common.mustSucceed());
Loading