phi_agent/
event_log.rs

1//! Event log: serialize turn events to JSONL files.
2//!
3//! Provides event persistence integrated with SessionContext,
4//! shared across CLI, Web, and other consumers.
5//!
6//! Note: `save_turn_log` performs synchronous file I/O. Consumers should
7//! call it via `tokio::task::spawn_blocking` in async contexts to avoid
8//! blocking the runtime.
9
10use std::io::Write;
11
12use agent_base::{RuntimeEvent, UserEvent};
13use anyhow::Result;
14
15use crate::session::SessionContext;
16
17/// Save all events from a turn to a JSONL file.
18///
19/// Performs synchronous file I/O. Callers should invoke this via
20/// `tokio::task::spawn_blocking`.
21pub fn save_turn_log(session_ctx: &SessionContext, turn: u32, events: &[RuntimeEvent], user_input: &str) -> Result<()> {
22    let turn_path = session_ctx.turn_path(turn as usize);
23    let mut file = std::fs::OpenOptions::new().create(true).append(true).open(&turn_path)?;
24
25    let meta = serde_json::json!({
26        "turn": turn,
27        "timestamp": chrono::Utc::now().to_rfc3339(),
28        "user_input": user_input,
29    });
30    writeln!(file, "{}", serde_json::to_string(&meta)?)?;
31
32    for event in events {
33        let line = event_to_jsonl(event);
34        writeln!(file, "{}", line)?;
35    }
36
37    writeln!(file, "{}", serde_json::to_string(&serde_json::json!({"type": "turn_end", "turn": turn}))?)?;
38
39    file.flush()?;
40
41    Ok(())
42}
43
44/// Convert a RuntimeEvent to a JSON Value (shared by event_log and render).
45pub fn event_to_value(event: &RuntimeEvent) -> serde_json::Value {
46    match event {
47        RuntimeEvent::ThoughtDelta { text, .. } => {
48            serde_json::json!({"type": "thought_delta", "text": text})
49        },
50        RuntimeEvent::TextDelta { text, .. } => {
51            serde_json::json!({"type": "text_delta", "text": text})
52        },
53        RuntimeEvent::ToolCallStarted { tool_name, args_json, .. } => {
54            let args: serde_json::Value = serde_json::from_str(args_json).unwrap_or(serde_json::Value::Null);
55            serde_json::json!({"type": "tool_call_started", "tool": tool_name, "args": args})
56        },
57        RuntimeEvent::ToolCallFinished { tool_name, summary, .. } => {
58            serde_json::json!({"type": "tool_call_finished", "tool": tool_name, "summary": summary})
59        },
60        RuntimeEvent::AwaitingApproval { request, .. } => {
61            serde_json::json!({"type": "approval_request", "title": request.title, "message": request.message})
62        },
63        RuntimeEvent::PlanUpdated { explanation, plan, .. } => {
64            serde_json::json!({"type": "plan_updated", "explanation": explanation, "plan": plan})
65        },
66        RuntimeEvent::UserEvent { event: UserEvent::Structured { event_type, data }, .. } => {
67            serde_json::json!({"type": "user_event", "event_type": event_type, "data": data})
68        },
69        RuntimeEvent::UserEvent { .. } => serde_json::json!({"type": "other"}),
70        RuntimeEvent::RunCancelled { .. } => serde_json::json!({"type": "run_cancelled"}),
71        RuntimeEvent::RunFinished { .. } => serde_json::json!({"type": "run_finished"}),
72        RuntimeEvent::Checkpoint { .. } => serde_json::json!({"type": "checkpoint"}),
73    }
74}
75
76/// Convert a RuntimeEvent to a JSONL line.
77pub fn event_to_jsonl(event: &RuntimeEvent) -> String {
78    let value = event_to_value(event);
79    serde_json::to_string(&value).unwrap_or_else(|_| r#"{"type":"serialize_error"}"#.to_string())
80}
81
82#[cfg(test)]
83mod tests {
84    use super::*;
85    use agent_base::{SessionId, UserEvent};
86    use tempfile::TempDir;
87
88    fn session_id() -> SessionId {
89        SessionId { id: 1, external_id: None }
90    }
91
92    // ── event_to_value tests ──
93
94    #[test]
95    fn test_event_to_value_text_delta() {
96        let v = event_to_value(&RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() });
97        assert_eq!(v["type"], "text_delta");
98        assert_eq!(v["text"], "hello");
99    }
100
101    #[test]
102    fn test_event_to_value_thought_delta() {
103        let v = event_to_value(&RuntimeEvent::ThoughtDelta { session_id: session_id(), text: "thinking".into() });
104        assert_eq!(v["type"], "thought_delta");
105    }
106
107    #[test]
108    fn test_event_to_value_tool_call_started() {
109        let v = event_to_value(&RuntimeEvent::ToolCallStarted {
110            session_id: session_id(),
111            tool_name: "shell".into(),
112            args_json: r#"{"cmd":"ls"}"#.into(),
113        });
114        assert_eq!(v["type"], "tool_call_started");
115        assert_eq!(v["tool"], "shell");
116        assert_eq!(v["args"]["cmd"], "ls");
117    }
118
119    #[test]
120    fn test_event_to_value_tool_call_finished() {
121        let v = event_to_value(&RuntimeEvent::ToolCallFinished {
122            session_id: session_id(),
123            tool_name: "shell".into(),
124            summary: "done".into(),
125        });
126        assert_eq!(v["type"], "tool_call_finished");
127        assert_eq!(v["summary"], "done");
128    }
129
130    #[test]
131    fn test_event_to_value_run_finished() {
132        let v = event_to_value(&RuntimeEvent::RunFinished { session_id: session_id() });
133        assert_eq!(v["type"], "run_finished");
134    }
135
136    #[test]
137    fn test_event_to_value_run_cancelled() {
138        let v = event_to_value(&RuntimeEvent::RunCancelled { session_id: session_id() });
139        assert_eq!(v["type"], "run_cancelled");
140    }
141
142    #[test]
143    fn test_event_to_value_user_event_other() {
144        let v = event_to_value(&RuntimeEvent::UserEvent {
145            session_id: session_id(),
146            event: UserEvent::Progress { text: "loading".into() },
147        });
148        assert_eq!(v["type"], "other");
149    }
150
151    #[test]
152    fn test_event_to_value_user_event_structured() {
153        let v = event_to_value(&RuntimeEvent::UserEvent {
154            session_id: session_id(),
155            event: UserEvent::Structured { event_type: "custom".into(), data: serde_json::json!({"key": "value"}) },
156        });
157        assert_eq!(v["type"], "user_event");
158        assert_eq!(v["event_type"], "custom");
159    }
160
161    // ── event_to_jsonl tests ──
162
163    #[test]
164    fn test_event_to_jsonl_returns_valid_json() {
165        let line = event_to_jsonl(&RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() });
166        let v: serde_json::Value = serde_json::from_str(&line).unwrap();
167        assert_eq!(v["type"], "text_delta");
168    }
169
170    #[test]
171    fn test_event_to_jsonl_all_variants_valid() {
172        let events: Vec<RuntimeEvent> = vec![
173            RuntimeEvent::TextDelta { session_id: session_id(), text: "t".into() },
174            RuntimeEvent::ThoughtDelta { session_id: session_id(), text: "t".into() },
175            RuntimeEvent::ToolCallStarted { session_id: session_id(), tool_name: "t".into(), args_json: "{}".into() },
176            RuntimeEvent::ToolCallFinished { session_id: session_id(), tool_name: "t".into(), summary: "s".into() },
177            RuntimeEvent::RunFinished { session_id: session_id() },
178            RuntimeEvent::RunCancelled { session_id: session_id() },
179            RuntimeEvent::UserEvent { session_id: session_id(), event: UserEvent::Progress { text: "t".into() } },
180        ];
181        for e in &events {
182            let line = event_to_jsonl(e);
183            assert!(serde_json::from_str::<serde_json::Value>(&line).is_ok(), "Failed to parse JSONL for event");
184        }
185    }
186
187    // ── save_turn_log tests ──
188
189    fn make_session_ctx(tmp: &TempDir) -> SessionContext {
190        crate::session::resolve_session(Some("test-session"), tmp.path()).unwrap()
191    }
192
193    #[test]
194    fn test_save_turn_log_creates_file() {
195        let tmp = TempDir::new().unwrap();
196        let ctx = make_session_ctx(&tmp);
197        let events = vec![RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() }];
198        save_turn_log(&ctx, 1, &events, "test input").unwrap();
199        let path = ctx.turn_path(1);
200        assert!(path.exists());
201        let content = std::fs::read_to_string(&path).unwrap();
202        assert!(!content.is_empty());
203    }
204
205    #[test]
206    fn test_save_turn_log_contains_metadata() {
207        let tmp = TempDir::new().unwrap();
208        let ctx = make_session_ctx(&tmp);
209        let events = vec![RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() }];
210        save_turn_log(&ctx, 1, &events, "my input").unwrap();
211        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
212        let lines: Vec<&str> = content.lines().collect();
213        let first: serde_json::Value = serde_json::from_str(lines[0]).unwrap();
214        assert_eq!(first["turn"], 1);
215        assert_eq!(first["user_input"], "my input");
216        assert!(first["timestamp"].as_str().is_some());
217    }
218
219    #[test]
220    fn test_save_turn_log_contains_events() {
221        let tmp = TempDir::new().unwrap();
222        let ctx = make_session_ctx(&tmp);
223        let events = vec![
224            RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() },
225            RuntimeEvent::RunFinished { session_id: session_id() },
226        ];
227        save_turn_log(&ctx, 1, &events, "input").unwrap();
228        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
229        let lines: Vec<&str> = content.lines().collect();
230        // Line 0: metadata, Line 1: text_delta, Line 2: run_finished, Line 3: turn_end
231        assert!(lines.len() >= 4);
232        let line1: serde_json::Value = serde_json::from_str(lines[1]).unwrap();
233        assert_eq!(line1["type"], "text_delta");
234        let line2: serde_json::Value = serde_json::from_str(lines[2]).unwrap();
235        assert_eq!(line2["type"], "run_finished");
236    }
237
238    #[test]
239    fn test_save_turn_log_contains_turn_end_marker() {
240        let tmp = TempDir::new().unwrap();
241        let ctx = make_session_ctx(&tmp);
242        let events = vec![RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into() }];
243        save_turn_log(&ctx, 1, &events, "input").unwrap();
244        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
245        let last_line = content.lines().last().unwrap();
246        let v: serde_json::Value = serde_json::from_str(last_line).unwrap();
247        assert_eq!(v["type"], "turn_end");
248        assert_eq!(v["turn"], 1);
249    }
250
251    #[test]
252    fn test_save_turn_log_appends() {
253        let tmp = TempDir::new().unwrap();
254        let ctx = make_session_ctx(&tmp);
255        let events1 = vec![RuntimeEvent::TextDelta { session_id: session_id(), text: "turn1".into() }];
256        let events2 = vec![RuntimeEvent::TextDelta { session_id: session_id(), text: "turn2".into() }];
257        save_turn_log(&ctx, 1, &events1, "input1").unwrap();
258        save_turn_log(&ctx, 1, &events2, "input2").unwrap();
259        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
260        assert!(content.contains("turn1"));
261        assert!(content.contains("turn2"));
262        // Should have two turn_end markers
263        let turn_end_count = content.lines().filter(|l| l.contains("turn_end")).count();
264        assert_eq!(turn_end_count, 2);
265    }
266
267    #[test]
268    fn test_save_turn_log_empty_events() {
269        let tmp = TempDir::new().unwrap();
270        let ctx = make_session_ctx(&tmp);
271        save_turn_log(&ctx, 1, &[], "no events").unwrap();
272        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
273        let lines: Vec<&str> = content.lines().collect();
274        // metadata header + turn_end marker
275        assert_eq!(lines.len(), 2);
276        let last: serde_json::Value = serde_json::from_str(lines[1]).unwrap();
277        assert_eq!(last["type"], "turn_end");
278        assert_eq!(last["turn"], 1);
279    }
280}
phi_agent/event_log.rs

phi_agent/
event_log.rs
