refactor(store): decouple waku store public api types from rpc types #1350
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
LNSD
changed the title
LNSD
commented
Nov 7, 2022
Comment on lines
+67
to
+104
| HistoryErrorKind* {.pure.} = enum | ||
| UNKNOWN = uint32(000) | ||
| PEER_DIAL_FAILURE = uint32(200) | ||
| BAD_RESPONSE = uint32(300) | ||
| BAD_REQUEST = uint32(400) | ||
| SERVICE_UNAVAILABLE = uint32(503) | ||
|
|
||
| HistoryError* = object | ||
| case kind*: HistoryErrorKind | ||
| of PEER_DIAL_FAILURE: | ||
| address*: string | ||
| of BAD_RESPONSE, BAD_REQUEST: | ||
| cause*: string | ||
| else: | ||
| discard | ||
|
|
||
| HistoryResult* = Result[HistoryResponse, HistoryError] | ||
|
|
||
|
|
||
| proc parse*(T: type HistoryErrorKind, kind: uint32): T = | ||
| case kind: | ||
| of 000, 200, 300, 400, 503: | ||
| HistoryErrorKind(kind) | ||
| else: | ||
| HistoryErrorKind.UNKNOWN | ||
|
|
||
| proc `$`*(err: HistoryError): string = | ||
| case err.kind: | ||
| of HistoryErrorKind.PEER_DIAL_FAILURE: | ||
| "PEER_DIAL_FAILURE: " & err.address | ||
| of HistoryErrorKind.BAD_RESPONSE: | ||
| "BAD_RESPONSE: " & err.cause | ||
| of HistoryErrorKind.BAD_REQUEST: | ||
| "BAD_REQUEST: " & err.cause | ||
| of HistoryErrorKind.SERVICE_UNAVAILABLE: | ||
| "SERVICE_UNAVAILABLE" | ||
| of HistoryErrorKind.UNKNOWN: | ||
| "UNKNOWN" |
There was a problem hiding this comment.
@rymnc This is, more or less, how I am envisioning error management in the nwaku codebase, in case we need to differentiate between error causes. Note the enum and the object variants type (this might remember you Rust's io:Error 🙂 )
LNSD
force-pushed
the
feat-store-decouple-types
branch
2 times, most recently
from
6d5995b to
d4a2398
Compare
Jenkins BuildsClick to see older builds (8)
|
LNSD
force-pushed
the
feat-store-decouple-types
branch
from
0bed6ce to
517d4c5
Compare
LNSD
force-pushed
the
feat-store-decouple-types
branch
from
517d4c5 to
c36dbbb
Compare
Merged
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.
The Waku Store protocol wire format will be reworked in the next release. To avoid having to refactor the whole codebase because the RPC types are used everywhere, decoupling the public-facing types from the internal implementation details is a good practice. This should apply to any public-facing API (e.g., c-bindings, REST, JSON-RPC, etc.).
commonmodule (common to the protocol handler and client)