openkind-client 0.4.0

Async Rust client for the openkind / TypeSafe Jev SystemOne HTTP API.
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
//! Retry, backoff, and rate-limit mechanics against a deterministic stub
//! server. The stub mirrors the openkind server's error contract exactly
//! (`{"error":{"code","message"}}` envelope, `retry-after-ms` +
//! `Retry-After` headers on 429/529), so timing-sensitive behavior can be
//! tested without real rate-limit windows.

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

use axum::body::Body;
use axum::extract::State;
use axum::http::{Request as HttpRequest, StatusCode};
use axum::response::{IntoResponse, Response};
use axum::routing::post;
use axum::{Json, Router};
use openkind_client::{Client, Error, RequestOptions, RetryPolicy};
use serde_json::{json, Value};
use tokio::io::{AsyncReadExt, AsyncWriteExt};

fn valid_response() -> Value {
    json!({
        "model": "mock",
        "usage": {"input_tokens": 3, "output_tokens": 4},
        "answers": {"q": {"type": "noul", "noul": 0.75}}
    })
}

fn error_envelope(code: &str, message: &str) -> Value {
    json!({"error": {"code": code, "message": message}})
}

#[derive(Clone)]
struct StubState {
    attempts: Arc<AtomicUsize>,
    /// Captured `x-typesafe-retry-count` header of every request received.
    retry_headers: Arc<Mutex<Vec<Option<String>>>>,
    /// How many leading requests fail (with `fail_status`) before 200.
    failures_before_success: usize,
    fail_status: u16,
    /// `retry-after-ms` value sent with failures (0 = omit).
    retry_after_ms: u64,
}

async fn stub_handler(State(state): State<StubState>) -> Response {
    let attempt = state.attempts.fetch_add(1, Ordering::SeqCst);
    if attempt < state.failures_before_success {
        let mut response = (
            StatusCode::from_u16(state.fail_status).unwrap(),
            Json(error_envelope(
                if state.fail_status == 429 {
                    "rate_limited"
                } else if state.fail_status == 529 {
                    "overloaded"
                } else {
                    "internal_error"
                },
                "stub failure",
            )),
        )
            .into_response();
        if state.retry_after_ms > 0 {
            let ms = state.retry_after_ms.to_string();
            let secs = state.retry_after_ms.div_ceil(1000).to_string();
            response
                .headers_mut()
                .insert("retry-after-ms", ms.parse().unwrap());
            response
                .headers_mut()
                .insert("retry-after", secs.parse().unwrap());
        }
        response
    } else {
        Json(valid_response()).into_response()
    }
}

async fn capture_middleware(
    state: State<StubState>,
    request: HttpRequest<Body>,
    next: axum::middleware::Next,
) -> Response {
    let retry_header = request
        .headers()
        .get("x-typesafe-retry-count")
        .and_then(|v| v.to_str().ok())
        .map(str::to_owned);
    state.retry_headers.lock().unwrap().push(retry_header);
    next.run(request).await
}

async fn spawn_stub(state: StubState) -> String {
    let app = Router::new()
        .route("/v1/systemone", post(stub_handler))
        .layer(axum::middleware::from_fn_with_state(
            state.clone(),
            capture_middleware,
        ))
        .with_state(state);
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });
    format!("http://{addr}")
}

fn stub_state(failures: usize, status: u16, retry_after_ms: u64) -> StubState {
    StubState {
        attempts: Arc::new(AtomicUsize::new(0)),
        retry_headers: Arc::new(Mutex::new(Vec::new())),
        failures_before_success: failures,
        fail_status: status,
        retry_after_ms,
    }
}

fn fast_client(base_url: &str, policy: RetryPolicy) -> Client {
    Client::builder()
        .api_key("test-key")
        .base_url(base_url)
        .default_model("mock")
        .timeout(Duration::from_secs(5))
        .retry(policy)
        .build()
        .unwrap()
}

