client.rs 8.21 KB
Newer Older
1
// Copyright 2019-2021 Parity Technologies (UK) Ltd.
David's avatar
David committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

Maciej Hirsz's avatar
Maciej Hirsz committed
27
28
29
use std::sync::Arc;
use std::time::Duration;

Niklas Adolfsson's avatar
Niklas Adolfsson committed
30
use crate::transport::HttpTransportClient;
31
use crate::types::{ErrorResponse, Id, NotificationSer, ParamsSer, RequestSer, Response};
32
use async_trait::async_trait;
33
use jsonrpsee_core::client::{CertificateStore, ClientT, IdKind, RequestIdManager, Subscription, SubscriptionClientT};
34
use jsonrpsee_core::tracing::RpcTracing;
35
use jsonrpsee_core::{Error, TEN_MB_SIZE_BYTES};
36
use jsonrpsee_types::error::CallError;
37
use rustc_hash::FxHashMap;
38
use serde::de::DeserializeOwned;
39
use tracing_futures::Instrument;
Niklas Adolfsson's avatar
Niklas Adolfsson committed
40

Niklas Adolfsson's avatar
Niklas Adolfsson committed
41
42
43
44
/// Http Client Builder.
#[derive(Debug)]
pub struct HttpClientBuilder {
	max_request_body_size: u32,
David's avatar
David committed
45
	request_timeout: Duration,
46
	max_concurrent_requests: usize,
47
	certificate_store: CertificateStore,
48
	id_kind: IdKind,
49
	max_log_length: u32,
Niklas Adolfsson's avatar
Niklas Adolfsson committed
50
51
52
53
54
55
56
57
58
}

impl HttpClientBuilder {
	/// Sets the maximum size of a request body in bytes (default is 10 MiB).
	pub fn max_request_body_size(mut self, size: u32) -> Self {
		self.max_request_body_size = size;
		self
	}

David's avatar
David committed
59
60
61
62
63
64
	/// Set request timeout (default is 60 seconds).
	pub fn request_timeout(mut self, timeout: Duration) -> Self {
		self.request_timeout = timeout;
		self
	}

65
66
67
68
69
70
	/// Set max concurrent requests.
	pub fn max_concurrent_requests(mut self, max: usize) -> Self {
		self.max_concurrent_requests = max;
		self
	}

71
72
73
74
75
76
	/// Set which certificate store to use.
	pub fn certificate_store(mut self, certificate_store: CertificateStore) -> Self {
		self.certificate_store = certificate_store;
		self
	}

77
78
79
80
81
82
	/// Configure the data type of the request object ID (default is number).
	pub fn id_format(mut self, id_kind: IdKind) -> Self {
		self.id_kind = id_kind;
		self
	}

83
84
85
86
87
88
89
90
	/// Max length for logging for requests and responses in number characters.
	///
	/// Logs bigger than this limit will be truncated.
	pub fn set_max_logging_length(mut self, max: u32) -> Self {
		self.max_log_length = max;
		self
	}

Niklas Adolfsson's avatar
Niklas Adolfsson committed
91
92
	/// Build the HTTP client with target to connect to.
	pub fn build(self, target: impl AsRef<str>) -> Result<HttpClient, Error> {
93
94
95
		let transport =
			HttpTransportClient::new(target, self.max_request_body_size, self.certificate_store, self.max_log_length)
				.map_err(|e| Error::Transport(e.into()))?;
96
97
		Ok(HttpClient {
			transport,
98
			id_manager: Arc::new(RequestIdManager::new(self.max_concurrent_requests, self.id_kind)),
99
100
			request_timeout: self.request_timeout,
		})
Niklas Adolfsson's avatar
Niklas Adolfsson committed
101
102
103
104
105
	}
}

impl Default for HttpClientBuilder {
	fn default() -> Self {
106
107
108
109
		Self {
			max_request_body_size: TEN_MB_SIZE_BYTES,
			request_timeout: Duration::from_secs(60),
			max_concurrent_requests: 256,
110
			certificate_store: CertificateStore::Native,
111
			id_kind: IdKind::Number,
112
			max_log_length: 4096,
113
		}
Niklas Adolfsson's avatar
Niklas Adolfsson committed
114
115
116
	}
}

Niklas Adolfsson's avatar
Niklas Adolfsson committed
117
/// JSON-RPC HTTP Client that provides functionality to perform method calls and notifications.
118
#[derive(Debug, Clone)]
Niklas Adolfsson's avatar
Niklas Adolfsson committed
119
120
121
pub struct HttpClient {
	/// HTTP transport client.
	transport: HttpTransportClient,
David's avatar
David committed
122
123
	/// Request timeout. Defaults to 60sec.
	request_timeout: Duration,
124
	/// Request ID manager.
125
	id_manager: Arc<RequestIdManager>,
Niklas Adolfsson's avatar
Niklas Adolfsson committed
126
127
}

128
#[async_trait]
129
impl ClientT for HttpClient {
130
	async fn notification<'a>(&self, method: &'a str, params: Option<ParamsSer<'a>>) -> Result<(), Error> {
131
132
133
134
135
136
137
		let trace = RpcTracing::notification(method);
		let _enter = trace.span().enter();

		let notif = serde_json::to_string(&NotificationSer::new(method, params)).map_err(Error::ParseError)?;

