heartbit-core 2026.507.2

The Rust agentic framework — agents, tools, LLM providers, memory, evaluation.
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
//! Embedding providers for semantic memory retrieval.

#![allow(missing_docs)]
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;

use serde::Deserialize;

use crate::auth::TenantScope;
use crate::error::Error;

use super::{Memory, MemoryEntry};

/// Trait for generating text embeddings.
#[allow(clippy::type_complexity)]
pub trait EmbeddingProvider: Send + Sync {
    fn embed(
        &self,
        texts: &[&str],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>>;

    fn dimension(&self) -> usize;
}

/// No-op embedding provider — returns empty results.
/// Used when no embedding API is configured (graceful degradation).
pub struct NoopEmbedding;

impl EmbeddingProvider for NoopEmbedding {
    fn embed(
        &self,
        texts: &[&str],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>> {
        let len = texts.len();
        Box::pin(async move { Ok(vec![vec![]; len]) })
    }

    fn dimension(&self) -> usize {
        0
    }
}

/// OpenAI-compatible embedding provider.
///
/// Calls `POST /v1/embeddings` with the configured model.
/// Works with OpenAI API and compatible endpoints.
pub struct OpenAiEmbedding {
    client: reqwest::Client,
    api_key: String,
    model: String,
    base_url: String,
    dimension: usize,
}

impl OpenAiEmbedding {
    /// Create an `OpenAiEmbedding` provider.
    ///
    /// SECURITY (F-MEM-4): the HTTP client is hardened with
    /// `redirect::Policy::none()`, `https_only(true)`,
    /// `connect_timeout(10s)`, `timeout(60s)`, and `.no_proxy()`. Without
    /// these, a slow-loris embedding endpoint wedges every `memory_store`,
    /// and a redirect to a non-HTTPS host would leak the Bearer API key.
    pub fn new(api_key: impl Into<String>, model: impl Into<String>) -> Self {
        let model = model.into();
        let dimension = match model.as_str() {
            "text-embedding-3-small" => 1536,
            "text-embedding-3-large" => 3072,
            "text-embedding-ada-002" => 1536,
            _ => 1536, // default
        };
        let client = reqwest::Client::builder()
            .redirect(reqwest::redirect::Policy::none())
            .https_only(true)
            .no_proxy()
            .connect_timeout(std::time::Duration::from_secs(10))
            .timeout(std::time::Duration::from_secs(60))
            .build()
            .expect("failed to build hardened HTTPS client for OpenAiEmbedding");
        Self {
            client,
            api_key: api_key.into(),
            model,
            base_url: "https://api.openai.com".into(),
            dimension,
        }
    }

    /// Override the base URL.
    ///
    /// SECURITY (F-MEM-4): the URL must be HTTPS — `https_only(true)` is
    /// already set on the client, so a plaintext URL here will fail at
    /// request time. For local non-secret endpoints (Ollama embeddings,
    /// vLLM), build a separate provider with a custom client.
    pub fn with_base_url(mut self, base_url: impl Into<String>) -> Self {
        self.base_url = base_url.into();
        self
    }

