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
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! Use async/await syntax with actix actors.
//!
//! # Example
//!
//! This example shows how you could implement a generic "pipeline adapter"
//! which allows turning any `Sink`/`Stream` pair (forming a request/response
//! pipeline) into an actix Actor.
//!
//! Responses are matched up with their requests according to the order
//! in which they were sent (so the first response corresponds to the
//! first request sent to the `Sink`, etc). This requires that our "send"
//! operations are strictly ordered, and this is difficult to achieve
//! in actix because async operations are normally allowed to interleave.
//!
//! Furthermore, although the sends must be atomic, we also want to be
//! able to have a large number of requests in-flight at any given time,
//! so the receiving part of the message handler must not require exclusive
//! access to the actor while it is waiting. As a result, abstractions
//! like the `AtomicResponse` type are too simplistic to help.
//!
//! To solve this problem, we use the [`critical_section`](critical_section)
//! function to allow specific parts of our message handler to be atomic.
//!
//! ```rust
//! use std::collections::VecDeque;
//! use std::pin::Pin;
//!
//! use futures::{Sink, SinkExt, Stream, channel::oneshot};
//! use actix::prelude::*;
//!
//! use actix_interop::{FutureInterop, with_ctx, critical_section};
//!
//! // Define our actor
//! pub struct PipelineAdapter<Req, Res, Err> {
//! sink: Option<Pin<Box<dyn Sink<Req, Error=Err>>>>,
//! in_flight_reqs: VecDeque<oneshot::Sender<Result<Res, Err>>>,
//! }
//!
//! // Implement a constructor
//! impl<Req, Res, Err> PipelineAdapter<Req, Res, Err>
//! where
//! Req: 'static,
//! Res: 'static,
//! Err: 'static,
//! {
//! pub fn new<Si, St>(sink: Si, stream: St) -> Addr<Self>
//! where
//! Si: Sink<Req, Error=Err> + 'static,
//! St: Stream<Item=Res> + 'static,
//! {
//! // Convert to a boxed trait object
//! let sink: Box<dyn Sink<Req, Error=Err>> = Box::new(sink);
//!
//! Self::create(|ctx| {
//! ctx.add_stream(stream);
//! Self {
//! sink: Some(sink.into()),
//! in_flight_reqs: VecDeque::new(),
//! }
//! })
//! }
//! }
//!
//! // Tell actix this is an actor using the default Context type
//! impl<Req, Res, Err> Actor for PipelineAdapter<Req, Res, Err>
//! where
//! Req: 'static,
//! Res: 'static,
//! Err: 'static,
//! {
//! type Context = Context<Self>;
//! }
//!
//! // Transform actix messages into the pipelines request/response protocol
//! impl<Req, Res, Err> Handler<Req> for PipelineAdapter<Req, Res, Err>
//! where
//! Req: Message<Result=Result<Res, Err>> + 'static,
//! Res: 'static,
//! Err: 'static,
//! {
//! type Result = ResponseActFuture<Self, Result<Res, Err>>; // <- Message response type
//!
//! fn handle(&mut self, msg: Req, _ctx: &mut Context<Self>) -> Self::Result {
//! async move {
//! let (tx, rx) = oneshot::channel();
//!
//! // Perform sends in a critical section so they are strictly ordered
//! critical_section::<Self, _>(async {
//! // Take the sink from the actor state
//! let mut sink = with_ctx(|actor: &mut Self, _| actor.sink.take())
//! .expect("Sink to be present");
//!
//! // Send the request
//! let res = sink.send(msg).await;
//!
//! // Put the sink back, and if the send was successful,
//! // record the in-flight request.
//! with_ctx(|actor: &mut Self, _| {
//! actor.sink = Some(sink);
//! match res {
//! Ok(()) => actor.in_flight_reqs.push_back(tx),
//! Err(e) => {
//! // Don't care if the receiver has gone away
//! let _ = tx.send(Err(e));
//! }
//! }
//! });
//! })
//! .await;
//!
//! // Wait for the result concurrently, so many requests can
//! // be pipelined at the same time.
//! rx.await.expect("Sender should not be dropped")
//! }
//! .interop_actor_boxed(self)
//! }
//! }
//!
//! // Process responses
//! impl<Req, Res, Err> StreamHandler<Res> for PipelineAdapter<Req, Res, Err>
//! where
//! Req: 'static,
//! Res: 'static,
//! Err: 'static,
//! {
//! fn handle(&mut self, msg: Res, _ctx: &mut Context<Self>) {
//! // When we receive a response, just pull the first in-flight
//! // request and forward on the result.
//! let _ = self.in_flight_reqs
//! .pop_front()
//! .expect("There to be an in-flight request")
//! .send(Ok(msg));
//! }
//! }
//! ```
//!
#![deny(missing_docs, warnings)]
use std::any::Any;
use std::future::Future;
use std::marker::PhantomData;
use std::pin::Pin;
use std::task::{Context, Poll};
use actix::{Actor, ActorFuture, ActorStream, AsyncContext, ResponseActFuture};
use futures::Stream;
use pin_project::pin_project;
use scoped_tls_hkt::scoped_thread_local;
use self::local_handle::local_handle;
mod local_handle;
scoped_thread_local!(static mut CURRENT_ACTOR_CTX: for<'a> (&'a mut dyn Any, &'a mut dyn Any));
fn set_actor_context<A, F, R>(actor: &mut A, ctx: &mut A::Context, f: F) -> R
where
A: Actor,
F: FnOnce() -> R,
{
CURRENT_ACTOR_CTX.set((actor, ctx), f)
}
/// May be called from within a future spawned onto an actor context to gain mutable access
/// to the actor's state and/or context. The future must have been wrapped using
/// [`interop_actor`](FutureInterop::interop_actor) or
/// [`interop_actor_boxed`](FutureInterop::interop_actor_boxed).
///
/// Nested calls to this function will panic, as only one mutable borrow can be given out
/// at a time.
pub fn with_ctx<A, F, R>(f: F) -> R
where
A: Actor + 'static,
F: FnOnce(&mut A, &mut A::Context) -> R,
{
CURRENT_ACTOR_CTX.with(|(actor, ctx)| {
let actor = actor
.downcast_mut()
.expect("Future was spawned onto the wrong actor");
let ctx = ctx
.downcast_mut()
.expect("Future was spawned onto the wrong actor");
f(actor, ctx)
})
}
/// May be called in the same places as [`with_ctx`](with_ctx) to run a chunk of async
/// code with exclusive access to an actor's state: no other futures spawned to this
/// actor will be polled during the critical section.
/// Unlike [`with_ctx`](with_ctx), calls to this function may be nested, although there
/// is little point in doing so. Calling [`with_ctx`](with_ctx) from within a critical
/// section is allowed (and expected).
pub fn critical_section<A: Actor, F: Future>(f: F) -> impl Future<Output = F::Output>
where
A::Context: AsyncContext<A>,
F: 'static,
{
let (f, handle) = local_handle(f);
with_ctx(|actor: &mut A, ctx: &mut A::Context| ctx.wait(f.interop_actor(actor)));
handle
}
/// Future to ActorFuture adapter returned by [`interop_actor`](FutureInterop::interop_actor).
#[pin_project]
#[derive(Debug)]
pub struct FutureInteropWrap<A: Actor, F> {
#[pin]
inner: F,
phantom: PhantomData<fn(&mut A, &mut A::Context)>,
}
impl<A: Actor, F: Future> FutureInteropWrap<A, F> {
fn new(inner: F) -> Self {
Self {
inner,
phantom: PhantomData,
}
}
}
impl<A: Actor, F: Future> ActorFuture<A> for FutureInteropWrap<A, F> {
type Output = F::Output;
fn poll(
self: Pin<&mut Self>,
actor: &mut A,
ctx: &mut A::Context,
task: &mut Context,
) -> Poll<Self::Output> {
set_actor_context(actor, ctx, || self.project().inner.poll(task))
}
}
/// Extension trait implemented for all futures. Import this trait to bring the
/// [`interop_actor`](FutureInterop::interop_actor) and
/// [`interop_actor_boxed`](FutureInterop::interop_actor_boxed) methods into scope.
pub trait FutureInterop<A: Actor>: Future + Sized {
/// Convert a future using the `with_ctx` or `critical_section` methods into an ActorFuture.
fn interop_actor(self, actor: &A) -> FutureInteropWrap<A, Self>;
/// Convert a future using the `with_ctx` or `critical_section` methods into a boxed
/// ActorFuture.
fn interop_actor_boxed(self, actor: &A) -> ResponseActFuture<A, Self::Output>
where
Self: 'static,
{
Box::pin(self.interop_actor(actor))
}
}
impl<A: Actor, F: Future> FutureInterop<A> for F {
fn interop_actor(self, _actor: &A) -> FutureInteropWrap<A, Self> {
FutureInteropWrap::new(self)
}
}
/// Stream to ActorStream adapter returned by [`interop_actor`](StreamInterop::interop_actor).
#[pin_project]
#[derive(Debug)]
pub struct StreamInteropWrap<A: Actor, S> {
#[pin]
inner: S,
phantom: PhantomData<fn(&mut A, &mut A::Context)>,
}
impl<A: Actor, S: Stream> StreamInteropWrap<A, S> {
fn new(inner: S) -> Self {
Self {
inner,
phantom: PhantomData,
}
}
}
impl<A: Actor, S: Stream> ActorStream<A> for StreamInteropWrap<A, S> {
type Item = S::Item;
fn poll_next(
self: Pin<&mut Self>,
actor: &mut A,
ctx: &mut A::Context,
task: &mut Context,
) -> Poll<Option<Self::Item>> {
set_actor_context(actor, ctx, || self.project().inner.poll_next(task))
}
}
/// Extension trait implemented for all streams. Import this trait to bring the
/// [`interop_actor`](StreamInterop::interop_actor) and
/// [`interop_actor_boxed`](StreamInterop::interop_actor_boxed) methods into scope.
pub trait StreamInterop<A: Actor>: Stream + Sized {
/// Convert a stream using the `with_ctx` or `critical_section` methods into an ActorStream.
fn interop_actor(self, actor: &A) -> StreamInteropWrap<A, Self>;
/// Convert a stream using the `with_ctx` or `critical_section` methods into a boxed
/// ActorStream.
fn interop_actor_boxed(self, actor: &A) -> Box<dyn ActorStream<A, Item = Self::Item>>
where
Self: 'static,
{
Box::new(self.interop_actor(actor))
}
}
impl<A: Actor, S: Stream> StreamInterop<A> for S {
fn interop_actor(self, _actor: &A) -> StreamInteropWrap<A, Self> {
StreamInteropWrap::new(self)
}
}
#[cfg(test)]
mod tests {
use super::{critical_section, with_ctx, FutureInterop};
use actix::prelude::*;
#[derive(Message)]
#[rtype(result = "Result<i32, ()>")] // we have to define the response type for `Sum` message
struct Sum(i32);
struct Summator {
field: i32,
}
impl Actor for Summator {
type Context = Context<Self>;
}
impl Handler<Sum> for Summator {
type Result = ResponseActFuture<Self, Result<i32, ()>>; // <- Message response type
fn handle(&mut self, msg: Sum, _ctx: &mut Context<Self>) -> Self::Result {
async move {
// Run some code with exclusive access to the actor
let accum = critical_section::<Self, _>(async {
with_ctx(move |a: &mut Self, _| {
a.field += msg.0;
a.field
})
})
.await;
// Return a result
Ok(accum)
}
.interop_actor_boxed(self)
}
}
impl StreamHandler<i32> for Summator {
fn handle(&mut self, msg: i32, _ctx: &mut Context<Self>) {
self.field += msg;
}
fn finished(&mut self, _ctx: &mut Context<Self>) {
assert_eq!(self.field, 10);
System::current().stop();
}
}
#[actix::test]
async fn can_run_future() -> Result<(), Box<dyn std::error::Error>> {
let addr = Summator { field: 0 }.start();
addr.send(Sum(3)).await.unwrap().unwrap();
let res = addr.send(Sum(4)).await?;
assert_eq!(res, Ok(7));
Ok(())
}
#[actix::test]
async fn can_run_stream() {
Summator::create(|ctx| {
ctx.add_stream(futures::stream::iter(1..5));
Summator { field: 0 }
});
}
mod pipeline {}
}