rpc/lib/client & server: try to conform to JSON-RPC 2.0 spec#4141
Merged
rpc/lib/client & server: try to conform to JSON-RPC 2.0 spec#4141
Conversation
golangcibot
reviewed
Nov 14, 2019
https://www.jsonrpc.org/specification What is done in this PR: JSONRPCClient: validate that Response.ID matches Request.ID I wanted to do the same for the WSClient, but since we're sending events as responses, not notifications, checking IDs would require storing them in memory indefinitely (and we won't be able to remove them upon client unsubscribing because ID is different then). Request.ID is now optional. Notification is a Request without an ID. Previously "" or 0 were considered as notifications Remove #event suffix from ID from an event response (partially fixes #2949) ID must be either string, int or null AND must be equal to request's ID. Now, because we've implemented events as responses, WS clients are tripping when they see Response.ID("0#event") != Request.ID("0"). Implementing events as requests would require a lot of time (~ 2 days to completely rewrite WS client and server) generate unique ID for each request switch to integer IDs instead of "json-client-XYZ" id=0 method=/subscribe id=0 result=... id=1 method=/abci_query id=1 result=... > send events (resulting from /subscribe) as requests+notifications (not responses) this will require a lot of work. probably not worth it * rpc: generate an unique ID for each request in conformance with JSON-RPC spec * WSClient: check for unsolicited responses * fix golangci warnings * save commit * fix errors * remove ID from responses from subscribe Fixes #2949 * clients are safe for concurrent access * tm-bench: switch to int ID * fixes after my own review * comment out sentIDs in WSClient see commit body for the reason * remove body.Close it will be closed automatically * stop ws connection outside of write/read routines also, use t.Rate in tm-bench indexer when calculating ID fix gocritic issues
dad7de0 to
e6dcc81
Compare
melekes
commented
Nov 14, 2019
Codecov Report
@@ Coverage Diff @@
## master #4141 +/- ##
=======================================
Coverage 66.68% 66.68%
=======================================
Files 247 247
Lines 21218 21221 +3
=======================================
+ Hits 14149 14151 +2
- Misses 6007 6013 +6
+ Partials 1062 1057 -5
|
NicolasMahe
reviewed
Feb 14, 2020
|
|
||
| // Read from the socket and subscribe to or unsubscribe from events | ||
| func (wsc *wsConnection) readRoutine() { | ||
| var request types.RPCRequest |
There was a problem hiding this comment.
a bug has been introduced by moving this variable outside of the for loop (because it is used in the defer function to display the request.ID in the error message).
When one ws client (one connection) wants to subscribe to multiple events (multiple call to Subscribe method), all ws messages contain the ID of the last subscriber.
previous place where this variable was declared: https://github.com/tendermint/tendermint/pull/4141/files#diff-692f910080346cdb0d29bfba93c21569L701
@antho1404 is working on a fix and should create a PR soon.
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
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.

Redo of #3858
https://www.jsonrpc.org/specification
What is done in this PR:
this will require a lot of work. probably not worth it
rpc: generate an unique ID for each request
in conformance with JSON-RPC spec
WSClient: check for unsolicited responses
fix golangci warnings
save commit
fix errors
remove ID from responses from subscribe
Fixes Responses to "subscribe" sent over WebSocket don't conform to RPC 2.0 specification #2949
clients are safe for concurrent access
tm-bench: switch to int ID
fixes after my own review
comment out sentIDs in WSClient
see commit body for the reason
remove body.Close
it will be closed automatically
stop ws connection outside of write/read routines
also, use t.Rate in tm-bench indexer when calculating ID
fix gocritic issues