Fix bug where fs.exists is incorrectly promisified #835
Conversation
This file contains 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
Hexxeh
force-pushed
the
lmcloughlin/exists-promisify
branch
from
7e3b978 to
0b912c3
Compare
shellscape
requested review from
danielgindi,
lukastaegert,
tjenkinson and
TrySound
merceyz
reviewed
Mar 13, 2021
| export const readFile = promisify(fs.readFile); | ||
| export const realpath = promisify(fs.realpath); | ||
| export { realpathSync } from 'fs'; | ||
| export const stat = promisify(fs.stat); | ||
| export async function exists(filePath) { |
There was a problem hiding this comment.
Since fs.exists is just a wrapper around fs.access you should use that to make sure the behaviour is the same and to not unnecessarily create the stat object just to throw it away
TrySound
reviewed
Mar 13, 2021
packages/node-resolve/src/fs.js
Outdated
| export const readFile = promisify(fs.readFile); | ||
| export const realpath = promisify(fs.realpath); | ||
| export { realpathSync } from 'fs'; | ||
| export const stat = promisify(fs.stat); | ||
| export async function exists(filePath) { | ||
| try { | ||
| await stat(filePath); |
There was a problem hiding this comment.
There is "access" function to check file existence.
|
Also looks like already promisified version are available in node 10 |
danielgindi
approved these changes
Mar 13, 2021
Hexxeh
force-pushed
the
lmcloughlin/exists-promisify
branch
from
0b912c3 to
4b58114
Compare
|
Swapped |
lukastaegert
approved these changes
Mar 16, 2021
|
|
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.
Rollup Plugin Name: node-resolve
This PR contains:
Are tests included?
Breaking Changes?
If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.
List any relevant issue numbers:
Description
Using the node-resolve plugin in a browser where the fs module is mocked fails to find resolve any paths. Upon debugging this issue, it appears to be because
fs.existsis passed toutil.promisify. The Node docs explicitly call out this function as being non-standard and not following the pattern forutil.promisifyto work correctly.As far as I can tell, this works on Node because
fs.existsactually internally already provides a promisified version via: https://nodejs.org/api/util.html#util_custom_promisified_functionsUsing stat, which doesn't have this non-standard-ness, works around this issue.
I haven't included tests because this fixes a bug when running in an admittedly quite strange setup that's currently not replicated in tests at all as far as I know.