extension_host.rs

   1mod capability_granter;
   2pub mod extension_settings;
   3pub mod headless_host;
   4pub mod wasm_host;
   5
   6#[cfg(test)]
   7mod extension_store_test;
   8
   9use anyhow::{Context as _, Result, anyhow, bail};
  10use async_compression::futures::bufread::GzipDecoder;
  11use async_tar::Archive;
  12use client::ExtensionProvides;
  13use client::{Client, ExtensionMetadata, GetExtensionsResponse, proto, telemetry::Telemetry};
  14use collections::{BTreeMap, BTreeSet, HashSet, btree_map};
  15pub use extension::ExtensionManifest;
  16use extension::extension_builder::{CompileExtensionOptions, ExtensionBuilder};
  17use extension::{
  18    ExtensionContextServerProxy, ExtensionDebugAdapterProviderProxy, ExtensionEvents,
  19    ExtensionGrammarProxy, ExtensionHostProxy, ExtensionLanguageProxy,
  20    ExtensionLanguageServerProxy, ExtensionSlashCommandProxy, ExtensionSnippetProxy,
  21    ExtensionThemeProxy,
  22};
  23use fs::{Fs, RemoveOptions};
  24use futures::future::join_all;
  25use futures::{
  26    AsyncReadExt as _, Future, FutureExt as _, StreamExt as _,
  27    channel::{
  28        mpsc::{UnboundedSender, unbounded},
  29        oneshot,
  30    },
  31    io::BufReader,
  32    select_biased,
  33};
  34use gpui::{
  35    App, AppContext as _, AsyncApp, Context, Entity, EventEmitter, Global, Task, WeakEntity,
  36    actions,
  37};
  38use http_client::{AsyncBody, HttpClient, HttpClientWithUrl};
  39use language::{
  40    LanguageConfig, LanguageMatcher, LanguageName, LanguageQueries, LoadedLanguage,
  41    QUERY_FILENAME_PREFIXES, Rope,
  42};
  43use node_runtime::NodeRuntime;
  44use project::ContextProviderWithTasks;
  45use release_channel::ReleaseChannel;
  46use remote::RemoteClient;
  47use semver::Version;
  48use serde::{Deserialize, Serialize};
  49use settings::Settings;
  50use std::ops::RangeInclusive;
  51use std::str::FromStr;
  52use std::{
  53    cmp::Ordering,
  54    path::{self, Path, PathBuf},
  55    sync::Arc,
  56    time::{Duration, Instant},
  57};
  58use url::Url;
  59use util::{ResultExt, paths::RemotePathBuf};
  60use wasm_host::{
  61    WasmExtension, WasmHost,
  62    wit::{is_supported_wasm_api_version, wasm_api_version_range},
  63};
  64
  65pub use extension::{
  66    ExtensionLibraryKind, GrammarManifestEntry, OldExtensionManifest, SchemaVersion,
  67};
  68pub use extension_settings::ExtensionSettings;
  69
  70pub const RELOAD_DEBOUNCE_DURATION: Duration = Duration::from_millis(200);
  71const FS_WATCH_LATENCY: Duration = Duration::from_millis(100);
  72
  73/// The current extension [`SchemaVersion`] supported by Zed.
  74const CURRENT_SCHEMA_VERSION: SchemaVersion = SchemaVersion(1);
  75
  76/// Extensions that should no longer be loaded or downloaded.
  77///
  78/// These snippets should no longer be downloaded or loaded, because their
  79/// functionality has been integrated into the core editor.
  80const SUPPRESSED_EXTENSIONS: &[&str] = &["snippets", "ruff", "ty", "basedpyright"];
  81
  82/// Returns the [`SchemaVersion`] range that is compatible with this version of Zed.
  83pub fn schema_version_range() -> RangeInclusive<SchemaVersion> {
  84    SchemaVersion::ZERO..=CURRENT_SCHEMA_VERSION
  85}
  86
  87/// Returns whether the given extension version is compatible with this version of Zed.
  88pub fn is_version_compatible(
  89    release_channel: ReleaseChannel,
  90    extension_version: &ExtensionMetadata,
  91) -> bool {
  92    let schema_version = extension_version.manifest.schema_version.unwrap_or(0);
  93    if CURRENT_SCHEMA_VERSION.0 < schema_version {
  94        return false;
  95    }
  96
  97    if let Some(wasm_api_version) = extension_version
  98        .manifest
  99        .wasm_api_version
 100        .as_ref()
 101        .and_then(|wasm_api_version| Version::from_str(wasm_api_version).ok())
 102        && !is_supported_wasm_api_version(release_channel, wasm_api_version)
 103    {
 104        return false;
 105    }
 106
 107    true
 108}
 109
 110pub struct ExtensionStore {
 111    pub proxy: Arc<ExtensionHostProxy>,
 112    pub builder: Arc<ExtensionBuilder>,
 113    pub extension_index: ExtensionIndex,
 114    pub fs: Arc<dyn Fs>,
 115    pub http_client: Arc<HttpClientWithUrl>,
 116    pub telemetry: Option<Arc<Telemetry>>,
 117    pub reload_tx: UnboundedSender<Option<Arc<str>>>,
 118    pub reload_complete_senders: Vec<oneshot::Sender<()>>,
 119    pub installed_dir: PathBuf,
 120    pub outstanding_operations: BTreeMap<Arc<str>, ExtensionOperation>,
 121    pub index_path: PathBuf,
 122    pub modified_extensions: HashSet<Arc<str>>,
 123    pub wasm_host: Arc<WasmHost>,
 124    pub wasm_extensions: Vec<(Arc<ExtensionManifest>, WasmExtension)>,
 125    pub tasks: Vec<Task<()>>,
 126    pub remote_clients: Vec<WeakEntity<RemoteClient>>,
 127    pub ssh_registered_tx: UnboundedSender<()>,
 128}
 129
 130#[derive(Clone, Copy)]
 131pub enum ExtensionOperation {
 132    Upgrade,
 133    Install,
 134    Remove,
 135}
 136
 137#[derive(Clone)]
 138pub enum Event {
 139    ExtensionsUpdated,
 140    StartedReloading,
 141    ExtensionInstalled(Arc<str>),
 142    ExtensionUninstalled(Arc<str>),
 143    ExtensionFailedToLoad(Arc<str>),
 144}
 145
 146impl EventEmitter<Event> for ExtensionStore {}
 147
 148struct GlobalExtensionStore(Entity<ExtensionStore>);
 149
 150impl Global for GlobalExtensionStore {}
 151
 152#[derive(Debug, Deserialize, Serialize, Default, PartialEq, Eq)]
 153pub struct ExtensionIndex {
 154    pub extensions: BTreeMap<Arc<str>, ExtensionIndexEntry>,
 155    pub themes: BTreeMap<Arc<str>, ExtensionIndexThemeEntry>,
 156    #[serde(default)]
 157    pub icon_themes: BTreeMap<Arc<str>, ExtensionIndexIconThemeEntry>,
 158    pub languages: BTreeMap<LanguageName, ExtensionIndexLanguageEntry>,
 159}
 160
 161#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
 162pub struct ExtensionIndexEntry {
 163    pub manifest: Arc<ExtensionManifest>,
 164    pub dev: bool,
 165}
 166
 167#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
 168pub struct ExtensionIndexThemeEntry {
 169    pub extension: Arc<str>,
 170    pub path: PathBuf,
 171}
 172
 173#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
 174pub struct ExtensionIndexIconThemeEntry {
 175    pub extension: Arc<str>,
 176    pub path: PathBuf,
 177}
 178
 179#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
 180pub struct ExtensionIndexLanguageEntry {
 181    pub extension: Arc<str>,
 182    pub path: PathBuf,
 183    pub matcher: LanguageMatcher,
 184    pub hidden: bool,
 185    pub grammar: Option<Arc<str>>,
 186}
 187
 188actions!(
 189    zed,
 190    [
 191        /// Reloads all installed extensions.
 192        ReloadExtensions
 193    ]
 194);
 195
 196pub fn init(
 197    extension_host_proxy: Arc<ExtensionHostProxy>,
 198    fs: Arc<dyn Fs>,
 199    client: Arc<Client>,
 200    node_runtime: NodeRuntime,
 201    cx: &mut App,
 202) {
 203    let store = cx.new(move |cx| {
 204        ExtensionStore::new(
 205            paths::extensions_dir().clone(),
 206            None,
 207            extension_host_proxy,
 208            fs,
 209            client.http_client(),
 210            client.http_client(),
 211            Some(client.telemetry().clone()),
 212            node_runtime,
 213            cx,
 214        )
 215    });
 216
 217    cx.on_action(|_: &ReloadExtensions, cx| {
 218        let store = cx.global::<GlobalExtensionStore>().0.clone();
 219        store.update(cx, |store, cx| drop(store.reload(None, cx)));
 220    });
 221
 222    cx.set_global(GlobalExtensionStore(store));
 223}
 224
 225impl ExtensionStore {
 226    pub fn try_global(cx: &App) -> Option<Entity<Self>> {
 227        cx.try_global::<GlobalExtensionStore>()
 228            .map(|store| store.0.clone())
 229    }
 230
 231    pub fn global(cx: &App) -> Entity<Self> {
 232        cx.global::<GlobalExtensionStore>().0.clone()
 233    }
 234
 235    pub fn new(
 236        extensions_dir: PathBuf,
 237        build_dir: Option<PathBuf>,
 238        extension_host_proxy: Arc<ExtensionHostProxy>,
 239        fs: Arc<dyn Fs>,
 240        http_client: Arc<HttpClientWithUrl>,
 241        builder_client: Arc<dyn HttpClient>,
 242        telemetry: Option<Arc<Telemetry>>,
 243        node_runtime: NodeRuntime,
 244        cx: &mut Context<Self>,
 245    ) -> Self {
 246        let work_dir = extensions_dir.join("work");
 247        let build_dir = build_dir.unwrap_or_else(|| extensions_dir.join("build"));
 248        let installed_dir = extensions_dir.join("installed");
 249        let index_path = extensions_dir.join("index.json");
 250
 251        let (reload_tx, mut reload_rx) = unbounded();
 252        let (connection_registered_tx, mut connection_registered_rx) = unbounded();
 253        let mut this = Self {
 254            proxy: extension_host_proxy.clone(),
 255            extension_index: Default::default(),
 256            installed_dir,
 257            index_path,
 258            builder: Arc::new(ExtensionBuilder::new(builder_client, build_dir)),
 259            outstanding_operations: Default::default(),
 260            modified_extensions: Default::default(),
 261            reload_complete_senders: Vec::new(),
 262            wasm_host: WasmHost::new(
 263                fs.clone(),
 264                http_client.clone(),
 265                node_runtime,
 266                extension_host_proxy,
 267                work_dir,
 268                cx,
 269            ),
 270            wasm_extensions: Vec::new(),
 271            fs,
 272            http_client,
 273            telemetry,
 274            reload_tx,
 275            tasks: Vec::new(),
 276
 277            remote_clients: Default::default(),
 278            ssh_registered_tx: connection_registered_tx,
 279        };
 280
 281        // The extensions store maintains an index file, which contains a complete
 282        // list of the installed extensions and the resources that they provide.
 283        // This index is loaded synchronously on startup.
 284        let (index_content, index_metadata, extensions_metadata) =
 285            cx.background_executor().block(async {
 286                futures::join!(
 287                    this.fs.load(&this.index_path),
 288                    this.fs.metadata(&this.index_path),
 289                    this.fs.metadata(&this.installed_dir),
 290                )
 291            });
 292
 293        // Normally, there is no need to rebuild the index. But if the index file
 294        // is invalid or is out-of-date according to the filesystem mtimes, then
 295        // it must be asynchronously rebuilt.
 296        let mut extension_index = ExtensionIndex::default();
 297        let mut extension_index_needs_rebuild = true;
 298        if let Ok(index_content) = index_content
 299            && let Some(index) = serde_json::from_str(&index_content).log_err()
 300        {
 301            extension_index = index;
 302            if let (Ok(Some(index_metadata)), Ok(Some(extensions_metadata))) =
 303                (index_metadata, extensions_metadata)
 304                && index_metadata
 305                    .mtime
 306                    .bad_is_greater_than(extensions_metadata.mtime)
 307            {
 308                extension_index_needs_rebuild = false;
 309            }
 310        }
 311
 312        // Immediately load all of the extensions in the initial manifest. If the
 313        // index needs to be rebuild, then enqueue
 314        let load_initial_extensions = this.extensions_updated(extension_index, cx);
 315        let mut reload_future = None;
 316        if extension_index_needs_rebuild {
 317            reload_future = Some(this.reload(None, cx));
 318        }
 319
 320        cx.spawn(async move |this, cx| {
 321            if let Some(future) = reload_future {
 322                future.await;
 323            }
 324            this.update(cx, |this, cx| this.auto_install_extensions(cx))
 325                .ok();
 326            this.update(cx, |this, cx| this.check_for_updates(cx)).ok();
 327        })
 328        .detach();
 329
 330        // Perform all extension loading in a single task to ensure that we
 331        // never attempt to simultaneously load/unload extensions from multiple
 332        // parallel tasks.
 333        this.tasks.push(cx.spawn(async move |this, cx| {
 334            async move {
 335                load_initial_extensions.await;
 336
 337                let mut index_changed = false;
 338                let mut debounce_timer = cx.background_spawn(futures::future::pending()).fuse();
 339                loop {
 340                    select_biased! {
 341                        _ = debounce_timer => {
 342                            if index_changed {
 343                                let index = this
 344                                    .update(cx, |this, cx| this.rebuild_extension_index(cx))?
 345                                    .await;
 346                                this.update(cx, |this, cx| this.extensions_updated(index, cx))?
 347                                    .await;
 348                                index_changed = false;
 349                            }
 350
 351                            Self::update_remote_clients(&this, cx).await?;
 352                        }
 353                        _ = connection_registered_rx.next() => {
 354                            debounce_timer = cx
 355                                .background_executor()
 356                                .timer(RELOAD_DEBOUNCE_DURATION)
 357                                .fuse();
 358                        }
 359                        extension_id = reload_rx.next() => {
 360                            let Some(extension_id) = extension_id else { break; };
 361                            this.update(cx, |this, _| {
 362                                this.modified_extensions.extend(extension_id);
 363                            })?;
 364                            index_changed = true;
 365                            debounce_timer = cx
 366                                .background_executor()
 367                                .timer(RELOAD_DEBOUNCE_DURATION)
 368                                .fuse();
 369                        }
 370                    }
 371                }
 372
 373                anyhow::Ok(())
 374            }
 375            .map(drop)
 376            .await;
 377        }));
 378
 379        // Watch the installed extensions directory for changes. Whenever changes are
 380        // detected, rebuild the extension index, and load/unload any extensions that
 381        // have been added, removed, or modified.
 382        this.tasks.push(cx.background_spawn({
 383            let fs = this.fs.clone();
 384            let reload_tx = this.reload_tx.clone();
 385            let installed_dir = this.installed_dir.clone();
 386            async move {
 387                let (mut paths, _) = fs.watch(&installed_dir, FS_WATCH_LATENCY).await;
 388                while let Some(events) = paths.next().await {
 389                    for event in events {
 390                        let Ok(event_path) = event.path.strip_prefix(&installed_dir) else {
 391                            continue;
 392                        };
 393
 394                        if let Some(path::Component::Normal(extension_dir_name)) =
 395                            event_path.components().next()
 396                            && let Some(extension_id) = extension_dir_name.to_str()
 397                        {
 398                            reload_tx.unbounded_send(Some(extension_id.into())).ok();
 399                        }
 400                    }
 401                }
 402            }
 403        }));
 404
 405        this
 406    }
 407
 408    pub fn reload(
 409        &mut self,
 410        modified_extension: Option<Arc<str>>,
 411        cx: &mut Context<Self>,
 412    ) -> impl Future<Output = ()> + use<> {
 413        let (tx, rx) = oneshot::channel();
 414        self.reload_complete_senders.push(tx);
 415        self.reload_tx
 416            .unbounded_send(modified_extension)
 417            .expect("reload task exited");
 418        cx.emit(Event::StartedReloading);
 419
 420        async move {
 421            rx.await.ok();
 422        }
 423    }
 424
 425    fn extensions_dir(&self) -> PathBuf {
 426        self.installed_dir.clone()
 427    }
 428
 429    pub fn outstanding_operations(&self) -> &BTreeMap<Arc<str>, ExtensionOperation> {
 430        &self.outstanding_operations
 431    }
 432
 433    pub fn installed_extensions(&self) -> &BTreeMap<Arc<str>, ExtensionIndexEntry> {
 434        &self.extension_index.extensions
 435    }
 436
 437    pub fn dev_extensions(&self) -> impl Iterator<Item = &Arc<ExtensionManifest>> {
 438        self.extension_index
 439            .extensions
 440            .values()
 441            .filter_map(|extension| extension.dev.then_some(&extension.manifest))
 442    }
 443
 444    pub fn extension_manifest_for_id(&self, extension_id: &str) -> Option<&Arc<ExtensionManifest>> {
 445        self.extension_index
 446            .extensions
 447            .get(extension_id)
 448            .map(|extension| &extension.manifest)
 449    }
 450
 451    /// Returns the names of themes provided by extensions.
 452    pub fn extension_themes<'a>(
 453        &'a self,
 454        extension_id: &'a str,
 455    ) -> impl Iterator<Item = &'a Arc<str>> {
 456        self.extension_index
 457            .themes
 458            .iter()
 459            .filter_map(|(name, theme)| theme.extension.as_ref().eq(extension_id).then_some(name))
 460    }
 461
 462    /// Returns the path to the theme file within an extension, if there is an
 463    /// extension that provides the theme.
 464    pub fn path_to_extension_theme(&self, theme_name: &str) -> Option<PathBuf> {
 465        let entry = self.extension_index.themes.get(theme_name)?;
 466
 467        Some(
 468            self.extensions_dir()
 469                .join(entry.extension.as_ref())
 470                .join(&entry.path),
 471        )
 472    }
 473
 474    /// Returns the names of icon themes provided by extensions.
 475    pub fn extension_icon_themes<'a>(
 476        &'a self,
 477        extension_id: &'a str,
 478    ) -> impl Iterator<Item = &'a Arc<str>> {
 479        self.extension_index
 480            .icon_themes
 481            .iter()
 482            .filter_map(|(name, icon_theme)| {
 483                icon_theme
 484                    .extension
 485                    .as_ref()
 486                    .eq(extension_id)
 487                    .then_some(name)
 488            })
 489    }
 490
 491    /// Returns the path to the icon theme file within an extension, if there is
 492    /// an extension that provides the icon theme.
 493    pub fn path_to_extension_icon_theme(
 494        &self,
 495        icon_theme_name: &str,
 496    ) -> Option<(PathBuf, PathBuf)> {
 497        let entry = self.extension_index.icon_themes.get(icon_theme_name)?;
 498
 499        let icon_theme_path = self
 500            .extensions_dir()
 501            .join(entry.extension.as_ref())
 502            .join(&entry.path);
 503        let icons_root_path = self.extensions_dir().join(entry.extension.as_ref());
 504
 505        Some((icon_theme_path, icons_root_path))
 506    }
 507
 508    pub fn fetch_extensions(
 509        &self,
 510        search: Option<&str>,
 511        provides_filter: Option<&BTreeSet<ExtensionProvides>>,
 512        cx: &mut Context<Self>,
 513    ) -> Task<Result<Vec<ExtensionMetadata>>> {
 514        let version = CURRENT_SCHEMA_VERSION.to_string();
 515        let mut query = vec![("max_schema_version", version.as_str())];
 516        if let Some(search) = search {
 517            query.push(("filter", search));
 518        }
 519
 520        let provides_filter = provides_filter.map(|provides_filter| {
 521            provides_filter
 522                .iter()
 523                .map(|provides| provides.to_string())
 524                .collect::<Vec<_>>()
 525                .join(",")
 526        });
 527        if let Some(provides_filter) = provides_filter.as_deref() {
 528            query.push(("provides", provides_filter));
 529        }
 530
 531        self.fetch_extensions_from_api("/extensions", &query, cx)
 532    }
 533
 534    pub fn fetch_extensions_with_update_available(
 535        &mut self,
 536        cx: &mut Context<Self>,
 537    ) -> Task<Result<Vec<ExtensionMetadata>>> {
 538        let schema_versions = schema_version_range();
 539        let wasm_api_versions = wasm_api_version_range(ReleaseChannel::global(cx));
 540        let extension_settings = ExtensionSettings::get_global(cx);
 541        let extension_ids = self
 542            .extension_index
 543            .extensions
 544            .iter()
 545            .filter(|(id, entry)| !entry.dev && extension_settings.should_auto_update(id))
 546            .map(|(id, _)| id.as_ref())
 547            .collect::<Vec<_>>()
 548            .join(",");
 549        let task = self.fetch_extensions_from_api(
 550            "/extensions/updates",
 551            &[
 552                ("min_schema_version", &schema_versions.start().to_string()),
 553                ("max_schema_version", &schema_versions.end().to_string()),
 554                (
 555                    "min_wasm_api_version",
 556                    &wasm_api_versions.start().to_string(),
 557                ),
 558                ("max_wasm_api_version", &wasm_api_versions.end().to_string()),
 559                ("ids", &extension_ids),
 560            ],
 561            cx,
 562        );
 563        cx.spawn(async move |this, cx| {
 564            let extensions = task.await?;
 565            this.update(cx, |this, _cx| {
 566                extensions
 567                    .into_iter()
 568                    .filter(|extension| {
 569                        this.extension_index
 570                            .extensions
 571                            .get(&extension.id)
 572                            .is_none_or(|installed_extension| {
 573                                installed_extension.manifest.version != extension.manifest.version
 574                            })
 575                    })
 576                    .collect()
 577            })
 578        })
 579    }
 580
 581    pub fn fetch_extension_versions(
 582        &self,
 583        extension_id: &str,
 584        cx: &mut Context<Self>,
 585    ) -> Task<Result<Vec<ExtensionMetadata>>> {
 586        self.fetch_extensions_from_api(&format!("/extensions/{extension_id}"), &[], cx)
 587    }
 588
 589    /// Installs any extensions that should be included with Zed by default.
 590    ///
 591    /// This can be used to make certain functionality provided by extensions
 592    /// available out-of-the-box.
 593    pub fn auto_install_extensions(&mut self, cx: &mut Context<Self>) {
 594        if cfg!(test) {
 595            return;
 596        }
 597
 598        let extension_settings = ExtensionSettings::get_global(cx);
 599
 600        let extensions_to_install = extension_settings
 601            .auto_install_extensions
 602            .keys()
 603            .filter(|extension_id| extension_settings.should_auto_install(extension_id))
 604            .filter(|extension_id| {
 605                let is_already_installed = self
 606                    .extension_index
 607                    .extensions
 608                    .contains_key(extension_id.as_ref());
 609                !is_already_installed && !SUPPRESSED_EXTENSIONS.contains(&extension_id.as_ref())
 610            })
 611            .cloned()
 612            .collect::<Vec<_>>();
 613
 614        cx.spawn(async move |this, cx| {
 615            for extension_id in extensions_to_install {
 616                this.update(cx, |this, cx| {
 617                    this.install_latest_extension(extension_id.clone(), cx);
 618                })
 619                .ok();
 620            }
 621        })
 622        .detach();
 623    }
 624
 625    pub fn check_for_updates(&mut self, cx: &mut Context<Self>) {
 626        let task = self.fetch_extensions_with_update_available(cx);
 627        cx.spawn(async move |this, cx| Self::upgrade_extensions(this, task.await?, cx).await)
 628            .detach();
 629    }
 630
 631    async fn upgrade_extensions(
 632        this: WeakEntity<Self>,
 633        extensions: Vec<ExtensionMetadata>,
 634        cx: &mut AsyncApp,
 635    ) -> Result<()> {
 636        for extension in extensions {
 637            let task = this.update(cx, |this, cx| {
 638                if let Some(installed_extension) =
 639                    this.extension_index.extensions.get(&extension.id)
 640                {
 641                    let installed_version =
 642                        Version::from_str(&installed_extension.manifest.version).ok()?;
 643                    let latest_version = Version::from_str(&extension.manifest.version).ok()?;
 644
 645                    if installed_version >= latest_version {
 646                        return None;
 647                    }
 648                }
 649
 650                Some(this.upgrade_extension(extension.id, extension.manifest.version, cx))
 651            })?;
 652
 653            if let Some(task) = task {
 654                task.await.log_err();
 655            }
 656        }
 657        anyhow::Ok(())
 658    }
 659
 660    fn fetch_extensions_from_api(
 661        &self,
 662        path: &str,
 663        query: &[(&str, &str)],
 664        cx: &mut Context<ExtensionStore>,
 665    ) -> Task<Result<Vec<ExtensionMetadata>>> {
 666        let url = self.http_client.build_zed_api_url(path, query);
 667        let http_client = self.http_client.clone();
 668        cx.spawn(async move |_, _| {
 669            let mut response = http_client
 670                .get(url?.as_ref(), AsyncBody::empty(), true)
 671                .await?;
 672
 673            let mut body = Vec::new();
 674            response
 675                .body_mut()
 676                .read_to_end(&mut body)
 677                .await
 678                .context("error reading extensions")?;
 679
 680            if response.status().is_client_error() {
 681                let text = String::from_utf8_lossy(body.as_slice());
 682                bail!(
 683                    "status error {}, response: {text:?}",
 684                    response.status().as_u16()
 685                );
 686            }
 687
 688            let mut response: GetExtensionsResponse = serde_json::from_slice(&body)?;
 689
 690            response
 691                .data
 692                .retain(|extension| !SUPPRESSED_EXTENSIONS.contains(&extension.id.as_ref()));
 693
 694            Ok(response.data)
 695        })
 696    }
 697
 698    pub fn install_extension(
 699        &mut self,
 700        extension_id: Arc<str>,
 701        version: Arc<str>,
 702        cx: &mut Context<Self>,
 703    ) {
 704        self.install_or_upgrade_extension(extension_id, version, ExtensionOperation::Install, cx)
 705            .detach_and_log_err(cx);
 706    }
 707
 708    fn install_or_upgrade_extension_at_endpoint(
 709        &mut self,
 710        extension_id: Arc<str>,
 711        url: Url,
 712        operation: ExtensionOperation,
 713        cx: &mut Context<Self>,
 714    ) -> Task<Result<()>> {
 715        let extension_dir = self.installed_dir.join(extension_id.as_ref());
 716        let http_client = self.http_client.clone();
 717        let fs = self.fs.clone();
 718
 719        match self.outstanding_operations.entry(extension_id.clone()) {
 720            btree_map::Entry::Occupied(_) => return Task::ready(Ok(())),
 721            btree_map::Entry::Vacant(e) => e.insert(operation),
 722        };
 723        cx.notify();
 724
 725        cx.spawn(async move |this, cx| {
 726            let _finish = cx.on_drop(&this, {
 727                let extension_id = extension_id.clone();
 728                move |this, cx| {
 729                    this.outstanding_operations.remove(extension_id.as_ref());
 730                    cx.notify();
 731                }
 732            });
 733
 734            let mut response = http_client
 735                .get(url.as_ref(), Default::default(), true)
 736                .await
 737                .context("downloading extension")?;
 738
 739            fs.remove_dir(
 740                &extension_dir,
 741                RemoveOptions {
 742                    recursive: true,
 743                    ignore_if_not_exists: true,
 744                },
 745            )
 746            .await?;
 747
 748            let content_length = response
 749                .headers()
 750                .get(http_client::http::header::CONTENT_LENGTH)
 751                .and_then(|value| value.to_str().ok()?.parse::<usize>().ok());
 752
 753            let mut body = BufReader::new(response.body_mut());
 754            let mut tar_gz_bytes = Vec::new();
 755            body.read_to_end(&mut tar_gz_bytes).await?;
 756
 757            if let Some(content_length) = content_length {
 758                let actual_len = tar_gz_bytes.len();
 759                if content_length != actual_len {
 760                    bail!(concat!(
 761                        "downloaded extension size {actual_len} ",
 762                        "does not match content length {content_length}"
 763                    ));
 764                }
 765            }
 766            let decompressed_bytes = GzipDecoder::new(BufReader::new(tar_gz_bytes.as_slice()));
 767            let archive = Archive::new(decompressed_bytes);
 768            archive.unpack(extension_dir).await?;
 769            this.update(cx, |this, cx| this.reload(Some(extension_id.clone()), cx))?
 770                .await;
 771
 772            if let ExtensionOperation::Install = operation {
 773                this.update(cx, |this, cx| {
 774                    cx.emit(Event::ExtensionInstalled(extension_id.clone()));
 775                    if let Some(events) = ExtensionEvents::try_global(cx)
 776                        && let Some(manifest) = this.extension_manifest_for_id(&extension_id)
 777                    {
 778                        events.update(cx, |this, cx| {
 779                            this.emit(extension::Event::ExtensionInstalled(manifest.clone()), cx)
 780                        });
 781                    }
 782                })
 783                .ok();
 784            }
 785
 786            anyhow::Ok(())
 787        })
 788    }
 789
 790    pub fn install_latest_extension(&mut self, extension_id: Arc<str>, cx: &mut Context<Self>) {
 791        log::info!("installing extension {extension_id} latest version");
 792
 793        let schema_versions = schema_version_range();
 794        let wasm_api_versions = wasm_api_version_range(ReleaseChannel::global(cx));
 795
 796        let Some(url) = self
 797            .http_client
 798            .build_zed_api_url(
 799                &format!("/extensions/{extension_id}/download"),
 800                &[
 801                    ("min_schema_version", &schema_versions.start().to_string()),
 802                    ("max_schema_version", &schema_versions.end().to_string()),
 803                    (
 804                        "min_wasm_api_version",
 805                        &wasm_api_versions.start().to_string(),
 806                    ),
 807                    ("max_wasm_api_version", &wasm_api_versions.end().to_string()),
 808                ],
 809            )
 810            .log_err()
 811        else {
 812            return;
 813        };
 814
 815        self.install_or_upgrade_extension_at_endpoint(
 816            extension_id,
 817            url,
 818            ExtensionOperation::Install,
 819            cx,
 820        )
 821        .detach_and_log_err(cx);
 822    }
 823
 824    pub fn upgrade_extension(
 825        &mut self,
 826        extension_id: Arc<str>,
 827        version: Arc<str>,
 828        cx: &mut Context<Self>,
 829    ) -> Task<Result<()>> {
 830        self.install_or_upgrade_extension(extension_id, version, ExtensionOperation::Upgrade, cx)
 831    }
 832
 833    fn install_or_upgrade_extension(
 834        &mut self,
 835        extension_id: Arc<str>,
 836        version: Arc<str>,
 837        operation: ExtensionOperation,
 838        cx: &mut Context<Self>,
 839    ) -> Task<Result<()>> {
 840        log::info!("installing extension {extension_id} {version}");
 841        let Some(url) = self
 842            .http_client
 843            .build_zed_api_url(
 844                &format!("/extensions/{extension_id}/{version}/download"),
 845                &[],
 846            )
 847            .log_err()
 848        else {
 849            return Task::ready(Ok(()));
 850        };
 851
 852        self.install_or_upgrade_extension_at_endpoint(extension_id, url, operation, cx)
 853    }
 854
 855    pub fn uninstall_extension(
 856        &mut self,
 857        extension_id: Arc<str>,
 858        cx: &mut Context<Self>,
 859    ) -> Task<Result<()>> {
 860        let extension_dir = self.installed_dir.join(extension_id.as_ref());
 861        let work_dir = self.wasm_host.work_dir.join(extension_id.as_ref());
 862        let fs = self.fs.clone();
 863
 864        let extension_manifest = self.extension_manifest_for_id(&extension_id).cloned();
 865
 866        match self.outstanding_operations.entry(extension_id.clone()) {
 867            btree_map::Entry::Occupied(_) => return Task::ready(Ok(())),
 868            btree_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Remove),
 869        };
 870
 871        cx.spawn(async move |extension_store, cx| {
 872            let _finish = cx.on_drop(&extension_store, {
 873                let extension_id = extension_id.clone();
 874                move |this, cx| {
 875                    this.outstanding_operations.remove(extension_id.as_ref());
 876                    cx.notify();
 877                }
 878            });
 879
 880            fs.remove_dir(
 881                &extension_dir,
 882                RemoveOptions {
 883                    recursive: true,
 884                    ignore_if_not_exists: true,
 885                },
 886            )
 887            .await
 888            .with_context(|| format!("Removing extension dir {extension_dir:?}"))?;
 889
 890            extension_store
 891                .update(cx, |extension_store, cx| extension_store.reload(None, cx))?
 892                .await;
 893
 894            // There's a race between wasm extension fully stopping and the directory removal.
 895            // On Windows, it's impossible to remove a directory that has a process running in it.
 896            for i in 0..3 {
 897                cx.background_executor()
 898                    .timer(Duration::from_millis(i * 100))
 899                    .await;
 900                let removal_result = fs
 901                    .remove_dir(
 902                        &work_dir,
 903                        RemoveOptions {
 904                            recursive: true,
 905                            ignore_if_not_exists: true,
 906                        },
 907                    )
 908                    .await;
 909                match removal_result {
 910                    Ok(()) => break,
 911                    Err(e) => {
 912                        if i == 2 {
 913                            log::error!("Failed to remove extension work dir {work_dir:?} : {e}");
 914                        }
 915                    }
 916                }
 917            }
 918
 919            extension_store.update(cx, |_, cx| {
 920                cx.emit(Event::ExtensionUninstalled(extension_id.clone()));
 921                if let Some(events) = ExtensionEvents::try_global(cx)
 922                    && let Some(manifest) = extension_manifest
 923                {
 924                    events.update(cx, |this, cx| {
 925                        this.emit(extension::Event::ExtensionUninstalled(manifest.clone()), cx)
 926                    });
 927                }
 928            })?;
 929
 930            anyhow::Ok(())
 931        })
 932    }
 933
 934    pub fn install_dev_extension(
 935        &mut self,
 936        extension_source_path: PathBuf,
 937        cx: &mut Context<Self>,
 938    ) -> Task<Result<()>> {
 939        let extensions_dir = self.extensions_dir();
 940        let fs = self.fs.clone();
 941        let builder = self.builder.clone();
 942
 943        cx.spawn(async move |this, cx| {
 944            let mut extension_manifest =
 945                ExtensionManifest::load(fs.clone(), &extension_source_path).await?;
 946            let extension_id = extension_manifest.id.clone();
 947
 948            if let Some(uninstall_task) = this
 949                .update(cx, |this, cx| {
 950                    this.extension_index
 951                        .extensions
 952                        .get(extension_id.as_ref())
 953                        .is_some_and(|index_entry| !index_entry.dev)
 954                        .then(|| this.uninstall_extension(extension_id.clone(), cx))
 955                })
 956                .ok()
 957                .flatten()
 958            {
 959                uninstall_task.await.log_err();
 960            }
 961
 962            if !this.update(cx, |this, cx| {
 963                match this.outstanding_operations.entry(extension_id.clone()) {
 964                    btree_map::Entry::Occupied(_) => return false,
 965                    btree_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Install),
 966                };
 967                cx.notify();
 968                true
 969            })? {
 970                return Ok(());
 971            }
 972
 973            let _finish = cx.on_drop(&this, {
 974                let extension_id = extension_id.clone();
 975                move |this, cx| {
 976                    this.outstanding_operations.remove(extension_id.as_ref());
 977                    cx.notify();
 978                }
 979            });
 980
 981            cx.background_spawn({
 982                let extension_source_path = extension_source_path.clone();
 983                async move {
 984                    builder
 985                        .compile_extension(
 986                            &extension_source_path,
 987                            &mut extension_manifest,
 988                            CompileExtensionOptions { release: false },
 989                        )
 990                        .await
 991                }
 992            })
 993            .await
 994            .inspect_err(|error| {
 995                util::log_err(error);
 996            })?;
 997
 998            let output_path = &extensions_dir.join(extension_id.as_ref());
 999            if let Some(metadata) = fs.metadata(output_path).await? {
1000                if metadata.is_symlink {
1001                    fs.remove_file(
1002                        output_path,
1003                        RemoveOptions {
1004                            recursive: false,
1005                            ignore_if_not_exists: true,
1006                        },
1007                    )
1008                    .await?;
1009                } else {
1010                    bail!("extension {extension_id} is still installed");
1011                }
1012            }
1013
1014            fs.create_symlink(output_path, extension_source_path)
1015                .await?;
1016
1017            this.update(cx, |this, cx| this.reload(None, cx))?.await;
1018            this.update(cx, |this, cx| {
1019                cx.emit(Event::ExtensionInstalled(extension_id.clone()));
1020                if let Some(events) = ExtensionEvents::try_global(cx)
1021                    && let Some(manifest) = this.extension_manifest_for_id(&extension_id)
1022                {
1023                    events.update(cx, |this, cx| {
1024                        this.emit(extension::Event::ExtensionInstalled(manifest.clone()), cx)
1025                    });
1026                }
1027            })?;
1028
1029            Ok(())
1030        })
1031    }
1032
1033    pub fn rebuild_dev_extension(&mut self, extension_id: Arc<str>, cx: &mut Context<Self>) {
1034        let path = self.installed_dir.join(extension_id.as_ref());
1035        let builder = self.builder.clone();
1036        let fs = self.fs.clone();
1037
1038        match self.outstanding_operations.entry(extension_id.clone()) {
1039            btree_map::Entry::Occupied(_) => return,
1040            btree_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Upgrade),
1041        };
1042
1043        cx.notify();
1044        let compile = cx.background_spawn(async move {
1045            let mut manifest = ExtensionManifest::load(fs, &path).await?;
1046            builder
1047                .compile_extension(
1048                    &path,
1049                    &mut manifest,
1050                    CompileExtensionOptions { release: true },
1051                )
1052                .await
1053        });
1054
1055        cx.spawn(async move |this, cx| {
1056            let result = compile.await;
1057
1058            this.update(cx, |this, cx| {
1059                this.outstanding_operations.remove(&extension_id);
1060                cx.notify();
1061            })?;
1062
1063            if result.is_ok() {
1064                this.update(cx, |this, cx| this.reload(Some(extension_id), cx))?
1065                    .await;
1066            }
1067
1068            result
1069        })
1070        .detach_and_log_err(cx)
1071    }
1072
1073    /// Updates the set of installed extensions.
1074    ///
1075    /// First, this unloads any themes, languages, or grammars that are
1076    /// no longer in the manifest, or whose files have changed on disk.
1077    /// Then it loads any themes, languages, or grammars that are newly
1078    /// added to the manifest, or whose files have changed on disk.
1079    fn extensions_updated(
1080        &mut self,
1081        mut new_index: ExtensionIndex,
1082        cx: &mut Context<Self>,
1083    ) -> Task<()> {
1084        let old_index = &self.extension_index;
1085
1086        new_index
1087            .extensions
1088            .retain(|extension_id, _| !SUPPRESSED_EXTENSIONS.contains(&extension_id.as_ref()));
1089
1090        // Determine which extensions need to be loaded and unloaded, based
1091        // on the changes to the manifest and the extensions that we know have been
1092        // modified.
1093        let mut extensions_to_unload = Vec::default();
1094        let mut extensions_to_load = Vec::default();
1095        {
1096            let mut old_keys = old_index.extensions.iter().peekable();
1097            let mut new_keys = new_index.extensions.iter().peekable();
1098            loop {
1099                match (old_keys.peek(), new_keys.peek()) {
1100                    (None, None) => break,
1101                    (None, Some(_)) => {
1102                        extensions_to_load.push(new_keys.next().unwrap().0.clone());
1103                    }
1104                    (Some(_), None) => {
1105                        extensions_to_unload.push(old_keys.next().unwrap().0.clone());
1106                    }
1107                    (Some((old_key, _)), Some((new_key, _))) => match old_key.cmp(new_key) {
1108                        Ordering::Equal => {
1109                            let (old_key, old_value) = old_keys.next().unwrap();
1110                            let (new_key, new_value) = new_keys.next().unwrap();
1111                            if old_value != new_value || self.modified_extensions.contains(old_key)
1112                            {
1113                                extensions_to_unload.push(old_key.clone());
1114                                extensions_to_load.push(new_key.clone());
1115                            }
1116                        }
1117                        Ordering::Less => {
1118                            extensions_to_unload.push(old_keys.next().unwrap().0.clone());
1119                        }
1120                        Ordering::Greater => {
1121                            extensions_to_load.push(new_keys.next().unwrap().0.clone());
1122                        }
1123                    },
1124                }
1125            }
1126            self.modified_extensions.clear();
1127        }
1128
1129        if extensions_to_load.is_empty() && extensions_to_unload.is_empty() {
1130            self.reload_complete_senders.clear();
1131            return Task::ready(());
1132        }
1133
1134        let reload_count = extensions_to_unload
1135            .iter()
1136            .filter(|id| extensions_to_load.contains(id))
1137            .count();
1138
1139        log::info!(
1140            "extensions updated. loading {}, reloading {}, unloading {}",
1141            extensions_to_load.len() - reload_count,
1142            reload_count,
1143            extensions_to_unload.len() - reload_count
1144        );
1145
1146        let extension_ids = extensions_to_load
1147            .iter()
1148            .filter_map(|id| {
1149                Some((
1150                    id.clone(),
1151                    new_index.extensions.get(id)?.manifest.version.clone(),
1152                ))
1153            })
1154            .collect::<Vec<_>>();
1155
1156        telemetry::event!("Extensions Loaded", id_and_versions = extension_ids);
1157
1158        let themes_to_remove = old_index
1159            .themes
1160            .iter()
1161            .filter_map(|(name, entry)| {
1162                if extensions_to_unload.contains(&entry.extension) {
1163                    Some(name.clone().into())
1164                } else {
1165                    None
1166                }
1167            })
1168            .collect::<Vec<_>>();
1169        let icon_themes_to_remove = old_index
1170            .icon_themes
1171            .iter()
1172            .filter_map(|(name, entry)| {
1173                if extensions_to_unload.contains(&entry.extension) {
1174                    Some(name.clone().into())
1175                } else {
1176                    None
1177                }
1178            })
1179            .collect::<Vec<_>>();
1180        let languages_to_remove = old_index
1181            .languages
1182            .iter()
1183            .filter_map(|(name, entry)| {
1184                if extensions_to_unload.contains(&entry.extension) {
1185                    Some(name.clone())
1186                } else {
1187                    None
1188                }
1189            })
1190            .collect::<Vec<_>>();
1191        let mut grammars_to_remove = Vec::new();
1192        let mut server_removal_tasks = Vec::with_capacity(extensions_to_unload.len());
1193        for extension_id in &extensions_to_unload {
1194            let Some(extension) = old_index.extensions.get(extension_id) else {
1195                continue;
1196            };
1197            grammars_to_remove.extend(extension.manifest.grammars.keys().cloned());
1198            for (language_server_name, config) in &extension.manifest.language_servers {
1199                for language in config.languages() {
1200                    server_removal_tasks.push(self.proxy.remove_language_server(
1201                        &language,
1202                        language_server_name,
1203                        cx,
1204                    ));
1205                }
1206            }
1207
1208            for server_id in extension.manifest.context_servers.keys() {
1209                self.proxy.unregister_context_server(server_id.clone(), cx);
1210            }
1211            for adapter in extension.manifest.debug_adapters.keys() {
1212                self.proxy.unregister_debug_adapter(adapter.clone());
1213            }
1214            for locator in extension.manifest.debug_locators.keys() {
1215                self.proxy.unregister_debug_locator(locator.clone());
1216            }
1217            for command_name in extension.manifest.slash_commands.keys() {
1218                self.proxy.unregister_slash_command(command_name.clone());
1219            }
1220        }
1221
1222        self.wasm_extensions
1223            .retain(|(extension, _)| !extensions_to_unload.contains(&extension.id));
1224        self.proxy.remove_user_themes(themes_to_remove);
1225        self.proxy.remove_icon_themes(icon_themes_to_remove);
1226        self.proxy
1227            .remove_languages(&languages_to_remove, &grammars_to_remove);
1228
1229        let mut grammars_to_add = Vec::new();
1230        let mut themes_to_add = Vec::new();
1231        let mut icon_themes_to_add = Vec::new();
1232        let mut snippets_to_add = Vec::new();
1233        for extension_id in &extensions_to_load {
1234            let Some(extension) = new_index.extensions.get(extension_id) else {
1235                continue;
1236            };
1237
1238            grammars_to_add.extend(extension.manifest.grammars.keys().map(|grammar_name| {
1239                let mut grammar_path = self.installed_dir.clone();
1240                grammar_path.extend([extension_id.as_ref(), "grammars"]);
1241                grammar_path.push(grammar_name.as_ref());
1242                grammar_path.set_extension("wasm");
1243                (grammar_name.clone(), grammar_path)
1244            }));
1245            themes_to_add.extend(extension.manifest.themes.iter().map(|theme_path| {
1246                let mut path = self.installed_dir.clone();
1247                path.extend([Path::new(extension_id.as_ref()), theme_path.as_path()]);
1248                path
1249            }));
1250            icon_themes_to_add.extend(extension.manifest.icon_themes.iter().map(
1251                |icon_theme_path| {
1252                    let mut path = self.installed_dir.clone();
1253                    path.extend([Path::new(extension_id.as_ref()), icon_theme_path.as_path()]);
1254
1255                    let mut icons_root_path = self.installed_dir.clone();
1256                    icons_root_path.extend([Path::new(extension_id.as_ref())]);
1257
1258                    (path, icons_root_path)
1259                },
1260            ));
1261            snippets_to_add.extend(extension.manifest.snippets.iter().map(|snippets_path| {
1262                let mut path = self.installed_dir.clone();
1263                path.extend([Path::new(extension_id.as_ref()), snippets_path.as_path()]);
1264                path
1265            }));
1266        }
1267
1268        self.proxy.register_grammars(grammars_to_add);
1269        let languages_to_add = new_index
1270            .languages
1271            .iter()
1272            .filter(|(_, entry)| extensions_to_load.contains(&entry.extension))
1273            .collect::<Vec<_>>();
1274        for (language_name, language) in languages_to_add {
1275            let mut language_path = self.installed_dir.clone();
1276            language_path.extend([
1277                Path::new(language.extension.as_ref()),
1278                language.path.as_path(),
1279            ]);
1280            self.proxy.register_language(
1281                language_name.clone(),
1282                language.grammar.clone(),
1283                language.matcher.clone(),
1284                language.hidden,
1285                Arc::new(move || {
1286                    let config = std::fs::read_to_string(language_path.join("config.toml"))?;
1287                    let config: LanguageConfig = ::toml::from_str(&config)?;
1288                    let queries = load_plugin_queries(&language_path);
1289                    let context_provider =
1290                        std::fs::read_to_string(language_path.join("tasks.json"))
1291                            .ok()
1292                            .and_then(|contents| {
1293                                let definitions =
1294                                    serde_json_lenient::from_str(&contents).log_err()?;
1295                                Some(Arc::new(ContextProviderWithTasks::new(definitions)) as Arc<_>)
1296                            });
1297
1298                    Ok(LoadedLanguage {
1299                        config,
1300                        queries,
1301                        context_provider,
1302                        toolchain_provider: None,
1303                        manifest_name: None,
1304                    })
1305                }),
1306            );
1307        }
1308
1309        let fs = self.fs.clone();
1310        let wasm_host = self.wasm_host.clone();
1311        let root_dir = self.installed_dir.clone();
1312        let proxy = self.proxy.clone();
1313        let extension_entries = extensions_to_load
1314            .iter()
1315            .filter_map(|name| new_index.extensions.get(name).cloned())
1316            .collect::<Vec<_>>();
1317        self.extension_index = new_index;
1318        cx.notify();
1319        cx.emit(Event::ExtensionsUpdated);
1320
1321        cx.spawn(async move |this, cx| {
1322            cx.background_spawn({
1323                let fs = fs.clone();
1324                async move {
1325                    let _ = join_all(server_removal_tasks).await;
1326                    for theme_path in themes_to_add {
1327                        proxy
1328                            .load_user_theme(theme_path, fs.clone())
1329                            .await
1330                            .log_err();
1331                    }
1332
1333                    for (icon_theme_path, icons_root_path) in icon_themes_to_add {
1334                        proxy
1335                            .load_icon_theme(icon_theme_path, icons_root_path, fs.clone())
1336                            .await
1337                            .log_err();
1338                    }
1339
1340                    for snippets_path in &snippets_to_add {
1341                        match fs
1342                            .load(snippets_path)
1343                            .await
1344                            .with_context(|| format!("Loading snippets from {snippets_path:?}"))
1345                        {
1346                            Ok(snippets_contents) => {
1347                                proxy
1348                                    .register_snippet(snippets_path, &snippets_contents)
1349                                    .log_err();
1350                            }
1351                            Err(e) => log::error!("Cannot load snippets: {e:#}"),
1352                        }
1353                    }
1354                }
1355            })
1356            .await;
1357
1358            let mut wasm_extensions = Vec::new();
1359            for extension in extension_entries {
1360                if extension.manifest.lib.kind.is_none() {
1361                    continue;
1362                };
1363
1364                let extension_path = root_dir.join(extension.manifest.id.as_ref());
1365                let wasm_extension = WasmExtension::load(
1366                    &extension_path,
1367                    &extension.manifest,
1368                    wasm_host.clone(),
1369                    cx,
1370                )
1371                .await
1372                .with_context(|| format!("Loading extension from {extension_path:?}"));
1373
1374                match wasm_extension {
1375                    Ok(wasm_extension) => {
1376                        wasm_extensions.push((extension.manifest.clone(), wasm_extension))
1377                    }
1378                    Err(e) => {
1379                        log::error!("Failed to load extension: {e:#}");
1380                        this.update(cx, |_, cx| {
1381                            cx.emit(Event::ExtensionFailedToLoad(extension.manifest.id.clone()))
1382                        })
1383                        .ok();
1384                    }
1385                }
1386            }
1387
1388            this.update(cx, |this, cx| {
1389                this.reload_complete_senders.clear();
1390
1391                for (manifest, wasm_extension) in &wasm_extensions {
1392                    let extension = Arc::new(wasm_extension.clone());
1393
1394                    for (language_server_id, language_server_config) in &manifest.language_servers {
1395                        for language in language_server_config.languages() {
1396                            this.proxy.register_language_server(
1397                                extension.clone(),
1398                                language_server_id.clone(),
1399                                language.clone(),
1400                            );
1401                        }
1402                    }
1403
1404                    for (slash_command_name, slash_command) in &manifest.slash_commands {
1405                        this.proxy.register_slash_command(
1406                            extension.clone(),
1407                            extension::SlashCommand {
1408                                name: slash_command_name.to_string(),
1409                                description: slash_command.description.to_string(),
1410                                // We don't currently expose this as a configurable option, as it currently drives
1411                                // the `menu_text` on the `SlashCommand` trait, which is not used for slash commands
1412                                // defined in extensions, as they are not able to be added to the menu.
1413                                tooltip_text: String::new(),
1414                                requires_argument: slash_command.requires_argument,
1415                            },
1416                        );
1417                    }
1418
1419                    for id in manifest.context_servers.keys() {
1420                        this.proxy
1421                            .register_context_server(extension.clone(), id.clone(), cx);
1422                    }
1423
1424                    for (debug_adapter, meta) in &manifest.debug_adapters {
1425                        let mut path = root_dir.clone();
1426                        path.push(Path::new(manifest.id.as_ref()));
1427                        if let Some(schema_path) = &meta.schema_path {
1428                            path.push(schema_path);
1429                        } else {
1430                            path.push("debug_adapter_schemas");
1431                            path.push(Path::new(debug_adapter.as_ref()).with_extension("json"));
1432                        }
1433
1434                        this.proxy.register_debug_adapter(
1435                            extension.clone(),
1436                            debug_adapter.clone(),
1437                            &path,
1438                        );
1439                    }
1440
1441                    for debug_adapter in manifest.debug_locators.keys() {
1442                        this.proxy
1443                            .register_debug_locator(extension.clone(), debug_adapter.clone());
1444                    }
1445                }
1446
1447                this.wasm_extensions.extend(wasm_extensions);
1448                this.proxy.set_extensions_loaded();
1449                this.proxy.reload_current_theme(cx);
1450                this.proxy.reload_current_icon_theme(cx);
1451
1452                if let Some(events) = ExtensionEvents::try_global(cx) {
1453                    events.update(cx, |this, cx| {
1454                        this.emit(extension::Event::ExtensionsInstalledChanged, cx)
1455                    });
1456                }
1457            })
1458            .ok();
1459        })
1460    }
1461
1462    fn rebuild_extension_index(&self, cx: &mut Context<Self>) -> Task<ExtensionIndex> {
1463        let fs = self.fs.clone();
1464        let work_dir = self.wasm_host.work_dir.clone();
1465        let extensions_dir = self.installed_dir.clone();
1466        let index_path = self.index_path.clone();
1467        let proxy = self.proxy.clone();
1468        cx.background_spawn(async move {
1469            let start_time = Instant::now();
1470            let mut index = ExtensionIndex::default();
1471
1472            fs.create_dir(&work_dir).await.log_err();
1473            fs.create_dir(&extensions_dir).await.log_err();
1474
1475            let extension_paths = fs.read_dir(&extensions_dir).await;
1476            if let Ok(mut extension_paths) = extension_paths {
1477                while let Some(extension_dir) = extension_paths.next().await {
1478                    let Ok(extension_dir) = extension_dir else {
1479                        continue;
1480                    };
1481
1482                    if extension_dir
1483                        .file_name()
1484                        .is_some_and(|file_name| file_name == ".DS_Store")
1485                    {
1486                        continue;
1487                    }
1488
1489                    Self::add_extension_to_index(
1490                        fs.clone(),
1491                        extension_dir,
1492                        &mut index,
1493                        proxy.clone(),
1494                    )
1495                    .await
1496                    .log_err();
1497                }
1498            }
1499
1500            if let Ok(index_json) = serde_json::to_string_pretty(&index) {
1501                fs.save(&index_path, &index_json.as_str().into(), Default::default())
1502                    .await
1503                    .context("failed to save extension index")
1504                    .log_err();
1505            }
1506
1507            log::info!("rebuilt extension index in {:?}", start_time.elapsed());
1508            index
1509        })
1510    }
1511
1512    async fn add_extension_to_index(
1513        fs: Arc<dyn Fs>,
1514        extension_dir: PathBuf,
1515        index: &mut ExtensionIndex,
1516        proxy: Arc<ExtensionHostProxy>,
1517    ) -> Result<()> {
1518        let mut extension_manifest = ExtensionManifest::load(fs.clone(), &extension_dir).await?;
1519        let extension_id = extension_manifest.id.clone();
1520
1521        if SUPPRESSED_EXTENSIONS.contains(&extension_id.as_ref()) {
1522            return Ok(());
1523        }
1524
1525        // TODO: distinguish dev extensions more explicitly, by the absence
1526        // of a checksum file that we'll create when downloading normal extensions.
1527        let is_dev = fs
1528            .metadata(&extension_dir)
1529            .await?
1530            .context("directory does not exist")?
1531            .is_symlink;
1532
1533        if let Ok(mut language_paths) = fs.read_dir(&extension_dir.join("languages")).await {
1534            while let Some(language_path) = language_paths.next().await {
1535                let language_path = language_path?;
1536                let Ok(relative_path) = language_path.strip_prefix(&extension_dir) else {
1537                    continue;
1538                };
1539                let Ok(Some(fs_metadata)) = fs.metadata(&language_path).await else {
1540                    continue;
1541                };
1542                if !fs_metadata.is_dir {
1543                    continue;
1544                }
1545                let config = fs.load(&language_path.join("config.toml")).await?;
1546                let config = ::toml::from_str::<LanguageConfig>(&config)?;
1547
1548                let relative_path = relative_path.to_path_buf();
1549                if !extension_manifest.languages.contains(&relative_path) {
1550                    extension_manifest.languages.push(relative_path.clone());
1551                }
1552
1553                index.languages.insert(
1554                    config.name.clone(),
1555                    ExtensionIndexLanguageEntry {
1556                        extension: extension_id.clone(),
1557                        path: relative_path,
1558                        matcher: config.matcher,
1559                        hidden: config.hidden,
1560                        grammar: config.grammar,
1561                    },
1562                );
1563            }
1564        }
1565
1566        if let Ok(mut theme_paths) = fs.read_dir(&extension_dir.join("themes")).await {
1567            while let Some(theme_path) = theme_paths.next().await {
1568                let theme_path = theme_path?;
1569                let Ok(relative_path) = theme_path.strip_prefix(&extension_dir) else {
1570                    continue;
1571                };
1572
1573                let Some(theme_families) = proxy
1574                    .list_theme_names(theme_path.clone(), fs.clone())
1575                    .await
1576                    .log_err()
1577                else {
1578                    continue;
1579                };
1580
1581                let relative_path = relative_path.to_path_buf();
1582                if !extension_manifest.themes.contains(&relative_path) {
1583                    extension_manifest.themes.push(relative_path.clone());
1584                }
1585
1586                for theme_name in theme_families {
1587                    index.themes.insert(
1588                        theme_name.into(),
1589                        ExtensionIndexThemeEntry {
1590                            extension: extension_id.clone(),
1591                            path: relative_path.clone(),
1592                        },
1593                    );
1594                }
1595            }
1596        }
1597
1598        if let Ok(mut icon_theme_paths) = fs.read_dir(&extension_dir.join("icon_themes")).await {
1599            while let Some(icon_theme_path) = icon_theme_paths.next().await {
1600                let icon_theme_path = icon_theme_path?;
1601                let Ok(relative_path) = icon_theme_path.strip_prefix(&extension_dir) else {
1602                    continue;
1603                };
1604
1605                let Some(icon_theme_families) = proxy
1606                    .list_icon_theme_names(icon_theme_path.clone(), fs.clone())
1607                    .await
1608                    .log_err()
1609                else {
1610                    continue;
1611                };
1612
1613                let relative_path = relative_path.to_path_buf();
1614                if !extension_manifest.icon_themes.contains(&relative_path) {
1615                    extension_manifest.icon_themes.push(relative_path.clone());
1616                }
1617
1618                for icon_theme_name in icon_theme_families {
1619                    index.icon_themes.insert(
1620                        icon_theme_name.into(),
1621                        ExtensionIndexIconThemeEntry {
1622                            extension: extension_id.clone(),
1623                            path: relative_path.clone(),
1624                        },
1625                    );
1626                }
1627            }
1628        }
1629
1630        let extension_wasm_path = extension_dir.join("extension.wasm");
1631        if fs.is_file(&extension_wasm_path).await {
1632            extension_manifest
1633                .lib
1634                .kind
1635                .get_or_insert(ExtensionLibraryKind::Rust);
1636        }
1637
1638        index.extensions.insert(
1639            extension_id.clone(),
1640            ExtensionIndexEntry {
1641                dev: is_dev,
1642                manifest: Arc::new(extension_manifest),
1643            },
1644        );
1645
1646        Ok(())
1647    }
1648
1649    fn prepare_remote_extension(
1650        &mut self,
1651        extension_id: Arc<str>,
1652        is_dev: bool,
1653        tmp_dir: PathBuf,
1654        cx: &mut Context<Self>,
1655    ) -> Task<Result<()>> {
1656        let src_dir = self.extensions_dir().join(extension_id.as_ref());
1657        let Some(loaded_extension) = self.extension_index.extensions.get(&extension_id).cloned()
1658        else {
1659            return Task::ready(Err(anyhow!("extension no longer installed")));
1660        };
1661        let fs = self.fs.clone();
1662        cx.background_spawn(async move {
1663            const EXTENSION_TOML: &str = "extension.toml";
1664            const EXTENSION_WASM: &str = "extension.wasm";
1665            const CONFIG_TOML: &str = "config.toml";
1666
1667            if is_dev {
1668                let manifest_toml = toml::to_string(&loaded_extension.manifest)?;
1669                fs.save(
1670                    &tmp_dir.join(EXTENSION_TOML),
1671                    &Rope::from(manifest_toml),
1672                    language::LineEnding::Unix,
1673                )
1674                .await?;
1675            } else {
1676                fs.copy_file(
1677                    &src_dir.join(EXTENSION_TOML),
1678                    &tmp_dir.join(EXTENSION_TOML),
1679                    fs::CopyOptions::default(),
1680                )
1681                .await?
1682            }
1683
1684            if fs.is_file(&src_dir.join(EXTENSION_WASM)).await {
1685                fs.copy_file(
1686                    &src_dir.join(EXTENSION_WASM),
1687                    &tmp_dir.join(EXTENSION_WASM),
1688                    fs::CopyOptions::default(),
1689                )
1690                .await?
1691            }
1692
1693            for language_path in loaded_extension.manifest.languages.iter() {
1694                if fs
1695                    .is_file(&src_dir.join(language_path).join(CONFIG_TOML))
1696                    .await
1697                {
1698                    fs.create_dir(&tmp_dir.join(language_path)).await?;
1699                    fs.copy_file(
1700                        &src_dir.join(language_path).join(CONFIG_TOML),
1701                        &tmp_dir.join(language_path).join(CONFIG_TOML),
1702                        fs::CopyOptions::default(),
1703                    )
1704                    .await?
1705                }
1706            }
1707
1708            for (adapter_name, meta) in loaded_extension.manifest.debug_adapters.iter() {
1709                let schema_path = &extension::build_debug_adapter_schema_path(adapter_name, meta);
1710
1711                if fs.is_file(&src_dir.join(schema_path)).await {
1712                    if let Some(parent) = schema_path.parent() {
1713                        fs.create_dir(&tmp_dir.join(parent)).await?
1714                    }
1715                    fs.copy_file(
1716                        &src_dir.join(schema_path),
1717                        &tmp_dir.join(schema_path),
1718                        fs::CopyOptions::default(),
1719                    )
1720                    .await?
1721                }
1722            }
1723
1724            Ok(())
1725        })
1726    }
1727
1728    async fn sync_extensions_to_remotes(
1729        this: &WeakEntity<Self>,
1730        client: WeakEntity<RemoteClient>,
1731        cx: &mut AsyncApp,
1732    ) -> Result<()> {
1733        let extensions = this.update(cx, |this, _cx| {
1734            this.extension_index
1735                .extensions
1736                .iter()
1737                .filter_map(|(id, entry)| {
1738                    if !entry.manifest.allow_remote_load() {
1739                        return None;
1740                    }
1741                    Some(proto::Extension {
1742                        id: id.to_string(),
1743                        version: entry.manifest.version.to_string(),
1744                        dev: entry.dev,
1745                    })
1746                })
1747                .collect()
1748        })?;
1749
1750        let response = client
1751            .update(cx, |client, _cx| {
1752                client
1753                    .proto_client()
1754                    .request(proto::SyncExtensions { extensions })
1755            })?
1756            .await?;
1757        let path_style = client.read_with(cx, |client, _| client.path_style())?;
1758
1759        for missing_extension in response.missing_extensions.into_iter() {
1760            let tmp_dir = tempfile::tempdir()?;
1761            this.update(cx, |this, cx| {
1762                this.prepare_remote_extension(
1763                    missing_extension.id.clone().into(),
1764                    missing_extension.dev,
1765                    tmp_dir.path().to_owned(),
1766                    cx,
1767                )
1768            })?
1769            .await?;
1770            let dest_dir = RemotePathBuf::new(
1771                path_style
1772                    .join(&response.tmp_dir, &missing_extension.id)
1773                    .with_context(|| {
1774                        format!(
1775                            "failed to construct destination path: {:?}, {:?}",
1776                            response.tmp_dir, missing_extension.id,
1777                        )
1778                    })?,
1779                path_style,
1780            );
1781            log::info!(
1782                "Uploading extension {} to {:?}",
1783                missing_extension.clone().id,
1784                dest_dir
1785            );
1786
1787            client
1788                .update(cx, |client, cx| {
1789                    client.upload_directory(tmp_dir.path().to_owned(), dest_dir.clone(), cx)
1790                })?
1791                .await?;
1792
1793            log::info!(
1794                "Finished uploading extension {}",
1795                missing_extension.clone().id
1796            );
1797
1798            let result = client
1799                .update(cx, |client, _cx| {
1800                    client.proto_client().request(proto::InstallExtension {
1801                        tmp_dir: dest_dir.to_proto(),
1802                        extension: Some(missing_extension.clone()),
1803                    })
1804                })?
1805                .await;
1806
1807            if let Err(e) = result {
1808                log::error!(
1809                    "Failed to install extension {}: {}",
1810                    missing_extension.id,
1811                    e
1812                );
1813            }
1814        }
1815
1816        anyhow::Ok(())
1817    }
1818
1819    pub async fn update_remote_clients(this: &WeakEntity<Self>, cx: &mut AsyncApp) -> Result<()> {
1820        let clients = this.update(cx, |this, _cx| {
1821            this.remote_clients.retain(|v| v.upgrade().is_some());
1822            this.remote_clients.clone()
1823        })?;
1824
1825        for client in clients {
1826            Self::sync_extensions_to_remotes(this, client, cx)
1827                .await
1828                .log_err();
1829        }
1830
1831        anyhow::Ok(())
1832    }
1833
1834    pub fn register_remote_client(
1835        &mut self,
1836        client: Entity<RemoteClient>,
1837        _cx: &mut Context<Self>,
1838    ) {
1839        self.remote_clients.push(client.downgrade());
1840        self.ssh_registered_tx.unbounded_send(()).ok();
1841    }
1842}
1843
1844fn load_plugin_queries(root_path: &Path) -> LanguageQueries {
1845    let mut result = LanguageQueries::default();
1846    if let Some(entries) = std::fs::read_dir(root_path).log_err() {
1847        for entry in entries {
1848            let Some(entry) = entry.log_err() else {
1849                continue;
1850            };
1851            let path = entry.path();
1852            if let Some(remainder) = path.strip_prefix(root_path).ok().and_then(|p| p.to_str()) {
1853                if !remainder.ends_with(".scm") {
1854                    continue;
1855                }
1856                for (name, query) in QUERY_FILENAME_PREFIXES {
1857                    if remainder.starts_with(name) {
1858                        if let Some(contents) = std::fs::read_to_string(&path).log_err() {
1859                            match query(&mut result) {
1860                                None => *query(&mut result) = Some(contents.into()),
1861                                Some(r) => r.to_mut().push_str(contents.as_ref()),
1862                            }
1863                        }
1864                        break;
1865                    }
1866                }
1867            }
1868        }
1869    }
1870    result
1871}