		let fut = self.transport.send(notif).in_current_span();

138
		match tokio::time::timeout(self.request_timeout, fut).await {
David's avatar
David committed
139
140
			Ok(Ok(ok)) => Ok(ok),
			Err(_) => Err(Error::RequestTimeout),
141
			Ok(Err(e)) => Err(Error::Transport(e.into())),
David's avatar
David committed
142
		}
Niklas Adolfsson's avatar
Niklas Adolfsson committed
143
144
145
	}

	/// Perform a request towards the server.
146
	async fn request<'a, R>(&self, method: &'a str, params: Option<ParamsSer<'a>>) -> Result<R, Error>
147
	where
148
		R: DeserializeOwned,
149
	{
150
151
152
		let guard = self.id_manager.next_request_id()?;
		let id = guard.inner();
		let request = RequestSer::new(&id, method, params);
153
154
155
156
		let trace = RpcTracing::method_call(method);
		let _enter = trace.span().enter();

		let raw = serde_json::to_string(&request).map_err(Error::ParseError)?;
157

158
		let fut = self.transport.send_and_read_body(raw).in_current_span();
159
		let body = match tokio::time::timeout(self.request_timeout, fut).await {
David's avatar
David committed
160
			Ok(Ok(body)) => body,
161
162
163
164
165
166
			Err(_e) => {
				return Err(Error::RequestTimeout);
			}
			Ok(Err(e)) => {
				return Err(Error::Transport(e.into()));
			}
David's avatar
David committed
167
		};
Niklas Adolfsson's avatar
Niklas Adolfsson committed
168

David's avatar
David committed
169
		let response: Response<_> = match serde_json::from_slice(&body) {
170
171
			Ok(response) => response,
			Err(_) => {
Maciej Hirsz's avatar
Maciej Hirsz committed
172
				let err: ErrorResponse = serde_json::from_slice(&body).map_err(Error::ParseError)?;
173
				return Err(Error::Call(CallError::Custom(err.error_object().clone().into_owned())));
174
175
176
			}
		};

177
		if response.id == id {
178
179
180
181
			Ok(response.result)
		} else {
			Err(Error::InvalidRequestId)
		}
Niklas Adolfsson's avatar
Niklas Adolfsson committed
182
	}
183

184
	async fn batch_request<'a, R>(&self, batch: Vec<(&'a str, Option<ParamsSer<'a>>)>) -> Result<Vec<R>, Error>
185
	where
186
		R: DeserializeOwned + Default + Clone,
187
	{
188
189
		let guard = self.id_manager.next_request_ids(batch.len())?;
		let ids: Vec<Id> = guard.inner();
190
191
		let trace = RpcTracing::batch();
		let _enter = trace.span().enter();
192

193
		let mut batch_request = Vec::with_capacity(batch.len());
194
195
		// NOTE(niklasad1): `ID` is not necessarily monotonically increasing.
		let mut ordered_requests = Vec::with_capacity(batch.len());
196
		let mut request_set = FxHashMap::with_capacity_and_hasher(batch.len(), Default::default());
197
198

		for (pos, (method, params)) in batch.into_iter().enumerate() {
199
200
201
			batch_request.push(RequestSer::new(&ids[pos], method, params));
			ordered_requests.push(&ids[pos]);
			request_set.insert(&ids[pos], pos);
202
203
		}

204
205
206
207
		let fut = self
			.transport
			.send_and_read_body(serde_json::to_string(&batch_request).map_err(Error::ParseError)?)
			.in_current_span();
David's avatar
David committed
208

209
		let body = match tokio::time::timeout(self.request_timeout, fut).await {
David's avatar
David committed
210
211
			Ok(Ok(body)) => body,
			Err(_e) => return Err(Error::RequestTimeout),
212
			Ok(Err(e)) => return Err(Error::Transport(e.into())),
David's avatar
David committed
213
		};
214

215
		let rps: Vec<Response<_>> =
Maciej Hirsz's avatar
Maciej Hirsz committed
216
			serde_json::from_slice(&body).map_err(|_| match serde_json::from_slice::<ErrorResponse>(&body) {
217
				Ok(e) => Error::Call(CallError::Custom(e.error_object().clone().into_owned())),
218
219
				Err(e) => Error::ParseError(e),
			})?;
220
221
222
223

		// NOTE: `R::default` is placeholder and will be replaced in loop below.
		let mut responses = vec![R::default(); ordered_requests.len()];
		for rp in rps {
224
			let pos = match request_set.get(&rp.id) {
225
226
227
228
229
230
231
232
				Some(pos) => *pos,
				None => return Err(Error::InvalidRequestId),
			};
			responses[pos] = rp.result
		}
		Ok(responses)
	}
}
233
234

#[async_trait]
235
impl SubscriptionClientT for HttpClient {
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
	/// Send a subscription request to the server. Not implemented for HTTP; will always return [`Error::HttpNotImplemented`].
	async fn subscribe<'a, N>(
		&self,
		_subscribe_method: &'a str,
		_params: Option<ParamsSer<'a>>,
		_unsubscribe_method: &'a str,
	) -> Result<Subscription<N>, Error>
	where
		N: DeserializeOwned,
	{
		Err(Error::HttpNotImplemented)
	}

	/// Subscribe to a specific method. Not implemented for HTTP; will always return [`Error::HttpNotImplemented`].
	async fn subscribe_to_method<'a, N>(&self, _method: &'a str) -> Result<Subscription<N>, Error>
	where
		N: DeserializeOwned,
	{
		Err(Error::HttpNotImplemented)
	}
}