openrouter-rs 0.14.0

A type-safe OpenRouter Rust SDK
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
use std::{
    io::{Read, Write},
    net::TcpListener,
    sync::mpsc,
    thread,
    time::Duration,
};

use futures_util::StreamExt;
use openrouter_rs::{
    api::chat::{
        ChatCompletionRequestBuilder, Message, send_chat_completion, stream_chat_completion,
    },
    types::{OpenRouterExperimentalMetadata, Role, ServerTool, completion::CompletionsResponse},
};

struct CapturedRequest {
    request_line: String,
    header_text: String,
    body_text: String,
}

fn spawn_server(
    response_body: &str,
    content_type: &str,
) -> (
    String,
    mpsc::Receiver<CapturedRequest>,
    thread::JoinHandle<()>,
) {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener should bind");
    let addr = listener
        .local_addr()
        .expect("listener should have local addr");
    let body = response_body.to_string();
    let content_type = content_type.to_string();
    let (tx, rx) = mpsc::channel::<CapturedRequest>();

    let server = thread::spawn(move || {
        let (mut stream, _) = listener
            .accept()
            .expect("server should accept one connection");
        let mut request_bytes = Vec::new();
        let mut chunk = [0_u8; 1024];
        let header_end = loop {
            let read = stream.read(&mut chunk).expect("server should read request");
            if read == 0 {
                break None;
            }
            request_bytes.extend_from_slice(&chunk[..read]);
            if let Some(pos) = request_bytes
                .windows(4)
                .position(|window| window == b"\r\n\r\n")
            {
                break Some(pos + 4);
            }
        }
        .expect("request should contain header terminator");

        let header_text = String::from_utf8_lossy(&request_bytes[..header_end]).to_string();
        let request_line = header_text.lines().next().unwrap_or_default().to_string();
        let content_length = header_text
            .lines()
            .find_map(|line| {
                let lower = line.to_ascii_lowercase();
                if lower.starts_with("content-length:") {
                    line.split(':').nth(1)?.trim().parse::<usize>().ok()
                } else {
                    None
                }
            })
            .unwrap_or(0);

        let mut body_bytes = request_bytes[header_end..].to_vec();
        while body_bytes.len() < content_length {
            let read = stream
                .read(&mut chunk)
                .expect("server should read request body");
            if read == 0 {
                break;
            }
            body_bytes.extend_from_slice(&chunk[..read]);
        }
        let body_text = String::from_utf8_lossy(&body_bytes[..content_length]).to_string();
        tx.send(CapturedRequest {
            request_line,
            header_text,
            body_text,
        })
        .expect("server should send request");

        let response = format!(
            "HTTP/1.1 200 OK\r\nContent-Type: {}\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{}",
            content_type,
            body.len(),
            body
        );
        stream
            .write_all(response.as_bytes())
            .expect("server should write response");
    });

    (format!("http://{addr}/api/v1"), rx, server)
}