fn evaluate_request() -> openkind_client::SystemRequest {
    openkind_client::SystemRequest {
        state: openkind_client::State::Text("hello".into()),
        model: "mock".into(),
        questions: std::collections::HashMap::from_iter([(
            "q".to_string(),
            openkind_client::question::noul("Is this billing?"),
        )]),
    }
}

async fn spawn_oversized_chunked_response(status: u16) -> String {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let mut request = [0_u8; 4096];
        let _ = stream.read(&mut request).await;
        let reason = if status == 200 { "OK" } else { "Bad Request" };
        stream
            .write_all(
                format!(
                    "HTTP/1.1 {status} {reason}\r\nContent-Type: application/json\r\nTransfer-Encoding: chunked\r\n\r\n"
                )
                .as_bytes(),
            )
            .await
            .unwrap();

        let chunk = vec![b'x'; 64 * 1024];
        for _ in 0..=(openkind_client::MAX_RESPONSE_BODY_SIZE / chunk.len()) {
            if stream
                .write_all(format!("{:x}\r\n", chunk.len()).as_bytes())
                .await
                .is_err()
                || stream.write_all(&chunk).await.is_err()
                || stream.write_all(b"\r\n").await.is_err()
            {
                break;
            }
        }
        let _ = stream.write_all(b"0\r\n\r\n").await;
    });
    format!("http://{addr}")
}

#[tokio::test]
async fn rejects_oversized_chunked_success_response() {
    let url = spawn_oversized_chunked_response(200).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(0));

    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(matches!(
        err,
        Error::ResponseTooLarge {
            limit: openkind_client::MAX_RESPONSE_BODY_SIZE
        }
    ));
}

#[tokio::test]
async fn rejects_oversized_chunked_error_response_without_retrying() {
    let url = spawn_oversized_chunked_response(400).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(3));

    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(matches!(err, Error::ResponseTooLarge { .. }));
}

#[tokio::test]
async fn chunk_size_line_can_span_socket_reads() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let base_url = format!("http://{}", listener.local_addr().unwrap());
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let mut request = [0_u8; 4096];
        let received = stream.read(&mut request).await.unwrap();
        assert!(received > 0);
        let body = b"{\"status\":\"ok\"}";
        stream
            .write_all(
                format!(
                    "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nTransfer-Encoding: chunked\r\n\r\n{:x}\r",
                    body.len()
                )
                .as_bytes(),
            )
            .await
            .unwrap();
        // Force the size line's CRLF to cross reads.
        tokio::time::sleep(Duration::from_millis(5)).await;
        stream.write_all(b"\n").await.unwrap();
        stream.write_all(body).await.unwrap();
        stream.write_all(b"\r\n0\r\n\r\n").await.unwrap();
    });

    let client = fast_client(&base_url, RetryPolicy::new().max_retries(0));
    assert_eq!(client.health().await.unwrap().status, "ok");
    server.await.unwrap();
}

#[tokio::test]
async fn retries_429_until_success_and_sends_retry_count_header() {
    let state = stub_state(2, 429, 1);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(5).backoff_jitter(0.0));

    let response = client.evaluate(evaluate_request()).await.unwrap();
    assert_eq!(response.answers.len(), 1);
    assert_eq!(
        state.attempts.load(Ordering::SeqCst),
        3,
        "1 initial + 2 retries"
    );

    let headers = state.retry_headers.lock().unwrap();
    assert_eq!(headers[0], None, "initial attempt has no retry header");
    assert_eq!(headers[1].as_deref(), Some("1"));
    assert_eq!(headers[2].as_deref(), Some("2"));
}

#[tokio::test]
async fn exhausted_429_retries_surface_rate_limit_error() {
    let state = stub_state(usize::MAX, 429, 25);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(2).backoff_jitter(0.0));

    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert_eq!(err.status(), Some(429));
    assert_eq!(err.retry_after(), Some(Duration::from_millis(25)));
    assert_eq!(
        state.attempts.load(Ordering::SeqCst),
        3,
        "1 initial + 2 retries"
    );
}

