From 37526a5ae869a075d65cd72e4c8ffa40b9736292 Mon Sep 17 00:00:00 2001
From: Roman Reiss <me@silverwind.io>
Date: Mon, 24 Sep 2018 19:45:05 +0200
Subject: [PATCH] util: change inspect's default depth from 2 to 4

When dealing with somewhat deep objects, the default depath of 2 is
often a hindrance when using the console to log said objects. This
changes the default depth to a more reasonable 4.

PR-URL: https://github.com/nodejs/node/pull/23062
---
 doc/api/util.md                          |  5 +++-
 lib/internal/util/inspect.js             |  2 +-
 test/parallel/test-util-inspect-proxy.js | 13 +++++----
 test/parallel/test-util-inspect.js       | 36 +++++++++++++-----------
 4 files changed, 32 insertions(+), 24 deletions(-)

diff --git a/doc/api/util.md b/doc/api/util.md
index 29ba65b760346e..87e4ff4ec2baa8 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -360,6 +360,9 @@ stream.write('With ES6');
 <!-- YAML
 added: v0.3.0
 changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/23062
+    description: The `depth` option now defaults to `4` instead of `2`.
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/22788
     description: The `sorted` option is supported now.
@@ -401,7 +404,7 @@ changes:
   * `depth` {number} Specifies the number of times to recurse while formatting
     the `object`. This is useful for inspecting large complicated objects. To
     make it recurse up to the maximum call stack size pass `Infinity` or `null`.
-    **Default:** `2`.
+    **Default:** `4`.
   * `colors` {boolean} If `true`, the output will be styled with ANSI color
     codes. Colors are customizable, see [Customizing `util.inspect` colors][].
     **Default:** `false`.
diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js
index dc66c5f9dfedd3..089b61cd2db754 100644
--- a/lib/internal/util/inspect.js
+++ b/lib/internal/util/inspect.js
@@ -94,7 +94,7 @@ const hasOwnProperty = uncurryThis(Object.prototype.hasOwnProperty);
 
 const inspectDefaultOptions = Object.seal({
   showHidden: false,
-  depth: 2,
+  depth: 4,
   colors: false,
   customInspect: true,
   showProxy: false,
diff --git a/test/parallel/test-util-inspect-proxy.js b/test/parallel/test-util-inspect-proxy.js
index b3438a625240a2..8cfd4007992fcf 100644
--- a/test/parallel/test-util-inspect-proxy.js
+++ b/test/parallel/test-util-inspect-proxy.js
@@ -50,13 +50,14 @@ const expected1 = 'Proxy [ {}, {} ]';
 const expected2 = 'Proxy [ Proxy [ {}, {} ], {} ]';
 const expected3 = 'Proxy [ Proxy [ Proxy [ {}, {} ], {} ], Proxy [ {}, {} ] ]';
 const expected4 = 'Proxy [ Proxy [ {}, {} ], Proxy [ Proxy [ {}, {} ], {} ] ]';
-const expected5 = 'Proxy [ Proxy [ Proxy [ Proxy [Array], {} ],' +
+const expected5 = 'Proxy [ Proxy [ Proxy [ Proxy [ {}, {} ], {} ],' +
                   ' Proxy [ {}, {} ] ],\n  Proxy [ Proxy [ {}, {} ]' +
-                  ', Proxy [ Proxy [Array], {} ] ] ]';
-const expected6 = 'Proxy [ Proxy [ Proxy [ Proxy [Array], Proxy [Array]' +
-                  ' ],\n    Proxy [ Proxy [Array], Proxy [Array] ] ],\n' +
-                  '  Proxy [ Proxy [ Proxy [Array], Proxy [Array] ],\n' +
-                  '    Proxy [ Proxy [Array], Proxy [Array] ] ] ]';
+                  ', Proxy [ Proxy [ {}, {} ], {} ] ] ]';
+const expected6 = 'Proxy [ Proxy [ Proxy [ Proxy [ Proxy [ {}, {} ], {} ],' +
+                  ' Proxy [ {}, {} ] ],\n    Proxy [ Proxy [ {}, {} ], Proxy' +
+                  ' [ Proxy [ {}, {} ], {} ] ] ],\n  Proxy [ Proxy [ Proxy' +
+                  ' [ Proxy [ {}, {} ], {} ], Proxy [ {}, {} ] ],\n    Proxy' +
+                  ' [ Proxy [ {}, {} ], Proxy [ Proxy [ {}, {} ], {} ] ] ] ]';
 assert.strictEqual(
   util.inspect(proxy1, { showProxy: true, depth: null }),
   expected1);
diff --git a/test/parallel/test-util-inspect.js b/test/parallel/test-util-inspect.js
index 1d37e97897dd34..c8659563179dc6 100644
--- a/test/parallel/test-util-inspect.js
+++ b/test/parallel/test-util-inspect.js
@@ -70,8 +70,10 @@ assert.strictEqual(util.inspect({ a: function*() {} }),
 assert.strictEqual(util.inspect({ a: 1, b: 2 }), '{ a: 1, b: 2 }');
 assert.strictEqual(util.inspect({ 'a': {} }), '{ a: {} }');
 assert.strictEqual(util.inspect({ 'a': { 'b': 2 } }), '{ a: { b: 2 } }');
-assert.strictEqual(util.inspect({ 'a': { 'b': { 'c': { 'd': 2 } } } }),
-                   '{ a: { b: { c: [Object] } } }');
+assert.strictEqual(util.inspect(
+  { 'a': { 'b': { 'c': { 'd': { 'e': { 'f': {} } } } } } }),
+                   '{ a: { b: { c: { d: { e: [Object] } } } } }'
+);
 assert.strictEqual(
   util.inspect({ 'a': { 'b': { 'c': { 'd': 2 } } } }, false, null),
   '{ a: { b: { c: { d: 2 } } } }');
@@ -111,10 +113,12 @@ assert.strictEqual(util.inspect((new JSStream())._externalStream),
 }
 
 assert(/Object/.test(
-  util.inspect({ a: { a: { a: { a: {} } } } }, undefined, undefined, true)
+  util.inspect({ a: { a: { a: { a: { a: { a: {} } } } } } },
+               undefined, undefined, true)
 ));
 assert(!/Object/.test(
-  util.inspect({ a: { a: { a: { a: {} } } } }, undefined, null, true)
+  util.inspect({ a: { a: { a: { a: { a: { a: {} } } } } } },
+               undefined, null, true)
 ));
 
 for (const showHidden of [true, false]) {
@@ -1048,16 +1052,16 @@ if (typeof Symbol !== 'undefined') {
 
 // Empty and circular before depth.
 {
-  const arr = [[[[]]]];
-  assert.strictEqual(util.inspect(arr), '[ [ [ [] ] ] ]');
-  arr[0][0][0][0] = [];
-  assert.strictEqual(util.inspect(arr), '[ [ [ [Array] ] ] ]');
-  arr[0][0][0] = {};
-  assert.strictEqual(util.inspect(arr), '[ [ [ {} ] ] ]');
-  arr[0][0][0] = { a: 2 };
-  assert.strictEqual(util.inspect(arr), '[ [ [ [Object] ] ] ]');
-  arr[0][0][0] = arr;
-  assert.strictEqual(util.inspect(arr), '[ [ [ [Circular] ] ] ]');
+  const arr = [[[[[[]]]]]];
+  assert.strictEqual(util.inspect(arr), '[ [ [ [ [ [] ] ] ] ] ]');
+  arr[0][0][0][0][0][0] = [];
+  assert.strictEqual(util.inspect(arr), '[ [ [ [ [ [Array] ] ] ] ] ]');
+  arr[0][0][0][0][0] = {};
+  assert.strictEqual(util.inspect(arr), '[ [ [ [ [ {} ] ] ] ] ]');
+  arr[0][0][0][0][0] = { a: 2 };
+  assert.strictEqual(util.inspect(arr), '[ [ [ [ [ [Object] ] ] ] ] ]');
+  arr[0][0][0][0][0] = arr;
+  assert.strictEqual(util.inspect(arr), '[ [ [ [ [ [Circular] ] ] ] ] ]');
 }
 
 // Corner cases.
@@ -1145,7 +1149,7 @@ if (typeof Symbol !== 'undefined') {
 // util.inspect.defaultOptions tests.
 {
   const arr = new Array(101).fill();
-  const obj = { a: { a: { a: { a: 1 } } } };
+  const obj = { a: { a: { a: { a: { a: { a: 1 } } } } } };
 
   const oldOptions = Object.assign({}, util.inspect.defaultOptions);
 
@@ -1559,7 +1563,7 @@ util.inspect(process);
     head = head.next = {};
   assert.strictEqual(
     util.inspect(list),
-    '{ next: { next: { next: [Object] } } }'
+    '{ next: { next: { next: { next: { next: [Object] } } } } }'
   );
   const longList = util.inspect(list, { depth: Infinity });
   const match = longList.match(/next/g);