distributed 1.8.1

CQRS/ES framework for Rust using Plain Old Rust Structs — append-only events, replay, snapshots, outbox, service bus, and pluggable infrastructure
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
use std::collections::HashMap;
use std::fmt;
use std::time::SystemTime;

use serde::{Deserialize, Serialize};

use crate::SourcedResult;

use super::{BitcodePayloadCodec, EventRecord, EventRecordError, PayloadCodec};

#[derive(Serialize, Deserialize)]
pub struct Entity {
    id: String,
    version: u64,
    events: Vec<EventRecord>,
    /// Number of leading events NOT held in `events` — the prefix folded into a
    /// snapshot and skipped on load. Zero for a full-history entity. The true
    /// stream length is always `prefix_version + events.len()`, so event
    /// sequencing and `new_events` slicing stay correct when only a tail is in
    /// memory. Transient: not part of the durable entity representation.
    #[serde(skip, default)]
    prefix_version: u64,
    #[serde(skip, default)]
    replaying: bool,
    snapshot_version: u64,
    #[serde(skip, default)]
    committed_version: u64,
    timestamp: SystemTime,
    /// Metadata applied to every event produced by `digest`.
    /// Transient — not serialized with the entity. Set before calling
    /// command methods to attach correlation IDs, user context, etc.
    #[serde(skip, default)]
    metadata: HashMap<String, String>,
}

impl Default for Entity {
    fn default() -> Self {
        Entity {
            id: String::new(),
            version: 0,
            events: Vec::new(),
            prefix_version: 0,
            replaying: false,
            snapshot_version: 0,
            committed_version: 0,
            timestamp: SystemTime::now(),
            metadata: HashMap::new(),
        }
    }
}

impl fmt::Debug for Entity {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Entity")
            .field("id", &self.id)
            .field("version", &self.version)
            .field("events", &self.events)
            .field("prefix_version", &self.prefix_version)
            .field("replaying", &self.replaying)
            .field("snapshot_version", &self.snapshot_version)
            .field("committed_version", &self.committed_version)
            .field("timestamp", &self.timestamp)
            .field("metadata", &self.metadata)
            .finish()
    }
}

impl Clone for Entity {
    fn clone(&self) -> Self {
        Entity {
            id: self.id.clone(),
            version: self.version,
            events: self.events.clone(),
            prefix_version: self.prefix_version,
            replaying: self.replaying,
            snapshot_version: self.snapshot_version,
            committed_version: self.committed_version,
            timestamp: self.timestamp,
            metadata: self.metadata.clone(),
        }
    }
}

struct ReplayGuard<'a> {
    replaying: &'a mut bool,
}

impl<'a> ReplayGuard<'a> {
    fn new(replaying: &'a mut bool) -> Self {
        *replaying = true;
        ReplayGuard { replaying }
    }
}

impl Drop for ReplayGuard<'_> {
    fn drop(&mut self) {
        *self.replaying = false;
    }
}

impl Entity {
    pub fn new() -> Self {
        Entity::default()
    }

    pub fn with_id(id: impl Into<String>) -> Self {
        Entity {
            id: id.into(),
            ..Entity::default()
        }
    }

    pub fn id(&self) -> &str {
        &self.id
    }

    pub fn set_id(&mut self, id: impl Into<String>) {
        self.id = id.into();
    }

    pub fn version(&self) -> u64 {
        self.version
    }

    pub fn snapshot_version(&self) -> u64 {
        self.snapshot_version
    }

    pub fn set_snapshot_version(&mut self, snapshot_version: u64) {
        self.snapshot_version = snapshot_version;
    }

    pub fn committed_version(&self) -> u64 {
        self.committed_version
    }

    pub fn events(&self) -> &[EventRecord] {
        &self.events
    }

    /// Take the in-memory events out of the entity, leaving it empty.
    ///
    /// Used by replay paths that need to iterate events while also holding a
    /// mutable borrow of the owning aggregate (the borrow checker forbids
    /// borrowing `events` immutably and the aggregate mutably at once). The
    /// caller is responsible for restoring history afterward — e.g. via
    /// [`load_from_history`](Self::load_from_history) — so the entity's
    /// `version`/`committed_version` invariants hold.
    pub fn take_events(&mut self) -> Vec<EventRecord> {
        std::mem::take(&mut self.events)
    }

