Skip to content

Commit

Permalink
fs: warn if no callback is passed to async calls
Browse files Browse the repository at this point in the history
This patch issues a deprecation warning, if an asynchronous function
is called without a callback function.

PR-URL: #7897
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
thefourtheye committed Aug 27, 2016
1 parent a72a331 commit f8f283b
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 15 deletions.
7 changes: 7 additions & 0 deletions lib/fs.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ function throwOptionsError(options) {
}

function rethrow() {
// TODO(thefourtheye) Throw error instead of warning in major version > 7
process.emitWarning(
'Calling an asynchronous function without callback is deprecated.',
'DeprecationWarning',
rethrow
);

// Only enable in debug mode. A backtrace uses ~1000 bytes of heap space and
// is fairly slow to generate.
if (DEBUG) {
Expand Down
40 changes: 25 additions & 15 deletions test/parallel/test-fs-make-callback.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict';
require('../common');
var assert = require('assert');
var fs = require('fs');
const common = require('../common');
const assert = require('assert');
const fs = require('fs');

function test(cb) {
return function() {
Expand All @@ -13,16 +13,26 @@ function test(cb) {
// Verify the case where a callback function is provided
assert.doesNotThrow(test(function() {}));

// Passing undefined calls rethrow() internally, which is fine
assert.doesNotThrow(test(undefined));
process.once('warning', common.mustCall((warning) => {
assert.strictEqual(
warning.message,
'Calling an asynchronous function without callback is deprecated.'
);

// Anything else should throw
assert.throws(test(null));
assert.throws(test(true));
assert.throws(test(false));
assert.throws(test(1));
assert.throws(test(0));
assert.throws(test('foo'));
assert.throws(test(/foo/));
assert.throws(test([]));
assert.throws(test({}));
invalidArgumentsTests();
}));

// Passing undefined/nothing calls rethrow() internally, which emits a warning
assert.doesNotThrow(test());

function invalidArgumentsTests() {
assert.throws(test(null));
assert.throws(test(true));
assert.throws(test(false));
assert.throws(test(1));
assert.throws(test(0));
assert.throws(test('foo'));
assert.throws(test(/foo/));
assert.throws(test([]));
assert.throws(test({}));
}

0 comments on commit f8f283b

Please sign in to comment.