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.
use std::net::SocketAddr;
use std::time::Duration;
Niklas Adolfsson
committed
use futures::{SinkExt, StreamExt};
use jsonrpsee::core::error::SubscriptionClosed;
use jsonrpsee::core::server::access_control::{AccessControl, AccessControlBuilder};
use jsonrpsee::http_server::{HttpServerBuilder, HttpServerHandle};
use jsonrpsee::types::error::{ErrorObject, SUBSCRIPTION_CLOSED_WITH_ERROR};
use jsonrpsee::ws_server::{WsServerBuilder, WsServerHandle};
use jsonrpsee::RpcModule;
Niklas Adolfsson
committed
use tokio::time::interval;
use tokio_stream::wrappers::IntervalStream;
pub async fn websocket_server_with_subscription() -> (SocketAddr, WsServerHandle) {
let server = WsServerBuilder::default().build("127.0.0.1:0").await.unwrap();
let mut module = RpcModule::new(());
module.register_method("say_hello", |_, _| Ok("hello")).unwrap();
.register_subscription("subscribe_hello", "subscribe_hello", "unsubscribe_hello", |_, mut sink, _| {
let interval = interval(Duration::from_millis(50));
let stream = IntervalStream::new(interval).map(move |_| &"hello from subscription");
tokio::spawn(async move {
sink.pipe_from_stream(stream).await;
.register_subscription("subscribe_foo", "subscribe_foo", "unsubscribe_foo", |_, mut sink, _| {
let interval = interval(Duration::from_millis(100));
let stream = IntervalStream::new(interval).map(move |_| 1337_usize);
tokio::spawn(async move {
sink.pipe_from_stream(stream).await;
.register_subscription(
"subscribe_add_one",
"subscribe_add_one",
"unsubscribe_add_one",
|params, mut sink, _| {
let count = params.one::<usize>().map(|c| c.wrapping_add(1))?;
let wrapping_counter = futures::stream::iter((count..).cycle());
let interval = interval(Duration::from_millis(100));
let stream = IntervalStream::new(interval).zip(wrapping_counter).map(move |(_, c)| c);
tokio::spawn(async move {
sink.pipe_from_stream(stream).await;
});
Ok(())
},
)
.register_subscription("subscribe_noop", "subscribe_noop", "unsubscribe_noop", |_, mut sink, _| {
sink.accept().unwrap();
tokio::spawn(async move {
tokio::time::sleep(Duration::from_secs(1)).await;
let err = ErrorObject::owned(
SUBSCRIPTION_CLOSED_WITH_ERROR,
"Server closed the stream because it was lazy",
None::<()>,
);
sink.close(err);
Niklas Adolfsson
committed
module
.register_subscription("subscribe_5_ints", "n", "unsubscribe_5_ints", |_, mut sink, _| {
Niklas Adolfsson
committed
tokio::spawn(async move {
let interval = interval(Duration::from_millis(50));
let stream = IntervalStream::new(interval).zip(futures::stream::iter(1..=5)).map(|(_, c)| c);
match sink.pipe_from_stream(stream).await {
SubscriptionClosed::Success => {
sink.close(SubscriptionClosed::Success);
}
_ => unreachable!(),
}
});
Niklas Adolfsson
committed
})
.unwrap();
module
.register_subscription("can_reuse_subscription", "n", "u_can_reuse_subscription", |_, mut sink, _| {
Niklas Adolfsson
committed
tokio::spawn(async move {
let stream1 = IntervalStream::new(interval(Duration::from_millis(50)))
.zip(futures::stream::iter(1..=5))
.map(|(_, c)| c);
let stream2 = IntervalStream::new(interval(Duration::from_millis(50)))
.zip(futures::stream::iter(6..=10))
.map(|(_, c)| c);
let result = sink.pipe_from_stream(stream1).await;
assert!(matches!(result, SubscriptionClosed::Success));
match sink.pipe_from_stream(stream2).await {
SubscriptionClosed::Success => {
sink.close(SubscriptionClosed::Success);
}
_ => unreachable!(),
}
});
Niklas Adolfsson
committed
})
.unwrap();
module
.register_subscription(
"subscribe_with_err_on_stream",
"n",
"unsubscribe_with_err_on_stream",
move |_, mut sink, _| {
Niklas Adolfsson
committed
let err: &'static str = "error on the stream";
// Create stream that produce an error which will cancel the subscription.
Niklas Adolfsson
committed
let stream = futures::stream::iter(vec![Ok(1_u32), Err(err), Ok(2), Ok(3)]);
tokio::spawn(async move {
match sink.pipe_from_try_stream(stream).await {
SubscriptionClosed::Failed(e) => {
sink.close(e);
}
_ => unreachable!(),
}
});
Niklas Adolfsson
committed
},
)
.unwrap();
let server_handle = server.start(module).unwrap();
let server = WsServerBuilder::default().build("127.0.0.1:0").await.unwrap();
let mut module = RpcModule::new(());
module.register_method("say_hello", |_, _| Ok("hello")).unwrap();
module
.register_async_method("slow_hello", |_, _| async {
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
Ok("hello")
})
.unwrap();
Niklas Adolfsson
committed
/// Yields one item then sleeps for an hour.
pub async fn websocket_server_with_sleeping_subscription(tx: futures::channel::mpsc::Sender<()>) -> SocketAddr {
let server = WsServerBuilder::default().build("127.0.0.1:0").await.unwrap();
let addr = server.local_addr().unwrap();
let mut module = RpcModule::new(tx);
module
.register_subscription("subscribe_sleep", "n", "unsubscribe_sleep", |_, mut sink, mut tx| {
Niklas Adolfsson
committed
tokio::spawn(async move {
let interval = interval(Duration::from_secs(60 * 60));
let stream = IntervalStream::new(interval).zip(futures::stream::iter(1..=5)).map(|(_, c)| c);
sink.pipe_from_stream(stream).await;
let send_back = std::sync::Arc::make_mut(&mut tx);
send_back.send(()).await.unwrap();
});
Niklas Adolfsson
committed
})
.unwrap();
server.start(module).unwrap();
addr
}
pub async fn http_server() -> (SocketAddr, HttpServerHandle) {
http_server_with_access_control(AccessControlBuilder::default().build(), CorsLayer::default()).await
}
pub async fn http_server_with_access_control(acl: AccessControl, cors: CorsLayer) -> (SocketAddr, HttpServerHandle) {
let middleware = tower::ServiceBuilder::new().layer(cors);
let server = HttpServerBuilder::default()
.set_access_control(acl)
.health_api("/health", "system_health")
.unwrap()
.build("127.0.0.1:0")
.await
.unwrap();
module.register_method("say_hello", |_, _| Ok("hello")).unwrap();
module.register_method("notif", |_, _| Ok("")).unwrap();
module.register_method("system_health", |_, _| Ok(serde_json::json!({ "health": true }))).unwrap();
Niklas Adolfsson
committed
let handle = server.start(module).unwrap();
(addr, handle)