Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

util: expose diff function used by the assertion errors #57462

Merged
merged 1 commit into from
Mar 19, 2025
Merged

util: expose diff function used by the assertion errors #57462

merged 1 commit into from
Mar 19, 2025
+257 −16

Conversation

puskin94
Copy link
Contributor

fix: #51740

Exporting the new util.diff(actual, expected) function.

This function is the one internally used by the assert module when an AssertionError occurs and it is just an utility to better show differences between the two params actual and expected.

It is internally using the "new" Myers diff algorithm so you can expect the same output provided by this PR: #54862

@nodejs-github-bot nodejs-github-bot added assert Issues and PRs related to the assert subsystem. needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Mar 14, 2025
@puskin94 puskin94 force-pushed the util-add-diff-function branch from 1905f00 to 480d3c7 Compare March 14, 2025 15:28
@puskin94 puskin94 changed the title util: expose diff function used by the assertion errors. util: expose diff function used by the assertion errors Mar 14, 2025
@codecov Codecov
Copy link

codecov bot commented Mar 14, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 95.65217% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.23%. Comparing base (3329efe) to head (dd09392).
Report is 49 commits behind head on main.

Files with missing lines Patch % Lines
lib/internal/assert/myers_diff.js 85.71% 3 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #57462      +/-   ##
==========================================
+ Coverage   90.20%   90.23%   +0.02%     
==========================================
  Files         629      630       +1     
  Lines      184948   184898      -50     
  Branches    36204    36217      +13     
==========================================
- Hits       166837   166834       -3     
+ Misses      11057    11019      -38     
+ Partials     7054     7045       -9
Files with missing lines Coverage Δ
lib/internal/util/diff.js 100.00% <100.00%> (ø)
lib/util.js 97.75% <100.00%> (+0.04%) ⬆️
lib/internal/assert/myers_diff.js 89.20% <85.71%> (+0.31%) ⬆️

... and 56 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

jasnell
jasnell reviewed Mar 14, 2025
View reviewed changes
jasnell
jasnell approved these changes Mar 14, 2025
View reviewed changes
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code change LGTM with one nit about the docs.

@puskin94 puskin94 force-pushed the util-add-diff-function branch from 480d3c7 to 518712d Compare March 14, 2025 18:00
@benjamingr benjamingr added the notable-change PRs with changes that should be highlighted in changelogs. label Mar 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @benjamingr.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

pmarchini
pmarchini approved these changes Mar 15, 2025
View reviewed changes
Copy link
Member

@pmarchini pmarchini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (only one nit)

BridgeAR
BridgeAR requested changes Mar 16, 2025
View reviewed changes
@puskin94 puskin94 force-pushed the util-add-diff-function branch 2 times, most recently from 549a8b6 to 1a33a1c Compare March 17, 2025 11:11
BridgeAR
BridgeAR reviewed Mar 17, 2025
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks pretty good!

I would still consider changing the output format to be the most performant one we can think of. I would likely change it to: [type, value], where type would be one of -1, 0, 1.

@puskin94 puskin94 force-pushed the util-add-diff-function branch 3 times, most recently from f4b06e7 to fe1f36c Compare March 17, 2025 14:17
BridgeAR
BridgeAR approved these changes Mar 17, 2025
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This is shaping up well!

Two small things, otherwise it's LGTM

@puskin94
util: expose diff function used by the assertion errors

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
dd09392 
fix: nodejs#51740
@puskin94 puskin94 force-pushed the util-add-diff-function branch from fe1f36c to dd09392 Compare March 17, 2025 15:30
@pmarchini pmarchini added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 17, 2025
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 17, 2025
@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@BridgeAR BridgeAR added the semver-minor PRs that contain new features and should be released in the next minor version. label Mar 19, 2025
BridgeAR
BridgeAR approved these changes Mar 19, 2025
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work

@BridgeAR BridgeAR added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 19, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 19, 2025
@nodejs-github-bot nodejs-github-bot merged commit 6b42554 into nodejs:main Mar 19, 2025
66 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 6b42554

