phi-telemetry 0.7.0

Observability layer for phi-agent — collects and persists structured metrics
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
411
412
413
414
415
416
//! Metrics persistence — save, load, and list session metrics from disk.

use std::path::Path;

use anyhow::{Context, Result};

use crate::types::{SessionMetrics, SessionSummary};

/// Metrics file name within a session directory.
const METRICS_FILE: &str = "session_metrics.json";

/// Incrementally write session metrics to `session_metrics.json`.
///
/// Merges with any existing file first: a second writer over the same session
/// (TUI session switch, a new process resuming it) must extend the per-turn
/// history rather than clobber it — a plain overwrite once erased a whole
/// session's stats when a resume started a fresh accumulator over the same
/// directory. Union is keyed on `(turn_number, started_at)`, so the per-turn
/// saves from a single process stay idempotent.
pub fn save_metrics(metrics: &SessionMetrics, session_dir: &Path) -> Result<()> {
    let path = session_dir.join(METRICS_FILE);
    let merged = match try_load_metrics(session_dir) {
        Some(mut existing) => {
            existing.merge_turns(metrics);
            // The writer knows its own final state (e.g. `finalize` set
            // Interrupted right before this save) — let it win.
            existing.outcome = metrics.outcome.clone();
            existing
        }
        None => metrics.clone(),
    };
    let json = serde_json::to_string_pretty(&merged)?;
    std::fs::write(&path, json)?;
    tracing::debug!(
        path = %path.display(),
        turns = merged.total_turns,
        "session_metrics saved"
    );
    Ok(())
}

/// Load session metrics from `session_metrics.json` in a session directory.
pub fn load_metrics(session_dir: &Path) -> Result<SessionMetrics> {
    let path = session_dir.join(METRICS_FILE);
    let content = std::fs::read_to_string(&path)
        .with_context(|| format!("Failed to read metrics file: {}", path.display()))?;
    let metrics: SessionMetrics = serde_json::from_str(&content)
        .with_context(|| format!("Failed to parse metrics file: {}", path.display()))?;
    Ok(metrics)
}

/// Try to load session metrics, returning `None` if the file doesn't exist.
pub fn try_load_metrics(session_dir: &Path) -> Option<SessionMetrics> {
    load_metrics(session_dir).ok()
}

