rpc: backpressured RPC server (bump jsonrpsee 0.20) (#1313)

This is a rather big change in jsonrpsee, the major things in this bump
are:
- Server backpressure (the subscription impls are modified to deal with
that)
- Allow custom error types / return types (remove jsonrpsee::core::Error
and jsonrpee::core::CallError)
- Bug fixes (graceful shutdown in particular not used by substrate
anyway)
   - Less dependencies for the clients in particular
   - Return type requires Clone in method call responses
   - Moved to tokio channels
   - Async subscription API (not used in this PR)

Major changes in this PR:
- The subscriptions are now bounded and if subscription can't keep up
with the server it is dropped
- CLI: add parameter to configure the jsonrpc server bounded message
buffer (default is 64)
- Add our own subscription helper to deal with the unbounded streams in
substrate

The most important things in this PR to review is the added helpers
functions in `substrate/client/rpc/src/utils.rs` and the rest is pretty
much chore.

Regarding the "bounded buffer limit" it may cause the server to handle
the JSON-RPC calls
slower than before.

The message size limit is bounded by "--rpc-response-size" thus "by
default 10MB * 64 = 640MB"
but the subscription message size is not covered by this limit and could
be capped as well.

Hopefully the last release prior to 1.0, sorry in advance for a big PR

Previous attempt: https://github.com/paritytech/substrate/pull/13992

Resolves https://github.com/paritytech/polkadot-sdk/issues/748, resolves
https://github.com/paritytech/polkadot-sdk/issues/627
This commit is contained in:
Niklas Adolfsson
2024-01-23 09:55:13 +01:00
committed by GitHub
parent 76c37c930b
commit e16ef0861f
117 changed files with 1245 additions and 1090 deletions
+11 -10
View File
@@ -44,9 +44,9 @@
use std::sync::Arc;
use jsonrpsee::{
core::{async_trait, Error as JsonRpseeError, RpcResult},
core::async_trait,
proc_macros::rpc,
types::{error::CallError, ErrorObject},
types::{ErrorObject, ErrorObjectOwned},
};
use sc_client_api::StorageData;
@@ -80,13 +80,13 @@ pub enum Error<Block: BlockT> {
LightSyncStateExtensionNotFound,
}
impl<Block: BlockT> From<Error<Block>> for JsonRpseeError {
impl<Block: BlockT> From<Error<Block>> for ErrorObjectOwned {
fn from(error: Error<Block>) -> Self {
let message = match error {
Error::JsonRpc(s) => s,
_ => error.to_string(),
};
CallError::Custom(ErrorObject::owned(1, message, None::<()>)).into()
ErrorObject::owned(1, message, None::<()>)
}
}
@@ -126,10 +126,10 @@ pub struct LightSyncState<Block: BlockT> {
/// An api for sync state RPC calls.
#[rpc(client, server)]
pub trait SyncStateApi {
pub trait SyncStateApi<B: BlockT> {
/// Returns the JSON serialized chainspec running the node, with a sync state.
#[method(name = "sync_state_genSyncSpec")]
async fn system_gen_sync_spec(&self, raw: bool) -> RpcResult<serde_json::Value>;
async fn system_gen_sync_spec(&self, raw: bool) -> Result<serde_json::Value, Error<B>>;
}
/// An api for sync state RPC calls.
@@ -188,12 +188,12 @@ where
}
#[async_trait]
impl<Block, Backend> SyncStateApiServer for SyncState<Block, Backend>
impl<Block, Backend> SyncStateApiServer<Block> for SyncState<Block, Backend>
where
Block: BlockT,
Backend: HeaderBackend<Block> + sc_client_api::AuxStore + 'static,
{
async fn system_gen_sync_spec(&self, raw: bool) -> RpcResult<serde_json::Value> {
async fn system_gen_sync_spec(&self, raw: bool) -> Result<serde_json::Value, Error<Block>> {
let current_sync_state = self.build_sync_state().await?;
let mut chain_spec = self.chain_spec.cloned_box();
@@ -202,10 +202,11 @@ where
)
.ok_or(Error::<Block>::LightSyncStateExtensionNotFound)?;
let val = serde_json::to_value(&current_sync_state)?;
let val = serde_json::to_value(&current_sync_state)
.map_err(|e| Error::<Block>::JsonRpc(e.to_string()))?;
*extension = Some(val);
let json_str = chain_spec.as_json(raw).map_err(|e| Error::<Block>::JsonRpc(e))?;
serde_json::from_str(&json_str).map_err(Into::into)
serde_json::from_str(&json_str).map_err(|e| Error::<Block>::JsonRpc(e.to_string()))
}
}