#[tokio::test]
async fn overloaded_529_is_retried_and_then_succeeds() {
    let state = stub_state(1, 529, 1);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(3));

    let response = client.evaluate(evaluate_request()).await.unwrap();
    assert_eq!(state.attempts.load(Ordering::SeqCst), 2);
    assert_eq!(response.usage.output_tokens, 4);
}

#[tokio::test]
async fn overloaded_529_without_retries_is_overloaded_kind() {
    let state = stub_state(usize::MAX, 529, 100);
    let url = spawn_stub(state).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(0));

    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert_eq!(err.kind(), Some(openkind_client::ApiErrorKind::Overloaded));
    assert_eq!(err.retry_after(), Some(Duration::from_millis(100)));
}

#[tokio::test]
async fn server_error_500_is_retried() {
    let state = stub_state(1, 500, 0);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(2).backoff_jitter(0.0));

    client.evaluate(evaluate_request()).await.unwrap();
    assert_eq!(state.attempts.load(Ordering::SeqCst), 2);
}

#[tokio::test]
async fn client_errors_are_never_retried() {
    for status in [400, 401, 404, 422] {
        let state = stub_state(usize::MAX, status, 0);
        let url = spawn_stub(state.clone()).await;
        let client = fast_client(&url, RetryPolicy::new().max_retries(5));
        let err = client.evaluate(evaluate_request()).await.unwrap_err();
        assert_eq!(err.status(), Some(status));
        assert_eq!(
            state.attempts.load(Ordering::SeqCst),
            1,
            "status {status} must not be retried"
        );
    }
}

#[tokio::test]
async fn retry_after_header_wins_over_long_backoff() {
    // Backoff would be 10s; the server asks for 5ms. Must finish fast.
    let state = stub_state(1, 429, 5);
    let url = spawn_stub(state).await;
    let client = fast_client(
        &url,
        RetryPolicy::new()
            .max_retries(3)
            .backoff_initial(Duration::from_secs(10)),
    );

    let start = std::time::Instant::now();
    client.evaluate(evaluate_request()).await.unwrap();
    assert!(
        start.elapsed() < Duration::from_secs(5),
        "retry-after must override 10s backoff, took {:?}",
        start.elapsed()
    );
}

#[tokio::test]
async fn total_timeout_budget_stops_retrying() {
    // Every attempt 429s with a 200ms wait; budget is 100ms so at most a
    // couple of attempts happen and the last error surfaces quickly.
    let state = stub_state(usize::MAX, 429, 200);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(
        &url,
        RetryPolicy::new()
            .max_retries(100)
            .backoff_initial(Duration::from_millis(1))
            .backoff_jitter(0.0)
            .total_timeout(Some(Duration::from_millis(100))),
    );

    let start = std::time::Instant::now();
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert_eq!(err.status(), Some(429));
    assert!(
        start.elapsed() < Duration::from_secs(3),
        "budget must stop runaway retries, took {:?}",
        start.elapsed()
    );
    let attempts = state.attempts.load(Ordering::SeqCst);
    assert!(attempts <= 4, "budget should cap attempts, got {attempts}");
}

#[tokio::test]
async fn connection_error_is_classified_and_retried() {
    // Bind, learn the port, then drop the listener: connects are refused.
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    drop(listener);

    let client = fast_client(
        &format!("http://{addr}"),
        RetryPolicy::new()
            .max_retries(1)
            .backoff_initial(Duration::from_millis(1))
            .backoff_jitter(0.0),
    );
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(
        matches!(err, Error::Connection(_)),
        "expected Connection error, got {err:?}"
    );
}