/// List all session summaries by scanning the sessions directory.
/// Reads each `session_metrics.json` and extracts summary fields.
pub fn list_all_metrics(base_dir: &Path) -> Result<Vec<SessionSummary>> {
    let sessions_dir = base_dir.join("sessions");
    if !sessions_dir.exists() {
        return Ok(Vec::new());
    }

    let mut summaries = Vec::new();
    for entry in std::fs::read_dir(&sessions_dir)? {
        let entry = entry?;
        let path = entry.path();
        if !path.is_dir() {
            continue;
        }

        if let Some(metrics) = try_load_metrics(&path) {
            let product = metrics
                .custom
                .get("product")
                .and_then(|v| v.as_str())
                .map(|s| s.to_string());

            summaries.push(SessionSummary {
                session_id: metrics.session_id,
                node_id: metrics.node_id,
                created_at: metrics.created_at,
                model: metrics.model,
                total_turns: metrics.total_turns,
                total_chars: metrics.total_chars,
                outcome: metrics.outcome,
                product,
            });
        }
    }

    // Sort by created_at descending (newest first)
    summaries.sort_by(|a, b| b.created_at.cmp(&a.created_at));
    Ok(summaries)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::{SessionMetrics, SessionOutcome, TurnMetrics, TurnOutcome};
    use serde_json::Value;
    use std::fs;

    /// Helper: create a temporary directory for tests.
    fn temp_dir(name: &str) -> std::path::PathBuf {
        let dir = std::env::temp_dir().join(format!(
            "phi_telemetry_test_{}_{}",
            name,
            std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_nanos()
        ));
        fs::create_dir_all(&dir).unwrap();
        dir
    }

    /// Helper: build a sample SessionMetrics with one turn.
    fn sample_metrics(session_id: &str, model: &str) -> SessionMetrics {
        let mut m = SessionMetrics::new(
            session_id.to_string(),
            "node-1".to_string(),
            model.to_string(),
        );
        let turn = TurnMetrics::new(
            1,
            "2026-08-01T12:00:00Z".to_string(),
            1000,
            model.to_string(),
            "test input".to_string(),
            TurnOutcome::Completed,
        );
        m.append_turn(turn);
        m
    }

    // ── save_metrics ──

    #[test]
    fn save_metrics_creates_file() {
        let dir = temp_dir("save_creates");
        let m = sample_metrics("s1", "gpt-4o");
        save_metrics(&m, &dir).unwrap();

        let path = dir.join(METRICS_FILE);
        assert!(path.exists());

        // Verify content is valid JSON
        let content = fs::read_to_string(&path).unwrap();
        let parsed: SessionMetrics = serde_json::from_str(&content).unwrap();
        assert_eq!(parsed.session_id, "s1");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn save_metrics_merges_instead_of_clobbering() {
        let dir = temp_dir("save_merges");
        // First writer records turn 1.
        let mut m1 = sample_metrics("s1", "gpt-4o");
        m1.outcome = SessionOutcome::Cancelled;
        save_metrics(&m1, &dir).unwrap();

        // A second writer (fresh accumulator, e.g. a resume) records turn 2
        // over the same directory. Its own outcome is the default Completed.
        let mut m2 = SessionMetrics::new(
            "s1".to_string(),
            "node-1".to_string(),
            "claude-sonnet".to_string(),
        );
        let turn2 = TurnMetrics::new(
            2,
            "2026-08-01T12:01:00Z".to_string(),
            2000,
            "gpt-4o".to_string(),
            "second input".to_string(),
            TurnOutcome::Completed,
        );
        m2.append_turn(turn2);
        save_metrics(&m2, &dir).unwrap();

        let loaded = load_metrics(&dir).unwrap();
        // Both writers' turns survive — nothing is erased.
        assert_eq!(loaded.total_turns, 2);
        assert_eq!(loaded.turns.len(), 2);
        assert_eq!(loaded.turns[0].turn_number, 1);
        assert_eq!(loaded.turns[1].turn_number, 2);
        // Aggregates are rebuilt over the union.
        assert_eq!(loaded.total_duration_ms, 3000);
        // The last writer's outcome wins.
        assert_eq!(loaded.outcome, SessionOutcome::Completed);

        // Re-saving the same data is idempotent (per-turn saves from one
        // process must not double-count).
        save_metrics(&m2, &dir).unwrap();
        let loaded = load_metrics(&dir).unwrap();
        assert_eq!(loaded.total_turns, 2);

        let _ = fs::remove_dir_all(&dir);
    }

    // ── load_metrics ──

    #[test]
    fn load_metrics_roundtrip() {
        let dir = temp_dir("load_roundtrip");
        let original = sample_metrics("s1", "gpt-4o");
        save_metrics(&original, &dir).unwrap();

        let loaded = load_metrics(&dir).unwrap();
        assert_eq!(loaded.session_id, "s1");
        assert_eq!(loaded.model, "gpt-4o");
        assert_eq!(loaded.total_turns, 1);
        assert_eq!(loaded.turns.len(), 1);
        assert_eq!(loaded.node_id, "node-1");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn load_metrics_file_not_found() {
        let dir = temp_dir("load_not_found");
        let result = load_metrics(&dir);
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("Failed to read metrics file")
        );

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn load_metrics_invalid_json() {
        let dir = temp_dir("load_invalid");
        fs::write(dir.join(METRICS_FILE), "not valid json").unwrap();

        let result = load_metrics(&dir);
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("Failed to parse metrics file")
        );

        let _ = fs::remove_dir_all(&dir);
    }

    // ── try_load_metrics ──

    #[test]
    fn try_load_metrics_returns_some_when_exists() {
        let dir = temp_dir("try_some");
        let m = sample_metrics("s1", "gpt-4o");
        save_metrics(&m, &dir).unwrap();

        let result = try_load_metrics(&dir);
        assert!(result.is_some());
        assert_eq!(result.unwrap().session_id, "s1");

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn try_load_metrics_returns_none_when_missing() {
        let dir = temp_dir("try_none");
        let result = try_load_metrics(&dir);
        assert!(result.is_none());

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn try_load_metrics_returns_none_on_invalid_json() {
        let dir = temp_dir("try_invalid");
        fs::write(dir.join(METRICS_FILE), "not json").unwrap();

        let result = try_load_metrics(&dir);
        assert!(result.is_none());

        let _ = fs::remove_dir_all(&dir);
    }

    // ── list_all_metrics ──

    #[test]
    fn list_all_metrics_empty_when_no_sessions_dir() {
        let dir = temp_dir("list_no_sessions");
        let result = list_all_metrics(&dir).unwrap();
        assert!(result.is_empty());

        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn list_all_metrics_returns_summaries_sorted_by_date() {
        let base = temp_dir("list_sorted");
        let sessions_dir = base.join("sessions");
        fs::create_dir_all(&sessions_dir).unwrap();

        // Create two sessions with different created_at
        let dir1 = sessions_dir.join("s1");
        fs::create_dir_all(&dir1).unwrap();
        let mut m1 = sample_metrics("s1", "gpt-4o");
        m1.created_at = "2026-01-01T00:00:00Z".to_string();
        save_metrics(&m1, &dir1).unwrap();

        let dir2 = sessions_dir.join("s2");
        fs::create_dir_all(&dir2).unwrap();
        let mut m2 = sample_metrics("s2", "claude-sonnet");
        m2.created_at = "2026-08-01T00:00:00Z".to_string();
        save_metrics(&m2, &dir2).unwrap();

        let summaries = list_all_metrics(&base).unwrap();
        assert_eq!(summaries.len(), 2);
        // Sorted descending by created_at — s2 first
        assert_eq!(summaries[0].session_id, "s2");
        assert_eq!(summaries[1].session_id, "s1");
        assert_eq!(summaries[0].model, "claude-sonnet");
        assert_eq!(summaries[0].total_turns, 1);

        let _ = fs::remove_dir_all(&base);
    }

    #[test]
    fn list_all_metrics_skips_non_session_dirs() {
        let base = temp_dir("list_skip");
        let sessions_dir = base.join("sessions");
        fs::create_dir_all(&sessions_dir).unwrap();

        // A subdirectory without metrics — should be skipped gracefully
        let empty_dir = sessions_dir.join("empty_session");
        fs::create_dir_all(&empty_dir).unwrap();

        // A regular file (not a dir) — should be skipped
        fs::write(sessions_dir.join("not_a_dir.txt"), "data").unwrap();

        // A valid session
        let valid_dir = sessions_dir.join("valid");
        fs::create_dir_all(&valid_dir).unwrap();
        save_metrics(&sample_metrics("valid", "gpt-4o"), &valid_dir).unwrap();

        let summaries = list_all_metrics(&base).unwrap();
        assert_eq!(summaries.len(), 1);
        assert_eq!(summaries[0].session_id, "valid");

        let _ = fs::remove_dir_all(&base);
    }

    #[test]
    fn list_all_metrics_extracts_product_from_custom() {
        let base = temp_dir("list_product");
        let sessions_dir = base.join("sessions");
        let sdir = sessions_dir.join("s1");
        fs::create_dir_all(&sdir).unwrap();

        let mut m = sample_metrics("s1", "gpt-4o");
        if let Value::Object(ref mut map) = m.custom {
            map.insert("product".to_string(), Value::String("phi-bard".to_string()));
        }
        save_metrics(&m, &sdir).unwrap();

        let summaries = list_all_metrics(&base).unwrap();
        assert_eq!(summaries.len(), 1);
        assert_eq!(summaries[0].product, Some("phi-bard".to_string()));

        let _ = fs::remove_dir_all(&base);
    }

    #[test]
    fn list_all_metrics_no_product_when_custom_empty() {
        let base = temp_dir("list_no_product");
        let sessions_dir = base.join("sessions");
        let sdir = sessions_dir.join("s1");
        fs::create_dir_all(&sdir).unwrap();

        let m = sample_metrics("s1", "gpt-4o");
        save_metrics(&m, &sdir).unwrap();

        let summaries = list_all_metrics(&base).unwrap();
        assert_eq!(summaries[0].product, None);

        let _ = fs::remove_dir_all(&base);
    }

    #[test]
    fn list_all_metrics_summary_fields_are_correct() {
        let base = temp_dir("list_fields");
        let sessions_dir = base.join("sessions");
        let sdir = sessions_dir.join("s1");
        fs::create_dir_all(&sdir).unwrap();

        let mut m = sample_metrics("s1", "gpt-4o");
        m.node_id = "node-42".to_string();
        m.created_at = "2026-06-15T10:00:00Z".to_string();
        m.total_chars = 5000;
        m.outcome = SessionOutcome::Completed;
        save_metrics(&m, &sdir).unwrap();

        let summaries = list_all_metrics(&base).unwrap();
        let s = &summaries[0];
        assert_eq!(s.session_id, "s1");
        assert_eq!(s.node_id, "node-42");
        assert_eq!(s.created_at, "2026-06-15T10:00:00Z");
        assert_eq!(s.model, "gpt-4o");
        assert_eq!(s.total_turns, 1);
        assert_eq!(s.total_chars, 5000);
        assert_eq!(s.outcome, SessionOutcome::Completed);

        let _ = fs::remove_dir_all(&base);
    }
}