aduh95 pushed a commit that referenced this pull request Mar 23, 2025
@puskin94 @aduh95
util: expose diff function used by the assertion errors

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
1b8d1d3 
fix: #51740
PR-URL: #57462
Fixes: #51740
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@github-actions github-actions bot mentioned this pull request Mar 30, 2025
Merged
nodejs-github-bot added a commit that referenced this pull request Mar 30, 2025
@nodejs-github-bot
2025-03-31, Version 23.11.0 (Current)
Loading
Loading status checks…
4c2045d 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) improve partialDeepStrictEqual (Ruben Bridgewater) #57370
assert,util:
  * (SEMVER-MINOR) improve performance (Ruben Bridgewater) #57370
benchmark:
  * (SEMVER-MINOR) adjust assert runtimes (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) skip running some assert benchmarks by default (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) add assert partialDeepStrictEqual benchmark (Ruben Bridgewater) #57370
crypto:
  * (SEMVER-MINOR) add optional callback to crypto.diffieHellman (Filip Skokan) #57274
process:
  * (SEMVER-MINOR) add execve (Paolo Insogna) #56496
sqlite:
  * (SEMVER-MINOR) add StatementSync.prototype.columns() (Colin Ihrig) #57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462

PR-URL: #57694
aduh95 added a commit that referenced this pull request Mar 30, 2025
@nodejs-github-bot @aduh95
2025-03-31, Version 23.11.0 (Current)
Loading
Loading status checks…
bd770fd 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
crypto:
  * (SEMVER-MINOR) add optional callback to `crypto.diffieHellman` (Filip Skokan) #57274
process:
  * (SEMVER-MINOR) add `execve` (Paolo Insogna) #56496
sqlite:
  * (SEMVER-MINOR) add `StatementSync.prototype.columns()` (Colin Ihrig) #57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462

PR-URL: #57694
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
aduh95 added a commit that referenced this pull request Apr 1, 2025
@aduh95
2025-04-01, Version 23.11.0 (Current)
Loading
Loading status checks…
32c6759 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
crypto:
  * (SEMVER-MINOR) add optional callback to `crypto.diffieHellman` (Filip Skokan) #57274
process:
  * (SEMVER-MINOR) add `execve` (Paolo Insogna) #56496
sqlite:
  * (SEMVER-MINOR) add `StatementSync.prototype.columns()` (Colin Ihrig) #57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462

PR-URL: #57694
aduh95 added a commit that referenced this pull request Apr 1, 2025
@aduh95
2025-04-01, Version 23.11.0 (Current)
Loading
Loading status checks…
9ad070e 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
crypto:
  * (SEMVER-MINOR) add optional callback to `crypto.diffieHellman` (Filip Skokan) #57274
process:
  * (SEMVER-MINOR) add `execve` (Paolo Insogna) #56496
sqlite:
  * (SEMVER-MINOR) add `StatementSync.prototype.columns()` (Colin Ihrig) #57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462

PR-URL: #57694
aduh95 added a commit that referenced this pull request Apr 1, 2025
@aduh95
2025-04-01, Version 23.11.0 (Current)
Loading
Loading status checks…
2bfcc1c 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
crypto:
  * (SEMVER-MINOR) add optional callback to `crypto.diffieHellman` (Filip Skokan) #57274
process:
  * (SEMVER-MINOR) add `execve` (Paolo Insogna) #56496
sqlite:
  * (SEMVER-MINOR) add `StatementSync.prototype.columns()` (Colin Ihrig) #57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462

