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,doc,test: open reserved characters under win32 #13875

Closed
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1587,6 +1587,26 @@ fs.open('<directory>', 'a+', (err, fd) => {
});
```

Some characters are reserved under Windows as documented by
[Naming Files, Paths, and Namespaces][]. Under NTFS, if the filename contains
colon, Node.js will open a file system stream, as described by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"colon" -> "a colon"

[this MSDN page][MSDN-Using-Streams].

The reserved characters are list below.

+ `<` (less than)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm honestly not a huge fan of documenting the operating system like this in Node's docs. Since we're already linking to MSDN, this list can probably be dropped.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think listing them here is more intuitive.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The list might be helpful but you could use a more compact form like < > " / \ | ? * :

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get some more feedback on the formatting of this list
/cc @nodejs/documentation @nodejs/platform-windows

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I say drop the list, it is in the MSDN and should be rather well known.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I too think a link to MSDN is enough. IIRC this is primarily a limitations of NTFS only.

+ `>` (greater than)
+ `:` (colon)
+ `"` (double quote)
+ `/` (forward slash)
+ `\` (backslash)
+ `|` (vertical bar or pipe)
+ `?` (question mark)
+ `*` (asterisk)

Functions based on `fs.open()` exhibit this behavior as well. eg.
`fs.writeFile()`, `fs.readFile()`, etc.

## fs.openSync(path, flags[, mode])
<!-- YAML
added: v0.1.21
Expand Down Expand Up @@ -2864,3 +2884,5 @@ The following constants are meant for use with the [`fs.Stats`][] object's
[Readable Stream]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable
[inode]: https://en.wikipedia.org/wiki/Inode
[Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
[MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx
45 changes: 45 additions & 0 deletions test/parallel/test-fs-write-file-invalid-path.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
'use strict';

const common = require('../common');
const assert = require('assert');
const fs = require('fs');
const path = require('path');

if (!common.isWindows)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the skipping can be placed before require('assert') etc. to eliminate needless work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all require at the top is much tidier.

common.skip('This test is for Windows only.');

common.refreshTmpDir();

const DATA_VALUE = 'hello';

// Refs: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
// Ignore '/', '\\' and ':'
const REVERSED_CHARACTERS = '<>"|?*';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless I am missing something here, I am pretty sure those characters are RESERVED, not REVERSED.


Array.prototype.forEach.call(REVERSED_CHARACTERS, (ch) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be simpler?

[...REVERSED_CHARACTERS].forEach((ch) => { });

const pathname = path.join(common.tmpDir, `somefile_${ch}`);
assert.throws(
() => {
fs.writeFileSync(pathname, DATA_VALUE);
},
/^Error: ENOENT: no such file or directory, open '.*'$/,
`failed with '${ch}'`);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for the last arg (default error will be good)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use the default message, we won't know which character is if test failed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it will be in the error message.. but it you are sure, Ok.

});

// Test for ':' (NTFS data streams).
// Refs: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx
const pathname = path.join(common.tmpDir, 'foo:bar');
fs.writeFileSync(pathname, DATA_VALUE);

let content = '';
const fileDataStream = fs.createReadStream(pathname, {
encoding: 'utf8'
});

fileDataStream.on('data', (data) => {
content += data.toString();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would not the data be already a string as we have set encoding: 'utf8' above?

});

fileDataStream.on('end', common.mustCall(() => {
assert.strictEqual(content, DATA_VALUE);
}));