buffer: inspect extra properties

BridgeAR · BridgeAR · commit d385e2cc5a85 · 2018-12-27T22:32:23.000+01:00
This makes sure extra properties on buffers are not ignored anymore when inspecting the buffer. PR-URL: #25150 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/lib/buffer.js b/lib/buffer.js
@@ -38,6 +38,13 @@ const {
   kStringMaxLength
 } = internalBinding('buffer');
 const { isAnyArrayBuffer } = internalBinding('types');
+const {
+  getOwnNonIndexProperties,
+  propertyFilter: {
+    ALL_PROPERTIES,
+    ONLY_ENUMERABLE
+  }
+} = internalBinding('util');
 const {
   customInspectSymbol,
   isInsideNodeModules,
@@ -48,6 +55,10 @@ const {
   isArrayBufferView,
   isUint8Array
 } = require('internal/util/types');
+const {
+  formatProperty,
+  kObjectType
+} = require('internal/util/inspect');
 
 const {
   ERR_BUFFER_OUT_OF_BOUNDS,
@@ -671,10 +682,20 @@ Buffer.prototype.equals = function equals(otherBuffer) {
 Buffer.prototype[customInspectSymbol] = function inspect(recurseTimes, ctx) {
   const max = exports.INSPECT_MAX_BYTES;
   const actualMax = Math.min(max, this.length);
-  let str = this.hexSlice(0, actualMax).replace(/(.{2})/g, '$1 ').trim();
   const remaining = this.length - max;
+  let str = this.hexSlice(0, actualMax).replace(/(.{2})/g, '$1 ').trim();
   if (remaining > 0)
     str += ` ... ${remaining} more byte${remaining > 1 ? 's' : ''}`;
+  // Inspect special properties as well, if possible.
+  if (ctx) {
+    const filter = ctx.showHidden ? ALL_PROPERTIES : ONLY_ENUMERABLE;
+    str += getOwnNonIndexProperties(this, filter).reduce((str, key) => {
+      // Using `formatProperty()` expects an indentationLvl to be set.
+      ctx.indentationLvl = 0;
+      str += `, ${formatProperty(ctx, this, recurseTimes, key, kObjectType)}`;
+      return str;
+    }, '');
+  }
   return `<${this.constructor.name} ${str}>`;
 };
 Buffer.prototype.inspect = Buffer.prototype[customInspectSymbol];
diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js
@@ -1217,5 +1217,7 @@ function reduceToSingleString(ctx, output, base, braces) {
 }
 
 module.exports = {
-  inspect
+  inspect,
+  formatProperty,
+  kObjectType
 };
diff --git a/test/parallel/test-buffer-inspect.js b/test/parallel/test-buffer-inspect.js
@@ -55,4 +55,4 @@ assert.strictEqual(util.inspect(b), expected);
 assert.strictEqual(util.inspect(s), expected);
 
 b.inspect = undefined;
-assert.strictEqual(util.inspect(b), expected);
+assert.strictEqual(util.inspect(b), '<Buffer 31 32, inspect: undefined>');

Original file line number	Diff line number	Diff line change
`@@ -1217,5 +1217,7 @@ function reduceToSingleString(ctx, output, base, braces) {`
`1217`	`1217`	`}`
`1218`	`1218`
`1219`	`1219`	`module.exports = {`
`1220`		`- inspect`
	`1220`	`+ inspect,`
	`1221`	`+ formatProperty,`
	`1222`	`+ kObjectType`
`1221`	`1223`	`};`