litellm-rs 0.6.0

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
//! Unit tests for routing selection logic
//!
//! Tests edge cases and deterministic behavior for SimpleShuffle,
//! RoundRobin, and LatencyBased strategies via `select_deployment`.

#![allow(deprecated)]

use super::router_tests::create_test_deployment;
use crate::config::models::provider::ProviderConfig;
use crate::core::providers::factory::create_provider;
use crate::core::router::config::{RouterConfig, RoutingStrategy};
use crate::core::router::deployment::{Deployment, HealthStatus};
use crate::core::router::error::RouterError;
use crate::core::router::unified::Router;
use crate::core::types::model::ProviderCapability;
use std::collections::HashMap;
use std::sync::atomic::Ordering::Relaxed;

// ==================== SimpleShuffle ====================

#[tokio::test]
async fn test_simple_shuffle_single_deployment_always_selected() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::SimpleShuffle,
        ..Default::default()
    };
    let router = Router::new(config);

    let d = create_test_deployment("only-one", "gpt-4").await;
    d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    router.add_deployment(d);

    for _ in 0..50 {
        let id = router.select_deployment("gpt-4").unwrap();
        assert_eq!(id, "only-one");
        router.release_deployment(&id);
    }
}

#[tokio::test]
async fn test_simple_shuffle_respects_weight() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::SimpleShuffle,
        ..Default::default()
    };
    let router = Router::new(config);

    let mut d_heavy = create_test_deployment("heavy", "gpt-4").await;
    let mut d_light = create_test_deployment("light", "gpt-4").await;
    d_heavy
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);
    d_light
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);

    d_heavy.config.weight = 90;
    d_light.config.weight = 10;

    router.add_deployment(d_heavy);
    router.add_deployment(d_light);

    let mut counts: HashMap<String, u32> = HashMap::new();
    for _ in 0..1000 {
        let id = router.select_deployment("gpt-4").unwrap();
        *counts.entry(id.clone()).or_default() += 1;
        router.release_deployment(&id);
    }

    let heavy_count = *counts.get("heavy").unwrap_or(&0);
    // With 90/10 weight split over 1000 trials, heavy should dominate.
    assert!(
        heavy_count > 700,
        "Expected weighted bias toward 'heavy', got {} out of 1000",
        heavy_count
    );
}

#[tokio::test]
async fn test_simple_shuffle_skips_unhealthy() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::SimpleShuffle,
        ..Default::default()
    };
    let router = Router::new(config);

    let d1 = create_test_deployment("healthy", "gpt-4").await;
    let d2 = create_test_deployment("sick", "gpt-4").await;
    d1.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    d2.state
        .health
        .store(HealthStatus::Unhealthy as u8, Relaxed);

    router.add_deployment(d1);
    router.add_deployment(d2);

    for _ in 0..50 {
        let id = router.select_deployment("gpt-4").unwrap();
        assert_eq!(id, "healthy", "unhealthy deployment must not be selected");
        router.release_deployment(&id);
    }
}

#[tokio::test]
async fn test_simple_shuffle_increments_active_requests() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::SimpleShuffle,
        ..Default::default()
    };
    let router = Router::new(config);

    let d = create_test_deployment("d1", "gpt-4").await;
    d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    router.add_deployment(d);

    let id = router.select_deployment("gpt-4").unwrap();
    let active = router
        .get_deployment(&id)
        .unwrap()
        .state
        .active_requests
        .load(Relaxed);
    assert_eq!(
        active, 1,
        "select_deployment should increment active_requests"
    );

    router.release_deployment(&id);
    let after = router
        .get_deployment(&id)
        .unwrap()
        .state
        .active_requests
        .load(Relaxed);
    assert_eq!(
        after, 0,
        "release_deployment should decrement active_requests"
    );
}

#[tokio::test]
async fn test_capability_selection_reports_unsupported_capability() {
    let router = Router::default();
    let d = create_test_deployment("chat-only", "shared-model").await;
    d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    router.add_deployment(d);

    let err = router
        .select_deployment_for_capability("shared-model", &ProviderCapability::CodeExecution)
        .expect_err("unsupported capability should not look unavailable");

    assert!(matches!(
        err,
        RouterError::UnsupportedCapability { model, capability }
            if model == "shared-model" && capability == "CodeExecution"
    ));
}

