phi-agent 0.9.1

phi-agent — General-purpose AI Agent framework (builder factory, renderer, config, session management)
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
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
//! Event log: serialize turn events to JSONL files.
//!
//! Provides event persistence integrated with SessionContext,
//! shared across CLI, Web, and other consumers.
//!
//! Note: `save_turn_log` performs synchronous file I/O. Consumers should
//! call it via `tokio::task::spawn_blocking` in async contexts to avoid
//! blocking the runtime.

use std::io::Write;

use agent_base::{AgentResult, RuntimeEvent, UserEvent};

use crate::session::SessionContext;

/// Save all events from a turn to a JSONL file.
///
/// Performs synchronous file I/O. Callers should invoke this via
/// `tokio::task::spawn_blocking`.
pub fn save_turn_log(
    session_ctx: &SessionContext,
    turn: u32,
    events: &[RuntimeEvent],
    user_input: &str,
) -> AgentResult<()> {
    let turn_path = session_ctx.turn_path(turn as usize);
    let mut file = std::fs::OpenOptions::new().create(true).append(true).open(&turn_path)?;

    let meta = serde_json::json!({
        "turn": turn,
        "timestamp": chrono::Utc::now().to_rfc3339(),
        "user_input": user_input,
    });
    writeln!(file, "{}", serde_json::to_string(&meta)?)?;

    for event in events {
        let line = event_to_jsonl(event);
        writeln!(file, "{}", line)?;
    }

    writeln!(file, "{}", serde_json::to_string(&serde_json::json!({"type": "turn_end", "turn": turn}))?)?;

    file.flush()?;

    Ok(())
}

/// Convert a RuntimeEvent to a JSON Value (shared by event_log and render).
pub fn event_to_value(event: &RuntimeEvent) -> serde_json::Value {
    match event {
        RuntimeEvent::ThoughtDelta { text, .. } => {
            serde_json::json!({"type": "thought_delta", "text": text})
        },
        RuntimeEvent::TextDelta { text, .. } => {
            serde_json::json!({"type": "text_delta", "text": text})
        },
        RuntimeEvent::ToolCallStarted { tool_name, args_json, .. } => {
            let args: serde_json::Value = serde_json::from_str(args_json).unwrap_or(serde_json::Value::Null);
            serde_json::json!({"type": "tool_call_started", "tool": tool_name, "args": args})
        },
        RuntimeEvent::ToolCallFinished { tool_name, summary, .. } => {
            serde_json::json!({"type": "tool_call_finished", "tool": tool_name, "summary": summary})
        },
        RuntimeEvent::AwaitingApproval { request, .. } => {
            serde_json::json!({"type": "approval_request", "title": request.title, "message": request.message})
        },
        RuntimeEvent::PlanUpdated { explanation, plan, .. } => {
            serde_json::json!({"type": "plan_updated", "explanation": explanation, "plan": plan})
        },
        RuntimeEvent::UserEvent { event: UserEvent::Structured { event_type, data }, .. } => {
            serde_json::json!({"type": "user_event", "event_type": event_type, "data": data})
        },
        RuntimeEvent::UserEvent { event: UserEvent::SubAgentEvent { subagent, event: inner }, .. } => {
            let inner = event_to_value(inner);
            serde_json::json!({"type": "subagent_event", "subagent": subagent, "event": inner})
        },
        RuntimeEvent::UserEvent { .. } => serde_json::json!({"type": "other"}),
        RuntimeEvent::RunCancelled { .. } => serde_json::json!({"type": "run_cancelled"}),
        RuntimeEvent::RunFinished { .. } => serde_json::json!({"type": "run_finished"}),
        RuntimeEvent::Checkpoint { .. } => serde_json::json!({"type": "checkpoint"}),
    }
}

