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
use std::{
collections::HashMap,
pin::Pin,
sync::{Arc, Mutex},
};
use anyhow::Result;
use graphql_client::GraphQLQuery;
use serde::{Deserialize, Serialize};
use tokio::sync::{
broadcast::{self, Sender},
{mpsc, oneshot},
};
use tokio_stream::{wrappers::BroadcastStream, Stream, StreamExt};
use uuid::Uuid;
/// Subscription GraphQL response, returned from an active stream.
pub type BoxedSubscription<T> = Pin<
Box<
dyn Stream<Item = Option<graphql_client::Response<<T as GraphQLQuery>::ResponseData>>>
+ Send
+ Sync,
>,
>;
/// Payload contains the raw data received back from a GraphQL subscription.
/// At the point of receiving data, the only known fields are { id, type };
/// what's contained inside the `payload` field is unknown
/// until we attempt to deserialize it against a generated GraphQLQuery::ResponseData later.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Payload {
id: Uuid,
#[serde(rename = "type")]
payload_type: String,
payload: serde_json::Value,
}
impl Payload {
/// Returns an "init" payload to confirm the connection to the server.
pub fn init(id: Uuid) -> Self {
Self {
id,
payload_type: "connection_init".to_owned(),
payload: serde_json::Value::Null,
}
}
/// Returns a "subscribe" payload necessary for starting a new subscription.
pub fn subscribe<T: GraphQLQuery + Send + Sync>(
id: Uuid,
payload: &graphql_client::QueryBody<T::Variables>,
) -> Self {
Self {
id,
payload_type: "subscribe".to_owned(),
payload: serde_json::json!(payload),
}
}
/// Returns a "stop" payload for terminating the subscription in the GraphQL server.
fn stop(id: Uuid) -> Self {
Self {
id,
payload_type: "stop".to_owned(),
payload: serde_json::Value::Null,
}
}
/// Attempts to return a definitive ResponseData on the `payload` field, matched against
/// a generated `GraphQLQuery`.
fn response<T: GraphQLQuery + Send + Sync>(
&self,
) -> Option<graphql_client::Response<T::ResponseData>> {
serde_json::from_value::<graphql_client::Response<T::ResponseData>>(self.payload.clone())
.ok()
}
}
/// A single `SubscriptionClient` enables subscription multiplexing.
#[derive(Debug)]
pub struct SubscriptionClient {
tx: mpsc::UnboundedSender<Payload>,
subscriptions: Arc<Mutex<HashMap<Uuid, Sender<Payload>>>>,
_shutdown_tx: oneshot::Sender<()>,
}
impl SubscriptionClient {
/// Create a new subscription client.
/// `tx` is a channel for sending `Payload`s to the GraphQL server;
/// `rx` is a channel for `Payload` back.
pub fn new(
tx: mpsc::UnboundedSender<Payload>,
mut rx: mpsc::UnboundedReceiver<Payload>,
) -> Self {
// `oneshot` channel for cancelling the listener if `SubscriptionClient`` is dropped.
let (_shutdown_tx, mut shutdown_rx) = oneshot::channel::<()>();
let subscriptions = Arc::new(Mutex::new(HashMap::new()));
let subscriptions_clone = Arc::clone(&subscriptions);
// Spawn a handler for shutdown,
// and relaying received `Payload`s back to the relevant subscription.
let tx_clone = tx.clone();
tokio::spawn(async move {
loop {
tokio::select! {
// Break the loop if shutdown is triggered.
// This happens implicitly once the client goes out of scope.
_ = &mut shutdown_rx => {
let subscriptions = subscriptions_clone.lock().unwrap();
for id in subscriptions.keys() {
_ = tx_clone.send(Payload::stop(*id));
}
break
},
// Handle receiving payloads back `_from_` the server.
message = rx.recv() => {
match message {
Some(p) => {
let subscriptions = subscriptions_clone.lock().unwrap();
let s: Option<&Sender<Payload>> = subscriptions.get::<Uuid>(&p.id);
if let Some(s) = s {
_ = s.send(p);
}
}
None => {
subscriptions_clone.lock().unwrap().clear();
break;
},
}
}
}
}
});
Self {
tx,
subscriptions,
_shutdown_tx,
}
}
/// Start a new subscription request.
pub fn start<T: GraphQLQuery + Send + Sync>(
&self,
request_body: &graphql_client::QueryBody<T::Variables>,
) -> BoxedSubscription<T>
where
T: GraphQLQuery + Send + Sync,
<T as GraphQLQuery>::ResponseData: Unpin + Send + Sync + 'static,
{
// Generate a unique ID for the subscription.
// Subscriptions can be multiplexed over a single connection,
// so we'll keep a copy of this against the client to
// handle routing responses back to the relevant subscriber.
let id = Uuid::new_v4();
let (tx, rx) = broadcast::channel::<Payload>(100);
self.subscriptions.lock().unwrap().insert(id, tx);
// Initialize the connection with the relevant control messages.
_ = self.tx.send(Payload::init(id));
_ = self.tx.send(Payload::subscribe::<T>(id, request_body));
Box::pin(
BroadcastStream::new(rx)
.filter(Result::is_ok)
.map(|payload| payload.unwrap().response::<T>()),
)
}
}