ralph-proto 2.9.3

Shared types, error definitions, and traits for Ralph Orchestrator
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

//! Event types for pub/sub messaging.

use crate::{HatId, Topic};
use serde::{Deserialize, Serialize};

/// An event in the pub/sub system.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Event {
    /// The routing topic for this event.
    pub topic: Topic,

    /// The content/payload of the event.
    pub payload: String,

    /// The hat that published this event (if any).
    pub source: Option<HatId>,

    /// Optional target hat for direct handoff.
    pub target: Option<HatId>,

    /// Wave correlation ID (e.g., "w-1a2b3c4d").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wave_id: Option<String>,

    /// Index of this event within the wave (0-based).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wave_index: Option<u32>,

    /// Total number of events in the wave.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wave_total: Option<u32>,
}

impl Event {
    /// Creates a new event with the given topic and payload.
    pub fn new(topic: impl Into<Topic>, payload: impl Into<String>) -> Self {
        Self {
            topic: topic.into(),
            payload: payload.into(),
            source: None,
            target: None,
            wave_id: None,
            wave_index: None,
            wave_total: None,
        }
    }

    /// Sets the source hat for this event.
    #[must_use]
    pub fn with_source(mut self, source: impl Into<HatId>) -> Self {
        self.source = Some(source.into());
        self
    }

    /// Sets the target hat for direct handoff.
    #[must_use]
    pub fn with_target(mut self, target: impl Into<HatId>) -> Self {
        self.target = Some(target.into());
        self
    }

    /// Sets wave correlation metadata on this event.
    #[must_use]
    pub fn with_wave(mut self, wave_id: impl Into<String>, index: u32, total: u32) -> Self {
        self.wave_id = Some(wave_id.into());
        self.wave_index = Some(index);
        self.wave_total = Some(total);
        self
    }

    /// Returns true if this event has wave correlation metadata.
    pub fn is_wave_event(&self) -> bool {
        self.wave_id.is_some()
    }
}

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

    #[test]
    fn test_new_event_has_no_wave_metadata() {
        let event = Event::new("test.topic", "payload");
        assert!(!event.is_wave_event());
        assert!(event.wave_id.is_none());
        assert!(event.wave_index.is_none());
        assert!(event.wave_total.is_none());
    }

    #[test]
    fn test_with_wave_sets_metadata() {
        let event = Event::new("review.file", "src/main.rs").with_wave("w-1a2b3c4d", 0, 3);
        assert!(event.is_wave_event());
        assert_eq!(event.wave_id.as_deref(), Some("w-1a2b3c4d"));
        assert_eq!(event.wave_index, Some(0));
        assert_eq!(event.wave_total, Some(3));
    }

    #[test]
    fn test_wave_metadata_roundtrips_through_serde() {
        let event = Event::new("review.file", "src/main.rs")
            .with_source("dispatcher")
            .with_wave("w-abcd1234", 2, 5);

        let json = serde_json::to_string(&event).unwrap();
        let deserialized: Event = serde_json::from_str(&json).unwrap();

        assert_eq!(deserialized.wave_id.as_deref(), Some("w-abcd1234"));
        assert_eq!(deserialized.wave_index, Some(2));
        assert_eq!(deserialized.wave_total, Some(5));
        assert_eq!(deserialized.topic.as_str(), "review.file");
        assert_eq!(deserialized.payload, "src/main.rs");
    }

    #[test]
    fn test_event_without_wave_serializes_without_wave_fields() {
        let event = Event::new("test.topic", "payload");
        let json = serde_json::to_string(&event).unwrap();
        assert!(!json.contains("wave_id"));
        assert!(!json.contains("wave_index"));
        assert!(!json.contains("wave_total"));
    }

    #[test]
    fn test_event_without_wave_fields_deserializes() {
        let json = r#"{"topic":"test.topic","payload":"hello"}"#;
        let event: Event = serde_json::from_str(json).unwrap();
        assert!(!event.is_wave_event());
        assert_eq!(event.topic.as_str(), "test.topic");
        assert_eq!(event.payload, "hello");
    }
}