PR-URL: #57694
RafaelGSS pushed a commit that referenced this pull request Apr 1, 2025
@puskin94 @RafaelGSS
util: expose diff function used by the assertion errors
9e293f2 
fix: #51740
PR-URL: #57462
Fixes: #51740
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
RafaelGSS pushed a commit that referenced this pull request Apr 1, 2025
@puskin94 @RafaelGSS
util: expose diff function used by the assertion errors
c42e8f9 
fix: #51740
PR-URL: #57462
Fixes: #51740
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@RafaelGSS RafaelGSS mentioned this pull request Apr 8, 2025
Open
RafaelGSS pushed a commit to RafaelGSS/node that referenced this pull request Apr 8, 2025
@puskin94 @RafaelGSS
util: expose diff function used by the assertion errors
f694179 
fix: nodejs#51740
PR-URL: nodejs#57462
Fixes: nodejs#51740
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
JonasBa pushed a commit to JonasBa/node that referenced this pull request Apr 11, 2025
@aduh95 @JonasBa
2025-04-01, Version 23.11.0 (Current)
de2e317 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) nodejs#57370
crypto:
  * (SEMVER-MINOR) add optional callback to `crypto.diffieHellman` (Filip Skokan) nodejs#57274
process:
  * (SEMVER-MINOR) add `execve` (Paolo Insogna) nodejs#56496
sqlite:
  * (SEMVER-MINOR) add `StatementSync.prototype.columns()` (Colin Ihrig) nodejs#57490
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) nodejs#57462

PR-URL: nodejs#57694
RafaelGSS added a commit that referenced this pull request Apr 11, 2025
@RafaelGSS
2025-04-15, Version 22.15.0 'Jod' (LTS)
Loading
Loading status checks…
5f08eb5 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) improve partialDeepStrictEqual (Ruben Bridgewater) #57370
assert,util:
  * (SEMVER-MINOR) improve performance (Ruben Bridgewater) #57370
benchmark:
  * (SEMVER-MINOR) adjust assert runtimes (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) skip running some assert benchmarks by default (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) add assert partialDeepStrictEqual benchmark (Ruben Bridgewater) #57370
cli:
  * (SEMVER-MINOR) allow --cpu-prof* in NODE_OPTIONS (Carlos Espa) #57018
crypto:
  * update root certificates to NSS 3.108 (Node.js GitHub Bot) #57381
  * (SEMVER-MINOR) support --use-system-ca on Windows (Joyee Cheung) #56833
  * (SEMVER-MINOR) added support for reading certificates from macOS system store (Tim Jacomb) #56599
deps:
  * update timezone to 2025a (Node.js GitHub Bot) #56876
  * (SEMVER-MINOR) update ada to v3.0.1 (Yagiz Nizipli) #56452
deps,tools:
  * (SEMVER-MINOR) add zstd 1.5.6 (Jan Martin) #52100
dns:
  * (SEMVER-MINOR) add TLSA record query and parsing (Rithvik Vibhu) #52983
doc:
  * add @geeksilva97 to collaborators (Edy Silva) #57241
module:
  * (SEMVER-MINOR) use synchronous hooks for preparsing in import(cjs) (Joyee Cheung) #55698
  * (SEMVER-MINOR) implement module.registerHooks() (Joyee Cheung) #55698
process:
  * (SEMVER-MINOR) add execve (Paolo Insogna) #56496
  * (SEMVER-MINOR) add threadCpuUsage (Paolo Insogna) #56467
sqlite:
  * (SEMVER-MINOR) add StatementSync.prototype.columns() (Colin Ihrig) #57490
  * (SEMVER-MINOR) allow returning `ArrayBufferView`s from user-defined functions (René) #56790
src:
  * set signal inspector io thread name (RafaelGSS) #56416
  * set thread name for main thread and v8 worker (RafaelGSS) #56416
  * set worker thread name using worker.name (RafaelGSS) #56416
  * use a default thread name for inspector (RafaelGSS) #56416
test:
  * (SEMVER-MINOR) add WPT for URLPattern (Yagiz Nizipli) #56452
tls:
  * (SEMVER-MINOR) implement tls.getCACertificates() (Joyee Cheung) #57107
url:
  * (SEMVER-MINOR) add URLPattern implementation (Yagiz Nizipli) #56452
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462
v8:
  * (SEMVER-MINOR) add v8.getCppHeapStatistics() method (Aditi) #57146
