Newer
Older
// Copyright 2019-2021 Parity Technologies (UK) Ltd.
//
// 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.
//! Example of using proc macro to generate working client and server.
use std::net::SocketAddr;
use futures_channel::oneshot;
use jsonrpsee::{ws_client::*, ws_server::WsServerBuilder};
use serde_json::value::RawValue;
mod rpc_impl {
use jsonrpsee::{
proc_macros::rpc,
types::{async_trait, JsonRpcResult},
ws_server::SubscriptionSink,
};
#[rpc(client, server, namespace = "foo")]
pub trait Rpc {
#[method(name = "foo")]
async fn async_method(&self, param_a: u8, param_b: String) -> JsonRpcResult<u16>;
#[method(name = "bar")]
fn sync_method(&self) -> JsonRpcResult<u16>;
#[subscription(name = "sub", unsub = "unsub", item = String)]
fn sub(&self);
#[subscription(name = "echo", unsub = "no_more_echo", item = u32)]
fn sub_with_params(&self, val: u32);
#[method(name = "params")]
fn params(&self, a: u8, b: &str) -> JsonRpcResult<String> {
Ok(format!("Called with: {}, {}", a, b))
}
#[method(name = "optional_params")]
fn optional_params(&self, a: u32, b: Option<u32>, c: Option<u32>) -> JsonRpcResult<String> {
Ok(format!("Called with: {}, {:?}, {:?}", a, b, c))
}
#[method(name = "lifetimes")]
fn lifetimes(
&self,
a: &str,
b: &'_ str,
c: std::borrow::Cow<'_, str>,
d: Option<beef::Cow<'_, str>>,
) -> JsonRpcResult<String> {
Ok(format!("Called with: {}, {}, {}, {:?}", a, b, c, d))
}
#[method(name = "zero_copy_cow")]
fn zero_copy_cow(&self, a: std::borrow::Cow<'_, str>, b: beef::Cow<'_, str>) -> JsonRpcResult<String> {
Ok(format!("Zero copy params: {}, {}", matches!(a, std::borrow::Cow::Borrowed(_)), b.is_borrowed()))
pub struct RpcServerImpl;
#[async_trait]
impl RpcServer for RpcServerImpl {
async fn async_method(&self, _param_a: u8, _param_b: String) -> JsonRpcResult<u16> {
Ok(42u16)
fn sync_method(&self) -> JsonRpcResult<u16> {
Ok(10u16)
fn sub(&self, mut sink: SubscriptionSink) {
sink.send(&"Response_A").unwrap();
sink.send(&"Response_B").unwrap();
}
fn sub_with_params(&self, mut sink: SubscriptionSink, val: u32) {
sink.send(&val).unwrap();
sink.send(&val).unwrap();
}
// Use generated implementations of server and client.
use rpc_impl::{RpcClient, RpcServer, RpcServerImpl};
pub async fn websocket_server() -> SocketAddr {
let (server_started_tx, server_started_rx) = oneshot::channel();
std::thread::spawn(move || {
let rt = tokio::runtime::Runtime::new().unwrap();
let server = rt.block_on(WsServerBuilder::default().build("127.0.0.1:0")).unwrap();
rt.block_on(async move {
server_started_tx.send(server.local_addr().unwrap()).unwrap();
server.start(RpcServerImpl.into_rpc()).await
});
});
server_started_rx.await.unwrap()
}
#[tokio::test]
async fn proc_macros_generic_ws_client_api() {
let server_addr = websocket_server().await;
let server_url = format!("ws://{}", server_addr);
let client = WsClientBuilder::default().build(&server_url).await.unwrap();
assert_eq!(client.async_method(10, "a".into()).await.unwrap(), 42);
assert_eq!(client.sync_method().await.unwrap(), 10);
// Sub without params
let mut sub = client.sub().await.unwrap();
let first_recv = sub.next().await.unwrap();
assert_eq!(first_recv, Some("Response_A".to_string()));
let second_recv = sub.next().await.unwrap();
assert_eq!(second_recv, Some("Response_B".to_string()));
// Sub with params
let mut sub = client.sub_with_params(42).await.unwrap();
let first_recv = sub.next().await.unwrap();
assert_eq!(first_recv, Some(42));
let second_recv = sub.next().await.unwrap();
assert_eq!(second_recv, Some(42));
}
#[tokio::test]
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
async fn macro_param_parsing() {
let module = RpcServerImpl.into_rpc();
let params = RawValue::from_string(r#"[42, "Hello"]"#.into()).ok();
let result = module.call("foo_params", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 42, Hello","id":0}"#);
}
#[tokio::test]
async fn macro_optional_param_parsing() {
let module = RpcServerImpl.into_rpc();
// Optional param omitted at tail
let params = RawValue::from_string(r#"[42, 70]"#.into()).ok();
let result = module.call("foo_optional_params", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 42, Some(70), None","id":0}"#);
// Optional param using `null`
let params = RawValue::from_string(r#"[42, null, 70]"#.into()).ok();
let result = module.call("foo_optional_params", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 42, None, Some(70)","id":0}"#);
// Named params using a map
let params = RawValue::from_string(r#"{"a": 22, "c": 50}"#.into()).ok();
let result = module.call("foo_optional_params", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 22, None, Some(50)","id":0}"#);
}
#[tokio::test]
async fn macro_lifetimes_parsing() {
let module = RpcServerImpl.into_rpc();
let params = RawValue::from_string(r#"["foo", "bar", "baz", "qux"]"#.into()).ok();
let result = module.call("foo_lifetimes", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: foo, bar, baz, Some(\"qux\")","id":0}"#);
}
#[tokio::test]
async fn macro_zero_copy_cow() {
let module = RpcServerImpl.into_rpc();
let params = RawValue::from_string(r#"["foo", "bar"]"#.into()).ok();
let result = module.call("foo_zero_copy_cow", params).await.unwrap();
// std::borrow::Cow<str> always deserialized to owned variant here
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Zero copy params: false, true","id":0}"#);
// serde_json will have to allocate a new string to replace `\t` with byte 0x09 (tab)
let params = RawValue::from_string(r#"["\tfoo", "\tbar"]"#.into()).ok();
let result = module.call("foo_zero_copy_cow", params).await.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Zero copy params: false, false","id":0}"#);