#[tokio::test]
async fn test_send_chat_completion_sets_stream_false_and_headers() {
    let (base_url, rx, server) = spawn_server(
        r#"{"id":"gen-123","choices":[{"message":{"role":"assistant","content":"Hello from mock"}}],"created":1700000000,"model":"test-model","object":"chat.completion"}"#,
        "application/json",
    );

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "hello")])
        .experimental_metadata(OpenRouterExperimentalMetadata::Enabled)
        .build()
        .expect("chat request should build");
    let x_title = Some("openrouter-rs-tests".to_string());
    let http_referer = Some("https://github.com/realmorrisliu/openrouter-rs".to_string());
    let app_categories = Some(vec!["cli-agent".to_string()]);

    let response = send_chat_completion(
        &base_url,
        "api-key",
        &x_title,
        &http_referer,
        &app_categories,
        &request,
    )
    .await
    .expect("send_chat_completion should succeed");
    assert_eq!(response.id, "gen-123");
    assert_eq!(response.choices[0].content(), Some("Hello from mock"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(
        captured.request_line,
        "POST /api/v1/chat/completions HTTP/1.1"
    );

    let headers_lower = captured.header_text.to_ascii_lowercase();
    assert!(
        headers_lower.contains("authorization: bearer api-key")
            || headers_lower.contains("authorization:bearer api-key"),
        "authorization header should include API key, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-openrouter-title: openrouter-rs-tests")
            || headers_lower.contains("x-openrouter-title:openrouter-rs-tests"),
        "x-openrouter-title header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-title: openrouter-rs-tests")
            || headers_lower.contains("x-title:openrouter-rs-tests"),
        "x-title header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("http-referer: https://github.com/realmorrisliu/openrouter-rs")
            || headers_lower
                .contains("http-referer:https://github.com/realmorrisliu/openrouter-rs"),
        "http-referer header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-openrouter-categories: cli-agent")
            || headers_lower.contains("x-openrouter-categories:cli-agent"),
        "x-openrouter-categories header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-openrouter-metadata: enabled")
            || headers_lower.contains("x-openrouter-metadata:enabled"),
        "experimental metadata header should be present, headers:\n{}",
        captured.header_text
    );

    let request_json: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid JSON");
    assert_eq!(request_json["stream"], false);
    assert_eq!(request_json["model"], "openai/gpt-4o-mini");
    assert!(request_json.get("experimental_metadata").is_none());

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_send_chat_completion_sets_files_tool_header() {
    let (base_url, rx, server) = spawn_server(
        r#"{"id":"gen-files","choices":[{"message":{"role":"assistant","content":"ok"}}],"created":1700000000,"model":"test-model","object":"chat.completion"}"#,
        "application/json",
    );

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "inspect uploaded files")])
        .server_tool(ServerTool::files())
        .build()
        .expect("chat request should build");

    send_chat_completion(&base_url, "api-key", &None, &None, &None, &request)
        .await
        .expect("send_chat_completion should succeed");

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    let headers_lower = captured.header_text.to_ascii_lowercase();
    assert!(
        headers_lower.contains("x-openrouter-file-ids: openrouter")
            || headers_lower.contains("x-openrouter-file-ids:openrouter"),
        "files tool header should be present, headers:\n{}",
        captured.header_text
    );

    let request_json: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid JSON");
    assert_eq!(request_json["tools"][0]["type"], "openrouter:files");

    server.join().expect("server thread should finish");
}

#[test]
fn test_chat_completion_response_deserializes_openrouter_metadata_and_service_tier() {
    let raw = r#"{
        "id": "gen-123",
        "choices": [{
            "message": {
                "role": "assistant",
                "content": "Hello"
            }
        }],
        "created": 1700000000,
        "model": "openai/gpt-4o-mini",
        "object": "chat.completion",
        "service_tier": "priority",
        "openrouter_metadata": {
            "attempt": 1,
            "is_byok": false,
            "summary": "available=1, selected=OpenAI"
        }
    }"#;

    let parsed: CompletionsResponse =
        serde_json::from_str(raw).expect("chat completion response should deserialize");

    assert_eq!(parsed.service_tier.as_deref(), Some("priority"));
    assert_eq!(
        parsed
            .openrouter_metadata
            .as_ref()
            .and_then(|metadata| metadata.get("attempt"))
            .and_then(|value| value.as_i64()),
        Some(1)
    );
}

