rpc: Add support for batched requests/responses #3534
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
As per #3213, this adds support for [JSON RPC batch requests and responses](https://www.jsonrpc.org/specification#batch).
Codecov Report
@@ Coverage Diff @@
## develop #3534 +/- ##
===========================================
- Coverage 64.17% 64.02% -0.15%
===========================================
Files 213 213
Lines 17373 17388 +15
===========================================
- Hits 11149 11133 -16
- Misses 5301 5323 +22
- Partials 923 932 +9
|
liamsi
reviewed
Apr 9, 2019
melekes
reviewed
Apr 9, 2019
This refactors the batching functionality to rather act in a standalone way. In light of supporting concurrent goroutines making use of the same client, it would make sense to have batching functionality where one could create a batch of requests per goroutine and send that batch without interfering with a batch from another goroutine.
liamsi
reviewed
Apr 10, 2019
liamsi
reviewed
Apr 10, 2019
liamsi
reviewed
Apr 10, 2019
liamsi
reviewed
Apr 10, 2019
liamsi
reviewed
Apr 10, 2019
liamsi
reviewed
Apr 10, 2019
melekes
suggested changes
Apr 12, 2019
This adds code to automatically generate a randomized client ID for the JSONRPCClient, and adds a check of the IDs in the responses (if one was set in the requests).
melekes
reviewed
Apr 15, 2019
melekes
reviewed
Apr 16, 2019
melekes
reviewed
Apr 17, 2019
melekes
reviewed
Apr 17, 2019
brapse
pushed a commit
to brapse/tendermint
that referenced
this pull request
Jun 5, 2019
Continues from tendermint#3280 in building support for batched requests/responses in the JSON RPC (as per issue tendermint#3213). * Add JSON RPC batching for client and server As per tendermint#3213, this adds support for [JSON RPC batch requests and responses](https://www.jsonrpc.org/specification#batch). * Add additional checks to ensure client responses are the same as results * Fix case where a notification is sent and no response is expected * Add test to check that JSON RPC notifications in a batch are left out in responses * Update CHANGELOG_PENDING.md * Update PR number now that PR has been created * Make errors start with lowercase letter * Refactor batch functionality to be standalone This refactors the batching functionality to rather act in a standalone way. In light of supporting concurrent goroutines making use of the same client, it would make sense to have batching functionality where one could create a batch of requests per goroutine and send that batch without interfering with a batch from another goroutine. * Add examples for simple and batch HTTP client usage * Check errors from writer and remove nolinter directives * Make error strings start with lowercase letter * Refactor examples to make them testable * Use safer deferred shutdown for example Tendermint test node * Recompose rpcClient interface from pre-existing interface components * Rename WaitGroup for brevity * Replace empty ID string with request ID * Remove extraneous test case * Convert first letter of errors.Wrap() messages to lowercase * Remove extraneous function parameter * Make variable declaration terse * Reorder WaitGroup.Done call to help prevent race conditions in the face of failure * Swap mutex to value representation and remove initialization * Restore empty JSONRPC string ID in response to prevent nil * Make JSONRPCBufferedRequest private * Revert PR hard link in CHANGELOG_PENDING * Add client ID for JSONRPCClient This adds code to automatically generate a randomized client ID for the JSONRPCClient, and adds a check of the IDs in the responses (if one was set in the requests). * Extract response ID validation into separate function * Remove extraneous comments * Reorder fields to indicate clearly which are protected by the mutex * Refactor for loop to remove indexing * Restructure and combine loop * Flatten conditional block for better readability * Make multi-variable declaration slightly more readable * Change for loop style * Compress error check statements * Make function description more generic to show that we support different protocols * Preallocate memory for request and result objects
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.
Continues from #3280 in building support for batched requests/responses in the JSON RPC (as per issue #3213).