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