bob-adapters 0.3.2

Adapter implementations for Bob Agent Framework ports
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
//! # Provider Router
//!
//! Routes LLM requests across multiple providers with fallback,
//! priority ordering, and circuit-breaker-aware health checks.
//!
//! ## Strategies
//!
//! - [`RoutingStrategy::Priority`]: Try providers in order; fall back to the next on failure.
//! - [`RoutingStrategy::RoundRobin`]: Distribute requests across healthy providers in round-robin
//!   order.
//!
//! ## Example
//!
//! ```rust,ignore
//! use bob_adapters::provider_router::{ProviderRouter, RoutingStrategy, ProviderEntry};
//! use std::sync::Arc;
//!
//! let router = ProviderRouter::new(RoutingStrategy::Priority)
//!     .with_provider(ProviderEntry::new("openai", Arc::new(openai_adapter)))
//!     .with_provider(ProviderEntry::new("anthropic", Arc::new(anthropic_adapter)));
//!
//! let response = router.complete(request).await?;
//! ```

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

use async_trait::async_trait;
use bob_core::{
    error::LlmError,
    ports::LlmPort,
    resilience::{CircuitBreaker, CircuitState},
    types::{LlmCapabilities, LlmRequest, LlmResponse, LlmStream},
};

// ── Routing Strategy ─────────────────────────────────────────────────

/// How the router selects which provider to use.
#[derive(Debug, Clone)]
pub enum RoutingStrategy {
    /// Try each provider in the order they were added; stop on first success.
    Priority,
    /// Distribute across healthy providers in round-robin fashion.
    RoundRobin,
}

// ── Provider Entry ───────────────────────────────────────────────────

/// A named LLM provider with an optional circuit breaker.
pub struct ProviderEntry {
    /// Human-readable name (e.g. `"openai"`, `"anthropic"`).
    pub name: String,
    /// The underlying LLM adapter.
    pub adapter: Arc<dyn LlmPort>,
    /// Optional circuit breaker for this provider.
    pub circuit_breaker: Option<Arc<CircuitBreaker>>,
}

impl std::fmt::Debug for ProviderEntry {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ProviderEntry")
            .field("name", &self.name)
            .field("has_circuit_breaker", &self.circuit_breaker.is_some())
            .finish_non_exhaustive()
    }
}

impl ProviderEntry {
    /// Create a new provider entry without a circuit breaker.
    #[must_use]
    pub fn new(name: impl Into<String>, adapter: Arc<dyn LlmPort>) -> Self {
        Self { name: name.into(), adapter, circuit_breaker: None }
    }

    /// Attach a circuit breaker to this provider entry.
    #[must_use]
    pub fn with_circuit_breaker(mut self, cb: Arc<CircuitBreaker>) -> Self {
        self.circuit_breaker = Some(cb);
        self
    }

    /// Returns `true` if the circuit breaker allows a call.
    fn is_available(&self) -> bool {
        match &self.circuit_breaker {
            Some(cb) => cb.state() != CircuitState::Open,
            None => true,
        }
    }
}

// ── Provider Router ──────────────────────────────────────────────────

/// Routes LLM requests across multiple providers.
pub struct ProviderRouter {
    strategy: RoutingStrategy,
    providers: Vec<ProviderEntry>,
    round_robin_index: AtomicUsize,
}

impl std::fmt::Debug for ProviderRouter {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ProviderRouter")
            .field("strategy", &self.strategy)
            .field("provider_count", &self.providers.len())
            .finish_non_exhaustive()
    }
}

impl ProviderRouter {
    /// Create a new router with the given strategy.
    #[must_use]
    pub fn new(strategy: RoutingStrategy) -> Self {
        Self { strategy, providers: Vec::new(), round_robin_index: AtomicUsize::new(0) }
    }

    /// Add a provider to the router.
    #[must_use]
    pub fn with_provider(mut self, entry: ProviderEntry) -> Self {
        self.providers.push(entry);
        self
    }

    /// Returns the number of registered providers.
    #[must_use]
    pub fn provider_count(&self) -> usize {
        self.providers.len()
    }

    /// Execute a request using the configured routing strategy.
    async fn route_request<F, Fut>(&self, make_call: F) -> Result<LlmResponse, LlmError>
    where
        F: Fn(Arc<dyn LlmPort>) -> Fut,
        Fut: std::future::Future<Output = Result<LlmResponse, LlmError>>,
    {
        match &self.strategy {
            RoutingStrategy::Priority => self.route_priority(&make_call).await,
            RoutingStrategy::RoundRobin => self.route_round_robin(&make_call).await,
        }
    }

