util: Change how Error objects are formatted #4582

zeusdeux · 2016-01-08T10:39:52Z

Previously, Error objects were formatted as the result of a toString
call bounded by square brackets. They are now formatted as the stack
trace for the given error object. The intention initially was to emulate
how browsers do console.error but since that would also impact
console.warn, console.log, etc, it was decided to make the change at
util.inspect level which is in turn used by the console package.

This is definitely a semver-major change.

Bigger discussion @ #4452

jasnell · 2016-01-08T16:27:54Z

test/parallel/test-util-format.js

@@ -55,13 +55,16 @@ assert.equal(util.format('%%%s%%%%', 'hi'), '%hi%%');
 })();

 // Errors
-assert.equal(util.format(new Error('foo')), '[Error: foo]');
+const err = new Error('foo');


While you're working in this file, can you change the require() statements at the top to use const as well?

Doing this in both test-util-format.js and test-util-inspect.js.

jasnell · 2016-01-08T16:29:08Z

LGTM
But I'd like to get other @nodejs/ctc opinions also

bnoordhuis · 2016-01-08T19:33:05Z

LGTM-ish in that I think it's a useful change. Less LGTM in that it probably doesn't format well when you util.inspect() an object graph with an Error object a few levels deep.

zeusdeux · 2016-01-08T22:38:56Z

@bnoordhuis It does format kinda weird when there is an error object as a part of another object/array but the behaviour is now similar to that in browsers. It looks something like below:

{ a: 10,
  b:
   { c: 'nope',
     d:
      Error
          at repl:1:40
          at REPLServer.defaultEval (repl.js:252:27)
          at bound (domain.js:287:14)
          at REPLServer.runBound [as eval] (domain.js:300:12)
          at REPLServer.<anonymous> (repl.js:417:12)
          at emitOne (events.js:83:20)
          at REPLServer.emit (events.js:170:7)
          at REPLServer.Interface._onLine (readline.js:215:10)
          at REPLServer.Interface._line (readline.js:554:8)
          at REPLServer.Interface._ttyWrite (readline.js:831:14) } }

Previously, Error objects were formatted as the result of a `toString` call bounded by square brackets. They are now formatted as the stack trace for the given error object. The intention initially was to emulate how browsers do `console.error` but since that would also impact `console.warn`, `console.log`, etc, it was decided to make the change at `util.inspect` level which is in turn used by the `console` package. Fixes: nodejs#4452

zeusdeux · 2016-01-08T23:08:34Z

lib/util.js

