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
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
//! Integration tests for persistence: EventSourced, DurableState, InMemoryStorage.
//!
//! These exercise the full lifecycle of persisting, snapshotting, and recovering
//! actors using the persistence traits directly (no TestRuntime spawning needed).

use async_trait::async_trait;
use dactor::actor::Actor;
use dactor::persistence::*;

// ── Counter actor (event-sourced) ───────────────────────────

#[derive(Debug, Clone)]
enum CounterEvent {
    Add(i64),
    Subtract(i64),
}

struct CounterActor {
    id: String,
    value: i64,
    last_seq: SequenceId,
}

impl CounterActor {
    fn new(id: &str) -> Self {
        Self {
            id: id.to_string(),
            value: 0,
            last_seq: SequenceId(0),
        }
    }
}

impl Actor for CounterActor {
    type Args = ();
    type Deps = ();
    fn create(_args: (), _deps: ()) -> Self {
        CounterActor::new("default")
    }
}

impl PersistentActor for CounterActor {
    fn persistence_id(&self) -> PersistenceId {
        PersistenceId::new("Counter", &self.id)
    }
}

#[async_trait]
impl EventSourced for CounterActor {
    type Event = CounterEvent;

    fn apply(&mut self, event: &CounterEvent) {
        match event {
            CounterEvent::Add(v) => self.value += v,
            CounterEvent::Subtract(v) => self.value -= v,
        }
    }

    fn serialize_event(&self, event: &CounterEvent) -> Result<Vec<u8>, PersistError> {
        let bytes = match event {
            CounterEvent::Add(v) => [b"A:".as_slice(), &v.to_le_bytes()].concat(),
            CounterEvent::Subtract(v) => [b"S:".as_slice(), &v.to_le_bytes()].concat(),
        };
        Ok(bytes)
    }

    fn deserialize_event(&self, payload: &[u8]) -> Result<CounterEvent, PersistError> {
        if payload.len() != 10 {
            return Err(PersistError::SerializationFailed(
                format!("expected 10 bytes, got {}", payload.len()),
            ));
        }
        let val = i64::from_le_bytes(payload[2..10].try_into().unwrap());
        match &payload[..2] {
            b"A:" => Ok(CounterEvent::Add(val)),
            b"S:" => Ok(CounterEvent::Subtract(val)),
            _ => Err(PersistError::SerializationFailed("unknown tag".into())),
        }
    }

    fn snapshot_payload(&self) -> Result<Vec<u8>, PersistError> {
        Ok(self.value.to_le_bytes().to_vec())
    }

    fn restore_snapshot(&mut self, payload: Vec<u8>) -> Result<(), PersistError> {
        if payload.len() != 8 {
            return Err(PersistError::SerializationFailed("bad snapshot len".into()));
        }
        self.value = i64::from_le_bytes(payload.try_into().unwrap());
        Ok(())
    }

    fn last_sequence_id(&self) -> SequenceId {
        self.last_seq
    }

    fn set_last_sequence_id(&mut self, seq: SequenceId) {
        self.last_seq = seq;
    }
}

// ── Config actor (durable state) ────────────────────────────

struct ConfigActor {
    id: String,
    data: String,
}

impl ConfigActor {
    fn new(id: &str) -> Self {
        Self {
            id: id.to_string(),
            data: String::new(),
        }
    }
}

impl Actor for ConfigActor {
    type Args = ();
    type Deps = ();
    fn create(_args: (), _deps: ()) -> Self {
        ConfigActor::new("default")
    }
}

impl PersistentActor for ConfigActor {
    fn persistence_id(&self) -> PersistenceId {
        PersistenceId::new("Config", &self.id)
    }
}

#[async_trait]
impl DurableState for ConfigActor {
    fn serialize_state(&self) -> Result<Vec<u8>, PersistError> {
        Ok(self.data.as_bytes().to_vec())
    }

    fn restore_state(&mut self, payload: Vec<u8>) -> Result<(), PersistError> {
        self.data = String::from_utf8(payload)
            .map_err(|e| PersistError::SerializationFailed(e.to_string()))?;
        Ok(())
    }
}

// ── Tests ───────────────────────────────────────────────────

