dactor 0.3.3

An abstract framework for distributed actors in Rust
Documentation
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
//! Type-erased dispatch infrastructure for delivering messages to actors.
//!
//! This module provides the core dispatch types used by all dactor runtimes
//! (TestRuntime, ractor adapter, kameo adapter) to wrap concrete messages
//! into type-erased envelopes that know how to invoke the correct handler.

use std::any::Any;

use async_trait::async_trait;
use tokio_util::sync::CancellationToken;

use crate::actor::{Actor, ActorContext, ReduceHandler, Handler, ExpandHandler, TransformHandler};
use crate::errors::RuntimeError;
use crate::interceptor::{Disposition, SendMode};
use crate::message::Message;
use crate::stream::{StreamReceiver, StreamSender};

// ---------------------------------------------------------------------------
// Type-erased dispatch via async trait
// ---------------------------------------------------------------------------

/// Type-erased message envelope. Each concrete message type is wrapped in a
/// `TypedDispatch<M>`, `AskDispatch<M>`, `ExpandDispatch<M>`,
/// `ReduceDispatch<M>`, or `TransformDispatch<M>` that knows how to invoke
/// the appropriate handler.
#[async_trait]
pub trait Dispatch<A: Actor>: Send {
    /// Dispatch the message to the actor's handler.
    /// Returns the type-erased reply for ask (Some), or None for tell.
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult;

    /// The message as `&dyn Any` for interceptor inspection.
    fn message_any(&self) -> &dyn Any;

    /// The send mode (Tell, Ask, Stream, or Feed).
    fn send_mode(&self) -> SendMode;

    /// The message type name.
    fn message_type_name(&self) -> &'static str;

    /// Reject this dispatch — for ask/feed, sends the proper error to the caller.
    /// For tell/stream, silently drops.
    fn reject(self: Box<Self>, disposition: Disposition, interceptor_name: &str);

    /// Cancel this dispatch — sends RuntimeError::Cancelled to the caller.
    /// For tell/stream, silently drops.
    fn cancel(self: Box<Self>);

    /// The cancellation token for this dispatch (None for tell).
    fn cancel_token(&self) -> Option<CancellationToken>;
}

/// Convenience alias for a boxed dispatch envelope.
pub type BoxedDispatch<A> = Box<dyn Dispatch<A>>;

/// Type alias for the reply sender closure in DispatchResult.
pub type ReplySender = Box<dyn FnOnce(Box<dyn Any + Send>) + Send>;

/// Result of dispatching a message, including the type-erased reply for ask.
pub struct DispatchResult {
    /// The type-erased reply value (Some for ask, None for tell).
    pub reply: Option<Box<dyn Any + Send>>,
    /// Oneshot sender to deliver the reply to the caller (Some for ask).
    pub reply_sender: Option<ReplySender>,
}

impl DispatchResult {
    /// Create a result for tell (no reply).
    pub fn tell() -> Self {
        Self {
            reply: None,
            reply_sender: None,
        }
    }

    /// Send the reply to the caller (for ask). Must be called after interceptors inspect it.
    pub fn send_reply(self) {
        if let (Some(reply), Some(sender)) = (self.reply, self.reply_sender) {
            sender(reply);
        }
    }
}

// ---------------------------------------------------------------------------
// TypedDispatch (tell)
// ---------------------------------------------------------------------------

/// Tell envelope: carries the message for fire-and-forget delivery.
pub struct TypedDispatch<M: Message> {
    /// The message payload.
    pub msg: M,
}

#[async_trait]
impl<A, M> Dispatch<A> for TypedDispatch<M>
where
    A: Handler<M>,
    M: Message<Reply = ()>,
{
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult {
        actor.handle(self.msg, ctx).await;
        DispatchResult::tell()
    }

    fn message_any(&self) -> &dyn Any {
        &self.msg
    }

    fn send_mode(&self) -> SendMode {
        SendMode::Tell
    }

    fn message_type_name(&self) -> &'static str {
        std::any::type_name::<M>()
    }

    fn reject(self: Box<Self>, _: Disposition, _: &str) {}

    fn cancel(self: Box<Self>) {}

    fn cancel_token(&self) -> Option<CancellationToken> {
        None
    }
}

// ---------------------------------------------------------------------------
// AskDispatch
// ---------------------------------------------------------------------------

