tkach 0.5.0

Provider-independent Rust agent runtime — streaming, reasoning summaries, prompt caching, and per-call approval gating.
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
//! HTTP-level coverage of the `OpenAICodex` provider.
//!
//! Uses `wiremock` to assert request headers, request body shape, and
//! parser behavior over a real SSE response. Covers what the unit
//! tests in `src/providers/openai_codex.rs` cannot: that the provider
//! actually sends the headers and body it claims to, and that the
//! shared SSE parser is wired in.

use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};

use futures::StreamExt;
use serde_json::{Value, json};
use tkach::ProviderError;
use tkach::message::{Message, StopReason};
use tkach::provider::{LlmProvider, Request, ToolDefinition};
use tkach::providers::{CodexCredentials, OpenAICodex};
use tkach::stream::StreamEvent;
use wiremock::matchers::{header, method, path};
use wiremock::{Mock, MockServer, Request as MockRequest, ResponseTemplate};

fn build_request() -> Request {
    Request {
        model: "gpt-5-codex".into(),
        system: None,
        messages: vec![Message::user_text("ping")],
        tools: vec![ToolDefinition {
            name: "bash".into(),
            description: "shell".into(),
            input_schema: json!({"type":"object"}),
            cache_control: None,
        }],
        max_tokens: 256,
        temperature: None,
        thinking: None,
    }
}

fn ok_sse(body: String) -> ResponseTemplate {
    ResponseTemplate::new(200)
        .insert_header("content-type", "text/event-stream")
        .set_body_string(body)
}

#[tokio::test]
async fn stream_sends_codex_headers_and_body_shape() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .and(header("authorization", "Bearer secret-token"))
        .and(header("chatgpt-account-id", "acct_42"))
        .and(header("OpenAI-Beta", "responses=experimental"))
        .and(header("originator", "tkach"))
        .and(header("accept", "text/event-stream"))
        .and(header("content-type", "application/json"))
        .respond_with(ok_sse(
            "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\",\"usage\":{\"input_tokens\":3,\"output_tokens\":5}}}\n\n"
                .into(),
        ))
        .expect(1)
        .mount(&server)
        .await;

    let provider =
        OpenAICodex::with_static_credentials(CodexCredentials::new("secret-token", "acct_42"))
            .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut saw_done = false;
    while let Some(event) = stream.next().await {
        if matches!(event.unwrap(), StreamEvent::Done) {
            saw_done = true;
        }
    }
    assert!(saw_done, "stream must end with Done");

    // Verify body shape on the captured request.
    let received = &server.received_requests().await.unwrap()[0];
    let body: Value = serde_json::from_slice(&received.body).unwrap();
    assert_eq!(body["model"], "gpt-5-codex");
    assert_eq!(body["store"], false);
    assert_eq!(body["stream"], true);
    assert_eq!(body["text"]["verbosity"], "low");
    assert_eq!(body["include"][0], "reasoning.encrypted_content");
    assert_eq!(
        body["reasoning"]["summary"], "auto",
        "include=encrypted_content alone does not enable summary events; reasoning.summary must be set"
    );
    assert!(body.get("max_output_tokens").is_none());
    assert_eq!(body["tools"][0]["name"], "bash");
}

#[tokio::test]
async fn reasoning_effort_and_summary_overrides_apply() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(
            "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\"}}\n\n"
                .into(),
        ))
        .expect(1)
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri())
        .with_reasoning_effort("high")
        .with_reasoning_summary("detailed");

    let mut stream = provider.stream(build_request()).await.expect("stream");
    while stream.next().await.is_some() {}

    let received = &server.received_requests().await.unwrap()[0];
    let body: Value = serde_json::from_slice(&received.body).unwrap();
    assert_eq!(body["reasoning"]["effort"], "high");
    assert_eq!(body["reasoning"]["summary"], "detailed");
}

#[tokio::test]
async fn without_reasoning_omits_field_but_keeps_include() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(
            "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\"}}\n\n"
                .into(),
        ))
        .expect(1)
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri())
        .without_reasoning();

    let mut stream = provider.stream(build_request()).await.expect("stream");
    while stream.next().await.is_some() {}

    let received = &server.received_requests().await.unwrap()[0];
    let body: Value = serde_json::from_slice(&received.body).unwrap();
    assert!(body.get("reasoning").is_none());
    assert_eq!(body["include"][0], "reasoning.encrypted_content");
}

#[tokio::test]
async fn originator_header_can_be_overridden() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .and(header("originator", "sunny"))
        .respond_with(ok_sse(
            "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\"}}\n\n"
                .into(),
        ))
        .expect(1)
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct_1"))
        .with_base_url(server.uri())
        .with_originator("sunny");

    let mut stream = provider.stream(build_request()).await.expect("stream");
    while stream.next().await.is_some() {}
}

