fix: equality of iterable with symbols (#14688)

jestjs · Nov 16, 2023 · 540c239 · 540c239
1 parent 5b97c9d
commit 540c239
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,7 @@
 - `[@jest/expect-utils]` Fix comparison of `DataView` ([#14408](https://github.com/jestjs/jest/pull/14408))
 - `[@jest/expect-utils]` [**BREAKING**] exclude non-enumerable in object matching ([#14670](https://github.com/jestjs/jest/pull/14670))
 - `[@jest/expect-utils]` Fix comparison of `URL` ([#14672](https://github.com/jestjs/jest/pull/14672))
+- `[@jest/expect-utils]` Check `Symbol` properties in equality ([#14688](https://github.com/jestjs/jest/pull/14688))
 - `[jest-leak-detector]` Make leak-detector more aggressive when running GC ([#14526](https://github.com/jestjs/jest/pull/14526))
 - `[jest-runtime]` Properly handle re-exported native modules in ESM via CJS ([#14589](https://github.com/jestjs/jest/pull/14589))
 - `[jest-util]` Make sure `isInteractive` works in a browser ([#14552](https://github.com/jestjs/jest/pull/14552))

diff --git a/packages/expect-utils/src/__tests__/utils.test.ts b/packages/expect-utils/src/__tests__/utils.test.ts
@@ -591,6 +591,36 @@ describe('iterableEquality', () => {
     const b = new TestRecord().set('dummy', 'data');
     expect(iterableEquality(a, b)).toBe(true);
   });
+
+  test('returns true when given a symbols keys within equal objects', () => {
+    const KEY = Symbol();
+
+    const a = {
+      [Symbol.iterator]: () => ({next: () => ({done: true})}),
+      [KEY]: [],
+    };
+    const b = {
+      [Symbol.iterator]: () => ({next: () => ({done: true})}),
+      [KEY]: [],
+    };
+
+    expect(iterableEquality(a, b)).toBe(true);
+  });
+
+  test('returns false when given a symbols keys within inequal objects', () => {
+    const KEY = Symbol();
+
+    const a = {
+      [Symbol.iterator]: () => ({next: () => ({done: true})}),
+      [KEY]: [1],
+    };
+    const b = {
+      [Symbol.iterator]: () => ({next: () => ({done: true})}),
+      [KEY]: [],
+    };
+
+    expect(iterableEquality(a, b)).toBe(false);
+  });
 });
 
 describe('typeEquality', () => {

diff --git a/packages/expect-utils/src/utils.ts b/packages/expect-utils/src/utils.ts
@@ -307,8 +307,8 @@ export const iterableEquality = (
     !isImmutableOrderedSet(a) &&
     !isImmutableRecord(a)
   ) {
-    const aEntries = Object.entries(a);
-    const bEntries = Object.entries(b);
+    const aEntries = entries(a);
+    const bEntries = entries(b);
     if (!equals(aEntries, bEntries)) {
       return false;
     }
@@ -320,6 +320,15 @@ export const iterableEquality = (
   return true;
 };
 
+const entries = (obj: any) => {
+  if (!isObject(obj)) return [];
+
+  return Object.getOwnPropertySymbols(obj)
+    .filter(key => key !== Symbol.iterator)
+    .map(key => [key, obj[key]])
+    .concat(Object.entries(obj));
+};
+
 const isObject = (a: any) => a !== null && typeof a === 'object';
 
 const isObjectWithKeys = (a: any) =>