speare 0.4.2

actor-like thin abstraction over tokio::task and flume channels
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
mod sync_vec;

use derive_more::From;
use speare::{Actor, Backoff, Ctx, Limit, Node, PubSubError, Supervision};
use sync_vec::SyncVec;
use tokio::task;

// -- shared event type --------------------------------------------------------

#[derive(Clone)]
struct OrderPlaced {
    id: u32,
}

// -- Subscriber actor ---------------------------------------------------------

struct OrderSubscriber;

#[derive(From)]
enum OrderSubscriberMsg {
    Order(OrderPlaced),
}

impl Actor for OrderSubscriber {
    type Props = SyncVec<u32>;
    type Msg = OrderSubscriberMsg;
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.subscribe::<OrderPlaced>("orders").unwrap();
        Ok(OrderSubscriber)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        match msg {
            OrderSubscriberMsg::Order(o) => ctx.props().push(o.id).await,
        }

        Ok(())
    }
}

// -- Publisher actor ----------------------------------------------------------

struct OrderPublisher;

impl Actor for OrderPublisher {
    type Props = ();
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.publish("orders", OrderPlaced { id: 42 }).unwrap();
        Ok(OrderPublisher)
    }
}

// -- Tests --------------------------------------------------------------------

#[tokio::test]
async fn publish_delivers_to_subscriber() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    node.actor::<OrderSubscriber>(recvd.clone()).spawn();
    task::yield_now().await;

    // Act
    node.publish("orders", OrderPlaced { id: 42 }).unwrap();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![42]);
}

#[tokio::test]
async fn publish_delivers_to_multiple_subscribers() {
    // Arrange
    let mut node = Node::default();
    let recvd_a = SyncVec::<u32>::default();
    let recvd_b = SyncVec::<u32>::default();
    node.actor::<OrderSubscriber>(recvd_a.clone()).spawn();
    node.actor::<OrderSubscriber>(recvd_b.clone()).spawn();
    task::yield_now().await;

    // Act
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd_a.clone_vec().await, vec![42]);
    assert_eq!(recvd_b.clone_vec().await, vec![42]);
}

#[tokio::test]
async fn publish_to_empty_topic_is_noop() {
    // Arrange
    let mut node = Node::default();

    struct Pub;
    impl Actor for Pub {
        type Props = SyncVec<bool>;
        type Msg = ();
        type Err = ();

        async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
            let result = ctx.publish("nobody-listens", OrderPlaced { id: 1 });
            ctx.props().push(result.is_ok()).await;

            Ok(Pub)
        }
    }

    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<Pub>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

#[tokio::test]
async fn subscribe_type_mismatch_returns_error() {
    // Arrange
    let mut node = Node::default();
    node.actor::<OrderSubscriber>(SyncVec::default()).spawn();
    task::yield_now().await;

    struct WrongTypeSub;
    impl Actor for WrongTypeSub {
        type Props = SyncVec<bool>;
        type Msg = String;
        type Err = ();

        async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
            let result = ctx.subscribe::<String>("orders");
            ctx.props()
                .push(matches!(result, Err(PubSubError::TypeMismatch { .. })))
                .await;

            Ok(WrongTypeSub)
        }
    }

    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<WrongTypeSub>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

#[tokio::test]
async fn publish_type_mismatch_returns_error() {
    // Arrange
    let mut node = Node::default();
    node.actor::<OrderSubscriber>(SyncVec::default()).spawn();
    task::yield_now().await;

    struct WrongTypePub;
    impl Actor for WrongTypePub {
        type Props = SyncVec<bool>;
        type Msg = ();
        type Err = ();

        async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
            let result = ctx.publish("orders", "not an OrderPlaced".to_string());
            ctx.props()
                .push(matches!(result, Err(PubSubError::TypeMismatch { .. })))
                .await;

            Ok(WrongTypePub)
        }
    }

    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<WrongTypePub>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

// -- Cleanup on stop ----------------------------------------------------------

#[tokio::test]
async fn subscriptions_cleaned_up_on_stop() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    let sub_handle = node.actor::<OrderSubscriber>(recvd.clone()).spawn();
    task::yield_now().await;

    // Act
    sub_handle.stop();
    task::yield_now().await;
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, Vec::<u32>::new());
}

// -- Cleanup on restart -------------------------------------------------------

struct RestartSubscriber;

#[derive(Clone)]
struct TriggerFail;

#[derive(From)]
enum RestartSubMsg {
    Order(OrderPlaced),
    Fail(TriggerFail),
}

impl Actor for RestartSubscriber {
    type Props = SyncVec<u32>;
    type Msg = RestartSubMsg;
    type Err = String;

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.subscribe::<OrderPlaced>("orders").unwrap();
        Ok(RestartSubscriber)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        match msg {
            RestartSubMsg::Order(o) => {
                ctx.props().push(o.id).await;
                Ok(())
            }

            RestartSubMsg::Fail(_) => Err("forced".to_string()),
        }
    }
}

#[tokio::test]
async fn subscriptions_cleaned_up_on_restart_no_duplicates() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    let sub_handle = node
        .actor::<RestartSubscriber>(recvd.clone())
        .supervision(Supervision::Restart {
            max: Limit::None,
            backoff: Backoff::None,
        })
        .spawn();
    task::yield_now().await;

    // Act
    sub_handle.send(TriggerFail);
    task::yield_now().await;
    task::yield_now().await; // extra yield for restart cycle
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![42]);
}

// -- Dynamic subscribe from handle() -----------------------------------------

