feat(integrations): Add zod integration #11144
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a [Zod](https://github.com/colinhacks/zod) integration to sentry that adds better support for ZodError issues. Currently, the ZodError message is a formatted json string that gets truncated and the full list of issues are lost. - Adds the full list of issues to `extras['zoderror.issues']`. - Replaces the error message with a simple string.
size-limit report 📦
|
|
Hey @scttcper do you mind resolving merge conflicts (rebasing on develop), then I'll take a look - thank you! (and sorry for late response, got a bit lost there...) |
# Conflicts: # packages/node/src/index.ts
mydea
approved these changes
Apr 19, 2024
colinhacks
reviewed
Apr 19, 2024
packages/utils/src/zod-errors.ts
Outdated
| * This doesn't display well in the Sentry UI. Replace it with something shorter. | ||
| */ | ||
| function formatIssueMessage(zodError: ZodError): string { | ||
| const formError = zodError.flatten(); |
There was a problem hiding this comment.
I'd recommend against relying on .flatten here as it's liable to change in Zod 4. Instead consider iterating over the .issues array.
declare let err: z.ZodError;
const errorKeyMap = new Set<string | number | symbol>();
for (const iss of err.issues) {
if (iss.path) errorKeyMap.add(iss.path[0]);
}
const errorKeys = Array.from(errorKeyMap);
mydea
reviewed
Apr 22, 2024
mydea
requested changes
Apr 22, 2024
|
@mydea i think this is ready to go. I assume you'll merge it? I'm not up to date on what's going on with the sdk v8 |
mydea
reviewed
Apr 26, 2024
4 tasks
|
I created a docs issue for this as we don't have docs for that yet: getsentry/sentry-docs#14626 |
s1gr1d
reviewed
Aug 12, 2025
| import { defineIntegration } from '../integration'; | ||
|
|
||
| interface ZodErrorsOptions { | ||
| key?: string; |
There was a problem hiding this comment.
@scttcper I know this PR is quite old already but I just discovered the integration in the code and started creating docs for it.
I stumbled upon the option key which is actually not used in the integration. Should this be deleted or should this be the key under which Zod error details will be attached to the event's extra data? (now "zoderror.issues")
3 tasks
s1gr1d
added a commit
to getsentry/sentry-docs
that referenced
this pull request
Aug 13, 2025
## DESCRIBE YOUR PR Documents getsentry/sentry-javascript#11144 closes #14626 ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a Zod integration to sentry that adds better support for ZodError issues. Currently, the ZodError message is a formatted json string that gets truncated and the full list of issues are lost.
extras['zoderror.issues'].before
after
