Skip to content

Improve the performance of z.nativeEnum #4341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve the performance of z.nativeEnum #4341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b3c09c
Add benchmarks for z.nativeEnum
sluukkonen May 9, 2025
ded6dd3
Improve the performance of z.nativeEnum
sluukkonen May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions deno/lib/benchmarks/primitives.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,38 @@ longEnumSuite
console.log(`long z.enum: ${e.target}`);
});

const nativeEnumSuite = new Benchmark.Suite("z.nativeEnum");
const nativeEnumSchema = z.nativeEnum(enumSchema.Values);

nativeEnumSuite
.add("valid", () => {
nativeEnumSchema.parse("a");
})
.add("invalid", () => {
try {
nativeEnumSchema.parse("x");
} catch (e) {}
})
.on("cycle", (e: Benchmark.Event) => {
console.log(`z.nativeEnum: ${e.target}`);
});

const longNativeEnumSuite = new Benchmark.Suite("long z.nativeEnum");
const longNativeEnumSchema = z.nativeEnum(longEnumSchema.Values);

longNativeEnumSuite
.add("valid", () => {
longNativeEnumSchema.parse("five");
})
.add("invalid", () => {
try {
longNativeEnumSchema.parse("invalid");
} catch (e) {}
})
.on("cycle", (e: Benchmark.Event) => {
console.log(`long z.nativeEnum: ${e.target}`);
});

const undefinedSuite = new Benchmark.Suite("z.undefined");
const undefinedSchema = z.undefined();

Expand Down Expand Up @@ -164,6 +196,8 @@ export default {
suites: [
enumSuite,
longEnumSuite,
nativeEnumSuite,
longNativeEnumSuite,
undefinedSuite,
literalSuite,
numberSuite,
Expand Down
7 changes: 3 additions & 4 deletions deno/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4461,14 +4461,13 @@ export class ZodNativeEnum<T extends EnumLike> extends ZodType<
> {
#cache: Set<T[keyof T]> | undefined;
_parse(input: ParseInput): ParseReturnType<T[keyof T]> {
const nativeEnumValues = util.getValidEnumValues(this._def.values);

const ctx = this._getOrReturnCtx(input);

if (
ctx.parsedType !== ZodParsedType.string &&
ctx.parsedType !== ZodParsedType.number
) {
const expectedValues = util.objectValues(nativeEnumValues);
const expectedValues = util.getValidEnumValues(this._def.values);
addIssueToContext(ctx, {
expected: util.joinValues(expectedValues) as "string",
received: ctx.parsedType,
Expand All @@ -4482,7 +4481,7 @@ export class ZodNativeEnum<T extends EnumLike> extends ZodType<
}

if (!this.#cache.has(input.data)) {
const expectedValues = util.objectValues(nativeEnumValues);
const expectedValues = util.getValidEnumValues(this._def.values);

addIssueToContext(ctx, {
received: ctx.data,
Expand Down
34 changes: 34 additions & 0 deletions src/benchmarks/primitives.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,38 @@ longEnumSuite
console.log(`long z.enum: ${e.target}`);
});

const nativeEnumSuite = new Benchmark.Suite("z.nativeEnum");
const nativeEnumSchema = z.nativeEnum(enumSchema.Values);

nativeEnumSuite
.add("valid", () => {
nativeEnumSchema.parse("a");
})
.add("invalid", () => {
try {
nativeEnumSchema.parse("x");
} catch (e) {}
})
.on("cycle", (e: Benchmark.Event) => {
console.log(`z.nativeEnum: ${e.target}`);
});

const longNativeEnumSuite = new Benchmark.Suite("long z.nativeEnum");
const longNativeEnumSchema = z.nativeEnum(longEnumSchema.Values);

longNativeEnumSuite
.add("valid", () => {
longNativeEnumSchema.parse("five");
})
.add("invalid", () => {
try {
longNativeEnumSchema.parse("invalid");
} catch (e) {}
})
.on("cycle", (e: Benchmark.Event) => {
console.log(`long z.nativeEnum: ${e.target}`);
});

const undefinedSuite = new Benchmark.Suite("z.undefined");
const undefinedSchema = z.undefined();

Expand Down Expand Up @@ -164,6 +196,8 @@ export default {
suites: [
enumSuite,
longEnumSuite,
nativeEnumSuite,
longNativeEnumSuite,
undefinedSuite,
literalSuite,
numberSuite,
Expand Down
7 changes: 3 additions & 4 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4461,14 +4461,13 @@ export class ZodNativeEnum<T extends EnumLike> extends ZodType<
> {
#cache: Set<T[keyof T]> | undefined;
_parse(input: ParseInput): ParseReturnType<T[keyof T]> {
const nativeEnumValues = util.getValidEnumValues(this._def.values);

const ctx = this._getOrReturnCtx(input);

if (
ctx.parsedType !== ZodParsedType.string &&
ctx.parsedType !== ZodParsedType.number
) {
const expectedValues = util.objectValues(nativeEnumValues);
const expectedValues = util.getValidEnumValues(this._def.values);
addIssueToContext(ctx, {
expected: util.joinValues(expectedValues) as "string",
received: ctx.parsedType,
Expand All @@ -4482,7 +4481,7 @@ export class ZodNativeEnum<T extends EnumLike> extends ZodType<
}

if (!this.#cache.has(input.data)) {
const expectedValues = util.objectValues(nativeEnumValues);
const expectedValues = util.getValidEnumValues(this._def.values);

addIssueToContext(ctx, {
received: ctx.data,
Expand Down