    pub fn with_dimension(mut self, dimension: usize) -> Self {
        self.dimension = dimension;
        self
    }
}

#[derive(Deserialize)]
struct EmbeddingResponse {
    data: Vec<EmbeddingData>,
}

#[derive(Deserialize)]
struct EmbeddingData {
    embedding: Vec<f32>,
}

impl EmbeddingProvider for OpenAiEmbedding {
    fn embed(
        &self,
        texts: &[&str],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>> {
        let input: Vec<String> = texts.iter().map(|t| t.to_string()).collect();
        Box::pin(async move {
            if input.is_empty() {
                return Ok(vec![]);
            }

            let body = serde_json::json!({
                "model": self.model,
                "input": input,
            });

            let resp = self
                .client
                .post(format!("{}/v1/embeddings", self.base_url))
                .header("Authorization", format!("Bearer {}", self.api_key))
                .header("Content-Type", "application/json")
                .json(&body)
                .send()
                .await
                .map_err(|e| Error::Memory(format!("embedding request failed: {e}")))?;

            if !resp.status().is_success() {
                let status = resp.status();
                let text = resp.text().await.unwrap_or_else(|_| "unknown error".into());
                return Err(Error::Memory(format!(
                    "embedding API returned {status}: {text}"
                )));
            }

            let response: EmbeddingResponse = resp
                .json()
                .await
                .map_err(|e| Error::Memory(format!("failed to parse embedding response: {e}")))?;

            Ok(response.data.into_iter().map(|d| d.embedding).collect())
        })
    }

    fn dimension(&self) -> usize {
        self.dimension
    }
}

/// Decorator that generates embeddings on store and passes through to inner Memory.
///
/// When storing a `MemoryEntry` without an embedding, this wrapper generates
/// one via the configured `EmbeddingProvider` before delegating to the inner store.
/// All other operations pass through unchanged.
pub struct EmbeddingMemory {
    inner: Arc<dyn Memory>,
    embedder: Arc<dyn EmbeddingProvider>,
}

impl EmbeddingMemory {
    pub fn new(inner: Arc<dyn Memory>, embedder: Arc<dyn EmbeddingProvider>) -> Self {
        Self { inner, embedder }
    }
}

impl Memory for EmbeddingMemory {
    fn store(
        &self,
        scope: &TenantScope,
        entry: MemoryEntry,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>> {
        let scope = scope.clone();
        Box::pin(async move {
            let mut entry = entry;
            // Only generate embedding if not already present and embedder is real (dimension > 0)
            if entry.embedding.is_none() && self.embedder.dimension() > 0 {
                match self.embedder.embed(&[&entry.content]).await {
                    Ok(mut embeddings) if !embeddings.is_empty() => {
                        let emb = embeddings.swap_remove(0);
                        if !emb.is_empty() {
                            entry.embedding = Some(emb);
                        }
                    }
                    Ok(_) => {} // empty result, skip
                    Err(e) => {
                        // Log but don't fail — embedding is optional
                        tracing::warn!("failed to generate embedding for memory {}: {e}", entry.id);
                    }
                }
            }
            self.inner.store(&scope, entry).await
        })
    }

    fn recall(
        &self,
        scope: &TenantScope,
        query: super::MemoryQuery,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<MemoryEntry>, Error>> + Send + '_>> {
        let scope = scope.clone();
        Box::pin(async move {
            let mut query = query;
            // Generate query embedding for hybrid retrieval when text is present
            // and no embedding was already provided.
            if query.query_embedding.is_none()
                && query.text.is_some()
                && self.embedder.dimension() > 0
            {
                let text = query.text.as_deref().unwrap_or_default();
                match self.embedder.embed(&[text]).await {
                    Ok(mut embeddings) if !embeddings.is_empty() => {
                        let emb = embeddings.swap_remove(0);
                        if !emb.is_empty() {
                            query.query_embedding = Some(emb);
                        }
                    }
                    Ok(_) => {}
                    Err(e) => {
                        // Log but don't fail — fall back to BM25-only
                        tracing::warn!("failed to generate query embedding: {e}");
                    }
                }
            }
            self.inner.recall(&scope, query).await
        })
    }

    fn update(
        &self,
        scope: &TenantScope,
        id: &str,
        content: String,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>> {
        let scope = scope.clone();
        let id = id.to_string();
        Box::pin(async move { self.inner.update(&scope, &id, content).await })
    }

    fn forget(
        &self,
        scope: &TenantScope,
        id: &str,
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + '_>> {
        let scope = scope.clone();
        let id = id.to_string();
        Box::pin(async move { self.inner.forget(&scope, &id).await })
    }

    fn add_link(
        &self,
        scope: &TenantScope,
        id: &str,
        related_id: &str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>> {
        let scope = scope.clone();
        let id = id.to_string();
        let related_id = related_id.to_string();
        Box::pin(async move { self.inner.add_link(&scope, &id, &related_id).await })
    }

    fn prune(
        &self,
        scope: &TenantScope,
        min_strength: f64,
        min_age: chrono::Duration,
        agent_prefix: Option<&str>,
    ) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + Send + '_>> {
        let scope = scope.clone();
        let agent_prefix = agent_prefix.map(String::from);
        Box::pin(async move {
            self.inner
                .prune(&scope, min_strength, min_age, agent_prefix.as_deref())
                .await
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::memory::in_memory::InMemoryStore;
    use crate::memory::{Confidentiality, MemoryEntry, MemoryQuery, MemoryType};
    use chrono::Utc;

    fn test_scope() -> TenantScope {
        TenantScope::default()
    }

    fn make_entry(id: &str, content: &str) -> MemoryEntry {
        MemoryEntry {
            id: id.into(),
            agent: "test".into(),
            content: content.into(),
            category: "fact".into(),
            tags: vec![],
            created_at: Utc::now(),
            last_accessed: Utc::now(),
            access_count: 0,
            importance: 5,
            memory_type: MemoryType::default(),
            keywords: vec![],
            summary: None,
            strength: 1.0,
            related_ids: vec![],
            source_ids: vec![],
            embedding: None,
            confidentiality: Confidentiality::default(),
            author_user_id: None,
            author_tenant_id: None,
        }
    }

    #[test]
    fn noop_embedding_returns_empty() {
        let noop = NoopEmbedding;
        assert_eq!(noop.dimension(), 0);
        let rt = tokio::runtime::Builder::new_current_thread()
            .build()
            .unwrap();
        let result = rt.block_on(noop.embed(&["hello", "world"])).unwrap();
        assert_eq!(result.len(), 2);
        assert!(result[0].is_empty());
        assert!(result[1].is_empty());
    }

    #[test]
    fn embedding_provider_is_object_safe() {
        fn _accepts_dyn(_p: &dyn EmbeddingProvider) {}
    }

    #[test]
    fn embedding_memory_is_send_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<EmbeddingMemory>();
    }

    #[tokio::test]
    async fn noop_embedding_skips_embedding_on_store() {
        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(NoopEmbedding);
        let em = EmbeddingMemory::new(store.clone(), embedder);

        em.store(&test_scope(), make_entry("m1", "test content"))
            .await
            .unwrap();

        let results = store
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();
        assert_eq!(results.len(), 1);
        assert!(results[0].embedding.is_none());
    }

    /// Fake embedding provider for testing that returns deterministic vectors.
    struct FakeEmbedding;

    impl EmbeddingProvider for FakeEmbedding {
        fn embed(
            &self,
            texts: &[&str],
        ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>> {
            let results: Vec<Vec<f32>> = texts
                .iter()
                .map(|t| {
                    // Simple deterministic embedding: first 4 bytes as f32 values
                    let bytes = t.as_bytes();
                    vec![
                        bytes.first().copied().unwrap_or(0) as f32 / 255.0,
                        bytes.get(1).copied().unwrap_or(0) as f32 / 255.0,
                        bytes.get(2).copied().unwrap_or(0) as f32 / 255.0,
                    ]
                })
                .collect();
            Box::pin(async move { Ok(results) })
        }

        fn dimension(&self) -> usize {
            3
        }
    }

    #[tokio::test]
    async fn embedding_memory_generates_embedding_on_store() {
        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(FakeEmbedding);
        let em = EmbeddingMemory::new(store.clone(), embedder);

        em.store(&test_scope(), make_entry("m1", "hello"))
            .await
            .unwrap();

        let results = store
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();
        assert_eq!(results.len(), 1);
        let emb = results[0]
            .embedding
            .as_ref()
            .expect("embedding should be set");
        assert_eq!(emb.len(), 3);
    }

    #[tokio::test]
    async fn embedding_memory_preserves_existing_embedding() {
        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(FakeEmbedding);
        let em = EmbeddingMemory::new(store.clone(), embedder);

        let mut entry = make_entry("m1", "hello");
        entry.embedding = Some(vec![9.0, 8.0, 7.0]);
        em.store(&test_scope(), entry).await.unwrap();

        let results = store
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();
        let emb = results[0].embedding.as_ref().unwrap();
        // Should keep original, not overwrite with FakeEmbedding output
        assert!((emb[0] - 9.0).abs() < f32::EPSILON);
    }

    #[tokio::test]
    async fn embedding_memory_delegates_recall() {
        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(NoopEmbedding);
        let em = EmbeddingMemory::new(store.clone(), embedder);

        store
            .store(&test_scope(), make_entry("m1", "test"))
            .await
            .unwrap();
        let results = em
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].id, "m1");
    }

    #[tokio::test]
    async fn embedding_memory_generates_query_embedding_on_recall() {
        // When EmbeddingMemory wraps a store and query has text,
        // it should generate a query embedding for hybrid retrieval.
        use std::sync::atomic::{AtomicBool, Ordering};

        // Tracking embedding provider that records whether embed() was called
        struct TrackingEmbedding {
            called: Arc<AtomicBool>,
        }

        impl EmbeddingProvider for TrackingEmbedding {
            fn embed(
                &self,
                _texts: &[&str],
            ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>>
            {
                self.called.store(true, Ordering::SeqCst);
                Box::pin(async { Ok(vec![vec![0.5, 0.5, 0.5]]) })
            }

            fn dimension(&self) -> usize {
                3
            }
        }

        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let called = Arc::new(AtomicBool::new(false));
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(TrackingEmbedding {
            called: called.clone(),
        });
        let em = EmbeddingMemory::new(store.clone(), embedder);

        store
            .store(&test_scope(), make_entry("m1", "hello world"))
            .await
            .unwrap();

        // Recall with text query should trigger embedding generation
        let _results = em
            .recall(
                &test_scope(),
                MemoryQuery {
                    text: Some("hello".into()),
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();

        assert!(
            called.load(Ordering::SeqCst),
            "embed() should have been called for query text"
        );
    }

    #[tokio::test]
    async fn embedding_memory_skips_query_embedding_without_text() {
        use std::sync::atomic::{AtomicBool, Ordering};

        struct TrackingEmbedding {
            called: Arc<AtomicBool>,
        }

        impl EmbeddingProvider for TrackingEmbedding {
            fn embed(
                &self,
                _texts: &[&str],
            ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + '_>>
            {
                self.called.store(true, Ordering::SeqCst);
                Box::pin(async { Ok(vec![vec![0.5, 0.5, 0.5]]) })
            }

            fn dimension(&self) -> usize {
                3
            }
        }

        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let called = Arc::new(AtomicBool::new(false));
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(TrackingEmbedding {
            called: called.clone(),
        });
        let em = EmbeddingMemory::new(store.clone(), embedder);

        store
            .store(&test_scope(), make_entry("m1", "hello world"))
            .await
            .unwrap();

        // Recall WITHOUT text query should NOT generate embedding
        let _results = em
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();

        assert!(
            !called.load(Ordering::SeqCst),
            "embed() should NOT be called when no text query"
        );
    }

    #[tokio::test]
    async fn embedding_memory_delegates_forget() {
        let store: Arc<dyn Memory> = Arc::new(InMemoryStore::new());
        let embedder: Arc<dyn EmbeddingProvider> = Arc::new(NoopEmbedding);
        let em = EmbeddingMemory::new(store.clone(), embedder);

        store
            .store(&test_scope(), make_entry("m1", "test"))
            .await
            .unwrap();
        let removed = em.forget(&test_scope(), "m1").await.unwrap();
        assert!(removed);

        let results = store
            .recall(
                &test_scope(),
                MemoryQuery {
                    limit: 10,
                    ..Default::default()
                },
            )
            .await
            .unwrap();
        assert!(results.is_empty());
    }
}