#[tokio::test]
async fn test_event_sourced_full_lifecycle() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("lifecycle");

    // Persist 5 events, verify state after each.
    let expected_values = [10, 15, 12, 22, 17];
    let events = [
        CounterEvent::Add(10),
        CounterEvent::Add(5),
        CounterEvent::Subtract(3),
        CounterEvent::Add(10),
        CounterEvent::Subtract(5),
    ];
    for (i, event) in events.into_iter().enumerate() {
        actor.persist(event, &storage).await.unwrap();
        assert_eq!(actor.value, expected_values[i], "mismatch after event {}", i);
    }
    assert_eq!(actor.last_sequence_id(), SequenceId(5));

    // Take a snapshot at seq 5.
    actor.snapshot(&storage).await.unwrap();

    // Persist 3 more events after the snapshot.
    actor.persist(CounterEvent::Add(100), &storage).await.unwrap();
    actor.persist(CounterEvent::Subtract(7), &storage).await.unwrap();
    actor.persist(CounterEvent::Add(3), &storage).await.unwrap();

    // Final state = 17 + 100 - 7 + 3 = 113
    assert_eq!(actor.value, 113);
    assert_eq!(actor.last_sequence_id(), SequenceId(8));
}

#[tokio::test]
async fn test_event_sourced_recovery_from_events() {
    let storage = InMemoryStorage::new();

    // Persist 10 events via a first actor.
    let mut actor = CounterActor::new("evonly");
    for i in 1..=10 {
        actor
            .persist(CounterEvent::Add(i as i64), &storage)
            .await
            .unwrap();
    }
    let expected_sum: i64 = (1..=10).sum(); // 55
    assert_eq!(actor.value, expected_sum);

    // Recover into a fresh actor — events only, no snapshot.
    let mut recovered = CounterActor::new("evonly");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();

    assert_eq!(recovered.value, expected_sum);
    assert_eq!(recovered.last_sequence_id(), SequenceId(10));
}

#[tokio::test]
async fn test_event_sourced_recovery_with_snapshot() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("snaprec");

    // Persist 5 events.
    for i in 1..=5 {
        actor
            .persist(CounterEvent::Add(i * 10), &storage)
            .await
            .unwrap();
    }
    // value = 10+20+30+40+50 = 150
    assert_eq!(actor.value, 150);

    // Take a snapshot at seq 5.
    actor.snapshot(&storage).await.unwrap();

    // Persist 5 more events.
    for i in 1..=5 {
        actor
            .persist(CounterEvent::Subtract(i), &storage)
            .await
            .unwrap();
    }
    // value = 150 - (1+2+3+4+5) = 135
    assert_eq!(actor.value, 135);

    // Recover into a fresh actor — should load snapshot(150) + replay 5 events.
    let mut recovered = CounterActor::new("snaprec");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();

    assert_eq!(recovered.value, 135);
    assert_eq!(recovered.last_sequence_id(), SequenceId(10));
}

#[tokio::test]
async fn test_durable_state_save_and_recover() {
    let storage = InMemoryStorage::new();

    let mut actor = ConfigActor::new("cfg1");
    actor.data = "persistent-value-42".to_string();
    DurableState::save_state(&actor, &storage as &dyn StateStorage)
        .await
        .unwrap();

    // Recover into a fresh actor.
    let mut recovered = ConfigActor::new("cfg1");
    assert_eq!(recovered.data, "");
    recover_durable_state(&mut recovered, &storage).await.unwrap();

    assert_eq!(recovered.data, "persistent-value-42");
}

#[tokio::test]
async fn test_event_sourced_batch_persist() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("batch");

    let events: Vec<CounterEvent> = (1..=10).map(CounterEvent::Add).collect();
    let seq = actor.persist_batch(events, &storage).await.unwrap();

    let expected_sum: i64 = (1..=10).sum(); // 55
    assert_eq!(actor.value, expected_sum);
    assert_eq!(seq, SequenceId(10));
    assert_eq!(actor.last_sequence_id(), SequenceId(10));

    // Verify all events are in the journal.
    let pid = actor.persistence_id();
    let entries = storage.read_events(&pid, SequenceId(1)).await.unwrap();
    assert_eq!(entries.len(), 10);

    // Verify batch content by recovering a fresh actor from the journal.
    let mut recovered = CounterActor::new("batch");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();
    assert_eq!(recovered.value, expected_sum, "recovered state should match batch sum");
    assert_eq!(recovered.last_sequence_id(), SequenceId(10));
}

#[tokio::test]
async fn test_journal_cleanup_after_snapshot() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("cleanup");

    // Persist 10 events.
    for i in 1..=10 {
        actor
            .persist(CounterEvent::Add(i * 2), &storage)
            .await
            .unwrap();
    }
    // value = 2+4+6+8+10+12+14+16+18+20 = 110
    assert_eq!(actor.value, 110);

    // Snapshot at seq 10.
    actor.snapshot(&storage).await.unwrap();

    // Delete all journal events up to seq 10.
    let pid = actor.persistence_id();
    storage.delete_events_to(&pid, SequenceId(10)).await.unwrap();

    // Verify no events remain.
    let remaining = storage.read_events(&pid, SequenceId(1)).await.unwrap();
    assert!(remaining.is_empty());

    // Recover — should use snapshot only (no events to replay).
    let mut recovered = CounterActor::new("cleanup");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();

    assert_eq!(recovered.value, 110);
    assert_eq!(recovered.last_sequence_id(), SequenceId(10));
}

