litellm-rs 0.4.16

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
//! Execution flow tests

use super::router_tests::create_test_deployment;
use crate::core::providers::unified_provider::ProviderError;
use crate::core::router::config::RouterConfig;
use crate::core::router::error::RouterError;
use crate::core::router::execution::is_retryable_error;
use crate::core::router::fallback::{ExecutionResult, FallbackConfig};
use crate::core::router::unified::Router;
use std::sync::atomic::Ordering;

#[test]
fn test_is_retryable_error() {
    assert!(is_retryable_error(&ProviderError::rate_limit(
        "test",
        Some(60)
    )));
    assert!(is_retryable_error(&ProviderError::timeout(
        "test",
        "Request timed out"
    )));
    assert!(is_retryable_error(&ProviderError::network(
        "test",
        "Connection failed"
    )));
    assert!(is_retryable_error(&ProviderError::ProviderUnavailable {
        provider: "test",
        message: "Service unavailable".to_string(),
    }));

    assert!(!is_retryable_error(&ProviderError::authentication(
        "test",
        "Invalid API key"
    )));
    assert!(!is_retryable_error(&ProviderError::model_not_found(
        "test", "gpt-5"
    )));
    assert!(!is_retryable_error(&ProviderError::invalid_request(
        "test",
        "Bad request"
    )));
}

#[tokio::test]
async fn test_execute_once_success() {
    let router = Router::default();
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result = router
        .execute_once("gpt-4", |_deployment_id| async move {
            Ok(("success".to_string(), 100u64))
        })
        .await;

    assert!(result.is_ok());
    let exec_result = result.unwrap();
    assert_eq!(exec_result.result, "success");
    assert_eq!(exec_result.attempts, 1);
    assert!(!exec_result.used_fallback);
    assert!(exec_result.latency_us > 0);
}

#[tokio::test]
async fn test_execute_once_deployment_not_found() {
    let router = Router::default();

    let result = router
        .execute_once("gpt-4", |_deployment_id| async move {
            Ok(("success".to_string(), 100u64))
        })
        .await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(matches!(err, RouterError::ModelNotFound(_)));
}

#[tokio::test]
async fn test_execute_once_operation_fails() {
    let router = Router::default();
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result: Result<ExecutionResult<String>, _> = router
        .execute_once("gpt-4", |_deployment_id| async move {
            Err::<(String, u64), _>(ProviderError::authentication("test", "Invalid API key"))
        })
        .await;

    assert!(result.is_err());

    if let Some(d) = router.get_deployment("test-1") {
        assert_eq!(d.state.fail_requests.load(Ordering::Relaxed), 1);
    }
}

#[tokio::test]
async fn test_execute_with_retry_success_first_attempt() {
    let router = Router::default();
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result = router
        .execute_with_retry("gpt-4", |_deployment_id| async move {
            Ok(("success".to_string(), 100u64))
        })
        .await;

    assert!(result.is_ok());
    let (value, deployment_id, attempts, _latency) = result.unwrap();
    assert_eq!(value, "success");
    assert_eq!(attempts, 1);
    assert_eq!(deployment_id, "test-1");
}

#[tokio::test]
async fn test_execute_with_retry_success_second_attempt() {
    let config = RouterConfig {
        num_retries: 3,
        retry_after_secs: 0,
        cooldown_time_secs: 0,
        ..Default::default()
    };
    let router = Router::new(config);
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let attempt_count = std::sync::Arc::new(std::sync::atomic::AtomicU32::new(0));
    let attempt_count_clone = attempt_count.clone();

    let result = router
        .execute_with_retry("gpt-4", move |_deployment_id| {
            let attempt_count = attempt_count_clone.clone();
            async move {
                let current = attempt_count.fetch_add(1, Ordering::Relaxed);
                if current == 0 {
                    Err(ProviderError::timeout("test", "Request timed out"))
                } else {
                    Ok(("success".to_string(), 100u64))
                }
            }
        })
        .await;

    assert!(result.is_ok());
    let (_value, _deployment_id, attempts, _latency) = result.unwrap();
    assert_eq!(attempts, 2);
}

