Add customTester support toStrictEqual

jestjs · SimenB · Jan 3, 2023 · Dec 1, 2022 · Dec 1, 2022 · Dec 1, 2022
commit cb73a206e3c4abdae5959894589ab7b90b764f9e
diff --git a/packages/expect-utils/src/utils.ts b/packages/expect-utils/src/utils.ts
@@ -365,10 +365,10 @@ export const arrayBufferEquality = (
   return true;
 };
 
-// TODO: Update with customTesters
 export const sparseArrayEquality = (
   a: unknown,
   b: unknown,
+  customTesters: Array<Tester> = [],
 ): boolean | undefined => {
   if (!Array.isArray(a) || !Array.isArray(b)) {
     return undefined;
@@ -378,7 +378,12 @@ export const sparseArrayEquality = (
   const aKeys = Object.keys(a);
   const bKeys = Object.keys(b);
   return (
-    equals(a, b, [iterableEquality, typeEquality], true) && equals(aKeys, bKeys)
+    equals(
+      a,
+      b,
+      customTesters.filter(t => t !== sparseArrayEquality),
+      true,
+    ) && equals(aKeys, bKeys)
   );
 };
 

diff --git a/packages/expect/src/__tests__/customEqualityTesters.test.ts b/packages/expect/src/__tests__/customEqualityTesters.test.ts
@@ -59,7 +59,7 @@ it('has no custom testers as default', () => {
   const special1 = createSpecialObject(1);
   const special2 = createSpecialObject(2);
 
-  // Basic matchers passing
+  // Basic matchers passing with default settings
   expect(special1).toBe(special1);
   expect(special1).toEqual(special1);
   expect([special1, special2]).toEqual([special1, special2]);
@@ -69,7 +69,7 @@ it('has no custom testers as default', () => {
     toIterator([special1, special2]),
   );
 
-  // Basic matchers not passing
+  // Basic matchers not passing with default settings
   expect(special1).not.toBe(special2);
   expect(createSpecialObject(1)).not.toEqual(createSpecialObject(2));
   expect([special1, special2]).not.toEqual([special2, special1]);
@@ -80,6 +80,10 @@ it('has no custom testers as default', () => {
   expect(toIterator([special1, special2])).not.toEqual(
     toIterator([special2, special1]),
   );
+  expect({a: special1, b: undefined}).not.toStrictEqual({
+    a: special2,
+    b: undefined,
+  });
 });
 
 describe('with custom equality testers', () => {
@@ -117,15 +121,14 @@ describe('with custom equality testers', () => {
     expect(toIterator([special1, special2])).toEqual(
       toIterator([special2, special1]),
     );
-    expect([createSpecialObject(1)]).toContainEqual(createSpecialObject(2));
-    expect({a: createSpecialObject(1)}).toHaveProperty(
-      'a',
-      createSpecialObject(2),
-    );
+    expect([special1]).toContainEqual(special2);
+    expect({a: special1}).toHaveProperty('a', special2);
+    expect({a: special1, b: undefined}).toStrictEqual({
+      a: special2,
+      b: undefined,
+    });
   });
 
-  // it('applies custom testers to toStrictEqual', () => {});
-
   // it('applies custom testers to toMatchObject', () => {});
 
   // TODO: Add tests for other matchers

diff --git a/packages/expect/src/matchers.ts b/packages/expect/src/matchers.ts
@@ -937,7 +937,12 @@ const matchers: MatchersObject = {
       promise: this.promise,
     };
 
-    const pass = equals(received, expected, toStrictEqualTesters, true);
+    const pass = equals(
+      received,
+      expected,
+      [...toStrictEqualTesters, ...getCustomEqualityTesters()],
+      true,
+    );
 
     const message = pass
       ? () =>