feat(parser): support Standard Schema and upgrade to Zod v4 #4164
+1,473
−1,194
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
boring-cyborg
bot
added
dependencies
pull-request-size
bot
added
the
size/XXL
svozza
reviewed
Jul 13, 2025
svozza
reviewed
Jul 13, 2025
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
Co-authored-by: Stefano Vozza <svozza@amazon.com>
|
Please retry analysis of this Pull-Request directly on SonarQube Cloud |
|
svozza
approved these changes
Jul 13, 2025
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.
Summary
Changes
This PR updates the codebase to Zod v4 and adds support for it in Parser, as well as making the
parserMiddy.js middleware and class method decorator Standard Schema compatible, meaning it can now accept and parse events using Valibot and other parsing libraries.The PR diff is large, unfortunately I wasn't able to make updates in an orderly fashion because the migration from Zod v3 to v4 has been quite painful. While the upgrade guide is extensive, it focuses primarily on application developers (aka end users). Likewise, the page dedicated to library authors mainly explains how to accept schemas, but falls short of showing complex types or interaction between customer-provided schemas and build-in schemas.
The bulk of the changes in this PR focuses on the built-in envelopes and their unit tests. Envelopes are the area in the utility that is more opinionated and have Zod schemas mixed with custom logic and custom errors. Because of this, the changes required are fairly spread out, causing a large diff.
Aside from this, the rest of the work has gone in expanding types to support Standard Schema and documentation, both in the
docspage as well as within the code.Finally, while working on this I realized that while we had type-checked tests in the Parser utility, these were not actually type-checking but only showing errors in the IDE. I updated the package
vitestconfig to make sure they run correctly.Thank you in advance for your help reviewing.
Issue number: closes #3951, closes #2431
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.