struct LazySubscriber;

struct DoSubscribe;

#[derive(From)]
enum LazySubMsg {
    Subscribe(DoSubscribe),
    Order(OrderPlaced),
}

impl Actor for LazySubscriber {
    type Props = SyncVec<u32>;
    type Msg = LazySubMsg;
    type Err = ();

    async fn init(_ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        Ok(LazySubscriber)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        match msg {
            LazySubMsg::Subscribe(_) => {
                ctx.subscribe::<OrderPlaced>("orders").unwrap();
            }

            LazySubMsg::Order(o) => {
                ctx.props().push(o.id).await;
            }
        }

        Ok(())
    }
}

#[tokio::test]
async fn subscribe_from_handle_works() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    let sub_handle = node.actor::<LazySubscriber>(recvd.clone()).spawn();
    task::yield_now().await;

    // Act & Assert

    // Not subscribed yet — publish should not deliver
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;
    assert_eq!(recvd.clone_vec().await, Vec::<u32>::new());

    // Now subscribe dynamically
    sub_handle.send(DoSubscribe);
    task::yield_now().await;

    // Publish again — should deliver this time
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;
    assert_eq!(recvd.clone_vec().await, vec![42]);
}

// -- Double subscribe to same topic -------------------------------------------

struct DoubleSubscriber;

#[derive(From)]
enum DoubleSubMsg {
    Order(OrderPlaced),
}

impl Actor for DoubleSubscriber {
    type Props = SyncVec<u32>;
    type Msg = DoubleSubMsg;
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.subscribe::<OrderPlaced>("orders").unwrap();
        ctx.subscribe::<OrderPlaced>("orders").unwrap();
        Ok(DoubleSubscriber)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        match msg {
            DoubleSubMsg::Order(o) => ctx.props().push(o.id).await,
        }
        Ok(())
    }
}

#[tokio::test]
async fn double_subscribe_delivers_message_twice() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    node.actor::<DoubleSubscriber>(recvd.clone()).spawn();
    task::yield_now().await;

    // Act
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![42, 42]);
}

#[tokio::test]
async fn double_subscribe_cleaned_up_fully_on_stop() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<u32>::default();
    let handle = node.actor::<DoubleSubscriber>(recvd.clone()).spawn();
    task::yield_now().await;

    // Act
    handle.stop();
    task::yield_now().await;
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, Vec::<u32>::new());
}

// -- Stale subscriber (channel closed) ----------------------------------------

#[tokio::test]
async fn publish_ignores_dead_subscriber_channels() {
    // Arrange
    let mut node = Node::default();
    let recvd_alive = SyncVec::<u32>::default();
    let recvd_dead = SyncVec::<u32>::default();
    let dead_handle = node.actor::<OrderSubscriber>(recvd_dead.clone()).spawn();
    node.actor::<OrderSubscriber>(recvd_alive.clone()).spawn();
    task::yield_now().await;

    // Act
    dead_handle.stop();
    task::yield_now().await;
    node.actor::<OrderPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd_alive.clone_vec().await, vec![42]);
    assert_eq!(recvd_dead.clone_vec().await, Vec::<u32>::new());
}

// -- Multi-topic per actor ----------------------------------------------------

#[derive(Clone)]
struct PaymentProcessed {
    amount: u32,
}

struct MultiTopicSubscriber;

#[derive(From)]
enum MultiTopicMsg {
    Order(OrderPlaced),
    Payment(PaymentProcessed),
}

impl Actor for MultiTopicSubscriber {
    type Props = (SyncVec<u32>, SyncVec<u32>);
    type Msg = MultiTopicMsg;
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.subscribe::<OrderPlaced>("orders").unwrap();
        ctx.subscribe::<PaymentProcessed>("payments").unwrap();
        Ok(MultiTopicSubscriber)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        match msg {
            MultiTopicMsg::Order(o) => ctx.props().0.push(o.id).await,
            MultiTopicMsg::Payment(p) => ctx.props().1.push(p.amount).await,
        }
        Ok(())
    }
}

struct PaymentPublisher;

impl Actor for PaymentPublisher {
    type Props = ();
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        ctx.publish("payments", PaymentProcessed { amount: 100 })
            .unwrap();
        Ok(PaymentPublisher)
    }
}

#[tokio::test]
async fn actor_subscribes_to_multiple_topics() {
    // Arrange
    let mut node = Node::default();
    let orders = SyncVec::<u32>::default();
    let payments = SyncVec::<u32>::default();
    node.actor::<MultiTopicSubscriber>((orders.clone(), payments.clone()))
        .spawn();
    task::yield_now().await;

    // Act
    node.actor::<OrderPublisher>(()).spawn();
    node.actor::<PaymentPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(orders.clone_vec().await, vec![42]);
    assert_eq!(payments.clone_vec().await, vec![100]);
}

#[tokio::test]
async fn multi_topic_subscriptions_cleaned_up_on_stop() {
    // Arrange
    let mut node = Node::default();
    let orders = SyncVec::<u32>::default();
    let payments = SyncVec::<u32>::default();
    let handle = node
        .actor::<MultiTopicSubscriber>((orders.clone(), payments.clone()))
        .spawn();
    task::yield_now().await;

    // Act
    handle.stop();
    task::yield_now().await;
    node.actor::<OrderPublisher>(()).spawn();
    node.actor::<PaymentPublisher>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(orders.clone_vec().await, Vec::<u32>::new());
    assert_eq!(payments.clone_vec().await, Vec::<u32>::new());
}