mirror of
https://github.com/nodejs/node.git
synced 2025-05-03 03:56:02 +00:00
c6656db352
In several places throughout the code we write directly to stderr to report warnings (deprecation, possible eventemitter memory leak). The current design of simply dumping the text to stderr is less than ideal. This PR introduces a new "process warnings" mechanism that emits 'warning' events on the global process object. These are invoked with a `warning` argument whose value is an Error object. By default, these warnings will be printed to stderr. This can be suppressed using the `--no-warnings` and `--no-deprecation` command line flags. For warnings, the 'warning' event will still be emitted by the process, allowing applications to handle the warnings in custom ways. The existing `--no-deprecation` flag will continue to supress all deprecation output generated by the core lib. The `--trace-warnings` command line flag will tell Node.js to print the full stack trace of warnings as part of the default handling. The existing `--no-deprecation`, `--throw-deprecation` and `--trace-deprecation` flags continue to work as they currently do, but the exact output of the warning message is modified to occur on process.nextTick(). The stack trace for the warnings and deprecations preserve and point to the correct call site. A new `process.emitWarning()` API is provided to permit userland to emit warnings and deprecations using the same consistent mechanism. Test cases and documentation are included. PR-URL: https://github.com/nodejs/node/pull/4782 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Wyatt Preul <wpreul@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
93 lines
2.6 KiB
JavaScript
93 lines
2.6 KiB
JavaScript
'use strict';
|
|
|
|
const binding = process.binding('util');
|
|
const prefix = `(${process.release.name}:${process.pid}) `;
|
|
const noDeprecation = process.noDeprecation;
|
|
|
|
exports.getHiddenValue = binding.getHiddenValue;
|
|
exports.setHiddenValue = binding.setHiddenValue;
|
|
|
|
// 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, 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, ctor) {
|
|
if (warned || noDeprecation)
|
|
return true;
|
|
process.emitWarning(msg, 'DeprecationWarning',
|
|
ctor || exports.printDeprecationMessage);
|
|
return true;
|
|
};
|
|
|
|
exports.error = function(msg) {
|
|
const fmt = `${prefix}${msg}`;
|
|
if (arguments.length > 1) {
|
|
const args = new Array(arguments.length);
|
|
args[0] = fmt;
|
|
for (let i = 1; i < arguments.length; ++i)
|
|
args[i] = arguments[i];
|
|
console.error.apply(console, args);
|
|
} else {
|
|
console.error(fmt);
|
|
}
|
|
};
|
|
|
|
exports.trace = function(msg) {
|
|
console.trace(`${prefix}${msg}`);
|
|
};
|
|
|
|
// Mark that a method should not be used.
|
|
// Returns a modified function which warns once by default.
|
|
// If --no-deprecation is set, then it is a no-op.
|
|
exports._deprecate = function(fn, msg) {
|
|
// Allow for deprecating things in the process of starting up.
|
|
if (global.process === undefined) {
|
|
return function() {
|
|
return exports._deprecate(fn, msg).apply(this, arguments);
|
|
};
|
|
}
|
|
|
|
if (process.noDeprecation === true) {
|
|
return fn;
|
|
}
|
|
|
|
var warned = false;
|
|
function deprecated() {
|
|
warned = exports.printDeprecationMessage(msg, warned, deprecated);
|
|
return fn.apply(this, arguments);
|
|
}
|
|
|
|
return deprecated;
|
|
};
|
|
|
|
exports.decorateErrorStack = function decorateErrorStack(err) {
|
|
if (!(exports.isError(err) && err.stack) ||
|
|
exports.getHiddenValue(err, 'node:decorated') === true)
|
|
return;
|
|
|
|
const arrow = exports.getHiddenValue(err, 'node:arrowMessage');
|
|
|
|
if (arrow) {
|
|
err.stack = arrow + err.stack;
|
|
exports.setHiddenValue(err, 'node:decorated', true);
|
|
}
|
|
};
|
|
|
|
exports.isError = function isError(e) {
|
|
return exports.objectToString(e) === '[object Error]' || e instanceof Error;
|
|
};
|
|
|
|
exports.objectToString = function objectToString(o) {
|
|
return Object.prototype.toString.call(o);
|
|
};
|
|
|
|
const noCrypto = !process.versions.openssl;
|
|
exports.assertCrypto = function(exports) {
|
|
if (noCrypto)
|
|
throw new Error('Node.js is not compiled with openssl crypto support');
|
|
};
|