#[tokio::test]
async fn test_empty_recovery_creates_fresh_actor() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("fresh");

    // No events, no snapshot — recover should succeed with defaults.
    recover_event_sourced(&mut actor, &storage, &storage)
        .await
        .unwrap();

    assert_eq!(actor.value, 0);
    assert_eq!(actor.last_sequence_id(), SequenceId(0));
}

#[tokio::test]
async fn test_multiple_actors_independent_persistence() {
    let storage = InMemoryStorage::new();

    // Actor A: adds 10, 20, 30 → 60
    let mut actor_a = CounterActor::new("alpha");
    actor_a.persist(CounterEvent::Add(10), &storage).await.unwrap();
    actor_a.persist(CounterEvent::Add(20), &storage).await.unwrap();
    actor_a.persist(CounterEvent::Add(30), &storage).await.unwrap();
    assert_eq!(actor_a.value, 60);

    // Actor B: subtracts 5, adds 100 → 95
    let mut actor_b = CounterActor::new("beta");
    actor_b.persist(CounterEvent::Subtract(5), &storage).await.unwrap();
    actor_b.persist(CounterEvent::Add(100), &storage).await.unwrap();
    assert_eq!(actor_b.value, 95);

    // Recover each independently.
    let mut recovered_a = CounterActor::new("alpha");
    recover_event_sourced(&mut recovered_a, &storage, &storage)
        .await
        .unwrap();
    assert_eq!(recovered_a.value, 60);
    assert_eq!(recovered_a.last_sequence_id(), SequenceId(3));

    let mut recovered_b = CounterActor::new("beta");
    recover_event_sourced(&mut recovered_b, &storage, &storage)
        .await
        .unwrap();
    assert_eq!(recovered_b.value, 95);
    assert_eq!(recovered_b.last_sequence_id(), SequenceId(2));
}

// ── Negative / error / edge-case tests ─────────────────

#[tokio::test]
async fn test_deserialize_corrupted_event_fails() {
    let storage = InMemoryStorage::new();
    let pid = PersistenceId::new("Counter", "corrupt-ev");

    // Write a valid event first, then a corrupted one.
    // This tests that valid events are NOT partially applied before the
    // corrupt one aborts recovery.
    let mut setup = CounterActor::new("corrupt-ev");
    setup.persist(CounterEvent::Add(100), &storage).await.unwrap();

    // Write corrupted entry at seq 2 (wrong length → deserialize_event returns Err).
    storage
        .write_event(&pid, SequenceId(2), "garbage", &[0xFF, 0xFF])
        .await
        .unwrap();

    let mut actor = CounterActor::new("corrupt-ev");
    let result = recover_event_sourced(&mut actor, &storage, &storage).await;
    assert!(result.is_err(), "recovery should fail on corrupted event payload");
    // Actor state should remain unchanged — valid event before the corrupt
    // one must NOT be partially applied.
    assert_eq!(actor.value, 0, "actor state should not change on failed recovery");
}

#[tokio::test]
async fn test_deserialize_corrupted_snapshot_fails() {
    let storage = InMemoryStorage::new();
    let pid = PersistenceId::new("Counter", "corrupt-snap");

    // Write a valid event so the journal isn't empty.
    let mut actor = CounterActor::new("corrupt-snap");
    actor.persist(CounterEvent::Add(1), &storage).await.unwrap();

    // Write a corrupted snapshot directly (wrong length → restore_snapshot returns Err).
    storage
        .save_snapshot(&pid, SequenceId(1), &[0xDE, 0xAD])
        .await
        .unwrap();

    let mut recovered = CounterActor::new("corrupt-snap");
    let result = recover_event_sourced(&mut recovered, &storage, &storage).await;
    assert!(result.is_err(), "recovery should fail on corrupted snapshot payload");
    // Actor state should remain unchanged (default)
    assert_eq!(recovered.value, 0, "actor state should not change on failed recovery");
}

#[tokio::test]
async fn test_durable_state_corrupted_payload() {
    let storage = InMemoryStorage::new();
    let pid = PersistenceId::new("Config", "corrupt-cfg");

    // Write non-UTF-8 bytes directly — ConfigActor::restore_state expects valid UTF-8.
    storage
        .save_state(&pid, &[0xFF, 0xFE, 0x80])
        .await
        .unwrap();

    let mut actor = ConfigActor::new("corrupt-cfg");
    let result = recover_durable_state(&mut actor, &storage).await;
    assert!(result.is_err(), "recovery should fail on non-UTF-8 state payload");
    // Actor state should remain unchanged (default)
    assert_eq!(actor.data, "", "actor state should not change on failed recovery");
}