#[tokio::test]
async fn openai_like_route_selection_rejects_unimplemented_surfaces() {
    let provider = create_provider(ProviderConfig {
        name: "perplexity".to_string(),
        api_key: "sk-test".to_string(),
        ..Default::default()
    })
    .await
    .expect("Tier-1 catalog provider should build");
    let deployment = Deployment::new(
        "catalog-test".to_string(),
        provider,
        "shared-model".to_string(),
        "shared-model".to_string(),
    );
    deployment
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);
    let router = Router::default();
    router.add_deployment(deployment);

    let selected = router
        .select_deployment_for_capability("shared-model", &ProviderCapability::ChatCompletion)
        .expect("OpenAI-like provider should remain selectable for chat");
    assert_eq!(selected, "catalog-test");

    for capability in [
        ProviderCapability::ImageEdit,
        ProviderCapability::ImageVariation,
        ProviderCapability::Moderation,
    ] {
        let err = router
            .select_deployment_for_capability("shared-model", &capability)
            .expect_err("OpenAI-like provider must not be selected without an executable method");
        assert!(matches!(
            err,
            RouterError::UnsupportedCapability { model, capability: reported }
                if model == "shared-model" && reported == format!("{capability:?}")
        ));
    }
}

#[tokio::test]
async fn test_capability_selection_reports_unavailable_when_capable_deployment_is_unhealthy() {
    let router = Router::default();
    let d = create_test_deployment("chat-capable", "shared-model").await;
    d.state.health.store(HealthStatus::Unhealthy as u8, Relaxed);
    router.add_deployment(d);

    let err = router
        .select_deployment_for_capability("shared-model", &ProviderCapability::ChatCompletion)
        .expect_err("unhealthy capable deployment should be unavailable");

    assert!(matches!(err, RouterError::NoAvailableDeployment(model) if model == "shared-model"));
}

// ==================== RoundRobin ====================

#[tokio::test]
async fn test_round_robin_cycles_deterministically() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::RoundRobin,
        ..Default::default()
    };
    let router = Router::new(config);

    let d1 = create_test_deployment("rr-a", "gpt-4").await;
    let d2 = create_test_deployment("rr-b", "gpt-4").await;
    d1.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    d2.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    router.add_deployment(d1);
    router.add_deployment(d2);

    // Collect 6 selections; round-robin should alternate between 2 deployments
    let mut ids = Vec::new();
    for _ in 0..6 {
        let id = router.select_deployment("gpt-4").unwrap();
        ids.push(id.clone());
        router.release_deployment(&id);
    }

    // Each consecutive pair should differ
    for pair in ids.windows(2) {
        assert_ne!(
            pair[0], pair[1],
            "consecutive round-robin picks must differ"
        );
    }

    // The cycle should repeat: id[0] == id[2] == id[4]
    assert_eq!(ids[0], ids[2]);
    assert_eq!(ids[2], ids[4]);
    assert_eq!(ids[1], ids[3]);
    assert_eq!(ids[3], ids[5]);
}

#[tokio::test]
async fn test_round_robin_single_deployment() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::RoundRobin,
        ..Default::default()
    };
    let router = Router::new(config);

    let d = create_test_deployment("solo", "gpt-4").await;
    d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    router.add_deployment(d);

    for _ in 0..10 {
        let id = router.select_deployment("gpt-4").unwrap();
        assert_eq!(id, "solo");
        router.release_deployment(&id);
    }
}

#[tokio::test]
async fn test_round_robin_independent_per_model() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::RoundRobin,
        ..Default::default()
    };
    let router = Router::new(config);

    let d1 = create_test_deployment("gpt4-a", "gpt-4").await;
    let d2 = create_test_deployment("gpt4-b", "gpt-4").await;
    let d3 = create_test_deployment("claude-a", "claude").await;
    let d4 = create_test_deployment("claude-b", "claude").await;

    for d in [&d1, &d2, &d3, &d4] {
        d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    }
    router.add_deployment(d1);
    router.add_deployment(d2);
    router.add_deployment(d3);
    router.add_deployment(d4);

    // Advance gpt-4 counter by 3
    for _ in 0..3 {
        let id = router.select_deployment("gpt-4").unwrap();
        router.release_deployment(&id);
    }

    // Claude counter should still be at 0 — first claude pick is independent
    let claude_first = router.select_deployment("claude").unwrap();
    let claude_second = router.select_deployment("claude").unwrap();
    router.release_deployment(&claude_first);
    router.release_deployment(&claude_second);

    assert_ne!(
        claude_first, claude_second,
        "round-robin counters must be independent per model"
    );
}

