mentra-provider 0.8.0

Shared provider core for Mentra
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
use async_trait::async_trait;
use std::collections::HashMap;
use std::sync::Arc;

use crate::definition::ProviderDefinition;
use crate::definition::ProviderDescriptor;
use crate::definition::ProviderId;
use crate::error::ProviderError;
use crate::model::ModelInfo;
use crate::request::CompactionRequest;
use crate::request::MemorySummarizeRequest;
use crate::request::Request;
use crate::response::CompactionResponse;
use crate::response::MemorySummarizeResponse;
use crate::response::Response;
use crate::response::collect_response_from_stream;
use crate::stream::ProviderEventStream;

/// Lists models available from a provider.
#[async_trait]
pub trait ModelCatalog: Send + Sync {
    async fn list_models(&self) -> Result<Vec<ModelInfo>, ProviderError>;
}

/// Creates a provider session on demand.
#[async_trait]
pub trait ProviderSessionFactory: Send + Sync {
    async fn create_session(&self) -> Result<Box<dyn ProviderSession>, ProviderError>;
}

/// Transport-neutral session used to stream model responses.
#[async_trait]
pub trait ProviderSession: Send + Sync {
    async fn stream(&self, request: Request<'_>) -> Result<ProviderEventStream, ProviderError>;

    async fn send(&self, request: Request<'_>) -> Result<Response, ProviderError> {
        collect_response_from_stream(self.stream(request).await?).await
    }

    async fn compact(
        &self,
        _request: CompactionRequest<'_>,
    ) -> Result<CompactionResponse, ProviderError> {
        Err(ProviderError::UnsupportedCapability(
            "history_compaction".to_string(),
        ))
    }

    async fn summarize_memories(
        &self,
        _request: MemorySummarizeRequest<'_>,
    ) -> Result<MemorySummarizeResponse, ProviderError> {
        Err(ProviderError::UnsupportedCapability(
            "memory_summarization".to_string(),
        ))
    }
}

/// Transport-neutral provider registration interface.
#[async_trait]
pub trait Provider: ModelCatalog + ProviderSessionFactory {
    fn definition(&self) -> ProviderDefinition;

    fn descriptor(&self) -> ProviderDescriptor {
        self.definition().descriptor
    }

    /// Returns the same configured provider with an independent session scope.
    ///
    /// Creating a scope is a synchronous, local operation: it must not open a
    /// connection or otherwise perform network I/O. Ordinary clones of the
    /// returned value share that one scope; calling this method again creates a
    /// different one. Implementations must preserve their provider definition,
    /// including its descriptor identity.
    ///
    /// Providers that do not define how to separate configuration from session
    /// state remain usable for one-shot runtimes and report this capability as
    /// unsupported.
    fn fresh_session_scope(&self) -> Result<ProviderSessionScope, ProviderError> {
        Err(ProviderError::UnsupportedCapability(
            "fresh_session_scope".to_string(),
        ))
    }

    async fn stream(&self, request: Request<'_>) -> Result<ProviderEventStream, ProviderError> {
        self.create_session().await?.stream(request).await
    }

    async fn send(&self, request: Request<'_>) -> Result<Response, ProviderError> {
        collect_response_from_stream(self.stream(request).await?).await
    }

    async fn compact(
        &self,
        request: CompactionRequest<'_>,
    ) -> Result<CompactionResponse, ProviderError> {
        self.create_session().await?.compact(request).await
    }

    async fn summarize_memories(
        &self,
        request: MemorySummarizeRequest<'_>,
    ) -> Result<MemorySummarizeResponse, ProviderError> {
        self.create_session()
            .await?
            .summarize_memories(request)
            .await
    }
}

/// One provider bound to one provider-owned session-state scope.
///
/// Cloning this value deliberately shares the current scope. Use
/// [`Provider::fresh_session_scope`] to retain the provider configuration while
/// allocating independent turn, response-chain, connection, and in-flight
/// state.
#[derive(Clone)]
pub struct ProviderSessionScope {
    inner: Arc<dyn Provider>,
}

impl ProviderSessionScope {
    /// Wraps a provider whose current session state is the scope to share.
    pub fn new<P>(provider: P) -> Self
    where
        P: Provider + 'static,
    {
        Self {
            inner: Arc::new(provider),
        }
    }
}

#[async_trait]
impl ModelCatalog for ProviderSessionScope {
    async fn list_models(&self) -> Result<Vec<ModelInfo>, ProviderError> {
        self.inner.list_models().await
    }
}

#[async_trait]
impl ProviderSessionFactory for ProviderSessionScope {
    async fn create_session(&self) -> Result<Box<dyn ProviderSession>, ProviderError> {
        self.inner.create_session().await
    }
}

#[async_trait]
impl Provider for ProviderSessionScope {
    fn definition(&self) -> ProviderDefinition {
        self.inner.definition()
    }

