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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
//! Strongly-typed event kind enum for domain events.
use serde::{Deserialize, Serialize};
use strum::{Display, EnumString, IntoStaticStr};
/// Strongly-typed event kind matching domain event variants.
///
/// Serializes to/from `snake_case` strings (e.g. `"run_status_changed"`).
///
/// # Examples
///
/// ```
/// use ironflow_store::entities::EventKind;
///
/// let kind: EventKind = "run_status_changed".parse().unwrap();
/// assert_eq!(kind, EventKind::RunStatusChanged);
/// assert_eq!(kind.as_str(), "run_status_changed");
/// ```
#[derive(
Debug,
Clone,
Copy,
PartialEq,
Eq,
Hash,
Serialize,
Deserialize,
Display,
EnumString,
IntoStaticStr,
)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub enum EventKind {
/// A new run was created.
RunCreated,
/// A run changed status.
RunStatusChanged,
/// A run failed.
RunFailed,
/// A run was stopped because it reached its cumulative cost cap.
RunBudgetExceeded,
/// A step completed successfully.
StepCompleted,
/// A step failed.
StepFailed,
/// A run is waiting for human approval.
ApprovalRequested,
/// A run was approved.
ApprovalGranted,
/// A run was rejected.
ApprovalRejected,
/// A log line was emitted by a running step.
LogLine,
/// A user signed in.
UserSignedIn,
/// A new user signed up.
UserSignedUp,
/// A user signed out.
UserSignedOut,
/// A batch of secrets was re-encrypted with a different key version.
SecretsRotated,
/// A retry was forced despite a handler version mismatch.
RetryForced,
}
impl EventKind {
/// All known event kinds.
pub const ALL: &'static [EventKind] = &[
Self::RunCreated,
Self::RunStatusChanged,
Self::RunFailed,
Self::RunBudgetExceeded,
Self::StepCompleted,
Self::StepFailed,
Self::ApprovalRequested,
Self::ApprovalGranted,
Self::ApprovalRejected,
Self::LogLine,
Self::UserSignedIn,
Self::UserSignedUp,
Self::UserSignedOut,
Self::SecretsRotated,
Self::RetryForced,
];
/// Returns the wire-format string for this kind.
///
/// # Examples
///
/// ```
/// use ironflow_store::entities::EventKind;
///
/// assert_eq!(EventKind::RunCreated.as_str(), "run_created");
/// assert_eq!(EventKind::StepFailed.as_str(), "step_failed");
/// ```
pub fn as_str(self) -> &'static str {
self.into()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn all_variants_roundtrip_via_str() {
for kind in EventKind::ALL {
let s = kind.as_str();
let parsed: EventKind = s.parse().unwrap();
assert_eq!(*kind, parsed);
}
}
#[test]
fn all_has_correct_count() {
assert_eq!(EventKind::ALL.len(), 15);
}
#[test]
fn secrets_rotated_uses_snake_case_wire_format() {
assert_eq!(EventKind::SecretsRotated.as_str(), "secrets_rotated");
assert_eq!(
"secrets_rotated".parse::<EventKind>().unwrap(),
EventKind::SecretsRotated
);
}
#[test]
fn run_budget_exceeded_uses_snake_case_wire_format() {
assert_eq!(EventKind::RunBudgetExceeded.as_str(), "run_budget_exceeded");
assert_eq!(
"run_budget_exceeded".parse::<EventKind>().unwrap(),
EventKind::RunBudgetExceeded
);
}
#[test]
fn display_matches_as_str() {
for kind in EventKind::ALL {
assert_eq!(kind.to_string(), kind.as_str());
}
}
#[test]
fn parse_unknown_returns_error() {
assert!("bogus".parse::<EventKind>().is_err());
}
#[test]
fn serde_roundtrip() {
let kind = EventKind::RunStatusChanged;
let json = serde_json::to_string(&kind).unwrap();
assert_eq!(json, "\"run_status_changed\"");
let back: EventKind = serde_json::from_str(&json).unwrap();
assert_eq!(back, kind);
}
#[test]
fn serde_all_variants() {
for kind in EventKind::ALL {
let json = serde_json::to_string(kind).unwrap();
let back: EventKind = serde_json::from_str(&json).unwrap();
assert_eq!(*kind, back);
}
}
}