mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 16:57:58 +00:00
Niklas Adolfsson
e16ef0861f
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
77 lines
2.3 KiB
Rust
77 lines
2.3 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! RPC a lenient list or value type.
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// RPC list or value wrapper.
|
|
///
|
|
/// For some RPCs it's convenient to call them with either
|
|
/// a single value or a whole list of values to get a proper response.
|
|
/// In theory you could do a batch query, but it's:
|
|
/// 1. Less convenient in client libraries
|
|
/// 2. If the response value is small, the protocol overhead might be dominant.
|
|
///
|
|
/// Also it's nice to be able to maintain backward compatibility for methods that
|
|
/// were initially taking a value and now we want to expand them to take a list.
|
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
|
|
#[serde(untagged)]
|
|
pub enum ListOrValue<T> {
|
|
/// A list of values of given type.
|
|
List(Vec<T>),
|
|
/// A single value of given type.
|
|
Value(T),
|
|
}
|
|
|
|
impl<T> ListOrValue<T> {
|
|
/// Map every contained value using function `F`.
|
|
///
|
|
/// This allows to easily convert all values in any of the variants.
|
|
pub fn map<F: Fn(T) -> X, X>(self, f: F) -> ListOrValue<X> {
|
|
match self {
|
|
ListOrValue::List(v) => ListOrValue::List(v.into_iter().map(f).collect()),
|
|
ListOrValue::Value(v) => ListOrValue::Value(f(v)),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> From<T> for ListOrValue<T> {
|
|
fn from(n: T) -> Self {
|
|
ListOrValue::Value(n)
|
|
}
|
|
}
|
|
|
|
impl<T> From<Vec<T>> for ListOrValue<T> {
|
|
fn from(n: Vec<T>) -> Self {
|
|
ListOrValue::List(n)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::assert_deser;
|
|
|
|
#[test]
|
|
fn should_serialize_and_deserialize() {
|
|
assert_deser(r#"5"#, ListOrValue::Value(5_u64));
|
|
assert_deser(r#""str""#, ListOrValue::Value("str".to_string()));
|
|
assert_deser(r#"[1,2,3]"#, ListOrValue::List(vec![1_u64, 2_u64, 3_u64]));
|
|
}
|
|
}
|