#[tokio::test]
async fn test_stream_chat_completion_sets_stream_true_and_parses_sse() {
    let (base_url, rx, server) = spawn_server(
        concat!(
            "data: {\"id\":\"gen-stream-001\",\"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"Hello\"},\"index\":0}],\"created\":1700000000,\"model\":\"test-model\",\"object\":\"chat.completion.chunk\"}\r\n",
            "\r\n",
            "data: [DONE]\r\n",
            "\r\n"
        ),
        "text/event-stream",
    );

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "hello")])
        .build()
        .expect("chat request should build");

    let x_title = Some("openrouter-rs-tests".to_string());
    let http_referer = Some("https://github.com/realmorrisliu/openrouter-rs".to_string());
    let app_categories = Some(vec!["cli-agent".to_string()]);

    let mut stream = stream_chat_completion(
        &base_url,
        "api-key",
        &x_title,
        &http_referer,
        &app_categories,
        &request,
    )
    .await
    .expect("stream_chat_completion should succeed");
    let mut chunks = Vec::new();
    while let Some(item) = stream.next().await {
        chunks.push(item.expect("stream chunk should parse"));
    }
    assert_eq!(chunks.len(), 1);
    assert_eq!(chunks[0].id, "gen-stream-001");
    assert_eq!(chunks[0].choices[0].content(), Some("Hello"));

    let captured = rx
        .recv_timeout(Duration::from_secs(2))
        .expect("should capture request");
    assert_eq!(
        captured.request_line,
        "POST /api/v1/chat/completions HTTP/1.1"
    );

    let headers_lower = captured.header_text.to_ascii_lowercase();
    assert!(
        headers_lower.contains("authorization: bearer api-key")
            || headers_lower.contains("authorization:bearer api-key"),
        "authorization header should include API key, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-openrouter-title: openrouter-rs-tests")
            || headers_lower.contains("x-openrouter-title:openrouter-rs-tests"),
        "x-openrouter-title header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("x-title: openrouter-rs-tests")
            || headers_lower.contains("x-title:openrouter-rs-tests"),
        "x-title header should be present, headers:\n{}",
        captured.header_text
    );
    assert!(
        headers_lower.contains("http-referer: https://github.com/realmorrisliu/openrouter-rs")
            || headers_lower
                .contains("http-referer:https://github.com/realmorrisliu/openrouter-rs"),
        "http-referer header should be present, headers:\n{}",
        captured.header_text
    );

    let request_json: serde_json::Value =
        serde_json::from_str(&captured.body_text).expect("request body should be valid JSON");
    assert_eq!(request_json["stream"], true);

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_stream_chat_completion_parses_multiline_sse_data_frames() {
    let (base_url, _rx, server) = spawn_server(
        concat!(
            ": keep-alive\r\n",
            "event: message\r\n",
            "data: {\r\n",
            "data:   \"id\":\"gen-stream-002\",\r\n",
            "data:   \"choices\":[{\"delta\":{\"role\":\"assistant\",\"content\":\"Hello again\"},\"index\":0}],\r\n",
            "data:   \"created\":1700000001,\r\n",
            "data:   \"model\":\"test-model\",\r\n",
            "data:   \"object\":\"chat.completion.chunk\"\r\n",
            "data: }\r\n",
            "\r\n",
            "data: [DONE]\r\n",
            "\r\n"
        ),
        "text/event-stream",
    );

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "hello")])
        .build()
        .expect("chat request should build");

    let mut stream = stream_chat_completion(&base_url, "api-key", &None, &None, &None, &request)
        .await
        .expect("stream_chat_completion should succeed");
    let mut chunks = Vec::new();
    while let Some(item) = stream.next().await {
        chunks.push(item.expect("stream chunk should parse"));
    }

    assert_eq!(chunks.len(), 1);
    assert_eq!(chunks[0].id, "gen-stream-002");
    assert_eq!(chunks[0].choices[0].content(), Some("Hello again"));

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_send_chat_completion_returns_contextual_parse_error_on_invalid_json() {
    let (base_url, _rx, server) = spawn_server("{\"id\":\"broken\"", "application/json");

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "hello")])
        .build()
        .expect("chat request should build");

    let error = send_chat_completion(&base_url, "api-key", &None, &None, &None, &request)
        .await
        .expect_err("invalid JSON should fail");

    match error {
        openrouter_rs::error::OpenRouterError::Unknown(message) => {
            assert!(message.contains("Failed to deserialize chat completion response"));
            assert!(message.contains("body preview"));
            assert!(message.contains("{\"id\":\"broken\""));
        }
        other => panic!("expected contextual parse error, got {other:?}"),
    }

    server.join().expect("server thread should finish");
}

#[tokio::test]
async fn test_send_chat_completion_treats_error_payload_with_200_status_as_api_error() {
    let (base_url, _rx, server) = spawn_server(
        r#"{"error":{"message":"Internal Server Error","code":500}}"#,
        "application/json",
    );

    let request = ChatCompletionRequestBuilder::default()
        .model("openai/gpt-4o-mini")
        .messages(vec![Message::new(Role::User, "hello")])
        .build()
        .expect("chat request should build");

    let error = send_chat_completion(&base_url, "api-key", &None, &None, &None, &request)
        .await
        .expect_err("error payload should fail");

    match error {
        openrouter_rs::error::OpenRouterError::Api(api_error) => {
            assert_eq!(api_error.status, http::StatusCode::INTERNAL_SERVER_ERROR);
            assert_eq!(api_error.api_code, Some(500));
            assert_eq!(api_error.message, "Internal Server Error");
            assert!(api_error.is_retryable());
        }
        other => panic!("expected API error, got {other:?}"),
    }

    server.join().expect("server thread should finish");
}