camel-component-llm 0.18.0

LLM chat, embeddings, tool calling, multi-turn, response cache, cost observability, retry, and concurrency control via OpenAI, Ollama, or Mock
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
use async_trait::async_trait;
use futures::stream::BoxStream;
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::time::Duration;

use crate::error::LlmError;
use crate::provider::{
    ChatEvent, ChatMessage, ChatRequest, ChatRole, EmbedRequest, EmbedResponse, FinishReason,
    LlmProvider, LlmUsage,
};

/// Mock provider mode.
#[derive(Debug, Clone)]
pub enum MockMode {
    /// Echo user messages back verbatim.
    Echo,
    /// Return a fixed response.
    Fixed(String),
    /// Stream a partial delta then error — for mid-stream failure testing.
    Error(LlmError),
}

/// A mock LLM provider for testing.
///
/// # Modes
/// - `Echo`: streams back the concatenation of all user messages.
/// - `Fixed(String)`: streams back the given canned text.
/// - `Error(LlmError)`: sends one Delta event, then the error.
///
/// # Deterministic test controls
/// All optional, all default-off. Chain builder methods to configure:
/// - `with_delay`: sleep before emitting any events.
/// - `with_fail_after`: fail on the Nth call.
/// - `with_rate_limit`: always emit a RateLimit error.
/// - `call_count`: query how many times `chat_stream` has been called (always tracked).
/// - `with_concurrent_tracker`: track max in-flight `chat_stream`.
/// - `with_cancellation_tracking`: record whether a stream was dropped early.
pub struct MockProvider {
    id: String,
    mode: MockMode,
    default_model: String,
    /// Delay before emitting events.
    delay: Option<Duration>,
    /// Fail on the Nth invocation (1-based) with the given error.
    fail_after: Option<(usize, LlmError)>,
    /// Always emit a RateLimit error (after any delay), carrying retry_after.
    rate_limit: Option<Option<Duration>>,
    /// Call counter.
    calls: AtomicUsize,
    /// In-flight concurrent counter and peak.
    concurrent: Arc<AtomicUsize>,
    max_concurrent: Arc<AtomicUsize>,
    track_concurrent: bool,
    /// Whether any stream was cancelled (dropped before completion).
    cancelled: Arc<AtomicBool>,
    track_cancel: bool,
    /// Optional tool call to emit (id, name, arguments).
    tool_call: Option<(String, String, String)>,
    /// Records received ChatRequest messages for assertion in multi-turn tests.
    messages_recorder: Option<Arc<Mutex<Vec<ChatMessage>>>>,
}

// ---------------------------------------------------------------------------
// Drop guard that records cancellation when a stream is dropped mid-flight
// ---------------------------------------------------------------------------

struct CancelGuard {
    cancelled: Option<Arc<AtomicBool>>,
    finished: Arc<AtomicBool>,
}

impl Drop for CancelGuard {
    fn drop(&mut self) {
        let Some(b) = &self.cancelled else { return };
        if !self.finished.load(Ordering::SeqCst) {
            b.store(true, Ordering::SeqCst);
        }
    }
}

// ---------------------------------------------------------------------------
// RAII guard that increments concurrent on construction and decrements on Drop
// ---------------------------------------------------------------------------

struct ConcurrentGuard {
    concurrent: Arc<AtomicUsize>,
    track: bool,
}

impl ConcurrentGuard {
    fn new(concurrent: Arc<AtomicUsize>, max_concurrent: Arc<AtomicUsize>, track: bool) -> Self {
        if track {
            let cur = concurrent.fetch_add(1, Ordering::SeqCst) + 1;
            max_concurrent.fetch_max(cur, Ordering::SeqCst);
        }
        Self { concurrent, track }
    }
}

impl Drop for ConcurrentGuard {
    fn drop(&mut self) {
        if self.track {
            self.concurrent.fetch_sub(1, Ordering::SeqCst);
        }
    }
}

