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

use serde::{Deserialize, Serialize};

use super::http::Client;

#[derive(Debug, Deserialize, Serialize)]
pub struct MachineGain {
    pub machine_id: String,
    pub hostname: String,
    pub total_input_tokens: i64,
    pub total_output_tokens: i64,
    pub total_commands: i64,
    #[serde(default)]
    pub total_raw_tokens: i64,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct GlobalMachineGain {
    pub machine_id: String,
    pub total_input_tokens: i64,
    pub total_output_tokens: i64,
    pub total_commands: i64,
    #[serde(default)]
    pub total_raw_tokens: i64,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct FilterGainEntry {
    pub filter_name: Option<String>,
    pub filter_hash: Option<String>,
    pub total_input_tokens: i64,
    pub total_output_tokens: i64,
    pub total_commands: i64,
    #[serde(default)]
    pub total_raw_tokens: i64,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct GainResponse {
    pub total_input_tokens: i64,
    pub total_output_tokens: i64,
    pub total_commands: i64,
    #[serde(default)]
    pub total_raw_tokens: i64,
    pub by_machine: Vec<MachineGain>,
    pub by_filter: Vec<FilterGainEntry>,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct GlobalGainResponse {
    pub total_input_tokens: i64,
    pub total_output_tokens: i64,
    pub total_commands: i64,
    #[serde(default)]
    pub total_raw_tokens: i64,
    pub by_machine: Vec<GlobalMachineGain>,
    pub by_filter: Vec<FilterGainEntry>,
}

/// Fetch the authenticated user's own token savings from the remote server.
///
/// # Errors
///
/// Returns an error if the server is unreachable, returns a non-success
/// status, or the response body cannot be deserialized.
pub fn get_gain(client: &Client) -> anyhow::Result<GainResponse> {
    client.get("/api/gain")
}

/// Fetch global (all-users) token savings from the remote server (public, no auth).
///
/// # Errors
///
/// Returns an error if the server is unreachable, returns a non-success
/// status, or the response body cannot be deserialized.
pub fn get_global_gain(client: &Client) -> anyhow::Result<GlobalGainResponse> {
    client.get("/api/gain/global")
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;

    #[test]
    fn deserialize_gain_response() {
        let json = r#"{
            "total_input_tokens": 50000,
            "total_output_tokens": 10000,
            "total_commands": 100,
            "by_machine": [{
                "machine_id": "abc-123",
                "hostname": "dev-laptop",
                "total_input_tokens": 50000,
                "total_output_tokens": 10000,
                "total_commands": 100
            }],
            "by_filter": [{
                "filter_name": "git/push",
                "filter_hash": "abc123",
                "total_input_tokens": 30000,
                "total_output_tokens": 5000,
                "total_commands": 60
            }]
        }"#;
        let resp: GainResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.total_input_tokens, 50000);
        assert_eq!(resp.total_output_tokens, 10000);
        assert_eq!(resp.total_commands, 100);
        assert_eq!(resp.by_machine.len(), 1);
        assert_eq!(resp.by_machine[0].hostname, "dev-laptop");
        assert_eq!(resp.by_filter.len(), 1);
        assert_eq!(resp.by_filter[0].filter_name.as_deref(), Some("git/push"));
    }

    #[test]
    fn deserialize_gain_response_empty() {
        let json = r#"{
            "total_input_tokens": 0,
            "total_output_tokens": 0,
            "total_commands": 0,
            "by_machine": [],
            "by_filter": []
        }"#;
        let resp: GainResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.total_commands, 0);
        assert!(resp.by_machine.is_empty());
        assert!(resp.by_filter.is_empty());
    }

    #[test]
    fn deserialize_global_gain_response() {
        let json = r#"{
            "total_input_tokens": 100000,
            "total_output_tokens": 20000,
            "total_commands": 500,
            "by_machine": [{
                "machine_id": "xyz-789",
                "total_input_tokens": 100000,
                "total_output_tokens": 20000,
                "total_commands": 500
            }],
            "by_filter": [{
                "filter_name": null,
                "filter_hash": null,
                "total_input_tokens": 5000,
                "total_output_tokens": 5000,
                "total_commands": 10
            }]
        }"#;
        let resp: GlobalGainResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.total_input_tokens, 100_000);
        assert_eq!(resp.by_machine.len(), 1);
        // Global response should not have hostname field
        assert_eq!(resp.by_machine[0].machine_id, "xyz-789");
        assert_eq!(resp.by_filter.len(), 1);
        assert!(resp.by_filter[0].filter_name.is_none());
    }

    #[test]
    fn gain_response_roundtrip_json() {
        let resp = GainResponse {
            total_input_tokens: 1000,
            total_output_tokens: 200,
            total_commands: 5,
            total_raw_tokens: 1500,
            by_machine: vec![MachineGain {
                machine_id: "m1".to_string(),
                hostname: "host".to_string(),
                total_input_tokens: 1000,
                total_output_tokens: 200,
                total_commands: 5,
                total_raw_tokens: 1500,
            }],
            by_filter: vec![FilterGainEntry {
                filter_name: Some("git/status".to_string()),
                filter_hash: Some("h".repeat(64)),
                total_input_tokens: 1000,
                total_output_tokens: 200,
                total_commands: 5,
                total_raw_tokens: 1500,
            }],
        };
        let json = serde_json::to_string(&resp).unwrap();
        let back: GainResponse = serde_json::from_str(&json).unwrap();
        assert_eq!(back.total_input_tokens, 1000);
        assert_eq!(back.total_raw_tokens, 1500);
        assert_eq!(back.by_machine[0].hostname, "host");
        assert_eq!(back.by_machine[0].total_raw_tokens, 1500);
        assert_eq!(back.by_filter[0].total_raw_tokens, 1500);
    }

    /// Backward compatibility: missing `total_raw_tokens` defaults to 0.
    #[test]
    fn gain_response_backward_compat_missing_raw_tokens() {
        let json = r#"{
            "total_input_tokens": 5000,
            "total_output_tokens": 1000,
            "total_commands": 10,
            "by_machine": [],
            "by_filter": []
        }"#;
        let resp: GainResponse = serde_json::from_str(json).unwrap();
        assert_eq!(resp.total_raw_tokens, 0);
    }

    #[test]
    fn filter_gain_entry_null_fields() {
        let json = r#"{
            "filter_name": null,
            "filter_hash": null,
            "total_input_tokens": 100,
            "total_output_tokens": 50,
            "total_commands": 2
        }"#;
        let entry: FilterGainEntry = serde_json::from_str(json).unwrap();
        assert!(entry.filter_name.is_none());
        assert!(entry.filter_hash.is_none());
        assert_eq!(entry.total_input_tokens, 100);
    }
}