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

[puskin]

Fixes: #48465

This PR allows some assertion methods to show the diff when 2 data are different and a custom error message is passed

From this:

To this:

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.61%. Comparing base (5949e16) to head (0d996bc).
Report is 326 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #54759   +/-   ##
=======================================
  Coverage   87.60%   87.61%           
=======================================
  Files         650      650           
  Lines      182829   182836    +7     
  Branches    35379    35381    +2     
=======================================
+ Hits       160173   160185   +12     
+ Misses      15928    15926    -2     
+ Partials     6728     6725    -3     

Files with missing lines	Coverage Δ
lib/internal/assert/assertion_error.js	100.00% <100.00%> (ø)

... and 31 files with indirect coverage changes

[pmarchini]

@redyetidev, do you think we should tag someone or ask for a review from the assert/test group?

Edit: Maybe @MoLow would be interested in reviewing this (I saw this #48465 (comment))

[MoLow]

Thanks! LGTM

[avivkeller]

CC @nodejs/assert

[puskin]

Any news on this? is this ready to land?

[puskin]

The PR is ready but the CI is flaky

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/62738/

[jasnell]

Landed in e1d8b4f

[thetutlage]

The related commit introduces an issue when the actual value is computed after creating the error instance. In one of my libraries, I create AssertionError instances ahead of time and throw them later. For example:

const error = new AssertionError({
  message: `Expected prompt validation message to equal ${inspect(message)}`,
  expected: message,
  operator: 'strictEqual',
})

Throwing the above error object after some async operation.

const result = await someAsyncOperation()
error.actual = result

if (error.expected !== error.actual) {
  throw error
}

In the above case, the error.message will have the following output.

AssertionError [ERR_ASSERTION]: Expected prompt validation message to equal 'client is required'
+ actual - expected

+ undefined
- 'client is required'

[thetutlage]

On the side note: There should be a way to disable generating diffs for cases where I want to use a specific library to generate custom diffs