impl MockProvider {
    /// Create a mock provider with the given id and mode.
    ///
    /// The default model is `"mock-model"`.
    pub fn new(id: impl Into<String>, mode: MockMode) -> Self {
        Self {
            id: id.into(),
            mode,
            default_model: "mock-model".to_string(),
            delay: None,
            fail_after: None,
            rate_limit: None,
            calls: AtomicUsize::new(0),
            concurrent: Arc::new(AtomicUsize::new(0)),
            max_concurrent: Arc::new(AtomicUsize::new(0)),
            track_concurrent: false,
            cancelled: Arc::new(AtomicBool::new(false)),
            track_cancel: false,
            tool_call: None,
            messages_recorder: None,
        }
    }

    /// Set the default model.
    pub fn with_model(mut self, model: impl Into<String>) -> Self {
        self.default_model = model.into();
        self
    }

    /// Shortcut for `MockProvider::new("mock", MockMode::Echo)`.
    pub fn echo() -> Self {
        Self::new("mock", MockMode::Echo)
    }

    // -----------------------------------------------------------------------
    // Deterministic test controls
    // -----------------------------------------------------------------------

    /// Add a delay before emitting any events.
    pub fn with_delay(mut self, d: Duration) -> Self {
        self.delay = Some(d);
        self
    }

    /// Fail on the Nth invocation (1-based) with the given error.
    pub fn with_fail_after(mut self, n: usize, e: LlmError) -> Self {
        self.fail_after = Some((n, e));
        self
    }

    /// Always emit a `RateLimit` error.  `retry_after` is the duration the
    /// caller should wait before retrying (`None` means the provider did not
    /// specify a wait).
    pub fn with_rate_limit(mut self, retry_after: Option<Duration>) -> Self {
        self.rate_limit = Some(retry_after);
        self
    }

    /// Track the number of in-flight `chat_stream` invocations and the
    /// peak concurrent count.
    pub fn with_concurrent_tracker(mut self) -> Self {
        self.track_concurrent = true;
        self
    }

    /// Emit a `ChatEvent::ToolCall` followed by `ChatEvent::Finished`
    /// with `FinishReason::ToolCall` instead of a text delta.
    pub fn with_tool_call(
        mut self,
        id: impl Into<String>,
        name: impl Into<String>,
        args: impl Into<String>,
    ) -> Self {
        self.tool_call = Some((id.into(), name.into(), args.into()));
        self
    }

    /// Record received ChatRequest messages for assertion in multi-turn tests.
    pub fn with_messages_recorder(mut self, recorder: Arc<Mutex<Vec<ChatMessage>>>) -> Self {
        self.messages_recorder = Some(recorder);
        self
    }

    /// Track whether any stream produced by this provider was dropped
    /// (cancelled) before reaching a terminal event.
    pub fn with_cancellation_tracking(mut self) -> Self {
        self.track_cancel = true;
        self
    }

    /// Number of times `chat_stream` has been called.
    pub fn call_count(&self) -> usize {
        self.calls.load(Ordering::SeqCst)
    }

    /// Peak number of concurrent `chat_stream` invocations.
    pub fn max_concurrent(&self) -> usize {
        self.max_concurrent.load(Ordering::SeqCst)
    }

    /// Whether any stream was cancelled (dropped before completion).
    pub fn was_cancelled(&self) -> bool {
        self.cancelled.load(Ordering::SeqCst)
    }
}

#[async_trait]
impl LlmProvider for MockProvider {
    fn id(&self) -> &str {
        &self.id
    }

    fn default_model(&self) -> &str {
        &self.default_model
    }

    fn chat_stream(&self, req: ChatRequest) -> BoxStream<'static, Result<ChatEvent, LlmError>> {
        let n = self.calls.fetch_add(1, Ordering::SeqCst) + 1;
        let delay = self.delay;
        let fail = self
            .fail_after
            .as_ref()
            .and_then(|(at, e)| if n == *at { Some(e.clone()) } else { None });
        let rl = self
            .rate_limit
            .map(|retry_after| LlmError::RateLimit { retry_after });

