lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

util: prepend '(node) ' to deprecation messages 

Changes included in this commit are

   1. Making the deprecation messages consistent. The messages will be in
      the following format

           x is deprecated. Use y instead.

      If there is no alternative for `x`, then the ` Use y instead.` part
      will not be there in the message.

   2. All the internal deprecation messages are printed with the prefix
      `(node) `, except when the `--trace-deprecation` flag is set.

Fixes: https://github.com/nodejs/io.js/issues/1883
PR-URL: https://github.com/nodejs/io.js/pull/1892
Reviewed-By: Roman Reiss <me@silverwind.io>
v4.0.0-rc
Sakthipriyan Vairamani 10 years ago
committed by Roman Reiss
parent
d55a778bae
commit
9cd44bb2b6
16 changed files with 116 additions and 64 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      lib/_http_outgoing.js
  2. 7
      lib/_stream_writable.js
  3. 9
      lib/buffer.js
  4. 6
      lib/child_process.js
  5. 12
      lib/crypto.js
  6. 8
      lib/http.js
  7. 22
      lib/internal/util.js
  8. 16
      lib/module.js
  9. 14
      lib/net.js
  10. 6
      lib/os.js
  11. 6
      lib/readline.js
  12. 3
      lib/smalloc.js
  13. 6
      lib/tty.js
  14. 34
      lib/util.js
  15. 6
      test/fixtures/deprecated-userland-function.js
  16. 18
      test/sequential/test-deprecation-flags.js

5
lib/_http_outgoing.js
View File

@ -4,6 +4,7 @@ const assert = require('assert').ok;
const Stream = require('stream'); const Stream = require('stream');
const timers = require('timers'); const timers = require('timers');
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const Buffer = require('buffer').Buffer; const Buffer = require('buffer').Buffer;
const common = require('_http_common'); const common = require('_http_common');
@ -644,6 +645,6 @@ OutgoingMessage.prototype.flushHeaders = function() {
this._send(''); this._send('');
}; };
OutgoingMessage.prototype.flush = util.deprecate(function() { OutgoingMessage.prototype.flush = internalUtil.deprecate(function() {
this.flushHeaders(); this.flushHeaders();
}, 'flush is deprecated. Use flushHeaders instead.'); }, 'OutgoingMessage.flush is deprecated. Use flushHeaders instead.');

7
lib/_stream_writable.js
View File

