Repository navigation
[v18.x] Wrong path returned by fs.readdir withFileTypes=true #52441
Description
Version
18.20.1
Platform
Linux h4ad 6.5.0-27-generic #28~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Fri Mar 15 10:51:06 UTC 2 x86_64 x86_64 x86_64 GNU/Linux
Subsystem
fs/promise
What steps will reproduce the bug?
You can reproduce the issue by running the following commands:
$ mkdir fs-issue
$ cd fs-issue
$ touch issue.txt
$ node -e "require('fs/promises').readdir('.', { withFileTypes: true, encoding: 'utf-8', }).then(console.log)" How often does it reproduce? Is there a required condition?
Always
What is the expected behavior? Why is that the expected behavior?
The path should be ..
[
Dirent {
name: 'issue.txt',
parentPath: '.',
path: '.',
[Symbol(type)]: 1
}
]
What do you see instead?
The path is different:
[
Dirent {
name: 'issue.txt',
parentPath: '.',
path: 'issue.txt',
[Symbol(type)]: 1
}
]
This issue only happens on fs/promises, on readdirSync, we don't see this issue:
$ node --print "require('fs').readdirSync('.', { withFileTypes: true, encoding: 'utf-8', })"
[
Dirent {
name: 'issue.txt',
parentPath: '.',
path: '.',
[Symbol(type)]: 1
}
]Also, if we include recursive, we don't see the issue:
$ node -e "require('fs/promises').readdir('.', { recursive:true, withFileTypes: true, encoding: 'utf-8', }).then(console.log)"
[
Dirent {
name: 'issue.txt',
parentPath: '.',
path: '.',
[Symbol(type)]: 1
}
]
Additional information
This bug was first introduced at 18.20.0, on 18.19.1 the behavior is correct.
On latest version of node, 21.7.2 and 20.12.1, we don't see this issue.
This bug was found by @wraithgar at npm/cli#7352 (comment)
Activity
H4ad commentedon Apr 9, 2024
The issue was probably introduced by this change introduced by #51021:
node/lib/internal/fs/utils.js
Lines 200 to 205 in f75dc41
The main PR #50976 didn't include these changes.
richardlau commentedon Apr 10, 2024
cc @aduh95
[-]Wrong path returned by fs.readdir withFileTypes=true[/-][+][v18.x] Wrong path returned by fs.readdir withFileTypes=true[/+]lcgani commentedon May 20, 2024
hi guys, what's the status of this issue? I can look into it if it wasn't assigned to anyone yet
H4ad commentedon May 22, 2024
@gm-al Basically waiting for a PR, feel free to work on it if you want :) You can ping me when you had something to review
jakecastelli commentedon Jun 11, 2024
Just had a quick scan, looks like the current main does not have
pathproperty any more? was that intentional? (it was still there inv20.x,v22.xand I couldn't see it mentioned in the changelog or docssonsurim commentedon Jul 16, 2024
Hello! May I try to resolve this issue?
dario-piotrowicz commentedon Jan 25, 2025
The dirent.path field has been deprecated in #51020 and removed in #55548 (like @jakecastelli mentioned above)
Precisely for reasons like the one presented here I assume
So this issue is no longer applicable and should be closed
cc. @aduh95
H4ad commentedon Jan 29, 2025
@dario-piotrowicz Thanks for the reminder, closing since this is no longer applicable.