util: validate formatWithOptions inspectOptions

This makes sure that the `inspectOptions` are validated. This could otherwise cause confusion. Fixes: #29726 PR-URL: #29824 Reviewed-By: Yongsheng Zhang <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
nodejs · Oct 11, 2019 · 2664dac · 2664dac
1 parent 3aeae8d
commit 2664dac
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js
@@ -1542,11 +1542,6 @@ function reduceToSingleString(
   return `${braces[0]}${ln}${join(output, `,\n${indentation}  `)} ${braces[1]}`;
 }
 
-function format(...args) {
-  return formatWithOptions(undefined, ...args);
-}
-
-
 const firstErrorLine = (error) => error.message.split('\n')[0];
 let CIRCULAR_ERROR_MESSAGE;
 function tryStringify(arg) {
@@ -1569,7 +1564,19 @@ function tryStringify(arg) {
   }
 }
 
+function format(...args) {
+  return formatWithOptionsInternal(undefined, ...args);
+}
+
 function formatWithOptions(inspectOptions, ...args) {
+  if (typeof inspectOptions !== 'object' || inspectOptions === null) {
+    throw new ERR_INVALID_ARG_TYPE(
+      'inspectOptions', 'object', inspectOptions);
+  }
+  return formatWithOptionsInternal(inspectOptions, ...args);
+}
+
+function formatWithOptionsInternal(inspectOptions, ...args) {
   const first = args[0];
   let a = 0;
   let str = '';

diff --git a/test/parallel/test-util-format.js b/test/parallel/test-util-format.js
@@ -408,3 +408,20 @@ assert.strictEqual(
   ),
   '[ 1, [Object] ]'
 );
+
+[
+  undefined,
+  null,
+  false,
+  5n,
+  5,
+  'test',
+  Symbol()
+].forEach((invalidOptions) => {
+  assert.throws(() => {
+    util.formatWithOptions(invalidOptions, { a: true });
+  }, {
+    code: 'ERR_INVALID_ARG_TYPE',
+    message: /"inspectOptions".+object/
+  });
+});