assert: inspect getters

BridgeAR · MylesBorins · commit a9ab28df2c23 · 2018-12-25T02:35:55.000-05:00
While asserting two objects the descriptor is not taken into account. Therefore getters will be triggered as such. This makes sure they are also highlighted in the error message instead of potentially looking identical while the return value of the getter is actually different. PR-URL: #25004 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
diff --git a/lib/internal/assert.js b/lib/internal/assert.js
@@ -56,7 +56,9 @@ function inspectValue(val) {
       breakLength: Infinity,
       // Assert does not detect proxies currently.
       showProxy: false,
-      sorted: true
+      sorted: true,
+      // Inspect getters as we also check them when comparing entries.
+      getters: true
     }
   );
 }
diff --git a/test/parallel/test-assert-deep.js b/test/parallel/test-assert-deep.js
@@ -24,7 +24,8 @@ function re(literals, ...values) {
       customInspect: false,
       maxArrayLength: Infinity,
       breakLength: Infinity,
-      sorted: true
+      sorted: true,
+      getters: true
     });
     // Need to escape special characters.
     result += str;
@@ -1049,3 +1050,24 @@ assert.throws(
   });
   assertDeepAndStrictEqual(a, b);
 }
+
+// Check getters.
+{
+  const a = {
+    get a() { return 5; }
+  };
+  const b = {
+    get a() { return 6; }
+  };
+  assert.throws(
+    () => assert.deepStrictEqual(a, b),
+    {
+      code: 'ERR_ASSERTION',
+      name: 'AssertionError [ERR_ASSERTION]',
+      message: /a: \[Getter: 5]\n-   a: \[Getter: 6]\n  /
+    }
+  );
+
+  // The descriptor is not compared.
+  assertDeepAndStrictEqual(a, { a: 5 });
+}

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,9 @@ function inspectValue(val) {`
`56`	`56`	`breakLength: Infinity,`
`57`	`57`	`// Assert does not detect proxies currently.`
`58`	`58`	`showProxy: false,`
`59`		`- sorted: true`
	`59`	`+ sorted: true,`
	`60`	`+ // Inspect getters as we also check them when comparing entries.`
	`61`	`+ getters: true`
`60`	`62`	`}`
`61`	`63`	`);`
`62`	`64`	`}`