@@ -488,7 +488,7 @@ function formatPrimitiveNoColor(ctx, value) {


 function formatError(value) {
-  return '[' + Error.prototype.toString.call(value) + ']';
+  return value.stack || '[' + Error.prototype.toString.call(value) + ']';


Added fallback in case the error is some custom error that isn't capturing the stack correctly.

Can you add a regression test for that? EDIT: Nevermind, I see BadCustomError covers that.

bnoordhuis · 2016-01-09T14:08:17Z

LGTM. One more sign-off would be good.

bnoordhuis · 2016-01-09T14:09:12Z

CI: https://ci.nodejs.org/job/node-test-pull-request/1175/

trevnorris · 2016-01-09T17:27:24Z

LGTM

cjihrig · 2016-01-09T17:59:31Z

LGTM

Previously, Error objects were formatted as the result of a `toString` call bounded by square brackets. They are now formatted as the stack trace for the given error object. The intention initially was to emulate how browsers do `console.error` but since that would also impact `console.warn`, `console.log`, etc, it was decided to make the change at `util.inspect` level which is in turn used by the `console` package. Fixes: #4452 PR-URL: #4582 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Trevor Norris <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>

jasnell · 2016-01-11T17:58:13Z

Landed in e2f47f5

Previously, Error objects were formatted as the result of a `toString` call bounded by square brackets. They are now formatted as the stack trace for the given error object. The intention initially was to emulate how browsers do `console.error` but since that would also impact `console.warn`, `console.log`, etc, it was decided to make the change at `util.inspect` level which is in turn used by the `console` package. Fixes: nodejs#4452 PR-URL: nodejs#4582 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Trevor Norris <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>

The following significant (semver-major) changes have been made since the previous Node v5.0.0 release. * Buffer * New Buffer constructors have been added [#4682](#4682) * Previously deprecated Buffer APIs are removed [#5048](#5048), [#4594](#4594) * Improved error handling [#4514](#4514) * Cluster * Worker emitted as first argument in 'message' event [#5361](#5361). * Crypto * Improved error handling [#3100](#3100), [#5611](#5611) * Simplified Certificate class bindings [#5382](#5382) * Improved control over FIPS mode [#5181](#5181) * pbkdf2 digest overloading is deprecated [#4047](#4047) * Dependencies * Reintroduce shared c-ares build support [#5775](#5775). * V8 updated to 5.0.71.31 [#6111](#6111). * DNS * Add resolvePtr API to query plain DNS PTR records [#4921](#4921). * Domains * Clear stack when no error handler [#4659](#4659). * File System * The `fs.realpath()` and `fs.realpathSync()` methods have been updated to use a more efficient libuv implementation. This change includes the removal of the `cache` argument and the method can throw new errors [#3594](#3594) * FS apis can now accept and return paths as Buffers [#5616](#5616). * Error handling and type checking improvements [#5616](#5616), [#5590](#5590), [#4518](#4518), [#3917](#3917). * fs.read's string interface is deprecated [#4525](#4525) * HTTP * 'clientError' can now be used to return custom errors from an HTTP server [#4557](#4557). * Modules * Current directory is now prioritized for local lookups [#5689](#5689) * Symbolic links are preserved when requiring modules [#5950](#5950) * Net * DNS hints no longer implicitly set [#6021](#6021). * Improved error handling and type checking [#5981](#5981), [#5733](#5733), [#2904](#2904) * Path * Improved type checking [#5348](#5348). * Process * Introduce process warnings API [#4782](#4782). * Throw exception when non-function passed to nextTick [#3860](#3860). * Readline * Emit key info unconditionally [#6024](#6024) * REPL * Assignment to `_` will emit a warning. [#5535](#5535) * Timers * Fail early when callback is not a function [#4362](#4362) * TLS * Rename 'clientError' to 'tlsClientError' [#4557](#4557) * SHA1 used for sessionIdContext [#3866](#3866) * TTY * Previously deprecated setRawMode wrapper is removed [#2528](#2528). * Util * Changes to Error object formatting [#4582](#4582). * Windows * Windows XP and Vista are no longer supported [#5167](#5167), [#5167](#5167).

The following significant (semver-major) changes have been made since the previous Node v5.0.0 release. * Buffer * New Buffer constructors have been added [#4682](#4682) * Previously deprecated Buffer APIs are removed [#5048](#5048), [#4594](#4594) * Improved error handling [#4514](#4514) * Cluster * Worker emitted as first argument in 'message' event [#5361](#5361). * Crypto * Improved error handling [#3100](#3100), [#5611](#5611) * Simplified Certificate class bindings [#5382](#5382) * Improved control over FIPS mode [#5181](#5181) * pbkdf2 digest overloading is deprecated [#4047](#4047) * Dependencies * Reintroduce shared c-ares build support [#5775](#5775). * V8 updated to 5.0.71.31 [#6111](#6111). * DNS * Add resolvePtr API to query plain DNS PTR records [#4921](#4921). * Domains * Clear stack when no error handler [#4659](#4659). * File System * The `fs.realpath()` and `fs.realpathSync()` methods have been updated to use a more efficient libuv implementation. This change includes the removal of the `cache` argument and the method can throw new errors [#3594](#3594) * FS apis can now accept and return paths as Buffers [#5616](#5616). * Error handling and type checking improvements [#5616](#5616), [#5590](#5590), [#4518](#4518), [#3917](#3917). * fs.read's string interface is deprecated [#4525](#4525) * HTTP * 'clientError' can now be used to return custom errors from an HTTP server [#4557](#4557). * Modules * Current directory is now prioritized for local lookups [#5689](#5689) * Symbolic links are preserved when requiring modules [#5950](#5950) * Net * DNS hints no longer implicitly set [#6021](#6021). * Improved error handling and type checking [#5981](#5981), [#5733](#5733), [#2904](#2904) * OS X * MACOSX_DEPLOYMENT_TARGET has been bumped up to 10.7 [#6402](#6402). * Path * Improved type checking [#5348](#5348). * Process * Introduce process warnings API [#4782](#4782). * Throw exception when non-function passed to nextTick [#3860](#3860). * Readline * Emit key info unconditionally [#6024](#6024) * REPL * Assignment to `_` will emit a warning. [#5535](#5535) * Timers * Fail early when callback is not a function [#4362](#4362) * TLS * Rename 'clientError' to 'tlsClientError' [#4557](#4557) * SHA1 used for sessionIdContext [#3866](#3866) * TTY * Previously deprecated setRawMode wrapper is removed [#2528](#2528). * Util * Changes to Error object formatting [#4582](#4582). * Windows * Windows XP and Vista are no longer supported [#5167](#5167), [#5167](#5167).

targos added util Issues and PRs related to the built-in util module. semver-major PRs that contain breaking changes and should be released in the next major version. labels Jan 8, 2016

jasnell reviewed Jan 8, 2016
View reviewed changes

zeusdeux force-pushed the issue-4452 branch from c39af71 to 0945900 Compare January 8, 2016 16:35

zeusdeux force-pushed the issue-4452 branch from 0945900 to 89a9e0a Compare January 8, 2016 22:39

zeusdeux force-pushed the issue-4452 branch from 89a9e0a to 006a66a Compare January 8, 2016 23:00

zeusdeux reviewed Jan 8, 2016
View reviewed changes

jasnell closed this Jan 11, 2016

jasnell mentioned this pull request Mar 17, 2016

Planning for v6 #5766

Closed

jasnell mentioned this pull request Apr 19, 2016

What is new in v6? #6264

Closed

jasnell mentioned this pull request Apr 26, 2016

2016-04-26, Version 6.0.0 (Current) Release #6383

Closed

mcous mentioned this pull request Apr 28, 2016

Fix deprecation warning and failing test under Node v6 (fixes #70) ericelliott/credential#71

Closed

jmendiara mentioned this pull request May 1, 2017

NodeJS 6 backwards compatible support telefonicaid/logops#36

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: Change how Error objects are formatted #4582

util: Change how Error objects are formatted #4582

zeusdeux commented Jan 8, 2016

jasnell Jan 8, 2016

zeusdeux Jan 8, 2016

jasnell commented Jan 8, 2016

bnoordhuis commented Jan 8, 2016

zeusdeux commented Jan 8, 2016

zeusdeux Jan 8, 2016

bnoordhuis Jan 9, 2016

bnoordhuis commented Jan 9, 2016

bnoordhuis commented Jan 9, 2016

trevnorris commented Jan 9, 2016

cjihrig commented Jan 9, 2016

jasnell commented Jan 11, 2016

util: Change how Error objects are formatted #4582

util: Change how Error objects are formatted #4582

Conversation

zeusdeux commented Jan 8, 2016

jasnell Jan 8, 2016

Choose a reason for hiding this comment

zeusdeux Jan 8, 2016

Choose a reason for hiding this comment

jasnell commented Jan 8, 2016

bnoordhuis commented Jan 8, 2016

zeusdeux commented Jan 8, 2016

zeusdeux Jan 8, 2016

Choose a reason for hiding this comment

bnoordhuis Jan 9, 2016

Choose a reason for hiding this comment

bnoordhuis commented Jan 9, 2016

bnoordhuis commented Jan 9, 2016

trevnorris commented Jan 9, 2016

cjihrig commented Jan 9, 2016

jasnell commented Jan 11, 2016