-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Expand file tree
/
Copy pathprovider_registry.rs
More file actions
345 lines (304 loc) · 11.4 KB
/
provider_registry.rs
File metadata and controls
345 lines (304 loc) · 11.4 KB
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
use super::base::{ConfigKey, ModelInfo, Provider, ProviderDef, ProviderMetadata, ProviderType};
use super::inventory::InventoryIdentityInput;
use crate::config::{DeclarativeProviderConfig, ExtensionConfig};
use crate::model::ModelConfig;
use anyhow::Result;
use futures::future::BoxFuture;
use std::collections::HashMap;
use std::sync::Arc;
pub type ProviderConstructor = Arc<
dyn Fn(ModelConfig, Vec<ExtensionConfig>) -> BoxFuture<'static, Result<Arc<dyn Provider>>>
+ Send
+ Sync,
>;
pub type ProviderCleanup = Arc<dyn Fn() -> BoxFuture<'static, Result<()>> + Send + Sync>;
pub type ProviderInventoryIdentityResolver =
Arc<dyn Fn() -> Result<InventoryIdentityInput> + Send + Sync>;
pub type ProviderInventoryConfiguredResolver = Arc<dyn Fn() -> bool + Send + Sync>;
#[derive(Clone)]
pub struct ProviderEntry {
metadata: ProviderMetadata,
pub(crate) constructor: ProviderConstructor,
pub(crate) inventory_identity: ProviderInventoryIdentityResolver,
pub(crate) inventory_configured: ProviderInventoryConfiguredResolver,
pub(crate) cleanup: Option<ProviderCleanup>,
provider_type: ProviderType,
supports_inventory_refresh: bool,
}
impl ProviderEntry {
pub fn metadata(&self) -> &ProviderMetadata {
&self.metadata
}
pub fn provider_type(&self) -> ProviderType {
self.provider_type
}
pub fn supports_inventory_refresh(&self) -> bool {
self.supports_inventory_refresh
}
pub fn inventory_identity(&self) -> Result<InventoryIdentityInput> {
(self.inventory_identity)()
}
pub fn inventory_configured(&self) -> bool {
(self.inventory_configured)()
}
fn normalize_model_config(&self, mut model: ModelConfig) -> ModelConfig {
model = model.with_canonical_limits(&self.metadata.name);
if model.context_limit.is_none() {
if let Some(info) = self
.metadata
.known_models
.iter()
.find(|m| m.name.eq_ignore_ascii_case(&model.model_name) && m.context_limit > 0)
{
model.context_limit = Some(info.context_limit);
}
}
model
}
pub async fn create_with_default_model(
&self,
extensions: Vec<ExtensionConfig>,
) -> Result<Arc<dyn Provider>> {
let default_model = &self.metadata.default_model;
let model_config = self.normalize_model_config(ModelConfig::new(default_model.as_str())?);
(self.constructor)(model_config, extensions).await
}
pub async fn create(
&self,
model: ModelConfig,
extensions: Vec<ExtensionConfig>,
) -> Result<Arc<dyn Provider>> {
let model = self.normalize_model_config(model);
(self.constructor)(model, extensions).await
}
}
#[derive(Default)]
pub struct ProviderRegistry {
pub(crate) entries: HashMap<String, ProviderEntry>,
}
impl ProviderRegistry {
pub fn new() -> Self {
Self {
entries: HashMap::new(),
}
}
pub fn register<F>(&mut self, preferred: bool)
where
F: ProviderDef + 'static,
{
let metadata = F::metadata();
let name = metadata.name.clone();
self.entries.insert(
name,
ProviderEntry {
metadata,
constructor: Arc::new(|model, extensions| {
Box::pin(async move {
let provider = F::from_env(model, extensions).await?;
Ok(Arc::new(provider) as Arc<dyn Provider>)
})
}),
inventory_identity: Arc::new(F::inventory_identity),
inventory_configured: Arc::new(F::inventory_configured),
cleanup: None,
provider_type: if preferred {
ProviderType::Preferred
} else {
ProviderType::Builtin
},
supports_inventory_refresh: F::supports_inventory_refresh(),
},
);
}
pub fn register_with_name<P, F, G>(
&mut self,
config: &DeclarativeProviderConfig,
provider_type: ProviderType,
supports_inventory_refresh: bool,
constructor: F,
inventory_identity: G,
) where
P: ProviderDef + 'static,
F: Fn(ModelConfig) -> Result<P::Provider> + Send + Sync + 'static,
G: Fn() -> Result<InventoryIdentityInput> + Send + Sync + 'static,
{
let base_metadata = P::metadata();
let description = config
.description
.clone()
.unwrap_or_else(|| format!("Custom {} provider", config.display_name));
let default_model = config
.models
.first()
.map(|m| m.name.clone())
.unwrap_or_default();
let known_models: Vec<ModelInfo> = config
.models
.iter()
.map(|m| ModelInfo {
name: m.name.clone(),
context_limit: m.context_limit,
input_token_cost: m.input_token_cost,
output_token_cost: m.output_token_cost,
currency: m.currency.clone(),
supports_cache_control: Some(m.supports_cache_control.unwrap_or(false)),
})
.collect();
let mut config_keys = if provider_type == ProviderType::Declarative {
if config.requires_auth && !config.api_key_env.is_empty() {
vec![ConfigKey::new(&config.api_key_env, true, true, None, true)]
} else {
Vec::new()
}
} else {
let mut config_keys = base_metadata.config_keys.clone();
if let Some(api_key_index) = config_keys.iter().position(|key| key.secret) {
if !config.requires_auth {
config_keys.remove(api_key_index);
} else if !config.api_key_env.is_empty() {
config_keys[api_key_index] =
ConfigKey::new(&config.api_key_env, false, true, None, true);
}
}
config_keys
};
if let Some(ref env_vars) = config.env_vars {
for ev in env_vars {
// Default primary to `required` so required fields show prominently in the UI
let primary = ev.primary.unwrap_or(ev.required);
config_keys.push(ConfigKey::new(
&ev.name,
ev.required,
ev.secret,
ev.default.as_deref(),
primary,
));
}
}
let custom_metadata = ProviderMetadata {
name: config.name.clone(),
display_name: config.display_name.clone(),
description,
default_model,
known_models,
model_doc_link: config
.model_doc_link
.clone()
.unwrap_or(base_metadata.model_doc_link),
config_keys,
setup_steps: config.setup_steps.clone(),
model_selection_hint: None,
};
let inventory_config_keys = custom_metadata.config_keys.clone();
self.entries.insert(
config.name.clone(),
ProviderEntry {
metadata: custom_metadata,
constructor: Arc::new(move |model, _extensions| {
let result = constructor(model);
Box::pin(async move {
let provider = result?;
Ok(Arc::new(provider) as Arc<dyn Provider>)
})
}),
inventory_identity: Arc::new(inventory_identity),
inventory_configured: Arc::new(move || {
super::inventory::default_inventory_configured(
&inventory_config_keys,
crate::config::Config::global(),
)
}),
cleanup: None,
provider_type,
supports_inventory_refresh,
},
);
}
pub fn set_cleanup(&mut self, name: &str, cleanup: ProviderCleanup) {
if let Some(entry) = self.entries.get_mut(name) {
entry.cleanup = Some(cleanup);
}
}
pub fn with_providers<F>(mut self, setup: F) -> Self
where
F: FnOnce(&mut Self),
{
setup(&mut self);
self
}
pub async fn create(
&self,
name: &str,
model: ModelConfig,
extensions: Vec<ExtensionConfig>,
) -> Result<Arc<dyn Provider>> {
let entry = self
.entries
.get(name)
.ok_or_else(|| anyhow::anyhow!("Unknown provider: {}", name))?;
entry.create(model, extensions).await
}
pub fn all_metadata_with_types(&self) -> Vec<(ProviderMetadata, ProviderType)> {
self.entries
.values()
.map(|e| (e.metadata.clone(), e.provider_type))
.collect()
}
pub fn remove_custom_providers(&mut self) {
self.entries.retain(|name, _| !name.starts_with("custom_"));
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::providers::inventory::InventoryIdentityInput;
fn make_test_entry(known_models: Vec<ModelInfo>) -> ProviderEntry {
let metadata = ProviderMetadata {
name: "test_provider".to_string(),
display_name: "Test Provider".to_string(),
description: "Test".to_string(),
default_model: "test-model".to_string(),
known_models,
model_doc_link: "https://example.com".to_string(),
config_keys: vec![],
setup_steps: vec![],
model_selection_hint: None,
};
ProviderEntry {
metadata,
constructor: Arc::new(|_, _| Box::pin(async { unimplemented!() })),
inventory_identity: Arc::new(|| Ok(InventoryIdentityInput::default())),
inventory_configured: Arc::new(|| true),
cleanup: None,
provider_type: ProviderType::Builtin,
supports_inventory_refresh: false,
}
}
#[test]
fn test_normalize_model_config_case_mismatch() {
// Registry has uppercase model name; GOOSE_MODEL is lowercase.
let entry = make_test_entry(vec![ModelInfo::new("GLM-5.1", 32_000)]);
let model = ModelConfig::new_or_fail("glm-5.1");
assert!(model.context_limit.is_none());
let normalized = entry.normalize_model_config(model);
assert_eq!(normalized.context_limit, Some(32_000));
}
#[test]
fn test_normalize_model_config_exact_case_match() {
// Exact case match should continue to work (no regression).
let entry = make_test_entry(vec![ModelInfo::new("gpt-4o", 128_000)]);
let model = ModelConfig::new_or_fail("gpt-4o");
assert!(model.context_limit.is_none());
let normalized = entry.normalize_model_config(model);
assert_eq!(normalized.context_limit, Some(128_000));
}
#[test]
fn test_normalize_model_config_no_match_falls_back() {
// Unknown model should not get a context_limit from known_models.
let entry = make_test_entry(vec![ModelInfo::new("GLM-5.1", 32_000)]);
let model = ModelConfig::new_or_fail("unknown-model");
assert!(model.context_limit.is_none());
let normalized = entry.normalize_model_config(model);
assert!(normalized.context_limit.is_none());
}
}