[fix] Remove all internal symbols before invoking util.inspect.

winstonjs · Jan 31, 2019 · a7da3e9 · a7da3e9
1 parent b29a596
commit a7da3e9
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 10 deletions.
diff --git a/pretty-print.js b/pretty-print.js
@@ -2,7 +2,7 @@
 
 const inspect = require('util').inspect;
 const format = require('./format');
-const { LEVEL, MESSAGE } = require('triple-beam');
+const { LEVEL, MESSAGE, SPLAT } = require('triple-beam');
 
 /*
  * function prettyPrint (info)
@@ -11,9 +11,18 @@ const { LEVEL, MESSAGE } = require('triple-beam');
  * { prettyPrint: true } to transports in `winston < 3.0.0`.
  */
 module.exports = format((info, opts = {}) => {
-  // info[LEVEL] is enumerable here, so util.inspect would print it; so it must be manually stripped
-  const strippedInfo = Object.assign({}, info);
-  delete strippedInfo[LEVEL];
-  info[MESSAGE] = inspect(strippedInfo, false, opts.depth || null, opts.colorize);
+  //
+  // info[{LEVEL, MESSAGE, SPLAT}] are enumerable here. Since they
+  // are internal, we remove them before util.inspect so they
+  // are not printed.
+  //
+  const {
+    [LEVEL]: level, // eslint-disable-line no-unused-vars
+    [MESSAGE]: message, // eslint-disable-line no-unused-vars
+    [SPLAT]: splat, // eslint-disable-line no-unused-vars
+    ...stripped
+  } = info;
+
+  info[MESSAGE] = inspect(stripped, false, opts.depth || null, opts.colorize);
   return info;
 });
diff --git a/test/pretty-print.test.js b/test/pretty-print.test.js
@@ -3,19 +3,51 @@
 const util = require('util');
 const assume = require('assume');
 const prettyPrint = require('../pretty-print');
-const helpers = require('./helpers');
-const { MESSAGE } = require('triple-beam');
+const { assumeFormatted, infoify } = require('./helpers');
+const { LEVEL, MESSAGE, SPLAT } = require('triple-beam');
 
 describe('prettyPrint', () => {
-  it('prettyPrint() (default) sets info[MESSAGE]', helpers.assumeFormatted(
+  it('prettyPrint() (default) sets info[MESSAGE]', assumeFormatted(
     prettyPrint(),
-    { level: 'info', message: 'yay template strings are fast' },
+    infoify({ level: 'info', message: 'yay template strings are fast' }),
     (info, expected) => {
       assume(info.level).is.a('string');
       assume(info.message).is.a('string');
       assume(info.level).equals('info');
       assume(info.message).equals('yay template strings are fast');
-      assume(info[MESSAGE]).equals(util.inspect(expected));
+
+      const {
+        [LEVEL]: level, // eslint-disable-line no-unused-vars
+        [MESSAGE]: message, // eslint-disable-line no-unused-vars
+        [SPLAT]: splat, // eslint-disable-line no-unused-vars
+        ...stripped
+      } = info;
+
+      assume(info[MESSAGE]).equals(util.inspect(stripped));
+    }
+  ));
+
+  it('prettyPrint() (default) strips info[SPLAT]', assumeFormatted(
+    prettyPrint(),
+    infoify({
+      level: 'info',
+      message: 'yay template strings are fast',
+      [SPLAT]: [1, 2, 3]
+    }),
+    (info, expected) => {
+      assume(info.level).is.a('string');
+      assume(info.message).is.a('string');
+      assume(info.level).equals('info');
+      assume(info.message).equals('yay template strings are fast');
+
+      const {
+        [LEVEL]: level, // eslint-disable-line no-unused-vars
+        [MESSAGE]: message, // eslint-disable-line no-unused-vars
+        [SPLAT]: splat, // eslint-disable-line no-unused-vars
+        ...stripped
+      } = info;
+
+      assume(info[MESSAGE]).equals(util.inspect(stripped));
     }
   ));
 });