Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rpc module: refactor calls/subs without a server #591

Merged
merged 13 commits into from
Dec 10, 2021
Merged

rpc module: refactor calls/subs without a server #591

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
adb955c
rpc module: refactor calls/subs without a server
niklasad1 Dec 6, 2021
f27efef
Update utils/src/server/rpc_module.rs
niklasad1 Dec 6, 2021
316172e
Update utils/src/server/rpc_module.rs
niklasad1 Dec 6, 2021
7bd19e6
Update utils/src/server/rpc_module.rs
niklasad1 Dec 6, 2021
e5d3879
rpc module: add raw_json_requests + rename test_subscribe
niklasad1 Dec 7, 2021
3a13a04
Merge remote-tracking branch 'origin/na-refactor-rpc-module-calls-sub…
niklasad1 Dec 7, 2021
f67fc69
Update utils/src/server/rpc_module.rs
niklasad1 Dec 8, 2021
9e4e3a1
add rustdoc examples
niklasad1 Dec 8, 2021
82d1728
fix tabs
niklasad1 Dec 9, 2021
1ce43ae
no more tabs in docs
niklasad1 Dec 9, 2021
4c26063
address grumbles
niklasad1 Dec 10, 2021
78c24c6
Merge remote-tracking branch 'origin' into na-refactor-rpc-module-cal…
niklasad1 Dec 10, 2021
4f430c4
Update utils/src/server/rpc_module.rs
niklasad1 Dec 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 25 additions & 27 deletions tests/tests/proc_macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ use jsonrpsee::{
ws_server::WsServerBuilder,
};

use serde_json::value::RawValue;
use serde_json::json;

mod rpc_impl {
use jsonrpsee::{
Expand Down Expand Up @@ -231,79 +231,77 @@ async fn proc_macros_generic_ws_client_api() {
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();
let res: String = module.call("foo_params", [json!(42_u64), json!("Hello")]).await.unwrap();

assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 42, Hello","id":0}"#);
assert_eq!(&res, "Called with: 42, Hello");
}

#[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}"#);
let res: String = module.call("foo_optional_params", [42_u64, 70]).await.unwrap();
assert_eq!(&res, "Called with: 42, Some(70), None");

// 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();
let res: String = module.call("foo_optional_params", [json!(42_u64), json!(null), json!(70_u64)]).await.unwrap();

assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: 42, None, Some(70)","id":0}"#);
assert_eq!(&res, "Called with: 42, None, Some(70)");

// 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}"#);
let (resp, _) = module
.raw_json_request(r#"{"jsonrpc":"2.0","method":"foo_optional_params","params":{"a":22,"c":50},"id":0}"#)
.await
.unwrap();
assert_eq!(resp, 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();
let res: String = module.call("foo_lifetimes", ["foo", "bar", "baz", "qux"]).await.unwrap();

assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Called with: foo, bar, baz, Some(\"qux\")","id":0}"#);
assert_eq!(&res, "Called with: foo, bar, baz, Some(\"qux\")");
}

#[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();
let (result, _) = module
.raw_json_request(r#"{"jsonrpc":"2.0","method":"foo_zero_copy_cow","params":["foo", "bar"],"id":0}"#)
.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();

let (result, _) = module
.raw_json_request(r#"{"jsonrpc":"2.0","method":"foo_zero_copy_cow","params":["\tfoo", "\tbar"],"id":0}"#)
.await
.unwrap();
assert_eq!(result, r#"{"jsonrpc":"2.0","result":"Zero copy params: false, false","id":0}"#);
}

// Disabled on MacOS as GH CI timings on Mac vary wildly (~100ms) making this test fail.
#[cfg(not(target_os = "macos"))]
#[tokio::test]
async fn multiple_blocking_calls_overlap() {
use jsonrpsee::types::EmptyParams;
use std::time::{Duration, Instant};

let module = RpcServerImpl.into_rpc();

let params = RawValue::from_string("[]".into()).ok();

let futures = std::iter::repeat_with(|| module.call("foo_blocking_call", params.clone())).take(4);
let futures = std::iter::repeat_with(|| module.call::<_, u64>("foo_blocking_call", EmptyParams::new())).take(4);
let now = Instant::now();
let results = futures::future::join_all(futures).await;
let elapsed = now.elapsed();

for result in results {
let result = serde_json::from_str::<serde_json::Value>(&result.unwrap()).unwrap();
assert_eq!(result["result"], 42);
assert_eq!(result.unwrap(), 42);
}

// Each request takes 50ms, added 10ms margin for scheduling
Expand Down
Loading