assert: fix deepEqual always return true on URL #50853

meixg · 2023-11-22T15:38:23Z

anonrig

LGTM

lib/internal/util/comparisons.js

aduh95 · 2023-11-22T20:45:19Z

Related test failure:

=== release test-whatwg-url-custom-inspect ===
Path: parallel/test-whatwg-url-custom-inspect
Error: --- stderr ---
node:assert:126
  throw new AssertionError(obj);
  ^

AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:
+ actual - expected

+ '{ a: ***host.name:8080/path/name/?que=ry#hash }'
- '{ a: URL {} }'
    at Object.<anonymous> (/home/runner/work/node/node/test/parallel/test-whatwg-url-custom-inspect.js:65:8)
    at Module._compile (node:internal/modules/cjs/loader:1375:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1434:10)
    at Module.load (node:internal/modules/cjs/loader:1206:32)
    at Module._load (node:internal/modules/cjs/loader:1022:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:142:12)
    at node:internal/main/run_main_module:28:49 {
  generatedMessage: true,
  code: 'ERR_ASSERTION',
  actual: '{ a: ***host.name:8080/path/name/?que=ry#hash }',
  expected: '{ a: URL {} }',
  operator: 'strictEqual'
}

meixg · 2023-11-23T02:08:49Z

Related test failure:

=== release test-whatwg-url-custom-inspect ===
Path: parallel/test-whatwg-url-custom-inspect
Error: --- stderr ---
node:assert:126
  throw new AssertionError(obj);
  ^

AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:
+ actual - expected

+ '{ a: ***host.name:8080/path/name/?que=ry#hash }'
- '{ a: URL {} }'
    at Object.<anonymous> (/home/runner/work/node/node/test/parallel/test-whatwg-url-custom-inspect.js:65:8)
    at Module._compile (node:internal/modules/cjs/loader:1375:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1434:10)
    at Module.load (node:internal/modules/cjs/loader:1206:32)
    at Module._load (node:internal/modules/cjs/loader:1022:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:142:12)
    at node:internal/main/run_main_module:28:49 {
  generatedMessage: true,
  code: 'ERR_ASSERTION',
  actual: '{ a: ***host.name:8080/path/name/?que=ry#hash }',
  expected: '{ a: URL {} }',
  operator: 'strictEqual'
}

fixed

nodejs-github-bot · 2023-11-23T05:02:40Z

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

nodejs-github-bot · 2023-11-23T09:05:18Z

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

BridgeAR

The detection is not checking for an actual instance of URL and it's just a heuristic which can trigger for lots of other objects as well. Assert has to be very strict about knowing what to check for. We would need a proper check for being an URL object and that's something we can not easily do.

Update: The check is actually just additive, so it should be ok in assert. I would still like to see if we can just rely upon changing URL instead of assert and util.

BridgeAR · 2023-11-23T09:51:36Z

lib/internal/util/inspect.js

