tokf 0.2.33

Config-driven CLI tool that compresses command output before it reaches an LLM context
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

#![allow(clippy::unwrap_used, clippy::expect_used)]

use super::*;
use serial_test::serial;
use tempfile::TempDir;

fn temp_db() -> (TempDir, Connection) {
    let dir = TempDir::new().expect("tempdir");
    let path = dir.path().join("tracking.db");
    let conn = open_db(&path).expect("open_db");
    (dir, conn)
}

// --- db_path / open_db ---

/// Must run serially: mutates process-global path overrides.
#[test]
#[serial]
fn db_path_env_override() {
    let dir = TempDir::new().expect("tempdir");
    let custom = dir.path().join("custom.db");
    let _guard = crate::paths::DbPathGuard::set(custom.clone());
    let result = db_path();
    assert_eq!(result, Some(custom));
}

#[test]
#[serial]
fn db_path_tokf_home_override() {
    let dir = TempDir::new().expect("tempdir");
    let _guard = crate::paths::HomeGuard::set(dir.path());
    let result = db_path();
    assert_eq!(result, Some(dir.path().join("tracking.db")));
}

/// `TOKF_DB_PATH` must take priority over `TOKF_HOME`.
#[test]
#[serial]
fn db_path_tokf_db_path_wins_over_tokf_home() {
    let dir = TempDir::new().expect("tempdir");
    let custom = dir.path().join("custom.db");
    let home_dir = TempDir::new().expect("tempdir");
    let _db_guard = crate::paths::DbPathGuard::set(custom.clone());
    let _home_guard = crate::paths::HomeGuard::set(home_dir.path());
    let result = db_path();
    assert_eq!(result, Some(custom));
}

#[test]
fn open_db_creates_dir_and_schema() {
    let dir = TempDir::new().expect("tempdir");
    let path = dir.path().join("sub").join("tracking.db");
    let conn = open_db(&path).expect("open_db");
    let count: i64 = conn
        .query_row("SELECT COUNT(*) FROM events", [], |r| r.get(0))
        .expect("query");
    assert_eq!(count, 0);
}

#[test]
fn open_db_idempotent() {
    let dir = TempDir::new().expect("tempdir");
    let path = dir.path().join("tracking.db");
    open_db(&path).expect("first open");
    open_db(&path).expect("second open — must not error");
}

// --- record_event ---

#[test]
fn record_event_inserts_row() {
    let (_dir, conn) = temp_db();
    let ev = build_event("echo hi", None, None, 100, 50, 100, 5, 0, false);
    record_event(&conn, &ev).expect("record");
    let count: i64 = conn
        .query_row("SELECT COUNT(*) FROM events", [], |r| r.get(0))
        .expect("count");
    assert_eq!(count, 1);
}

#[test]
fn record_event_all_fields_persisted() {
    let (_dir, conn) = temp_db();
    let ev = build_event(
        "git status",
        Some("git status"),
        None,
        400,
        200,
        400,
        10,
        0,
        false,
    );
    record_event(&conn, &ev).expect("record");
    let (cmd, fname, ib, ob, it, ot, ft, ec): (
        String,
        Option<String>,
        i64,
        i64,
        i64,
        i64,
        i64,
        i32,
    ) = conn
        .query_row(
            "SELECT command, filter_name, input_bytes, output_bytes,
                     input_tokens_est, output_tokens_est,
                     filter_time_ms, exit_code
              FROM events",
            [],
            |r| {
                Ok((
                    r.get(0)?,
                    r.get(1)?,
                    r.get(2)?,
                    r.get(3)?,
                    r.get(4)?,
                    r.get(5)?,
                    r.get(6)?,
                    r.get(7)?,
                ))
            },
        )
        .expect("select");
    assert_eq!(cmd, "git status");
    assert_eq!(fname.as_deref(), Some("git status"));
    assert_eq!(ib, 400);
    assert_eq!(ob, 200);
    assert_eq!(it, 100); // 400 / 4
    assert_eq!(ot, 50); // 200 / 4
    assert_eq!(ft, 10);
    assert_eq!(ec, 0);
}

