majra 1.0.4

Distributed queue & multiplex engine — pub/sub, priority queues, relay, IPC, heartbeat, and rate limiting 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

//! Message envelope — the universal wire type for majra.
//!
//! Every message flowing through pub/sub, relay, or IPC shares this structure.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use uuid::Uuid;

/// Routing target for a message.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum Target {
    /// Deliver to a specific node or agent.
    Node(String),
    /// Deliver to all subscribers of a topic.
    Topic(String),
    /// Deliver to all connected peers.
    Broadcast,
}

/// A message envelope carrying a JSON payload with routing metadata.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Envelope {
    /// Unique message identifier.
    pub id: Uuid,
    /// Sender identifier (node ID, agent ID, etc.).
    pub from: String,
    /// Routing target.
    pub to: Target,
    /// Arbitrary JSON payload.
    pub payload: serde_json::Value,
    /// When the message was created.
    pub timestamp: DateTime<Utc>,
}

impl Envelope {
    /// Create a new envelope with a generated ID and current timestamp.
    pub fn new(from: impl Into<String>, to: Target, payload: serde_json::Value) -> Self {
        Self {
            id: Uuid::new_v4(),
            from: from.into(),
            to,
            payload,
            timestamp: Utc::now(),
        }
    }

    /// Returns `true` if this is a broadcast message.
    #[inline]
    #[must_use]
    pub fn is_broadcast(&self) -> bool {
        matches!(self.to, Target::Broadcast)
    }

    /// Returns `true` if this targets a topic.
    #[inline]
    #[must_use]
    pub fn is_topic(&self) -> bool {
        matches!(self.to, Target::Topic(_))
    }
}

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

    #[test]
    fn envelope_roundtrip() {
        let env = Envelope::new(
            "node-1",
            Target::Topic("crew.events".into()),
            serde_json::json!({"status": "ok"}),
        );
        let json = serde_json::to_string(&env).unwrap();
        let decoded: Envelope = serde_json::from_str(&json).unwrap();
        assert_eq!(decoded.id, env.id);
        assert_eq!(decoded.from, "node-1");
        assert!(decoded.is_topic());
    }

    #[test]
    fn broadcast_detection() {
        let env = Envelope::new("a", Target::Broadcast, serde_json::Value::Null);
        assert!(env.is_broadcast());
        assert!(!env.is_topic());
    }

    #[test]
    fn node_target() {
        let env = Envelope::new("a", Target::Node("b".into()), serde_json::Value::Null);
        assert!(!env.is_broadcast());
        assert!(!env.is_topic());
    }
}