assert: improve diff output

The output is now a tiny bit improved by sorting object properties when inspecting the values that are compared with each other. That reduces the overall diff for identical objects with a different property insertion order. Backport-PR-URL: #23226 PR-URL: #22788 Refs: #22763 Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

Author: BridgeAR

lib/internal/assert.js

@@ -43,7 +43,8 @@ function inspectValue(val) {
  // comparison.
  breakLength: Infinity,
  // Assert does not detect proxies currently.
- showProxy: false
+ showProxy: false,
+ sorted: true
  }
  ).split('\n');
 }

test/parallel/test-assert.js

@@ -285,7 +285,7 @@ testAssertionMessage(/abc/gim, '/abc/gim');
 testAssertionMessage(function f() {}, '[Function: f]');
 testAssertionMessage(function() {}, '[Function]');
 testAssertionMessage({}, '{}');
-testAssertionMessage(circular, '{\n- y: 1,\n- x: [Circular]\n- }');
+testAssertionMessage(circular, '{\n- x: [Circular],\n- y: 1\n- }');
 testAssertionMessage({ a: undefined, b: null },
  '{\n- a: undefined,\n- b: null\n- }');
 testAssertionMessage({ a: NaN, b: Infinity, c: -Infinity },
@@ -593,8 +593,8 @@ assert.throws(
  '\n' +
  '- {}\n' +
  '+ {\n' +
- "+ loop: 'forever',\n" +
- '+ [Symbol(nodejs.util.inspect.custom)]: [Function]\n' +
+ '+ [Symbol(nodejs.util.inspect.custom)]: [Function],\n' +
+ "+ loop: 'forever'\n" +
  '+ }'
  });
 
@@ -858,9 +858,12 @@ common.expectsError(
  code: 'ERR_ASSERTION',
  name: 'AssertionError [ERR_ASSERTION]',
  message: `${start}\n${actExp}\n\n` +
- " Comparison {\n name: 'TypeError',\n" +
- " message: 'Wrong value',\n- code: 404\n" +
- '+ code: 404,\n+ foo: undefined\n }'
+ ' Comparison {\n' +
+ ' code: 404,\n' +
+ '+ foo: undefined,\n' +
+ " message: 'Wrong value',\n" +
+ " name: 'TypeError'\n" +
+ ' }'
  }
  );
 
@@ -872,9 +875,13 @@ common.expectsError(
  code: 'ERR_ASSERTION',
  name: 'AssertionError [ERR_ASSERTION]',
  message: `${start}\n${actExp}\n\n` +
- " Comparison {\n name: 'TypeError',\n" +
- " message: 'Wrong value',\n- code: 404\n" +
- "+ code: '404',\n+ foo: undefined\n }"
+ ' Comparison {\n' +
+ '- code: 404,\n' +
+ "+ code: '404',\n" +
+ '+ foo: undefined,\n' +
+ " message: 'Wrong value',\n" +
+ " name: 'TypeError'\n" +
+ ' }'
  }
  );
 
@@ -904,8 +911,11 @@ common.expectsError(
  name: 'AssertionError [ERR_ASSERTION]',
  code: 'ERR_ASSERTION',
  message: `${start}\n${actExp}\n\n` +
- " Comparison {\n- name: 'TypeError',\n+ name: 'Error'," +
- "\n message: 'e'\n }"
+ ' Comparison {\n' +
+ " message: 'e',\n" +
+ "- name: 'TypeError'\n" +
+ "+ name: 'Error'\n" +
+ ' }'
  }
  );
  assert.throws(
@@ -915,8 +925,11 @@ common.expectsError(
  code: 'ERR_ASSERTION',
  generatedMessage: true,
  message: `${start}\n${actExp}\n\n` +
- " Comparison {\n name: 'Error',\n- message: 'foo'" +
- "\n+ message: ''\n }"
+ ' Comparison {\n' +
+ "- message: 'foo',\n" +
+ "+ message: '',\n" +
+ " name: 'Error'\n" +
+ ' }'
  }
  );
 

test/parallel/test-internal-errors.js

@@ -92,7 +92,7 @@ common.expectsError(() => {
 }, {
  code: 'ERR_ASSERTION',
  type: assert.AssertionError,
- message: /-   message: 'Error for testing purposes: a'\n\+   message: \/\^Error/
+ message: /-   message: 'Error for testing purposes: a',\n\+   message: \/\^Error/
 });
 
 // Test ERR_INVALID_FD_TYPE