/// C1+C2: verify `exit_code` and `filter_time_ms` are readable with non-zero values.
#[test]
fn record_event_exit_code_and_filter_time_persisted() {
    let (_dir, conn) = temp_db();
    // exit_code = 42 (non-zero), filter_time_ms = 99
    let ev = build_event(
        "cargo test",
        Some("cargo test"),
        None,
        800,
        200,
        800,
        99,
        42,
        false,
    );
    record_event(&conn, &ev).expect("record");
    let (ft, ec): (i64, i32) = conn
        .query_row("SELECT filter_time_ms, exit_code FROM events", [], |r| {
            Ok((r.get(0)?, r.get(1)?))
        })
        .expect("select");
    assert_eq!(ft, 99, "filter_time_ms not persisted correctly");
    assert_eq!(ec, 42, "exit_code not persisted correctly");
}

#[test]
fn record_event_timestamp_iso8601() {
    let (_dir, conn) = temp_db();
    let ev = build_event("cmd", None, None, 0, 0, 0, 0, 0, false);
    record_event(&conn, &ev).expect("record");
    let ts: String = conn
        .query_row("SELECT timestamp FROM events", [], |r| r.get(0))
        .expect("ts");
    assert!(ts.len() >= 10, "timestamp too short: {ts}");
    let date_part = &ts[..10];
    assert!(
        date_part.chars().nth(4) == Some('-') && date_part.chars().nth(7) == Some('-'),
        "bad ISO date: {ts}"
    );
}

// --- build_event ---

#[test]
fn build_event_token_estimation() {
    let ev = build_event("x", None, None, 400, 0, 400, 0, 0, false);
    assert_eq!(ev.input_tokens_est, 100);
    let ev2 = build_event("x", None, None, 399, 0, 399, 0, 0, false);
    assert_eq!(ev2.input_tokens_est, 99);
}

#[test]
fn build_event_passthrough_filter_name_none() {
    let ev = build_event("echo hi", None, None, 10, 10, 10, 0, 0, false);
    assert!(ev.filter_name.is_none());
}

// --- query_summary ---

#[test]
fn query_summary_empty_db() {
    let (_dir, conn) = temp_db();
    let s = query_summary(&conn).expect("summary");
    assert_eq!(s.total_commands, 0);
    assert_eq!(s.total_input_tokens, 0);
    assert_eq!(s.total_output_tokens, 0);
    assert_eq!(s.tokens_saved, 0);
    assert!(s.savings_pct.abs() < f64::EPSILON);
    assert_eq!(s.pipe_override_count, 0);
}

#[test]
fn query_summary_with_events() {
    let (_dir, conn) = temp_db();
    // input_tokens 100, output_tokens 25 → saved 75
    let ev = build_event("cmd", Some("f"), None, 400, 100, 400, 5, 0, false);
    record_event(&conn, &ev).expect("record");
    let s = query_summary(&conn).expect("summary");
    assert_eq!(s.total_commands, 1);
    assert_eq!(s.total_input_tokens, 100);
    assert_eq!(s.total_output_tokens, 25);
    assert_eq!(s.tokens_saved, 75);
    assert!((s.savings_pct - 75.0).abs() < 0.01);
}

#[test]
fn query_summary_zero_input_no_divide_by_zero() {
    let (_dir, conn) = temp_db();
    let ev = build_event("cmd", None, None, 0, 0, 0, 0, 0, false);
    record_event(&conn, &ev).expect("record");
    let s = query_summary(&conn).expect("summary");
    assert!(s.savings_pct.abs() < f64::EPSILON); // must not panic or NaN
}