    fn descriptor(&self) -> ProviderDescriptor {
        self.inner.descriptor()
    }

    fn fresh_session_scope(&self) -> Result<ProviderSessionScope, ProviderError> {
        self.inner.fresh_session_scope()
    }

    async fn stream(&self, request: Request<'_>) -> Result<ProviderEventStream, ProviderError> {
        self.inner.stream(request).await
    }

    async fn send(&self, request: Request<'_>) -> Result<Response, ProviderError> {
        self.inner.send(request).await
    }

    async fn compact(
        &self,
        request: CompactionRequest<'_>,
    ) -> Result<CompactionResponse, ProviderError> {
        self.inner.compact(request).await
    }

    async fn summarize_memories(
        &self,
        request: MemorySummarizeRequest<'_>,
    ) -> Result<MemorySummarizeResponse, ProviderError> {
        self.inner.summarize_memories(request).await
    }
}

pub use Provider as RegisteredProvider;

#[derive(Default)]
pub struct ProviderRegistry {
    default_provider: Option<ProviderId>,
    providers: HashMap<ProviderId, Arc<dyn Provider>>,
}

impl ProviderRegistry {
    pub fn register_provider_instance<P>(&mut self, provider: P)
    where
        P: Provider + 'static,
    {
        let definition = provider.definition();
        let id = definition.descriptor.id.clone();

        if self.default_provider.is_none() {
            self.default_provider = Some(id.clone());
        }

        self.providers.insert(id, Arc::new(provider));
    }

    pub fn get_provider(&self, id: Option<&ProviderId>) -> Option<Arc<dyn Provider>> {
        match id {
            Some(id) => self.providers.get(id).cloned(),
            None => self
                .default_provider
                .as_ref()
                .and_then(|id| self.providers.get(id).cloned()),
        }
    }

    pub fn definitions(&self) -> Vec<ProviderDefinition> {
        self.providers
            .values()
            .map(|provider| provider.definition())
            .collect()
    }

    pub fn descriptors(&self) -> Vec<ProviderDescriptor> {
        self.providers
            .values()
            .map(|provider| provider.descriptor())
            .collect()
    }

