• mmsqe's avatar
    rpc: add limit for batch request items and response size (#26681) · f3314bb6
    mmsqe authored
    This PR adds server-side limits for JSON-RPC batch requests. Before this change, batches
    were limited only by processing time. The server would pick calls from the batch and
    answer them until the response timeout occurred, then stop processing the remaining batch
    items.
    
    Here, we are adding two additional limits which can be configured:
    
    - the 'item limit': batches can have at most N items
    - the 'response size limit': batches can contain at most X response bytes
    
    These limits are optional in package rpc. In Geth, we set a default limit of 1000 items
    and 25MB response size.
    
    When a batch goes over the limit, an error response is returned to the client. However,
    doing this correctly isn't always possible. In JSON-RPC, only method calls with a valid
    `id` can be responded to. Since batches may also contain non-call messages or
    notifications, the best effort thing we can do to report an error with the batch itself is
    reporting the limit violation as an error for the first method call in the batch. If a batch is
    too large, but contains only notifications and responses, the error will be reported with
    a null `id`.
    
    The RPC client was also changed so it can deal with errors resulting from too large
    batches. An older client connected to the server code in this PR could get stuck
    until the request timeout occurred when the batch is too large. **Upgrading to a version
    of the RPC client containing this change is strongly recommended to avoid timeout issues.**
    
    For some weird reason, when writing the original client implementation, @fjl worked off of
    the assumption that responses could be distributed across batches arbitrarily. So for a
    batch request containing requests `[A B C]`, the server could respond with `[A B C]` but
    also with `[A B] [C]` or even `[A] [B] [C]` and it wouldn't make a difference to the
    client.
    
    So in the implementation of BatchCallContext, the client waited for all requests in the
    batch individually. If the server didn't respond to some of the requests in the batch, the
    client would eventually just time out (if a context was used).
    
    With the addition of batch limits into the server, we anticipate that people will hit this
    kind of error way more often. To handle this properly, the client now waits for a single
    response batch and expects it to contain all responses to the requests.
    
    ---------
    Co-authored-by: 's avatarFelix Lange <fjl@twurst.com>
    Co-authored-by: 's avatarMartin Holst Swende <martin@swende.se>
    f3314bb6
Name
Last commit
Last update
.github Loading commit data...
accounts Loading commit data...
beacon Loading commit data...
build Loading commit data...
cmd Loading commit data...
common Loading commit data...
consensus Loading commit data...
console Loading commit data...
core Loading commit data...
crypto Loading commit data...
docs Loading commit data...
eth Loading commit data...
ethclient Loading commit data...
ethdb Loading commit data...
ethstats Loading commit data...
event Loading commit data...
graphql Loading commit data...
internal Loading commit data...
les Loading commit data...
light Loading commit data...
log Loading commit data...
metrics Loading commit data...
miner Loading commit data...
node Loading commit data...
p2p Loading commit data...
params Loading commit data...
rlp Loading commit data...
rpc Loading commit data...
signer Loading commit data...
swarm Loading commit data...
tests Loading commit data...
trie Loading commit data...
.dockerignore Loading commit data...
.gitattributes Loading commit data...
.gitignore Loading commit data...
.gitmodules Loading commit data...
.golangci.yml Loading commit data...
.mailmap Loading commit data...
.travis.yml Loading commit data...
AUTHORS Loading commit data...
COPYING Loading commit data...
COPYING.LESSER Loading commit data...
Dockerfile Loading commit data...
Dockerfile.alltools Loading commit data...
Makefile Loading commit data...
README.md Loading commit data...
SECURITY.md Loading commit data...
appveyor.yml Loading commit data...
circle.yml Loading commit data...
go.mod Loading commit data...
go.sum Loading commit data...
interfaces.go Loading commit data...
oss-fuzz.sh Loading commit data...