#[tokio::test]
async fn credentials_provider_is_called_each_request() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(|_req: &MockRequest| {
            ok_sse(
                "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\"}}\n\n"
                    .into(),
            )
        })
        .mount(&server)
        .await;

    let counter = Arc::new(AtomicUsize::new(0));
    let counter_clone = Arc::clone(&counter);

    let provider = OpenAICodex::new(move || {
        let counter = Arc::clone(&counter_clone);
        async move {
            let n = counter.fetch_add(1, Ordering::SeqCst);
            Ok(CodexCredentials::new(format!("token-{n}"), "acct"))
        }
    })
    .with_base_url(server.uri());

    for _ in 0..3 {
        let mut stream = provider.stream(build_request()).await.expect("stream");
        while stream.next().await.is_some() {}
    }
    assert_eq!(counter.load(Ordering::SeqCst), 3);
}

#[tokio::test]
async fn streaming_text_and_tool_calls_are_emitted() {
    let server = MockServer::start().await;

    let sse = String::new()
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"hello \"}\n\n"
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"world\"}\n\n"
        + "data: {\"type\":\"response.output_item.added\",\"output_index\":0,\"item\":{\"id\":\"fc_1\",\"type\":\"function_call\",\"call_id\":\"call_1\",\"name\":\"bash\",\"arguments\":\"\"}}\n\n"
        + "data: {\"type\":\"response.function_call_arguments.delta\",\"item_id\":\"fc_1\",\"delta\":\"{\\\"command\\\":\\\"ls\\\"}\"}\n\n"
        + "data: {\"type\":\"response.function_call_arguments.done\",\"item_id\":\"fc_1\",\"name\":\"bash\",\"arguments\":\"{\\\"command\\\":\\\"ls\\\"}\"}\n\n"
        + "data: {\"type\":\"response.output_item.done\",\"output_index\":0,\"item\":{\"id\":\"fc_1\",\"type\":\"function_call\",\"call_id\":\"call_1\",\"name\":\"bash\",\"arguments\":\"{\\\"command\\\":\\\"ls\\\"}\"}}\n\n"
        + "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\",\"usage\":{\"input_tokens\":10,\"output_tokens\":4}}}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut text = String::new();
    let mut tool_calls = Vec::new();
    let mut stop = StopReason::EndTurn;
    let mut input_tokens = 0;

    while let Some(event) = stream.next().await {
        match event.unwrap() {
            StreamEvent::ContentDelta(delta) => text.push_str(&delta),
            StreamEvent::ToolUse { id, name, input } => tool_calls.push((id, name, input)),
            StreamEvent::MessageDelta { stop_reason } => stop = stop_reason,
            StreamEvent::Usage(u) => input_tokens = u.input_tokens,
            StreamEvent::Done => break,
            _ => {}
        }
    }

    assert_eq!(text, "hello world");
    assert_eq!(tool_calls.len(), 1);
    assert_eq!(tool_calls[0].0, "call_1|fc_1");
    assert_eq!(tool_calls[0].1, "bash");
    assert_eq!(tool_calls[0].2["command"], "ls");
    assert_eq!(stop, StopReason::ToolUse);
    assert_eq!(input_tokens, 10);
}

#[tokio::test]
async fn complete_collects_stream_into_response() {
    let server = MockServer::start().await;

    let sse = String::new()
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"answer\"}\n\n"
        + "data: {\"type\":\"response.completed\",\"response\":{\"status\":\"completed\",\"usage\":{\"input_tokens\":2,\"output_tokens\":1}}}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let response = provider.complete(build_request()).await.expect("complete");
    assert_eq!(response.stop_reason, StopReason::EndTurn);
    assert_eq!(response.usage.input_tokens, 2);
    assert_eq!(response.content.len(), 1);
    let text = match &response.content[0] {
        tkach::Content::Text { text, .. } => text.clone(),
        other => panic!("expected text content, got {other:?}"),
    };
    assert_eq!(text, "answer");
}

#[tokio::test]
async fn unauthorized_does_not_retry_internally() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ResponseTemplate::new(401).set_body_string("token expired"))
        .expect(1)
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("expired", "acct"))
        .with_base_url(server.uri());

    match provider.stream(build_request()).await {
        Ok(_) => panic!("must surface 401 before stream begins"),
        Err(ProviderError::Api {
            status, retryable, ..
        }) => {
            assert_eq!(status, 401);
            assert!(!retryable, "401 must be non-retryable");
        }
        Err(other) => panic!("expected ProviderError::Api, got {other:?}"),
    }
}

#[tokio::test]
async fn rate_limit_classification_uses_retry_after() {
    let server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(
            ResponseTemplate::new(429)
                .insert_header("retry-after", "7")
                .set_body_string("slow down"),
        )
        .expect(1)
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    match provider.stream(build_request()).await {
        Ok(_) => panic!("must 429 before stream begins"),
        Err(ProviderError::RateLimit { retry_after_ms }) => {
            assert_eq!(retry_after_ms, Some(7_000));
        }
        Err(other) => panic!("expected RateLimit, got {other:?}"),
    }
}

