extension_store.rs

   1pub mod extension_builder;
   2mod extension_lsp_adapter;
   3mod extension_manifest;
   4mod wasm_host;
   5
   6#[cfg(test)]
   7mod extension_store_test;
   8
   9use crate::{extension_lsp_adapter::ExtensionLspAdapter, wasm_host::wit};
  10use anyhow::{anyhow, bail, Context as _, Result};
  11use async_compression::futures::bufread::GzipDecoder;
  12use async_tar::Archive;
  13use client::{telemetry::Telemetry, Client};
  14use collections::{hash_map, BTreeMap, HashMap, HashSet};
  15use extension_builder::{CompileExtensionOptions, ExtensionBuilder};
  16use fs::{Fs, RemoveOptions};
  17use futures::{
  18    channel::{
  19        mpsc::{unbounded, UnboundedSender},
  20        oneshot,
  21    },
  22    io::BufReader,
  23    select_biased, AsyncReadExt as _, Future, FutureExt as _, StreamExt as _,
  24};
  25use gpui::{actions, AppContext, Context, EventEmitter, Global, Model, ModelContext, Task};
  26use language::{
  27    ContextProviderWithTasks, LanguageConfig, LanguageMatcher, LanguageQueries, LanguageRegistry,
  28    QUERY_FILENAME_PREFIXES,
  29};
  30use node_runtime::NodeRuntime;
  31use serde::{Deserialize, Serialize};
  32use std::{
  33    cmp::Ordering,
  34    path::{self, Path, PathBuf},
  35    sync::Arc,
  36    time::{Duration, Instant},
  37};
  38use theme::{ThemeRegistry, ThemeSettings};
  39use url::Url;
  40use util::{
  41    http::{AsyncBody, HttpClient, HttpClientWithUrl},
  42    maybe,
  43    paths::EXTENSIONS_DIR,
  44    ResultExt,
  45};
  46use wasm_host::{WasmExtension, WasmHost};
  47
  48pub use extension_manifest::{
  49    ExtensionLibraryKind, ExtensionManifest, GrammarManifestEntry, OldExtensionManifest,
  50};
  51
  52const RELOAD_DEBOUNCE_DURATION: Duration = Duration::from_millis(200);
  53const FS_WATCH_LATENCY: Duration = Duration::from_millis(100);
  54
  55const CURRENT_SCHEMA_VERSION: i64 = 1;
  56
  57#[derive(Deserialize)]
  58pub struct ExtensionsApiResponse {
  59    pub data: Vec<ExtensionApiResponse>,
  60}
  61
  62#[derive(Clone, Deserialize)]
  63pub struct ExtensionApiResponse {
  64    pub id: Arc<str>,
  65    pub name: String,
  66    pub version: Arc<str>,
  67    pub description: Option<String>,
  68    pub authors: Vec<String>,
  69    pub repository: String,
  70    pub download_count: usize,
  71}
  72
  73pub struct ExtensionStore {
  74    builder: Arc<ExtensionBuilder>,
  75    extension_index: ExtensionIndex,
  76    fs: Arc<dyn Fs>,
  77    http_client: Arc<HttpClientWithUrl>,
  78    telemetry: Option<Arc<Telemetry>>,
  79    reload_tx: UnboundedSender<Option<Arc<str>>>,
  80    reload_complete_senders: Vec<oneshot::Sender<()>>,
  81    installed_dir: PathBuf,
  82    outstanding_operations: HashMap<Arc<str>, ExtensionOperation>,
  83    index_path: PathBuf,
  84    language_registry: Arc<LanguageRegistry>,
  85    theme_registry: Arc<ThemeRegistry>,
  86    modified_extensions: HashSet<Arc<str>>,
  87    wasm_host: Arc<WasmHost>,
  88    wasm_extensions: Vec<(Arc<ExtensionManifest>, WasmExtension)>,
  89    tasks: Vec<Task<()>>,
  90}
  91
  92#[derive(Clone)]
  93pub enum ExtensionStatus {
  94    NotInstalled,
  95    Installing,
  96    Upgrading,
  97    Installed(Arc<str>),
  98    Removing,
  99}
 100
 101#[derive(Clone, Copy)]
 102enum ExtensionOperation {
 103    Upgrade,
 104    Install,
 105    Remove,
 106}
 107
 108#[derive(Clone)]
 109pub enum Event {
 110    ExtensionsUpdated,
 111    StartedReloading,
 112    ExtensionInstalled(Arc<str>),
 113    ExtensionFailedToLoad(Arc<str>),
 114}
 115
 116impl EventEmitter<Event> for ExtensionStore {}
 117
 118struct GlobalExtensionStore(Model<ExtensionStore>);
 119
 120impl Global for GlobalExtensionStore {}
 121
 122#[derive(Debug, Deserialize, Serialize, Default, PartialEq, Eq)]
 123pub struct ExtensionIndex {
 124    pub extensions: BTreeMap<Arc<str>, ExtensionIndexEntry>,
 125    pub themes: BTreeMap<Arc<str>, ExtensionIndexThemeEntry>,
 126    pub languages: BTreeMap<Arc<str>, ExtensionIndexLanguageEntry>,
 127}
 128
 129#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
 130pub struct ExtensionIndexEntry {
 131    manifest: Arc<ExtensionManifest>,
 132    dev: bool,
 133}
 134
 135#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
 136pub struct ExtensionIndexThemeEntry {
 137    extension: Arc<str>,
 138    path: PathBuf,
 139}
 140
 141#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Deserialize, Serialize)]
 142pub struct ExtensionIndexLanguageEntry {
 143    extension: Arc<str>,
 144    path: PathBuf,
 145    matcher: LanguageMatcher,
 146    grammar: Option<Arc<str>>,
 147}
 148
 149actions!(zed, [ReloadExtensions]);
 150
 151pub fn init(
 152    fs: Arc<fs::RealFs>,
 153    client: Arc<Client>,
 154    node_runtime: Arc<dyn NodeRuntime>,
 155    language_registry: Arc<LanguageRegistry>,
 156    theme_registry: Arc<ThemeRegistry>,
 157    cx: &mut AppContext,
 158) {
 159    let store = cx.new_model(move |cx| {
 160        ExtensionStore::new(
 161            EXTENSIONS_DIR.clone(),
 162            None,
 163            fs,
 164            client.http_client().clone(),
 165            Some(client.telemetry().clone()),
 166            node_runtime,
 167            language_registry,
 168            theme_registry,
 169            cx,
 170        )
 171    });
 172
 173    cx.on_action(|_: &ReloadExtensions, cx| {
 174        let store = cx.global::<GlobalExtensionStore>().0.clone();
 175        store.update(cx, |store, cx| drop(store.reload(None, cx)));
 176    });
 177
 178    cx.set_global(GlobalExtensionStore(store));
 179}
 180
 181impl ExtensionStore {
 182    pub fn global(cx: &AppContext) -> Model<Self> {
 183        cx.global::<GlobalExtensionStore>().0.clone()
 184    }
 185
 186    #[allow(clippy::too_many_arguments)]
 187    pub fn new(
 188        extensions_dir: PathBuf,
 189        build_dir: Option<PathBuf>,
 190        fs: Arc<dyn Fs>,
 191        http_client: Arc<HttpClientWithUrl>,
 192        telemetry: Option<Arc<Telemetry>>,
 193        node_runtime: Arc<dyn NodeRuntime>,
 194        language_registry: Arc<LanguageRegistry>,
 195        theme_registry: Arc<ThemeRegistry>,
 196        cx: &mut ModelContext<Self>,
 197    ) -> Self {
 198        let work_dir = extensions_dir.join("work");
 199        let build_dir = build_dir.unwrap_or_else(|| extensions_dir.join("build"));
 200        let installed_dir = extensions_dir.join("installed");
 201        let index_path = extensions_dir.join("index.json");
 202
 203        let (reload_tx, mut reload_rx) = unbounded();
 204        let mut this = Self {
 205            extension_index: Default::default(),
 206            installed_dir,
 207            index_path,
 208            builder: Arc::new(ExtensionBuilder::new(build_dir)),
 209            outstanding_operations: Default::default(),
 210            modified_extensions: Default::default(),
 211            reload_complete_senders: Vec::new(),
 212            wasm_host: WasmHost::new(
 213                fs.clone(),
 214                http_client.clone(),
 215                node_runtime,
 216                language_registry.clone(),
 217                work_dir,
 218            ),
 219            wasm_extensions: Vec::new(),
 220            fs,
 221            http_client,
 222            telemetry,
 223            language_registry,
 224            theme_registry,
 225            reload_tx,
 226            tasks: Vec::new(),
 227        };
 228
 229        // The extensions store maintains an index file, which contains a complete
 230        // list of the installed extensions and the resources that they provide.
 231        // This index is loaded synchronously on startup.
 232        let (index_content, index_metadata, extensions_metadata) =
 233            cx.background_executor().block(async {
 234                futures::join!(
 235                    this.fs.load(&this.index_path),
 236                    this.fs.metadata(&this.index_path),
 237                    this.fs.metadata(&this.installed_dir),
 238                )
 239            });
 240
 241        // Normally, there is no need to rebuild the index. But if the index file
 242        // is invalid or is out-of-date according to the filesystem mtimes, then
 243        // it must be asynchronously rebuilt.
 244        let mut extension_index = ExtensionIndex::default();
 245        let mut extension_index_needs_rebuild = true;
 246        if let Some(index_content) = index_content.ok() {
 247            if let Some(index) = serde_json::from_str(&index_content).log_err() {
 248                extension_index = index;
 249                if let (Ok(Some(index_metadata)), Ok(Some(extensions_metadata))) =
 250                    (index_metadata, extensions_metadata)
 251                {
 252                    if index_metadata.mtime > extensions_metadata.mtime {
 253                        extension_index_needs_rebuild = false;
 254                    }
 255                }
 256            }
 257        }
 258
 259        // Immediately load all of the extensions in the initial manifest. If the
 260        // index needs to be rebuild, then enqueue
 261        let load_initial_extensions = this.extensions_updated(extension_index, cx);
 262        if extension_index_needs_rebuild {
 263            let _ = this.reload(None, cx);
 264        }
 265
 266        // Perform all extension loading in a single task to ensure that we
 267        // never attempt to simultaneously load/unload extensions from multiple
 268        // parallel tasks.
 269        this.tasks.push(cx.spawn(|this, mut cx| {
 270            async move {
 271                load_initial_extensions.await;
 272
 273                let mut debounce_timer = cx
 274                    .background_executor()
 275                    .spawn(futures::future::pending())
 276                    .fuse();
 277                loop {
 278                    select_biased! {
 279                        _ = debounce_timer => {
 280                            let index = this
 281                                .update(&mut cx, |this, cx| this.rebuild_extension_index(cx))?
 282                                .await;
 283                            this.update(&mut cx, |this, cx| this.extensions_updated(index, cx))?
 284                                .await;
 285                        }
 286                        extension_id = reload_rx.next() => {
 287                            let Some(extension_id) = extension_id else { break; };
 288                            this.update(&mut cx, |this, _| {
 289                                this.modified_extensions.extend(extension_id);
 290                            })?;
 291                            debounce_timer = cx
 292                                .background_executor()
 293                                .timer(RELOAD_DEBOUNCE_DURATION)
 294                                .fuse();
 295                        }
 296                    }
 297                }
 298
 299                anyhow::Ok(())
 300            }
 301            .map(drop)
 302        }));
 303
 304        // Watch the installed extensions directory for changes. Whenever changes are
 305        // detected, rebuild the extension index, and load/unload any extensions that
 306        // have been added, removed, or modified.
 307        this.tasks.push(cx.background_executor().spawn({
 308            let fs = this.fs.clone();
 309            let reload_tx = this.reload_tx.clone();
 310            let installed_dir = this.installed_dir.clone();
 311            async move {
 312                let mut paths = fs.watch(&installed_dir, FS_WATCH_LATENCY).await;
 313                while let Some(paths) = paths.next().await {
 314                    for path in paths {
 315                        let Ok(event_path) = path.strip_prefix(&installed_dir) else {
 316                            continue;
 317                        };
 318
 319                        if let Some(path::Component::Normal(extension_dir_name)) =
 320                            event_path.components().next()
 321                        {
 322                            if let Some(extension_id) = extension_dir_name.to_str() {
 323                                reload_tx.unbounded_send(Some(extension_id.into())).ok();
 324                            }
 325                        }
 326                    }
 327                }
 328            }
 329        }));
 330
 331        this
 332    }
 333
 334    fn reload(
 335        &mut self,
 336        modified_extension: Option<Arc<str>>,
 337        cx: &mut ModelContext<Self>,
 338    ) -> impl Future<Output = ()> {
 339        let (tx, rx) = oneshot::channel();
 340        self.reload_complete_senders.push(tx);
 341        self.reload_tx
 342            .unbounded_send(modified_extension)
 343            .expect("reload task exited");
 344        cx.emit(Event::StartedReloading);
 345
 346        async move {
 347            rx.await.ok();
 348        }
 349    }
 350
 351    fn extensions_dir(&self) -> PathBuf {
 352        self.installed_dir.clone()
 353    }
 354
 355    pub fn extension_status(&self, extension_id: &str) -> ExtensionStatus {
 356        match self.outstanding_operations.get(extension_id) {
 357            Some(ExtensionOperation::Install) => ExtensionStatus::Installing,
 358            Some(ExtensionOperation::Remove) => ExtensionStatus::Removing,
 359            Some(ExtensionOperation::Upgrade) => ExtensionStatus::Upgrading,
 360            None => match self.extension_index.extensions.get(extension_id) {
 361                Some(extension) => ExtensionStatus::Installed(extension.manifest.version.clone()),
 362                None => ExtensionStatus::NotInstalled,
 363            },
 364        }
 365    }
 366
 367    pub fn dev_extensions(&self) -> impl Iterator<Item = &Arc<ExtensionManifest>> {
 368        self.extension_index
 369            .extensions
 370            .values()
 371            .filter_map(|extension| extension.dev.then_some(&extension.manifest))
 372    }
 373
 374    /// Returns the names of themes provided by extensions.
 375    pub fn extension_themes<'a>(
 376        &'a self,
 377        extension_id: &'a str,
 378    ) -> impl Iterator<Item = &'a Arc<str>> {
 379        self.extension_index
 380            .themes
 381            .iter()
 382            .filter_map(|(name, theme)| theme.extension.as_ref().eq(extension_id).then_some(name))
 383    }
 384
 385    pub fn fetch_extensions(
 386        &self,
 387        search: Option<&str>,
 388        cx: &mut ModelContext<Self>,
 389    ) -> Task<Result<Vec<ExtensionApiResponse>>> {
 390        let version = CURRENT_SCHEMA_VERSION.to_string();
 391        let mut query = vec![("max_schema_version", version.as_str())];
 392        if let Some(search) = search {
 393            query.push(("filter", search));
 394        }
 395
 396        let url = self.http_client.build_zed_api_url("/extensions", &query);
 397        let http_client = self.http_client.clone();
 398        cx.spawn(move |_, _| async move {
 399            let mut response = http_client
 400                .get(&url?.as_ref(), AsyncBody::empty(), true)
 401                .await?;
 402
 403            let mut body = Vec::new();
 404            response
 405                .body_mut()
 406                .read_to_end(&mut body)
 407                .await
 408                .context("error reading extensions")?;
 409
 410            if response.status().is_client_error() {
 411                let text = String::from_utf8_lossy(body.as_slice());
 412                bail!(
 413                    "status error {}, response: {text:?}",
 414                    response.status().as_u16()
 415                );
 416            }
 417
 418            let response: ExtensionsApiResponse = serde_json::from_slice(&body)?;
 419
 420            Ok(response.data)
 421        })
 422    }
 423
 424    pub fn install_extension(
 425        &mut self,
 426        extension_id: Arc<str>,
 427        version: Arc<str>,
 428        cx: &mut ModelContext<Self>,
 429    ) {
 430        self.install_or_upgrade_extension(extension_id, version, ExtensionOperation::Install, cx)
 431    }
 432
 433    fn install_or_upgrade_extension_at_endpoint(
 434        &mut self,
 435        extension_id: Arc<str>,
 436        url: Url,
 437        operation: ExtensionOperation,
 438        cx: &mut ModelContext<Self>,
 439    ) {
 440        let extension_dir = self.installed_dir.join(extension_id.as_ref());
 441        let http_client = self.http_client.clone();
 442        let fs = self.fs.clone();
 443
 444        match self.outstanding_operations.entry(extension_id.clone()) {
 445            hash_map::Entry::Occupied(_) => return,
 446            hash_map::Entry::Vacant(e) => e.insert(operation),
 447        };
 448
 449        cx.spawn(move |this, mut cx| async move {
 450            let _finish = util::defer({
 451                let this = this.clone();
 452                let mut cx = cx.clone();
 453                let extension_id = extension_id.clone();
 454                move || {
 455                    this.update(&mut cx, |this, cx| {
 456                        this.outstanding_operations.remove(extension_id.as_ref());
 457                        cx.notify();
 458                    })
 459                    .ok();
 460                }
 461            });
 462
 463            let mut response = http_client
 464                .get(&url.as_ref(), Default::default(), true)
 465                .await
 466                .map_err(|err| anyhow!("error downloading extension: {}", err))?;
 467
 468            fs.remove_dir(
 469                &extension_dir,
 470                RemoveOptions {
 471                    recursive: true,
 472                    ignore_if_not_exists: true,
 473                },
 474            )
 475            .await?;
 476
 477            let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
 478            let archive = Archive::new(decompressed_bytes);
 479            archive.unpack(extension_dir).await?;
 480            this.update(&mut cx, |this, cx| {
 481                this.reload(Some(extension_id.clone()), cx)
 482            })?
 483            .await;
 484
 485            match operation {
 486                ExtensionOperation::Install => {
 487                    this.update(&mut cx, |_, cx| {
 488                        cx.emit(Event::ExtensionInstalled(extension_id));
 489                    })
 490                    .ok();
 491                }
 492                _ => {}
 493            }
 494
 495            anyhow::Ok(())
 496        })
 497        .detach_and_log_err(cx);
 498    }
 499
 500    pub fn install_latest_extension(
 501        &mut self,
 502        extension_id: Arc<str>,
 503        cx: &mut ModelContext<Self>,
 504    ) {
 505        log::info!("installing extension {extension_id} latest version");
 506
 507        let Some(url) = self
 508            .http_client
 509            .build_zed_api_url(&format!("/extensions/{extension_id}/download"), &[])
 510            .log_err()
 511        else {
 512            return;
 513        };
 514
 515        self.install_or_upgrade_extension_at_endpoint(
 516            extension_id,
 517            url,
 518            ExtensionOperation::Install,
 519            cx,
 520        );
 521    }
 522
 523    pub fn upgrade_extension(
 524        &mut self,
 525        extension_id: Arc<str>,
 526        version: Arc<str>,
 527        cx: &mut ModelContext<Self>,
 528    ) {
 529        self.install_or_upgrade_extension(extension_id, version, ExtensionOperation::Upgrade, cx)
 530    }
 531
 532    fn install_or_upgrade_extension(
 533        &mut self,
 534        extension_id: Arc<str>,
 535        version: Arc<str>,
 536        operation: ExtensionOperation,
 537        cx: &mut ModelContext<Self>,
 538    ) {
 539        log::info!("installing extension {extension_id} {version}");
 540        let Some(url) = self
 541            .http_client
 542            .build_zed_api_url(
 543                &format!("/extensions/{extension_id}/{version}/download"),
 544                &[],
 545            )
 546            .log_err()
 547        else {
 548            return;
 549        };
 550
 551        self.install_or_upgrade_extension_at_endpoint(extension_id, url, operation, cx);
 552    }
 553
 554    pub fn uninstall_extension(&mut self, extension_id: Arc<str>, cx: &mut ModelContext<Self>) {
 555        let extension_dir = self.installed_dir.join(extension_id.as_ref());
 556        let fs = self.fs.clone();
 557
 558        match self.outstanding_operations.entry(extension_id.clone()) {
 559            hash_map::Entry::Occupied(_) => return,
 560            hash_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Remove),
 561        };
 562
 563        cx.spawn(move |this, mut cx| async move {
 564            let _finish = util::defer({
 565                let this = this.clone();
 566                let mut cx = cx.clone();
 567                let extension_id = extension_id.clone();
 568                move || {
 569                    this.update(&mut cx, |this, cx| {
 570                        this.outstanding_operations.remove(extension_id.as_ref());
 571                        cx.notify();
 572                    })
 573                    .ok();
 574                }
 575            });
 576
 577            fs.remove_dir(
 578                &extension_dir,
 579                RemoveOptions {
 580                    recursive: true,
 581                    ignore_if_not_exists: true,
 582                },
 583            )
 584            .await?;
 585
 586            this.update(&mut cx, |this, cx| this.reload(None, cx))?
 587                .await;
 588            anyhow::Ok(())
 589        })
 590        .detach_and_log_err(cx)
 591    }
 592
 593    pub fn install_dev_extension(
 594        &mut self,
 595        extension_source_path: PathBuf,
 596        cx: &mut ModelContext<Self>,
 597    ) -> Task<Result<()>> {
 598        let extensions_dir = self.extensions_dir();
 599        let fs = self.fs.clone();
 600        let builder = self.builder.clone();
 601
 602        cx.spawn(move |this, mut cx| async move {
 603            let mut extension_manifest =
 604                ExtensionManifest::load(fs.clone(), &extension_source_path).await?;
 605            let extension_id = extension_manifest.id.clone();
 606
 607            if !this.update(&mut cx, |this, cx| {
 608                match this.outstanding_operations.entry(extension_id.clone()) {
 609                    hash_map::Entry::Occupied(_) => return false,
 610                    hash_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Remove),
 611                };
 612                cx.notify();
 613                true
 614            })? {
 615                return Ok(());
 616            }
 617
 618            let _finish = util::defer({
 619                let this = this.clone();
 620                let mut cx = cx.clone();
 621                let extension_id = extension_id.clone();
 622                move || {
 623                    this.update(&mut cx, |this, cx| {
 624                        this.outstanding_operations.remove(extension_id.as_ref());
 625                        cx.notify();
 626                    })
 627                    .ok();
 628                }
 629            });
 630
 631            cx.background_executor()
 632                .spawn({
 633                    let extension_source_path = extension_source_path.clone();
 634                    async move {
 635                        builder
 636                            .compile_extension(
 637                                &extension_source_path,
 638                                &mut extension_manifest,
 639                                CompileExtensionOptions { release: false },
 640                            )
 641                            .await
 642                    }
 643                })
 644                .await?;
 645
 646            let output_path = &extensions_dir.join(extension_id.as_ref());
 647            if let Some(metadata) = fs.metadata(&output_path).await? {
 648                if metadata.is_symlink {
 649                    fs.remove_file(
 650                        &output_path,
 651                        RemoveOptions {
 652                            recursive: false,
 653                            ignore_if_not_exists: true,
 654                        },
 655                    )
 656                    .await?;
 657                } else {
 658                    bail!("extension {extension_id} is already installed");
 659                }
 660            }
 661
 662            fs.create_symlink(output_path, extension_source_path)
 663                .await?;
 664
 665            this.update(&mut cx, |this, cx| this.reload(None, cx))?
 666                .await;
 667            Ok(())
 668        })
 669    }
 670
 671    pub fn rebuild_dev_extension(&mut self, extension_id: Arc<str>, cx: &mut ModelContext<Self>) {
 672        let path = self.installed_dir.join(extension_id.as_ref());
 673        let builder = self.builder.clone();
 674        let fs = self.fs.clone();
 675
 676        match self.outstanding_operations.entry(extension_id.clone()) {
 677            hash_map::Entry::Occupied(_) => return,
 678            hash_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Upgrade),
 679        };
 680
 681        cx.notify();
 682        let compile = cx.background_executor().spawn(async move {
 683            let mut manifest = ExtensionManifest::load(fs, &path).await?;
 684            builder
 685                .compile_extension(
 686                    &path,
 687                    &mut manifest,
 688                    CompileExtensionOptions { release: true },
 689                )
 690                .await
 691        });
 692
 693        cx.spawn(|this, mut cx| async move {
 694            let result = compile.await;
 695
 696            this.update(&mut cx, |this, cx| {
 697                this.outstanding_operations.remove(&extension_id);
 698                cx.notify();
 699            })?;
 700
 701            if result.is_ok() {
 702                this.update(&mut cx, |this, cx| this.reload(Some(extension_id), cx))?
 703                    .await;
 704            }
 705
 706            result
 707        })
 708        .detach_and_log_err(cx)
 709    }
 710
 711    /// Updates the set of installed extensions.
 712    ///
 713    /// First, this unloads any themes, languages, or grammars that are
 714    /// no longer in the manifest, or whose files have changed on disk.
 715    /// Then it loads any themes, languages, or grammars that are newly
 716    /// added to the manifest, or whose files have changed on disk.
 717    fn extensions_updated(
 718        &mut self,
 719        new_index: ExtensionIndex,
 720        cx: &mut ModelContext<Self>,
 721    ) -> Task<()> {
 722        let old_index = &self.extension_index;
 723
 724        // Determine which extensions need to be loaded and unloaded, based
 725        // on the changes to the manifest and the extensions that we know have been
 726        // modified.
 727        let mut extensions_to_unload = Vec::default();
 728        let mut extensions_to_load = Vec::default();
 729        {
 730            let mut old_keys = old_index.extensions.iter().peekable();
 731            let mut new_keys = new_index.extensions.iter().peekable();
 732            loop {
 733                match (old_keys.peek(), new_keys.peek()) {
 734                    (None, None) => break,
 735                    (None, Some(_)) => {
 736                        extensions_to_load.push(new_keys.next().unwrap().0.clone());
 737                    }
 738                    (Some(_), None) => {
 739                        extensions_to_unload.push(old_keys.next().unwrap().0.clone());
 740                    }
 741                    (Some((old_key, _)), Some((new_key, _))) => match old_key.cmp(&new_key) {
 742                        Ordering::Equal => {
 743                            let (old_key, old_value) = old_keys.next().unwrap();
 744                            let (new_key, new_value) = new_keys.next().unwrap();
 745                            if old_value != new_value || self.modified_extensions.contains(old_key)
 746                            {
 747                                extensions_to_unload.push(old_key.clone());
 748                                extensions_to_load.push(new_key.clone());
 749                            }
 750                        }
 751                        Ordering::Less => {
 752                            extensions_to_unload.push(old_keys.next().unwrap().0.clone());
 753                        }
 754                        Ordering::Greater => {
 755                            extensions_to_load.push(new_keys.next().unwrap().0.clone());
 756                        }
 757                    },
 758                }
 759            }
 760            self.modified_extensions.clear();
 761        }
 762
 763        if extensions_to_load.is_empty() && extensions_to_unload.is_empty() {
 764            return Task::ready(());
 765        }
 766
 767        let reload_count = extensions_to_unload
 768            .iter()
 769            .filter(|id| extensions_to_load.contains(id))
 770            .count();
 771
 772        log::info!(
 773            "extensions updated. loading {}, reloading {}, unloading {}",
 774            extensions_to_load.len() - reload_count,
 775            reload_count,
 776            extensions_to_unload.len() - reload_count
 777        );
 778
 779        if let Some(telemetry) = &self.telemetry {
 780            for extension_id in &extensions_to_load {
 781                if let Some(extension) = self.extension_index.extensions.get(extension_id) {
 782                    telemetry.report_extension_event(
 783                        extension_id.clone(),
 784                        extension.manifest.version.clone(),
 785                    );
 786                }
 787            }
 788        }
 789
 790        let themes_to_remove = old_index
 791            .themes
 792            .iter()
 793            .filter_map(|(name, entry)| {
 794                if extensions_to_unload.contains(&entry.extension) {
 795                    Some(name.clone().into())
 796                } else {
 797                    None
 798                }
 799            })
 800            .collect::<Vec<_>>();
 801        let languages_to_remove = old_index
 802            .languages
 803            .iter()
 804            .filter_map(|(name, entry)| {
 805                if extensions_to_unload.contains(&entry.extension) {
 806                    Some(name.clone())
 807                } else {
 808                    None
 809                }
 810            })
 811            .collect::<Vec<_>>();
 812        let mut grammars_to_remove = Vec::new();
 813        for extension_id in &extensions_to_unload {
 814            let Some(extension) = old_index.extensions.get(extension_id) else {
 815                continue;
 816            };
 817            grammars_to_remove.extend(extension.manifest.grammars.keys().cloned());
 818            for (language_server_name, config) in extension.manifest.language_servers.iter() {
 819                self.language_registry
 820                    .remove_lsp_adapter(config.language.as_ref(), language_server_name);
 821            }
 822        }
 823
 824        self.wasm_extensions
 825            .retain(|(extension, _)| !extensions_to_unload.contains(&extension.id));
 826        self.theme_registry.remove_user_themes(&themes_to_remove);
 827        self.language_registry
 828            .remove_languages(&languages_to_remove, &grammars_to_remove);
 829
 830        let languages_to_add = new_index
 831            .languages
 832            .iter()
 833            .filter(|(_, entry)| extensions_to_load.contains(&entry.extension))
 834            .collect::<Vec<_>>();
 835        let mut grammars_to_add = Vec::new();
 836        let mut themes_to_add = Vec::new();
 837        for extension_id in &extensions_to_load {
 838            let Some(extension) = new_index.extensions.get(extension_id) else {
 839                continue;
 840            };
 841
 842            grammars_to_add.extend(extension.manifest.grammars.keys().map(|grammar_name| {
 843                let mut grammar_path = self.installed_dir.clone();
 844                grammar_path.extend([extension_id.as_ref(), "grammars"]);
 845                grammar_path.push(grammar_name.as_ref());
 846                grammar_path.set_extension("wasm");
 847                (grammar_name.clone(), grammar_path)
 848            }));
 849            themes_to_add.extend(extension.manifest.themes.iter().map(|theme_path| {
 850                let mut path = self.installed_dir.clone();
 851                path.extend([Path::new(extension_id.as_ref()), theme_path.as_path()]);
 852                path
 853            }));
 854        }
 855
 856        self.language_registry
 857            .register_wasm_grammars(grammars_to_add);
 858
 859        for (language_name, language) in languages_to_add {
 860            let mut language_path = self.installed_dir.clone();
 861            language_path.extend([
 862                Path::new(language.extension.as_ref()),
 863                language.path.as_path(),
 864            ]);
 865            self.language_registry.register_language(
 866                language_name.clone(),
 867                language.grammar.clone(),
 868                language.matcher.clone(),
 869                move || {
 870                    let config = std::fs::read_to_string(language_path.join("config.toml"))?;
 871                    let config: LanguageConfig = ::toml::from_str(&config)?;
 872                    let queries = load_plugin_queries(&language_path);
 873                    let tasks = std::fs::read_to_string(language_path.join("tasks.json"))
 874                        .ok()
 875                        .and_then(|contents| {
 876                            let definitions = serde_json_lenient::from_str(&contents).log_err()?;
 877                            Some(Arc::new(ContextProviderWithTasks::new(definitions)) as Arc<_>)
 878                        });
 879
 880                    Ok((config, queries, tasks))
 881                },
 882            );
 883        }
 884
 885        let fs = self.fs.clone();
 886        let wasm_host = self.wasm_host.clone();
 887        let root_dir = self.installed_dir.clone();
 888        let theme_registry = self.theme_registry.clone();
 889        let extension_entries = extensions_to_load
 890            .iter()
 891            .filter_map(|name| new_index.extensions.get(name).cloned())
 892            .collect::<Vec<_>>();
 893
 894        self.extension_index = new_index;
 895        cx.notify();
 896        cx.emit(Event::ExtensionsUpdated);
 897
 898        cx.spawn(|this, mut cx| async move {
 899            cx.background_executor()
 900                .spawn({
 901                    let fs = fs.clone();
 902                    async move {
 903                        for theme_path in &themes_to_add {
 904                            theme_registry
 905                                .load_user_theme(&theme_path, fs.clone())
 906                                .await
 907                                .log_err();
 908                        }
 909                    }
 910                })
 911                .await;
 912
 913            let mut wasm_extensions = Vec::new();
 914            for extension in extension_entries {
 915                if extension.manifest.lib.kind.is_none() {
 916                    continue;
 917                };
 918
 919                let wasm_extension = maybe!(async {
 920                    let mut path = root_dir.clone();
 921                    path.extend([extension.manifest.clone().id.as_ref(), "extension.wasm"]);
 922                    let mut wasm_file = fs
 923                        .open_sync(&path)
 924                        .await
 925                        .context("failed to open wasm file")?;
 926
 927                    let mut wasm_bytes = Vec::new();
 928                    wasm_file
 929                        .read_to_end(&mut wasm_bytes)
 930                        .context("failed to read wasm")?;
 931
 932                    wasm_host
 933                        .load_extension(
 934                            wasm_bytes,
 935                            extension.manifest.clone().clone(),
 936                            cx.background_executor().clone(),
 937                        )
 938                        .await
 939                        .with_context(|| {
 940                            format!("failed to load wasm extension {}", extension.manifest.id)
 941                        })
 942                })
 943                .await;
 944
 945                if let Some(wasm_extension) = wasm_extension.log_err() {
 946                    wasm_extensions.push((extension.manifest.clone(), wasm_extension));
 947                } else {
 948                    this.update(&mut cx, |_, cx| {
 949                        cx.emit(Event::ExtensionFailedToLoad(extension.manifest.id.clone()))
 950                    })
 951                    .ok();
 952                }
 953            }
 954
 955            this.update(&mut cx, |this, cx| {
 956                this.reload_complete_senders.clear();
 957
 958                for (manifest, wasm_extension) in &wasm_extensions {
 959                    for (language_server_name, language_server_config) in &manifest.language_servers
 960                    {
 961                        this.language_registry.register_lsp_adapter(
 962                            language_server_config.language.clone(),
 963                            Arc::new(ExtensionLspAdapter {
 964                                extension: wasm_extension.clone(),
 965                                host: this.wasm_host.clone(),
 966                                config: wit::LanguageServerConfig {
 967                                    name: language_server_name.0.to_string(),
 968                                    language_name: language_server_config.language.to_string(),
 969                                },
 970                            }),
 971                        );
 972                    }
 973                }
 974                this.wasm_extensions.extend(wasm_extensions);
 975                ThemeSettings::reload_current_theme(cx)
 976            })
 977            .ok();
 978        })
 979    }
 980
 981    fn rebuild_extension_index(&self, cx: &mut ModelContext<Self>) -> Task<ExtensionIndex> {
 982        let fs = self.fs.clone();
 983        let work_dir = self.wasm_host.work_dir.clone();
 984        let extensions_dir = self.installed_dir.clone();
 985        let index_path = self.index_path.clone();
 986        cx.background_executor().spawn(async move {
 987            let start_time = Instant::now();
 988            let mut index = ExtensionIndex::default();
 989
 990            fs.create_dir(&work_dir).await.log_err();
 991            fs.create_dir(&extensions_dir).await.log_err();
 992
 993            let extension_paths = fs.read_dir(&extensions_dir).await;
 994            if let Ok(mut extension_paths) = extension_paths {
 995                while let Some(extension_dir) = extension_paths.next().await {
 996                    let Ok(extension_dir) = extension_dir else {
 997                        continue;
 998                    };
 999                    Self::add_extension_to_index(fs.clone(), extension_dir, &mut index)
1000                        .await
1001                        .log_err();
1002                }
1003            }
1004
1005            if let Ok(index_json) = serde_json::to_string_pretty(&index) {
1006                fs.save(&index_path, &index_json.as_str().into(), Default::default())
1007                    .await
1008                    .context("failed to save extension index")
1009                    .log_err();
1010            }
1011
1012            log::info!("rebuilt extension index in {:?}", start_time.elapsed());
1013            index
1014        })
1015    }
1016
1017    async fn add_extension_to_index(
1018        fs: Arc<dyn Fs>,
1019        extension_dir: PathBuf,
1020        index: &mut ExtensionIndex,
1021    ) -> Result<()> {
1022        let mut extension_manifest = ExtensionManifest::load(fs.clone(), &extension_dir).await?;
1023        let extension_id = extension_manifest.id.clone();
1024
1025        // TODO: distinguish dev extensions more explicitly, by the absence
1026        // of a checksum file that we'll create when downloading normal extensions.
1027        let is_dev = fs
1028            .metadata(&extension_dir)
1029            .await?
1030            .ok_or_else(|| anyhow!("directory does not exist"))?
1031            .is_symlink;
1032
1033        if let Ok(mut language_paths) = fs.read_dir(&extension_dir.join("languages")).await {
1034            while let Some(language_path) = language_paths.next().await {
1035                let language_path = language_path?;
1036                let Ok(relative_path) = language_path.strip_prefix(&extension_dir) else {
1037                    continue;
1038                };
1039                let Ok(Some(fs_metadata)) = fs.metadata(&language_path).await else {
1040                    continue;
1041                };
1042                if !fs_metadata.is_dir {
1043                    continue;
1044                }
1045                let config = fs.load(&language_path.join("config.toml")).await?;
1046                let config = ::toml::from_str::<LanguageConfig>(&config)?;
1047
1048                let relative_path = relative_path.to_path_buf();
1049                if !extension_manifest.languages.contains(&relative_path) {
1050                    extension_manifest.languages.push(relative_path.clone());
1051                }
1052
1053                index.languages.insert(
1054                    config.name.clone(),
1055                    ExtensionIndexLanguageEntry {
1056                        extension: extension_id.clone(),
1057                        path: relative_path,
1058                        matcher: config.matcher,
1059                        grammar: config.grammar,
1060                    },
1061                );
1062            }
1063        }
1064
1065        if let Ok(mut theme_paths) = fs.read_dir(&extension_dir.join("themes")).await {
1066            while let Some(theme_path) = theme_paths.next().await {
1067                let theme_path = theme_path?;
1068                let Ok(relative_path) = theme_path.strip_prefix(&extension_dir) else {
1069                    continue;
1070                };
1071
1072                let Some(theme_family) = ThemeRegistry::read_user_theme(&theme_path, fs.clone())
1073                    .await
1074                    .log_err()
1075                else {
1076                    continue;
1077                };
1078
1079                let relative_path = relative_path.to_path_buf();
1080                if !extension_manifest.themes.contains(&relative_path) {
1081                    extension_manifest.themes.push(relative_path.clone());
1082                }
1083
1084                for theme in theme_family.themes {
1085                    index.themes.insert(
1086                        theme.name.into(),
1087                        ExtensionIndexThemeEntry {
1088                            extension: extension_id.clone(),
1089                            path: relative_path.clone(),
1090                        },
1091                    );
1092                }
1093            }
1094        }
1095
1096        let extension_wasm_path = extension_dir.join("extension.wasm");
1097        if fs.is_file(&extension_wasm_path).await {
1098            extension_manifest
1099                .lib
1100                .kind
1101                .get_or_insert(ExtensionLibraryKind::Rust);
1102        }
1103
1104        index.extensions.insert(
1105            extension_id.clone(),
1106            ExtensionIndexEntry {
1107                dev: is_dev,
1108                manifest: Arc::new(extension_manifest),
1109            },
1110        );
1111
1112        Ok(())
1113    }
1114}
1115
1116fn load_plugin_queries(root_path: &Path) -> LanguageQueries {
1117    let mut result = LanguageQueries::default();
1118    if let Some(entries) = std::fs::read_dir(root_path).log_err() {
1119        for entry in entries {
1120            let Some(entry) = entry.log_err() else {
1121                continue;
1122            };
1123            let path = entry.path();
1124            if let Some(remainder) = path.strip_prefix(root_path).ok().and_then(|p| p.to_str()) {
1125                if !remainder.ends_with(".scm") {
1126                    continue;
1127                }
1128                for (name, query) in QUERY_FILENAME_PREFIXES {
1129                    if remainder.starts_with(name) {
1130                        if let Some(contents) = std::fs::read_to_string(&path).log_err() {
1131                            match query(&mut result) {
1132                                None => *query(&mut result) = Some(contents.into()),
1133                                Some(r) => r.to_mut().push_str(contents.as_ref()),
1134                            }
1135                        }
1136                        break;
1137                    }
1138                }
1139            }
1140        }
1141    }
1142    result
1143}