litellm-rs 0.8.2

A high-performance AI Gateway written in Rust, providing OpenAI-compatible APIs with intelligent routing, load balancing, and enterprise features
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//! Completion module tests

use super::*;
use crate::core::net::ProviderEndpointAccess;
use crate::core::providers::base::BaseConfig;
use crate::core::providers::openai::{OpenAIConfig, OpenAIProvider};
use crate::core::providers::unified_provider::ProviderError;
use crate::core::providers::{DeepgramProvider, Provider};
use crate::core::router::config::{RouterConfig, RoutingStrategy};
use crate::core::router::{Deployment, RuntimeBinding, UnifiedRouter};
use crate::core::types::message::MessageRole;
use crate::sdk::LLMClient;
use crate::sdk::errors::SDKError;
use crate::sdk::types::{Content as SdkContent, Message as SdkMessage, Role as SdkRole};
use crate::utils::error::gateway_error::GatewayError;
use futures::StreamExt;
use std::sync::Arc;
use tokio::io::{AsyncReadExt, AsyncWriteExt};

fn non_chat_deployment(id: &str, public_model: &str) -> Deployment {
    let mut deployment = Deployment::new(
        id.to_string(),
        Provider::Deepgram(
            DeepgramProvider::new(BaseConfig {
                api_key: Some("deepgram-test-key".to_string()),
                ..Default::default()
            })
            .expect("non-chat provider should build"),
        ),
        "nova-3".to_string(),
        public_model.to_string(),
    );
    deployment.config.priority = 0;
    deployment
}

#[test]
fn test_message_creation() {
    let msg = user_message("Hello, world!");
    assert_eq!(msg.role, MessageRole::User);
    if let Some(MessageContent::Text(content)) = msg.content {
        assert_eq!(content, "Hello, world!");
    } else {
        panic!("Expected text content");
    }
}

#[test]
fn test_completion_options_default() {
    let options = CompletionOptions::default();
    assert!(!options.stream);
    assert_eq!(options.extra_params.len(), 0);
}

#[test]
fn test_system_message_creation() {
    let msg = system_message("You are a helpful assistant.");
    assert_eq!(msg.role, MessageRole::System);
    if let Some(MessageContent::Text(content)) = msg.content {
        assert_eq!(content, "You are a helpful assistant.");
    } else {
        panic!("Expected text content");
    }
}

#[test]
fn test_assistant_message_creation() {
    let msg = assistant_message("I can help you with that.");
    assert_eq!(msg.role, MessageRole::Assistant);
    if let Some(MessageContent::Text(content)) = msg.content {
        assert_eq!(content, "I can help you with that.");
    } else {
        panic!("Expected text content");
    }
}

