Skip to content

util: add skipPrototype option to deep equality checks #59762

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

Merged
nodejs-github-bot merged 17 commits into from
Sep 14, 2025
Merged

util: add skipPrototype option to deep equality checks #59762

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3cd8765
lib: update isDeepStrictEqual to support options
miguelmarcondesf Sep 4, 2025
0a88d1b
doc: add options parameter to util.isDeepStrictEqual
miguelmarcondesf Sep 4, 2025
cf0d1eb
lib: add skipPrototypeComparison option to deepStrictEqual for Assert…
miguelmarcondesf Sep 4, 2025
5d5a6f8
test: add skipPrototypeComparison tests for Assert class
miguelmarcondesf Sep 4, 2025
68d6d79
doc: add skipPrototypeComparison option to Assert class
miguelmarcondesf Sep 4, 2025
c9cef45
lib: update notDeepStrictEqual to support skipPrototypeComparison option
miguelmarcondesf Sep 4, 2025
540097a
test: enhance skipPrototypeComparison tests for Assert class
miguelmarcondesf Sep 4, 2025
e8ca02a
test: add skipPrototypeComparison tests for util.isDeepStrictEqual
miguelmarcondesf Sep 4, 2025
642911b
lib: add missing proto
miguelmarcondesf Sep 5, 2025
1532570
lib: add missing proto
miguelmarcondesf Sep 5, 2025
dc0c5bc
lib: refine keyCheck mode condition for strict comparisons
miguelmarcondesf Sep 5, 2025
d14f030
doc: update examples to use class syntax for Foo and Bar
miguelmarcondesf Sep 5, 2025
3c6bf3c
lib: remove unecessary option check
miguelmarcondesf Sep 5, 2025
01daebd
doc: update missing pr number
miguelmarcondesf Sep 8, 2025
b3a4f56
doc: update missing pr number
miguelmarcondesf Sep 8, 2025
87e11ab
lib: simplify isDeepStrictEqual options handling
miguelmarcondesf Sep 8, 2025
0ae1910
lib: update skipPrototypeComparison to skipPrototype
miguelmarcondesf Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
test: add skipPrototypeComparison tests for util.isDeepStrictEqual
  • Loading branch information
@miguelmarcondesf
miguelmarcondesf committed Sep 4, 2025
commit e8ca02aa82ae9b0db4c2d160ab33c38ef09e6a86
64 changes: 64 additions & 0 deletions test/parallel/test-util-isDeepStrictEqual.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ require('../common');

const assert = require('assert');
const util = require('util');
const { test } = require('node:test');

function utilIsDeepStrict(a, b) {
assert.strictEqual(util.isDeepStrictEqual(a, b), true);
Expand Down Expand Up @@ -92,3 +93,66 @@ function notUtilIsDeepStrict(a, b) {
boxedStringA[symbol1] = true;
utilIsDeepStrict(a, b);
}

// Handle `skipPrototypeComparison` option for isDeepStrictEqual
{
test('util.isDeepStrictEqual with skipPrototypeComparison option', () => {
function ClassA(value) { this.value = value; }

function ClassB(value) { this.value = value; }

const objA = new ClassA(42);
const objB = new ClassB(42);

assert.strictEqual(util.isDeepStrictEqual(objA, objB), false);
assert.strictEqual(util.isDeepStrictEqual(objA, objB, { skipPrototypeComparison: true }), true);

const objC = new ClassB(99);
assert.strictEqual(util.isDeepStrictEqual(objA, objC, { skipPrototypeComparison: true }), false);

const nestedA = { obj: new ClassA('test'), num: 123 };
const nestedB = { obj: new ClassB('test'), num: 123 };

assert.strictEqual(util.isDeepStrictEqual(nestedA, nestedB), false);
assert.strictEqual(util.isDeepStrictEqual(nestedA, nestedB, { skipPrototypeComparison: true }), true);

const uint8Array = new Uint8Array([1, 2, 3]);
const buffer = Buffer.from([1, 2, 3]);

assert.strictEqual(util.isDeepStrictEqual(uint8Array, buffer), false);
assert.strictEqual(util.isDeepStrictEqual(uint8Array, buffer, { skipPrototypeComparison: true }), true);
});

test('util.isDeepStrictEqual skipPrototypeComparison with complex scenarios', () => {
class Parent { constructor(x) { this.x = x; } }
class Child extends Parent { constructor(x, y) { super(x); this.y = y; } }

function LegacyParent(x) { this.x = x; }

function LegacyChild(x, y) { this.x = x; this.y = y; }

const modernParent = new Parent(1);
const legacyParent = new LegacyParent(1);

assert.strictEqual(util.isDeepStrictEqual(modernParent, legacyParent), false);
assert.strictEqual(util.isDeepStrictEqual(modernParent, legacyParent, { skipPrototypeComparison: true }), true);

const modern = new Child(1, 2);
const legacy = new LegacyChild(1, 2);

assert.strictEqual(util.isDeepStrictEqual(modern, legacy), false);
assert.strictEqual(util.isDeepStrictEqual(modern, legacy, { skipPrototypeComparison: true }), true);

const literal = { name: 'test', values: [1, 2, 3] };
function Constructor(name, values) { this.name = name; this.values = values; }
const constructed = new Constructor('test', [1, 2, 3]);

assert.strictEqual(util.isDeepStrictEqual(literal, constructed), false);
assert.strictEqual(util.isDeepStrictEqual(literal, constructed, { skipPrototypeComparison: true }), true);

assert.strictEqual(util.isDeepStrictEqual(literal, constructed, {}), false);
assert.strictEqual(util.isDeepStrictEqual(literal, constructed, { skipPrototypeComparison: false }), false);
assert.strictEqual(util.isDeepStrictEqual(literal, constructed, { skipPrototypeComparison: null }), false);
assert.strictEqual(util.isDeepStrictEqual(literal, constructed, { skipPrototypeComparison: undefined }), false);
});
}
Loading