@vitest/expect 1.1.3 → 1.2.1

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as _vitest_utils from '@vitest/utils';
 import { stringify, Constructable } from '@vitest/utils';
 export { setupColors } from '@vitest/utils';
 import { diff } from '@vitest/utils/diff';
@@ -6,35 +7,16 @@ export { DiffOptions } from '@vitest/utils/diff';
 type Formatter = (input: string | number | null | undefined) => string;
 
 declare function getMatcherUtils(): {
-    EXPECTED_COLOR: {
-        (input: unknown): string;
-        open: string;
-        close: string;
-    };
-    RECEIVED_COLOR: {
-        (input: unknown): string;
-        open: string;
-        close: string;
-    };
-    INVERTED_COLOR: {
-        (input: unknown): string;
-        open: string;
-        close: string;
-    };
-    BOLD_WEIGHT: {
-        (input: unknown): string;
-        open: string;
-        close: string;
-    };
-    DIM_COLOR: {
-        (input: unknown): string;
-        open: string;
-        close: string;
-    };
+    EXPECTED_COLOR: _vitest_utils.ColorMethod;
+    RECEIVED_COLOR: _vitest_utils.ColorMethod;
+    INVERTED_COLOR: _vitest_utils.ColorMethod;
+    BOLD_WEIGHT: _vitest_utils.ColorMethod;
+    DIM_COLOR: _vitest_utils.ColorMethod;
     matcherHint: (matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions) => string;
     printReceived: (object: unknown) => string;
     printExpected: (value: unknown) => string;
 };
+declare function addCustomEqualityTesters(newTesters: Array<Tester>): void;
 
 /**
  * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
@@ -45,7 +27,10 @@ declare function getMatcherUtils(): {
  */
 
 type ChaiPlugin = Chai.ChaiPlugin;
