Include error details in protovalidate responses #714
Merged
Conversation
This file contains 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
The info struct is shared between all these subtests - there's no need to clutter up each test by redefining it. Signed-off-by: Akshay Shah <akshay@akshayshah.org>
The streaming interceptor should match the behavior of the unary interceptor and gracefully handle non-protobuf messages. Signed-off-by: Akshay Shah <akshay@akshayshah.org>
Amend the unary and streaming interceptors to send validation errors to the client as an error detail. This allows client code to easily parse and work with the structured validation information: for example, a UI might want to display validation errors next to the relevant fields in a form. Signed-off-by: Akshay Shah <akshay@akshayshah.org>
johanbrandhorst
approved these changes
May 25, 2024
| @@ -9,16 +9,19 @@ import ( | |||
| "net" | |||
| "testing" | |||
|
|
|||
| "buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate" | |||
|
Thanks for the quick review, @johanbrandhorst! I also noticed another bug in the streaming interceptor, but I'll fix that in a separate PR. |
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 PR improves the protovalidate middleware:
when message validation fails. This allows clients to know which field(s) of
the request were invalid and which validation rules failed.
Speaking as one of the protovalidate authors, we intended validation errors to
be used as gRPC error details. I didn't notice that we weren't sending them
over the wire when I first reviewed this code.
Changes
Verification