joerl 0.7.1

An Erlang-inspired actor model library for 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
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
//! Integration tests for joerl actor system.

use async_trait::async_trait;
use joerl::supervisor::{ChildSpec, RestartStrategy, SupervisorSpec, spawn_supervisor};
use joerl::{Actor, ActorContext, ActorSystem, ExitReason, Message, Signal};
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::time::{Duration, sleep};

struct CountingActor {
    counter: Arc<AtomicUsize>,
}

#[async_trait]
impl Actor for CountingActor {
    async fn handle_message(&mut self, msg: Message, _ctx: &mut ActorContext) {
        if msg.downcast_ref::<()>().is_some() {
            self.counter.fetch_add(1, Ordering::SeqCst);
        }
    }
}

#[tokio::test]
async fn test_actor_processes_messages() {
    let system = ActorSystem::new();
    let counter = Arc::new(AtomicUsize::new(0));

    let actor = system.spawn(CountingActor {
        counter: Arc::clone(&counter),
    });

    // Send messages
    for _ in 0..10 {
        actor.send(Box::new(())).await.unwrap();
    }

    sleep(Duration::from_millis(50)).await;
    assert_eq!(counter.load(Ordering::SeqCst), 10);
}

struct ExitActor {
    #[allow(dead_code)]
    should_panic: bool,
}

#[async_trait]
impl Actor for ExitActor {
    async fn handle_message(&mut self, msg: Message, ctx: &mut ActorContext) {
        if let Some(cmd) = msg.downcast_ref::<&str>() {
            match *cmd {
                "exit_normal" => ctx.stop(ExitReason::Normal),
                "exit_panic" => ctx.stop(ExitReason::Panic("intentional".to_string())),
                _ => {}
            }
        }
    }
}

#[tokio::test]
async fn test_actor_exit_normal() {
    let system = ActorSystem::new();
    let actor = system.spawn(ExitActor {
        should_panic: false,
    });
    let pid = actor.pid();

    actor.send(Box::new("exit_normal")).await.unwrap();
    sleep(Duration::from_millis(50)).await;

    assert!(!system.is_actor_alive(pid));
}

