feat(types): Add gRPC Richer Error Model support (BadRequest) #1068
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
LucioFranco
requested changes
Aug 26, 2022
Adjustments following suggestions by @LucioFranco in hyperium#1068. Adjust style, remove unecessary prints, avoid glob imports, apply `non_exhaustive` to `ErrorDetails` and `ErrorDetail`, avoid pub fields in `ErrorDetails`, adjust `WithErrorDetails::with_error_details_vec` args, add `gen_details_bytes`.
As suggested by @LucioFranco in hyperium#1068 (comment). This avoids the need for consumers to have `protoc` in their path. Implemented following changes in hyperium#1065.
This allows consumers to provide custom metadata when creating a `Status` with error details.
LucioFranco
requested changes
Sep 7, 2022
tonic-types/src/lib.rs
Outdated
| //! in [`tonic::Status`], allowing the implementation of the | ||
| //! [gRPC Richer Error Model] with [`tonic`] in a convenient way. | ||
| //! | ||
| //! [`tonic::Status`]: https://docs.rs/tonic/0.8.0/tonic/struct.Status.html |
There was a problem hiding this comment.
I feel like we will forget to update this version number. I think we may want to link to latest instead?
There was a problem hiding this comment.
Ok, I addressed this in the latest adjustments commit.
tonic-types/src/lib.rs
Outdated
|
|
||
| /// Used to implement associated functions and methods on `tonic::Status`, that | ||
| /// allow the addition and extraction of standard error details. | ||
| pub trait WithErrorDetails { |
There was a problem hiding this comment.
What do you think about naming this StatusExt since its an extension trait and that way people know its methods implemented ontop of Status.
There was a problem hiding this comment.
Yes that's a better name, thanks! Renamed it in the latest adjustments commit.
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
|
|
Adjustments following suggestions by @LucioFranco in hyperium#1068. Move `error_details_vec` mod into `error_details` mod, adjust doc comments, rename `WithErrorDetails` trait to `StatusExt`.
LucioFranco
approved these changes
Sep 21, 2022
|
Thanks for all improvement suggestions! I will start working on the next PR, that will add support for one more standard error message type. |
This was referenced Feb 14, 2023
This was referenced Feb 22, 2023
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.
Motivation
The gRPC Richer Error Model is quite useful to send additional feedback to clients, and is supported by many gRPC libraries in other languages.
Solution
This PR is the first step to add richer error model support to
tonic-types, as per #1060. It introduces theWithErrorDetailstrait and adds support to theBadRequeststandard error message type.