assert: make partialDeepStrictEqual throw when comparing [0] with [-0]

Fixes: #56230 PR-URL: #56237 Reviewed-By: James M Snell <[email protected]> Reviewed-By: LiviaMedeiros <[email protected]> Reviewed-By: Xuguang Mei <[email protected]> Reviewed-By: Jordan Harband <[email protected]>
nodejs · Dec 28, 2024 · 91c6b8a · 91c6b8a
1 parent 7d7e2ce
commit 91c6b8a
Show file tree

Hide file tree

Showing 2 changed files with 100 additions and 19 deletions.
diff --git a/lib/assert.js b/lib/assert.js
@@ -56,6 +56,7 @@ const {
   StringPrototypeIndexOf,
   StringPrototypeSlice,
   StringPrototypeSplit,
+  Symbol,
   SymbolIterator,
   TypedArrayPrototypeGetLength,
   Uint8Array,
@@ -497,6 +498,17 @@ function partiallyCompareSets(actual, expected, comparedObjects) {
   return true;
 }
 
+const minusZeroSymbol = Symbol('-0');
+const zeroSymbol = Symbol('0');
+
+// Helper function to get a unique key for 0, -0 to avoid collisions
+function getZeroKey(item) {
+  if (item === 0) {
+    return ObjectIs(item, -0) ? minusZeroSymbol : zeroSymbol;
+  }
+  return item;
+}
+
 function partiallyCompareArrays(actual, expected, comparedObjects) {
   if (expected.length > actual.length) {
     return false;
@@ -506,39 +518,58 @@ function partiallyCompareArrays(actual, expected, comparedObjects) {
 
   // Create a map to count occurrences of each element in the expected array
   const expectedCounts = new SafeMap();
-  for (const expectedItem of expected) {
-    let found = false;
-    for (const { 0: key, 1: count } of expectedCounts) {
-      if (isDeepStrictEqual(key, expectedItem)) {
-        expectedCounts.set(key, count + 1);
-        found = true;
-        break;
+  const safeExpected = new SafeArrayIterator(expected);
+
+  for (const expectedItem of safeExpected) {
+    // Check if the item is a zero or a -0, as these need to be handled separately
+    if (expectedItem === 0) {
+      const zeroKey = getZeroKey(expectedItem);
+      expectedCounts.set(zeroKey, (expectedCounts.get(zeroKey)?.count || 0) + 1);
+    } else {
+      let found = false;
+      for (const { 0: key, 1: count } of expectedCounts) {
+        if (isDeepStrictEqual(key, expectedItem)) {
+          expectedCounts.set(key, count + 1);
+          found = true;
+          break;
+        }
+      }
+      if (!found) {
+        expectedCounts.set(expectedItem, 1);
       }
-    }
-    if (!found) {
-      expectedCounts.set(expectedItem, 1);
     }
   }
 
   const safeActual = new SafeArrayIterator(actual);
 
-  // Create a map to count occurrences of relevant elements in the actual array
   for (const actualItem of safeActual) {
-    for (const { 0: key, 1: count } of expectedCounts) {
-      if (isDeepStrictEqual(key, actualItem)) {
+    // Check if the item is a zero or a -0, as these need to be handled separately
+    if (actualItem === 0) {
+      const zeroKey = getZeroKey(actualItem);
+
+      if (expectedCounts.has(zeroKey)) {
+        const count = expectedCounts.get(zeroKey);
         if (count === 1) {
-          expectedCounts.delete(key);
+          expectedCounts.delete(zeroKey);
         } else {
-          expectedCounts.set(key, count - 1);
+          expectedCounts.set(zeroKey, count - 1);
+        }
+      }
+    } else {
+      for (const { 0: expectedItem, 1: count } of expectedCounts) {
+        if (isDeepStrictEqual(expectedItem, actualItem)) {
+          if (count === 1) {
+            expectedCounts.delete(expectedItem);
+          } else {
+            expectedCounts.set(expectedItem, count - 1);
+          }
+          break;
         }
-        break;
       }
     }
   }
 
-  const { size } = expectedCounts;
-  expectedCounts.clear();
-  return size === 0;
+  return expectedCounts.size === 0;
 }
 
 /**

diff --git a/test/parallel/test-assert-objects.js b/test/parallel/test-assert-objects.js
@@ -97,6 +97,41 @@ describe('Object Comparison Tests', () => {
           actual: [1, 'two', true],
           expected: [1, 'two', false],
         },
+        {
+          description: 'throws when comparing [0] with [-0]',
+          actual: [0],
+          expected: [-0],
+        },
+        {
+          description: 'throws when comparing [0, 0, 0] with [0, -0]',
+          actual: [0, 0, 0],
+          expected: [0, -0],
+        },
+        {
+          description: 'throws when comparing ["-0"] with [-0]',
+          actual: ['-0'],
+          expected: [-0],
+        },
+        {
+          description: 'throws when comparing [-0] with [0]',
+          actual: [-0],
+          expected: [0],
+        },
+        {
+          description: 'throws when comparing [-0] with ["-0"]',
+          actual: [-0],
+          expected: ['-0'],
+        },
+        {
+          description: 'throws when comparing ["0"] with [0]',
+          actual: ['0'],
+          expected: [0],
+        },
+        {
+          description: 'throws when comparing [0] with ["0"]',
+          actual: [0],
+          expected: ['0'],
+        },
         {
           description:
             'throws when comparing two Date objects with different times',
@@ -385,6 +420,21 @@ describe('Object Comparison Tests', () => {
         actual: [1, 'two', true],
         expected: [1, 'two', true],
       },
+      {
+        description: 'compares [0] with [0]',
+        actual: [0],
+        expected: [0],
+      },
+      {
+        description: 'compares [-0] with [-0]',
+        actual: [-0],
+        expected: [-0],
+      },
+      {
+        description: 'compares [0, -0, 0] with [0, 0]',
+        actual: [0, -0, 0],
+        expected: [0, 0],
+      },
       {
         description: 'compares two Date objects with the same time',
         actual: new Date(0),