hexeract-core 0.5.0

Core traits and types for the Hexeract messaging framework
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

use crate::command::Command;
use crate::ids::{CorrelationId, MessageId};
use crate::notification::Notification;
use crate::query::Query;

/// Metadata carried alongside every dispatch.
///
/// The envelope exposes the message type name and identifiers without
/// requiring the middleware to know the concrete `Command` or `Query` type.
#[derive(Debug, Clone)]
pub struct MessageEnvelope {
    type_name: &'static str,
    message_id: MessageId,
    correlation_id: CorrelationId,
}

impl MessageEnvelope {
    /// Builds an envelope for a [`Command`] dispatch.
    #[must_use]
    pub fn for_command<C: Command>(message_id: MessageId, correlation_id: CorrelationId) -> Self {
        Self {
            type_name: std::any::type_name::<C>(),
            message_id,
            correlation_id,
        }
    }

    /// Builds an envelope for a [`Query`] dispatch.
    #[must_use]
    pub fn for_query<Q: Query>(message_id: MessageId, correlation_id: CorrelationId) -> Self {
        Self {
            type_name: std::any::type_name::<Q>(),
            message_id,
            correlation_id,
        }
    }

    /// Builds an envelope for a [`Notification`] dispatch. Each handler in a
    /// fan-out receives its own envelope; callers typically share the
    /// [`CorrelationId`] across the whole fan-out to preserve the causal link
    /// in traces.
    #[must_use]
    pub fn for_notification<N: Notification>(
        message_id: MessageId,
        correlation_id: CorrelationId,
    ) -> Self {
        Self {
            type_name: std::any::type_name::<N>(),
            message_id,
            correlation_id,
        }
    }

    /// The fully-qualified type name of the dispatched message.
    #[must_use]
    pub fn type_name(&self) -> &'static str {
        self.type_name
    }

    /// The unique identifier of this dispatch.
    #[must_use]
    pub fn message_id(&self) -> MessageId {
        self.message_id
    }

    /// The correlation identifier linking this dispatch to its causal chain.
    #[must_use]
    pub fn correlation_id(&self) -> CorrelationId {
        self.correlation_id
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    struct Ping;
    impl Command for Ping {
        type Output = ();
    }

    struct Pong;
    impl Query for Pong {
        type Output = ();
    }

    #[derive(Clone)]
    struct Bell;
    impl Notification for Bell {}

    #[test]
    fn for_notification_records_notification_type_name() {
        let env = MessageEnvelope::for_notification::<Bell>(MessageId::new(), CorrelationId::new());
        assert!(env.type_name().ends_with("::Bell"));
    }

    #[test]
    fn for_command_records_command_type_name() {
        let env = MessageEnvelope::for_command::<Ping>(MessageId::new(), CorrelationId::new());
        assert!(env.type_name().ends_with("::Ping"));
    }

    #[test]
    fn for_query_records_query_type_name() {
        let env = MessageEnvelope::for_query::<Pong>(MessageId::new(), CorrelationId::new());
        assert!(env.type_name().ends_with("::Pong"));
    }

    #[test]
    fn envelope_preserves_identifiers() {
        let msg = MessageId::new();
        let corr = CorrelationId::new();
        let env = MessageEnvelope::for_command::<Ping>(msg, corr);
        assert_eq!(env.message_id(), msg);
        assert_eq!(env.correlation_id(), corr);
    }

    #[test]
    fn envelope_is_clone() {
        let env = MessageEnvelope::for_command::<Ping>(MessageId::new(), CorrelationId::new());
        let cloned = env.clone();
        assert_eq!(env.message_id(), cloned.message_id());
        assert_eq!(env.type_name(), cloned.type_name());
    }
}