#[tokio::test]
async fn failed_response_event_surfaces_as_error() {
    let server = MockServer::start().await;

    let sse = String::new()
        + "data: {\"type\":\"response.failed\",\"response\":{\"error\":{\"message\":\"model timeout\"}}}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut saw_error = false;
    while let Some(event) = stream.next().await {
        if let Err(ProviderError::Api { message, .. }) = event {
            assert!(message.contains("model timeout"));
            saw_error = true;
        }
    }
    assert!(saw_error, "response.failed must surface as Err");
}

#[tokio::test]
async fn missing_terminal_event_surfaces_as_error() {
    // Backend cuts the connection cleanly mid-turn (no terminal event,
    // no transport error). The parser must surface this as Err rather
    // than synthesizing a successful empty Done — that would let
    // `complete()` return `EndTurn` with no content.
    let server = MockServer::start().await;

    let sse =
        String::new() + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"partial\"}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut saw_error = false;
    let mut saw_done = false;
    while let Some(event) = stream.next().await {
        match event {
            Err(ProviderError::Other(msg)) if msg.contains("terminal") => saw_error = true,
            Ok(StreamEvent::Done) => saw_done = true,
            _ => {}
        }
    }
    assert!(saw_error, "missing terminal must surface as Err");
    assert!(!saw_done, "must not emit Done when terminal is missing");
}

#[tokio::test]
async fn terminal_response_recovers_text_and_tool_calls() {
    // Defensive parse: backend finalizes the turn with output content
    // carried only in the terminal `response.completed` payload, with
    // no prior streaming deltas. The parser must reconstruct text and
    // tool_use rather than emitting Usage/Done over an empty body.
    let server = MockServer::start().await;

    let sse = "data: {\"type\":\"response.completed\",\"response\":{\
        \"status\":\"completed\",\
        \"output\":[\
            {\"id\":\"msg_1\",\"type\":\"message\",\"content\":[\
                {\"type\":\"output_text\",\"text\":\"final answer\"}\
            ]},\
            {\"id\":\"fc_1\",\"type\":\"function_call\",\
              \"call_id\":\"call_1\",\"name\":\"bash\",\
              \"arguments\":\"{\\\"command\\\":\\\"ls\\\"}\"}\
        ],\
        \"usage\":{\"input_tokens\":1,\"output_tokens\":1}\
    }}\n\n"
        .to_string();

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut text = String::new();
    let mut tool_calls = Vec::new();
    let mut stop = StopReason::EndTurn;

    while let Some(event) = stream.next().await {
        match event.unwrap() {
            StreamEvent::ContentDelta(delta) => text.push_str(&delta),
            StreamEvent::ToolUse { id, name, input } => tool_calls.push((id, name, input)),
            StreamEvent::MessageDelta { stop_reason } => stop = stop_reason,
            StreamEvent::Done => break,
            _ => {}
        }
    }

    assert_eq!(text, "final answer");
    assert_eq!(tool_calls.len(), 1);
    assert_eq!(tool_calls[0].0, "call_1|fc_1");
    assert_eq!(tool_calls[0].1, "bash");
    assert_eq!(tool_calls[0].2["command"], "ls");
    assert_eq!(stop, StopReason::ToolUse);
}

#[tokio::test]
async fn terminal_response_does_not_double_emit_already_streamed_content() {
    // When deltas have already streamed text, the recovery path must
    // not duplicate it from the terminal payload.
    let server = MockServer::start().await;

    let sse = String::new()
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"streamed \"}\n\n"
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"answer\"}\n\n"
        + "data: {\"type\":\"response.completed\",\"response\":{\
            \"status\":\"completed\",\
            \"output\":[{\"id\":\"msg_1\",\"type\":\"message\",\"content\":[\
                {\"type\":\"output_text\",\"text\":\"streamed answer\"}\
            ]}]\
        }}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut text = String::new();
    while let Some(event) = stream.next().await {
        if let Ok(StreamEvent::ContentDelta(delta)) = event {
            text.push_str(&delta);
        }
    }
    assert_eq!(
        text, "streamed answer",
        "recovery must not duplicate already-streamed text"
    );
}

#[tokio::test]
async fn incomplete_max_tokens_maps_stop_reason() {
    let server = MockServer::start().await;

    let sse = String::new()
        + "data: {\"type\":\"response.output_text.delta\",\"delta\":\"partial\"}\n\n"
        + "data: {\"type\":\"response.incomplete\",\"response\":{\"status\":\"incomplete\",\"incomplete_details\":{\"reason\":\"max_output_tokens\"}}}\n\n";

    Mock::given(method("POST"))
        .and(path("/codex/responses"))
        .respond_with(ok_sse(sse))
        .mount(&server)
        .await;

    let provider = OpenAICodex::with_static_credentials(CodexCredentials::new("t", "acct"))
        .with_base_url(server.uri());

    let mut stream = provider.stream(build_request()).await.expect("stream");
    let mut stop = StopReason::EndTurn;
    while let Some(event) = stream.next().await {
        if let Ok(StreamEvent::MessageDelta { stop_reason }) = event {
            stop = stop_reason;
        }
    }
    assert_eq!(stop, StopReason::MaxTokens);
}