feat: error handling overhaul #65
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
heilhead
force-pushed
the
feat/error-overhaul
branch
2 times, most recently
from
5719c65 to
803b7ca
Compare
heilhead
force-pushed
the
feat/error-overhaul
branch
from
d2a1b93 to
7ecb23f
Compare
xDarksome
approved these changes
Feb 16, 2024
| } | ||
|
|
||
| #[test] | ||
| fn error_tags() { |
jakubuid
reviewed
Feb 17, 2024
| Rpc { | ||
| code: i32, | ||
| message: String, | ||
| data: Option<String>, |
There was a problem hiding this comment.
data field is not handled currently in Kotlin client. It should not break tho, would be just ignored.
jakubuid
reviewed
Feb 17, 2024
llbartekll
reviewed
Feb 19, 2024
5 tasks
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.
Description
This reworks the RPC errors to be serializable and deserializable from the
datafield of JSONRPC error response. Both the HTTP and websocket clients in this crate make use of the new errors by deserializing relay RPC responses into strongly-typed errors.Clients in other SDKs should implement their own reconstruction based on the following JSONRPC error response fields:
code: the general class of errors to distinguish between retryable and permanent errors;data: the string tag specifying error kind within that class;message: string message detailing the error.The error codes are (mostly) consistent with the old error codes & the JSONRPC specs. What's changed:
-32602(invalid params) to a more generic-32600(invalid request);-32700(parse error) to-32600(invalid request);The rest of the changes are non-breaking, in terms of error codes.
How Has This Been Tested?
Existing tests, relay integration tests and also new tests covering error tags.
Due Diligence