Handling integer IDs in JSON-RPC requests -- fixes #2366#2811
Merged
ebuchman merged 6 commits intotendermint:developfrom Nov 26, 2018
Merged
Handling integer IDs in JSON-RPC requests -- fixes #2366#2811ebuchman merged 6 commits intotendermint:developfrom
ebuchman merged 6 commits intotendermint:developfrom
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #2811 +/- ##
===========================================
- Coverage 62.4% 62.16% -0.24%
===========================================
Files 212 212
Lines 17254 17352 +98
===========================================
+ Hits 10767 10787 +20
- Misses 5583 5657 +74
- Partials 904 908 +4
|
ebuchman
reviewed
Nov 12, 2018
ebuchman
reviewed
Nov 12, 2018
melekes
reviewed
Nov 15, 2018
rpc/lib/types/types.go
Outdated
| func NewRPCRequest(id string, method string, params json.RawMessage) RPCRequest { | ||
| // UnmarshalJSON custom JSON unmarshalling due to jsonrpcid being string or int | ||
| func (request *RPCRequest) UnmarshalJSON(data []byte) error { | ||
| type AliasStr RPCRequest |
Contributor
There was a problem hiding this comment.
We should Unmarshal interface{} and then use switch for different possible types
switch ID.(type) {
case string:
XXX
case int:
YYY
default:
return fmt.Errorf("Unknown ID type. Got %T, expected string or int", ID)
Contributor
Author
There was a problem hiding this comment.
Contributor
There was a problem hiding this comment.
yes! also you can do without intermediate struct
unsafeResp := &struct {
JSONRPC string `json:"jsonrpc"`
ID interface{} `json:"id"`
Method string `json:"method"`
Params json.RawMessage `json:"params"` // must be map[string]interface{} or []interface{}
}{}you just use the original one
Contributor
Author
There was a problem hiding this comment.
@melekes @ebuchman I've changed it here: f2a71d7#diff-f595cd0be03b00ec17ec43d65afb7780
I'm not that experienced with Go, so not sure how to do it without the intermediate struct -- or by using the original, did you mean that jsonrpcid should be an empty interface and it should get rid of the extra ID type wrappers (JSONRPCStringID/JSONRPCIntID)?
added 3 commits
November 19, 2018 11:45
…ndermint#2366) * added a wrapper interface `jsonrpcid` that represents both string and int IDs in JSON-RPC requests/responses + custom JSON unmarshallers * changed client-side code in RPC that uses it * added extra tests for integer IDs
* added table driven tests for request type marshalling/unmarshalling * expanded handler test to check IDs * changed pending changelog note
71fe74d to
73bd3c6
Compare
Contributor
|
Pushed a commit to do some minor cleanup, hope you don't mind. PTAL! Otherwise LGTM |
ebuchman
approved these changes
Nov 26, 2018
danil-lashin
pushed a commit
to danil-lashin/tendermint
that referenced
this pull request
Nov 27, 2018
* develop: types: Emit tags from BeginBlock/EndBlock (tendermint#2747) Fix fast sync stack with wrong block tendermint#2457 (tendermint#2731) It's better read from genDoc than from state.validators when appHeight==0 in replay (tendermint#2893) update encoding spec (tendermint#2903) return back initially allowed level if we encounter allowed key (tendermint#2889) Handling integer IDs in JSON-RPC requests -- fixes tendermint#2366 (tendermint#2811) # Conflicts: # blockchain/reactor_test.go # blockchain/store_test.go # node/node_test.go # types/events.go
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Addresses #2366
Hi everyone, we're using one JSON-RPC client library that only does integer IDs (incrementally), so rather than having a workaround for that, I guess it'd be better to fix this issue in Tendermint.
This is the first Go code I ever wrote, so apologies if it's too bad.
I decided to use this "interface wrapper with a single method" workaround for the lack of sum types in Go, as it seems to be an OK tradeoff between type safety (e.g. "empty interface" wrapper would work as well here, but passing in booleans / objects / arrays as IDs wouldn't result in an error) and boilerplate.