/// C3: multiple events with diverse byte counts — verify correct accumulation.
#[test]
fn query_summary_accumulates_multiple_events() {
    let (_dir, conn) = temp_db();
    // ev1: 400 in → 100 tokens, 100 out → 25 tokens, saved 75
    // ev2: 800 in → 200 tokens, 400 out → 100 tokens, saved 100
    // ev3: 1200 in → 300 tokens,   0 out →  0 tokens, saved 300
    // totals: 3 commands, 600 input, 125 output, 475 saved ≈ 79.17%
    let events = [
        build_event("cmd1", Some("f1"), None, 400, 100, 400, 5, 0, false),
        build_event("cmd2", Some("f2"), None, 800, 400, 800, 10, 1, false),
        build_event("cmd3", None, None, 1200, 0, 1200, 0, 0, false),
    ];
    for ev in &events {
        record_event(&conn, ev).expect("record");
    }
    let s = query_summary(&conn).expect("summary");
    assert_eq!(s.total_commands, 3);
    assert_eq!(s.total_input_tokens, 600); // (400+800+1200)/4
    assert_eq!(s.total_output_tokens, 125); // (100+400+0)/4
    assert_eq!(s.tokens_saved, 475); // 600-125
    assert!((s.savings_pct - 79.166_666).abs() < 0.01);
}

// --- query_by_filter ---

#[test]
fn query_by_filter_groups_correctly() {
    let (_dir, conn) = temp_db();
    for fname in &["alpha", "beta", "gamma"] {
        let ev = build_event("cmd", Some(fname), None, 400, 100, 400, 0, 0, false);
        record_event(&conn, &ev).expect("record");
    }
    let rows = query_by_filter(&conn).expect("query");
    assert_eq!(rows.len(), 3);
    assert!(rows.iter().all(|r| r.commands == 1));
}

#[test]
fn query_by_filter_null_shown_as_passthrough() {
    let (_dir, conn) = temp_db();
    let ev = build_event("echo hi", None, None, 200, 200, 200, 0, 0, false);
    record_event(&conn, &ev).expect("record");
    let rows = query_by_filter(&conn).expect("query");
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].filter_name, "passthrough");
}

/// Verify that named-filter rows and passthrough (NULL) rows coexist correctly.
#[test]
fn query_by_filter_mixed_null_and_named() {
    let (_dir, conn) = temp_db();
    record_event(
        &conn,
        &build_event(
            "git status",
            Some("git status"),
            None,
            400,
            100,
            400,
            5,
            0,
            false,
        ),
    )
    .expect("record");
    record_event(
        &conn,
        &build_event("echo hi", None, None, 200, 200, 200, 0, 0, false),
    )
    .expect("record");
    let rows = query_by_filter(&conn).expect("query");
    assert_eq!(rows.len(), 2);
    let names: Vec<&str> = rows.iter().map(|r| r.filter_name.as_str()).collect();
    assert!(names.contains(&"git status"), "rows: {names:?}");
    assert!(names.contains(&"passthrough"), "rows: {names:?}");
}

/// Verify ordering: filter with greater token savings appears first.
#[test]
fn query_by_filter_ordered_by_savings_desc() {
    let (_dir, conn) = temp_db();
    // "small": 100 in → 25 tokens, 80 out → 20 tokens, saved 5
    // "big":   400 in → 100 tokens,  0 out →  0 tokens, saved 100
    record_event(
        &conn,
        &build_event("cmd", Some("small"), None, 100, 80, 100, 0, 0, false),
    )
    .expect("record");
    record_event(
        &conn,
        &build_event("cmd", Some("big"), None, 400, 0, 400, 0, 0, false),
    )
    .expect("record");
    let rows = query_by_filter(&conn).expect("query");
    assert_eq!(rows.len(), 2);
    assert_eq!(
        rows[0].filter_name, "big",
        "highest savings should be first"
    );
    assert_eq!(rows[1].filter_name, "small");
}

// --- query_daily ---

#[test]
fn query_daily_groups_by_date() {
    let (_dir, conn) = temp_db();
    for _ in 0..2 {
        let ev = build_event("cmd", None, None, 400, 100, 400, 0, 0, false);
        record_event(&conn, &ev).expect("record");
    }
    let rows = query_daily(&conn).expect("query");
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].commands, 2);
}