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
//! wRPC transport client handle
use core::future::Future;
use core::mem;
use core::pin::pin;
use core::time::Duration;
use anyhow::Context as _;
use bytes::{Bytes, BytesMut};
use futures::TryStreamExt as _;
use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt as _};
use tokio::{select, try_join};
use tokio_util::codec::{Encoder as _, FramedRead};
use tracing::{debug, instrument, trace, Instrument as _};
use crate::{Deferred as _, Incoming, Index, TupleDecode, TupleEncode};
/// Client-side handle to a wRPC transport
pub trait Invoke: Send + Sync {
/// Transport-specific invocation context
type Context: Send + Sync;
/// Outgoing multiplexed byte stream
type Outgoing: AsyncWrite + Index<Self::Outgoing> + Send + Sync + Unpin + 'static;
/// Incoming multiplexed byte stream
type Incoming: AsyncRead + Index<Self::Incoming> + Send + Sync + Unpin + 'static;
/// Invoke function `func` on instance `instance`
///
/// Note, that compilation of code calling methods on [`Invoke`] implementations within [`Send`] async functions
/// may fail with hard-to-debug errors due to a compiler bug:
/// [https://github.com/rust-lang/rust/issues/96865](https://github.com/rust-lang/rust/issues/96865)
///
/// The following fails to compile with rustc 1.78.0:
///
/// ```compile_fail
/// use core::future::Future;
///
/// fn invoke_send<T>() -> impl Future<Output = anyhow::Result<(T::Outgoing, T::Incoming)>> + Send
/// where
/// T: wrpc_transport::Invoke<Context = ()> + Default,
/// {
/// async { T::default().invoke((), "compiler-bug", "free", "since".into(), [[Some(2024)].as_slice(); 0]).await }
/// }
/// ```
///
/// ```text
/// async { T::default().invoke((), "compiler-bug", "free", "since".into(), [[Some(2024)].as_slice(); 0]).await }
/// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ implementation of `AsRef` is not general enough
/// |
/// = note: `[&'0 [Option<usize>]; 0]` must implement `AsRef<[&'1 [Option<usize>]]>`, for any two lifetimes `'0` and `'1`...
/// = note: ...but it actually implements `AsRef<[&[Option<usize>]]>`
/// ```
///
/// The fix is to call [`send`](send_future::SendFuture::send) provided by [`send_future::SendFuture`], re-exported by this crate, on the future before awaiting:
/// ```
/// use core::future::Future;
/// use wrpc_transport::SendFuture as _;
///
/// fn invoke_send<T>() -> impl Future<Output = anyhow::Result<(T::Outgoing, T::Incoming)>> + Send
/// where
/// T: wrpc_transport::Invoke<Context = ()> + Default,
/// {
/// async { T::default().invoke((), "compiler-bug", "free", "since".into(), [[Some(2024)].as_slice(); 0]).send().await }
/// }
/// ```
fn invoke<P>(
&self,
cx: Self::Context,
instance: &str,
func: &str,
params: Bytes,
paths: impl AsRef<[P]> + Send,
) -> impl Future<Output = anyhow::Result<(Self::Outgoing, Self::Incoming)>> + Send
where
P: AsRef<[Option<usize>]> + Send + Sync;
}
/// Wrapper struct returned by [`InvokeExt::timeout`]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Timeout<'a, T: ?Sized> {
/// Inner [Invoke]
pub inner: &'a T,
/// Invocation timeout
pub timeout: Duration,
}
impl<T: Invoke> Invoke for Timeout<'_, T> {
type Context = T::Context;
type Outgoing = T::Outgoing;
type Incoming = T::Incoming;
#[instrument(level = "trace", skip(self, cx, params, paths))]
async fn invoke<P>(
&self,
cx: Self::Context,
instance: &str,
func: &str,
params: Bytes,
paths: impl AsRef<[P]> + Send,
) -> anyhow::Result<(Self::Outgoing, Self::Incoming)>
where
P: AsRef<[Option<usize>]> + Send + Sync,
{
tokio::time::timeout(
self.timeout,
self.inner.invoke(cx, instance, func, params, paths),
)
.await
.context("invocation timed out")?
}
}
/// Wrapper struct returned by [`InvokeExt::timeout_owned`]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct TimeoutOwned<T> {
/// Inner [Invoke]
pub inner: T,
/// Invocation timeout
pub timeout: Duration,
}
impl<T: Invoke> Invoke for TimeoutOwned<T> {
type Context = T::Context;
type Outgoing = T::Outgoing;
type Incoming = T::Incoming;
#[instrument(level = "trace", skip(self, cx, params, paths))]
async fn invoke<P>(
&self,
cx: Self::Context,
instance: &str,
func: &str,
params: Bytes,
paths: impl AsRef<[P]> + Send,
) -> anyhow::Result<(Self::Outgoing, Self::Incoming)>
where
P: AsRef<[Option<usize>]> + Send + Sync,
{
self.inner
.timeout(self.timeout)
.invoke(cx, instance, func, params, paths)
.await
}
}
/// Extension trait for [Invoke]
pub trait InvokeExt: Invoke {
/// Invoke function `func` on instance `instance` using typed `Params` and `Results`
#[instrument(level = "trace", skip(self, cx, params, paths))]
fn invoke_values<P, Params, Results>(
&self,
cx: Self::Context,
instance: &str,
func: &str,
params: Params,
paths: impl AsRef<[P]> + Send,
) -> impl Future<
Output = anyhow::Result<(
Results,
Option<impl Future<Output = anyhow::Result<()>> + Send + 'static>,
)>,
> + Send
where
P: AsRef<[Option<usize>]> + Send + Sync,
Params: TupleEncode<Self::Outgoing> + Send,
Results: TupleDecode<Self::Incoming> + Send,
<Params::Encoder as tokio_util::codec::Encoder<Params>>::Error:
std::error::Error + Send + Sync + 'static,
<Results::Decoder as tokio_util::codec::Decoder>::Error:
std::error::Error + Send + Sync + 'static,
{
async {
let mut buf = BytesMut::default();
let mut enc = Params::Encoder::default();
trace!("encoding parameters");
enc.encode(params, &mut buf)
.context("failed to encode parameters")?;
debug!("invoking function");
let (mut outgoing, incoming) = self
.invoke(cx, instance, func, buf.freeze(), paths)
.await
.context("failed to invoke function")?;
trace!("shutdown synchronous parameter channel");
outgoing
.shutdown()
.await
.context("failed to shutdown synchronous parameter channel")?;
let mut tx = enc.take_deferred().map(|tx| {
tokio::spawn(
async {
debug!("transmitting async parameters");
tx(outgoing, Vec::default())
.await
.context("failed to write async parameters")
}
.in_current_span(),
)
});
let mut dec = FramedRead::new(incoming, Results::Decoder::default());
let results = async {
debug!("receiving sync results");
dec.try_next()
.await
.context("failed to receive sync results")?
.context("incomplete results")
};
let results = if let Some(mut fut) = tx.take() {
let mut results = pin!(results);
select! {
res = &mut results => {
tx = Some(fut);
res?
}
res = &mut fut => {
res??;
results.await?
}
}
} else {
results.await?
};
trace!("received sync results");
let buffer = mem::take(dec.read_buffer_mut());
let rx = dec.decoder_mut().take_deferred();
let incoming = Incoming {
buffer,
inner: dec.into_inner(),
};
Ok((
results,
(tx.is_some() || rx.is_some()).then_some(
async {
match (tx, rx) {
(Some(tx), Some(rx)) => {
try_join!(
async {
debug!("receiving async results");
rx(incoming, Vec::default())
.await
.context("receiving async results failed")
},
async {
tx.await.context("transmitting async parameters failed")?
}
)?;
}
(Some(tx), None) => {
tx.await.context("transmitting async parameters failed")??;
}
(None, Some(rx)) => {
debug!("receiving async results");
rx(incoming, Vec::default())
.await
.context("receiving async results failed")?;
}
_ => {}
}
Ok(())
}
.in_current_span(),
),
))
}
}
/// Invoke function `func` on instance `instance` using typed `Params` and `Results`
/// This is like [`Self::invoke_values`], but it only results once all I/O is done
#[instrument(level = "trace", skip_all)]
fn invoke_values_blocking<P, Params, Results>(
&self,
cx: Self::Context,
instance: &str,
func: &str,
params: Params,
paths: impl AsRef<[P]> + Send,
) -> impl Future<Output = anyhow::Result<Results>> + Send
where
P: AsRef<[Option<usize>]> + Send + Sync,
Params: TupleEncode<Self::Outgoing> + Send,
Results: TupleDecode<Self::Incoming> + Send,
<Params::Encoder as tokio_util::codec::Encoder<Params>>::Error:
std::error::Error + Send + Sync + 'static,
<Results::Decoder as tokio_util::codec::Decoder>::Error:
std::error::Error + Send + Sync + 'static,
{
async {
let (ret, io) = self
.invoke_values(cx, instance, func, params, paths)
.await?;
if let Some(io) = io {
trace!("awaiting I/O completion");
io.await?;
}
Ok(ret)
}
}
/// Returns a [`Timeout`], wrapping [Self] with an implementation of [Invoke], which will
/// error, if call to [`Invoke::invoke`] does not return within a supplied `timeout`
fn timeout(&self, timeout: Duration) -> Timeout<'_, Self> {
Timeout {
inner: self,
timeout,
}
}
/// This is like [`InvokeExt::timeout`], but moves [Self] and returns corresponding [`TimeoutOwned`]
fn timeout_owned(self, timeout: Duration) -> TimeoutOwned<Self>
where
Self: Sized,
{
TimeoutOwned {
inner: self,
timeout,
}
}
}
impl<T: Invoke> InvokeExt for T {}
#[allow(dead_code)]
#[cfg(test)]
mod tests {
use core::future::Future;
use core::pin::Pin;
use std::sync::Arc;
use bytes::Bytes;
use futures::{Stream, StreamExt as _};
use send_future::SendFuture as _;
use super::*;
#[allow(clippy::manual_async_fn)]
fn invoke_values_send<T>() -> impl Future<
Output = anyhow::Result<(
Pin<Box<dyn Stream<Item = Vec<Pin<Box<dyn Future<Output = String> + Send>>>> + Send>>,
)>,
> + Send
where
T: Invoke<Context = ()> + Default,
{
async {
let wrpc = T::default();
let ((r0,), _) = wrpc
.invoke_values(
(),
"wrpc-test:integration/async",
"with-streams",
(),
[[None].as_slice()],
)
.send()
.await?;
Ok(r0)
}
}
async fn call_invoke<T: Invoke>(
i: &T,
cx: T::Context,
paths: Arc<[Arc<[Option<usize>]>]>,
) -> anyhow::Result<(T::Outgoing, T::Incoming)> {
i.invoke(cx, "foo", "bar", Bytes::default(), &paths).await
}
async fn call_invoke_async<T>() -> anyhow::Result<(Pin<Box<dyn Stream<Item = Bytes> + Send>>,)>
where
T: Invoke<Context = ()> + Default,
{
let wrpc = T::default();
let ((r0,), _) = wrpc
.invoke_values(
(),
"wrpc-test:integration/async",
"with-streams",
(),
[
[Some(1), Some(2)].as_slice(),
[None].as_slice(),
[Some(42)].as_slice(),
],
)
.await?;
Ok(r0)
}
trait Handler {
fn foo() -> impl Future<Output = anyhow::Result<()>>;
}
impl<T> Handler for T
where
T: Invoke<Context = ()> + Default,
{
async fn foo() -> anyhow::Result<()> {
let (st,) = call_invoke_async::<Self>().await?;
st.collect::<Vec<_>>().await;
Ok(())
}
}
}