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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
use crate::data::{AuthenticationTokenRequest, Event, Request, RequestEnvelope, ResponseEnvelope};
use crate::error::{BoxError, Error};
use crate::service::BoxCloneApiService;
use crate::service::{
send_request, AuthenticationLayer, MakeApiService, ResponseWithToken, RetryPolicy,
};
use futures_util::StreamExt;
use std::borrow::Cow;
use std::error::Error as StdError;
use tokio::sync::mpsc;
use tokio::sync::mpsc::error::SendError;
use tokio_tower::MakeTransport;
use tower::reconnect::Reconnect;
use tower::util::BoxCloneService;
use tower::{Service, ServiceBuilder, ServiceExt};
/// A client for interacting with the VTube Studio API.
///
/// This is a wrapper on top of [`tower::Service`] that provides a convenient interface for
/// [`send`](Self::send)ing API requests and receiving structured data.
#[derive(Clone, Debug)]
pub struct Client<S = BoxCloneApiService> {
service: S,
}
/// A client event received outside of the typical request/response flow.
///
/// This includes [`Event`]s received from the API, as requested via
/// [`EventSubscriptionRequest`](crate::data::EventSubscriptionRequest).
#[non_exhaustive]
#[derive(Debug)]
pub enum ClientEvent {
/// The underlying event transport established a connection.
///
/// Note that by default, [`Client`] connects lazily, so this event might not be received until
/// after making the first request.
Connected,
/// The underlying event transport disconnected.
///
/// You can use this as a signal to resubscribe to events.
Disconnected,
/// Received new auth token.
NewAuthToken(String),
/// Event received from the API.
Api(Event),
/// Error received outside the request/response flow.
Error(Error),
}
impl Client<BoxCloneApiService> {
/// Creates a builder to configure a new client.
///
/// # Example
///
#[cfg_attr(feature = "tokio-tungstenite", doc = "```no_run")]
#[cfg_attr(not(feature = "tokio-tungstenite"), doc = "```ignore")]
/// # use vtubestudio::Client;
/// let (mut client, mut events) = Client::builder()
/// .auth_token(Some("...".to_string()))
/// .authentication("Plugin name", "Developer name", None)
/// .build_tungstenite();
/// ```
pub fn builder() -> ClientBuilder {
ClientBuilder::new()
}
}
impl<S> Client<S>
where
S: Service<RequestEnvelope, Response = ResponseEnvelope>,
Error: From<S::Error>,
{
/// Creates a new client from a [`Service`], if you want to provide your own custom middleware
/// or transport. Most users will probably want to use the [`builder`](Client::builder) helper.
pub fn new_from_service(service: S) -> Self {
Self { service }
}
/// Consumes this client and returns the underlying [`Service`].
pub fn into_service(self) -> S {
self.service
}
/// Sends a VTube Studio API request.
///
/// # Example
///
#[cfg_attr(feature = "tokio-tungstenite", doc = "```no_run")]
#[cfg_attr(not(feature = "tokio-tungstenite"), doc = "```ignore")]
/// # async fn run() -> Result<(), vtubestudio::error::BoxError> {
/// # use vtubestudio::Client;
/// use vtubestudio::data::StatisticsRequest;
///
/// # let (mut client, _) = Client::builder().build_tungstenite();
/// let resp = client.send(&StatisticsRequest {}).await?;
/// println!("VTube Studio has been running for {}ms", resp.uptime);
/// # Ok(())
/// # }
/// ```
pub async fn send<Req: Request>(&mut self, data: &Req) -> Result<Req::Response, Error> {
send_request(&mut self.service, data).await
}
}
/// A builder to configure a new [`Client`] with a set of recommended [`tower`] middleware.
///
/// * retrying requests on disconnect (using [`Reconnect`] and [`RetryPolicy`])
/// * if [`authentication`](Self::authentication) is provided, automatically reauthenticate and
/// retry when it encounters an auth error (using [`AuthenticationLayer`]).
///
/// # Example
///
#[cfg_attr(feature = "tokio-tungstenite", doc = "```no_run")]
#[cfg_attr(not(feature = "tokio-tungstenite"), doc = "```ignore")]
/// # async fn run() -> Result<(), vtubestudio::error::BoxError> {
/// use vtubestudio::{Client, ClientEvent};
///
/// // An auth token from a previous successful authentication request
/// let stored_token = Some("...".to_string());
///
/// let (mut client, mut events) = Client::builder()
/// .authentication("Plugin name", "Developer name", None)
/// .auth_token(stored_token)
/// .build_tungstenite();
///
/// tokio::spawn(async move {
/// while let Some(event) = events.next().await {
/// match event {
/// ClientEvent::NewAuthToken(token) =>
/// println!("Got new token: {token}"),
/// _ =>
/// println!("Received event {:?}", event),
/// }
/// }
/// });
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct ClientBuilder {
url: String,
retry_on_disconnect: bool,
request_buffer_size: usize,
event_buffer_size: usize,
auth_token: Option<String>,
token_request: Option<AuthenticationTokenRequest>,
}
impl Default for ClientBuilder {
fn default() -> Self {
Self {
url: "ws://localhost:8001".to_string(),
retry_on_disconnect: true,
request_buffer_size: 128,
event_buffer_size: 128,
auth_token: None,
token_request: None,
}
}
}
/// A wrapper for a [`mpsc::Receiver`] that yields client events.
#[derive(Debug)]
pub struct ClientEventStream {
receiver: mpsc::Receiver<ClientEvent>,
}
impl ClientEventStream {
/// Returns [`ClientEvent`]s.
///
/// # Example
///
#[cfg_attr(feature = "tokio-tungstenite", doc = "```no_run")]
#[cfg_attr(not(feature = "tokio-tungstenite"), doc = "```ignore")]
/// # async fn run() -> Result<(), vtubestudio::error::BoxError> {
/// use vtubestudio::{Client, ClientEvent};
/// use vtubestudio::data::EventData;
///
/// let (mut client, mut events) = Client::builder()
/// .authentication("Plugin name", "Developer name", None)
/// .build_tungstenite();
///
/// tokio::spawn(async move {
/// while let Some(event) = events.next().await {
/// match event {
/// ClientEvent::NewAuthToken(token) =>
/// println!("Got new token: {token}"),
/// _ =>
/// println!("Received event {:?}", event),
/// }
/// }
/// });
/// # Ok(())
/// # }
pub async fn next(&mut self) -> Option<ClientEvent> {
self.receiver.recv().await
}
/// Consume this receiver and return the underlying [`mpsc::Receiver`].
pub fn into_inner(self) -> mpsc::Receiver<ClientEvent> {
self.receiver
}
}
impl ClientBuilder {
/// Creates new builder with default values.
pub fn new() -> Self {
Self::default()
}
crate::cfg_feature! {
#![feature = "tokio-tungstenite"]
/// Consumes the builder and initializes a [`Client`] and [`ClientEventStream`] using
/// [`tokio_tungstenite`] as the underlying websocket transport library.
pub fn build_tungstenite(self) -> (Client, ClientEventStream)
{
use crate::service::maker::TungsteniteConnector;
self.build_connector(TungsteniteConnector)
}
}
/// If this is provided, whenever the underlying service encounters an authentication error, it
/// will try to obtain a new auth token and retry the request.
pub fn authentication<S1, S2, S3>(mut self, name: S1, developer: S2, icon: S3) -> Self
where
S1: Into<Cow<'static, str>>,
S2: Into<Cow<'static, str>>,
S3: Into<Option<Cow<'static, str>>>,
{
self.token_request = Some(AuthenticationTokenRequest {
plugin_name: name.into(),
plugin_developer: developer.into(),
plugin_icon: icon.into(),
});
self
}
/// Sets the websocket URL. The default value is `ws://localhost:8001`.
pub fn url<S: Into<String>>(mut self, url: S) -> Self {
self.url = url.into();
self
}
/// Initial token to use for reauthentication (if [`authentication`](Self::authentication) is
/// provided). This should be the result of a previous successful authentication attempt.
pub fn auth_token(mut self, token: Option<String>) -> Self {
self.auth_token = token;
self
}
/// Retry requests on disconnect. The default value is `true`.
pub fn retry_on_disconnect(mut self, retry: bool) -> Self {
self.retry_on_disconnect = retry;
self
}
/// The max number of outstanding requests/responses.
///
/// The default value is `128`.
pub fn request_buffer_size(mut self, size: usize) -> Self {
self.request_buffer_size = size;
self
}
/// The max capacity of the [`ClientEventStream`] buffer.
///
/// This represents the max number of unacknowledged new events before the client stops sending
/// them.
///
/// The default value is `128`.
pub fn event_buffer_size(mut self, size: usize) -> Self {
self.event_buffer_size = size;
self
}
/// Consumes the builder and initializes a [`Client`] and [`ClientEventStream`] using a custom
/// [`Service`].
///
/// Note the [`ClientEventStream`] will only yield [`ClientEvent::NewAuthToken`] events. To
/// receive all events, use [`ClientBuilder::build_connector`].
pub fn build_service<S>(self, service: S) -> (Client, ClientEventStream)
where
S: Service<RequestEnvelope, Response = ResponseEnvelope> + Send + 'static,
S::Error: Into<BoxError> + Send + Sync,
S::Future: Send,
{
let (event_tx, event_rx) = mpsc::channel(self.event_buffer_size);
let client = self.build_service_internal(service, event_tx, false);
let event_receiver = ClientEventStream { receiver: event_rx };
(client, event_receiver)
}
fn build_service_internal<S>(
self,
service: S,
event_tx: mpsc::Sender<ClientEvent>,
send_disconnect: bool,
) -> Client
where
S: Service<RequestEnvelope, Response = ResponseEnvelope> + Send + 'static,
S::Error: Into<BoxError> + Send + Sync,
S::Future: Send,
{
if send_disconnect {
if let Err(_) = event_tx.try_send(ClientEvent::Disconnected) {
tracing::warn!("Failed to send Disconnected event to EventStream on startup");
}
}
let policy = RetryPolicy::new()
.on_disconnect(self.retry_on_disconnect)
.on_auth_error(self.token_request.is_some());
let service = if let Some(token_req) = self.token_request {
BoxCloneService::new(
ServiceBuilder::new()
.retry(policy)
.and_then(|resp: ResponseWithToken| async move {
if let Some(token) = resp.new_token {
// Ignore send errors (the consumer probably isn't reading the stream)
let _ = event_tx.send(ClientEvent::NewAuthToken(token)).await;
}
Ok(resp.response)
})
.layer(AuthenticationLayer::new(token_req).with_token(self.auth_token))
.map_err(Error::from_boxed)
.buffer(self.request_buffer_size)
.service(service),
)
} else {
BoxCloneService::new(
ServiceBuilder::new()
.retry(policy)
.map_err(Error::from_boxed)
.buffer(self.request_buffer_size)
.service(service),
)
};
Client::new_from_service(service)
}
/// Consumes the builder and initializes a [`Client`] and [`ClientEventStream`] with a
/// connector.
///
/// The input connector should be a [`MakeTransport`] that meets the requirements of
/// [`Reconnect`].
pub fn build_connector<M>(self, connector: M) -> (Client, ClientEventStream)
where
M: MakeTransport<String, RequestEnvelope, Item = ResponseEnvelope> + Send + Clone + 'static,
M::Future: Send + 'static,
M::Transport: Send + 'static,
M::MakeError: StdError + Send + Sync + 'static,
M::Error: Send,
BoxError: From<M::Error> + From<M::SinkError>,
{
let (event_tx, event_rx) = mpsc::channel(self.event_buffer_size);
let event_tx_cloned = event_tx.clone();
let log_err = |result: Result<(), SendError<ClientEvent>>| {
if let Err(SendError(event)) = result {
tracing::warn!(
?event,
"Failed to send event to EventStream because buffer is full"
);
}
};
let service = MakeApiService::<M, String>::new(connector, self.request_buffer_size)
.map_response(move |(service, mut events)| {
let event_tx = event_tx.clone();
tokio::spawn(async move {
log_err(event_tx.send(ClientEvent::Connected).await);
while let Some(result) = events.next().await {
let event = result.map_or_else(ClientEvent::Error, ClientEvent::Api);
log_err(event_tx.send(event).await);
}
log_err(event_tx.send(ClientEvent::Disconnected).await);
});
service
});
let client = self.build_reconnecting_service_internal(service, event_tx_cloned);
let event_receiver = ClientEventStream { receiver: event_rx };
(client, event_receiver)
}
/// Consumes the builder and initializes a [`Client`] and [`ClientEventStream`] with a
/// reconnecting service.
///
/// The input service should be a [`MakeService`](tower::MakeService) that satisfies the
/// requirements of [`Reconnect`].
///
/// Note the [`ClientEventStream`] will only yield [`ClientEvent::NewAuthToken`] events. To
/// receive all events, use [`ClientBuilder::build_connector`].
pub fn build_reconnecting_service<S>(self, maker: S) -> (Client, ClientEventStream)
where
S: Service<String> + Send + 'static,
S::Error: StdError + Send + Sync,
S::Future: Send + Unpin,
S::Response: Service<RequestEnvelope, Response = ResponseEnvelope> + Send + 'static,
<S::Response as Service<RequestEnvelope>>::Error: StdError + Send + Sync,
<S::Response as Service<RequestEnvelope>>::Future: Send,
{
let service = Reconnect::new::<S, String>(maker, self.url.clone());
self.build_service(service)
}
fn build_reconnecting_service_internal<S>(
self,
maker: S,
event_tx: mpsc::Sender<ClientEvent>,
) -> Client
where
S: Service<String> + Send + 'static,
S::Error: StdError + Send + Sync,
S::Future: Send + Unpin,
S::Response: Service<RequestEnvelope, Response = ResponseEnvelope> + Send + 'static,
<S::Response as Service<RequestEnvelope>>::Error: StdError + Send + Sync,
<S::Response as Service<RequestEnvelope>>::Future: Send,
{
let service = Reconnect::new::<S, String>(maker, self.url.clone());
self.build_service_internal(service, event_tx, true)
}
}