Merge pull request #777 from pasieronen/no-enum-value-in-error

Don't include received value in enum/literal error messages (fixes #461)
colinhacks · Dec 30, 2021 · a118887 · a118887
2 parents 9ef076d + 5cd8d7b
commit a118887
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 10 deletions.
diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -281,9 +281,7 @@ export const defaultErrorMap = (
     case ZodIssueCode.invalid_enum_value:
       message = `Invalid enum value. Expected ${issue.options
         .map((val) => (typeof val === "string" ? `'${val}'` : val))
-        .join(" | ")}, received ${
-        typeof _ctx.data === "string" ? `'${_ctx.data}'` : _ctx.data
-      }`;
+        .join(" | ")}`;
       break;
     case ZodIssueCode.invalid_arguments:
       message = `Invalid function arguments`;

diff --git a/deno/lib/__tests__/error.test.ts b/deno/lib/__tests__/error.test.ts
@@ -398,6 +398,29 @@ test("strict error message", () => {
   }
 });
 
+test("enum default error message", () => {
+  try {
+    z.enum(["Tuna", "Trout"]).parse("Salmon");
+  } catch (err) {
+    const zerr: z.ZodError = err as any;
+    expect(zerr.issues.length).toEqual(1);
+    expect(zerr.issues[0].message).toEqual(
+      "Invalid enum value. Expected 'Tuna' | 'Trout'"
+    );
+    expect(zerr.issues[0].message).not.toContain("Salmon");
+  }
+});
+
+test("literal default error message", () => {
+  try {
+    z.literal("Tuna").parse("Trout");
+  } catch (err) {
+    const zerr: z.ZodError = err as any;
+    expect(zerr.issues.length).toEqual(1);
+    expect(zerr.issues[0].message).toEqual("Expected string, received string");
+  }
+});
+
 // test("dont short circuit on continuable errors", () => {
 //   const user = z
 //     .object({

diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -2727,8 +2727,8 @@ export class ZodLiteral<T extends any> extends ZodType<T, ZodLiteralDef<T>> {
     if (ctx.data !== this._def.value) {
       addIssueToContext(ctx, {
         code: ZodIssueCode.invalid_type,
-        expected: this._def.value as any,
-        received: ctx.data,
+        expected: getParsedType(this._def.value),
+        received: ctx.parsedType,
       });
       return INVALID;
     }

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -281,9 +281,7 @@ export const defaultErrorMap = (
     case ZodIssueCode.invalid_enum_value:
       message = `Invalid enum value. Expected ${issue.options
         .map((val) => (typeof val === "string" ? `'${val}'` : val))
-        .join(" | ")}, received ${
-        typeof _ctx.data === "string" ? `'${_ctx.data}'` : _ctx.data
-      }`;
+        .join(" | ")}`;
       break;
     case ZodIssueCode.invalid_arguments:
       message = `Invalid function arguments`;

diff --git a/src/__tests__/error.test.ts b/src/__tests__/error.test.ts
@@ -397,6 +397,29 @@ test("strict error message", () => {
   }
 });
 
+test("enum default error message", () => {
+  try {
+    z.enum(["Tuna", "Trout"]).parse("Salmon");
+  } catch (err) {
+    const zerr: z.ZodError = err as any;
+    expect(zerr.issues.length).toEqual(1);
+    expect(zerr.issues[0].message).toEqual(
+      "Invalid enum value. Expected 'Tuna' | 'Trout'"
+    );
+    expect(zerr.issues[0].message).not.toContain("Salmon");
+  }
+});
+
+test("literal default error message", () => {
+  try {
+    z.literal("Tuna").parse("Trout");
+  } catch (err) {
+    const zerr: z.ZodError = err as any;
+    expect(zerr.issues.length).toEqual(1);
+    expect(zerr.issues[0].message).toEqual("Expected string, received string");
+  }
+});
+
 // test("dont short circuit on continuable errors", () => {
 //   const user = z
 //     .object({

diff --git a/src/types.ts b/src/types.ts
@@ -2727,8 +2727,8 @@ export class ZodLiteral<T extends any> extends ZodType<T, ZodLiteralDef<T>> {
     if (ctx.data !== this._def.value) {
       addIssueToContext(ctx, {
         code: ZodIssueCode.invalid_type,
-        expected: this._def.value as any,
-        received: ctx.data,
+        expected: getParsedType(this._def.value),
+        received: ctx.parsedType,
       });
       return INVALID;
     }