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 !this.update(cx, |this, cx| {
942 match this.outstanding_operations.entry(extension_id.clone()) {
943 btree_map::Entry::Occupied(_) => return false,
944 btree_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Install),
945 };
946 cx.notify();
947 true
948 })? {
949 return Ok(());
950 }
951
952 let _finish = cx.on_drop(&this, {
953 let extension_id = extension_id.clone();
954 move |this, cx| {
955 this.outstanding_operations.remove(extension_id.as_ref());
956 cx.notify();
957 }
958 });
959
960 cx.background_spawn({
961 let extension_source_path = extension_source_path.clone();
962 async move {
963 builder
964 .compile_extension(
965 &extension_source_path,
966 &mut extension_manifest,
967 CompileExtensionOptions { release: false },
968 )
969 .await
970 }
971 })
972 .await
973 .inspect_err(|error| {
974 util::log_err(error);
975 })?;
976
977 let output_path = &extensions_dir.join(extension_id.as_ref());
978 if let Some(metadata) = fs.metadata(output_path).await? {
979 if metadata.is_symlink {
980 fs.remove_file(
981 output_path,
982 RemoveOptions {
983 recursive: false,
984 ignore_if_not_exists: true,
985 },
986 )
987 .await?;
988 } else {
989 bail!("extension {extension_id} is already installed");
990 }
991 }
992
993 fs.create_symlink(output_path, extension_source_path)
994 .await?;
995
996 this.update(cx, |this, cx| this.reload(None, cx))?.await;
997 this.update(cx, |this, cx| {
998 cx.emit(Event::ExtensionInstalled(extension_id.clone()));
999 if let Some(events) = ExtensionEvents::try_global(cx)
1000 && let Some(manifest) = this.extension_manifest_for_id(&extension_id)
1001 {
1002 events.update(cx, |this, cx| {
1003 this.emit(extension::Event::ExtensionInstalled(manifest.clone()), cx)
1004 });
1005 }
1006 })?;
1007
1008 Ok(())
1009 })
1010 }
1011
1012 pub fn rebuild_dev_extension(&mut self, extension_id: Arc<str>, cx: &mut Context<Self>) {
1013 let path = self.installed_dir.join(extension_id.as_ref());
1014 let builder = self.builder.clone();
1015 let fs = self.fs.clone();
1016
1017 match self.outstanding_operations.entry(extension_id.clone()) {
1018 btree_map::Entry::Occupied(_) => return,
1019 btree_map::Entry::Vacant(e) => e.insert(ExtensionOperation::Upgrade),
1020 };
1021
1022 cx.notify();
1023 let compile = cx.background_spawn(async move {
1024 let mut manifest = ExtensionManifest::load(fs, &path).await?;
1025 builder
1026 .compile_extension(
1027 &path,
1028 &mut manifest,
1029 CompileExtensionOptions { release: true },
1030 )
1031 .await
1032 });
1033
1034 cx.spawn(async move |this, cx| {
1035 let result = compile.await;
1036
1037 this.update(cx, |this, cx| {
1038 this.outstanding_operations.remove(&extension_id);
1039 cx.notify();
1040 })?;
1041
1042 if result.is_ok() {
1043 this.update(cx, |this, cx| this.reload(Some(extension_id), cx))?
1044 .await;
1045 }
1046
1047 result
1048 })
1049 .detach_and_log_err(cx)
1050 }
1051
1052 /// Updates the set of installed extensions.
1053 ///
1054 /// First, this unloads any themes, languages, or grammars that are
1055 /// no longer in the manifest, or whose files have changed on disk.
1056 /// Then it loads any themes, languages, or grammars that are newly
1057 /// added to the manifest, or whose files have changed on disk.
1058 fn extensions_updated(
1059 &mut self,
1060 mut new_index: ExtensionIndex,
1061 cx: &mut Context<Self>,
1062 ) -> Task<()> {
1063 let old_index = &self.extension_index;
1064
1065 // Determine which extensions need to be loaded and unloaded, based
1066 // on the changes to the manifest and the extensions that we know have been
1067 // modified.
1068 let mut extensions_to_unload = Vec::default();
1069 let mut extensions_to_load = Vec::default();
1070 {
1071 let mut old_keys = old_index.extensions.iter().peekable();
1072 let mut new_keys = new_index.extensions.iter().peekable();
1073 loop {
1074 match (old_keys.peek(), new_keys.peek()) {
1075 (None, None) => break,
1076 (None, Some(_)) => {
1077 extensions_to_load.push(new_keys.next().unwrap().0.clone());
1078 }
1079 (Some(_), None) => {
1080 extensions_to_unload.push(old_keys.next().unwrap().0.clone());
1081 }
1082 (Some((old_key, _)), Some((new_key, _))) => match old_key.cmp(new_key) {
1083 Ordering::Equal => {
1084 let (old_key, old_value) = old_keys.next().unwrap();
1085 let (new_key, new_value) = new_keys.next().unwrap();
1086 if old_value != new_value || self.modified_extensions.contains(old_key)
1087 {
1088 extensions_to_unload.push(old_key.clone());
1089 extensions_to_load.push(new_key.clone());
1090 }
1091 }
1092 Ordering::Less => {
1093 extensions_to_unload.push(old_keys.next().unwrap().0.clone());
1094 }
1095 Ordering::Greater => {
1096 extensions_to_load.push(new_keys.next().unwrap().0.clone());
1097 }
1098 },
1099 }
1100 }
1101 self.modified_extensions.clear();
1102 }
1103
1104 if extensions_to_load.is_empty() && extensions_to_unload.is_empty() {
1105 return Task::ready(());
1106 }
1107
1108 let reload_count = extensions_to_unload
1109 .iter()
1110 .filter(|id| extensions_to_load.contains(id))
1111 .count();
1112
1113 log::info!(
1114 "extensions updated. loading {}, reloading {}, unloading {}",
1115 extensions_to_load.len() - reload_count,
1116 reload_count,
1117 extensions_to_unload.len() - reload_count
1118 );
1119
1120 let extension_ids = extensions_to_load
1121 .iter()
1122 .filter_map(|id| {
1123 Some((
1124 id.clone(),
1125 new_index.extensions.get(id)?.manifest.version.clone(),
1126 ))
1127 })
1128 .collect::<Vec<_>>();
1129
1130 telemetry::event!("Extensions Loaded", id_and_versions = extension_ids);
1131
1132 let themes_to_remove = old_index
1133 .themes
1134 .iter()
1135 .filter_map(|(name, entry)| {
1136 if extensions_to_unload.contains(&entry.extension) {
1137 Some(name.clone().into())
1138 } else {
1139 None
1140 }
1141 })
1142 .collect::<Vec<_>>();
1143 let icon_themes_to_remove = old_index
1144 .icon_themes
1145 .iter()
1146 .filter_map(|(name, entry)| {
1147 if extensions_to_unload.contains(&entry.extension) {
1148 Some(name.clone().into())
1149 } else {
1150 None
1151 }
1152 })
1153 .collect::<Vec<_>>();
1154 let languages_to_remove = old_index
1155 .languages
1156 .iter()
1157 .filter_map(|(name, entry)| {
1158 if extensions_to_unload.contains(&entry.extension) {
1159 Some(name.clone())
1160 } else {
1161 None
1162 }
1163 })
1164 .collect::<Vec<_>>();
1165 let mut grammars_to_remove = Vec::new();
1166 let mut server_removal_tasks = Vec::with_capacity(extensions_to_unload.len());
1167 for extension_id in &extensions_to_unload {
1168 let Some(extension) = old_index.extensions.get(extension_id) else {
1169 continue;
1170 };
1171 grammars_to_remove.extend(extension.manifest.grammars.keys().cloned());
1172 for (language_server_name, config) in &extension.manifest.language_servers {
1173 for language in config.languages() {
1174 server_removal_tasks.push(self.proxy.remove_language_server(
1175 &language,
1176 language_server_name,
1177 cx,
1178 ));
1179 }
1180 }
1181
1182 for server_id in extension.manifest.context_servers.keys() {
1183 self.proxy.unregister_context_server(server_id.clone(), cx);
1184 }
1185 for adapter in extension.manifest.debug_adapters.keys() {
1186 self.proxy.unregister_debug_adapter(adapter.clone());
1187 }
1188 for locator in extension.manifest.debug_locators.keys() {
1189 self.proxy.unregister_debug_locator(locator.clone());
1190 }
1191 for command_name in extension.manifest.slash_commands.keys() {
1192 self.proxy.unregister_slash_command(command_name.clone());
1193 }
1194 }
1195
1196 self.wasm_extensions
1197 .retain(|(extension, _)| !extensions_to_unload.contains(&extension.id));
1198 self.proxy.remove_user_themes(themes_to_remove);
1199 self.proxy.remove_icon_themes(icon_themes_to_remove);
1200 self.proxy
1201 .remove_languages(&languages_to_remove, &grammars_to_remove);
1202
1203 let mut grammars_to_add = Vec::new();
1204 let mut themes_to_add = Vec::new();
1205 let mut icon_themes_to_add = Vec::new();
1206 let mut snippets_to_add = Vec::new();
1207 for extension_id in &extensions_to_load {
1208 let Some(extension) = new_index.extensions.get(extension_id) else {
1209 continue;
1210 };
1211
1212 grammars_to_add.extend(extension.manifest.grammars.keys().map(|grammar_name| {
1213 let mut grammar_path = self.installed_dir.clone();
1214 grammar_path.extend([extension_id.as_ref(), "grammars"]);
1215 grammar_path.push(grammar_name.as_ref());
1216 grammar_path.set_extension("wasm");
1217 (grammar_name.clone(), grammar_path)
1218 }));
1219 themes_to_add.extend(extension.manifest.themes.iter().map(|theme_path| {
1220 let mut path = self.installed_dir.clone();
1221 path.extend([Path::new(extension_id.as_ref()), theme_path.as_path()]);
1222 path
1223 }));
1224 icon_themes_to_add.extend(extension.manifest.icon_themes.iter().map(
1225 |icon_theme_path| {
1226 let mut path = self.installed_dir.clone();
1227 path.extend([Path::new(extension_id.as_ref()), icon_theme_path.as_path()]);
1228
1229 let mut icons_root_path = self.installed_dir.clone();
1230 icons_root_path.extend([Path::new(extension_id.as_ref())]);
1231
1232 (path, icons_root_path)
1233 },
1234 ));
1235 snippets_to_add.extend(extension.manifest.snippets.iter().map(|snippets_path| {
1236 let mut path = self.installed_dir.clone();
1237 path.extend([Path::new(extension_id.as_ref()), snippets_path.as_path()]);
1238 path
1239 }));
1240 }
1241
1242 self.proxy.register_grammars(grammars_to_add);
1243 let languages_to_add = new_index
1244 .languages
1245 .iter_mut()
1246 .filter(|(_, entry)| extensions_to_load.contains(&entry.extension))
1247 .collect::<Vec<_>>();
1248 for (language_name, language) in languages_to_add {
1249 let mut language_path = self.installed_dir.clone();
1250 language_path.extend([
1251 Path::new(language.extension.as_ref()),
1252 language.path.as_path(),
1253 ]);
1254 self.proxy.register_language(
1255 language_name.clone(),
1256 language.grammar.clone(),
1257 language.matcher.clone(),
1258 language.hidden,
1259 Arc::new(move || {
1260 let config = std::fs::read_to_string(language_path.join("config.toml"))?;
1261 let config: LanguageConfig = ::toml::from_str(&config)?;
1262 let queries = load_plugin_queries(&language_path);
1263 let context_provider =
1264 std::fs::read_to_string(language_path.join("tasks.json"))
1265 .ok()
1266 .and_then(|contents| {
1267 let definitions =
1268 serde_json_lenient::from_str(&contents).log_err()?;
1269 Some(Arc::new(ContextProviderWithTasks::new(definitions)) as Arc<_>)
1270 });
1271
1272 Ok(LoadedLanguage {
1273 config,
1274 queries,
1275 context_provider,
1276 toolchain_provider: None,
1277 manifest_name: None,
1278 })
1279 }),
1280 );
1281 }
1282
1283 let fs = self.fs.clone();
1284 let wasm_host = self.wasm_host.clone();
1285 let root_dir = self.installed_dir.clone();
1286 let proxy = self.proxy.clone();
1287 let extension_entries = extensions_to_load
1288 .iter()
1289 .filter_map(|name| new_index.extensions.get(name).cloned())
1290 .collect::<Vec<_>>();
1291 self.extension_index = new_index;
1292 cx.notify();
1293 cx.emit(Event::ExtensionsUpdated);
1294
1295 cx.spawn(async move |this, cx| {
1296 cx.background_spawn({
1297 let fs = fs.clone();
1298 async move {
1299 let _ = join_all(server_removal_tasks).await;
1300 for theme_path in themes_to_add {
1301 proxy
1302 .load_user_theme(theme_path, fs.clone())
1303 .await
1304 .log_err();
1305 }
1306
1307 for (icon_theme_path, icons_root_path) in icon_themes_to_add {
1308 proxy
1309 .load_icon_theme(icon_theme_path, icons_root_path, fs.clone())
1310 .await
1311 .log_err();
1312 }
1313
1314 for snippets_path in &snippets_to_add {
1315 match fs
1316 .load(snippets_path)
1317 .await
1318 .with_context(|| format!("Loading snippets from {snippets_path:?}"))
1319 {
1320 Ok(snippets_contents) => {
1321 proxy
1322 .register_snippet(snippets_path, &snippets_contents)
1323 .log_err();
1324 }
1325 Err(e) => log::error!("Cannot load snippets: {e:#}"),
1326 }
1327 }
1328 }
1329 })
1330 .await;
1331
1332 let mut wasm_extensions = Vec::new();
1333 for extension in extension_entries {
1334 if extension.manifest.lib.kind.is_none() {
1335 continue;
1336 };
1337
1338 let extension_path = root_dir.join(extension.manifest.id.as_ref());
1339 let wasm_extension = WasmExtension::load(
1340 &extension_path,
1341 &extension.manifest,
1342 wasm_host.clone(),
1343 cx,
1344 )
1345 .await
1346 .with_context(|| format!("Loading extension from {extension_path:?}"));
1347
1348 match wasm_extension {
1349 Ok(wasm_extension) => {
1350 wasm_extensions.push((extension.manifest.clone(), wasm_extension))
1351 }
1352 Err(e) => {
1353 log::error!("Failed to load extension: {e:#}");
1354 this.update(cx, |_, cx| {
1355 cx.emit(Event::ExtensionFailedToLoad(extension.manifest.id.clone()))
1356 })
1357 .ok();
1358 }
1359 }
1360 }
1361
1362 this.update(cx, |this, cx| {
1363 this.reload_complete_senders.clear();
1364
1365 for (manifest, wasm_extension) in &wasm_extensions {
1366 let extension = Arc::new(wasm_extension.clone());
1367
1368 for (language_server_id, language_server_config) in &manifest.language_servers {
1369 for language in language_server_config.languages() {
1370 this.proxy.register_language_server(
1371 extension.clone(),
1372 language_server_id.clone(),
1373 language.clone(),
1374 );
1375 }
1376 }
1377
1378 for (slash_command_name, slash_command) in &manifest.slash_commands {
1379 this.proxy.register_slash_command(
1380 extension.clone(),
1381 extension::SlashCommand {
1382 name: slash_command_name.to_string(),
1383 description: slash_command.description.to_string(),
1384 // We don't currently expose this as a configurable option, as it currently drives
1385 // the `menu_text` on the `SlashCommand` trait, which is not used for slash commands
1386 // defined in extensions, as they are not able to be added to the menu.
1387 tooltip_text: String::new(),
1388 requires_argument: slash_command.requires_argument,
1389 },
1390 );
1391 }
1392
1393 for id in manifest.context_servers.keys() {
1394 this.proxy
1395 .register_context_server(extension.clone(), id.clone(), cx);
1396 }
1397
1398 for (debug_adapter, meta) in &manifest.debug_adapters {
1399 let mut path = root_dir.clone();
1400 path.push(Path::new(manifest.id.as_ref()));
1401 if let Some(schema_path) = &meta.schema_path {
1402 path.push(schema_path);
1403 } else {
1404 path.push("debug_adapter_schemas");
1405 path.push(Path::new(debug_adapter.as_ref()).with_extension("json"));
1406 }
1407
1408 this.proxy.register_debug_adapter(
1409 extension.clone(),
1410 debug_adapter.clone(),
1411 &path,
1412 );
1413 }
1414
1415 for debug_adapter in manifest.debug_locators.keys() {
1416 this.proxy
1417 .register_debug_locator(extension.clone(), debug_adapter.clone());
1418 }
1419 }
1420
1421 this.wasm_extensions.extend(wasm_extensions);
1422 this.proxy.set_extensions_loaded();
1423 this.proxy.reload_current_theme(cx);
1424 this.proxy.reload_current_icon_theme(cx);
1425
1426 if let Some(events) = ExtensionEvents::try_global(cx) {
1427 events.update(cx, |this, cx| {
1428 this.emit(extension::Event::ExtensionsInstalledChanged, cx)
1429 });
1430 }
1431 })
1432 .ok();
1433 })
1434 }
1435
1436 fn rebuild_extension_index(&self, cx: &mut Context<Self>) -> Task<ExtensionIndex> {
1437 let fs = self.fs.clone();
1438 let work_dir = self.wasm_host.work_dir.clone();
1439 let extensions_dir = self.installed_dir.clone();
1440 let index_path = self.index_path.clone();
1441 let proxy = self.proxy.clone();
1442 cx.background_spawn(async move {
1443 let start_time = Instant::now();
1444 let mut index = ExtensionIndex::default();
1445
1446 fs.create_dir(&work_dir).await.log_err();
1447 fs.create_dir(&extensions_dir).await.log_err();
1448
1449 let extension_paths = fs.read_dir(&extensions_dir).await;
1450 if let Ok(mut extension_paths) = extension_paths {
1451 while let Some(extension_dir) = extension_paths.next().await {
1452 let Ok(extension_dir) = extension_dir else {
1453 continue;
1454 };
1455
1456 if extension_dir
1457 .file_name()
1458 .is_some_and(|file_name| file_name == ".DS_Store")
1459 {
1460 continue;
1461 }
1462
1463 Self::add_extension_to_index(
1464 fs.clone(),
1465 extension_dir,
1466 &mut index,
1467 proxy.clone(),
1468 )
1469 .await
1470 .log_err();
1471 }
1472 }
1473
1474 if let Ok(index_json) = serde_json::to_string_pretty(&index) {
1475 fs.save(&index_path, &index_json.as_str().into(), Default::default())
1476 .await
1477 .context("failed to save extension index")
1478 .log_err();
1479 }
1480
1481 log::info!("rebuilt extension index in {:?}", start_time.elapsed());
1482 index
1483 })
1484 }
1485
1486 async fn add_extension_to_index(
1487 fs: Arc<dyn Fs>,
1488 extension_dir: PathBuf,
1489 index: &mut ExtensionIndex,
1490 proxy: Arc<ExtensionHostProxy>,
1491 ) -> Result<()> {
1492 let mut extension_manifest = ExtensionManifest::load(fs.clone(), &extension_dir).await?;
1493 let extension_id = extension_manifest.id.clone();
1494
1495 // TODO: distinguish dev extensions more explicitly, by the absence
1496 // of a checksum file that we'll create when downloading normal extensions.
1497 let is_dev = fs
1498 .metadata(&extension_dir)
1499 .await?
1500 .context("directory does not exist")?
1501 .is_symlink;
1502
1503 if let Ok(mut language_paths) = fs.read_dir(&extension_dir.join("languages")).await {
1504 while let Some(language_path) = language_paths.next().await {
1505 let language_path = language_path?;
1506 let Ok(relative_path) = language_path.strip_prefix(&extension_dir) else {
1507 continue;
1508 };
1509 let Ok(Some(fs_metadata)) = fs.metadata(&language_path).await else {
1510 continue;
1511 };
1512 if !fs_metadata.is_dir {
1513 continue;
1514 }
1515 let config = fs.load(&language_path.join("config.toml")).await?;
1516 let config = ::toml::from_str::<LanguageConfig>(&config)?;
1517
1518 let relative_path = relative_path.to_path_buf();
1519 if !extension_manifest.languages.contains(&relative_path) {
1520 extension_manifest.languages.push(relative_path.clone());
1521 }
1522
1523 index.languages.insert(
1524 config.name.clone(),
1525 ExtensionIndexLanguageEntry {
1526 extension: extension_id.clone(),
1527 path: relative_path,
1528 matcher: config.matcher,
1529 hidden: config.hidden,
1530 grammar: config.grammar,
1531 },
1532 );
1533 }
1534 }
1535
1536 if let Ok(mut theme_paths) = fs.read_dir(&extension_dir.join("themes")).await {
1537 while let Some(theme_path) = theme_paths.next().await {
1538 let theme_path = theme_path?;
1539 let Ok(relative_path) = theme_path.strip_prefix(&extension_dir) else {
1540 continue;
1541 };
1542
1543 let Some(theme_families) = proxy
1544 .list_theme_names(theme_path.clone(), fs.clone())
1545 .await
1546 .log_err()
1547 else {
1548 continue;
1549 };
1550
1551 let relative_path = relative_path.to_path_buf();
1552 if !extension_manifest.themes.contains(&relative_path) {
1553 extension_manifest.themes.push(relative_path.clone());
1554 }
1555
1556 for theme_name in theme_families {
1557 index.themes.insert(
1558 theme_name.into(),
1559 ExtensionIndexThemeEntry {
1560 extension: extension_id.clone(),
1561 path: relative_path.clone(),
1562 },
1563 );
1564 }
1565 }
1566 }
1567
1568 if let Ok(mut icon_theme_paths) = fs.read_dir(&extension_dir.join("icon_themes")).await {
1569 while let Some(icon_theme_path) = icon_theme_paths.next().await {
1570 let icon_theme_path = icon_theme_path?;
1571 let Ok(relative_path) = icon_theme_path.strip_prefix(&extension_dir) else {
1572 continue;
1573 };
1574
1575 let Some(icon_theme_families) = proxy
1576 .list_icon_theme_names(icon_theme_path.clone(), fs.clone())
1577 .await
1578 .log_err()
1579 else {
1580 continue;
1581 };
1582
1583 let relative_path = relative_path.to_path_buf();
1584 if !extension_manifest.icon_themes.contains(&relative_path) {
1585 extension_manifest.icon_themes.push(relative_path.clone());
1586 }
1587
1588 for icon_theme_name in icon_theme_families {
1589 index.icon_themes.insert(
1590 icon_theme_name.into(),
1591 ExtensionIndexIconThemeEntry {
1592 extension: extension_id.clone(),
1593 path: relative_path.clone(),
1594 },
1595 );
1596 }
1597 }
1598 }
1599
1600 let extension_wasm_path = extension_dir.join("extension.wasm");
1601 if fs.is_file(&extension_wasm_path).await {
1602 extension_manifest
1603 .lib
1604 .kind
1605 .get_or_insert(ExtensionLibraryKind::Rust);
1606 }
1607
1608 index.extensions.insert(
1609 extension_id.clone(),
1610 ExtensionIndexEntry {
1611 dev: is_dev,
1612 manifest: Arc::new(extension_manifest),
1613 },
1614 );
1615
1616 Ok(())
1617 }
1618
1619 fn prepare_remote_extension(
1620 &mut self,
1621 extension_id: Arc<str>,
1622 is_dev: bool,
1623 tmp_dir: PathBuf,
1624 cx: &mut Context<Self>,
1625 ) -> Task<Result<()>> {
1626 let src_dir = self.extensions_dir().join(extension_id.as_ref());
1627 let Some(loaded_extension) = self.extension_index.extensions.get(&extension_id).cloned()
1628 else {
1629 return Task::ready(Err(anyhow!("extension no longer installed")));
1630 };
1631 let fs = self.fs.clone();
1632 cx.background_spawn(async move {
1633 const EXTENSION_TOML: &str = "extension.toml";
1634 const EXTENSION_WASM: &str = "extension.wasm";
1635 const CONFIG_TOML: &str = "config.toml";
1636
1637 if is_dev {
1638 let manifest_toml = toml::to_string(&loaded_extension.manifest)?;
1639 fs.save(
1640 &tmp_dir.join(EXTENSION_TOML),
1641 &Rope::from(manifest_toml),
1642 language::LineEnding::Unix,
1643 )
1644 .await?;
1645 } else {
1646 fs.copy_file(
1647 &src_dir.join(EXTENSION_TOML),
1648 &tmp_dir.join(EXTENSION_TOML),
1649 fs::CopyOptions::default(),
1650 )
1651 .await?
1652 }
1653
1654 if fs.is_file(&src_dir.join(EXTENSION_WASM)).await {
1655 fs.copy_file(
1656 &src_dir.join(EXTENSION_WASM),
1657 &tmp_dir.join(EXTENSION_WASM),
1658 fs::CopyOptions::default(),
1659 )
1660 .await?
1661 }
1662
1663 for language_path in loaded_extension.manifest.languages.iter() {
1664 if fs
1665 .is_file(&src_dir.join(language_path).join(CONFIG_TOML))
1666 .await
1667 {
1668 fs.create_dir(&tmp_dir.join(language_path)).await?;
1669 fs.copy_file(
1670 &src_dir.join(language_path).join(CONFIG_TOML),
1671 &tmp_dir.join(language_path).join(CONFIG_TOML),
1672 fs::CopyOptions::default(),
1673 )
1674 .await?
1675 }
1676 }
1677
1678 for (adapter_name, meta) in loaded_extension.manifest.debug_adapters.iter() {
1679 let schema_path = &extension::build_debug_adapter_schema_path(adapter_name, meta);
1680
1681 if fs.is_file(&src_dir.join(schema_path)).await {
1682 if let Some(parent) = schema_path.parent() {
1683 fs.create_dir(&tmp_dir.join(parent)).await?
1684 }
1685 fs.copy_file(
1686 &src_dir.join(schema_path),
1687 &tmp_dir.join(schema_path),
1688 fs::CopyOptions::default(),
1689 )
1690 .await?
1691 }
1692 }
1693
1694 Ok(())
1695 })
1696 }
1697
1698 async fn sync_extensions_over_ssh(
1699 this: &WeakEntity<Self>,
1700 client: WeakEntity<RemoteClient>,
1701 cx: &mut AsyncApp,
1702 ) -> Result<()> {
1703 let extensions = this.update(cx, |this, _cx| {
1704 this.extension_index
1705 .extensions
1706 .iter()
1707 .filter_map(|(id, entry)| {
1708 if !entry.manifest.allow_remote_load() {
1709 return None;
1710 }
1711 Some(proto::Extension {
1712 id: id.to_string(),
1713 version: entry.manifest.version.to_string(),
1714 dev: entry.dev,
1715 })
1716 })
1717 .collect()
1718 })?;
1719
1720 let response = client
1721 .update(cx, |client, _cx| {
1722 client
1723 .proto_client()
1724 .request(proto::SyncExtensions { extensions })
1725 })?
1726 .await?;
1727 let path_style = client.read_with(cx, |client, _| client.path_style())?;
1728
1729 for missing_extension in response.missing_extensions.into_iter() {
1730 let tmp_dir = tempfile::tempdir()?;
1731 this.update(cx, |this, cx| {
1732 this.prepare_remote_extension(
1733 missing_extension.id.clone().into(),
1734 missing_extension.dev,
1735 tmp_dir.path().to_owned(),
1736 cx,
1737 )
1738 })?
1739 .await?;
1740 let dest_dir = RemotePathBuf::new(
1741 PathBuf::from(&response.tmp_dir).join(missing_extension.clone().id),
1742 path_style,
1743 );
1744 log::info!("Uploading extension {}", missing_extension.clone().id);
1745
1746 client
1747 .update(cx, |client, cx| {
1748 client.upload_directory(tmp_dir.path().to_owned(), dest_dir.clone(), cx)
1749 })?
1750 .await?;
1751
1752 log::info!(
1753 "Finished uploading extension {}",
1754 missing_extension.clone().id
1755 );
1756
1757 client
1758 .update(cx, |client, _cx| {
1759 client.proto_client().request(proto::InstallExtension {
1760 tmp_dir: dest_dir.to_proto(),
1761 extension: Some(missing_extension),
1762 })
1763 })?
1764 .await?;
1765 }
1766
1767 anyhow::Ok(())
1768 }
1769
1770 pub async fn update_ssh_clients(this: &WeakEntity<Self>, cx: &mut AsyncApp) -> Result<()> {
1771 let clients = this.update(cx, |this, _cx| {
1772 this.remote_clients.retain(|_k, v| v.upgrade().is_some());
1773 this.remote_clients.values().cloned().collect::<Vec<_>>()
1774 })?;
1775
1776 for client in clients {
1777 Self::sync_extensions_over_ssh(this, client, cx)
1778 .await
1779 .log_err();
1780 }
1781
1782 anyhow::Ok(())
1783 }
1784
1785 pub fn register_remote_client(&mut self, client: Entity<RemoteClient>, cx: &mut Context<Self>) {
1786 let options = client.read(cx).connection_options();
1787
1788 if let Some(existing_client) = self.remote_clients.get(&options)
1789 && existing_client.upgrade().is_some()
1790 {
1791 return;
1792 }
1793
1794 self.remote_clients.insert(options, client.downgrade());
1795 self.ssh_registered_tx.unbounded_send(()).ok();
1796 }
1797}
1798
1799fn load_plugin_queries(root_path: &Path) -> LanguageQueries {
1800 let mut result = LanguageQueries::default();
1801 if let Some(entries) = std::fs::read_dir(root_path).log_err() {
1802 for entry in entries {
1803 let Some(entry) = entry.log_err() else {
1804 continue;
1805 };
1806 let path = entry.path();
1807 if let Some(remainder) = path.strip_prefix(root_path).ok().and_then(|p| p.to_str()) {
1808 if !remainder.ends_with(".scm") {
1809 continue;
1810 }
1811 for (name, query) in QUERY_FILENAME_PREFIXES {
1812 if remainder.starts_with(name) {
1813 if let Some(contents) = std::fs::read_to_string(&path).log_err() {
1814 match query(&mut result) {
1815 None => *query(&mut result) = Some(contents.into()),
1816 Some(r) => r.to_mut().push_str(contents.as_ref()),
1817 }
1818 }
1819 break;
1820 }
1821 }
1822 }
1823 }
1824 }
1825 result
1826}