/// Convert a RuntimeEvent to a JSONL line.
pub fn event_to_jsonl(event: &RuntimeEvent) -> String {
    let value = event_to_value(event);
    serde_json::to_string(&value).unwrap_or_else(|_| r#"{"type":"serialize_error"}"#.to_string())
}

#[cfg(test)]
mod tests {
    use super::*;
    use agent_base::{SessionId, UserEvent};
    use tempfile::TempDir;

    fn session_id() -> SessionId {
        SessionId { id: 1, external_id: None }
    }

    // ── event_to_value tests ──

    #[test]
    fn test_event_to_value_text_delta() {
        let v = event_to_value(&RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "hello".into(),
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "text_delta");
        assert_eq!(v["text"], "hello");
    }

    #[test]
    fn test_event_to_value_thought_delta() {
        let v = event_to_value(&RuntimeEvent::ThoughtDelta {
            session_id: session_id(),
            text: "thinking".into(),
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "thought_delta");
    }

    #[test]
    fn test_event_to_value_tool_call_started() {
        let v = event_to_value(&RuntimeEvent::ToolCallStarted {
            session_id: session_id(),
            tool_name: "shell".into(),
            args_json: r#"{"cmd":"ls"}"#.into(),
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "tool_call_started");
        assert_eq!(v["tool"], "shell");
        assert_eq!(v["args"]["cmd"], "ls");
    }

    #[test]
    fn test_event_to_value_tool_call_finished() {
        let v = event_to_value(&RuntimeEvent::ToolCallFinished {
            session_id: session_id(),
            tool_name: "shell".into(),
            summary: "done".into(),
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "tool_call_finished");
        assert_eq!(v["summary"], "done");
    }

    #[test]
    fn test_event_to_value_run_finished() {
        let v = event_to_value(&RuntimeEvent::RunFinished { session_id: session_id(), agent_id: None, trace_id: None });
        assert_eq!(v["type"], "run_finished");
    }

    #[test]
    fn test_event_to_value_run_cancelled() {
        let v =
            event_to_value(&RuntimeEvent::RunCancelled { session_id: session_id(), agent_id: None, trace_id: None });
        assert_eq!(v["type"], "run_cancelled");
    }

    #[test]
    fn test_event_to_value_user_event_other() {
        let v = event_to_value(&RuntimeEvent::UserEvent {
            session_id: session_id(),
            event: UserEvent::Progress { text: "loading".into() },
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "other");
    }

    #[test]
    fn test_event_to_value_user_event_structured() {
        let v = event_to_value(&RuntimeEvent::UserEvent {
            session_id: session_id(),
            event: UserEvent::Structured { event_type: "custom".into(), data: serde_json::json!({"key": "value"}) },
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "user_event");
        assert_eq!(v["event_type"], "custom");
    }

    // ── event_to_jsonl tests ──

    #[test]
    fn test_event_to_jsonl_returns_valid_json() {
        let line = event_to_jsonl(&RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "hello".into(),
            agent_id: None,
            trace_id: None,
        });
        let v: serde_json::Value = serde_json::from_str(&line).unwrap();
        assert_eq!(v["type"], "text_delta");
    }

    #[test]
    fn test_event_to_jsonl_all_variants_valid() {
        let events: Vec<RuntimeEvent> = vec![
            RuntimeEvent::TextDelta { session_id: session_id(), text: "t".into(), agent_id: None, trace_id: None },
            RuntimeEvent::ThoughtDelta { session_id: session_id(), text: "t".into(), agent_id: None, trace_id: None },
            RuntimeEvent::ToolCallStarted {
                session_id: session_id(),
                tool_name: "t".into(),
                args_json: "{}".into(),
                agent_id: None,
                trace_id: None,
            },
            RuntimeEvent::ToolCallFinished {
                session_id: session_id(),
                tool_name: "t".into(),
                summary: "s".into(),
                agent_id: None,
                trace_id: None,
            },
            RuntimeEvent::RunFinished { session_id: session_id(), agent_id: None, trace_id: None },
            RuntimeEvent::RunCancelled { session_id: session_id(), agent_id: None, trace_id: None },
            RuntimeEvent::UserEvent {
                session_id: session_id(),
                event: UserEvent::Progress { text: "t".into() },
                agent_id: None,
                trace_id: None,
            },
        ];
        for e in &events {
            let line = event_to_jsonl(e);
            assert!(serde_json::from_str::<serde_json::Value>(&line).is_ok(), "Failed to parse JSONL for event");
        }
    }

    // ── save_turn_log tests ──

    fn make_session_ctx(tmp: &TempDir) -> SessionContext {
        crate::session::resolve_session(Some("test-session"), tmp.path()).unwrap()
    }

    #[test]
    fn test_save_turn_log_creates_file() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        let events = vec![RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "hello".into(),
            agent_id: None,
            trace_id: None,
        }];
        save_turn_log(&ctx, 1, &events, "test input").unwrap();
        let path = ctx.turn_path(1);
        assert!(path.exists());
        let content = std::fs::read_to_string(&path).unwrap();
        assert!(!content.is_empty());
    }

    #[test]
    fn test_save_turn_log_contains_metadata() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        let events = vec![RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "hello".into(),
            agent_id: None,
            trace_id: None,
        }];
        save_turn_log(&ctx, 1, &events, "my input").unwrap();
        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
        let lines: Vec<&str> = content.lines().collect();
        let first: serde_json::Value = serde_json::from_str(lines[0]).unwrap();
        assert_eq!(first["turn"], 1);
        assert_eq!(first["user_input"], "my input");
        assert!(first["timestamp"].as_str().is_some());
    }

    #[test]
    fn test_save_turn_log_contains_events() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        let events = vec![
            RuntimeEvent::TextDelta { session_id: session_id(), text: "hello".into(), agent_id: None, trace_id: None },
            RuntimeEvent::RunFinished { session_id: session_id(), agent_id: None, trace_id: None },
        ];
        save_turn_log(&ctx, 1, &events, "input").unwrap();
        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
        let lines: Vec<&str> = content.lines().collect();
        // Line 0: metadata, Line 1: text_delta, Line 2: run_finished, Line 3: turn_end
        assert!(lines.len() >= 4);
        let line1: serde_json::Value = serde_json::from_str(lines[1]).unwrap();
        assert_eq!(line1["type"], "text_delta");
        let line2: serde_json::Value = serde_json::from_str(lines[2]).unwrap();
        assert_eq!(line2["type"], "run_finished");
    }

    #[test]
    fn test_save_turn_log_contains_turn_end_marker() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        let events = vec![RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "hello".into(),
            agent_id: None,
            trace_id: None,
        }];
        save_turn_log(&ctx, 1, &events, "input").unwrap();
        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
        let last_line = content.lines().last().unwrap();
        let v: serde_json::Value = serde_json::from_str(last_line).unwrap();
        assert_eq!(v["type"], "turn_end");
        assert_eq!(v["turn"], 1);
    }

    #[test]
    fn test_save_turn_log_appends() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        let events1 = vec![RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "turn1".into(),
            agent_id: None,
            trace_id: None,
        }];
        let events2 = vec![RuntimeEvent::TextDelta {
            session_id: session_id(),
            text: "turn2".into(),
            agent_id: None,
            trace_id: None,
        }];
        save_turn_log(&ctx, 1, &events1, "input1").unwrap();
        save_turn_log(&ctx, 1, &events2, "input2").unwrap();
        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
        assert!(content.contains("turn1"));
        assert!(content.contains("turn2"));
        // Should have two turn_end markers
        let turn_end_count = content.lines().filter(|l| l.contains("turn_end")).count();
        assert_eq!(turn_end_count, 2);
    }

    #[test]
    fn test_save_turn_log_empty_events() {
        let tmp = TempDir::new().unwrap();
        let ctx = make_session_ctx(&tmp);
        save_turn_log(&ctx, 1, &[], "no events").unwrap();
        let content = std::fs::read_to_string(ctx.turn_path(1)).unwrap();
        let lines: Vec<&str> = content.lines().collect();
        // metadata header + turn_end marker
        assert_eq!(lines.len(), 2);
        let last: serde_json::Value = serde_json::from_str(lines[1]).unwrap();
        assert_eq!(last["type"], "turn_end");
        assert_eq!(last["turn"], 1);
    }

    // ── SubAgentEvent tests ──

    #[test]
    fn test_event_to_value_subagent_event() {
        let v = event_to_value(&RuntimeEvent::UserEvent {
            session_id: session_id(),
            event: UserEvent::SubAgentEvent {
                subagent: "root/searcher".into(),
                event: Box::new(RuntimeEvent::TextDelta {
                    session_id: session_id(),
                    text: "result".into(),
                    agent_id: None,
                    trace_id: None,
                }),
            },
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "subagent_event");
        assert_eq!(v["subagent"], "root/searcher");
        assert_eq!(v["event"]["type"], "text_delta");
        assert_eq!(v["event"]["text"], "result");
    }

    #[test]
    fn test_event_to_value_nested_subagent_event() {
        // Subagent event wrapping another subagent event (nested)
        let v = event_to_value(&RuntimeEvent::UserEvent {
            session_id: session_id(),
            event: UserEvent::SubAgentEvent {
                subagent: "root/parent".into(),
                event: Box::new(RuntimeEvent::UserEvent {
                    session_id: session_id(),
                    event: UserEvent::SubAgentEvent {
                        subagent: "root/parent/child".into(),
                        event: Box::new(RuntimeEvent::TextDelta {
                            session_id: session_id(),
                            text: "deep".into(),
                            agent_id: None,
                            trace_id: None,
                        }),
                    },
                    agent_id: None,
                    trace_id: None,
                }),
            },
            agent_id: None,
            trace_id: None,
        });
        assert_eq!(v["type"], "subagent_event");
        assert_eq!(v["subagent"], "root/parent");
        assert_eq!(v["event"]["type"], "subagent_event");
        assert_eq!(v["event"]["subagent"], "root/parent/child");
        assert_eq!(v["event"]["event"]["text"], "deep");
    }
}