fs: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow
, '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: watch directories, not files, in recursive fs.watch fallback - #65486

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches
Aug 31, 2026
Merged

fs: watch directories, not files, in recursive fs.watch fallback#65486
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
codebytere:perf/fs-watch-recursive-linux-dir-watches

Conversation

@codebytere

@codebyterecodebytere commented Aug 22, 2026

Copy link
Copy Markdown
Member

Makes the JavaScript recursive watcher (used where fs.watch() has no native recursive mode) arm one watcher per directory instead of one per file on Linux, and answer each event with one stat() instead of re-reading the directory.

Linux, this repository's test/ tree (13 500 entries, 896 directories):

beforeafter
fs.watch(test, { recursive: true }) setup~150 ms, 13 501 handles, +52 MB RSS~45 ms, 896 handles, +20 MB RSS
benchmark/fs/bench-watch-recursive.js (new), test/fixtures, 30 runs+287 % ±4 %
CPU for 300 appends to one file in test/parallel2 860 ms11 ms
CPU for 100 create+unlink in test/parallel2 890 ms110 ms

The fallback armed an fs.watch() handle and ran a statSync() for every file in the tree, and handled every event by stat()ing and re-reading the whole directory it happened in. A file replaced by rename() (the usual editor save) also stopped being reported, because its watch stayed on the old inode, and watcher.ref()/unref() were no-ops on this path.

inotify reports changes to a watched directory's entries with the entry name, so on Linux the watcher now keeps one handle per directory (symbolic links keep their own, as before) plus the set of known paths, and resolves an event with a single stat() of the named entry: new names are reported as 'rename' and descended into if they are directories, vanished ones are dropped with their subtree and reported as 'rename', changes to known files are 'change'. kqueue and event ports only report that the directory itself changed, so on the other platforms this fallback serves (illumos, the BSDs, AIX) files keep a watcher each and a directory event rescans that directory, as today. Two event differences remain, both matching the native watchers: creating a file with content yields 'rename' then 'change', and a file keeps being reported after it is replaced by rename(). ref()/unref() now reach the handles.

Tests: all test-fs-watch-recursive-*, test-fs-watch-ignore-*, test-fs-promises-watch* and watch-mode tests pass in both modes (the per-file mode exercised on Linux by flipping the platform check; recursive ones 3/3 repeated runs); a new Linux-only test covers the per-directory handle count, rename-over reporting, events behind a symbolic link, removal of a watched root directory and root file, and ref()/unref().


Disclosure: the code, test, benchmark, measurements and this description were written by Claude Code, directed and reviewed by @codebytere.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/performance

@nodejs-github-botnodejs-github-bot added fs Issues and PRs related to file-system APIs and the fs module. needs-ci PRs that need a full CI run. labels Aug 22, 2026
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.76821% with 23 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.14%. Comparing base (21f0f27) to head (7774d81).
⚠️ Report is 188 commits behind head on main.

Files with missing linesPatch %Lines
lib/internal/fs/recursive_watch.js84.76%22 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #65486 +/- ##
==========================================
+ Coverage 90.12% 90.14% +0.02% 
==========================================
Files 752 751 -1 Lines 252315 253482 +1167 Branches 47444 47747 +303 ==========================================
+ Hits 227395 228501 +1106 - Misses 16217 16252 +35 - Partials 8703 8729 +26 
Files with missing linesCoverage Δ
lib/internal/fs/recursive_watch.js86.47% <84.76%> (-0.74%)⬇️

... and 86 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from 6a5d660 to bd967d5CompareAugust 22, 2026 16:57
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
@codebytere
codebytereforce-pushed the perf/fs-watch-recursive-linux-dir-watches branch from bd967d5 to 7774d81CompareAugust 23, 2026 20:44
@codebytere

codebytere commented Aug 23, 2026

Copy link
Copy Markdown
MemberAuthor

@MoLow mind taking another look? the non-Linux path changed since your review

@codebytere
codebytere requested a review from MoLowAugust 25, 2026 08:13
@codebyterecodebytere added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 25, 2026
@nodejs-github-bot

This comment was marked as outdated.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@codebyterecodebytere added commit-queue PRs queued for automated landing through the Commit Queue. and removed needs-ci PRs that need a full CI run. labels Aug 31, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 2ec0f9a into nodejs:mainAug 31, 2026
72 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 2ec0f9a

@nodejs-github-botnodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 31, 2026
@aduh95

Copy link
Copy Markdown
Contributor

CI on main is failing since this change:

=== release test-fs-watch-enoent === Path: parallel/test-fs-watch-enoent
node:internal/assert/utils:146
throw error;
^
AssertionError [ERR_ASSERTION]: Missing expected exception.
at Object.<anonymous> (/Users/duhamean/Documents/nodejs/node/test/parallel/test-fs-watch-enoent.js:112:12)
at Module._compile (node:internal/modules/cjs/loader:1937:14)
at Object..js (node:internal/modules/cjs/loader:2077:10)
at Module.load (node:internal/modules/cjs/loader:1659:32)
at Module._load (node:internal/modules/cjs/loader:1451:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:261:19)
at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
at node:internal/main/run_main_module:33:47 {
generatedMessage: false,
code: 'ERR_ASSERTION',
actual: undefined,
expected: [Function (anonymous)],
operator: 'throws',
diff: 'simple'
}
Node.js v27.0.0-pre

@panva

Copy link
Copy Markdown
Member

#65683

@panvapanva added the needs-ci PRs that need a full CI run. label Aug 31, 2026
aduh95 pushed a commit that referenced this pull request Sep 3, 2026
The JavaScript recursive watcher used on platforms without a native one
(notably Linux) armed an fs.watch() handle and a stat() for every file
in the tree, and answered every event by stat()ing and re-reading the
whole directory it happened in. A 13k-entry tree cost 13.5k inotify
watches, ~150 ms and ~50 MB to set up, and appending to one file in a
3900-entry directory cost ~9 ms of CPU per event. A file replaced by
rename() (the usual editor save) also stopped being reported, since its
watch stayed on the old inode.
inotify reports changes to the entries of a watched directory, with
their names, so on Linux watch each directory once (symbolic links keep
their own watcher, as before), keep the set of known paths, and resolve
an event with a single stat() of the named entry: unknown names are
added and reported as 'rename', vanished ones are dropped and reported
as 'rename', file changes are reported as 'change'. kqueue and event
ports only report that a directory changed, so on the other platforms
served by this fallback every file keeps its own watcher and a
directory event rescans that directory, as before. unref() and ref()
now reach the underlying handles.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65486
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fsIssues and PRs related to file-system APIs and the fs module.needs-ciPRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@codebytere@nodejs-github-bot@aduh95@panva@MoLow