-type Tester = (a: any, b: any) => boolean | undefined;
+type Tester = (this: TesterContext, a: any, b: any, customTesters: Array<Tester>) => boolean | undefined;
+interface TesterContext {
+    equals: (a: unknown, b: unknown, customTesters?: Array<Tester>, strictCheck?: boolean) => boolean;
+}
 
 interface MatcherHintOptions {
     comment?: string;
@@ -98,6 +83,7 @@ interface ExpectStatic extends Chai.ExpectStatic, AsymmetricMatchersContaining {
     unreachable(message?: string): never;
     soft<T>(actual: T, message?: string): Assertion<T>;
     extend(expects: MatchersObject): void;
+    addEqualityTesters(testers: Array<Tester>): void;
     assertions(expected: number): void;
     hasAssertions(): void;
     anything(): any;
@@ -244,11 +230,11 @@ declare function fnNameFor(func: Function): string;
 declare function hasProperty(obj: object | null, property: string): boolean;
 declare function isImmutableUnorderedKeyed(maybeKeyed: any): boolean;
 declare function isImmutableUnorderedSet(maybeSet: any): boolean;
-declare function iterableEquality(a: any, b: any, aStack?: Array<any>, bStack?: Array<any>): boolean | undefined;
-declare function subsetEquality(object: unknown, subset: unknown): boolean | undefined;
+declare function iterableEquality(a: any, b: any, customTesters?: Array<Tester>, aStack?: Array<any>, bStack?: Array<any>): boolean | undefined;
+declare function subsetEquality(object: unknown, subset: unknown, customTesters?: Array<Tester>): boolean | undefined;
 declare function typeEquality(a: any, b: any): boolean | undefined;
 declare function arrayBufferEquality(a: unknown, b: unknown): boolean | undefined;
-declare function sparseArrayEquality(a: unknown, b: unknown): boolean | undefined;
+declare function sparseArrayEquality(a: unknown, b: unknown, customTesters?: Array<Tester>): boolean | undefined;
 declare function generateToBeMessage(deepEqualityName: string, expected?: string, actual?: string): string;
 declare function pluralize(word: string, count: number): string;
 
@@ -264,4 +250,4 @@ declare const JestChaiExpect: ChaiPlugin;
 
 declare const JestExtend: ChaiPlugin;
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, type Assertion, AsymmetricMatcher, type AsymmetricMatcherInterface, type AsymmetricMatchersContaining, type AsyncExpectationResult, type ChaiPlugin, type ExpectStatic, type ExpectationResult, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, type JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, type MatcherHintOptions, type MatcherState, type MatchersObject, ObjectContaining, type RawMatcherFn, StringContaining, StringMatching, type SyncExpectationResult, type Tester, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, type Assertion, AsymmetricMatcher, type AsymmetricMatcherInterface, type AsymmetricMatchersContaining, type AsyncExpectationResult, type ChaiPlugin, type ExpectStatic, type ExpectationResult, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, type JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, type MatcherHintOptions, type MatcherState, type MatchersObject, ObjectContaining, type RawMatcherFn, StringContaining, StringMatching, type SyncExpectationResult, type Tester, type TesterContext, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { getColors, stringify, isObject, assertTypes } from '@vitest/utils';
+import { getType, getColors, stringify, isObject, assertTypes } from '@vitest/utils';
 export { setupColors } from '@vitest/utils';
 import { diff } from '@vitest/utils/diff';
 import { isMockFunction } from '@vitest/spy';
@@ -13,6 +13,7 @@ const ASYMMETRIC_MATCHERS_OBJECT = Symbol.for("asymmetric-matchers-object");
 if (!Object.prototype.hasOwnProperty.call(globalThis, MATCHERS_OBJECT)) {
   const globalState = /* @__PURE__ */ new WeakMap();
   const matchers = /* @__PURE__ */ Object.create(null);
+  const customEqualityTesters = [];
   const assymetricMatchers = /* @__PURE__ */ Object.create(null);
   Object.defineProperty(globalThis, MATCHERS_OBJECT, {
     get: () => globalState
@@ -21,7 +22,8 @@ if (!Object.prototype.hasOwnProperty.call(globalThis, MATCHERS_OBJECT)) {
     configurable: true,
     get: () => ({
       state: globalState.get(globalThis[GLOBAL_EXPECT]),
-      matchers
+      matchers,
+      customEqualityTesters
     })
   });
   Object.defineProperty(globalThis, ASYMMETRIC_MATCHERS_OBJECT, {
@@ -106,6 +108,21 @@ function getMatcherUtils() {
     printExpected
   };
 }
+function addCustomEqualityTesters(newTesters) {
+  if (!Array.isArray(newTesters)) {
+    throw new TypeError(
+      `expect.customEqualityTesters: Must be set to an array of Testers. Was given "${getType(
+        newTesters
+      )}"`
+    );
+  }
+  globalThis[JEST_MATCHERS_OBJECT].customEqualityTesters.push(
+    ...newTesters
+  );
+}
+function getCustomEqualityTesters() {
+  return globalThis[JEST_MATCHERS_OBJECT].customEqualityTesters;
+}
 
 function equals(a, b, customTesters, strictCheck) {
   customTesters = customTesters || [];
@@ -144,8 +161,9 @@ function eq(a, b, aStack, bStack, customTesters, hasKey2) {
   const asymmetricResult = asymmetricMatch(a, b);
   if (asymmetricResult !== void 0)
     return asymmetricResult;
+  const testerContext = { equals };
   for (let i = 0; i < customTesters.length; i++) {
-    const customTesterResult = customTesters[i](a, b);
+    const customTesterResult = customTesters[i].call(testerContext, a, b, customTesters);
     if (customTesterResult !== void 0)
       return customTesterResult;
   }
@@ -266,7 +284,7 @@ const IteratorSymbol = Symbol.iterator;
 function hasIterator(object) {
   return !!(object != null && object[IteratorSymbol]);
 }
-function iterableEquality(a, b, aStack = [], bStack = []) {
+function iterableEquality(a, b, customTesters = [], aStack = [], bStack = []) {
   if (typeof a !== "object" || typeof b !== "object" || Array.isArray(a) || Array.isArray(b) || !hasIterator(a) || !hasIterator(b))
     return void 0;
   if (a.constructor !== b.constructor)
@@ -278,7 +296,19 @@ function iterableEquality(a, b, aStack = [], bStack = []) {
   }
   aStack.push(a);
   bStack.push(b);
-  const iterableEqualityWithStack = (a2, b2) => iterableEquality(a2, b2, [...aStack], [...bStack]);
+  const filteredCustomTesters = [
+    ...customTesters.filter((t) => t !== iterableEquality),
+    iterableEqualityWithStack
+  ];
+  function iterableEqualityWithStack(a2, b2) {
+    return iterableEquality(
+      a2,
+      b2,
+      [...filteredCustomTesters],
+      [...aStack],
+      [...bStack]
+    );
+  }
   if (a.size !== void 0) {
     if (a.size !== b.size) {
       return false;
@@ -288,7 +318,7 @@ function iterableEquality(a, b, aStack = [], bStack = []) {
         if (!b.has(aValue)) {
           let has = false;
           for (const bValue of b) {
-            const isEqual = equals(aValue, bValue, [iterableEqualityWithStack]);
+            const isEqual = equals(aValue, bValue, filteredCustomTesters);
             if (isEqual === true)
               has = true;
           }
@@ -304,18 +334,13 @@ function iterableEquality(a, b, aStack = [], bStack = []) {
     } else if (isA("Map", a) || isImmutableUnorderedKeyed(a)) {
       let allFound = true;
       for (const aEntry of a) {
-        if (!b.has(aEntry[0]) || !equals(aEntry[1], b.get(aEntry[0]), [iterableEqualityWithStack])) {
+        if (!b.has(aEntry[0]) || !equals(aEntry[1], b.get(aEntry[0]), filteredCustomTesters)) {
           let has = false;
           for (const bEntry of b) {
-            const matchedKey = equals(aEntry[0], bEntry[0], [
-              iterableEqualityWithStack
-            ]);
+            const matchedKey = equals(aEntry[0], bEntry[0], filteredCustomTesters);
             let matchedValue = false;
-            if (matchedKey === true) {
-              matchedValue = equals(aEntry[1], bEntry[1], [
-                iterableEqualityWithStack
-              ]);
-            }
+            if (matchedKey === true)
+              matchedValue = equals(aEntry[1], bEntry[1], filteredCustomTesters);
             if (matchedValue === true)
               has = true;
           }
@@ -333,7 +358,7 @@ function iterableEquality(a, b, aStack = [], bStack = []) {
   const bIterator = b[IteratorSymbol]();
   for (const aValue of a) {
     const nextB = bIterator.next();
-    if (nextB.done || !equals(aValue, nextB.value, [iterableEqualityWithStack]))
+    if (nextB.done || !equals(aValue, nextB.value, filteredCustomTesters))
       return false;
   }
   if (!bIterator.next().done)
@@ -351,18 +376,19 @@ function hasPropertyInObject(object, key) {
 function isObjectWithKeys(a) {
   return isObject(a) && !(a instanceof Error) && !Array.isArray(a) && !(a instanceof Date);
 }
-function subsetEquality(object, subset) {
+function subsetEquality(object, subset, customTesters = []) {
+  const filteredCustomTesters = customTesters.filter((t) => t !== subsetEquality);
   const subsetEqualityWithContext = (seenReferences = /* @__PURE__ */ new WeakMap()) => (object2, subset2) => {
     if (!isObjectWithKeys(subset2))
       return void 0;
     return Object.keys(subset2).every((key) => {
       if (isObjectWithKeys(subset2[key])) {
         if (seenReferences.has(subset2[key]))
-          return equals(object2[key], subset2[key], [iterableEquality]);
+          return equals(object2[key], subset2[key], filteredCustomTesters);
         seenReferences.set(subset2[key], true);
       }
       const result = object2 != null && hasPropertyInObject(object2, key) && equals(object2[key], subset2[key], [
-        iterableEquality,
+        ...filteredCustomTesters,
         subsetEqualityWithContext(seenReferences)
       ]);
       seenReferences.delete(subset2[key]);
@@ -397,12 +423,13 @@ function arrayBufferEquality(a, b) {
   }
   return true;
 }
-function sparseArrayEquality(a, b) {
+function sparseArrayEquality(a, b, customTesters = []) {
   if (!Array.isArray(a) || !Array.isArray(b))
     return void 0;
   const aKeys = Object.keys(a);
   const bKeys = Object.keys(b);
-  return equals(a, b, [iterableEquality, typeEquality], true) && equals(aKeys, bKeys);
+  const filteredCustomTesters = customTesters.filter((t) => t !== sparseArrayEquality);
+  return equals(a, b, filteredCustomTesters, true) && equals(aKeys, bKeys);
 }
 function generateToBeMessage(deepEqualityName, expected = "#{this}", actual = "#{exp}") {
   const toBeMessage = `expected ${expected} to be ${actual} // Object.is equality`;
@@ -432,7 +459,7 @@ class AsymmetricMatcher {
       ...getState(expect || globalThis[GLOBAL_EXPECT]),
       equals,
       isNot: this.inverse,
-      customTesters: [],
+      customTesters: getCustomEqualityTesters(),
       utils: {
         ...getMatcherUtils(),
         diff,
@@ -442,6 +469,14 @@ class AsymmetricMatcher {
       }
     };
   }
+  // implement custom chai/loupe inspect for better AssertionError.message formatting
+  // https://github.com/chaijs/loupe/blob/9b8a6deabcd50adc056a64fb705896194710c5c6/src/index.ts#L29
+  [Symbol.for("chai/inspect")](options) {
+    const result = stringify(this, options.depth, { min: true });
+    if (result.length <= options.truncate)
+      return result;
+    return `${this.toString()}{\u2026}`;
+  }
 }
 class StringContaining extends AsymmetricMatcher {
   constructor(sample, inverse = false) {
@@ -496,8 +531,9 @@ class ObjectContaining extends AsymmetricMatcher {
       );
     }
     let result = true;
+    const matcherContext = this.getMatcherContext();
     for (const property in this.sample) {
-      if (!this.hasProperty(other, property) || !equals(this.sample[property], other[property])) {
+      if (!this.hasProperty(other, property) || !equals(this.sample[property], other[property], matcherContext.customTesters)) {
         result = false;
         break;
       }
@@ -521,8 +557,9 @@ class ArrayContaining extends AsymmetricMatcher {
         `You must provide an array to ${this.toString()}, not '${typeof this.sample}'.`
       );
     }
+    const matcherContext = this.getMatcherContext();
     const result = this.sample.length === 0 || Array.isArray(other) && this.sample.every(
-      (item) => other.some((another) => equals(item, another))
+      (item) => other.some((another) => equals(item, another, matcherContext.customTesters))
     );
     return this.inverse ? !result : result;
   }
@@ -722,6 +759,7 @@ function wrapSoft(utils, fn) {
 const JestChaiExpect = (chai, utils) => {
   const { AssertionError } = chai;
   const c = () => getColors();
+  const customTesters = getCustomEqualityTesters();
   function def(name, fn) {
     const addMethod = (n) => {
       const softWrapper = wrapSoft(utils, fn);
@@ -767,7 +805,7 @@ const JestChaiExpect = (chai, utils) => {
     const equal = equals(
       actual,
       expected,
-      [iterableEquality]
+      [...customTesters, iterableEquality]
     );
     return this.assert(
       equal,
@@ -783,6 +821,7 @@ const JestChaiExpect = (chai, utils) => {
       obj,
       expected,
       [
+        ...customTesters,
         iterableEquality,
         typeEquality,
         sparseArrayEquality,
@@ -807,6 +846,7 @@ const JestChaiExpect = (chai, utils) => {
         actual,
         expected,
         [
+          ...customTesters,
           iterableEquality,
           typeEquality,
           sparseArrayEquality,
@@ -820,7 +860,7 @@ const JestChaiExpect = (chai, utils) => {
         const toEqualPass = equals(
           actual,
           expected,
-          [iterableEquality]
+          [...customTesters, iterableEquality]
         );
         if (toEqualPass)
           deepEqualityName = "toEqual";
@@ -837,7 +877,7 @@ const JestChaiExpect = (chai, utils) => {
   def("toMatchObject", function(expected) {
     const actual = this._obj;
     return this.assert(
-      equals(actual, expected, [iterableEquality, subsetEquality]),
+      equals(actual, expected, [...customTesters, iterableEquality, subsetEquality]),
       "expected #{this} to match object #{exp}",
       "expected #{this} to not match object #{exp}",
       expected,
@@ -882,7 +922,7 @@ const JestChaiExpect = (chai, utils) => {
   def("toContainEqual", function(expected) {
     const obj = utils.flag(this, "object");
     const index = Array.from(obj).findIndex((item) => {
-      return equals(item, expected);
+      return equals(item, expected, customTesters);
     });
     this.assert(
       index !== -1,
@@ -1008,7 +1048,7 @@ const JestChaiExpect = (chai, utils) => {
       return utils.getPathInfo(actual, propertyName);
     };
     const { value, exists } = getValue();
-    const pass = exists && (args.length === 1 || equals(expected, value));
+    const pass = exists && (args.length === 1 || equals(expected, value, customTesters));
     const valueString = args.length === 1 ? "" : ` with value ${utils.objDisplay(expected)}`;
     return this.assert(
       pass,
@@ -1156,7 +1196,7 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
   def(["toHaveBeenCalledWith", "toBeCalledWith"], function(...args) {
     const spy = getSpy(this);
     const spyName = spy.getMockName();
-    const pass = spy.mock.calls.some((callArg) => equals(callArg, args, [iterableEquality]));
+    const pass = spy.mock.calls.some((callArg) => equals(callArg, args, [...customTesters, iterableEquality]));
     const isNot = utils.flag(this, "negate");
     const msg = utils.getMessage(
       this,
@@ -1175,7 +1215,7 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
     const spyName = spy.getMockName();
     const nthCall = spy.mock.calls[times - 1];
     this.assert(
-      equals(nthCall, args, [iterableEquality]),
+      equals(nthCall, args, [...customTesters, iterableEquality]),
       `expected ${ordinalOf(times)} "${spyName}" call to have been called with #{exp}`,
       `expected ${ordinalOf(times)} "${spyName}" call to not have been called with #{exp}`,
       args,
@@ -1187,7 +1227,7 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
     const spyName = spy.getMockName();
     const lastCall = spy.mock.calls[spy.mock.calls.length - 1];
     this.assert(
-      equals(lastCall, args, [iterableEquality]),
+      equals(lastCall, args, [...customTesters, iterableEquality]),
       `expected last "${spyName}" call to have been called with #{exp}`,
       `expected last "${spyName}" call to not have been called with #{exp}`,
       args,
@@ -1423,8 +1463,7 @@ function getMatcherState(assertion, expect) {
   };
   const matcherState = {
     ...getState(expect),
-    // TODO: implement via expect.addEqualityTesters
-    customTesters: [],
+    customTesters: getCustomEqualityTesters(),
     isNot,
     utils: jestUtils,
     promise,
@@ -1514,4 +1553,4 @@ const JestExtend = (chai, utils) => {
   });
 };
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "1.1.3",
+  "version": "1.2.1",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -31,14 +31,14 @@
   ],
   "dependencies": {
     "chai": "^4.3.10",
-    "@vitest/spy": "1.1.3",
-    "@vitest/utils": "1.1.3"
+    "@vitest/spy": "1.2.1",
+    "@vitest/utils": "1.2.1"
   },
   "devDependencies": {
     "@types/chai": "4.3.6",
     "picocolors": "^1.0.0",
     "rollup-plugin-copy": "^3.5.0",
-    "@vitest/runner": "1.1.3"
+    "@vitest/runner": "1.2.1"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",