    pub fn is_empty(&self) -> bool {
        self.providers.is_empty()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use async_trait::async_trait;
    use std::sync::atomic::{AtomicUsize, Ordering};
    use tokio::sync::mpsc;

    #[derive(Clone)]
    struct TestProvider {
        definition: ProviderDefinition,
        models: Vec<ModelInfo>,
    }

    struct TestSession;

    #[derive(Clone)]
    struct RefreshableProvider {
        definition: ProviderDefinition,
        models: Vec<ModelInfo>,
        fresh_scopes: Arc<AtomicUsize>,
    }

    #[async_trait]
    impl ModelCatalog for TestProvider {
        async fn list_models(&self) -> Result<Vec<ModelInfo>, ProviderError> {
            Ok(self.models.clone())
        }
    }

    #[async_trait]
    impl ProviderSessionFactory for TestProvider {
        async fn create_session(&self) -> Result<Box<dyn ProviderSession>, ProviderError> {
            Ok(Box::new(TestSession))
        }
    }

    #[async_trait]
    impl Provider for TestProvider {
        fn definition(&self) -> ProviderDefinition {
            self.definition.clone()
        }
    }

    #[async_trait]
    impl ModelCatalog for RefreshableProvider {
        async fn list_models(&self) -> Result<Vec<ModelInfo>, ProviderError> {
            Ok(self.models.clone())
        }
    }

    #[async_trait]
    impl ProviderSessionFactory for RefreshableProvider {
        async fn create_session(&self) -> Result<Box<dyn ProviderSession>, ProviderError> {
            Ok(Box::new(TestSession))
        }
    }

    #[async_trait]
    impl Provider for RefreshableProvider {
        fn definition(&self) -> ProviderDefinition {
            self.definition.clone()
        }

        fn descriptor(&self) -> ProviderDescriptor {
            let mut descriptor = self.definition.descriptor.clone();
            descriptor.description = Some("delegated descriptor".to_string());
            descriptor
        }

        fn fresh_session_scope(&self) -> Result<ProviderSessionScope, ProviderError> {
            self.fresh_scopes.fetch_add(1, Ordering::SeqCst);
            Ok(ProviderSessionScope::new(self.clone()))
        }
    }

    #[async_trait]
    impl ProviderSession for TestSession {
        async fn stream(
            &self,
            _request: Request<'_>,
        ) -> Result<ProviderEventStream, ProviderError> {
            let (_tx, rx) = mpsc::unbounded_channel();
            Ok(rx)
        }
    }

    #[tokio::test]
    async fn registry_returns_registered_provider_descriptors() {
        let mut registry = ProviderRegistry::default();
        let provider = TestProvider {
            definition: ProviderDefinition::new("test-provider"),
            models: vec![ModelInfo::new("model-1", "test-provider")],
        };

        registry.register_provider_instance(provider);

        assert_eq!(registry.descriptors().len(), 1);
        assert_eq!(registry.definitions().len(), 1);
        assert_eq!(
            registry
                .get_provider(None)
                .expect("provider should exist")
                .definition()
                .descriptor
                .id
                .as_str(),
            "test-provider"
        );
    }

    #[test]
    fn an_arbitrary_provider_is_not_reusable_without_an_explicit_scope_contract() {
        let provider = TestProvider {
            definition: ProviderDefinition::new("one-shot"),
            models: Vec::new(),
        };
        let provider: &dyn Provider = &provider;

        let error = provider
            .fresh_session_scope()
            .err()
            .expect("a provider cannot claim freshness by default");

        assert!(matches!(
            error,
            ProviderError::UnsupportedCapability(capability)
                if capability == "fresh_session_scope"
        ));
    }

    #[tokio::test]
    async fn a_scope_clone_shares_its_provider_while_freshening_delegates_repeatedly() {
        let model = ModelInfo::new("model-1", "refreshable");
        let fresh_scopes = Arc::new(AtomicUsize::new(0));
        let scope = ProviderSessionScope::new(RefreshableProvider {
            definition: ProviderDefinition::new("refreshable"),
            models: vec![model.clone()],
            fresh_scopes: Arc::clone(&fresh_scopes),
        });
        let shared = scope.clone();

        assert!(Arc::ptr_eq(&scope.inner, &shared.inner));

        let first = scope
            .fresh_session_scope()
            .expect("the provider mints its first independent scope");
        let second = first
            .fresh_session_scope()
            .expect("the wrapper delegates repeated freshening");

        assert!(!Arc::ptr_eq(&scope.inner, &first.inner));
        assert!(!Arc::ptr_eq(&first.inner, &second.inner));
        assert_eq!(fresh_scopes.load(Ordering::SeqCst), 2);
        assert_eq!(first.definition(), scope.definition());
        assert_eq!(second.definition(), scope.definition());
        assert_eq!(
            second.descriptor().description.as_deref(),
            Some("delegated descriptor")
        );
        assert_eq!(
            second.list_models().await.expect("delegated catalog"),
            vec![model]
        );
        let _ = second
            .create_session()
            .await
            .expect("delegated session factory");
    }

    #[test]
    fn each_concrete_provider_preserves_its_definition_in_a_fresh_scope() {
        let mut anthropic_definition = crate::anthropic::definition();
        anthropic_definition.descriptor.id = ProviderId::new("custom-anthropic");
        anthropic_definition.base_url = Some("https://anthropic.example/v1/".to_string());

        let chat_definition =
            crate::chat_completions::definition("custom-chat", "https://chat.example/v1/");

        let mut gemini_definition = ProviderDefinition::new("custom-gemini");
        gemini_definition.base_url = Some("https://gemini.example/v1/".to_string());

        let mut responses_definition = crate::responses::openai_definition();
        responses_definition.descriptor.id = ProviderId::new("custom-responses");
        responses_definition.base_url = Some("https://responses.example/v1/".to_string());

        let providers: Vec<Box<dyn Provider>> = vec![
            Box::new(
                crate::anthropic::AnthropicProvider::with_definition_and_credential_source(
                    anthropic_definition,
                    crate::StaticCredentialSource::new("anthropic-key"),
                ),
            ),
            Box::new(crate::chat_completions::ChatCompletionsProvider::new(
                chat_definition,
                crate::StaticCredentialSource::new("chat-key"),
            )),
            Box::new(
                crate::gemini::GeminiProvider::with_definition_and_credential_source(
                    gemini_definition,
                    crate::StaticCredentialSource::new("gemini-key"),
                ),
            ),
            Box::new(crate::responses::ResponsesProvider::new(
                responses_definition,
                crate::StaticCredentialSource::new("responses-key"),
            )),
        ];

        for provider in providers {
            let expected = provider.definition();
            let fresh = provider
                .fresh_session_scope()
                .expect("each concrete provider supports fresh scopes");
            assert_eq!(fresh.definition(), expected);
        }
    }
}