Skip to main content

atman_runtime/
event.rs

1use std::sync::{Arc, Mutex};
2
3use serde::{Deserialize, Serialize};
4use tokio::sync::broadcast;
5use tokio::sync::mpsc;
6use tokio_util::sync::CancellationToken;
7use uuid::Uuid;
8
9#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
10#[serde(transparent)]
11pub struct FlowRunId(pub Uuid);
12
13impl FlowRunId {
14    pub fn now() -> Self {
15        Self(Uuid::now_v7())
16    }
17}
18
19impl std::fmt::Display for FlowRunId {
20    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
21        self.0.fmt(f)
22    }
23}
24
25#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
26#[serde(transparent)]
27pub struct TurnId(pub Uuid);
28
29impl TurnId {
30    pub fn now() -> Self {
31        Self(Uuid::now_v7())
32    }
33}
34
35impl std::fmt::Display for TurnId {
36    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
37        self.0.fmt(f)
38    }
39}
40
41/// Wraps an Event with assigned sequence number and timestamp.
42/// Serializes to the same JSONL format as the flat Event for backward compat.
43#[derive(Debug, Clone)]
44pub struct EventEnvelope {
45    pub seq: u64,
46    pub ts: chrono::DateTime<chrono::Utc>,
47    pub event: Event,
48}
49
50impl EventEnvelope {
51    pub fn new(seq: u64, event: Event) -> Self {
52        let ts = chrono::Utc::now();
53        Self { seq, ts, event }
54    }
55}
56
57impl serde::Serialize for EventEnvelope {
58    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
59        let mut value = serde_json::to_value(&self.event).map_err(serde::ser::Error::custom)?;
60        if let serde_json::Value::Object(ref mut map) = value {
61            map.insert("seq".into(), serde_json::Value::Number(self.seq.into()));
62            map.insert("ts".into(), serde_json::Value::String(self.ts.to_rfc3339()));
63        }
64        value.serialize(serializer)
65    }
66}
67
68impl<'de> serde::Deserialize<'de> for EventEnvelope {
69    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
70        let value = serde_json::Value::deserialize(deserializer)?;
71        // seq: required for new events, default 0 for legacy backward compat
72        let seq = value.get("seq").and_then(|v| v.as_u64()).unwrap_or(0);
73        // ts: parse when present; fall back to now for legacy events
74        let ts = value
75            .get("ts")
76            .and_then(|v| v.as_str())
77            .and_then(|s| chrono::DateTime::parse_from_rfc3339(s).ok())
78            .map(|dt| dt.with_timezone(&chrono::Utc))
79            .unwrap_or_else(chrono::Utc::now);
80        let event = serde_json::from_value(value).map_err(serde::de::Error::custom)?;
81        Ok(EventEnvelope { seq, ts, event })
82    }
83}
84
85#[derive(Debug, Clone, Serialize, Deserialize)]
86#[serde(tag = "type", rename_all = "snake_case")]
87pub enum Event {
88    FlowStart {
89        run_id: FlowRunId,
90        flow_name: String,
91        parent_run_id: Option<FlowRunId>,
92        parent_node_id: Option<String>,
93    },
94    FlowEnd {
95        run_id: FlowRunId,
96        flow_name: String,
97        status: FlowStatus,
98    },
99    LlmCall {
100        model: String,
101        provider: String,
102        usage: crate::provider::TokenUsage,
103        wallclock_ms: u64,
104        ttft_ms: Option<u64>,
105        tokens_per_second: Option<f64>,
106        status: LlmCallStatus,
107        #[serde(default, skip_serializing_if = "Option::is_none")]
108        run_id: Option<crate::event::FlowRunId>,
109        #[serde(default, skip_serializing_if = "Option::is_none")]
110        node_id: Option<String>,
111    },
112    TurnStart {
113        turn_id: TurnId,
114    },
115    TurnEnd {
116        turn_id: TurnId,
117    },
118    UserMsg {
119        turn_id: TurnId,
120        message: crate::message::Message,
121    },
122    AssistantMsg {
123        turn_id: TurnId,
124        flow_run_id: Option<FlowRunId>,
125        message: crate::message::Message,
126    },
127    ToolResultMsg {
128        turn_id: TurnId,
129        flow_run_id: Option<FlowRunId>,
130        message: crate::message::Message,
131    },
132    DiffPreview {
133        turn_id: Option<TurnId>,
134        flow_run_id: Option<FlowRunId>,
135        title: String,
136        old_content: Option<String>,
137        new_content: Option<String>,
138        unified_diff: Option<String>,
139    },
140    CompactionSummary {
141        session_id: String,
142        range_start: u64,
143        range_end: u64,
144        compacted_count: usize,
145        before_tokens: u64,
146        after_tokens: u64,
147        summary: String,
148    },
149    SystemMsg {
150        turn_id: TurnId,
151        message: crate::message::Message,
152    },
153    UserInject {
154        turn_id: TurnId,
155        injection: crate::injection::Injection,
156    },
157    ContentFilterHit {
158        turn_id: Option<TurnId>,
159        flow_run_id: Option<FlowRunId>,
160        provider: String,
161        model: String,
162        category: String,
163        action: String,
164    },
165    ContextCompact {
166        session_id: String,
167        before_tokens: u64,
168        after_tokens: u64,
169        compacted_range_start: u64,
170        compacted_range_end: u64,
171        #[serde(default, skip_serializing_if = "Option::is_none")]
172        summary_text: Option<String>,
173        #[serde(default, skip_serializing_if = "Option::is_none")]
174        replacement_msg_seq: Option<u64>,
175    },
176    Checkpoint {
177        session_id: String,
178        messages: Vec<crate::message::Message>,
179        window_tokens: u64,
180    },
181    ContextTruncated {
182        turn_id: Option<TurnId>,
183        flow_run_id: Option<FlowRunId>,
184        original_chars: u64,
185        result_chars: u64,
186        dropped_chars: u64,
187        budget_tokens: u64,
188    },
189    WatchWarn {
190        turn_id: Option<TurnId>,
191        flow_run_id: Option<FlowRunId>,
192        target: String,
193        trigger: String,
194        message: String,
195    },
196    LlmPartialCall {
197        turn_id: Option<TurnId>,
198        flow_run_id: Option<FlowRunId>,
199        model: String,
200        provider: String,
201        tokens_before_abort: u64,
202        restart_reason: String,
203    },
204    PendingPrompt {
205        prompt_id: uuid::Uuid,
206        kind: String,
207        payload: serde_json::Value,
208    },
209    PromptResolved {
210        prompt_id: uuid::Uuid,
211        answer: serde_json::Value,
212    },
213    FlowGraph {
214        run_id: FlowRunId,
215        graph: crate::nodegraph::FlowGraph,
216    },
217    FlowNodeStart {
218        run_id: FlowRunId,
219        node_id: String,
220        kind: crate::nodegraph::NodeKind,
221        label: String,
222        parent_node_id: Option<String>,
223    },
224    FlowNodeEnd {
225        run_id: FlowRunId,
226        node_id: String,
227        status: FlowNodeStatus,
228        output_preview: Option<String>,
229    },
230    ToolNode {
231        run_id: FlowRunId,
232        parent_node_id: String,
233        tool_use_id: String,
234        tool_name: String,
235        args_preview: String,
236    },
237    AttachmentDegraded {
238        turn_id: Option<TurnId>,
239        flow_run_id: Option<FlowRunId>,
240        message_seq: u64,
241        part_index: usize,
242        file_basename: String,
243        reason: String,
244    },
245    ToolPendingApproval {
246        run_id: FlowRunId,
247        tool_use_id: String,
248        tool_name: String,
249        args_preview: String,
250        level: String,
251        #[serde(default, skip_serializing_if = "Option::is_none")]
252        preview: Option<String>,
253    },
254    ToolApproved {
255        run_id: FlowRunId,
256        tool_use_id: String,
257        decided_by: String,
258    },
259    ToolDenied {
260        run_id: FlowRunId,
261        tool_use_id: String,
262        reason: String,
263    },
264}
265
266#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
267#[serde(rename_all = "snake_case")]
268pub enum FlowNodeStatus {
269    Ok,
270    Err,
271    Cancelled,
272}
273
274#[derive(Debug, Clone, Serialize, Deserialize)]
275#[serde(tag = "kind", rename_all = "snake_case")]
276pub enum FlowStatus {
277    Ok,
278    Errored { message: String },
279    Cancelled,
280}
281
282impl FlowStatus {
283    pub fn errored(msg: impl Into<String>) -> Self {
284        Self::Errored {
285            message: msg.into(),
286        }
287    }
288}
289
290#[derive(Debug, Clone, Serialize, Deserialize)]
291#[serde(tag = "kind", rename_all = "snake_case")]
292pub enum LlmCallStatus {
293    Ok,
294    Errored { message: String },
295}
296
297impl LlmCallStatus {
298    pub fn errored(msg: impl Into<String>) -> Self {
299        Self::Errored {
300            message: msg.into(),
301        }
302    }
303}
304
305#[derive(Debug, Clone)]
306pub enum NodeEvent {
307    LlmChunk {
308        text: String,
309        cumulative_tokens: u64,
310    },
311    ThinkingChunk {
312        text: String,
313    },
314    LlmDone {
315        total_tokens: u64,
316    },
317    ToolStdoutLine {
318        line: String,
319    },
320    ToolStderrLine {
321        line: String,
322    },
323    ToolDone {
324        exit: i32,
325    },
326}
327
328pub struct Observable<T> {
329    pub output: crate::tool::BoxFut<'static, Result<T, crate::error::RuntimeError>>,
330    pub events: broadcast::Receiver<NodeEvent>,
331    pub cancel: CancellationToken,
332}
333
334#[derive(Default, Clone)]
335pub struct EventSink {
336    events: Arc<Mutex<Vec<EventEnvelope>>>,
337    forwarder: Option<mpsc::UnboundedSender<EventEnvelope>>,
338    seq_counter: Arc<std::sync::atomic::AtomicU64>,
339    redactor: Option<Arc<crate::redact::Redactor>>,
340    last_compact_at: Arc<Mutex<Option<chrono::DateTime<chrono::Utc>>>>,
341}
342
343impl EventSink {
344    pub fn new() -> Self {
345        Self::default()
346    }
347
348    pub fn with_forwarder(mut self, tx: mpsc::UnboundedSender<EventEnvelope>) -> Self {
349        self.forwarder = Some(tx);
350        self
351    }
352
353    pub fn with_redactor(mut self, redactor: Arc<crate::redact::Redactor>) -> Self {
354        self.redactor = Some(redactor);
355        self
356    }
357
358    // Best-effort peek for anchor labels. NOT reserved: two peekers see the same value.
359    // Safe today because eval is single-threaded per flow (see tool.rs comment on !Send).
360    // If parallel-tool dispatch is introduced, switch call sites to reserve_seq.
361    pub fn next_seq_peek(&self) -> u64 {
362        self.seq_counter.load(std::sync::atomic::Ordering::SeqCst) + 1
363    }
364
365    pub fn restore_seq(&self, last_seq: u64) {
366        self.seq_counter
367            .store(last_seq, std::sync::atomic::Ordering::SeqCst);
368    }
369
370    // Atomic reserve for the future parallel-dispatch case: returns a seq value that
371    // no other reservation can obtain, at the cost of advancing the counter even if
372    // the caller never emits (a hole in seq numbering). Not used yet; kept ready.
373    pub fn reserve_seq(&self) -> u64 {
374        self.seq_counter
375            .fetch_add(1, std::sync::atomic::Ordering::SeqCst)
376            + 1
377    }
378
379    pub fn emit_returning_seq(&self, event: Event) -> u64 {
380        let next = self
381            .seq_counter
382            .fetch_add(1, std::sync::atomic::Ordering::SeqCst)
383            + 1;
384        let envelope = EventEnvelope::new(next, event);
385        if let Some(tx) = &self.forwarder {
386            let _ = tx.send(envelope.clone());
387        }
388        self.events
389            .lock()
390            .expect("event sink poisoned")
391            .push(envelope);
392        next
393    }
394
395    pub fn emit(&self, event: Event) {
396        let next = self
397            .seq_counter
398            .fetch_add(1, std::sync::atomic::Ordering::SeqCst)
399            + 1;
400        let envelope = EventEnvelope::new(next, event);
401        if let Some(tx) = &self.forwarder {
402            let _ = tx.send(envelope.clone());
403        }
404        self.events
405            .lock()
406            .expect("event sink poisoned")
407            .push(envelope);
408    }
409
410    pub fn events_handle(&self) -> Arc<Mutex<Vec<EventEnvelope>>> {
411        self.events.clone()
412    }
413
414    pub fn redactor(&self) -> Option<Arc<crate::redact::Redactor>> {
415        self.redactor.clone()
416    }
417
418    pub fn mark_compacted(&self) {
419        *self.last_compact_at.lock().expect("last_compact poisoned") = Some(chrono::Utc::now());
420    }
421
422    pub fn last_compact_ago_seconds(&self) -> Option<i64> {
423        self.last_compact_at
424            .lock()
425            .expect("last_compact poisoned")
426            .map(|t| (chrono::Utc::now() - t).num_seconds())
427    }
428
429    pub fn drain(&self) -> Vec<Event> {
430        std::mem::take(&mut *self.events.lock().expect("event sink poisoned"))
431            .into_iter()
432            .map(|envelope| envelope.event)
433            .collect()
434    }
435
436    pub fn snapshot(&self) -> Vec<Event> {
437        self.events
438            .lock()
439            .expect("event sink poisoned")
440            .iter()
441            .map(|envelope| envelope.event.clone())
442            .collect()
443    }
444
445    pub fn snapshot_envelopes(&self) -> Vec<EventEnvelope> {
446        self.events
447            .lock()
448            .expect("event sink poisoned")
449            .iter()
450            .cloned()
451            .collect()
452    }
453}
454
455#[cfg(test)]
456mod tests {
457    use super::*;
458
459    #[test]
460    fn flow_start_serializes_parent_linkage() {
461        let parent = FlowRunId::now();
462        let ev = Event::FlowStart {
463            run_id: FlowRunId::now(),
464            flow_name: "child".into(),
465            parent_run_id: Some(parent.clone()),
466            parent_node_id: Some("stmt_3".into()),
467        };
468        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
469        assert_eq!(v["type"], "flow_start");
470        assert_eq!(v["parent_run_id"], serde_json::json!(parent.0.to_string()));
471        assert_eq!(v["parent_node_id"], "stmt_3");
472    }
473
474    #[test]
475    fn flow_node_start_carries_parent_node_id() {
476        let ev = Event::FlowNodeStart {
477            run_id: FlowRunId::now(),
478            node_id: "stmt_1.branch[0]".into(),
479            kind: crate::nodegraph::NodeKind::UserConfirm,
480            label: "fanout".into(),
481            parent_node_id: Some("stmt_1".into()),
482        };
483        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
484        assert_eq!(v["type"], "flow_node_start");
485        assert_eq!(v["parent_node_id"], "stmt_1");
486    }
487
488    #[test]
489    fn tool_node_serializes_all_fields() {
490        let run_id = FlowRunId::now();
491        let ev = Event::ToolNode {
492            run_id: run_id.clone(),
493            parent_node_id: "stmt_2".into(),
494            tool_use_id: "tu_abc".into(),
495            tool_name: "fs.read".into(),
496            args_preview: "{\"path\":\"a.rs\"}".into(),
497        };
498        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
499        assert_eq!(v["type"], "tool_node");
500        assert_eq!(v["run_id"], run_id.0.to_string());
501        assert_eq!(v["parent_node_id"], "stmt_2");
502        assert_eq!(v["tool_use_id"], "tu_abc");
503        assert_eq!(v["tool_name"], "fs.read");
504        assert_eq!(v["args_preview"], "{\"path\":\"a.rs\"}");
505    }
506
507    #[test]
508    fn seq_and_set_seq_cover_tool_node() {
509        let _ev = Event::ToolNode {
510            run_id: FlowRunId::now(),
511            parent_node_id: "s".into(),
512            tool_use_id: "t".into(),
513            tool_name: "n".into(),
514            args_preview: "{}".into(),
515        };
516    }
517
518    #[test]
519    fn attachment_degraded_serializes_all_fields() {
520        let turn = TurnId::now();
521        let flow = FlowRunId::now();
522        let ev = Event::AttachmentDegraded {
523            turn_id: Some(turn.clone()),
524            flow_run_id: Some(flow.clone()),
525            message_seq: 42,
526            part_index: 1,
527            file_basename: "photo.png".into(),
528            reason: "image_too_large".into(),
529        };
530        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
531        assert_eq!(v["type"], "attachment_degraded");
532        assert_eq!(v["message_seq"], 42);
533        assert_eq!(v["part_index"], 1);
534        assert_eq!(v["file_basename"], "photo.png");
535        assert_eq!(v["reason"], "image_too_large");
536        assert_eq!(v["turn_id"], serde_json::json!(turn.0.to_string()));
537        assert_eq!(v["flow_run_id"], serde_json::json!(flow.0.to_string()));
538    }
539
540    #[test]
541    fn seq_and_set_seq_cover_attachment_degraded() {
542        let _ev = Event::AttachmentDegraded {
543            turn_id: None,
544            flow_run_id: None,
545            message_seq: 10,
546            part_index: 0,
547            file_basename: "x".into(),
548            reason: "y".into(),
549        };
550    }
551
552    #[test]
553    fn tool_pending_approval_round_trip() {
554        let ev = Event::ToolPendingApproval {
555            run_id: FlowRunId::now(),
556            tool_use_id: "tu1".into(),
557            tool_name: "fs.write".into(),
558            args_preview: "{}".into(),
559            level: "approve".into(),
560            preview: None,
561        };
562        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
563        assert_eq!(v["type"], "tool_pending_approval");
564        assert_eq!(v["tool_use_id"], "tu1");
565        assert_eq!(v["level"], "approve");
566    }
567
568    #[test]
569    fn seq_and_set_seq_cover_approval_variants() {
570        let rid = FlowRunId::now();
571        for _ev in [
572            Event::ToolPendingApproval {
573                run_id: rid.clone(),
574                tool_use_id: "t".into(),
575                tool_name: "n".into(),
576                args_preview: "{}".into(),
577                level: "approve".into(),
578                preview: None,
579            },
580            Event::ToolApproved {
581                run_id: rid.clone(),
582                tool_use_id: "t".into(),
583                decided_by: "user".into(),
584            },
585            Event::ToolDenied {
586                run_id: rid.clone(),
587                tool_use_id: "t".into(),
588                reason: "no".into(),
589            },
590        ] {}
591    }
592
593    #[test]
594    fn compaction_summary_serializes_all_fields() {
595        let ev = Event::CompactionSummary {
596            session_id: "sess".into(),
597            range_start: 2,
598            range_end: 8,
599            compacted_count: 7,
600            before_tokens: 1000,
601            after_tokens: 250,
602            summary: "gist".into(),
603        };
604        let v: serde_json::Value = serde_json::to_value(&ev).unwrap();
605        assert_eq!(v["type"], "compaction_summary");
606        assert_eq!(v["session_id"], "sess");
607        assert_eq!(v["range_start"], 2);
608        assert_eq!(v["range_end"], 8);
609        assert_eq!(v["compacted_count"], 7);
610        assert_eq!(v["before_tokens"], 1000);
611        assert_eq!(v["after_tokens"], 250);
612        assert_eq!(v["summary"], "gist");
613    }
614
615    #[test]
616    fn seq_and_set_seq_cover_compaction_summary() {
617        let _ev = Event::CompactionSummary {
618            session_id: "sess".into(),
619            range_start: 0,
620            range_end: 1,
621            compacted_count: 2,
622            before_tokens: 10,
623            after_tokens: 3,
624            summary: String::new(),
625        };
626    }
627
628    #[test]
629    fn envelope_round_trips_through_json() {
630        let env = EventEnvelope::new(
631            42,
632            Event::UserMsg {
633                turn_id: TurnId::now(),
634                message: crate::message::Message::user_text(TurnId::now(), "hello"),
635            },
636        );
637        let json = serde_json::to_string(&env).unwrap();
638        let back: EventEnvelope = serde_json::from_str(&json).unwrap();
639        assert_eq!(back.seq, 42);
640        assert!(matches!(back.event, Event::UserMsg { .. }));
641    }
642}