|
| 1 | +//! Structured event types for stack lifecycle observability. |
| 2 | +
|
| 3 | +use serde::{Deserialize, Serialize}; |
| 4 | + |
| 5 | +/// Structured event emitted during stack lifecycle operations. |
| 6 | +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] |
| 7 | +#[serde(tag = "type")] |
| 8 | +pub enum StackEvent { |
| 9 | + /// Reconciliation started for a stack. |
| 10 | + #[serde(rename = "stack_apply_started")] |
| 11 | + StackApplyStarted { |
| 12 | + /// Stack name. |
| 13 | + stack_name: String, |
| 14 | + /// Number of services in the spec. |
| 15 | + services_count: usize, |
| 16 | + }, |
| 17 | + /// Reconciliation completed for a stack. |
| 18 | + #[serde(rename = "stack_apply_completed")] |
| 19 | + StackApplyCompleted { |
| 20 | + /// Stack name. |
| 21 | + stack_name: String, |
| 22 | + /// Number of actions that succeeded. |
| 23 | + succeeded: usize, |
| 24 | + /// Number of actions that failed. |
| 25 | + failed: usize, |
| 26 | + }, |
| 27 | + /// Reconciliation failed for a stack. |
| 28 | + #[serde(rename = "stack_apply_failed")] |
| 29 | + StackApplyFailed { |
| 30 | + /// Stack name. |
| 31 | + stack_name: String, |
| 32 | + /// Error description. |
| 33 | + error: String, |
| 34 | + }, |
| 35 | + /// A service is being created. |
| 36 | + #[serde(rename = "service_creating")] |
| 37 | + ServiceCreating { |
| 38 | + /// Stack name. |
| 39 | + stack_name: String, |
| 40 | + /// Service name. |
| 41 | + service_name: String, |
| 42 | + }, |
| 43 | + /// A service is ready and running. |
| 44 | + #[serde(rename = "service_ready")] |
| 45 | + ServiceReady { |
| 46 | + /// Stack name. |
| 47 | + stack_name: String, |
| 48 | + /// Service name. |
| 49 | + service_name: String, |
| 50 | + /// Runtime container identifier. |
| 51 | + runtime_id: String, |
| 52 | + }, |
| 53 | + /// A service failed to start or crashed. |
| 54 | + #[serde(rename = "service_failed")] |
| 55 | + ServiceFailed { |
| 56 | + /// Stack name. |
| 57 | + stack_name: String, |
| 58 | + /// Service name. |
| 59 | + service_name: String, |
| 60 | + /// Error description. |
| 61 | + error: String, |
| 62 | + }, |
| 63 | +} |
| 64 | + |
| 65 | +#[cfg(test)] |
| 66 | +mod tests { |
| 67 | + #![allow(clippy::unwrap_used)] |
| 68 | + |
| 69 | + use super::*; |
| 70 | + |
| 71 | + #[test] |
| 72 | + fn event_round_trip() { |
| 73 | + let events = vec![ |
| 74 | + StackEvent::StackApplyStarted { |
| 75 | + stack_name: "myapp".to_string(), |
| 76 | + services_count: 3, |
| 77 | + }, |
| 78 | + StackEvent::StackApplyCompleted { |
| 79 | + stack_name: "myapp".to_string(), |
| 80 | + succeeded: 2, |
| 81 | + failed: 1, |
| 82 | + }, |
| 83 | + StackEvent::ServiceReady { |
| 84 | + stack_name: "myapp".to_string(), |
| 85 | + service_name: "web".to_string(), |
| 86 | + runtime_id: "ctr-123".to_string(), |
| 87 | + }, |
| 88 | + ]; |
| 89 | + |
| 90 | + for event in events { |
| 91 | + let json = serde_json::to_string(&event).unwrap(); |
| 92 | + let deserialized: StackEvent = serde_json::from_str(&json).unwrap(); |
| 93 | + assert_eq!(deserialized, event); |
| 94 | + } |
| 95 | + } |
| 96 | + |
| 97 | + #[test] |
| 98 | + fn event_tag_serialization() { |
| 99 | + let event = StackEvent::StackApplyStarted { |
| 100 | + stack_name: "test".to_string(), |
| 101 | + services_count: 1, |
| 102 | + }; |
| 103 | + let json = serde_json::to_string(&event).unwrap(); |
| 104 | + assert!(json.contains("\"type\":\"stack_apply_started\"")); |
| 105 | + } |
| 106 | +} |
0 commit comments