#[tokio::test]
async fn test_round_robin_skips_cooldown() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::RoundRobin,
        ..Default::default()
    };
    let router = Router::new(config);

    let d1 = create_test_deployment("ok", "gpt-4").await;
    let d2 = create_test_deployment("cooled", "gpt-4").await;

    d1.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    d2.state.health.store(HealthStatus::Healthy as u8, Relaxed);

    // Put d2 into cooldown
    d2.enter_cooldown(3600);

    router.add_deployment(d1);
    router.add_deployment(d2);

    // All selections must go to "ok"
    for _ in 0..10 {
        let id = router.select_deployment("gpt-4").unwrap();
        assert_eq!(id, "ok", "deployment in cooldown must be skipped");
        router.release_deployment(&id);
    }
}

// ==================== LatencyBased ====================

#[tokio::test]
async fn test_latency_based_picks_lowest() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::LatencyBased,
        ..Default::default()
    };
    let router = Router::new(config);

    let d1 = create_test_deployment("slow", "gpt-4").await;
    let d2 = create_test_deployment("fast", "gpt-4").await;
    let d3 = create_test_deployment("medium", "gpt-4").await;

    for d in [&d1, &d2, &d3] {
        d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    }

    d1.state.avg_latency_us.store(200_000, Relaxed);
    d2.state.avg_latency_us.store(10_000, Relaxed);
    d3.state.avg_latency_us.store(100_000, Relaxed);

    router.add_deployment(d1);
    router.add_deployment(d2);
    router.add_deployment(d3);

    let id = router.select_deployment("gpt-4").unwrap();
    assert_eq!(id, "fast", "should pick deployment with lowest latency");
    router.release_deployment(&id);
}

#[tokio::test]
async fn test_latency_based_zero_latency_uses_average() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::LatencyBased,
        ..Default::default()
    };
    let router = Router::new(config);

    let d_known = create_test_deployment("known", "gpt-4").await;
    let d_new = create_test_deployment("new", "gpt-4").await;

    d_known
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);
    d_new
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);

    // d_known has measured latency; d_new has 0 (no data yet)
    d_known.state.avg_latency_us.store(50_000, Relaxed);
    // d_new defaults to 0

    router.add_deployment(d_known);
    router.add_deployment(d_new);

    // With only one non-zero latency, average = 50_000.
    // d_new gets avg (50_000), d_known has 50_000, so either could be picked.
    // The key assertion is that it does NOT error out.
    let id = router.select_deployment("gpt-4").unwrap();
    router.release_deployment(&id);
}

#[tokio::test]
async fn test_latency_based_single_deployment() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::LatencyBased,
        ..Default::default()
    };
    let router = Router::new(config);

    let d = create_test_deployment("only", "gpt-4").await;
    d.state.health.store(HealthStatus::Healthy as u8, Relaxed);
    d.state.avg_latency_us.store(42_000, Relaxed);
    router.add_deployment(d);

    let id = router.select_deployment("gpt-4").unwrap();
    assert_eq!(id, "only");
    router.release_deployment(&id);
}

#[tokio::test]
async fn test_latency_based_skips_rate_limited() {
    let config = RouterConfig {
        routing_strategy: RoutingStrategy::LatencyBased,
        ..Default::default()
    };
    let router = Router::new(config);

    let mut d_fast = create_test_deployment("fast-limited", "gpt-4").await;
    let d_slow = create_test_deployment("slow-ok", "gpt-4").await;

    d_fast
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);
    d_slow
        .state
        .health
        .store(HealthStatus::Healthy as u8, Relaxed);

    d_fast.state.avg_latency_us.store(1_000, Relaxed);
    d_slow.state.avg_latency_us.store(100_000, Relaxed);

    // Rate-limit the fast one
    d_fast.config.rpm_limit = Some(100);
    d_fast.state.rpm_current.store(100, Relaxed);

    router.add_deployment(d_fast);
    router.add_deployment(d_slow);

    let id = router.select_deployment("gpt-4").unwrap();
    assert_eq!(
        id, "slow-ok",
        "rate-limited deployment must be excluded even if it has lowest latency"
    );
    router.release_deployment(&id);
}