    async fn route_priority<F, Fut>(&self, make_call: &F) -> Result<LlmResponse, LlmError>
    where
        F: Fn(Arc<dyn LlmPort>) -> Fut,
        Fut: std::future::Future<Output = Result<LlmResponse, LlmError>>,
    {
        let mut last_error = None;

        for entry in &self.providers {
            if !entry.is_available() {
                continue;
            }

            let result = if let Some(cb) = &entry.circuit_breaker {
                cb.call(|| make_call(entry.adapter.clone())).await.map_err(|cb_err| match cb_err {
                    bob_core::resilience::CircuitBreakerError::CircuitOpen => {
                        LlmError::Provider(format!("{}: circuit open", entry.name))
                    }
                    bob_core::resilience::CircuitBreakerError::Inner(e) => e,
                })
            } else {
                make_call(entry.adapter.clone()).await
            };

            match result {
                Ok(resp) => return Ok(resp),
                Err(err) => {
                    tracing::warn!(provider = %entry.name, error = %err, "provider failed, trying next");
                    last_error = Some(err);
                }
            }
        }

        Err(last_error.unwrap_or_else(|| LlmError::Provider("no providers available".into())))
    }

    async fn route_round_robin<F, Fut>(&self, make_call: &F) -> Result<LlmResponse, LlmError>
    where
        F: Fn(Arc<dyn LlmPort>) -> Fut,
        Fut: std::future::Future<Output = Result<LlmResponse, LlmError>>,
    {
        let healthy: Vec<&ProviderEntry> =
            self.providers.iter().filter(|p| p.is_available()).collect();

        if healthy.is_empty() {
            return Err(LlmError::Provider("no healthy providers available".into()));
        }

        let index = self.round_robin_index.fetch_add(1, Ordering::Relaxed) % healthy.len();

        // Try starting from the round-robin index, then wrap around.
        let mut last_error = None;
        for offset in 0..healthy.len() {
            let entry = healthy[(index + offset) % healthy.len()];

            let result = if let Some(cb) = &entry.circuit_breaker {
                cb.call(|| make_call(entry.adapter.clone())).await.map_err(|cb_err| match cb_err {
                    bob_core::resilience::CircuitBreakerError::CircuitOpen => {
                        LlmError::Provider(format!("{}: circuit open", entry.name))
                    }
                    bob_core::resilience::CircuitBreakerError::Inner(e) => e,
                })
            } else {
                make_call(entry.adapter.clone()).await
            };

            match result {
                Ok(resp) => return Ok(resp),
                Err(err) => {
                    tracing::warn!(provider = %entry.name, error = %err, "provider failed in round-robin");
                    last_error = Some(err);
                }
            }
        }

        Err(last_error.unwrap_or_else(|| LlmError::Provider("all providers failed".into())))
    }
}

// ── LlmPort Implementation ───────────────────────────────────────────

#[async_trait]
impl LlmPort for ProviderRouter {
    fn capabilities(&self) -> LlmCapabilities {
        // Union of all provider capabilities.
        let mut native_tool_calling = false;
        let mut streaming = false;
        for entry in &self.providers {
            let caps = entry.adapter.capabilities();
            native_tool_calling |= caps.native_tool_calling;
            streaming |= caps.streaming;
        }
        LlmCapabilities { native_tool_calling, streaming }
    }

    async fn complete(&self, req: LlmRequest) -> Result<LlmResponse, LlmError> {
        let req = Arc::new(req);
        self.route_request(|adapter| {
            let req = Arc::clone(&req);
            async move { adapter.complete((*req).clone()).await }
        })
        .await
    }

    async fn complete_stream(&self, req: LlmRequest) -> Result<LlmStream, LlmError> {
        // For streaming, try each provider in priority order.
        for entry in &self.providers {
            if !entry.is_available() {
                continue;
            }
            match entry.adapter.complete_stream(req.clone()).await {
                Ok(stream) => return Ok(stream),
                Err(err) => {
                    tracing::warn!(provider = %entry.name, error = %err, "stream provider failed, trying next");
                }
            }
        }
        Err(LlmError::Provider("no provider available for streaming".into()))
    }
}