#[tokio::test]
async fn garbage_2xx_body_is_decode_error() {
    let app = Router::new().route("/v1/systemone", post(|| async { "this is not json" }));
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    let client = fast_client(&format!("http://{addr}"), RetryPolicy::new().max_retries(0));
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    match &err {
        Error::Decode { status, .. } => assert_eq!(*status, 200),
        other => panic!("expected Decode error, got {other:?}"),
    }
    // `Error::status` only reports server-rejection statuses; decode failures
    // are transport-local.
    assert_eq!(err.status(), None);
}

#[tokio::test]
async fn per_call_options_override_client_policy() {
    // Client policy is aggressive; the call disables retries entirely.
    let state = stub_state(1, 500, 0);
    let url = spawn_stub(state.clone()).await;
    let client = fast_client(&url, RetryPolicy::new().max_retries(10));

    let err = client
        .evaluate_with(
            evaluate_request(),
            &RequestOptions::new().retry(RetryPolicy::new().max_retries(0)),
        )
        .await
        .unwrap_err();
    assert_eq!(err.status(), Some(500));
    assert_eq!(state.attempts.load(Ordering::SeqCst), 1);
}

// ------------------------------------------------------------------
// reqwest-path transport: the production `https://` path. These tests
// force the reqwest transport so its classification and body limits are
// exercised, not the fast HTTP/1.1 pool that plain-http test URLs take.
// ------------------------------------------------------------------

fn reqwest_client(base_url: &str, policy: RetryPolicy) -> Client {
    Client::builder()
        .api_key("test-key")
        .base_url(base_url)
        .default_model("mock")
        .timeout(Duration::from_secs(5))
        .retry(policy)
        .http_client(reqwest::Client::new())
        .build()
        .unwrap()
}

#[tokio::test]
async fn reqwest_transport_classifies_timeouts_and_connection_failures() {
    // A stalled server that accepts the connection but never responds
    // drives the timeout classification.
    let stalled = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let stalled_addr = stalled.local_addr().unwrap();
    tokio::spawn(async move {
        // Accept and hold the socket open without ever replying.
        let (_stream, _) = stalled.accept().await.unwrap();
        tokio::time::sleep(Duration::from_secs(30)).await;
    });

    let client = Client::builder()
        .api_key("test-key")
        .base_url(format!("http://{stalled_addr}"))
        .default_model("mock")
        .timeout(Duration::from_millis(200))
        .retry(RetryPolicy::new().max_retries(0))
        .http_client(reqwest::Client::new())
        .build()
        .unwrap();
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(
        matches!(err, Error::Timeout { .. }),
        "expected Timeout from the reqwest path, got {err:?}"
    );

    // A refused connection classifies as Connection.
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let refused_addr = listener.local_addr().unwrap();
    drop(listener);
    let client = reqwest_client(
        &format!("http://{refused_addr}"),
        RetryPolicy::new().max_retries(0),
    );
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(
        matches!(err, Error::Connection(_)),
        "expected Connection from the reqwest path, got {err:?}"
    );
}

#[tokio::test]
async fn reqwest_transport_enforces_the_response_body_limit() {
    // Raw server: a declared content-length beyond the 8 MiB cap with no
    // body needed — the pre-check rejects before reading.
    let oversized = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = oversized.local_addr().unwrap();
    tokio::spawn(async move {
        let (mut stream, _) = oversized.accept().await.unwrap();
        let mut request = [0_u8; 4096];
        let _ = tokio::io::AsyncReadExt::read(&mut stream, &mut request).await;
        let head =
            "HTTP/1.1 200 OK\r\ncontent-type: application/json\r\ncontent-length: 9000000\r\n\r\n";
        use tokio::io::AsyncWriteExt;
        let _ = stream.write_all(head.as_bytes()).await;
        tokio::time::sleep(Duration::from_secs(30)).await;
    });

    let client = reqwest_client(&format!("http://{addr}"), RetryPolicy::new().max_retries(0));
    let err = client.evaluate(evaluate_request()).await.unwrap_err();
    assert!(
        matches!(err, Error::ResponseTooLarge { .. }),
        "expected ResponseTooLarge from the reqwest path, got {err:?}"
    );
}