/// Ask envelope: carries the message and a oneshot sender for the reply.
pub struct AskDispatch<M: Message> {
    /// The message payload.
    pub msg: M,
    /// Channel to send the reply back to the caller.
    pub reply_tx: tokio::sync::oneshot::Sender<Result<M::Reply, RuntimeError>>,
    /// Optional cancellation token for the ask operation.
    pub cancel: Option<CancellationToken>,
}

#[async_trait]
impl<A, M> Dispatch<A> for AskDispatch<M>
where
    A: Handler<M>,
    M: Message,
{
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult {
        let reply = actor.handle(self.msg, ctx).await;
        let reply_any: Box<dyn Any + Send> = Box::new(reply);
        let reply_tx = self.reply_tx;
        DispatchResult {
            reply: Some(reply_any),
            reply_sender: Some(Box::new(move |boxed_reply| {
                if let Ok(reply) = boxed_reply.downcast::<M::Reply>() {
                    if reply_tx.send(Ok(*reply)).is_err() {
                        tracing::debug!(
                            "reply dropped — caller may have timed out or been cancelled"
                        );
                    }
                }
            })),
        }
    }

    fn message_any(&self) -> &dyn Any {
        &self.msg
    }

    fn send_mode(&self) -> SendMode {
        SendMode::Ask
    }

    fn message_type_name(&self) -> &'static str {
        std::any::type_name::<M>()
    }

    fn reject(self: Box<Self>, disposition: Disposition, interceptor_name: &str) {
        let error = match disposition {
            Disposition::Reject(reason) => RuntimeError::Rejected {
                interceptor: interceptor_name.to_string(),
                reason,
            },
            Disposition::Retry(retry_after) => RuntimeError::RetryAfter {
                interceptor: interceptor_name.to_string(),
                retry_after,
            },
            Disposition::Drop => RuntimeError::ActorNotFound(format!(
                "dropped by interceptor '{}'",
                interceptor_name
            )),
            _ => return,
        };
        let _ = self.reply_tx.send(Err(error));
    }

    fn cancel(self: Box<Self>) {
        let _ = self.reply_tx.send(Err(RuntimeError::Cancelled));
    }

    fn cancel_token(&self) -> Option<CancellationToken> {
        self.cancel.clone()
    }
}

// ---------------------------------------------------------------------------
// ExpandDispatch
// ---------------------------------------------------------------------------

/// Stream envelope: carries the message and a StreamSender for pushing items.
pub struct ExpandDispatch<M: Send + 'static, OutputItem: Send + 'static> {
    /// The message payload.
    pub msg: M,
    /// Sender for pushing stream reply items.
    pub sender: StreamSender<OutputItem>,
    /// Optional cancellation token for the stream.
    pub cancel: Option<CancellationToken>,
}

#[async_trait]
impl<A, M, OutputItem> Dispatch<A> for ExpandDispatch<M, OutputItem>
where
    A: ExpandHandler<M, OutputItem>,
    M: Send + 'static,
    OutputItem: Send + 'static,
{
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult {
        actor.handle_expand(self.msg, self.sender, ctx).await;
        DispatchResult::tell()
    }

    fn message_any(&self) -> &dyn Any {
        &self.msg
    }

    fn send_mode(&self) -> SendMode {
        SendMode::Expand
    }

    fn message_type_name(&self) -> &'static str {
        std::any::type_name::<M>()
    }

    fn reject(self: Box<Self>, _: Disposition, _: &str) {}

    fn cancel(self: Box<Self>) {}

    fn cancel_token(&self) -> Option<CancellationToken> {
        self.cancel.clone()
    }
}

// ---------------------------------------------------------------------------
// ReduceDispatch
// ---------------------------------------------------------------------------

/// Feed envelope: carries a StreamReceiver for items and a oneshot for the reply.
pub struct ReduceDispatch<InputItem: Send + 'static, Reply: Send + 'static> {
    /// Receiver for incoming stream items.
    pub receiver: StreamReceiver<InputItem>,
    /// Channel to send the final reply back to the caller.
    pub reply_tx: tokio::sync::oneshot::Sender<Result<Reply, RuntimeError>>,
    /// Optional cancellation token for the feed operation.
    pub cancel: Option<CancellationToken>,
}