#[tokio::test]
async fn explicit_completion_facade_executes_selected_runtime_deployment() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("mock provider should bind");
    let address = listener.local_addr().expect("mock address should exist");
    let upstream = tokio::spawn(async move {
        let (mut socket, _) = listener.accept().await.expect("request should arrive");
        let mut request = vec![0_u8; 8192];
        let bytes = socket
            .read(&mut request)
            .await
            .expect("request should read");
        let request = String::from_utf8_lossy(&request[..bytes]);
        assert!(request.starts_with("POST /v1/chat/completions HTTP/1.1"));
        assert!(request.contains(r#""model":"canonical-model""#));

        let body = r#"{"id":"chatcmpl-runtime","object":"chat.completion","created":1,"model":"canonical-model","choices":[{"index":0,"message":{"role":"assistant","content":"runtime"},"finish_reason":"stop"}],"usage":{"prompt_tokens":1,"completion_tokens":1,"total_tokens":2}}"#;
        let response = format!(
            "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{}",
            body.len(),
            body
        );
        socket
            .write_all(response.as_bytes())
            .await
            .expect("response should write");
    });

    let provider = OpenAIProvider::new(OpenAIConfig {
        base: BaseConfig {
            api_key: Some("sk-runtime-test".to_string()),
            api_base: Some(format!("http://{address}/v1")),
            endpoint_access: ProviderEndpointAccess::PrivateNetwork,
            ..Default::default()
        },
        ..Default::default()
    })
    .await
    .expect("provider should build");
    let runtime = Arc::new(UnifiedRouter::default());
    runtime.add_deployment(Deployment::new(
        "canonical-deployment".to_string(),
        Provider::OpenAI(provider),
        "canonical-model".to_string(),
        "facade-model".to_string(),
    ));
    runtime
        .add_model_alias("google/facade-alias", "facade-model")
        .expect("prefix-looking alias should publish");
    let facade = DefaultRouter::from_runtime(RuntimeBinding::new(runtime));

    let response = facade
        .complete(
            "google/facade-alias",
            vec![user_message("hello")],
            CompletionOptions::default(),
        )
        .await
        .expect("canonical runtime completion should succeed");

    assert_eq!(response.id, "chatcmpl-runtime");
    assert_eq!(response.model, "canonical-model");
    upstream.await.expect("mock provider should finish");
}

#[tokio::test]
async fn runtime_handle_capability_filters_non_streaming_for_completion_and_sdk() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("mock provider should bind");
    let address = listener.local_addr().expect("mock address should exist");
    let upstream = tokio::spawn(async move {
        for _ in 0..2 {
            let (mut socket, _) = listener.accept().await.expect("request should arrive");
            let mut request = vec![0_u8; 8192];
            let bytes = socket
                .read(&mut request)
                .await
                .expect("request should read");
            let request = String::from_utf8_lossy(&request[..bytes]);
            assert!(request.starts_with("POST /v1/chat/completions HTTP/1.1"));
            assert!(request.contains(r#""model":"canonical-stream-model""#));
            assert!(request.contains(r#""stream":true"#));

            let body = concat!(
                "data: {\"id\":\"chatcmpl-runtime-stream\",\"object\":\"chat.completion.chunk\",\"created\":1,\"model\":\"canonical-stream-model\",\"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"runtime-stream\"},\"finish_reason\":null}]}\n\n",
                "data: [DONE]\n\n"
            );
            let response = format!(
                "HTTP/1.1 200 OK\r\nContent-Type: text/event-stream\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{}",
                body.len(),
                body
            );
            socket
                .write_all(response.as_bytes())
                .await
                .expect("response should write");
        }
    });

    let provider = OpenAIProvider::new(OpenAIConfig {
        base: BaseConfig {
            api_key: Some("sk-runtime-stream-test".to_string()),
            api_base: Some(format!("http://{address}/v1")),
            endpoint_access: ProviderEndpointAccess::PrivateNetwork,
            ..Default::default()
        },
        ..Default::default()
    })
    .await
    .expect("provider should build");
    let runtime = Arc::new(UnifiedRouter::new(RouterConfig {
        routing_strategy: RoutingStrategy::PriorityBased,
        ..Default::default()
    }));
    runtime.add_deployment(non_chat_deployment(
        "non-streaming-deployment",
        "stream-facade-model",
    ));
    let mut stream_deployment = Deployment::new(
        "canonical-stream-deployment".to_string(),
        Provider::OpenAI(provider),
        "canonical-stream-model".to_string(),
        "stream-facade-model".to_string(),
    );
    stream_deployment.config.priority = 10;
    runtime.add_deployment(stream_deployment);
    let deployment = runtime
        .get_deployment("canonical-stream-deployment")
        .expect("stream deployment should exist");
    let binding = RuntimeBinding::new(runtime);
    let facade = DefaultRouter::from_runtime(binding.clone());
    let sdk_facade = LLMClient::from_runtime(binding, "stream-facade-model")
        .expect("SDK runtime facade should build");

    let mut stream = facade
        .complete_stream(
            "stream-facade-model",
            vec![user_message("hello")],
            CompletionOptions::default(),
        )
        .await
        .expect("canonical runtime stream should start");
    assert_eq!(
        deployment
            .state
            .active_requests
            .load(std::sync::atomic::Ordering::Relaxed),
        1
    );
    let chunk = stream
        .next()
        .await
        .expect("stream should yield a chunk")
        .expect("chunk should succeed");

    assert_eq!(chunk.id, "chatcmpl-runtime-stream");
    assert_eq!(chunk.model, "canonical-stream-model");
    assert_eq!(
        chunk.choices[0].delta.content.as_deref(),
        Some("runtime-stream")
    );
    drop(stream);
    assert_eq!(
        deployment
            .state
            .active_requests
            .load(std::sync::atomic::Ordering::Relaxed),
        0
    );

    let mut sdk_stream = sdk_facade
        .chat_stream(vec![SdkMessage {
            role: SdkRole::User,
            content: Some(SdkContent::Text("hello".to_string())),
            name: None,
            tool_calls: None,
        }])
        .await
        .expect("canonical SDK stream should start");
    assert_eq!(
        deployment
            .state
            .active_requests
            .load(std::sync::atomic::Ordering::Relaxed),
        1
    );
    let sdk_chunk = sdk_stream
        .next()
        .await
        .expect("SDK stream should yield a chunk")
        .expect("SDK chunk should succeed");
    assert_eq!(sdk_chunk.id, "chatcmpl-runtime-stream");
    assert_eq!(sdk_chunk.model, "canonical-stream-model");
    assert_eq!(
        sdk_chunk.choices[0].delta.content.as_deref(),
        Some("runtime-stream")
    );
    drop(sdk_stream);
    assert_eq!(
        deployment
            .state
            .active_requests
            .load(std::sync::atomic::Ordering::Relaxed),
        0
    );
    upstream.await.expect("mock provider should finish");
}

#[tokio::test]
async fn runtime_handle_capability_filters_non_chat_for_completion_and_sdk() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("mock provider should bind");
    let address = listener.local_addr().expect("mock address should exist");
    let upstream = tokio::spawn(async move {
        for _ in 0..2 {
            let (mut socket, _) = listener.accept().await.expect("request should arrive");
            let mut request = vec![0_u8; 8192];
            let bytes = socket
                .read(&mut request)
                .await
                .expect("request should read");
            let request = String::from_utf8_lossy(&request[..bytes]);
            assert!(request.contains(r#""model":"shared-runtime-model""#));

            let body = r#"{"id":"chatcmpl-shared","object":"chat.completion","created":1,"model":"shared-runtime-model","choices":[{"index":0,"message":{"role":"assistant","content":"shared"},"finish_reason":"stop"}],"usage":{"prompt_tokens":1,"completion_tokens":1,"total_tokens":2}}"#;
            let response = format!(
                "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{}",
                body.len(),
                body
            );
            socket
                .write_all(response.as_bytes())
                .await
                .expect("response should write");
        }
    });

    let provider = OpenAIProvider::new(OpenAIConfig {
        base: BaseConfig {
            api_key: Some("sk-shared-runtime-test".to_string()),
            api_base: Some(format!("http://{address}/v1")),
            endpoint_access: ProviderEndpointAccess::PrivateNetwork,
            ..Default::default()
        },
        ..Default::default()
    })
    .await
    .expect("provider should build");
    let runtime = Arc::new(UnifiedRouter::new(RouterConfig {
        routing_strategy: RoutingStrategy::PriorityBased,
        ..Default::default()
    }));
    runtime.add_deployment(non_chat_deployment(
        "non-chat-deployment",
        "public-runtime-model",
    ));
    let mut chat = Deployment::new(
        "shared-runtime-deployment".to_string(),
        Provider::OpenAI(provider),
        "shared-runtime-model".to_string(),
        "public-runtime-model".to_string(),
    );
    chat.config.priority = 10;
    runtime.add_deployment(chat);
    let binding = RuntimeBinding::new(runtime);
    let completion_facade = DefaultRouter::from_runtime(binding.clone());
    let sdk_facade = LLMClient::from_runtime(binding, "public-runtime-model")
        .expect("SDK runtime facade should build");

    let completion_response = completion_facade
        .complete(
            "public-runtime-model",
            vec![user_message("hello")],
            CompletionOptions::default(),
        )
        .await
        .expect("completion facade should succeed");
    let sdk_response = sdk_facade
        .chat(vec![SdkMessage {
            role: SdkRole::User,
            content: Some(SdkContent::Text("hello".to_string())),
            name: None,
            tool_calls: None,
        }])
        .await
        .expect("SDK facade should succeed");

    assert_eq!(completion_response.model, "shared-runtime-model");
    assert_eq!(sdk_response.model, "shared-runtime-model");
    upstream.await.expect("mock provider should finish");

    let empty_binding = RuntimeBinding::new(Arc::new(UnifiedRouter::default()));
    let completion_error = DefaultRouter::from_runtime(empty_binding.clone())
        .complete(
            "missing-model",
            vec![user_message("hello")],
            CompletionOptions::default(),
        )
        .await
        .expect_err("completion must fail for an unknown model");
    let sdk_error = LLMClient::from_runtime(empty_binding, "missing-model")
        .expect("SDK runtime facade should build")
        .chat(vec![SdkMessage {
            role: SdkRole::User,
            content: Some(SdkContent::Text("hello".to_string())),
            name: None,
            tool_calls: None,
        }])
        .await
        .expect_err("SDK must fail for an unknown model");

    assert!(matches!(
        completion_error,
        GatewayError::Provider(ProviderError::ModelNotFound { .. })
    ));
    assert!(matches!(sdk_error, SDKError::ModelNotFound(_)));
}

#[tokio::test]
async fn terminal_provider_error_preserves_type_and_redacts_gateway_copy() {
    let provider = OpenAIProvider::new(OpenAIConfig {
        base: BaseConfig {
            api_key: Some("sk-unused-test-key".to_string()),
            ..Default::default()
        },
        ..Default::default()
    })
    .await
    .expect("provider should build");
    let runtime = Arc::new(UnifiedRouter::default());
    runtime.add_deployment(Deployment::new(
        "authentication-deployment".to_string(),
        Provider::OpenAI(provider),
        "canonical-model".to_string(),
        "auth-model".to_string(),
    ));
    let handle = RuntimeBinding::new(runtime).bind();
    let error = handle
        .execute_with_selected_deployment_typed("auth-model", |_| async {
            Err::<((), u64), _>(ProviderError::authentication(
                "openai",
                "authorization: Bearer sk-terminal-secret",
            ))
        })
        .await
        .expect_err("typed runtime boundary should preserve authentication failure");
    let error = GatewayError::from(error);

    match error {
        GatewayError::Provider(ref error @ ProviderError::Authentication { ref message, .. }) => {
            assert_eq!(
                error.canonical_code(),
                crate::utils::error::ErrorCode::Authentication
            );
            assert!(!message.contains("sk-terminal-secret"));
            assert!(message.contains("[REDACTED]"));
        }
        other => panic!("expected typed authentication error, got {other:?}"),
    }
}

#[tokio::test]
async fn unary_completion_fails_closed_instead_of_using_request_provider_overrides() {
    let facade =
        DefaultRouter::from_runtime(RuntimeBinding::new(Arc::new(UnifiedRouter::default())));
    let error = facade
        .complete(
            "missing-model",
            vec![user_message("hello")],
            CompletionOptions {
                api_key: Some("sk-must-not-build-a-provider".to_string()),
                ..Default::default()
            },
        )
        .await
        .expect_err("request-level provider construction must fail closed");

    assert!(matches!(
        error,
        GatewayError::Provider(ProviderError::InvalidRequest { .. })
    ));
}

#[test]
fn unary_completion_source_has_no_legacy_execution_fallback() {
    let source = include_str!("default_router/router_impl.rs");
    let start = source
        .find("pub(super) async fn complete_with_runtime_handle")
        .expect("canonical unary helper should exist");
    let end = source[start..]
        .find("pub(super) async fn complete_stream_with_runtime_handle")
        .map(|offset| start + offset)
        .expect("canonical unary helper should have a stable boundary");
    let unary = &source[start..end];

    for forbidden in [
        "ProviderRegistry",
        "std::env",
        "try_dynamic_provider_creation",
        "OpenAIProvider::new",
        "select_static_provider",
        "unsupported_explicit_completion_selector",
        "router_error_to_provider_error",
    ] {
        assert!(
            !unary.contains(forbidden),
            "unary completion must not contain legacy fallback: {forbidden}"
        );
    }
    let stream_start = end;
    let stream_end = source[stream_start..]
        .find("#[async_trait]")
        .map(|offset| stream_start + offset)
        .expect("canonical stream helper should have a stable boundary");
    let stream = &source[stream_start..stream_end];
    for forbidden in [
        "ProviderRegistry",
        "std::env",
        "try_dynamic_provider_stream_creation",
        "OpenAIProvider::new",
        "select_static_provider",
    ] {
        assert!(
            !stream.contains(forbidden),
            "streaming completion must not contain legacy fallback: {forbidden}"
        );
    }
    assert!(stream.contains("let _lease = &lease"));

    let facade = include_str!("default_router/mod.rs");
    let start = facade
        .find("pub async fn completion(")
        .expect("completion free function should exist");
    let end = facade[start..]
        .find("pub async fn acompletion(")
        .map(|offset| start + offset)
        .expect("completion free function should have a stable boundary");
    let facade_unary = &facade[start..end];
    assert!(facade_unary.contains("default_runtime()"));
    assert!(!facade_unary.contains("get_global_router"));

    let stream_start = facade
        .find("pub async fn completion_stream(")
        .expect("completion_stream free function should exist");
    let stream_end = facade[stream_start..]
        .find("\n}")
        .map(|offset| stream_start + offset)
        .expect("completion_stream should have a stable boundary");
    let facade_stream = &facade[stream_start..stream_end];
    assert!(facade_stream.contains("default_runtime()"));
    assert!(!facade_stream.contains("get_global_router"));
}