Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

fix fs.truncate when first arg is an int fd #9161

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions doc/api/fs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ Synchronous ftruncate(2).

Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback.
Currently, fs.truncate also accepts a file descriptor as first argument but
you should use fs.ftruncate in this case as this fallback may go away.

## fs.truncateSync(path, len)

Expand Down
9 changes: 5 additions & 4 deletions lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,12 @@ function maybeCallback(cb) {
// for callbacks that are passed to the binding layer, callbacks that are
// invoked from JS already run in the proper scope.
function makeCallback(cb) {
if (!util.isFunction(cb)) {
if (util.ifNullOrUndefined(cb)) {
return rethrow();
}
if (!util.isFunction(cb)) {
throw new Error('callback must be a function');
}

return function() {
return cb.apply(null, arguments);
Expand Down Expand Up @@ -641,9 +644,7 @@ fs.renameSync = function(oldPath, newPath) {

fs.truncate = function(path, len, callback) {
if (util.isNumber(path)) {
var req = new FSReqWrap();
req.oncomplete = callback;
return fs.ftruncate(path, len, req);
return fs.ftruncate(path, len, callback);
}
if (util.isFunction(len)) {
callback = len;
Expand Down
45 changes: 45 additions & 0 deletions test/simple/test-regress-GH-9161.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var common = require('../common');
var assert = require('assert');
var path = require('path');
var fs = require('fs');
var tmp = common.tmpDir;
if (!fs.existsSync(tmp))
fs.mkdirSync(tmp);
var filename = path.resolve(tmp, 'truncate-file.txt');

var success = 0;
Copy link

Choose a reason for hiding this comment

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

I think this and the process.on('exit', ...) can be removed.

Copy link
Author

Choose a reason for hiding this comment

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

Exit test is necessary. Otherwise the test exits without any diagnostics on the broken implementation.


fs.writeFileSync(filename, 'hello world', 'utf8');
var fd = fs.openSync(filename, 'r+');
fs.truncate(fd, 5, function(err) {
assert.ok(!err);
success++;
});

process.on('exit', function() {
fs.closeSync(fd);
fs.unlinkSync(filename);
assert.equal(success, 1);
Copy link

Choose a reason for hiding this comment

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

I still don't think it's necessary to check for success. However, one thing you can add here is cleanup of the temp file used by the test.

Copy link
Author

Choose a reason for hiding this comment

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

The bug is that the callback is replaced by an instance of FSReqWrap. So no callback is called (and no exception is thrown). So I need another way to detect that something went wrong. Verifying the number of assertions at exit time does the job.

Copy link
Author

Choose a reason for hiding this comment

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

The test file that I provided 1) reproduces the bug, 2) produces a clear message that there is a bug and 3) passes when the bug is fixed. The alternative that you are proposing misses 2) because the test completes without any message.

Copy link

Choose a reason for hiding this comment

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

Sorry, my mistake was assuming that ftruncate() would throw when its callback isn't a function.

Copy link
Author

Choose a reason for hiding this comment

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

Yep. I was actually surprised to not get an exception.

console.log('ok');
});