#[async_trait]
impl<A, InputItem, Reply> Dispatch<A> for ReduceDispatch<InputItem, Reply>
where
    A: ReduceHandler<InputItem, Reply>,
    InputItem: Send + 'static,
    Reply: Send + 'static,
{
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult {
        let reply = actor.handle_reduce(self.receiver, ctx).await;
        let reply_any: Box<dyn Any + Send> = Box::new(reply);
        let reply_tx = self.reply_tx;
        DispatchResult {
            reply: Some(reply_any),
            reply_sender: Some(Box::new(move |boxed_reply| {
                if let Ok(reply) = boxed_reply.downcast::<Reply>() {
                    if reply_tx.send(Ok(*reply)).is_err() {
                        tracing::debug!(
                            "reply dropped — caller may have timed out or been cancelled"
                        );
                    }
                }
            })),
        }
    }

    fn message_any(&self) -> &dyn Any {
        // ReduceDispatch has no message — return unit
        &()
    }

    fn send_mode(&self) -> SendMode {
        SendMode::Reduce
    }

    fn message_type_name(&self) -> &'static str {
        std::any::type_name::<InputItem>()
    }

    fn reject(self: Box<Self>, disposition: Disposition, interceptor_name: &str) {
        let error = match disposition {
            Disposition::Reject(reason) => RuntimeError::Rejected {
                interceptor: interceptor_name.to_string(),
                reason,
            },
            Disposition::Retry(retry_after) => RuntimeError::RetryAfter {
                interceptor: interceptor_name.to_string(),
                retry_after,
            },
            Disposition::Drop => RuntimeError::ActorNotFound(format!(
                "dropped by interceptor '{}'",
                interceptor_name
            )),
            _ => return,
        };
        let _ = self.reply_tx.send(Err(error));
    }

    fn cancel(self: Box<Self>) {
        let _ = self.reply_tx.send(Err(RuntimeError::Cancelled));
    }

    fn cancel_token(&self) -> Option<CancellationToken> {
        self.cancel.clone()
    }
}

// ---------------------------------------------------------------------------
// TransformDispatch
// ---------------------------------------------------------------------------

/// Transform envelope: carries a StreamReceiver for input items and a
/// StreamSender for output items. The actor consumes input, produces output.
pub struct TransformDispatch<A, InputItem, OutputItem>
where
    A: TransformHandler<InputItem, OutputItem>,
    InputItem: Send + 'static,
    OutputItem: Send + 'static,
{
    /// Receiver for incoming stream items.
    pub receiver: StreamReceiver<InputItem>,
    /// Sender for pushing output items.
    pub sender: StreamSender<OutputItem>,
    /// Optional cancellation token.
    pub cancel: Option<CancellationToken>,
    /// Phantom data for the actor type.
    _phantom: std::marker::PhantomData<fn() -> A>,
}

impl<A, InputItem, OutputItem> TransformDispatch<A, InputItem, OutputItem>
where
    A: TransformHandler<InputItem, OutputItem>,
    InputItem: Send + 'static,
    OutputItem: Send + 'static,
{
    /// Create a new TransformDispatch.
    pub fn new(
        receiver: StreamReceiver<InputItem>,
        sender: StreamSender<OutputItem>,
        cancel: Option<CancellationToken>,
    ) -> Self {
        Self {
            receiver,
            sender,
            cancel,
            _phantom: std::marker::PhantomData,
        }
    }
}

#[async_trait]
impl<A, InputItem, OutputItem> Dispatch<A> for TransformDispatch<A, InputItem, OutputItem>
where
    A: TransformHandler<InputItem, OutputItem>,
    InputItem: Send + 'static,
    OutputItem: Send + 'static,
{
    async fn dispatch(self: Box<Self>, actor: &mut A, ctx: &mut ActorContext) -> DispatchResult {
        let mut receiver = self.receiver;
        let sender = self.sender;
        let cancel = self.cancel;
        let mut cancelled = false;

        while let Some(item) = receiver.recv().await {
            // Check cancellation before processing each item
            if let Some(ref token) = cancel {
                if token.is_cancelled() {
                    cancelled = true;
                    break;
                }
            }
            actor.handle_transform(item, &sender, ctx).await;
        }

        // Only call on_transform_complete if the stream ended normally (not cancelled)
        if !cancelled {
            actor.on_transform_complete(&sender, ctx).await;
        }

        DispatchResult::tell()
    }

    fn message_any(&self) -> &dyn Any {
        &()
    }

    fn send_mode(&self) -> SendMode {
        SendMode::Transform
    }

    fn message_type_name(&self) -> &'static str {
        std::any::type_name::<InputItem>()
    }

    fn reject(self: Box<Self>, _: Disposition, _: &str) {}

    fn cancel(self: Box<Self>) {}

    fn cancel_token(&self) -> Option<CancellationToken> {
        self.cancel.clone()
    }
}