1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fs: warn on non-portable mkdtemp() templates

Browse Source 
Refs: https://github.com/nodejs/node/issues/26435
PR-URL: https://github.com/nodejs/node/pull/26980
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
cjihrig 2019-03-29 09:17:55 -04:00
parent d11c4beb4b
commit b925379f50
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
4 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/fs.js
View File

@ -73,7 +73,8 @@ const {
toUnixTimestamp, toUnixTimestamp,
validateOffsetLengthRead, validateOffsetLengthRead,
validateOffsetLengthWrite, validateOffsetLengthWrite,
validatePath validatePath,
warnOnNonPortableTemplate
} = require('internal/fs/utils'); } = require('internal/fs/utils');
const { const {
CHAR_FORWARD_SLASH, CHAR_FORWARD_SLASH,
@ -1721,6 +1722,7 @@ function mkdtemp(prefix, options, callback) {
throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix); throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix);
} }
nullCheck(prefix, 'prefix'); nullCheck(prefix, 'prefix');
warnOnNonPortableTemplate(prefix);
const req = new FSReqCallback(); const req = new FSReqCallback();
req.oncomplete = callback; req.oncomplete = callback;
binding.mkdtemp(`${prefix}XXXXXX`, options.encoding, req); binding.mkdtemp(`${prefix}XXXXXX`, options.encoding, req);
@ -1733,6 +1735,7 @@ function mkdtempSync(prefix, options) {
throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix); throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix);
} }
nullCheck(prefix, 'prefix'); nullCheck(prefix, 'prefix');
warnOnNonPortableTemplate(prefix);
const path = `${prefix}XXXXXX`; const path = `${prefix}XXXXXX`;
const ctx = { path }; const ctx = { path };
const result = binding.mkdtemp(path, options.encoding, const result = binding.mkdtemp(path, options.encoding,

4
lib/internal/fs/promises.js
View File

@ -31,7 +31,8 @@ const {
toUnixTimestamp, toUnixTimestamp,
validateOffsetLengthRead, validateOffsetLengthRead,
validateOffsetLengthWrite, validateOffsetLengthWrite,
validatePath validatePath,
warnOnNonPortableTemplate
} = require('internal/fs/utils'); } = require('internal/fs/utils');
const { const {
parseMode, parseMode,
@ -461,6 +462,7 @@ async function mkdtemp(prefix, options) {
throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix); throw new ERR_INVALID_ARG_TYPE('prefix', 'string', prefix);
} }
nullCheck(prefix); nullCheck(prefix);
warnOnNonPortableTemplate(prefix);
return binding.mkdtemp(`${prefix}XXXXXX`, options.encoding, kUsePromises); return binding.mkdtemp(`${prefix}XXXXXX`, options.encoding, kUsePromises);
} }

15
lib/internal/fs/utils.js
View File

@ -432,6 +432,18 @@ const validatePath = hideStackFrames((path, propName = 'path') => {
} }
}); });
let nonPortableTemplateWarn = true;
function warnOnNonPortableTemplate(template) {
// Template strings passed to the mkdtemp() family of functions should not
// end with 'X' because they are handled inconsistently across platforms.
if (nonPortableTemplateWarn && template.endsWith('X')) {
process.emitWarning('mkdtemp() templates ending with X are not portable. ' +
'For details see: https://nodejs.org/api/fs.html');
nonPortableTemplateWarn = false;
}
}
module.exports = { module.exports = {
assertEncoding, assertEncoding,
copyObject, copyObject,
@ -448,5 +460,6 @@ module.exports = {
toUnixTimestamp, toUnixTimestamp,
validateOffsetLengthRead, validateOffsetLengthRead,
validateOffsetLengthWrite, validateOffsetLengthWrite,
validatePath validatePath,
warnOnNonPortableTemplate
}; };

5
test/parallel/test-fs-mkdtemp.js
View File

@ -29,3 +29,8 @@ fs.mkdtemp(path.join(tmpdir.path, 'bar.'), common.mustCall(handler));
// Same test as above, but making sure that passing an options object doesn't // Same test as above, but making sure that passing an options object doesn't
// affect the way the callback function is handled. // affect the way the callback function is handled.
fs.mkdtemp(path.join(tmpdir.path, 'bar.'), {}, common.mustCall(handler)); fs.mkdtemp(path.join(tmpdir.path, 'bar.'), {}, common.mustCall(handler));
const warningMsg = 'mkdtemp() templates ending with X are not portable. ' +
'For details see: https://nodejs.org/api/fs.html';
common.expectWarning('Warning', warningMsg);
fs.mkdtemp(path.join(tmpdir.path, 'bar.X'), common.mustCall(handler));