util: gracefully handle unknown colors

BridgeAR · addaleax · commit 2c4864762d2b · 2020-06-19T17:36:21.000+02:00
This makes sure colors that are unknown won't cause an error. This is especially important in case a library wants to use colors defined by Node.js core, if available and fall back to the default otherwise. Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de> PR-URL: #33797 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js
@@ -508,7 +508,8 @@ function stylizeWithColor(str, styleType) {
   const style = inspect.styles[styleType];
   if (style !== undefined) {
     const color = inspect.colors[style];
-    return `\u001b[${color[0]}m${str}\u001b[${color[1]}m`;
+    if (color !== undefined)
+      return `\u001b[${color[0]}m${str}\u001b[${color[1]}m`;
   }
   return str;
 }
diff --git a/test/parallel/test-util-inspect.js b/test/parallel/test-util-inspect.js
@@ -2245,6 +2245,12 @@ assert.strictEqual(
     assert.deepStrictEqual(inspect.colors[bgColor], [40 + i, 49]);
     assert.deepStrictEqual(inspect.colors[`${bgColor}Bright`], [100 + i, 49]);
   });
+
+  // Unknown colors are handled gracefully:
+  const stringStyle = inspect.styles.string;
+  inspect.styles.string = 'UNKNOWN';
+  assert.strictEqual(inspect('foobar', { colors: true }), "'foobar'");
+  inspect.styles.string = stringStyle;
 }
 
 assert.strictEqual(

Original file line number	Diff line number	Diff line change
`@@ -508,7 +508,8 @@ function stylizeWithColor(str, styleType) {`
`508`	`508`	`const style = inspect.styles[styleType];`
`509`	`509`	`if (style !== undefined) {`
`510`	`510`	`const color = inspect.colors[style];`
`511`		- return `\u001b[${color[0]}m${str}\u001b[${color[1]}m`;
	`511`	`+ if (color !== undefined)`
	`512`	+ return `\u001b[${color[0]}m${str}\u001b[${color[1]}m`;
`512`	`513`	`}`
`513`	`514`	`return str;`
`514`	`515`	`}`