registry.rs

  1use crate::{
  2    LanguageModel, LanguageModelId, LanguageModelProvider, LanguageModelProviderId,
  3    LanguageModelProviderState,
  4};
  5use collections::BTreeMap;
  6use gpui::{App, Context, Entity, EventEmitter, Global, prelude::*};
  7use std::{str::FromStr, sync::Arc};
  8use thiserror::Error;
  9use util::maybe;
 10
 11pub fn init(cx: &mut App) {
 12    let registry = cx.new(|_cx| LanguageModelRegistry::default());
 13    cx.set_global(GlobalLanguageModelRegistry(registry));
 14}
 15
 16struct GlobalLanguageModelRegistry(Entity<LanguageModelRegistry>);
 17
 18impl Global for GlobalLanguageModelRegistry {}
 19
 20#[derive(Error)]
 21pub enum ConfigurationError {
 22    #[error("Configure at least one LLM provider to start using the panel.")]
 23    NoProvider,
 24    #[error("LLM provider is not configured or does not support the configured model.")]
 25    ModelNotFound,
 26    #[error("{} LLM provider is not configured.", .0.name().0)]
 27    ProviderNotAuthenticated(Arc<dyn LanguageModelProvider>),
 28}
 29
 30impl std::fmt::Debug for ConfigurationError {
 31    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 32        match self {
 33            Self::NoProvider => write!(f, "NoProvider"),
 34            Self::ModelNotFound => write!(f, "ModelNotFound"),
 35            Self::ProviderNotAuthenticated(provider) => {
 36                write!(f, "ProviderNotAuthenticated({})", provider.id())
 37            }
 38        }
 39    }
 40}
 41
 42#[derive(Default)]
 43pub struct LanguageModelRegistry {
 44    default_model: Option<ConfiguredModel>,
 45    default_fast_model: Option<ConfiguredModel>,
 46    inline_assistant_model: Option<ConfiguredModel>,
 47    commit_message_model: Option<ConfiguredModel>,
 48    thread_summary_model: Option<ConfiguredModel>,
 49    providers: BTreeMap<LanguageModelProviderId, Arc<dyn LanguageModelProvider>>,
 50    inline_alternatives: Vec<Arc<dyn LanguageModel>>,
 51}
 52
 53#[derive(Debug)]
 54pub struct SelectedModel {
 55    pub provider: LanguageModelProviderId,
 56    pub model: LanguageModelId,
 57}
 58
 59impl FromStr for SelectedModel {
 60    type Err = String;
 61
 62    /// Parse string identifiers like `provider_id/model_id` into a `SelectedModel`
 63    fn from_str(id: &str) -> Result<SelectedModel, Self::Err> {
 64        let parts: Vec<&str> = id.split('/').collect();
 65        let [provider_id, model_id] = parts.as_slice() else {
 66            return Err(format!(
 67                "Invalid model identifier format: `{}`. Expected `provider_id/model_id`",
 68                id
 69            ));
 70        };
 71
 72        if provider_id.is_empty() || model_id.is_empty() {
 73            return Err(format!("Provider and model ids can't be empty: `{}`", id));
 74        }
 75
 76        Ok(SelectedModel {
 77            provider: LanguageModelProviderId(provider_id.to_string().into()),
 78            model: LanguageModelId(model_id.to_string().into()),
 79        })
 80    }
 81}
 82
 83#[derive(Clone)]
 84pub struct ConfiguredModel {
 85    pub provider: Arc<dyn LanguageModelProvider>,
 86    pub model: Arc<dyn LanguageModel>,
 87}
 88
 89impl ConfiguredModel {
 90    pub fn is_same_as(&self, other: &ConfiguredModel) -> bool {
 91        self.model.id() == other.model.id() && self.provider.id() == other.provider.id()
 92    }
 93
 94    pub fn is_provided_by_zed(&self) -> bool {
 95        self.provider.id() == crate::ZED_CLOUD_PROVIDER_ID
 96    }
 97}
 98
 99pub enum Event {
100    DefaultModelChanged,
101    InlineAssistantModelChanged,
102    CommitMessageModelChanged,
103    ThreadSummaryModelChanged,
104    ProviderStateChanged(LanguageModelProviderId),
105    AddedProvider(LanguageModelProviderId),
106    RemovedProvider(LanguageModelProviderId),
107}
108
109impl EventEmitter<Event> for LanguageModelRegistry {}
110
111impl LanguageModelRegistry {
112    pub fn global(cx: &App) -> Entity<Self> {
113        cx.global::<GlobalLanguageModelRegistry>().0.clone()
114    }
115
116    pub fn read_global(cx: &App) -> &Self {
117        cx.global::<GlobalLanguageModelRegistry>().0.read(cx)
118    }
119
120    #[cfg(any(test, feature = "test-support"))]
121    pub fn test(cx: &mut App) -> Arc<crate::fake_provider::FakeLanguageModelProvider> {
122        let fake_provider = Arc::new(crate::fake_provider::FakeLanguageModelProvider::default());
123        let registry = cx.new(|cx| {
124            let mut registry = Self::default();
125            registry.register_provider(fake_provider.clone(), cx);
126            let model = fake_provider.provided_models(cx)[0].clone();
127            let configured_model = ConfiguredModel {
128                provider: fake_provider.clone(),
129                model,
130            };
131            registry.set_default_model(Some(configured_model), cx);
132            registry
133        });
134        cx.set_global(GlobalLanguageModelRegistry(registry));
135        fake_provider
136    }
137
138    pub fn register_provider<T: LanguageModelProvider + LanguageModelProviderState>(
139        &mut self,
140        provider: Arc<T>,
141        cx: &mut Context<Self>,
142    ) {
143        let id = provider.id();
144
145        let subscription = provider.subscribe(cx, {
146            let id = id.clone();
147            move |_, cx| {
148                cx.emit(Event::ProviderStateChanged(id.clone()));
149            }
150        });
151        if let Some(subscription) = subscription {
152            subscription.detach();
153        }
154
155        self.providers.insert(id.clone(), provider);
156        let now = std::time::SystemTime::now()
157            .duration_since(std::time::UNIX_EPOCH)
158            .unwrap_or_default()
159            .as_millis();
160        eprintln!(
161            "[{}ms] LanguageModelRegistry: About to emit AddedProvider event for {:?}",
162            now, id
163        );
164        cx.emit(Event::AddedProvider(id.clone()));
165        eprintln!(
166            "[{}ms] LanguageModelRegistry: Emitted AddedProvider event for {:?}",
167            now, id
168        );
169    }
170
171    pub fn unregister_provider(&mut self, id: LanguageModelProviderId, cx: &mut Context<Self>) {
172        if self.providers.remove(&id).is_some() {
173            cx.emit(Event::RemovedProvider(id));
174        }
175    }
176
177    pub fn providers(&self) -> Vec<Arc<dyn LanguageModelProvider>> {
178        let now = std::time::SystemTime::now()
179            .duration_since(std::time::UNIX_EPOCH)
180            .unwrap_or_default()
181            .as_millis();
182        eprintln!(
183            "[{}ms] LanguageModelRegistry::providers() called, {} providers in registry",
184            now,
185            self.providers.len()
186        );
187        for (id, _) in &self.providers {
188            eprintln!("  - provider: {:?}", id);
189        }
190        let zed_provider_id = LanguageModelProviderId("zed.dev".into());
191        let mut providers = Vec::with_capacity(self.providers.len());
192        if let Some(provider) = self.providers.get(&zed_provider_id) {
193            providers.push(provider.clone());
194        }
195        providers.extend(self.providers.values().filter_map(|p| {
196            if p.id() != zed_provider_id {
197                Some(p.clone())
198            } else {
199                None
200            }
201        }));
202        eprintln!(
203            "[{}ms] LanguageModelRegistry::providers() returning {} providers",
204            now,
205            providers.len()
206        );
207        providers
208    }
209
210    pub fn configuration_error(
211        &self,
212        model: Option<ConfiguredModel>,
213        cx: &App,
214    ) -> Option<ConfigurationError> {
215        let Some(model) = model else {
216            if !self.has_authenticated_provider(cx) {
217                return Some(ConfigurationError::NoProvider);
218            }
219            return Some(ConfigurationError::ModelNotFound);
220        };
221
222        if !model.provider.is_authenticated(cx) {
223            return Some(ConfigurationError::ProviderNotAuthenticated(model.provider));
224        }
225
226        None
227    }
228
229    /// Returns `true` if at least one provider that is authenticated.
230    pub fn has_authenticated_provider(&self, cx: &App) -> bool {
231        self.providers.values().any(|p| p.is_authenticated(cx))
232    }
233
234    pub fn available_models<'a>(
235        &'a self,
236        cx: &'a App,
237    ) -> impl Iterator<Item = Arc<dyn LanguageModel>> + 'a {
238        self.providers
239            .values()
240            .filter(|provider| provider.is_authenticated(cx))
241            .flat_map(|provider| provider.provided_models(cx))
242    }
243
244    pub fn provider(&self, id: &LanguageModelProviderId) -> Option<Arc<dyn LanguageModelProvider>> {
245        self.providers.get(id).cloned()
246    }
247
248    pub fn select_default_model(&mut self, model: Option<&SelectedModel>, cx: &mut Context<Self>) {
249        let configured_model = model.and_then(|model| self.select_model(model, cx));
250        self.set_default_model(configured_model, cx);
251    }
252
253    pub fn select_inline_assistant_model(
254        &mut self,
255        model: Option<&SelectedModel>,
256        cx: &mut Context<Self>,
257    ) {
258        let configured_model = model.and_then(|model| self.select_model(model, cx));
259        self.set_inline_assistant_model(configured_model, cx);
260    }
261
262    pub fn select_commit_message_model(
263        &mut self,
264        model: Option<&SelectedModel>,
265        cx: &mut Context<Self>,
266    ) {
267        let configured_model = model.and_then(|model| self.select_model(model, cx));
268        self.set_commit_message_model(configured_model, cx);
269    }
270
271    pub fn select_thread_summary_model(
272        &mut self,
273        model: Option<&SelectedModel>,
274        cx: &mut Context<Self>,
275    ) {
276        let configured_model = model.and_then(|model| self.select_model(model, cx));
277        self.set_thread_summary_model(configured_model, cx);
278    }
279
280    /// Selects and sets the inline alternatives for language models based on
281    /// provider name and id.
282    pub fn select_inline_alternative_models(
283        &mut self,
284        alternatives: impl IntoIterator<Item = SelectedModel>,
285        cx: &mut Context<Self>,
286    ) {
287        self.inline_alternatives = alternatives
288            .into_iter()
289            .flat_map(|alternative| {
290                self.select_model(&alternative, cx)
291                    .map(|configured_model| configured_model.model)
292            })
293            .collect::<Vec<_>>();
294    }
295
296    pub fn select_model(
297        &mut self,
298        selected_model: &SelectedModel,
299        cx: &mut Context<Self>,
300    ) -> Option<ConfiguredModel> {
301        let provider = self.provider(&selected_model.provider)?;
302        let model = provider
303            .provided_models(cx)
304            .iter()
305            .find(|model| model.id() == selected_model.model)?
306            .clone();
307        Some(ConfiguredModel { provider, model })
308    }
309
310    pub fn set_default_model(&mut self, model: Option<ConfiguredModel>, cx: &mut Context<Self>) {
311        match (self.default_model.as_ref(), model.as_ref()) {
312            (Some(old), Some(new)) if old.is_same_as(new) => {}
313            (None, None) => {}
314            _ => cx.emit(Event::DefaultModelChanged),
315        }
316        self.default_fast_model = maybe!({
317            let provider = &model.as_ref()?.provider;
318            let fast_model = provider.default_fast_model(cx)?;
319            Some(ConfiguredModel {
320                provider: provider.clone(),
321                model: fast_model,
322            })
323        });
324        self.default_model = model;
325    }
326
327    pub fn set_inline_assistant_model(
328        &mut self,
329        model: Option<ConfiguredModel>,
330        cx: &mut Context<Self>,
331    ) {
332        match (self.inline_assistant_model.as_ref(), model.as_ref()) {
333            (Some(old), Some(new)) if old.is_same_as(new) => {}
334            (None, None) => {}
335            _ => cx.emit(Event::InlineAssistantModelChanged),
336        }
337        self.inline_assistant_model = model;
338    }
339
340    pub fn set_commit_message_model(
341        &mut self,
342        model: Option<ConfiguredModel>,
343        cx: &mut Context<Self>,
344    ) {
345        match (self.commit_message_model.as_ref(), model.as_ref()) {
346            (Some(old), Some(new)) if old.is_same_as(new) => {}
347            (None, None) => {}
348            _ => cx.emit(Event::CommitMessageModelChanged),
349        }
350        self.commit_message_model = model;
351    }
352
353    pub fn set_thread_summary_model(
354        &mut self,
355        model: Option<ConfiguredModel>,
356        cx: &mut Context<Self>,
357    ) {
358        match (self.thread_summary_model.as_ref(), model.as_ref()) {
359            (Some(old), Some(new)) if old.is_same_as(new) => {}
360            (None, None) => {}
361            _ => cx.emit(Event::ThreadSummaryModelChanged),
362        }
363        self.thread_summary_model = model;
364    }
365
366    pub fn default_model(&self) -> Option<ConfiguredModel> {
367        #[cfg(debug_assertions)]
368        if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
369            return None;
370        }
371
372        self.default_model.clone()
373    }
374
375    pub fn inline_assistant_model(&self) -> Option<ConfiguredModel> {
376        #[cfg(debug_assertions)]
377        if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
378            return None;
379        }
380
381        self.inline_assistant_model
382            .clone()
383            .or_else(|| self.default_model.clone())
384    }
385
386    pub fn commit_message_model(&self) -> Option<ConfiguredModel> {
387        #[cfg(debug_assertions)]
388        if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
389            return None;
390        }
391
392        self.commit_message_model
393            .clone()
394            .or_else(|| self.default_fast_model.clone())
395            .or_else(|| self.default_model.clone())
396    }
397
398    pub fn thread_summary_model(&self) -> Option<ConfiguredModel> {
399        #[cfg(debug_assertions)]
400        if std::env::var("ZED_SIMULATE_NO_LLM_PROVIDER").is_ok() {
401            return None;
402        }
403
404        self.thread_summary_model
405            .clone()
406            .or_else(|| self.default_fast_model.clone())
407            .or_else(|| self.default_model.clone())
408    }
409
410    /// The models to use for inline assists. Returns the union of the active
411    /// model and all inline alternatives. When there are multiple models, the
412    /// user will be able to cycle through results.
413    pub fn inline_alternative_models(&self) -> &[Arc<dyn LanguageModel>] {
414        &self.inline_alternatives
415    }
416}
417
418#[cfg(test)]
419mod tests {
420    use super::*;
421    use crate::fake_provider::FakeLanguageModelProvider;
422
423    #[gpui::test]
424    fn test_register_providers(cx: &mut App) {
425        let registry = cx.new(|_| LanguageModelRegistry::default());
426
427        let provider = Arc::new(FakeLanguageModelProvider::default());
428        registry.update(cx, |registry, cx| {
429            registry.register_provider(provider.clone(), cx);
430        });
431
432        let providers = registry.read(cx).providers();
433        assert_eq!(providers.len(), 1);
434        assert_eq!(providers[0].id(), provider.id());
435
436        registry.update(cx, |registry, cx| {
437            registry.unregister_provider(provider.id(), cx);
438        });
439
440        let providers = registry.read(cx).providers();
441        assert!(providers.is_empty());
442    }
443}