#[tokio::test]
async fn test_execute_with_retry_exhausted() {
    let config = RouterConfig {
        num_retries: 2,
        retry_after_secs: 0,
        cooldown_time_secs: 0,
        ..Default::default()
    };
    let router = Router::new(config);
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result = router
        .execute_with_retry("gpt-4", |_deployment_id| async move {
            Err::<(String, u64), _>(ProviderError::timeout("test", "Request timed out"))
        })
        .await;

    assert!(result.is_err());
    let (error, attempts) = result.unwrap_err();
    assert_eq!(attempts, 3);
    assert!(matches!(error, ProviderError::Timeout { .. }));
}

#[tokio::test]
async fn test_execute_with_retry_non_retryable_error() {
    let config = RouterConfig {
        num_retries: 3,
        ..Default::default()
    };
    let router = Router::new(config);
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result = router
        .execute_with_retry("gpt-4", |_deployment_id| async move {
            Err::<(String, u64), _>(ProviderError::authentication("test", "Invalid API key"))
        })
        .await;

    assert!(result.is_err());
    let (_error, attempts) = result.unwrap_err();
    assert_eq!(attempts, 1);
}

#[tokio::test]
async fn test_execute_with_fallback() {
    let config = RouterConfig {
        num_retries: 1,
        retry_after_secs: 0,
        max_fallbacks: 2,
        ..Default::default()
    };

    let fallback_config =
        FallbackConfig::new().add_general("gpt-4", vec!["gpt-3.5-turbo".to_string()]);

    let router = Router::new(config).with_fallback_config(fallback_config);

    let deployment1 = create_test_deployment("test-gpt4", "gpt-4").await;
    let deployment2 = create_test_deployment("test-gpt3.5", "gpt-3.5-turbo").await;
    router.add_deployment(deployment1);
    router.add_deployment(deployment2);

    let call_count = std::sync::Arc::new(std::sync::atomic::AtomicU32::new(0));
    let call_count_clone = call_count.clone();

    let result: Result<ExecutionResult<String>, _> = router
        .execute("gpt-4", move |deployment_id| {
            let call_count = call_count_clone.clone();
            async move {
                let count = call_count.fetch_add(1, Ordering::Relaxed);
                if deployment_id.contains("gpt4") {
                    Err(ProviderError::timeout("test", "gpt-4 timed out"))
                } else {
                    Ok((format!("fallback-{}", count), 100u64))
                }
            }
        })
        .await;

    assert!(result.is_ok());
    let exec_result = result.unwrap();
    assert!(exec_result.used_fallback);
    assert!(exec_result.model_used.contains("gpt-3.5-turbo"));
    assert!(exec_result.attempts > 1);
}

#[tokio::test]
async fn test_execute_all_models_fail() {
    let config = RouterConfig {
        num_retries: 1,
        retry_after_secs: 0,
        max_fallbacks: 2,
        ..Default::default()
    };

    let fallback_config =
        FallbackConfig::new().add_general("gpt-4", vec!["gpt-3.5-turbo".to_string()]);

    let router = Router::new(config).with_fallback_config(fallback_config);

    let deployment1 = create_test_deployment("test-gpt4", "gpt-4").await;
    let deployment2 = create_test_deployment("test-gpt3.5", "gpt-3.5-turbo").await;
    router.add_deployment(deployment1);
    router.add_deployment(deployment2);

    let result: Result<ExecutionResult<String>, _> = router
        .execute("gpt-4", |_deployment_id| async move {
            Err::<(String, u64), _>(ProviderError::timeout("test", "All models timed out"))
        })
        .await;

    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        RouterError::NoAvailableDeployment(_)
    ));
}

