Skip to content

Commit c0b250e

Browse files
zirkelczirkelc
authored
feat: add schema validation matchers (#8527)
1 parent 981b14d commit c0b250e

9 files changed

Lines changed: 441 additions & 1 deletion

File tree

‎docs/api/expect.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,6 +1688,42 @@ test('variety ends with "re"', () => {
16881688
You can use `expect.not` with this matcher to negate the expected value.
16891689
:::
16901690

1691+
## expect.schemaMatching
1692+
1693+
- **Type:** `(expected: StandardSchemaV1) => any`
1694+
1695+
When used with an equality check, this asymmetric matcher will return `true` if the value matches the provided schema. The schema must implement the [Standard Schema v1](https://standardschema.dev/) specification.
1696+
1697+
```ts
1698+
import { expect, test } from 'vitest'
1699+
import { z } from 'zod'
1700+
import * as v from 'valibot'
1701+
import { type } from 'arktype'
1702+
1703+
test('email validation', () => {
1704+
const user = { email: '[email protected]' }
1705+
1706+
// using Zod
1707+
expect(user).toEqual({
1708+
email: expect.schemaMatching(z.string().email()),
1709+
})
1710+
1711+
// using Valibot
1712+
expect(user).toEqual({
1713+
email: expect.schemaMatching(v.pipe(v.string(), v.email()))
1714+
})
1715+
1716+
// using ArkType
1717+
expect(user).toEqual({
1718+
email: expect.schemaMatching(type('string.email')),
1719+
})
1720+
})
1721+
```
1722+
1723+
:::tip
1724+
You can use `expect.not` with this matcher to negate the expected value.
1725+
:::
1726+
16911727
## expect.addSnapshotSerializer
16921728

16931729
- **Type:** `(plugin: PrettyFormatPlugin) => void`

‎packages/expect/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"dev": "rollup -c --watch"
3434
},
3535
"dependencies": {
36+
"@standard-schema/spec": "^1.0.0",
3637
"@types/chai": "catalog:",
3738
"@vitest/spy": "workspace:*",
3839
"@vitest/utils": "workspace:*",

‎packages/expect/src/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export {
1313
AsymmetricMatcher,
1414
JestAsymmetricMatchers,
1515
ObjectContaining,
16+
SchemaMatching,
1617
StringContaining,
1718
StringMatching,
1819
} from './jest-asymmetric-matchers'

‎packages/expect/src/jest-asymmetric-matchers.ts‎

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/* eslint-disable unicorn/no-instanceof-builtins -- we check both */
22

3+
import type { StandardSchemaV1 } from '@standard-schema/spec'
34
import type { ChaiPlugin, MatcherState, Tester } from './types'
45
import { GLOBAL_EXPECT } from './constants'
56
import {
@@ -8,14 +9,15 @@ import {
89
getMatcherUtils,
910
stringify,
1011
} from './jest-matcher-utils'
12+
1113
import {
1214
equals,
1315
isA,
16+
isStandardSchema,
1417
iterableEquality,
1518
pluralize,
1619
subsetEquality,
1720
} from './jest-utils'
18-
1921
import { getState } from './state'
2022

2123
export interface AsymmetricMatcherInterface {
@@ -395,6 +397,50 @@ class CloseTo extends AsymmetricMatcher<number> {
395397
}
396398
}
397399

400+
export class SchemaMatching extends AsymmetricMatcher<StandardSchemaV1<unknown, unknown>> {
401+
private result: StandardSchemaV1.Result<unknown> | undefined
402+
403+
constructor(sample: StandardSchemaV1<unknown, unknown>, inverse = false) {
404+
if (!isStandardSchema(sample)) {
405+
throw new TypeError(
406+
'SchemaMatching expected to receive a Standard Schema.',
407+
)
408+
}
409+
super(sample, inverse)
410+
}
411+
412+
asymmetricMatch(other: unknown): boolean {
413+
const result = this.sample['~standard'].validate(other)
414+
415+
// Check if the result is a Promise (async validation)
416+
if (result instanceof Promise) {
417+
throw new TypeError('Async schema validation is not supported in asymmetric matchers.')
418+
}
419+
420+
this.result = result
421+
const pass = !this.result.issues || this.result.issues.length === 0
422+
423+
return this.inverse ? !pass : pass
424+
}
425+
426+
toString() {
427+
return `Schema${this.inverse ? 'Not' : ''}Matching`
428+
}
429+
430+
getExpectedType() {
431+
return 'object'
432+
}
433+
434+
toAsymmetricMatcher(): string {
435+
const { utils } = this.getMatcherContext()
436+
const issues = this.result?.issues || []
437+
if (issues.length > 0) {
438+
return `${this.toString()} ${utils.stringify(this.result, undefined, { printBasicPrototype: false })}`
439+
}
440+
return this.toString()
441+
}
442+
}
443+
398444
export const JestAsymmetricMatchers: ChaiPlugin = (chai, utils) => {
399445
utils.addMethod(chai.expect, 'anything', () => new Anything())
400446

@@ -428,6 +474,12 @@ export const JestAsymmetricMatchers: ChaiPlugin = (chai, utils) => {
428474
chai.expect,
429475
'closeTo',
430476
(expected: any, precision?: number) => new CloseTo(expected, precision),
477+
)
478+
479+
utils.addMethod(
480+
chai.expect,
481+
'schemaMatching',
482+
(expected: any) => new SchemaMatching(expected),
431483
);
432484

433485
// defineProperty does not work
@@ -441,5 +493,6 @@ export const JestAsymmetricMatchers: ChaiPlugin = (chai, utils) => {
441493
new StringMatching(expected, true),
442494
closeTo: (expected: any, precision?: number) =>
443495
new CloseTo(expected, precision, true),
496+
schemaMatching: (expected: any) => new SchemaMatching(expected, true),
444497
}
445498
}

‎packages/expect/src/jest-utils.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2222
2323
*/
2424

25+
import type { StandardSchemaV1 } from '@standard-schema/spec'
2526
import type { AsymmetricMatcher } from './jest-asymmetric-matchers'
2627
import type { Tester, TesterContext } from './types'
2728
import { isObject } from '@vitest/utils/helpers'
@@ -799,3 +800,15 @@ export function getObjectSubset(
799800

800801
return { subset: getObjectSubsetWithContext()(object, subset), stripped }
801802
}
803+
804+
/**
805+
* Detects if an object is a Standard Schema V1 compatible schema
806+
*/
807+
export function isStandardSchema(obj: any): obj is StandardSchemaV1 {
808+
return (
809+
!!obj
810+
&& typeof obj === 'object'
811+
&& obj['~standard']
812+
&& typeof obj['~standard'].validate === 'function'
813+
)
814+
}

‎packages/expect/src/types.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,17 @@ export interface AsymmetricMatchersContaining extends CustomMatcher {
184184
* expect(5.11).toEqual(expect.closeTo(5.12)); // with default precision
185185
*/
186186
closeTo: (expected: number, precision?: number) => any
187+
188+
/**
189+
* Matches if the received value validates against a Standard Schema.
190+
*
191+
* @param schema - A Standard Schema V1 compatible schema object
192+
*
193+
* @example
194+
* expect(user).toEqual(expect.schemaMatching(z.object({ name: z.string() })))
195+
* expect(['hello', 'world']).toEqual([expect.schemaMatching(z.string()), expect.schemaMatching(z.string())])
196+
*/
197+
schemaMatching: (schema: unknown) => any
187198
}
188199

189200
type WithAsymmetricMatcher<T> = T | AsymmetricMatcher<unknown>

‎pnpm-lock.yaml‎

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎test/core/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"collect": "vitest list"
1414
},
1515
"devDependencies": {
16+
"@standard-schema/spec": "^1.0.0",
1617
"@test/vite-environment-external": "link:./projects/vite-environment-external",
1718
"@test/vite-external": "link:./projects/vite-external",
1819
"@types/debug": "catalog:",

0 commit comments

Comments
 (0)