RobinTail / express-zod-api / 33591720986

100%

push

github

feat(endpoint): Try parsing sync first (#3672)

This should unblock #3666 for compiled schemas.
We're gonna try parsing synchronously first, but if it fails we do
async.
Historically established `.parseAsync()` is chosen for versatility, due
to the #269.

The happy path does not affect the performance.

```
 ✓ bench/parse-maybe-async.bench.ts > Parsing 'sync' schemas 2959ms
     name                          hz     min     max    mean     p75     p99    p995    p999     rme  samples
   · .parseAsync()       8,148,819.69  0.0000  2.1694  0.0001  0.0001  0.0003  0.0004  0.0006  ±0.89%  4074410
   · parseMaybeAsync()  10,416,248.81  0.0000  0.1899  0.0001  0.0001  0.0002  0.0002  0.0005  ±0.26%  5208125

 ✓ bench/parse-maybe-async.bench.ts > Parsing 'async' schemas 1593ms
     name                         hz     min     max    mean     p75     p99    p995    p999     rme  samples
   · .parseAsync()      3,368,112.15  0.0002  0.1607  0.0003  0.0003  0.0005  0.0007  0.0008  ±0.28%  1684062
   · parseMaybeAsync()    227,643.07  0.0038  0.1916  0.0044  0.0045  0.0055  0.0058  0.0100  ±0.19%   113822
```

Meaning:
- Parsing sync schemas (happy path): becomes `1.3x` faster than before
(even without schema compilation);
- Parsing occasionally async schemas regrettably becomes `~14x` slower
than it used to be with `.parseAsync()`;

Therefore:
- I decided to make it an opt-in feature for now, that will become
default in v30 #3643 , when Zod 4.5 will be a required min version and
we'll use compiled schemas anyway for performance benefits;
- but even when enabled, it will try it only once per schema (first
request, cache findings), so if we find out that the schema is async
then we'll keep using `parseAsync` for it.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## New Features

- Added the opt-in `trySyncValidation` setting for endpoint and
middleware schema validation.
- Synchronous validation is attempted fi... (continued)

1114 of 1163 branches covered (95.79%)

19 of 19 new or added lines in 4 files covered. (100.0%)

1610 of 1610 relevant lines covered (100.0%)

601.49 hits per line