    /// Put a previously [taken](Self::take_events) event history back without
    /// recomputing `version`/`prefix_version`/`committed_version`. The caller
    /// must restore the *same* events the entity already accounted for, so the
    /// existing invariants continue to hold (used by replay paths that only
    /// borrowed the events out to satisfy the borrow checker).
    pub fn restore_history(&mut self, events: Vec<EventRecord>) {
        self.events = events;
    }

    /// Returns events added since the entity was loaded (not yet persisted).
    ///
    /// Slices relative to `prefix_version` so it is correct whether the entity
    /// holds the full history (`prefix_version == 0`) or only a snapshot tail.
    pub fn new_events(&self) -> &[EventRecord] {
        let start = (self.committed_version - self.prefix_version) as usize;
        &self.events[start..]
    }

    /// Mark all current events as committed. Called by repository after successful commit.
    pub fn mark_committed(&mut self) {
        self.committed_version = self.version;
    }

    /// Set metadata that will be attached to every subsequent event.
    ///
    /// Call this before invoking command methods to propagate context
    /// (correlation IDs, user info, trace spans) into the event stream.
    pub fn set_metadata(&mut self, metadata: HashMap<String, String>) {
        self.metadata = metadata;
    }

    /// Set a single metadata key-value pair.
    pub fn set_meta(&mut self, key: impl Into<String>, value: impl Into<String>) {
        self.metadata.insert(key.into(), value.into());
    }

    /// Set the correlation ID for subsequent events.
    pub fn set_correlation_id(&mut self, id: impl Into<String>) {
        self.set_meta("correlation_id", id);
    }

    /// Set the causation ID for subsequent events.
    pub fn set_causation_id(&mut self, id: impl Into<String>) {
        self.set_meta("causation_id", id);
    }

    /// Get the current metadata context.
    pub fn metadata(&self) -> &HashMap<String, String> {
        &self.metadata
    }

    /// Clear all metadata.
    pub fn clear_metadata(&mut self) {
        self.metadata.clear();
    }

    /// Record an event with a serializable payload.
    ///
    /// If serialization fails, the entity is left unchanged.
    /// Any metadata set on the entity is attached to the event.
    pub fn digest<T: serde::Serialize>(
        &mut self,
        name: impl Into<String>,
        payload: &T,
    ) -> SourcedResult {
        if self.replaying {
            return Ok(());
        }

        let bytes = BitcodePayloadCodec::encode(payload).map_err(EventRecordError::encode)?;
        let sequence = self.next_sequence();
        let mut record = EventRecord::new(name, bytes, sequence);
        if !self.metadata.is_empty() {
            record.metadata = self.metadata.clone();
        }
        self.push_new_event(record);
        Ok(())
    }

    /// Record a versioned event.
    ///
    /// If serialization fails, the entity is left unchanged.
    pub fn digest_v<T: serde::Serialize>(
        &mut self,
        name: impl Into<String>,
        version: u64,
        payload: &T,
    ) -> SourcedResult {
        if self.replaying {
            return Ok(());
        }

        let bytes = BitcodePayloadCodec::encode(payload).map_err(EventRecordError::encode)?;
        let sequence = self.next_sequence();
        let mut record = EventRecord::new_versioned(name, bytes, sequence, version);
        if !self.metadata.is_empty() {
            record.metadata = self.metadata.clone();
        }
        self.push_new_event(record);
        Ok(())
    }

    /// Record an event with no payload.
    pub fn digest_empty(&mut self, name: impl Into<String>) -> SourcedResult {
        self.digest(name, &())
    }

    /// The sequence number the next appended event will carry — the true stream
    /// length plus one. Counts the omitted snapshot prefix as well as the
    /// in-memory events, so tail-only entities still produce contiguous,
    /// non-colliding sequences.
    fn next_sequence(&self) -> u64 {
        self.prefix_version + self.events.len() as u64 + 1
    }

    fn push_new_event(&mut self, record: EventRecord) {
        self.events.push(record);
        self.version = self.prefix_version + self.events.len() as u64;
        self.timestamp = SystemTime::now();
    }

    pub fn load_from_history(&mut self, history: Vec<EventRecord>) {
        self.events = history;
        self.prefix_version = 0;
        self.version = self.events.len() as u64;
        self.committed_version = self.version;
    }

