79400bfbfd
Updates the fs module APIs to allow 'file://' URL objects
to be passed as the path.
For example:
```js
const URL = require('url').URL;
const myURL = new URL('file:///C:/path/to/file');
fs.readFile(myURL, (err, data) => {});
```
On Windows, file: URLs with a hostname convert to UNC paths,
while file: URLs with drive letters convert to local absolute
paths:
```
file://hostname/a/b/c => \\hostname\a\b\c
file:///c:/a/b/c => c:\a\b\c
```
On all other platforms, file: URLs with a hostname are unsupported
and will result in a throw:
```
file://hostname/a/b/c => throw!
file:///a/b/c => /a/b/c
```
The documentation for the fs API is intentionally not updated in
this commit because the URL API is still considered experimental
and is not officially documented *at this time*
Note that file: URLs are *required* by spec to always be absolute
paths from the file system root.
This is a semver-major commit because it changes error handling
on the fs APIs.
PR-URL: https://github.com/nodejs/node/pull/10739
Ref: https://github.com/nodejs/node/issues/10703
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
114 lines
5.9 KiB
JavaScript
114 lines
5.9 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const URL = require('url').URL;
|
|
|
|
function check(async, sync) {
|
|
const expected = /Path must be a string without null bytes/;
|
|
const argsSync = Array.prototype.slice.call(arguments, 2);
|
|
const argsAsync = argsSync.concat((er) => {
|
|
assert(er && er.message.match(expected));
|
|
assert.strictEqual(er.code, 'ENOENT');
|
|
});
|
|
|
|
if (sync)
|
|
assert.throws(() => {
|
|
sync.apply(null, argsSync);
|
|
}, expected);
|
|
|
|
if (async)
|
|
async.apply(null, argsAsync);
|
|
}
|
|
|
|
check(fs.access, fs.accessSync, 'foo\u0000bar');
|
|
check(fs.access, fs.accessSync, 'foo\u0000bar', fs.F_OK);
|
|
check(fs.appendFile, fs.appendFileSync, 'foo\u0000bar');
|
|
check(fs.chmod, fs.chmodSync, 'foo\u0000bar', '0644');
|
|
check(fs.chown, fs.chownSync, 'foo\u0000bar', 12, 34);
|
|
check(fs.link, fs.linkSync, 'foo\u0000bar', 'foobar');
|
|
check(fs.link, fs.linkSync, 'foobar', 'foo\u0000bar');
|
|
check(fs.lstat, fs.lstatSync, 'foo\u0000bar');
|
|
check(fs.mkdir, fs.mkdirSync, 'foo\u0000bar', '0755');
|
|
check(fs.open, fs.openSync, 'foo\u0000bar', 'r');
|
|
check(fs.readFile, fs.readFileSync, 'foo\u0000bar');
|
|
check(fs.readdir, fs.readdirSync, 'foo\u0000bar');
|
|
check(fs.readlink, fs.readlinkSync, 'foo\u0000bar');
|
|
check(fs.realpath, fs.realpathSync, 'foo\u0000bar');
|
|
check(fs.rename, fs.renameSync, 'foo\u0000bar', 'foobar');
|
|
check(fs.rename, fs.renameSync, 'foobar', 'foo\u0000bar');
|
|
check(fs.rmdir, fs.rmdirSync, 'foo\u0000bar');
|
|
check(fs.stat, fs.statSync, 'foo\u0000bar');
|
|
check(fs.symlink, fs.symlinkSync, 'foo\u0000bar', 'foobar');
|
|
check(fs.symlink, fs.symlinkSync, 'foobar', 'foo\u0000bar');
|
|
check(fs.truncate, fs.truncateSync, 'foo\u0000bar');
|
|
check(fs.unlink, fs.unlinkSync, 'foo\u0000bar');
|
|
check(null, fs.unwatchFile, 'foo\u0000bar', common.fail);
|
|
check(fs.utimes, fs.utimesSync, 'foo\u0000bar', 0, 0);
|
|
check(null, fs.watch, 'foo\u0000bar', common.fail);
|
|
check(null, fs.watchFile, 'foo\u0000bar', common.fail);
|
|
check(fs.writeFile, fs.writeFileSync, 'foo\u0000bar');
|
|
|
|
check(fs.access, fs.accessSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.access, fs.accessSync, new URL('file:///foo\u0000bar'), fs.F_OK);
|
|
check(fs.appendFile, fs.appendFileSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.chmod, fs.chmodSync, new URL('file:///foo\u0000bar'), '0644');
|
|
check(fs.chown, fs.chownSync, new URL('file:///foo\u0000bar'), 12, 34);
|
|
check(fs.link, fs.linkSync, new URL('file:///foo\u0000bar'), 'foobar');
|
|
check(fs.link, fs.linkSync, 'foobar', new URL('file:///foo\u0000bar'));
|
|
check(fs.lstat, fs.lstatSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.mkdir, fs.mkdirSync, new URL('file:///foo\u0000bar'), '0755');
|
|
check(fs.open, fs.openSync, new URL('file:///foo\u0000bar'), 'r');
|
|
check(fs.readFile, fs.readFileSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.readdir, fs.readdirSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.readlink, fs.readlinkSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.realpath, fs.realpathSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.rename, fs.renameSync, new URL('file:///foo\u0000bar'), 'foobar');
|
|
check(fs.rename, fs.renameSync, 'foobar', new URL('file:///foo\u0000bar'));
|
|
check(fs.rmdir, fs.rmdirSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.stat, fs.statSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.symlink, fs.symlinkSync, new URL('file:///foo\u0000bar'), 'foobar');
|
|
check(fs.symlink, fs.symlinkSync, 'foobar', new URL('file:///foo\u0000bar'));
|
|
check(fs.truncate, fs.truncateSync, new URL('file:///foo\u0000bar'));
|
|
check(fs.unlink, fs.unlinkSync, new URL('file:///foo\u0000bar'));
|
|
check(null, fs.unwatchFile, new URL('file:///foo\u0000bar'), common.fail);
|
|
check(fs.utimes, fs.utimesSync, new URL('file:///foo\u0000bar'), 0, 0);
|
|
check(null, fs.watch, new URL('file:///foo\u0000bar'), common.fail);
|
|
check(null, fs.watchFile, new URL('file:///foo\u0000bar'), common.fail);
|
|
check(fs.writeFile, fs.writeFileSync, new URL('file:///foo\u0000bar'));
|
|
|
|
check(fs.access, fs.accessSync, new URL('file:///foo%00bar'));
|
|
check(fs.access, fs.accessSync, new URL('file:///foo%00bar'), fs.F_OK);
|
|
check(fs.appendFile, fs.appendFileSync, new URL('file:///foo%00bar'));
|
|
check(fs.chmod, fs.chmodSync, new URL('file:///foo%00bar'), '0644');
|
|
check(fs.chown, fs.chownSync, new URL('file:///foo%00bar'), 12, 34);
|
|
check(fs.link, fs.linkSync, new URL('file:///foo%00bar'), 'foobar');
|
|
check(fs.link, fs.linkSync, 'foobar', new URL('file:///foo%00bar'));
|
|
check(fs.lstat, fs.lstatSync, new URL('file:///foo%00bar'));
|
|
check(fs.mkdir, fs.mkdirSync, new URL('file:///foo%00bar'), '0755');
|
|
check(fs.open, fs.openSync, new URL('file:///foo%00bar'), 'r');
|
|
check(fs.readFile, fs.readFileSync, new URL('file:///foo%00bar'));
|
|
check(fs.readdir, fs.readdirSync, new URL('file:///foo%00bar'));
|
|
check(fs.readlink, fs.readlinkSync, new URL('file:///foo%00bar'));
|
|
check(fs.realpath, fs.realpathSync, new URL('file:///foo%00bar'));
|
|
check(fs.rename, fs.renameSync, new URL('file:///foo%00bar'), 'foobar');
|
|
check(fs.rename, fs.renameSync, 'foobar', new URL('file:///foo%00bar'));
|
|
check(fs.rmdir, fs.rmdirSync, new URL('file:///foo%00bar'));
|
|
check(fs.stat, fs.statSync, new URL('file:///foo%00bar'));
|
|
check(fs.symlink, fs.symlinkSync, new URL('file:///foo%00bar'), 'foobar');
|
|
check(fs.symlink, fs.symlinkSync, 'foobar', new URL('file:///foo%00bar'));
|
|
check(fs.truncate, fs.truncateSync, new URL('file:///foo%00bar'));
|
|
check(fs.unlink, fs.unlinkSync, new URL('file:///foo%00bar'));
|
|
check(null, fs.unwatchFile, new URL('file:///foo%00bar'), common.fail);
|
|
check(fs.utimes, fs.utimesSync, new URL('file:///foo%00bar'), 0, 0);
|
|
check(null, fs.watch, new URL('file:///foo%00bar'), common.fail);
|
|
check(null, fs.watchFile, new URL('file:///foo%00bar'), common.fail);
|
|
check(fs.writeFile, fs.writeFileSync, new URL('file:///foo%00bar'));
|
|
|
|
// an 'error' for exists means that it doesn't exist.
|
|
// one of many reasons why this file is the absolute worst.
|
|
fs.exists('foo\u0000bar', common.mustCall((exists) => {
|
|
assert(!exists);
|
|
}));
|
|
assert(!fs.existsSync('foo\u0000bar'));
|