util: do not reduce to a single line if not appropriate using inspect

BridgeAR · danielleadams · commit 2c7f17c72c87 · 2022-01-31T23:54:08.000-05:00
This makes sure entries are not lined up on a single line if the content contains any new line. That would otherwise cause confusing output. Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de> PR-URL: #41083 Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js
@@ -1931,8 +1931,11 @@ function reduceToSingleString(
         const start = output.length + ctx.indentationLvl +
                       braces[0].length + base.length + 10;
         if (isBelowBreakLength(ctx, output, start, base)) {
-          return `${base ? `${base} ` : ''}${braces[0]} ${join(output, ', ')}` +
-            ` ${braces[1]}`;
+          const joinedOutput = join(output, ', ');
+          if (!joinedOutput.includes('\n')) {
+            return `${base ? `${base} ` : ''}${braces[0]} ${joinedOutput}` +
+              ` ${braces[1]}`;
+          }
         }
       }
     }
diff --git a/test/parallel/test-util-inspect.js b/test/parallel/test-util-inspect.js
@@ -2631,6 +2631,24 @@ assert.strictEqual(
 
   assert.strictEqual(out, expected);
 
+  // Array grouping should prevent lining up outer elements on a single line.
+  obj = [[[1, 2, 3, 4, 5, 6, 7, 8, 9]]];
+
+  out = util.inspect(obj, { compact: 3 });
+
+  expected = [
+    '[',
+    '  [',
+    '    [',
+    '      1, 2, 3, 4, 5,',
+    '      6, 7, 8, 9',
+    '    ]',
+    '  ]',
+    ']',
+  ].join('\n');
+
+  assert.strictEqual(out, expected);
+
   // Verify that array grouping and line consolidation does not happen together.
   obj = {
     a: {

Original file line number	Diff line number	Diff line change
`@@ -1931,8 +1931,11 @@ function reduceToSingleString(`
`1931`	`1931`	`const start = output.length + ctx.indentationLvl +`
`1932`	`1932`	`braces[0].length + base.length + 10;`
`1933`	`1933`	`if (isBelowBreakLength(ctx, output, start, base)) {`
`1934`		- return `${base ? `${base} ` : ''}${braces[0]} ${join(output, ', ')}` +
`1935`		- ` ${braces[1]}`;
	`1934`	`+ const joinedOutput = join(output, ', ');`
	`1935`	`+ if (!joinedOutput.includes('\n')) {`
	`1936`	+ return `${base ? `${base} ` : ''}${braces[0]} ${joinedOutput}` +
	`1937`	+ ` ${braces[1]}`;
	`1938`	`+ }`
`1936`	`1939`	`}`
`1937`	`1940`	`}`
`1938`	`1941`	`}`