assert: show diff when doing partial comparisons with a custom message

[puskin94]

following the same reasoning as this PR:

right now the method assert.partialDeepStrictEqual does not show the diff when the assertion fails.
With this PR we go from this:

const assert = require('assert');

assert.partialDeepStrictEqual([1, 2, 3, 5], [4, 5]);

to this

with a custom error message:

Relevant changes:

1. enabled the diff when assert.partialDeepStrictEqual fails
2. enabled the diff when assert.partialDeepStrictEqual fails with a custom error message
3. added different diff style in case assert.partialDeepStrictEqual fails:

• properties available in actual are gray
• properties in expected but not in actual are prefixed with the classic red -
• properties present in both actual and expected are white

[BridgeAR]

How to show the diff for the partial implementation has been one of my main concerns for a while and my current idea is to grey out or hide all lines that are not in the expected object. That way it would be more straight forward for the user.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.54%. Comparing base (3851edf) to head (0018ef3).
Report is 168 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #56211      +/-   ##
==========================================
+ Coverage   88.49%   88.54%   +0.04%     
==========================================
  Files         656      657       +1     
  Lines      189261   190668    +1407     
  Branches    36348    36595     +247     
==========================================
+ Hits       167493   168833    +1340     
- Misses      14977    15019      +42     
- Partials     6791     6816      +25     

Files with missing lines	Coverage Δ
lib/assert.js	99.37% <100.00%> (+0.27%)	⬆️
lib/internal/assert/assertion_error.js	95.44% <100.00%> (+0.07%)	⬆️
lib/internal/assert/myers_diff.js	90.05% <100.00%> (+0.23%)	⬆️

... and 75 files with indirect coverage changes

[puskin94]

Is there anything left to be done here?

[BridgeAR]

LGTM!

Let's see how people react to the greyed out part to gather feedback while it's experimental. I feel it is nicer than the green plus.

[nodejs-github-bot]

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

[puskin94]

Is anything else needed here?

[BridgeAR]

Still LGTM

[nodejs-github-bot]

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

[nodejs-github-bot]

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

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/56211
✔  Done loading data for nodejs/node/pull/56211
----------------------------------- PR info ------------------------------------
Title      assert: show diff when doing partial comparisons with a custom message (#56211)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     puskin94:partial-deep-strict-equal-custom-message-diff -> nodejs:main
Labels     assert, needs-ci
Commits    1
 - assert: show diff when doing partial comparisons
Committers 1
 - Giovanni <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/56211
Reviewed-By: Ruben Bridgewater <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/56211
Reviewed-By: Ruben Bridgewater <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 10 Dec 2024 15:24:35 GMT
   ✔  Approvals: 1
   ✔  - Ruben Bridgewater (@BridgeAR) (TSC): https://github.com/nodejs/node/pull/56211#pullrequestreview-2530930488
   ✘  Last GitHub CI failed
   ℹ  Last Full PR CI on 2025-01-06T16:25:01Z: https://ci.nodejs.org/job/node-test-pull-request/64369/
- Querying data for job/node-test-pull-request/64369/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/12638165059

[nodejs-github-bot]

Landed in 799d920