#[tokio::test]
async fn test_execute_respects_max_fallbacks() {
    let config = RouterConfig {
        num_retries: 0,
        max_fallbacks: 1,
        retry_after_secs: 0,
        ..Default::default()
    };

    let fallback_config = FallbackConfig::new().add_general(
        "gpt-4",
        vec![
            "fallback-1".to_string(),
            "fallback-2".to_string(),
            "fallback-3".to_string(),
        ],
    );

    let router = Router::new(config).with_fallback_config(fallback_config);

    let deployment1 = create_test_deployment("test-gpt4", "gpt-4").await;
    let deployment2 = create_test_deployment("test-fb1", "fallback-1").await;
    let deployment3 = create_test_deployment("test-fb2", "fallback-2").await;
    let deployment4 = create_test_deployment("test-fb3", "fallback-3").await;
    router.add_deployment(deployment1);
    router.add_deployment(deployment2);
    router.add_deployment(deployment3);
    router.add_deployment(deployment4);

    let tried_models = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
    let tried_models_clone = tried_models.clone();

    let result: Result<ExecutionResult<String>, _> = router
        .execute("gpt-4", move |deployment_id| {
            let tried = tried_models_clone.clone();
            async move {
                tried.lock().unwrap().push(deployment_id.clone());
                Err::<(String, u64), _>(ProviderError::timeout("test", "Failed"))
            }
        })
        .await;

    assert!(result.is_err());

    let models = tried_models.lock().unwrap();
    assert!(
        models.len() <= 2,
        "Tried {} models, expected <= 2",
        models.len()
    );
}

#[tokio::test]
async fn test_execute_records_metrics() {
    let router = Router::default();
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let result = router
        .execute_once("gpt-4", |_deployment_id| async move {
            Ok(("success".to_string(), 500u64))
        })
        .await;

    assert!(result.is_ok());

    if let Some(d) = router.get_deployment("test-1") {
        assert_eq!(d.state.total_requests.load(Ordering::Relaxed), 1);
        assert!(d.state.avg_latency_us.load(Ordering::Relaxed) > 0);
    }
}

// ==================== Additional Edge Case Tests ====================

#[tokio::test]
async fn test_execute_with_rate_limit_error() {
    let config = RouterConfig {
        num_retries: 2,
        retry_after_secs: 0,
        cooldown_time_secs: 0,
        ..Default::default()
    };
    let router = Router::new(config);
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let attempt_count = std::sync::Arc::new(std::sync::atomic::AtomicU32::new(0));
    let attempt_count_clone = attempt_count.clone();

    let result = router
        .execute_with_retry("gpt-4", move |_deployment_id| {
            let attempt_count = attempt_count_clone.clone();
            async move {
                let current = attempt_count.fetch_add(1, Ordering::Relaxed);
                if current < 2 {
                    Err(ProviderError::rate_limit("test", Some(1)))
                } else {
                    Ok(("success after rate limit".to_string(), 100u64))
                }
            }
        })
        .await;

    assert!(result.is_ok());
    let (_value, _deployment_id, attempts, _latency) = result.unwrap();
    assert_eq!(attempts, 3);
}

#[tokio::test]
async fn test_execute_deployment_selection_failure() {
    let router = Router::default();

    // No deployments added
    let result = router
        .execute_with_retry("nonexistent-model", |_deployment_id| async move {
            Ok(("should not reach here".to_string(), 100u64))
        })
        .await;

    assert!(result.is_err());
    let (_error, attempts) = result.unwrap_err();
    assert_eq!(attempts, 1); // Should fail immediately on deployment selection
}

#[tokio::test]
async fn test_execute_max_retries_exceeded() {
    let config = RouterConfig {
        num_retries: 3,
        retry_after_secs: 0,
        cooldown_time_secs: 0,
        ..Default::default()
    };
    let router = Router::new(config);
    let deployment = create_test_deployment("test-1", "gpt-4").await;
    router.add_deployment(deployment);

    let attempt_count = std::sync::Arc::new(std::sync::atomic::AtomicU32::new(0));
    let attempt_count_clone = attempt_count.clone();

    let result = router
        .execute_with_retry("gpt-4", move |_deployment_id| {
            let attempt_count = attempt_count_clone.clone();
            async move {
                attempt_count.fetch_add(1, Ordering::Relaxed);
                Err::<(String, u64), _>(ProviderError::timeout("test", "Always timeout"))
            }
        })
        .await;

    assert!(result.is_err());
    let (_error, attempts) = result.unwrap_err();
    assert_eq!(attempts, 4); // Initial attempt + 3 retries
}