assert: show the diff when deep comparing data with a custom message

puskin · marco-ippolito · commit 085c3441fe10 · 2024-11-17T11:51:41.000+01:00
Fixes: #48465 PR-URL: #54759 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/lib/internal/assert/assertion_error.js b/lib/internal/assert/assertion_error.js
@@ -72,7 +72,11 @@ function inspectValue(val) {
   );
 }
 
-function createErrDiff(actual, expected, operator) {
+function getErrorMessage(operator, message) {
+  return message || kReadableOperator[operator];
+}
+
+function createErrDiff(actual, expected, operator, message = '') {
   let other = '';
   let res = '';
   let end = '';
@@ -110,7 +114,7 @@ function createErrDiff(actual, expected, operator) {
       if ((typeof actual !== 'object' || actual === null) &&
           (typeof expected !== 'object' || expected === null) &&
           (actual !== 0 || expected !== 0)) { // -0 === +0
-        return `${kReadableOperator[operator]}\n\n` +
+        return `${getErrorMessage(operator, message)}\n\n` +
             `${actualLines[0]} !== ${expectedLines[0]}\n`;
       }
     } else if (operator !== 'strictEqualObject') {
@@ -184,8 +188,7 @@ function createErrDiff(actual, expected, operator) {
 
   let printedLines = 0;
   let identical = 0;
-  const msg = kReadableOperator[operator] +
-        `\n${colors.green}+ actual${colors.white} ${colors.red}- expected${colors.white}`;
+  const msg = `${getErrorMessage(operator, message)}\n${colors.green}+ actual${colors.white} ${colors.red}- expected${colors.white}`;
   const skippedMsg = ` ${colors.blue}...${colors.white} Lines skipped`;
 
   let lines = actualLines;
@@ -337,7 +340,11 @@ class AssertionError extends Error {
     if (isErrorStackTraceLimitWritable()) Error.stackTraceLimit = 0;
 
     if (message != null) {
-      super(String(message));
+      if (operator === 'deepStrictEqual' || operator === 'strictEqual') {
+        super(createErrDiff(actual, expected, operator, message));
+      } else {
+        super(String(message));
+      }
     } else {
       // Reset colors on each call to make sure we handle dynamically set environment
       // variables correct.
diff --git a/test/parallel/test-assert.js b/test/parallel/test-assert.js
@@ -391,7 +391,7 @@ test('Test assertion messages', () => {
   assert.throws(
     () => assert.strictEqual(1, 2, 'oh no'),
     {
-      message: 'oh no',
+      message: 'oh no\n\n1 !== 2\n',
       generatedMessage: false
     }
   );
@@ -1203,7 +1203,7 @@ test('Additional assert', () => {
       ),
       {
         actual,
-        message,
+        message: "message\n+ actual - expected\n\n+ 'foobar'\n- {\n-   message: 'foobar'\n- }",
         operator: 'throws',
         generatedMessage: false
       }
@@ -1250,6 +1250,17 @@ test('Additional assert', () => {
     }
   );
 
+  assert.throws(
+    () => {
+      assert.deepStrictEqual({ a: true }, { a: false }, 'custom message');
+    },
+    {
+      code: 'ERR_ASSERTION',
+      name: 'AssertionError',
+      message: 'custom message\n+ actual - expected\n\n  {\n+   a: true\n-   a: false\n  }'
+    }
+  );
+
   {
     let threw = false;
     try {

Original file line number	Diff line number	Diff line change
`@@ -391,7 +391,7 @@ test('Test assertion messages', () => {`
`391`	`391`	`assert.throws(`
`392`	`392`	`() => assert.strictEqual(1, 2, 'oh no'),`
`393`	`393`	`{`
`394`		`- message: 'oh no',`
	`394`	`+ message: 'oh no\n\n1 !== 2\n',`
`395`	`395`	`generatedMessage: false`
`396`	`396`	`}`
`397`	`397`	`);`
`@@ -1203,7 +1203,7 @@ test('Additional assert', () => {`
`1203`	`1203`	`),`
`1204`	`1204`	`{`
`1205`	`1205`	`actual,`
`1206`		`- message,`
	`1206`	`+ message: "message\n+ actual - expected\n\n+ 'foobar'\n- {\n- message: 'foobar'\n- }",`
`1207`	`1207`	`operator: 'throws',`
`1208`	`1208`	`generatedMessage: false`
`1209`	`1209`	`}`
`@@ -1250,6 +1250,17 @@ test('Additional assert', () => {`
`1250`	`1250`	`}`
`1251`	`1251`	`);`
`1252`	`1252`
	`1253`	`+ assert.throws(`
	`1254`	`+ () => {`
	`1255`	`+ assert.deepStrictEqual({ a: true }, { a: false }, 'custom message');`
	`1256`	`+ },`
	`1257`	`+ {`
	`1258`	`+ code: 'ERR_ASSERTION',`
	`1259`	`+ name: 'AssertionError',`
	`1260`	`+ message: 'custom message\n+ actual - expected\n\n {\n+ a: true\n- a: false\n }'`
	`1261`	`+ }`
	`1262`	`+ );`
	`1263`	`+`
`1253`	`1264`	`{`
`1254`	`1265`	`let threw = false;`
`1255`	`1266`	`try {`