fs: runtime deprecate closing fs.Dir on garbage collection
#58850
+120
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LiviaMedeiros
added
fs
nodejs-github-bot
added
the
c++
LiviaMedeiros
force-pushed
the
fs-deprecate-dir-close-gc
branch
3 times, most recently
from
719ebb4 to
39e8ae5
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #58850 +/- ##
==========================================
- Coverage 88.28% 88.26% -0.02%
==========================================
Files 701 701
Lines 206774 206787 +13
Branches 39772 39778 +6
==========================================
- Hits 182545 182522 -23
- Misses 16234 16285 +51
+ Partials 7995 7980 -15
🚀 New features to boost your workflow:
|
aduh95
reviewed
Sep 6, 2025
doc/api/deprecations.md
Outdated
Comment on lines
4080
to
4143
| import { opendir } from 'node:fs/promises'; | ||
|
|
||
| { | ||
| await using dir = await opendir('/async/disposable/directory'); | ||
| } // Closed by dir[Symbol.asyncDispose]() | ||
|
|
||
| { | ||
| using dir = await opendir('/sync/disposable/directory'); | ||
| } // Closed by dir[Symbol.dispose]() | ||
|
|
||
| { | ||
| let dir; | ||
| try { | ||
| dir = await opendir('/legacy/closeable/directory'); | ||
| } finally { | ||
| await dir?.close(); | ||
| } | ||
| } |
There was a problem hiding this comment.
I think this is lacking the (IMO) most prominent use-case for opendir: iterating on it. Can you add a test that iterates on a Dir and validates that it does not trigger any warning?
There was a problem hiding this comment.
Can you add the iteration example in this snippet as well please?
LiviaMedeiros
force-pushed
the
fs-deprecate-dir-close-gc
branch
from
39e8ae5 to
c60424b
Compare
aduh95
approved these changes
Sep 10, 2025
|
Sure, i'll make PR with doc-only version of this (or rather, formalizing already existing runtime warning as deprecation). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The DEP0137 is going to be End-of-Life in the next major release.
I think we should align closing
fs.Diron GC and deprecate it as well. Now that explicit resource management is available, closing dirs properly should become easier for userland.Given that it already spams
Warnings in stderr, it would make sense to make this deprecation runtime right away.cc @nodejs/fs @nodejs/tsc