util,console: handle symbols as defined in the spec

The `console` functions rely on the `util.format()` behavior. It
did not follow the whatwg spec when it comes to symbols in combination
with the %d, %i and %f format specifiers. Using a symbol argument in
combination with one of these specifiers resulted in an error instead
of returning `'NaN'`. This is now fixed by this patch.
PR-URL: #23708
Refs: https://console.spec.whatwg.org/#formatter
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

Author: BridgeAR

doc/api/util.md

@@ -183,6 +183,10 @@ property take precedence over `--trace-deprecation` and
 <!-- YAML
 added: v0.5.3
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/23708
+ description: The `%d`, `%f` and `%i` specifiers now support Symbols
+ properly.
  - version: REPLACEME
  pr-url: https://github.com/nodejs/node/pull/REPLACEME
  description: The `%o` specifier's `depth` has default depth of 4 again.

lib/util.js

@@ -106,6 +106,8 @@ function formatWithOptions(inspectOptions, f) {
 // eslint-disable-next-line valid-typeof
 if(typeoftempNum==='bigint'){
 tempStr=`${tempNum}n`;
+}elseif(typeoftempNum==='symbol'){
+tempStr='NaN';
 }else{
 tempStr=`${Number(tempNum)}`;
 }
@@ -128,12 +130,19 @@ function formatWithOptions(inspectOptions, f) {
 // eslint-disable-next-line valid-typeof
 if(typeoftempInteger==='bigint'){
 tempStr=`${tempInteger}n`;
+}elseif(typeoftempInteger==='symbol'){
+tempStr='NaN';
 }else{
 tempStr=`${parseInt(tempInteger)}`;
 }
 break;
 case102: // 'f'
-tempStr=`${parseFloat(arguments[a++])}`;
+consttempFloat=arguments[a++];
+if(typeoftempFloat==='symbol'){
+tempStr='NaN';
+}else{
+tempStr=`${parseFloat(tempFloat)}`;
+}
 break;
 case37: // '%'
 str+=f.slice(lastPos,i);

test/parallel/test-util-format.js

@@ -44,18 +44,6 @@ assert.strictEqual(util.format(symbol), 'Symbol(foo)');
 assert.strictEqual(util.format('foo',symbol),'foo Symbol(foo)');
 assert.strictEqual(util.format('%s',symbol),'Symbol(foo)');
 assert.strictEqual(util.format('%j',symbol),'undefined');
-assert.throws(
-()=>{util.format('%d',symbol);},
-(e)=>{
-// The error should be a TypeError.
-if(!(einstanceofTypeError))
-returnfalse;
-
-// The error should be from the JS engine and not from Node.js.
-// JS engine errors do not have the `code` property.
-returne.code===undefined;
-}
-);
 
 // Number format specifier
 assert.strictEqual(util.format('%d'),'%d');
@@ -66,6 +54,7 @@ assert.strictEqual(util.format('%d', '42.0'), '42');
 assert.strictEqual(util.format('%d',1.5),'1.5');
 assert.strictEqual(util.format('%d',-0.5),'-0.5');
 assert.strictEqual(util.format('%d',''),'0');
+assert.strictEqual(util.format('%d',Symbol()),'NaN');
 assert.strictEqual(util.format('%d %d',42,43),'42 43');
 assert.strictEqual(util.format('%d %d',42),'42 %d');
 assert.strictEqual(
@@ -90,6 +79,7 @@ assert.strictEqual(util.format('%i', '42.0'), '42');
 assert.strictEqual(util.format('%i',1.5),'1');
 assert.strictEqual(util.format('%i',-0.5),'0');
 assert.strictEqual(util.format('%i',''),'NaN');
+assert.strictEqual(util.format('%i',Symbol()),'NaN');
 assert.strictEqual(util.format('%i %i',42,43),'42 43');
 assert.strictEqual(util.format('%i %i',42),'42 %i');
 assert.strictEqual(
@@ -125,6 +115,8 @@ assert.strictEqual(util.format('%f', 1.5), '1.5');
 assert.strictEqual(util.format('%f',-0.5),'-0.5');
 assert.strictEqual(util.format('%f',Math.PI),'3.141592653589793');
 assert.strictEqual(util.format('%f',''),'NaN');
+assert.strictEqual(util.format('%f',Symbol('foo')),'NaN');
+assert.strictEqual(util.format('%f',5n),'5');
 assert.strictEqual(util.format('%f %f',42,43),'42 43');
 assert.strictEqual(util.format('%f %f',42),'42 %f');