Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fs: deprecate never throw behaviour in fs.existsSync #55753

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
5 changes: 4 additions & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3776,12 +3776,15 @@ It is recommended to use the `new` qualifier instead. This applies to all REPL c

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/55753
description: Runtime deprecation.
Ceres6 marked this conversation as resolved.
Show resolved Hide resolved
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/55892
description: Documentation-only.
-->

Type: Documentation-only
Type: Runtime
aduh95 marked this conversation as resolved.
Show resolved Hide resolved

Passing non-supported argument types is deprecated and, instead of returning `false`,
will throw an error in a future version.
Expand Down
13 changes: 7 additions & 6 deletions lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -272,12 +272,7 @@ ObjectDefineProperty(exists, kCustomPromisifiedSymbol, {
},
});

// fs.existsSync never throws, it only returns true or false.
// Since fs.existsSync never throws, users have established
// the expectation that passing invalid arguments to it, even like
// fs.existsSync(), would only get a false in return, so we cannot signal
// validation errors to users properly out of compatibility concerns.
// TODO(joyeecheung): deprecate the never-throw-on-invalid-arguments behavior
let showExistsDeprecation = true;
/**
* Synchronously tests whether or not the given path exists.
* @param {string | Buffer | URL} path
Expand All @@ -287,6 +282,12 @@ function existsSync(path) {
try {
path = getValidatedPath(path);
} catch {
if (showExistsDeprecation) {
process.emitWarning(
'Passing invalid argument types to fs.existsSync is deprecated', 'DeprecationWarning', 'DEP0187',
);
showExistsDeprecation = false;
}
return false;
}

Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-fs-exists.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ assert(fs.existsSync(f));
assert(!fs.existsSync(`${f}-NO`));

// fs.existsSync() never throws
const msg = 'Passing invalid argument types to fs.existsSync is deprecated';
common.expectWarning('DeprecationWarning', msg, 'DEP0187');
assert(!fs.existsSync());
assert(!fs.existsSync({}));
assert(!fs.existsSync(new URL('https://foo')));
Loading