util: escape symbol and non-enumerable keys

These keys require escaping as they might also contain line breaks and other special characters.

Author: BridgeAR

lib/util.js

@@ -1256,9 +1256,10 @@ function formatProperty(ctx, value, recurseTimes, key, array) {
  return str;
  }
  if (typeof key === 'symbol') {
- name = `[${ctx.stylize(key.toString(), 'symbol')}]`;
+ const tmp = key.toString().replace(strEscapeSequencesReplacer, escapeFn);
+ name = `[${ctx.stylize(tmp, 'symbol')}]`;
  } else if (desc.enumerable === false) {
- name = `[${key}]`;
+ name = `[${key.replace(strEscapeSequencesReplacer, escapeFn)}]`;
  } else if (keyStrRegExp.test(key)) {
  name = ctx.stylize(key, 'name');
  } else {

test/parallel/test-util-inspect.js

@@ -838,22 +838,22 @@ if (typeof Symbol !== 'undefined') {
  const options = { showHidden: true };
  let subject = {};
 
- subject[Symbol('symbol')] = 42;
+ subject[Symbol('sym\nbol')] = 42;
 
- assert.strictEqual(util.inspect(subject), '{ [Symbol(symbol)]: 42 }');
+ assert.strictEqual(util.inspect(subject), '{ [Symbol(sym\\nbol)]: 42 }');
  assert.strictEqual(
  util.inspect(subject, options),
- '{ [Symbol(symbol)]: 42 }'
+ '{ [Symbol(sym\\nbol)]: 42 }'
  );
 
  Object.defineProperty(
  subject,
  Symbol(),
  { enumerable: false, value: 'non-enum' });
- assert.strictEqual(util.inspect(subject), '{ [Symbol(symbol)]: 42 }');
+ assert.strictEqual(util.inspect(subject), '{ [Symbol(sym\\nbol)]: 42 }');
  assert.strictEqual(
  util.inspect(subject, options),
- "{ [Symbol(symbol)]: 42, [Symbol()]: 'non-enum' }"
+ "{ [Symbol(sym\\nbol)]: 42, [Symbol()]: 'non-enum' }"
  );
 
  subject = [1, 2, 3];
@@ -1637,3 +1637,13 @@ assert.strictEqual(inspect(Object(-1n)), '[BigInt: -1n]');
 assert.strictEqual(inspect(Object(13n)), '[BigInt: 13n]');
 assert.strictEqual(inspect(new BigInt64Array([0n])), 'BigInt64Array [ 0n ]');
 assert.strictEqual(inspect(new BigUint64Array([0n])), 'BigUint64Array [ 0n ]');
+
+// Verify non-enumerable keys get escaped.
+{
+ const obj = {};
+ Object.defineProperty(obj, 'Non\nenumerable\tkey', { value: true });
+ assert.strictEqual(
+ util.inspect(obj, { showHidden: true }),
+ '{ [Non\\nenumerable\\tkey]: true }'
+ );
+}