#[tokio::test]
async fn test_persist_batch_empty() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("empty-batch");

    let seq = actor
        .persist_batch(vec![], &storage)
        .await
        .unwrap();

    // No state change, returns current (initial) sequence.
    assert_eq!(seq, SequenceId(0));
    assert_eq!(actor.value, 0);

    // Journal should have no entries.
    let pid = actor.persistence_id();
    let entries = storage.read_events(&pid, SequenceId(1)).await.unwrap();
    assert!(entries.is_empty(), "no entries should be written for an empty batch");
}

#[tokio::test]
async fn test_durable_state_delete_then_recover() {
    let storage = InMemoryStorage::new();

    // Save some state.
    let mut actor = ConfigActor::new("del-cfg");
    actor.data = "important-data".to_string();
    DurableState::save_state(&actor, &storage as &dyn StateStorage)
        .await
        .unwrap();

    // Delete the state.
    let pid = actor.persistence_id();
    storage.delete_state(&pid).await.unwrap();

    // Recover should yield fresh/default (empty) state.
    let mut recovered = ConfigActor::new("del-cfg");
    recover_durable_state(&mut recovered, &storage).await.unwrap();
    assert_eq!(recovered.data, "", "after delete, recovery should yield default state");
}

#[tokio::test]
async fn test_snapshot_cleanup_preserves_later_events() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("snap-cleanup");

    // Persist 10 events: Add(1) through Add(10).
    for i in 1..=10 {
        actor
            .persist(CounterEvent::Add(i), &storage)
            .await
            .unwrap();
    }
    // value = 1+2+…+10 = 55
    assert_eq!(actor.value, 55);

    // Save a snapshot at seq 5 with value=15 (1+2+3+4+5) directly via storage.
    let pid = PersistenceId::new("Counter", "snap-cleanup");
    let snapshot_value: i64 = 15;
    storage
        .save_snapshot(&pid, SequenceId(5), &snapshot_value.to_le_bytes())
        .await
        .unwrap();

    // Delete events up to seq 5 (old events).
    storage.delete_events_to(&pid, SequenceId(5)).await.unwrap();

    // Verify events 6-10 still exist.
    let remaining = storage.read_events(&pid, SequenceId(1)).await.unwrap();
    assert_eq!(remaining.len(), 5, "events 6-10 should remain");
    assert_eq!(remaining[0].sequence_id, SequenceId(6));

    // Recover: snapshot(15 at seq 5) + replay events 6-10 → 15 + 6+7+8+9+10 = 55.
    let mut recovered = CounterActor::new("snap-cleanup");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();
    assert_eq!(recovered.value, 55);
    assert_eq!(recovered.last_sequence_id(), SequenceId(10));
}

#[tokio::test]
async fn test_durable_state_overwrite() {
    let storage = InMemoryStorage::new();

    // Save v1.
    let mut actor = ConfigActor::new("overwrite");
    actor.data = "v1".to_string();
    DurableState::save_state(&actor, &storage as &dyn StateStorage)
        .await
        .unwrap();

    // Save v2 (overwrites v1).
    actor.data = "v2".to_string();
    DurableState::save_state(&actor, &storage as &dyn StateStorage)
        .await
        .unwrap();

    // Recover should return v2.
    let mut recovered = ConfigActor::new("overwrite");
    recover_durable_state(&mut recovered, &storage).await.unwrap();
    assert_eq!(recovered.data, "v2");
}

#[tokio::test]
async fn test_recovery_from_snapshot_without_events() {
    let storage = InMemoryStorage::new();
    let mut actor = CounterActor::new("snap-only");

    // Persist 5 events.
    for i in 1..=5 {
        actor
            .persist(CounterEvent::Add(i * 3), &storage)
            .await
            .unwrap();
    }
    // value = 3+6+9+12+15 = 45
    assert_eq!(actor.value, 45);

    // Snapshot at seq 5.
    actor.snapshot(&storage).await.unwrap();

    // Delete ALL events.
    let pid = actor.persistence_id();
    storage.delete_events_to(&pid, SequenceId(5)).await.unwrap();
    let remaining = storage.read_events(&pid, SequenceId(1)).await.unwrap();
    assert!(remaining.is_empty());

    // Recover — snapshot only, no events to replay.
    let mut recovered = CounterActor::new("snap-only");
    recover_event_sourced(&mut recovered, &storage, &storage)
        .await
        .unwrap();
    assert_eq!(recovered.value, 45);
    assert_eq!(recovered.last_sequence_id(), SequenceId(5));
}