// ── Tests ────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use std::sync::Mutex;

    use super::*;

    struct MockLlm {
        _name: &'static str,
        responses: Mutex<Vec<Result<LlmResponse, LlmError>>>,
    }

    impl MockLlm {
        fn succeeds(name: &'static str, content: &'static str) -> Self {
            Self {
                _name: name,
                responses: Mutex::new(vec![Ok(LlmResponse {
                    content: content.into(),
                    usage: bob_core::types::TokenUsage::default(),
                    finish_reason: bob_core::types::FinishReason::Stop,
                    tool_calls: vec![],
                })]),
            }
        }

        fn always_fails(name: &'static str) -> Self {
            Self {
                _name: name,
                responses: Mutex::new(vec![Err(LlmError::Provider(format!(
                    "{name}: simulated failure"
                )))]),
            }
        }
    }

    #[async_trait]
    impl LlmPort for MockLlm {
        fn capabilities(&self) -> LlmCapabilities {
            LlmCapabilities { native_tool_calling: false, streaming: false }
        }

        async fn complete(&self, _req: LlmRequest) -> Result<LlmResponse, LlmError> {
            let mut responses = match self.responses.lock() {
                Ok(guard) => guard,
                Err(poisoned) => poisoned.into_inner(),
            };
            if responses.is_empty() {
                return Err(LlmError::Provider("no more mock responses".into()));
            }
            responses.remove(0)
        }

        async fn complete_stream(&self, _req: LlmRequest) -> Result<LlmStream, LlmError> {
            Err(LlmError::Provider("streaming not supported in mock".into()))
        }
    }

    fn test_request() -> LlmRequest {
        LlmRequest {
            model: "test-model".into(),
            messages: vec![bob_core::types::Message::text(bob_core::types::Role::User, "hello")],
            tools: vec![],
            output_schema: None,
        }
    }

    #[tokio::test]
    async fn priority_routes_to_first_available() {
        let router = ProviderRouter::new(RoutingStrategy::Priority)
            .with_provider(ProviderEntry::new(
                "primary",
                Arc::new(MockLlm::succeeds("primary", "ok")),
            ))
            .with_provider(ProviderEntry::new(
                "backup",
                Arc::new(MockLlm::succeeds("backup", "fallback")),
            ));

        let resp = router.complete(test_request()).await.expect("should succeed");
        assert_eq!(resp.content, "ok");
    }

    #[tokio::test]
    async fn priority_falls_back_on_failure() {
        let router = ProviderRouter::new(RoutingStrategy::Priority)
            .with_provider(ProviderEntry::new(
                "primary",
                Arc::new(MockLlm::always_fails("primary")),
            ))
            .with_provider(ProviderEntry::new(
                "backup",
                Arc::new(MockLlm::succeeds("backup", "fallback")),
            ));

        let resp = router.complete(test_request()).await.expect("should succeed via fallback");
        assert_eq!(resp.content, "fallback");
    }

    #[tokio::test]
    async fn priority_fails_when_all_providers_fail() {
        let router = ProviderRouter::new(RoutingStrategy::Priority)
            .with_provider(ProviderEntry::new("p1", Arc::new(MockLlm::always_fails("p1"))))
            .with_provider(ProviderEntry::new("p2", Arc::new(MockLlm::always_fails("p2"))));

        let result = router.complete(test_request()).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn round_robin_distributes_requests() {
        let router = ProviderRouter::new(RoutingStrategy::RoundRobin)
            .with_provider(ProviderEntry::new("a", Arc::new(MockLlm::succeeds("a", "from-a"))))
            .with_provider(ProviderEntry::new("b", Arc::new(MockLlm::succeeds("b", "from-b"))));

        // Both should succeed; the order depends on the round-robin index.
        let _ = router.complete(test_request()).await.expect("first call should succeed");
        let _ = router.complete(test_request()).await.expect("second call should succeed");
    }

    #[tokio::test]
    async fn circuit_breaker_skips_open_provider() {
        let cb = Arc::new(CircuitBreaker::new(bob_core::resilience::CircuitBreakerConfig {
            failure_threshold: 1,
            success_threshold: 1,
            cooldown: std::time::Duration::from_secs(60),
        }));

        // Trip the circuit breaker by calling it directly.
        let _ = cb.call(|| async { Err::<(), _>("fail") }).await;
        assert_eq!(cb.state(), CircuitState::Open);

        let router = ProviderRouter::new(RoutingStrategy::Priority)
            .with_provider(
                ProviderEntry::new("primary", Arc::new(MockLlm::succeeds("primary", "ok")))
                    .with_circuit_breaker(cb),
            )
            .with_provider(ProviderEntry::new(
                "backup",
                Arc::new(MockLlm::succeeds("backup", "fallback")),
            ));

        let resp = router.complete(test_request()).await.expect("should fall back to backup");
        assert_eq!(resp.content, "fallback");
    }

    #[tokio::test]
    async fn no_providers_returns_error() {
        let router = ProviderRouter::new(RoutingStrategy::Priority);
        let result = router.complete(test_request()).await;
        assert!(result.is_err());
    }
}