zlib:
  * (SEMVER-MINOR) add zstd support (Jan Martin) #52100

PR-URL: TODO
@RafaelGSS RafaelGSS mentioned this pull request Apr 11, 2025
Open
RafaelGSS added a commit that referenced this pull request Apr 11, 2025
@RafaelGSS
2025-04-15, Version 22.15.0 'Jod' (LTS)
Loading
Loading status checks…
e1372dd 
Notable changes:

assert:
  * (SEMVER-MINOR) implement partial error comparison (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) improve partialDeepStrictEqual (Ruben Bridgewater) #57370
assert,util:
  * (SEMVER-MINOR) improve performance (Ruben Bridgewater) #57370
benchmark:
  * (SEMVER-MINOR) adjust assert runtimes (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) skip running some assert benchmarks by default (Ruben Bridgewater) #57370
  * (SEMVER-MINOR) add assert partialDeepStrictEqual benchmark (Ruben Bridgewater) #57370
cli:
  * (SEMVER-MINOR) allow --cpu-prof* in NODE_OPTIONS (Carlos Espa) #57018
crypto:
  * update root certificates to NSS 3.108 (Node.js GitHub Bot) #57381
  * (SEMVER-MINOR) support --use-system-ca on Windows (Joyee Cheung) #56833
  * (SEMVER-MINOR) added support for reading certificates from macOS system store (Tim Jacomb) #56599
deps:
  * update timezone to 2025a (Node.js GitHub Bot) #56876
  * (SEMVER-MINOR) update ada to v3.0.1 (Yagiz Nizipli) #56452
deps,tools:
  * (SEMVER-MINOR) add zstd 1.5.6 (Jan Martin) #52100
dns:
  * (SEMVER-MINOR) add TLSA record query and parsing (Rithvik Vibhu) #52983
doc:
  * add @geeksilva97 to collaborators (Edy Silva) #57241
module:
  * (SEMVER-MINOR) use synchronous hooks for preparsing in import(cjs) (Joyee Cheung) #55698
  * (SEMVER-MINOR) implement module.registerHooks() (Joyee Cheung) #55698
process:
  * (SEMVER-MINOR) add execve (Paolo Insogna) #56496
  * (SEMVER-MINOR) add threadCpuUsage (Paolo Insogna) #56467
sqlite:
  * (SEMVER-MINOR) add StatementSync.prototype.columns() (Colin Ihrig) #57490
  * (SEMVER-MINOR) allow returning `ArrayBufferView`s from user-defined functions (René) #56790
src:
  * set signal inspector io thread name (RafaelGSS) #56416
  * set thread name for main thread and v8 worker (RafaelGSS) #56416
  * set worker thread name using worker.name (RafaelGSS) #56416
  * use a default thread name for inspector (RafaelGSS) #56416
test:
  * (SEMVER-MINOR) add WPT for URLPattern (Yagiz Nizipli) #56452
tls:
  * (SEMVER-MINOR) implement tls.getCACertificates() (Joyee Cheung) #57107
url:
  * (SEMVER-MINOR) add URLPattern implementation (Yagiz Nizipli) #56452
util:
  * (SEMVER-MINOR) expose diff function used by the assertion errors (Giovanni Bucci) #57462
v8:
  * (SEMVER-MINOR) add v8.getCppHeapStatistics() method (Aditi) #57146
zlib:
  * (SEMVER-MINOR) add zstd support (Jan Martin) #52100

PR-URL: #57840
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell

@benjamingr benjamingr

@BridgeAR BridgeAR

@pmarchini pmarchini

Assignees
No one assigned
Labels
assert Issues and PRs related to the assert subsystem. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. needs-ci PRs that need a full CI run. notable-change PRs with changes that should be highlighted in changelogs. semver-minor PRs that contain new features and should be released in the next minor version. util Issues and PRs related to the built-in util module.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Expose createErrDiff for diffing objects
6 participants
@puskin94 @nodejs-github-bot @jasnell @benjamingr @BridgeAR @pmarchini