    /// Load only the *tail* of a stream — the events after a known prefix that
    /// is not held in memory (e.g. events already folded into a snapshot).
    ///
    /// Unlike [`load_from_history`](Self::load_from_history), the in-memory
    /// `events` here are a suffix of the durable stream, so `version` and
    /// `committed_version` must be supplied explicitly rather than derived from
    /// `events.len()`. They reflect the true persisted stream position:
    /// `committed_version` is the optimistic-concurrency `expected_version` for
    /// the next commit, and `new_events()` slices relative to it.
    ///
    /// # Invariant
    ///
    /// `prefix_version` is the count of events covered by the omitted prefix.
    /// Callers must guarantee that every event in `tail` has
    /// `sequence > prefix_version` and that sequences are contiguous, so the
    /// resulting `version == prefix_version + tail.len()` equals the true
    /// `max(sequence)`. Snapshots satisfy this: `prefix_version` is the snapshot
    /// version and the tail is exactly `sequence > snapshot.version`.
    pub fn load_tail_from_history(&mut self, tail: Vec<EventRecord>, prefix_version: u64) {
        self.events = tail;
        self.prefix_version = prefix_version;
        self.version = prefix_version + self.events.len() as u64;
        self.committed_version = self.version;
    }

    pub fn rehydrate<F, E>(&mut self, mut apply: F) -> Result<(), E>
    where
        F: FnMut(&EventRecord) -> Result<(), E>,
    {
        let _guard = ReplayGuard::new(&mut self.replaying);

        for event in &self.events {
            apply(event)?;
        }

        Ok(())
    }

    pub fn is_replaying(&self) -> bool {
        self.replaying
    }

