Add RPCErrorConvertible #2143
Merged
Add RPCErrorConvertible #2143
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
Motivation: If an error is thrown from a server RPC then the status sent to the client will always have the unknown error code unless an `RPCError` is thrown. Moreover, there are various extensions to gRPC which rely on additional information being stuffed into the metadata. This is difficult and a bit error prone for users to do directly. We should provide a mechanism whereby errors can be converted to an `RPCError` such that the appropriate code, message and metadata are sent to the client. Modifications: - Add the `RPCErrorConvertible` protocol. Conforming types provide appropriate properties to populate an `RPCError`. - Add handling for this in the server executor such that convertible errors are converted into an `RPCError`. Result: Easier for users to propagate an appropriate status
gjcairo
approved these changes
Dec 12, 2024
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:
If an error is thrown from a server RPC then the status sent to the client will always have the unknown error code unless an
RPCErroris thrown.Moreover, there are various extensions to gRPC which rely on additional information being stuffed into the metadata. This is difficult and a bit error prone for users to do directly.
We should provide a mechanism whereby errors can be converted to an
RPCErrorsuch that the appropriate code, message and metadata are sent to the client.Modifications:
RPCErrorConvertibleprotocol. Conforming types provide appropriate properties to populate anRPCError.RPCError.Result:
Easier for users to propagate an appropriate status