eventide-domain 0.1.1

Domain layer for the eventide DDD/CQRS toolkit: aggregates, entities, value objects, domain events, repositories, and an in-memory event engine.
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

//! Persistence-layer model for aggregate snapshots (`SerializedSnapshot`).
//!
//! Defines the canonical shape an aggregate takes when serialized to a
//! snapshot store, together with bidirectional helpers to convert between
//! a live [`Aggregate`] instance and its on-disk form.
//!
//! Snapshots are used by [`SnapshotPolicyRepo`](super::SnapshotPolicyRepo)
//! to bound the cost of replaying long event histories: instead of always
//! starting from version zero, a load can begin at the most recent
//! snapshot and only replay events recorded after it.
//!
use crate::{
    aggregate::Aggregate,
    error::{DomainError, DomainResult as Result},
};
use bon::Builder;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Storage-layer representation of an aggregate snapshot.
///
/// The structure is intentionally minimal: an identity triple
/// (`aggregate_id`, `aggregate_type`, `aggregate_version`) plus the
/// JSON-encoded aggregate state. Adapters typically persist this directly
/// as one row per aggregate (latest snapshot only) or one row per
/// aggregate + version (full snapshot history).
#[derive(Debug, Clone, Builder, Serialize, Deserialize)]
pub struct SerializedSnapshot {
    aggregate_id: String,
    aggregate_type: String,
    aggregate_version: usize,
    payload: Value,
}

impl SerializedSnapshot {
    pub fn aggregate_id(&self) -> &str {
        &self.aggregate_id
    }

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

    pub fn aggregate_version(&self) -> usize {
        self.aggregate_version
    }

    pub fn payload(&self) -> &Value {
        &self.payload
    }

    /// Deserializes the snapshot back into a typed aggregate instance.
    ///
    /// The conversion verifies that `aggregate_type` matches the requested
    /// `A::TYPE` before attempting JSON deserialization, which catches
    /// programming mistakes (a snapshot of `Order` being read as `Customer`)
    /// early and with a clear error.
    ///
    /// # Errors
    ///
    /// - Returns [`DomainError::type_mismatch`] when the stored
    ///   `aggregate_type` does not equal `A::TYPE`.
    /// - Returns a JSON-conversion [`DomainError`] when `payload` cannot be
    ///   decoded into `A`.
    pub fn to_aggregate<A>(&self) -> Result<A>
    where
        A: Aggregate,
    {
        if A::TYPE != self.aggregate_type {
            return Err(DomainError::type_mismatch(
                A::TYPE,
                self.aggregate_type.as_str(),
            ));
        }

        let aggregate = serde_json::from_value(self.payload.clone())?;
        Ok(aggregate)
    }

    /// Serializes a live aggregate into a snapshot ready for storage.
    ///
    /// The aggregate's id, type tag and current version are copied into the
    /// dedicated fields, and the entire aggregate is JSON-encoded into
    /// `payload`. The resulting `SerializedSnapshot` is what
    /// [`SnapshotRepository::save`](super::SnapshotRepository::save) ultimately
    /// receives.
    ///
    /// # Errors
    ///
    /// Returns a [`DomainError`] when the aggregate cannot be encoded into
    /// JSON.
    pub fn from_aggregate<A>(aggregate: &A) -> Result<Self>
    where
        A: Aggregate,
    {
        Ok(Self {
            aggregate_id: aggregate.id().to_string(),
            aggregate_type: A::TYPE.to_string(),
            aggregate_version: aggregate.version().value(),
            payload: serde_json::to_value(aggregate)?,
        })
    }
}