util: fix inspected stack indentation

Error stacks and multiline error messages were not correct indented. This is fixed by this patch. PR-URL: #20802 Refs: #20253 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · May 22, 2018 · f0d6a37 · f0d6a37
1 parent 38bc5fb
commit f0d6a37
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 0 deletions.
diff --git a/lib/util.js b/lib/util.js
@@ -600,6 +600,11 @@ function formatValue(ctx, value, recurseTimes) {
       if (base.indexOf('\n    at') === -1) {
         base = `[${base}]`;
       }
+      // The message and the stack have to be indented as well!
+      if (ctx.indentationLvl !== 0) {
+        const indentation = ' '.repeat(ctx.indentationLvl);
+        base = formatError(value).replace(/\n/g, `\n${indentation}`);
+      }
       if (keyLength === 0)
         return base;
     } else if (isAnyArrayBuffer(value)) {

diff --git a/test/message/util_inspect_error.js b/test/message/util_inspect_error.js
@@ -0,0 +1,12 @@
+'use strict';
+
+require('../common');
+const util = require('util');
+
+const err = new Error('foo\nbar');
+
+console.log(util.inspect({ err, nested: { err } }, { compact: true }));
+console.log(util.inspect({ err, nested: { err } }, { compact: false }));
+
+err.foo = 'bar';
+console.log(util.inspect(err, { compact: true, breakLength: 5 }));
diff --git a/test/message/util_inspect_error.out b/test/message/util_inspect_error.out
@@ -0,0 +1,63 @@
+{ err:
+   Error: foo
+   bar
+       at *util_inspect_error*
+       at *
+       at *
+       at *
+       at *
+       at *
+       at *
+       at *
+       at *
+  nested:
+   { err:
+      Error: foo
+      bar
+          at *util_inspect_error*
+          at *
+          at *
+          at *
+          at *
+          at *
+          at *
+          at *
+          at * } }
+{
+  err: Error: foo
+  bar
+      at *util_inspect_error*
+      at *
+      at *
+      at *
+      at *
+      at *
+      at *
+      at *
+      at *,
+  nested: {
+    err: Error: foo
+    bar
+        at *util_inspect_error*
+        at *
+        at *
+        at *
+        at *
+        at *
+        at *
+        at *
+        at *
+  }
+}
+{ Error: foo
+bar
+    at *util_inspect_error*
+    at *
+    at *
+    at *
+    at *
+    at *
+    at *
+    at *
+    at *
+  foo: 'bar' }