#[tokio::test]
async fn test_actor_link_propagates_failure() {
    let system = ActorSystem::new();

    struct LinkedActor {
        exit_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for LinkedActor {
        async fn started(&mut self, ctx: &mut ActorContext) {
            ctx.trap_exit(true);
        }

        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Exit { .. } = signal {
                self.exit_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let exit_counter = Arc::new(AtomicUsize::new(0));

    let actor1 = system.spawn(ExitActor { should_panic: true });
    let actor2 = system.spawn(LinkedActor {
        exit_received: Arc::clone(&exit_counter),
    });

    // Link the actors
    system.link(actor1.pid(), actor2.pid()).unwrap();

    // Make actor1 exit abnormally
    actor1.send(Box::new("exit_panic")).await.unwrap();

    sleep(Duration::from_millis(100)).await;

    // Actor2 should have received an EXIT signal
    assert_eq!(exit_counter.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn test_actor_monitor() {
    let system = ActorSystem::new();

    struct MonitoringActor {
        down_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for MonitoringActor {
        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Down { .. } = signal {
                self.down_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let down_counter = Arc::new(AtomicUsize::new(0));

    let actor1 = system.spawn(ExitActor { should_panic: true });
    let actor2 = system.spawn(MonitoringActor {
        down_received: Arc::clone(&down_counter),
    });

    // Monitor actor1 from actor2
    actor1.monitor(actor2.pid()).unwrap();

    // Make actor1 exit
    actor1.send(Box::new("exit_normal")).await.unwrap();

    sleep(Duration::from_millis(100)).await;

    // Actor2 should have received a DOWN signal
    assert_eq!(down_counter.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn test_mailbox_backpressure() {
    let system = ActorSystem::new();

    struct SlowActor;

    #[async_trait]
    impl Actor for SlowActor {
        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {
            // Process slowly
            sleep(Duration::from_millis(50)).await;
        }
    }

    let actor = system.spawn_with_capacity(SlowActor, 2);

    // First 2 sends should succeed immediately
    assert!(actor.try_send(Box::new(())).is_ok());
    assert!(actor.try_send(Box::new(())).is_ok());

    // Third should fail due to bounded mailbox
    assert!(actor.try_send(Box::new(())).is_err());

    sleep(Duration::from_millis(100)).await;

    // Now should succeed again
    assert!(actor.try_send(Box::new(())).is_ok());
}

#[tokio::test]
async fn test_actor_lifecycle_hooks() {
    let system = ActorSystem::new();
    let started = Arc::new(AtomicUsize::new(0));
    let stopped = Arc::new(AtomicUsize::new(0));

    struct LifecycleActor {
        started: Arc<AtomicUsize>,
        stopped: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for LifecycleActor {
        async fn started(&mut self, _ctx: &mut ActorContext) {
            self.started.fetch_add(1, Ordering::SeqCst);
        }

        async fn stopped(&mut self, _reason: &ExitReason, _ctx: &mut ActorContext) {
            self.stopped.fetch_add(1, Ordering::SeqCst);
        }

        async fn handle_message(&mut self, msg: Message, ctx: &mut ActorContext) {
            if let Some(cmd) = msg.downcast_ref::<&str>()
                && *cmd == "stop"
            {
                ctx.stop(ExitReason::Normal);
            }
        }
    }

    let actor = system.spawn(LifecycleActor {
        started: Arc::clone(&started),
        stopped: Arc::clone(&stopped),
    });

    sleep(Duration::from_millis(50)).await;
    assert_eq!(started.load(Ordering::SeqCst), 1);

    actor.send(Box::new("stop")).await.unwrap();
    sleep(Duration::from_millis(50)).await;
    assert_eq!(stopped.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn test_multiple_actors_concurrently() {
    let system = ActorSystem::new();

    struct SimpleActor;

    #[async_trait]
    impl Actor for SimpleActor {
        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {
            // Just process the message
        }
    }

    // Spawn multiple actors and verify they all start
    let actors: Vec<_> = (0..10).map(|_| system.spawn(SimpleActor)).collect();

    sleep(Duration::from_millis(50)).await;

    // Verify all actors are alive
    for actor in &actors {
        assert!(system.is_actor_alive(actor.pid()));
    }

    // Send a message to each actor
    for actor in &actors {
        actor.send(Box::new(())).await.unwrap();
    }

    sleep(Duration::from_millis(50)).await;

    // All actors should still be alive
    for actor in &actors {
        assert!(system.is_actor_alive(actor.pid()));
    }
}

#[tokio::test]
async fn test_actor_panic_notifies_links() {
    let system = ActorSystem::new();

    struct PanicActor;

    #[async_trait]
    impl Actor for PanicActor {
        async fn handle_message(&mut self, msg: Message, _ctx: &mut ActorContext) {
            if let Some(cmd) = msg.downcast_ref::<&str>()
                && *cmd == "panic"
            {
                panic!("intentional panic for testing");
            }
        }
    }

    struct LinkedActor {
        exit_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for LinkedActor {
        async fn started(&mut self, ctx: &mut ActorContext) {
            ctx.trap_exit(true);
        }

        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Exit { reason, .. } = signal
                && matches!(reason, ExitReason::Panic(_))
            {
                self.exit_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let exit_counter = Arc::new(AtomicUsize::new(0));

    let panic_actor = system.spawn(PanicActor);
    let linked_actor = system.spawn(LinkedActor {
        exit_received: Arc::clone(&exit_counter),
    });

    // Link the actors
    system.link(panic_actor.pid(), linked_actor.pid()).unwrap();
    let panic_pid = panic_actor.pid();

    // Trigger panic
    panic_actor.send(Box::new("panic")).await.unwrap();

    sleep(Duration::from_millis(200)).await;

    // Linked actor should have received EXIT signal with Panic reason
    assert_eq!(exit_counter.load(Ordering::SeqCst), 1);

    // Panicked actor should be cleaned up
    assert!(!system.is_actor_alive(panic_pid));
}

#[tokio::test]
async fn test_actor_panic_notifies_monitors() {
    let system = ActorSystem::new();

    struct PanicActor;

    #[async_trait]
    impl Actor for PanicActor {
        async fn handle_message(&mut self, msg: Message, _ctx: &mut ActorContext) {
            if let Some(cmd) = msg.downcast_ref::<&str>()
                && *cmd == "panic"
            {
                panic!("intentional panic for testing");
            }
        }
    }

    struct MonitorActor {
        down_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for MonitorActor {
        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Down { reason, .. } = signal
                && matches!(reason, ExitReason::Panic(_))
            {
                self.down_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let down_counter = Arc::new(AtomicUsize::new(0));

    let panic_actor = system.spawn(PanicActor);
    let monitor_actor = system.spawn(MonitorActor {
        down_received: Arc::clone(&down_counter),
    });

    // Monitor the panic actor
    panic_actor.monitor(monitor_actor.pid()).unwrap();
    let panic_pid = panic_actor.pid();

    // Trigger panic
    panic_actor.send(Box::new("panic")).await.unwrap();

    sleep(Duration::from_millis(200)).await;

    // Monitor should have received DOWN signal with Panic reason
    assert_eq!(down_counter.load(Ordering::SeqCst), 1);

    // Panicked actor should be cleaned up
    assert!(!system.is_actor_alive(panic_pid));
}

#[tokio::test]
async fn test_supervisor_restarts_panicked_child() {
    let system = Arc::new(ActorSystem::new());
    let panic_count = Arc::new(AtomicUsize::new(0));
    let panic_count_clone = Arc::clone(&panic_count);

    struct PanickingWorker {
        panic_count: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for PanickingWorker {
        async fn started(&mut self, _ctx: &mut ActorContext) {
            let count = self.panic_count.fetch_add(1, Ordering::SeqCst);
            // Only panic on first start, not on restart
            if count == 0 {
                panic!("intentional panic on first start");
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let spec = SupervisorSpec::new(RestartStrategy::OneForOne).child(ChildSpec::new(
        "worker",
        move || {
            Box::new(PanickingWorker {
                panic_count: Arc::clone(&panic_count_clone),
            })
        },
    ));

    let _supervisor = spawn_supervisor(&system, spec);

    // Wait for initial panic and restart
    sleep(Duration::from_millis(300)).await;

    // Worker should have been started twice: once (panic) and once (restart)
    let count = panic_count.load(Ordering::SeqCst);
    assert!(
        count >= 2,
        "Worker should have been restarted after panic, got {} starts",
        count
    );
}

#[tokio::test]
async fn test_panic_in_started_hook() {
    let system = ActorSystem::new();

    struct PanicInStarted;

    #[async_trait]
    impl Actor for PanicInStarted {
        async fn started(&mut self, _ctx: &mut ActorContext) {
            panic!("panic in started hook");
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    struct MonitorActor {
        down_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for MonitorActor {
        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Down { reason, .. } = signal
                && matches!(reason, ExitReason::Panic(_))
            {
                self.down_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let down_counter = Arc::new(AtomicUsize::new(0));

    let panic_actor = system.spawn(PanicInStarted);
    let monitor_actor = system.spawn(MonitorActor {
        down_received: Arc::clone(&down_counter),
    });

    panic_actor.monitor(monitor_actor.pid()).unwrap();
    let panic_pid = panic_actor.pid();

    sleep(Duration::from_millis(200)).await;

    // Monitor should receive DOWN even though panic happened in started
    assert_eq!(down_counter.load(Ordering::SeqCst), 1);
    assert!(!system.is_actor_alive(panic_pid));
}

#[tokio::test]
async fn test_panic_during_stopped_hook() {
    let system = ActorSystem::new();

    struct PanicInStopped;

    #[async_trait]
    impl Actor for PanicInStopped {
        async fn stopped(&mut self, _reason: &ExitReason, _ctx: &mut ActorContext) {
            // Even if stopped panics, monitor should be notified
            panic!("panic in stopped hook");
        }

        async fn handle_message(&mut self, msg: Message, ctx: &mut ActorContext) {
            if let Some(cmd) = msg.downcast_ref::<&str>()
                && *cmd == "stop"
            {
                ctx.stop(ExitReason::Normal);
            }
        }
    }

    struct MonitorActor {
        down_received: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl Actor for MonitorActor {
        async fn handle_signal(&mut self, signal: Signal, _ctx: &mut ActorContext) {
            if let Signal::Down { .. } = signal {
                self.down_received.fetch_add(1, Ordering::SeqCst);
            }
        }

        async fn handle_message(&mut self, _msg: Message, _ctx: &mut ActorContext) {}
    }

    let down_counter = Arc::new(AtomicUsize::new(0));

    let actor = system.spawn(PanicInStopped);
    let monitor_actor = system.spawn(MonitorActor {
        down_received: Arc::clone(&down_counter),
    });

    actor.monitor(monitor_actor.pid()).unwrap();

    actor.send(Box::new("stop")).await.unwrap();

    sleep(Duration::from_millis(200)).await;

    // Monitor should still be notified despite panic in stopped
    assert_eq!(down_counter.load(Ordering::SeqCst), 1);
}