        let concurrent = Arc::clone(&self.concurrent);
        let max_concurrent = Arc::clone(&self.max_concurrent);
        let cancelled = Arc::clone(&self.cancelled);
        let track_concurrent = self.track_concurrent;
        let track_cancel = self.track_cancel;
        let mode = self.mode.clone();
        let model = req.model.clone();
        let tool_call = self.tool_call.clone();
        let messages_recorder = self.messages_recorder.clone();

        let s = async_stream::stream! {
            // Record received messages before processing the stream.
            if let Some(ref recorder) = messages_recorder {
                let mut guard = recorder.lock().expect("messages_recorder poisoned"); // allow-unwrap
                guard.extend(req.messages.clone());
            }

            // Guards at the TOP so they cover delay and every exit path.
            let _conc_guard = ConcurrentGuard::new(
                Arc::clone(&concurrent),
                Arc::clone(&max_concurrent),
                track_concurrent,
            );
            let finished = Arc::new(AtomicBool::new(false));
            let _cancel_guard = CancelGuard {
                cancelled: track_cancel.then(|| Arc::clone(&cancelled)),
                finished: Arc::clone(&finished),
            };

            if let Some(d) = delay {
                tokio::time::sleep(d).await;
            }

            // Rate-limit simulation (always fires if configured)
            if let Some(e) = rl {
                finished.store(true, Ordering::SeqCst);
                yield Err(e);
                return;
            }

            // Fail-after simulation
            if let Some(e) = fail {
                finished.store(true, Ordering::SeqCst);
                yield Err(e);
                return;
            }

            // Tool call mode — emit ToolCall then Finished with ToolCall reason
            if let Some((ref tc_id, ref tc_name, ref tc_args)) = tool_call {
                yield Ok(ChatEvent::ToolCall {
                    id: tc_id.clone(),
                    name: tc_name.clone(),
                    arguments: tc_args.clone(),
                });
                finished.store(true, Ordering::SeqCst);
                yield Ok(ChatEvent::Finished {
                    usage: Some(LlmUsage {
                        prompt_tokens: 1,
                        completion_tokens: 0,
                        total_tokens: 1,
                    }),
                    model: Some(model),
                    finish_reason: Some(FinishReason::ToolCall),
                    metadata: serde_json::Map::new(),
                });
                return;
            }

            let text = match &mode {
                MockMode::Echo => req
                    .messages
                    .iter()
                    .filter(|m| matches!(m.role, ChatRole::User))
                    .map(|m| m.content.as_str())
                    .collect::<Vec<_>>()
                    .join(" "),
                MockMode::Fixed(t) => t.clone(),
                MockMode::Error(e) => {
                    yield Ok(ChatEvent::Delta { text: "partial".into() });
                    finished.store(true, Ordering::SeqCst);
                    yield Err(e.clone());
                    return;
                }
            };

            let pt = text.len() as u32 / 4;
            yield Ok(ChatEvent::Delta { text });
            finished.store(true, Ordering::SeqCst);
            yield Ok(ChatEvent::Finished {
                usage: Some(LlmUsage {
                    prompt_tokens: pt,
                    completion_tokens: pt,
                    total_tokens: pt * 2,
                }),
                model: Some(model),
                finish_reason: Some(FinishReason::Stop),
                metadata: serde_json::Map::new(),
            });
        };
        Box::pin(s)
    }

    async fn embed(&self, req: EmbedRequest) -> Result<EmbedResponse, LlmError> {
        let n = self.calls.fetch_add(1, Ordering::SeqCst) + 1;

        // Delay before error checks (same ordering as chat_stream —
        // simulates network latency before the response is determined).
        if let Some(d) = self.delay {
            tokio::time::sleep(d).await;
        }

        // Rate-limit simulation (always fires if configured).
        if let Some(retry_after) = self.rate_limit {
            return Err(LlmError::RateLimit { retry_after });
        }

        // Check fail_after (same semantics as chat_stream).
        if let Some((at, ref e)) = self.fail_after
            && n == at
        {
            return Err(e.clone());
        }

        let embeddings: Vec<Vec<f32>> = req
            .inputs
            .iter()
            .map(|input| {
                let hash = input
                    .bytes()
                    .fold(0u32, |acc, b| acc.wrapping_mul(31).wrapping_add(b as u32));
                (0..16).map(|i| ((hash >> i) & 1) as f32).collect()
            })
            .collect();

        let prompt_tokens: u32 = req.inputs.iter().map(|i| i.len() as u32 / 4).sum();
        Ok(EmbedResponse {
            embeddings,
            usage: Some(LlmUsage {
                prompt_tokens,
                completion_tokens: 0,
                total_tokens: prompt_tokens,
            }),
            model: req.model,
            metadata: serde_json::Map::new(),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::provider::ChatMessage;
    use futures::StreamExt;
    use std::sync::Arc;
    use std::time::Duration;

    #[tokio::test]
    async fn echo_provider_streams_prompt_back() {
        let provider = MockProvider::new("test", MockMode::Echo);
        let req = ChatRequest::new("mock-model", vec![ChatMessage::user("hello world")]);
        let mut stream = provider.chat_stream(req);

        let mut text = String::new();
        while let Some(event) = stream.next().await {
            match event.expect("stream ok") {
                ChatEvent::Delta { text: t } => text.push_str(&t),
                ChatEvent::ToolCall { .. } => {}
                ChatEvent::Finished { .. } => {}
            }
        }
        assert_eq!(text, "hello world");
    }

    #[tokio::test]
    async fn fixed_provider_returns_fixed_text() {
        let provider = MockProvider::new("test", MockMode::Fixed("canned response".into()));
        let req = ChatRequest::new("mock-model", vec![ChatMessage::user("anything")]);
        let mut stream = provider.chat_stream(req);

        let mut text = String::new();
        while let Some(event) = stream.next().await {
            match event.expect("stream ok") {
                ChatEvent::Delta { text: t } => text.push_str(&t),
                ChatEvent::ToolCall { .. } => {}
                ChatEvent::Finished { .. } => {}
            }
        }
        assert_eq!(text, "canned response");
    }

    #[tokio::test]
    async fn mock_provider_embeds() {
        let provider = MockProvider::new("test", MockMode::Fixed("irrelevant".into()));
        let req = EmbedRequest::new("mock-model", vec!["hello".into()]);
        let resp = provider.embed(req).await.expect("embed ok");
        assert_eq!(resp.embeddings.len(), 1);
        assert_eq!(
            resp.embeddings[0].len(),
            16,
            "embedding must be 16-dimensional"
        );
        // Verify binary range (all values are 0.0 or 1.0)
        for &val in &resp.embeddings[0] {
            assert!(
                val == 0.0 || val == 1.0,
                "embedding value must be binary, got {val}"
            );
        }
        // Verify determinism: same input → same output
        let req2 = EmbedRequest::new("mock-model", vec!["hello".into()]);
        let resp2 = provider.embed(req2).await.expect("embed ok 2");
        assert_eq!(
            resp.embeddings[0], resp2.embeddings[0],
            "embeddings must be deterministic"
        );
    }

    #[tokio::test]
    async fn error_mode_emits_partial_then_error() {
        let provider = MockProvider::new(
            "test",
            MockMode::Error(LlmError::ProviderUnavailable("service down".into())),
        );
        let req = ChatRequest::new("mock-model", vec![ChatMessage::user("hello")]);
        let mut stream = provider.chat_stream(req);

        let mut events = Vec::new();
        while let Some(event) = stream.next().await {
            events.push(event);
        }

        assert_eq!(events.len(), 2, "should emit exactly 2 events");
        assert!(matches!(events[0], Ok(ChatEvent::Delta { ref text }) if text == "partial"));
        assert!(matches!(events[1], Err(LlmError::ProviderUnavailable(_))));
    }

    #[tokio::test]
    async fn finished_event_has_usage() {
        let provider = MockProvider::new("test", MockMode::Fixed("hi".into()));
        let req = ChatRequest::new("mock-model", vec![ChatMessage::user("hi")]);
        let mut stream = provider.chat_stream(req);

        let mut found_usage = false;
        while let Some(event) = stream.next().await {
            if let ChatEvent::Finished { usage, .. } = event.expect("ok") {
                assert!(usage.is_some());
                found_usage = true;
            }
        }
        assert!(found_usage);
    }

    #[tokio::test]
    async fn delay_mode_emits_events_after_delay() {
        let provider = MockProvider::new("t", MockMode::Fixed("hi".into()))
            .with_delay(Duration::from_millis(50));
        let start = std::time::Instant::now();
        let mut s = provider.chat_stream(ChatRequest::new("m", vec![ChatMessage::user("x")]));
        while s.next().await.is_some() {}
        assert!(start.elapsed() >= Duration::from_millis(45));
    }

    #[tokio::test]
    async fn fail_after_succeeds_then_fails_at_n() {
        let provider = MockProvider::new("t", MockMode::Fixed("ok".into()))
            .with_fail_after(2, LlmError::Network("boom".into()));
        let r1 = collect_chat(&provider).await;
        let r2 = collect_chat(&provider).await;
        assert!(r1.is_ok());
        assert!(matches!(r2.unwrap_err(), LlmError::Network(_)));
    }

    #[tokio::test]
    async fn rate_limit_mode_carries_retry_after() {
        let provider = MockProvider::new("t", MockMode::Fixed("ok".into()))
            .with_rate_limit(Some(Duration::from_millis(10)));
        let err = collect_chat(&provider).await.unwrap_err();
        assert!(matches!(
            err,
            LlmError::RateLimit {
                retry_after: Some(_)
            }
        ));
    }

    #[tokio::test]
    async fn call_count_tracks_invocations() {
        let provider = MockProvider::echo();
        let _ = collect_chat(&provider).await;
        let _ = collect_chat(&provider).await;
        assert_eq!(provider.call_count(), 2);
    }

    #[tokio::test]
    async fn concurrent_tracker_peaks_at_inflight() {
        let provider = MockProvider::new("t", MockMode::Fixed("ok".into()))
            .with_delay(Duration::from_millis(50))
            .with_concurrent_tracker();
        let p = Arc::new(provider);
        let mut handles = vec![];
        for _ in 0..3 {
            let p = Arc::clone(&p);
            handles.push(tokio::spawn(async move { collect_chat(&p).await }));
        }
        for h in handles {
            let _ = h.await;
        }
        assert!(p.max_concurrent() >= 2);
    }

    #[tokio::test]
    async fn cancellation_tracker_records_drop() {
        let provider = MockProvider::new("t", MockMode::Fixed("ok".into()))
            .with_delay(Duration::from_millis(100))
            .with_cancellation_tracking();
        let mut s = provider.chat_stream(ChatRequest::new("m", vec![ChatMessage::user("x")]));
        let _ = s.next().await;
        drop(s);
        assert!(provider.was_cancelled());
    }

    #[tokio::test]
    async fn completed_stream_not_marked_cancelled() {
        let provider =
            MockProvider::new("t", MockMode::Fixed("ok".into())).with_cancellation_tracking();
        let mut s = provider.chat_stream(ChatRequest::new("m", vec![ChatMessage::user("x")]));
        while s.next().await.is_some() {} // drain to completion
        assert!(
            !provider.was_cancelled(),
            "a fully-consumed stream must NOT report cancellation"
        );
    }

    async fn collect_chat(p: &MockProvider) -> Result<(), LlmError> {
        let mut s = p.chat_stream(ChatRequest::new("m", vec![ChatMessage::user("x")]));
        while let Some(ev) = s.next().await {
            ev?;
        }
        Ok(())
    }
}