1 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
use std::{future::IntoFuture, time::Duration};
use futures::{channel::mpsc, future::BoxFuture, FutureExt};
use serde::Serialize;
use crate::{graphql::GraphqlOperation, logging::trace, protocol::Event, Error};
use super::{
actor::ConnectionActor,
connection::{Connection, Message},
keepalive::KeepAliveSettings,
Client, Subscription,
};
/// Builder for Graphql over Websocket clients
///
/// This can be used to configure the client prior to construction, but can also create
/// subscriptions directly in the case where users only need to run one per connection.
///
/// ```rust
/// use graphql_ws_client::Client;
/// use std::future::IntoFuture;
/// #
/// # async fn example() -> Result<(), graphql_ws_client::Error> {
/// # let connection = graphql_ws_client::__doc_utils::Conn;
/// let (client, actor) = Client::build(connection).await?;
/// # Ok(())
/// # }
/// ```
pub struct ClientBuilder {
payload: Option<serde_json::Value>,
subscription_buffer_size: Option<usize>,
connection: Box<dyn Connection + Send>,
keep_alive: KeepAliveSettings,
}
impl super::Client {
/// Creates a ClientBuilder with the given connection.
///
/// ```rust
/// use graphql_ws_client::Client;
/// use std::future::IntoFuture;
/// # async fn example() -> Result<(), graphql_ws_client::Error> {
/// # let connection = graphql_ws_client::__doc_utils::Conn;
/// let (client, actor) = Client::build(connection).await?;
/// # Ok(())
/// # }
/// ```
pub fn build<Conn>(connection: Conn) -> ClientBuilder
where
Conn: Connection + Send + 'static,
{
ClientBuilder {
payload: None,
subscription_buffer_size: None,
connection: Box::new(connection),
keep_alive: KeepAliveSettings::default(),
}
}
}
impl ClientBuilder {
/// Add payload to `connection_init`
pub fn payload<NewPayload>(self, payload: NewPayload) -> Result<ClientBuilder, Error>
where
NewPayload: Serialize,
{
Ok(ClientBuilder {
payload: Some(
serde_json::to_value(payload)
.map_err(|error| Error::Serializing(error.to_string()))?,
),
..self
})
}
/// Sets the size of the incoming message buffer that subscriptions created by this client will
/// use
pub fn subscription_buffer_size(self, new: usize) -> Self {
ClientBuilder {
subscription_buffer_size: Some(new),
..self
}
}
/// Sets the interval between keep alives.
///
/// Any incoming messages automatically reset this interval so keep alives may not be sent
/// on busy connections even if this is set.
pub fn keep_alive_interval(mut self, new: Duration) -> Self {
self.keep_alive.interval = Some(new);
self
}
/// The number of keepalive retries before a connection is considered broken.
///
/// This defaults to 3, but has no effect if `keep_alive_interval` is not called.
pub fn keep_alive_retries(mut self, count: usize) -> Self {
self.keep_alive.retries = count;
self
}
/// Initialise a Client and use it to run a single subscription
///
/// ```rust
/// use graphql_ws_client::Client;
/// use std::future::IntoFuture;
/// # async fn example() -> Result<(), graphql_ws_client::Error> {
/// # let connection = graphql_ws_client::__doc_utils::Conn;
/// # let subscription = graphql_ws_client::__doc_utils::Subscription;
/// let stream = Client::build(connection).subscribe(subscription).await?;
/// # Ok(())
/// # }
/// ```
///
/// Note that this takes ownership of the client, so it cannot be
/// used to run any more operations.
///
/// If users want to run mutliple operations on a connection they
/// should use the `IntoFuture` impl to construct a `Client`
pub async fn subscribe<'a, Operation>(
self,
op: Operation,
) -> Result<Subscription<Operation>, Error>
where
Operation: GraphqlOperation + Unpin + Send + 'static,
{
let (client, actor) = self.await?;
let mut actor_future = actor.into_future().fuse();
let subscribe_future = client.subscribe(op).fuse();
futures::pin_mut!(subscribe_future);
// Temporarily run actor_future while we start the subscription
let stream = futures::select! {
() = actor_future => {
return Err(Error::Unknown("actor ended before subscription started".into()))
},
result = subscribe_future => {
result?
}
};
Ok(stream.join(actor_future))
}
}
impl IntoFuture for ClientBuilder {
type Output = Result<(Client, ConnectionActor), Error>;
type IntoFuture = BoxFuture<'static, Self::Output>;
fn into_future(self) -> Self::IntoFuture {
Box::pin(self.build())
}
}
impl ClientBuilder {
/// Constructs a Client
///
/// Accepts an already built websocket connection, and returns the connection
/// and a future that must be awaited somewhere - if the future is dropped the
/// connection will also drop.
pub async fn build(self) -> Result<(Client, ConnectionActor), Error> {
let Self {
payload,
subscription_buffer_size,
mut connection,
keep_alive,
} = self;
connection.send(Message::init(payload)).await?;
// wait for ack before entering receiver loop:
loop {
match connection.receive().await {
None => return Err(Error::Unknown("connection dropped".into())),
Some(Message::Close { code, reason }) => {
return Err(Error::Close(
code.unwrap_or_default(),
reason.unwrap_or_default(),
))
}
Some(Message::Ping) | Some(Message::Pong) => {}
Some(message @ Message::Text(_)) => {
let event = message.deserialize::<Event>()?;
match event {
// pings can be sent at any time
Event::Ping { .. } => {
connection.send(Message::graphql_pong()).await?;
}
Event::Pong { .. } => {}
Event::ConnectionAck { .. } => {
// handshake completed, ready to enter main receiver loop
trace!("connection_ack received, handshake completed");
break;
}
event => {
connection
.send(Message::Close {
code: Some(4950),
reason: Some("Unexpected message while waiting for ack".into()),
})
.await
.ok();
return Err(Error::Decode(format!(
"expected a connection_ack or ping, got {}",
event.r#type()
)));
}
}
}
}
}
let (command_sender, command_receiver) = mpsc::channel(5);
let actor = ConnectionActor::new(connection, command_receiver, keep_alive);
let client = Client::new_internal(command_sender, subscription_buffer_size.unwrap_or(5));
Ok((client, actor))
}
}