@ -8,6 +8,7 @@ module.exports = Writable;
Writable.WritableState = WritableState; Writable.WritableState = WritableState;
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const Stream = require('stream'); const Stream = require('stream');
const Buffer = require('buffer').Buffer; const Buffer = require('buffer').Buffer;
@ -120,10 +121,10 @@ WritableState.prototype.getBuffer = function writableStateGetBuffer() {
}; };
Object.defineProperty(WritableState.prototype, 'buffer', { Object.defineProperty(WritableState.prototype, 'buffer', {
get: util.deprecate(function() { get: internalUtil.deprecate(function() {
return this.getBuffer(); return this.getBuffer();
}, '_writableState.buffer is deprecated. Use ' + }, '_writableState.buffer is deprecated. Use _writableState.getBuffer ' +
'_writableState.getBuffer() instead.') 'instead.')
}); });
function Writable(options) { function Writable(options) {

9
lib/buffer.js
View File

@ -468,7 +468,7 @@ Buffer.prototype.get = internalUtil.deprecate(function get(offset) {
if (offset < 0 || offset >= this.length) if (offset < 0 || offset >= this.length)
throw new RangeError('index out of range'); throw new RangeError('index out of range');
return this[offset]; return this[offset];
}, '.get() is deprecated. Access using array indexes instead.'); }, 'Buffer.get is deprecated. Use array indexes instead.');
// XXX remove in v0.13 // XXX remove in v0.13
@ -477,14 +477,15 @@ Buffer.prototype.set = internalUtil.deprecate(function set(offset, v) {
if (offset < 0 || offset >= this.length) if (offset < 0 || offset >= this.length)
throw new RangeError('index out of range'); throw new RangeError('index out of range');
return this[offset] = v; return this[offset] = v;
}, '.set() is deprecated. Set using array indexes instead.'); }, 'Buffer.set is deprecated. Use array indexes instead.');
// TODO(trevnorris): fix these checks to follow new standard // TODO(trevnorris): fix these checks to follow new standard
// write(string, offset = 0, length = buffer.length, encoding = 'utf8') // write(string, offset = 0, length = buffer.length, encoding = 'utf8')
var writeWarned = false; var writeWarned = false;
const writeMsg = '.write(string, encoding, offset, length) is deprecated.' + const writeMsg = 'Buffer.write(string, encoding, offset, length) is ' +
' Use write(string[, offset[, length]][, encoding]) instead.'; 'deprecated. Use write(string[, offset[, length]]' +
'[, encoding]) instead.';
Buffer.prototype.write = function(string, offset, length, encoding) { Buffer.prototype.write = function(string, offset, length, encoding) {
// Buffer#write(string); // Buffer#write(string);
if (offset === undefined) { if (offset === undefined) {

6
lib/child_process.js
View File

@ -1,6 +1,7 @@
'use strict'; 'use strict';
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const debug = util.debuglog('child_process'); const debug = util.debuglog('child_process');
const constants = require('constants'); const constants = require('constants');
@ -269,11 +270,12 @@ exports.execFile = function(file /* args, options, callback */) {
return child; return child;
}; };
var _deprecatedCustomFds = util.deprecate(function(options) { var _deprecatedCustomFds = internalUtil.deprecate(function(options) {
options.stdio = options.customFds.map(function(fd) { options.stdio = options.customFds.map(function(fd) {
return fd === -1 ? 'pipe' : fd; return fd === -1 ? 'pipe' : fd;
}); });
}, 'child_process: customFds option is deprecated, use stdio instead.'); }, 'child_process: options.customFds option is deprecated. ' +
'Use options.stdio instead.');
function _convertCustomFds(options) { function _convertCustomFds(options) {
if (options && options.customFds && !options.stdio) { if (options && options.customFds && !options.stdio) {

12
lib/crypto.js
View File

@ -19,6 +19,7 @@ const Buffer = require('buffer').Buffer;
const constants = require('constants'); const constants = require('constants');
const stream = require('stream'); const stream = require('stream');
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const DH_GENERATOR = 2; const DH_GENERATOR = 2;
@ -682,10 +683,13 @@ function filterDuplicates(names) {
} }
// Legacy API // Legacy API
exports.__defineGetter__('createCredentials', util.deprecate(function() { exports.__defineGetter__('createCredentials',
internalUtil.deprecate(function() {
return require('tls').createSecureContext; return require('tls').createSecureContext;
}, 'createCredentials() is deprecated, use tls.createSecureContext instead')); }, 'crypto.createCredentials is deprecated. ' +
'Use tls.createSecureContext instead.'));
exports.__defineGetter__('Credentials', util.deprecate(function() { exports.__defineGetter__('Credentials', internalUtil.deprecate(function() {
return require('tls').SecureContext; return require('tls').SecureContext;
}, 'Credentials is deprecated, use tls.createSecureContext instead')); }, 'crypto.Credentials is deprecated. ' +
'Use tls.createSecureContext instead.'));

8
lib/http.js
View File

@ -1,6 +1,7 @@
'use strict'; 'use strict';
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const EventEmitter = require('events').EventEmitter; const EventEmitter = require('events').EventEmitter;
@ -91,9 +92,8 @@ Client.prototype.request = function(method, path, headers) {
return c; return c;
}; };
exports.Client = util.deprecate(Client, exports.Client = internalUtil.deprecate(Client, 'http.Client is deprecated.');
'http.Client will be removed soon. Do not use it.');
exports.createClient = util.deprecate(function(port, host) { exports.createClient = internalUtil.deprecate(function(port, host) {
return new Client(port, host); return new Client(port, host);
}, 'http.createClient is deprecated. Use `http.request` instead.'); }, 'http.createClient is deprecated. Use http.request instead.');

22
lib/internal/util.js
View File

@ -1,6 +1,20 @@
'use strict'; 'use strict';
const prefix = '(node) ';
// All the internal deprecations have to use this function only, as this will
// prepend the prefix to the actual message.
exports.deprecate = function(fn, msg) {
return exports._deprecate(fn, `${prefix}${msg}`);
};
// All the internal deprecations have to use this function only, as this will
// prepend the prefix to the actual message.
exports.printDeprecationMessage = function(msg, warned) { exports.printDeprecationMessage = function(msg, warned) {
return exports._printDeprecationMessage(`${prefix}${msg}`, warned);
};
exports._printDeprecationMessage = function(msg, warned) {
if (process.noDeprecation) if (process.noDeprecation)
return true; return true;
@ -10,7 +24,7 @@ exports.printDeprecationMessage = function(msg, warned) {
if (process.throwDeprecation) if (process.throwDeprecation)
throw new Error(msg); throw new Error(msg);
else if (process.traceDeprecation) else if (process.traceDeprecation)
console.trace(msg); console.trace(msg.startsWith(prefix) ? msg.replace(prefix, '') : msg);
else else
console.error(msg); console.error(msg);
@ -20,11 +34,11 @@ exports.printDeprecationMessage = function(msg, warned) {
// Mark that a method should not be used. // Mark that a method should not be used.
// Returns a modified function which warns once by default. // Returns a modified function which warns once by default.
// If --no-deprecation is set, then it is a no-op. // If --no-deprecation is set, then it is a no-op.
exports.deprecate = function(fn, msg) { exports._deprecate = function(fn, msg) {
// Allow for deprecating things in the process of starting up. // Allow for deprecating things in the process of starting up.
if (global.process === undefined) { if (global.process === undefined) {
return function() { return function() {
return exports.deprecate(fn, msg).apply(this, arguments); return exports._deprecate(fn, msg).apply(this, arguments);
}; };
} }
@ -34,7 +48,7 @@ exports.deprecate = function(fn, msg) {
var warned = false; var warned = false;
function deprecated() { function deprecated() {
warned = exports.printDeprecationMessage(msg, warned); warned = exports._printDeprecationMessage(msg, warned);
return fn.apply(this, arguments); return fn.apply(this, arguments);
} }

16
lib/module.js
View File

@ -2,6 +2,7 @@
const NativeModule = require('native_module'); const NativeModule = require('native_module');
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const runInThisContext = require('vm').runInThisContext; const runInThisContext = require('vm').runInThisContext;
const assert = require('assert').ok; const assert = require('assert').ok;
const fs = require('fs'); const fs = require('fs');
@ -120,12 +121,7 @@ function tryExtensions(p, exts) {
return false; return false;
} }
var warned = false;
const noopDeprecateRequireDot = util.deprecate(function() {},
'warning: require(\'.\') resolved outside the package directory. ' +
'This functionality is deprecated and will be removed soon.');
Module._findPath = function(request, paths) { Module._findPath = function(request, paths) {
var exts = Object.keys(Module._extensions); var exts = Object.keys(Module._extensions);
@ -172,7 +168,13 @@ Module._findPath = function(request, paths) {
if (filename) { if (filename) {
// Warn once if '.' resolved outside the module dir // Warn once if '.' resolved outside the module dir
if (request === '.' && i > 0) noopDeprecateRequireDot(); if (request === '.' && i > 0) {
warned = internalUtil.printDeprecationMessage(
'warning: require(\'.\') resolved outside the package ' +
'directory. This functionality is deprecated and will be removed ' +
'soon.', warned);
}
Module._pathCache[cacheKey] = filename; Module._pathCache[cacheKey] = filename;
return filename; return filename;
} }

14
lib/net.js
View File

@ -4,6 +4,7 @@ const events = require('events');
const stream = require('stream'); const stream = require('stream');
const timers = require('timers'); const timers = require('timers');
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const assert = require('assert'); const assert = require('assert');
const cares = process.binding('cares_wrap'); const cares = process.binding('cares_wrap');
const uv = process.binding('uv'); const uv = process.binding('uv');
@ -1077,16 +1078,17 @@ function Server(options, connectionListener) {
this._connections = 0; this._connections = 0;
Object.defineProperty(this, 'connections', { Object.defineProperty(this, 'connections', {
get: util.deprecate(function() { get: internalUtil.deprecate(function() {
if (self._usingSlaves) { if (self._usingSlaves) {
return null; return null;
} }
return self._connections; return self._connections;
}, 'connections property is deprecated. Use getConnections() method'), }, 'Server.connections property is deprecated. ' +
set: util.deprecate(function(val) { 'Use Server.getConnections method instead.'),
set: internalUtil.deprecate(function(val) {
return (self._connections = val); return (self._connections = val);
}, 'connections property is deprecated. Use getConnections() method'), }, 'Server.connections property is deprecated.'),
configurable: true, enumerable: false configurable: true, enumerable: false
}); });
@ -1498,9 +1500,9 @@ function emitCloseNT(self) {
} }
Server.prototype.listenFD = util.deprecate(function(fd, type) { Server.prototype.listenFD = internalUtil.deprecate(function(fd, type) {
return this.listen({ fd: fd }); return this.listen({ fd: fd });
}, 'listenFD is deprecated. Use listen({fd: <number>}).'); }, 'Server.listenFD is deprecated. Use Server.listen({fd: <number>}) instead.');
Server.prototype._setupSlave = function(socketList) { Server.prototype._setupSlave = function(socketList) {
this._usingSlaves = true; this._usingSlaves = true;

6
lib/os.js
View File

@ -2,6 +2,7 @@
const binding = process.binding('os'); const binding = process.binding('os');
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const isWindows = process.platform === 'win32'; const isWindows = process.platform === 'win32';
exports.hostname = binding.getHostname; exports.hostname = binding.getHostname;
@ -46,9 +47,10 @@ exports.tmpdir = function() {
exports.tmpDir = exports.tmpdir; exports.tmpDir = exports.tmpdir;
exports.getNetworkInterfaces = util.deprecate(function() { exports.getNetworkInterfaces = internalUtil.deprecate(function() {
return exports.networkInterfaces(); return exports.networkInterfaces();
}, 'getNetworkInterfaces is now called `os.networkInterfaces`.'); }, 'os.getNetworkInterfaces is deprecated. ' +
'Use os.networkInterfaces instead.');
exports.EOL = isWindows ? '\r\n' : '\n'; exports.EOL = isWindows ? '\r\n' : '\n';

6
lib/readline.js
View File

@ -9,6 +9,7 @@
const kHistorySize = 30; const kHistorySize = 30;
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const inherits = util.inherits; const inherits = util.inherits;
const Buffer = require('buffer').Buffer; const Buffer = require('buffer').Buffer;
const EventEmitter = require('events').EventEmitter; const EventEmitter = require('events').EventEmitter;
@ -1417,8 +1418,9 @@ function codePointAt(str, index) {
} }
return code; return code;
} }
exports.codePointAt = util.deprecate(codePointAt, exports.codePointAt = internalUtil.deprecate(codePointAt,
'codePointAt() is deprecated. Use String.prototype.codePointAt'); 'readline.codePointAt is deprecated. ' +
'Use String.prototype.codePointAt instead.');
/** /**

3
lib/smalloc.js
View File

@ -3,4 +3,5 @@
const util = require('internal/util'); const util = require('internal/util');
module.exports = require('internal/smalloc'); module.exports = require('internal/smalloc');
util.printDeprecationMessage('smalloc is deprecated.'); util.printDeprecationMessage('smalloc is deprecated. ' +
'Use typed arrays instead.');

6
lib/tty.js
View File

@ -1,6 +1,7 @@
'use strict'; 'use strict';
const util = require('util'); const util = require('util');
const internalUtil = require('internal/util');
const net = require('net'); const net = require('net');
const TTY = process.binding('tty_wrap').TTY; const TTY = process.binding('tty_wrap').TTY;
const isTTY = process.binding('tty_wrap').isTTY; const isTTY = process.binding('tty_wrap').isTTY;
@ -14,12 +15,13 @@ exports.isatty = function(fd) {
// backwards-compat // backwards-compat
exports.setRawMode = util.deprecate(function(flag) { exports.setRawMode = internalUtil.deprecate(function(flag) {
if (!process.stdin.isTTY) { if (!process.stdin.isTTY) {
throw new Error('can\'t set raw mode on non-tty'); throw new Error('can\'t set raw mode on non-tty');
} }
process.stdin.setRawMode(flag); process.stdin.setRawMode(flag);
}, 'tty.setRawMode: Use `process.stdin.setRawMode()` instead.'); }, 'tty.setRawMode is deprecated. ' +
'Use process.stdin.setRawMode instead.');
function ReadStream(fd, options) { function ReadStream(fd, options) {

34
lib/util.js
View File

@ -48,7 +48,7 @@ exports.format = function(f) {
}; };
exports.deprecate = internalUtil.deprecate; exports.deprecate = internalUtil._deprecate;
var debugs = {}; var debugs = {};
@ -730,50 +730,50 @@ function hasOwnProperty(obj, prop) {
// Deprecated old stuff. // Deprecated old stuff.
exports.p = exports.deprecate(function() { exports.p = internalUtil.deprecate(function() {
for (var i = 0, len = arguments.length; i < len; ++i) { for (var i = 0, len = arguments.length; i < len; ++i) {
console.error(exports.inspect(arguments[i])); console.error(exports.inspect(arguments[i]));
} }
}, 'util.p: Use console.error() instead'); }, 'util.p is deprecated. Use console.error instead.');
exports.exec = exports.deprecate(function() { exports.exec = internalUtil.deprecate(function() {
return require('child_process').exec.apply(this, arguments); return require('child_process').exec.apply(this, arguments);
}, 'util.exec is now called `child_process.exec`.'); }, 'util.exec is deprecated. Use child_process.exec instead.');
exports.print = exports.deprecate(function() { exports.print = internalUtil.deprecate(function() {
for (var i = 0, len = arguments.length; i < len; ++i) { for (var i = 0, len = arguments.length; i < len; ++i) {
process.stdout.write(String(arguments[i])); process.stdout.write(String(arguments[i]));
} }
}, 'util.print: Use console.log instead'); }, 'util.print is deprecated. Use console.log instead.');
exports.puts = exports.deprecate(function() { exports.puts = internalUtil.deprecate(function() {
for (var i = 0, len = arguments.length; i < len; ++i) { for (var i = 0, len = arguments.length; i < len; ++i) {
process.stdout.write(arguments[i] + '\n'); process.stdout.write(arguments[i] + '\n');
} }
}, 'util.puts: Use console.log instead'); }, 'util.puts is deprecated. Use console.log instead.');
exports.debug = exports.deprecate(function(x) { exports.debug = internalUtil.deprecate(function(x) {
process.stderr.write('DEBUG: ' + x + '\n'); process.stderr.write('DEBUG: ' + x + '\n');
}, 'util.debug: Use console.error instead'); }, 'util.debug is deprecated. Use console.error instead.');
exports.error = exports.deprecate(function(x) { exports.error = internalUtil.deprecate(function(x) {
for (var i = 0, len = arguments.length; i < len; ++i) { for (var i = 0, len = arguments.length; i < len; ++i) {
process.stderr.write(arguments[i] + '\n'); process.stderr.write(arguments[i] + '\n');
} }
}, 'util.error: Use console.error instead'); }, 'util.error is deprecated. Use console.error instead.');
exports.pump = exports.deprecate(function(readStream, writeStream, callback) { exports.pump = internalUtil.deprecate(function(readStream, writeStream, cb) {
var callbackCalled = false; var callbackCalled = false;
function call(a, b, c) { function call(a, b, c) {
if (callback && !callbackCalled) { if (cb && !callbackCalled) {
callback(a, b, c); cb(a, b, c);
callbackCalled = true; callbackCalled = true;
} }
} }
@ -803,7 +803,7 @@ exports.pump = exports.deprecate(function(readStream, writeStream, callback) {
readStream.destroy(); readStream.destroy();
call(err); call(err);
}); });
}, 'util.pump(): Use readableStream.pipe() instead'); }, 'util.pump is deprecated. Use readableStream.pipe instead.');
exports._errnoException = function(err, syscall, original) { exports._errnoException = function(err, syscall, original) {

6
test/fixtures/deprecated-userland-function.js
View File

@ -0,0 +1,6 @@
const util = require('util');
function deprecatedFunction() {
}
util.deprecate(deprecatedFunction, 'deprecatedFunction is deprecated.')();

18
test/sequential/test-deprecation-flags.js
View File

@ -5,6 +5,9 @@ var execFile = require('child_process').execFile;
var depmod = require.resolve('../fixtures/deprecated.js'); var depmod = require.resolve('../fixtures/deprecated.js');
var node = process.execPath; var node = process.execPath;
var depUserland =
require.resolve('../fixtures/deprecated-userland-function.js');
var normal = [depmod]; var normal = [depmod];
var noDep = ['--no-deprecation', depmod]; var noDep = ['--no-deprecation', depmod];
var traceDep = ['--trace-deprecation', depmod]; var traceDep = ['--trace-deprecation', depmod];
@ -13,8 +16,8 @@ execFile(node, normal, function(er, stdout, stderr) {
console.error('normal: show deprecation warning'); console.error('normal: show deprecation warning');
assert.equal(er, null); assert.equal(er, null);
assert.equal(stdout, ''); assert.equal(stdout, '');
assert.equal(stderr, assert.equal(stderr, '(node) util.p is deprecated. Use console.error ' +
'util.p: Use console.error() instead\n\'This is deprecated\'\n'); 'instead.\n\'This is deprecated\'\n');
console.log('normal ok'); console.log('normal ok');
}); });
@ -32,7 +35,16 @@ execFile(node, traceDep, function(er, stdout, stderr) {
assert.equal(stdout, ''); assert.equal(stdout, '');
var stack = stderr.trim().split('\n'); var stack = stderr.trim().split('\n');
// just check the top and bottom. // just check the top and bottom.
assert.equal(stack[0], 'Trace: util.p: Use console.error() instead'); assert.equal(stack[0],
'Trace: util.p is deprecated. Use console.error instead.');
assert.equal(stack.pop(), '\'This is deprecated\''); assert.equal(stack.pop(), '\'This is deprecated\'');
console.log('trace ok'); console.log('trace ok');
}); });
execFile(node, [depUserland], function(er, stdout, stderr) {
console.error('normal: testing deprecated userland function');
assert.equal(er, null);
assert.equal(stdout, '');
assert.equal(0, stderr.indexOf('deprecatedFunction is deprecated.'));
console.error('normal: ok');
});

Write Preview
Loading…
Cancel
Save