Properly register initialized default prettier (#33669)

Stop doing useless prettier-related work when doing a project search.

Before, project search might cause

<img width="1728" alt="not_pretty"
src="https://github.com/user-attachments/assets/5f8b935f-962d-488e-984f-50dfbaee97ba"
/>

but now we debounce the prettier-related task first, and actually set
the "installed" state for the default prettier, when there's no install
needed.

Release Notes:

- N/A
This commit is contained in:
Kirill Bulatov 2025-06-30 22:08:50 +03:00 committed by GitHub
parent 7c4da37322
commit 197828980c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,6 +2,7 @@ use std::{
ops::ControlFlow, ops::ControlFlow,
path::{Path, PathBuf}, path::{Path, PathBuf},
sync::Arc, sync::Arc,
time::Duration,
}; };
use anyhow::{Context as _, Result, anyhow}; use anyhow::{Context as _, Result, anyhow};
@ -527,26 +528,6 @@ impl PrettierStore {
let mut new_plugins = plugins.collect::<HashSet<_>>(); let mut new_plugins = plugins.collect::<HashSet<_>>();
let node = self.node.clone(); let node = self.node.clone();
let fs = Arc::clone(&self.fs);
let locate_prettier_installation = match worktree.and_then(|worktree_id| {
self.worktree_store
.read(cx)
.worktree_for_id(worktree_id, cx)
.map(|worktree| worktree.read(cx).abs_path())
}) {
Some(locate_from) => {
let installed_prettiers = self.prettier_instances.keys().cloned().collect();
cx.background_spawn(async move {
Prettier::locate_prettier_installation(
fs.as_ref(),
&installed_prettiers,
locate_from.as_ref(),
)
.await
})
}
None => Task::ready(Ok(ControlFlow::Continue(None))),
};
new_plugins.retain(|plugin| !self.default_prettier.installed_plugins.contains(plugin)); new_plugins.retain(|plugin| !self.default_prettier.installed_plugins.contains(plugin));
let mut installation_attempt = 0; let mut installation_attempt = 0;
let previous_installation_task = match &mut self.default_prettier.prettier { let previous_installation_task = match &mut self.default_prettier.prettier {
@ -574,15 +555,34 @@ impl PrettierStore {
} }
}; };
log::info!("Initializing default prettier with plugins {new_plugins:?}");
let plugins_to_install = new_plugins.clone(); let plugins_to_install = new_plugins.clone();
let fs = Arc::clone(&self.fs); let fs = Arc::clone(&self.fs);
let new_installation_task = cx let new_installation_task = cx
.spawn(async move |project, cx| { .spawn(async move |prettier_store, cx| {
match locate_prettier_installation cx.background_executor().timer(Duration::from_millis(30)).await;
let location_data = prettier_store.update(cx, |prettier_store, cx| {
worktree.and_then(|worktree_id| {
prettier_store.worktree_store
.read(cx)
.worktree_for_id(worktree_id, cx)
.map(|worktree| worktree.read(cx).abs_path())
}).map(|locate_from| {
let installed_prettiers = prettier_store.prettier_instances.keys().cloned().collect();
(locate_from, installed_prettiers)
})
})?;
let locate_prettier_installation = match location_data {
Some((locate_from, installed_prettiers)) => Prettier::locate_prettier_installation(
fs.as_ref(),
&installed_prettiers,
locate_from.as_ref(),
)
.await .await
.context("locate prettier installation") .context("locate prettier installation").map_err(Arc::new)?,
.map_err(Arc::new)? None => ControlFlow::Continue(None),
};
match locate_prettier_installation
{ {
ControlFlow::Break(()) => return Ok(()), ControlFlow::Break(()) => return Ok(()),
ControlFlow::Continue(prettier_path) => { ControlFlow::Continue(prettier_path) => {
@ -593,8 +593,8 @@ impl PrettierStore {
if let Some(previous_installation_task) = previous_installation_task { if let Some(previous_installation_task) = previous_installation_task {
if let Err(e) = previous_installation_task.await { if let Err(e) = previous_installation_task.await {
log::error!("Failed to install default prettier: {e:#}"); log::error!("Failed to install default prettier: {e:#}");
project.update(cx, |project, _| { prettier_store.update(cx, |prettier_store, _| {
if let PrettierInstallation::NotInstalled { attempts, not_installed_plugins, .. } = &mut project.default_prettier.prettier { if let PrettierInstallation::NotInstalled { attempts, not_installed_plugins, .. } = &mut prettier_store.default_prettier.prettier {
*attempts += 1; *attempts += 1;
new_plugins.extend(not_installed_plugins.iter().cloned()); new_plugins.extend(not_installed_plugins.iter().cloned());
installation_attempt = *attempts; installation_attempt = *attempts;
@ -604,8 +604,8 @@ impl PrettierStore {
} }
}; };
if installation_attempt > prettier::FAIL_THRESHOLD { if installation_attempt > prettier::FAIL_THRESHOLD {
project.update(cx, |project, _| { prettier_store.update(cx, |prettier_store, _| {
if let PrettierInstallation::NotInstalled { installation_task, .. } = &mut project.default_prettier.prettier { if let PrettierInstallation::NotInstalled { installation_task, .. } = &mut prettier_store.default_prettier.prettier {
*installation_task = None; *installation_task = None;
}; };
})?; })?;
@ -614,19 +614,20 @@ impl PrettierStore {
); );
return Ok(()); return Ok(());
} }
project.update(cx, |project, _| { prettier_store.update(cx, |prettier_store, _| {
new_plugins.retain(|plugin| { new_plugins.retain(|plugin| {
!project.default_prettier.installed_plugins.contains(plugin) !prettier_store.default_prettier.installed_plugins.contains(plugin)
}); });
if let PrettierInstallation::NotInstalled { not_installed_plugins, .. } = &mut project.default_prettier.prettier { if let PrettierInstallation::NotInstalled { not_installed_plugins, .. } = &mut prettier_store.default_prettier.prettier {
not_installed_plugins.retain(|plugin| { not_installed_plugins.retain(|plugin| {
!project.default_prettier.installed_plugins.contains(plugin) !prettier_store.default_prettier.installed_plugins.contains(plugin)
}); });
not_installed_plugins.extend(new_plugins.iter().cloned()); not_installed_plugins.extend(new_plugins.iter().cloned());
} }
needs_install |= !new_plugins.is_empty(); needs_install |= !new_plugins.is_empty();
})?; })?;
if needs_install { if needs_install {
log::info!("Initializing default prettier with plugins {new_plugins:?}");
let installed_plugins = new_plugins.clone(); let installed_plugins = new_plugins.clone();
cx.background_spawn(async move { cx.background_spawn(async move {
install_prettier_packages(fs.as_ref(), new_plugins, node).await?; install_prettier_packages(fs.as_ref(), new_plugins, node).await?;
@ -637,17 +638,27 @@ impl PrettierStore {
.await .await
.context("prettier & plugins install") .context("prettier & plugins install")
.map_err(Arc::new)?; .map_err(Arc::new)?;
log::info!("Initialized prettier with plugins: {installed_plugins:?}"); log::info!("Initialized default prettier with plugins: {installed_plugins:?}");
project.update(cx, |project, _| { prettier_store.update(cx, |prettier_store, _| {
project.default_prettier.prettier = prettier_store.default_prettier.prettier =
PrettierInstallation::Installed(PrettierInstance { PrettierInstallation::Installed(PrettierInstance {
attempt: 0, attempt: 0,
prettier: None, prettier: None,
}); });
project.default_prettier prettier_store.default_prettier
.installed_plugins .installed_plugins
.extend(installed_plugins); .extend(installed_plugins);
})?; })?;
} else {
prettier_store.update(cx, |prettier_store, _| {
if let PrettierInstallation::NotInstalled { .. } = &mut prettier_store.default_prettier.prettier {
prettier_store.default_prettier.prettier =
PrettierInstallation::Installed(PrettierInstance {
attempt: 0,
prettier: None,
});
}
})?;
} }
} }
} }
@ -767,6 +778,7 @@ pub(super) async fn format_with_prettier(
} }
} }
#[derive(Debug)]
pub struct DefaultPrettier { pub struct DefaultPrettier {
prettier: PrettierInstallation, prettier: PrettierInstallation,
installed_plugins: HashSet<Arc<str>>, installed_plugins: HashSet<Arc<str>>,