    pub fn set_replaying(&mut self, replaying: bool) {
        self.replaying = replaying;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde::ser::Error as _;
    use serde_json;

    #[derive(Clone)]
    struct FailingSerialize;

    impl Serialize for FailingSerialize {
        fn serialize<S>(&self, _serializer: S) -> Result<S::Ok, S::Error>
        where
            S: serde::Serializer,
        {
            Err(S::Error::custom("intentional serialization failure"))
        }
    }

    #[test]
    fn new() {
        let entity = Entity::new();
        assert_eq!(entity.id(), "");
        assert_eq!(entity.version(), 0);
        assert!(entity.events().is_empty());
        assert!(!entity.is_replaying());
        assert_eq!(entity.snapshot_version(), 0);
        assert_eq!(entity.committed_version(), 0);
    }

    #[test]
    fn digest() {
        let mut entity = Entity::new();
        entity.digest("test_event", &("arg1", "arg2")).unwrap();

        assert_eq!(entity.version(), 1);
        assert_eq!(entity.events().len(), 1);
        assert_eq!(entity.events()[0].event_name, "test_event");
        let decoded: (String, String) = entity.events()[0].decode().unwrap();
        assert_eq!(decoded, ("arg1".to_string(), "arg2".to_string()));
        assert_eq!(entity.events()[0].sequence, 1);
    }

    #[test]
    fn digest_returns_serialization_errors_without_mutating_entity() {
        let mut entity = Entity::new();

        let err = entity.digest("bad_event", &FailingSerialize).unwrap_err();

        assert!(err.message.contains("intentional serialization failure"));
        assert_eq!(entity.version(), 0);
        assert!(entity.events().is_empty());
    }

    #[test]
    fn digest_v_returns_serialization_errors_without_mutating_entity() {
        let mut entity = Entity::new();

        let err = entity
            .digest_v("bad_event", 2, &FailingSerialize)
            .unwrap_err();

        assert!(err.message.contains("intentional serialization failure"));
        assert_eq!(entity.version(), 0);
        assert!(entity.events().is_empty());
    }

    #[test]
    fn rehydrate() {
        let mut entity = Entity::new();
        entity.digest("test_event1", &"arg1").unwrap();
        entity.digest("test_event2", &"arg2").unwrap();

        let mut replayed = Vec::new();
        let result = entity.rehydrate(|event| {
            replayed.push(event.event_name.clone());
            Ok::<(), ()>(())
        });

        assert!(result.is_ok());
        assert_eq!(replayed, vec!["test_event1", "test_event2"]);
        assert!(!entity.is_replaying());
    }

    #[test]
    fn clone() {
        let entity = Entity::new();
        let cloned_entity = entity.clone();

        assert_eq!(entity.id(), cloned_entity.id());
        assert_eq!(entity.version(), cloned_entity.version());
        assert_eq!(entity.events(), cloned_entity.events());
        assert_eq!(entity.snapshot_version(), cloned_entity.snapshot_version());
        assert_eq!(
            entity.committed_version(),
            cloned_entity.committed_version()
        );
    }

    #[test]
    fn debug() {
        let entity = Entity::new();
        let debug_str = format!("{:?}", entity);

        assert!(debug_str.contains("Entity"));
        assert!(debug_str.contains("id: \"\""));
        assert!(debug_str.contains("version: 0"));
    }

    #[test]
    fn serialize_deserialize() {
        let mut entity = Entity::new();
        entity.digest("test_event1", &"arg1").unwrap();

        let serialized: String = serde_json::to_string(&entity).unwrap();
        let deserialized: Entity = serde_json::from_str(&serialized).unwrap();

        assert_eq!(entity.id(), deserialized.id());
        assert_eq!(entity.version(), deserialized.version());
        assert_eq!(entity.events(), deserialized.events());
        assert_eq!(entity.snapshot_version(), deserialized.snapshot_version());
        assert_eq!(entity.timestamp, deserialized.timestamp);
        // committed_version is serde(skip) — not serialized, defaults to 0
        assert_eq!(deserialized.committed_version(), 0);
    }

    #[test]
    fn replaying_state_blocks_changes() {
        let mut entity = Entity::new();
        entity.replaying = true;

        entity.digest("test_event", &"arg1").unwrap();
        assert!(entity.events().is_empty());
    }

    #[test]
    fn load_from_history_sets_committed_version() {
        let mut entity = Entity::new();
        assert_eq!(entity.committed_version(), 0);

        let mut source = Entity::new();
        source.digest("e1", &"a").unwrap();
        source.digest("e2", &"b").unwrap();

        entity.load_from_history(source.events().to_vec());
        assert_eq!(entity.version(), 2);
        assert_eq!(entity.committed_version(), 2);
        assert_eq!(entity.snapshot_version(), 0);
    }

    #[test]
    fn new_events_on_fresh_entity() {
        let mut entity = Entity::new();
        assert!(entity.new_events().is_empty());

        entity.digest("e1", &"a").unwrap();
        entity.digest("e2", &"b").unwrap();
        assert_eq!(entity.new_events().len(), 2);
        assert_eq!(entity.new_events()[0].event_name, "e1");
        assert_eq!(entity.new_events()[1].event_name, "e2");
    }

    #[test]
    fn new_events_after_load_and_digest() {
        let mut source = Entity::new();
        source.digest("e1", &"a").unwrap();
        source.digest("e2", &"b").unwrap();

        let mut entity = Entity::new();
        entity.load_from_history(source.events().to_vec());
        assert!(entity.new_events().is_empty());

        entity.digest("e3", &"c").unwrap();
        assert_eq!(entity.new_events().len(), 1);
        assert_eq!(entity.new_events()[0].event_name, "e3");
    }

    #[test]
    fn mark_committed_resets_new_events() {
        let mut entity = Entity::new();
        entity.digest("e1", &"a").unwrap();
        entity.digest("e2", &"b").unwrap();
        assert_eq!(entity.new_events().len(), 2);

        entity.mark_committed();
        assert!(entity.new_events().is_empty());
        assert_eq!(entity.committed_version(), 2);
        assert_eq!(entity.snapshot_version(), 0);
        assert_eq!(entity.version(), 2);
        assert_eq!(entity.events().len(), 2);
    }

    #[test]
    fn digest_propagates_metadata_to_event_record() {
        let mut entity = Entity::new();
        entity.set_correlation_id("req-abc");
        entity.set_causation_id("cmd-xyz");
        entity.set_meta("user_id", "u-42");

        entity.digest("e1", &"payload").unwrap();

        let record = &entity.events()[0];
        assert_eq!(record.correlation_id(), Some("req-abc"));
        assert_eq!(record.causation_id(), Some("cmd-xyz"));
        assert_eq!(record.meta("user_id"), Some("u-42"));
    }

    #[test]
    fn digest_without_metadata_leaves_event_record_empty() {
        let mut entity = Entity::new();
        entity.digest("e1", &"payload").unwrap();

        let record = &entity.events()[0];
        assert!(record.metadata.is_empty());
        assert_eq!(record.correlation_id(), None);
    }

    #[test]
    fn metadata_is_transient_not_serialized() {
        let mut entity = Entity::new();
        entity.set_correlation_id("req-abc");
        entity.digest("e1", &"payload").unwrap();

        let serialized = serde_json::to_string(&entity).unwrap();
        let deserialized: Entity = serde_json::from_str(&serialized).unwrap();

        // Entity metadata is transient (serde skip), should be empty after round-trip
        assert!(deserialized.metadata().is_empty());
        // But the event record metadata was persisted
        assert_eq!(deserialized.events()[0].correlation_id(), Some("req-abc"));
    }

    #[test]
    fn clear_metadata_stops_propagation() {
        let mut entity = Entity::new();
        entity.set_correlation_id("req-abc");
        entity.digest("e1", &"first").unwrap();

        entity.clear_metadata();
        entity.digest("e2", &"second").unwrap();

        assert_eq!(entity.events()[0].correlation_id(), Some("req-abc"));
        assert!(entity.events()[1].metadata.is_empty());
    }

    #[test]
    fn load_tail_records_true_version_without_full_history() {
        // A tail of 2 events after a snapshot prefix of 3: true version is 5,
        // even though only 2 events are held in memory.
        let mut entity = Entity::with_id("agg");
        entity.load_tail_from_history(
            vec![
                EventRecord::new("e4", vec![], 4),
                EventRecord::new("e5", vec![], 5),
            ],
            3,
        );

        assert_eq!(entity.version(), 5);
        assert_eq!(entity.committed_version(), 5);
        assert_eq!(entity.events().len(), 2);
        assert!(entity.new_events().is_empty());
    }

    #[test]
    fn digest_after_tail_load_continues_sequence_from_true_version() {
        // After loading a tail (prefix 3 + 2 events = version 5), the next
        // digested event must be sequence 6 — not 3 (events.len() + 1).
        let mut entity = Entity::with_id("agg");
        entity.load_tail_from_history(
            vec![
                EventRecord::new("e4", vec![], 4),
                EventRecord::new("e5", vec![], 5),
            ],
            3,
        );

        entity.digest("e6", &"payload").unwrap();

        assert_eq!(entity.version(), 6);
        assert_eq!(entity.events().last().unwrap().sequence, 6);
        // Only the freshly digested event is new (uncommitted).
        assert_eq!(entity.new_events().len(), 1);
        assert_eq!(entity.new_events()[0].event_name, "e6");
        assert_eq!(entity.new_events()[0].sequence, 6);
    }

    #[test]
    fn digest_on_empty_tail_load_continues_from_prefix() {
        // A current snapshot leaves an empty tail at the snapshot version. The
        // next event must continue from there, not restart at sequence 1.
        let mut entity = Entity::with_id("agg");
        entity.load_tail_from_history(Vec::new(), 5);
        assert_eq!(entity.version(), 5);
        assert!(entity.new_events().is_empty());

        entity.digest("e6", &"payload").unwrap();
        assert_eq!(entity.version(), 6);
        assert_eq!(entity.events()[0].sequence, 6);
        assert_eq!(entity.new_events().len(), 1);
    }

    #[test]
    fn snapshot_version_not_affected_by_load_or_commit() {
        let mut entity = Entity::new();
        assert_eq!(entity.snapshot_version(), 0);

        // digest doesn't touch snapshot_version
        entity.digest("e1", &"a").unwrap();
        entity.digest("e2", &"b").unwrap();
        assert_eq!(entity.snapshot_version(), 0);

        // mark_committed doesn't touch snapshot_version
        entity.mark_committed();
        assert_eq!(entity.snapshot_version(), 0);

        // load_from_history doesn't touch snapshot_version
        let mut entity2 = Entity::new();
        entity2.load_from_history(entity.events().to_vec());
        assert_eq!(entity2.snapshot_version(), 0);
        assert_eq!(entity2.committed_version(), 2);
    }
}