+    } else if (isURL(value) && !(recurseTimes > ctx.depth && ctx.depth !== null)) {
+      base = value.href;
+      if (keys.length === 0 && protoProps === undefined) {
+        return base;


I think it would be valuable to see the object structure as before. With this change, it almost looks like a string without providing the information about being an URL object.
Overall, I am not fond of special handling URL during inspection, especially as our detection is only a heuristic that can definitely trigger for lots of other objects (Boolean(self?.href && self.protocol && self.auth === undefined && self.path === undefined)). We could see if we want to change the implementation in URL itself that no special handling would be needed.

@BridgeAR Hi.
I thought it would be a simple solution to using instanceof, but I found that Using a symbol or instanceof would not be able to recognize URL objects coming from other implementations (e.g. in Electron) in the annotation

Could you tell me in what direction you think the implementation of the URL object should be changed?

That is the reason why we use the heuristic. Let's imagine a user handles websites and has a structure like: { href: 'string', protocol: 'ftp', country: 'GER' }. It would now be detected as URL. Our detection is only working in URL itself, by expecting objects of a specific shape. It does not work for a general input case like inspect. It is fine in assert, due to just parsing a few properties multiple times. The effective difference is triggering the getter for href.

I understand that it would be good to detect changes between input in case an assertion fails, I am just not sure how to ideally indicate that difference. We could consider activating custom inspection. It was turned off by default while using assertions as it is likely that it would show better debugging information in most cases. This just prevents getters from being accessed.

theoludwig · 2024-03-07T20:04:59Z

What is the status of this PR? Is there any way, can anyone help to move this forward? 😄

MCprotein · 2024-07-22T14:51:29Z

@meixg hi, What is the current status of this PR?

github-actions · 2024-08-09T17:08:13Z

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

RedYetiDev · 2024-08-09T17:08:33Z

Hi! People appear to have been requesting updates since March. For that reason, I've marked this PR as stalled. When action is taken, I'll be happy to un-mark it :-).

BridgeAR · 2024-10-01T08:57:30Z

lib/internal/util/inspect.js

+    } else if (isURL(value) && !(recurseTimes > ctx.depth && ctx.depth !== null)) {
+      base = value.href;
+      if (keys.length === 0 && protoProps === undefined) {
+        return base;


That is the reason why we use the heuristic. Let's imagine a user handles websites and has a structure like: { href: 'string', protocol: 'ftp', country: 'GER' }. It would now be detected as URL. Our detection is only working in URL itself, by expecting objects of a specific shape. It does not work for a general input case like inspect. It is fine in assert, due to just parsing a few properties multiple times. The effective difference is triggering the getter for href.

I understand that it would be good to detect changes between input in case an assertion fails, I am just not sure how to ideally indicate that difference. We could consider activating custom inspection. It was turned off by default while using assertions as it is likely that it would show better debugging information in most cases. This just prevents getters from being accessed.

BridgeAR · 2024-10-01T09:03:30Z

test/parallel/test-assert-deep.js

+  const a = new URL('http://foo');
+  const b = new URL('http://bar');
+
+  assertNotDeepOrStrict(a, b);


I wonder if we want a test for the error message, due to this being blocked for exactly that reason.

nodejs-github-bot · 2024-10-05T03:27:29Z

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

codecov · 2024-10-05T04:30:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.41%. Comparing base (98788da) to head (ea84315).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #50853      +/-   ##
==========================================
+ Coverage   87.89%   88.41%   +0.52%     
==========================================
  Files         652      652              
  Lines      186589   186604      +15     
  Branches    35750    36062     +312     
==========================================
+ Hits       163999   164988     +989     
+ Misses      15816    14889     -927     
+ Partials     6774     6727      -47

Files with missing lines	Coverage Δ
lib/internal/util/comparisons.js	`100.00% <100.00%> (ø)`
lib/internal/util/inspect.js	`99.95% <100.00%> (-0.05%)`	⬇️

... and 92 files with indirect coverage changes

nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Nov 22, 2023

meixg force-pushed the fix-deep-queal branch from e430f61 to aab5308 Compare November 22, 2023 15:43

tniessen requested review from anonrig and BridgeAR November 22, 2023 16:07

tniessen added assert Issues and PRs related to the assert subsystem. whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Nov 22, 2023

anonrig approved these changes Nov 22, 2023

View reviewed changes

marco-ippolito approved these changes Nov 22, 2023

View reviewed changes

aduh95 reviewed Nov 22, 2023

View reviewed changes

lib/internal/util/comparisons.js Show resolved Hide resolved

meixg force-pushed the fix-deep-queal branch from aab5308 to 42b8ba1 Compare November 23, 2023 02:04

meixg added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 23, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 23, 2023

BridgeAR requested changes Nov 23, 2023

View reviewed changes

RedYetiDev added the stalled Issues and PRs that are stalled. label Aug 9, 2024

BridgeAR reviewed Oct 1, 2024

View reviewed changes

RedYetiDev removed the stalled Issues and PRs that are stalled. label Oct 1, 2024

assert: fix deepEqual always return true on URL

ea84315

meixg force-pushed the fix-deep-queal branch from 42b8ba1 to ea84315 Compare October 5, 2024 03:13

meixg added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 5, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

assert: fix deepEqual always return true on URL #50853

assert: fix deepEqual always return true on URL #50853

meixg commented Nov 22, 2023 •

edited by aduh95

Loading

anonrig left a comment

aduh95 commented Nov 22, 2023

meixg commented Nov 23, 2023

nodejs-github-bot commented Nov 23, 2023

nodejs-github-bot commented Nov 23, 2023

BridgeAR left a comment •

edited

Loading

BridgeAR Nov 23, 2023

MCprotein Jul 23, 2024 •

edited

Loading

BridgeAR Oct 1, 2024

theoludwig commented Mar 7, 2024

MCprotein commented Jul 22, 2024

github-actions bot commented Aug 9, 2024

RedYetiDev commented Aug 9, 2024

BridgeAR Oct 1, 2024

BridgeAR Oct 1, 2024

nodejs-github-bot commented Oct 5, 2024

codecov bot commented Oct 5, 2024 •

edited

Loading

assert: fix deepEqual always return true on URL #50853

Are you sure you want to change the base?

assert: fix deepEqual always return true on URL #50853

Conversation

meixg commented Nov 22, 2023 • edited by aduh95 Loading

anonrig left a comment

Choose a reason for hiding this comment

aduh95 commented Nov 22, 2023

meixg commented Nov 23, 2023

nodejs-github-bot commented Nov 23, 2023

nodejs-github-bot commented Nov 23, 2023

BridgeAR left a comment • edited Loading

Choose a reason for hiding this comment

BridgeAR Nov 23, 2023

Choose a reason for hiding this comment

MCprotein Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

BridgeAR Oct 1, 2024

Choose a reason for hiding this comment

theoludwig commented Mar 7, 2024

MCprotein commented Jul 22, 2024

github-actions bot commented Aug 9, 2024

RedYetiDev commented Aug 9, 2024

BridgeAR Oct 1, 2024

Choose a reason for hiding this comment

BridgeAR Oct 1, 2024

Choose a reason for hiding this comment

nodejs-github-bot commented Oct 5, 2024

codecov bot commented Oct 5, 2024 • edited Loading

Codecov Report

meixg commented Nov 22, 2023 •

edited by aduh95

Loading

BridgeAR left a comment •

edited

Loading

MCprotein Jul 23, 2024 •

edited

Loading

codecov bot commented Oct 5, 2024 •

edited

Loading