]> git.lizzy.rs Git - rust.git/blob - src/tools/rust-analyzer/crates/rust-analyzer/src/reload.rs
Rollup merge of #95040 - frank-king:fix/94981, r=Mark-Simulacrum
[rust.git] / src / tools / rust-analyzer / crates / rust-analyzer / src / reload.rs
1 //! Project loading & configuration updates.
2 //!
3 //! This is quite tricky. The main problem is time and changes -- there's no
4 //! fixed "project" rust-analyzer is working with, "current project" is itself
5 //! mutable state. For example, when the user edits `Cargo.toml` by adding a new
6 //! dependency, project model changes. What's more, switching project model is
7 //! not instantaneous -- it takes time to run `cargo metadata` and (for proc
8 //! macros) `cargo check`.
9 //!
10 //! The main guiding principle here is, as elsewhere in rust-analyzer,
11 //! robustness. We try not to assume that the project model exists or is
12 //! correct. Instead, we try to provide a best-effort service. Even if the
13 //! project is currently loading and we don't have a full project model, we
14 //! still want to respond to various  requests.
15 use std::{mem, sync::Arc};
16
17 use flycheck::{FlycheckConfig, FlycheckHandle};
18 use hir::db::DefDatabase;
19 use ide::Change;
20 use ide_db::base_db::{
21     CrateGraph, Env, ProcMacro, ProcMacroExpander, ProcMacroExpansionError, ProcMacroKind,
22     ProcMacroLoadResult, SourceRoot, VfsPath,
23 };
24 use proc_macro_api::{MacroDylib, ProcMacroServer};
25 use project_model::{ProjectWorkspace, WorkspaceBuildScripts};
26 use syntax::SmolStr;
27 use vfs::{file_set::FileSetConfig, AbsPath, AbsPathBuf, ChangeKind};
28
29 use crate::{
30     config::{Config, FilesWatcher, LinkedProject},
31     global_state::GlobalState,
32     lsp_ext,
33     main_loop::Task,
34     op_queue::Cause,
35 };
36
37 #[derive(Debug)]
38 pub(crate) enum ProjectWorkspaceProgress {
39     Begin,
40     Report(String),
41     End(Vec<anyhow::Result<ProjectWorkspace>>),
42 }
43
44 #[derive(Debug)]
45 pub(crate) enum BuildDataProgress {
46     Begin,
47     Report(String),
48     End((Arc<Vec<ProjectWorkspace>>, Vec<anyhow::Result<WorkspaceBuildScripts>>)),
49 }
50
51 impl GlobalState {
52     pub(crate) fn is_quiescent(&self) -> bool {
53         !(self.fetch_workspaces_queue.op_in_progress()
54             || self.fetch_build_data_queue.op_in_progress()
55             || self.vfs_progress_config_version < self.vfs_config_version
56             || self.vfs_progress_n_done < self.vfs_progress_n_total)
57     }
58
59     pub(crate) fn update_configuration(&mut self, config: Config) {
60         let _p = profile::span("GlobalState::update_configuration");
61         let old_config = mem::replace(&mut self.config, Arc::new(config));
62         if self.config.lru_capacity() != old_config.lru_capacity() {
63             self.analysis_host.update_lru_capacity(self.config.lru_capacity());
64         }
65         if self.config.linked_projects() != old_config.linked_projects() {
66             self.fetch_workspaces_queue.request_op("linked projects changed".to_string())
67         } else if self.config.flycheck() != old_config.flycheck() {
68             self.reload_flycheck();
69         }
70
71         if self.analysis_host.raw_database().enable_proc_attr_macros()
72             != self.config.expand_proc_attr_macros()
73         {
74             self.analysis_host
75                 .raw_database_mut()
76                 .set_enable_proc_attr_macros(self.config.expand_proc_attr_macros());
77         }
78     }
79
80     pub(crate) fn current_status(&self) -> lsp_ext::ServerStatusParams {
81         let mut status = lsp_ext::ServerStatusParams {
82             health: lsp_ext::Health::Ok,
83             quiescent: self.is_quiescent(),
84             message: None,
85         };
86
87         if self.proc_macro_changed {
88             status.health = lsp_ext::Health::Warning;
89             status.message =
90                 Some("Reload required due to source changes of a procedural macro.".into())
91         }
92         if let Err(_) = self.fetch_build_data_error() {
93             status.health = lsp_ext::Health::Warning;
94             status.message =
95                 Some("Failed to run build scripts of some packages, check the logs.".to_string());
96         }
97         if !self.config.cargo_autoreload()
98             && self.is_quiescent()
99             && self.fetch_workspaces_queue.op_requested()
100         {
101             status.health = lsp_ext::Health::Warning;
102             status.message = Some("Workspace reload required".to_string())
103         }
104
105         if let Err(error) = self.fetch_workspace_error() {
106             status.health = lsp_ext::Health::Error;
107             status.message = Some(error)
108         }
109         status
110     }
111
112     pub(crate) fn fetch_workspaces(&mut self, cause: Cause) {
113         tracing::info!(%cause, "will fetch workspaces");
114
115         self.task_pool.handle.spawn_with_sender({
116             let linked_projects = self.config.linked_projects();
117             let detached_files = self.config.detached_files().to_vec();
118             let cargo_config = self.config.cargo();
119
120             move |sender| {
121                 let progress = {
122                     let sender = sender.clone();
123                     move |msg| {
124                         sender
125                             .send(Task::FetchWorkspace(ProjectWorkspaceProgress::Report(msg)))
126                             .unwrap()
127                     }
128                 };
129
130                 sender.send(Task::FetchWorkspace(ProjectWorkspaceProgress::Begin)).unwrap();
131
132                 let mut workspaces = linked_projects
133                     .iter()
134                     .map(|project| match project {
135                         LinkedProject::ProjectManifest(manifest) => {
136                             project_model::ProjectWorkspace::load(
137                                 manifest.clone(),
138                                 &cargo_config,
139                                 &progress,
140                             )
141                         }
142                         LinkedProject::InlineJsonProject(it) => {
143                             project_model::ProjectWorkspace::load_inline(
144                                 it.clone(),
145                                 cargo_config.target.as_deref(),
146                             )
147                         }
148                     })
149                     .collect::<Vec<_>>();
150
151                 if !detached_files.is_empty() {
152                     workspaces
153                         .push(project_model::ProjectWorkspace::load_detached_files(detached_files));
154                 }
155
156                 tracing::info!("did fetch workspaces {:?}", workspaces);
157                 sender
158                     .send(Task::FetchWorkspace(ProjectWorkspaceProgress::End(workspaces)))
159                     .unwrap();
160             }
161         });
162     }
163
164     pub(crate) fn fetch_build_data(&mut self, cause: Cause) {
165         tracing::info!(%cause, "will fetch build data");
166         let workspaces = Arc::clone(&self.workspaces);
167         let config = self.config.cargo();
168         self.task_pool.handle.spawn_with_sender(move |sender| {
169             sender.send(Task::FetchBuildData(BuildDataProgress::Begin)).unwrap();
170
171             let progress = {
172                 let sender = sender.clone();
173                 move |msg| {
174                     sender.send(Task::FetchBuildData(BuildDataProgress::Report(msg))).unwrap()
175                 }
176             };
177             let mut res = Vec::new();
178             for ws in workspaces.iter() {
179                 res.push(ws.run_build_scripts(&config, &progress));
180             }
181             sender.send(Task::FetchBuildData(BuildDataProgress::End((workspaces, res)))).unwrap();
182         });
183     }
184
185     pub(crate) fn switch_workspaces(&mut self, cause: Cause) {
186         let _p = profile::span("GlobalState::switch_workspaces");
187         tracing::info!(%cause, "will switch workspaces");
188
189         if let Err(error_message) = self.fetch_workspace_error() {
190             self.show_and_log_error(error_message, None);
191             if !self.workspaces.is_empty() {
192                 // It only makes sense to switch to a partially broken workspace
193                 // if we don't have any workspace at all yet.
194                 return;
195             }
196         }
197
198         if let Err(error) = self.fetch_build_data_error() {
199             self.show_and_log_error(
200                 "rust-analyzer failed to run build scripts".to_string(),
201                 Some(error),
202             );
203         }
204
205         let workspaces = self
206             .fetch_workspaces_queue
207             .last_op_result()
208             .iter()
209             .filter_map(|res| res.as_ref().ok().cloned())
210             .collect::<Vec<_>>();
211
212         fn eq_ignore_build_data<'a>(
213             left: &'a ProjectWorkspace,
214             right: &'a ProjectWorkspace,
215         ) -> bool {
216             let key = |p: &'a ProjectWorkspace| match p {
217                 ProjectWorkspace::Cargo {
218                     cargo,
219                     sysroot,
220                     rustc,
221                     rustc_cfg,
222                     cfg_overrides,
223
224                     build_scripts: _,
225                 } => Some((cargo, sysroot, rustc, rustc_cfg, cfg_overrides)),
226                 _ => None,
227             };
228             match (key(left), key(right)) {
229                 (Some(lk), Some(rk)) => lk == rk,
230                 _ => left == right,
231             }
232         }
233
234         let same_workspaces = workspaces.len() == self.workspaces.len()
235             && workspaces
236                 .iter()
237                 .zip(self.workspaces.iter())
238                 .all(|(l, r)| eq_ignore_build_data(l, r));
239
240         if same_workspaces {
241             let (workspaces, build_scripts) = self.fetch_build_data_queue.last_op_result();
242             if Arc::ptr_eq(workspaces, &self.workspaces) {
243                 tracing::debug!("set build scripts to workspaces");
244
245                 let workspaces = workspaces
246                     .iter()
247                     .cloned()
248                     .zip(build_scripts)
249                     .map(|(mut ws, bs)| {
250                         ws.set_build_scripts(bs.as_ref().ok().cloned().unwrap_or_default());
251                         ws
252                     })
253                     .collect::<Vec<_>>();
254
255                 // Workspaces are the same, but we've updated build data.
256                 self.workspaces = Arc::new(workspaces);
257             } else {
258                 tracing::info!("build scripts do not match the version of the active workspace");
259                 // Current build scripts do not match the version of the active
260                 // workspace, so there's nothing for us to update.
261                 return;
262             }
263         } else {
264             tracing::debug!("abandon build scripts for workspaces");
265
266             // Here, we completely changed the workspace (Cargo.toml edit), so
267             // we don't care about build-script results, they are stale.
268             self.workspaces = Arc::new(workspaces)
269         }
270
271         if let FilesWatcher::Client = self.config.files().watcher {
272             let registration_options = lsp_types::DidChangeWatchedFilesRegistrationOptions {
273                 watchers: self
274                     .workspaces
275                     .iter()
276                     .flat_map(|ws| ws.to_roots())
277                     .filter(|it| it.is_local)
278                     .flat_map(|root| {
279                         root.include.into_iter().flat_map(|it| {
280                             [
281                                 format!("{}/**/*.rs", it.display()),
282                                 format!("{}/**/Cargo.toml", it.display()),
283                                 format!("{}/**/Cargo.lock", it.display()),
284                             ]
285                         })
286                     })
287                     .map(|glob_pattern| lsp_types::FileSystemWatcher { glob_pattern, kind: None })
288                     .collect(),
289             };
290             let registration = lsp_types::Registration {
291                 id: "workspace/didChangeWatchedFiles".to_string(),
292                 method: "workspace/didChangeWatchedFiles".to_string(),
293                 register_options: Some(serde_json::to_value(registration_options).unwrap()),
294             };
295             self.send_request::<lsp_types::request::RegisterCapability>(
296                 lsp_types::RegistrationParams { registrations: vec![registration] },
297                 |_, _| (),
298             );
299         }
300
301         let mut change = Change::new();
302
303         let files_config = self.config.files();
304         let project_folders = ProjectFolders::new(&self.workspaces, &files_config.exclude);
305
306         if self.proc_macro_client.is_none() {
307             if let Some((path, args)) = self.config.proc_macro_srv() {
308                 match ProcMacroServer::spawn(path.clone(), args) {
309                     Ok(it) => self.proc_macro_client = Some(it),
310                     Err(err) => {
311                         tracing::error!(
312                             "Failed to run proc_macro_srv from path {}, error: {:?}",
313                             path.display(),
314                             err
315                         );
316                     }
317                 }
318             }
319         }
320
321         let watch = match files_config.watcher {
322             FilesWatcher::Client => vec![],
323             FilesWatcher::Server => project_folders.watch,
324         };
325         self.vfs_config_version += 1;
326         self.loader.handle.set_config(vfs::loader::Config {
327             load: project_folders.load,
328             watch,
329             version: self.vfs_config_version,
330         });
331
332         // Create crate graph from all the workspaces
333         let crate_graph = {
334             let proc_macro_client = self.proc_macro_client.as_ref();
335             let dummy_replacements = self.config.dummy_replacements();
336             let mut load_proc_macro = move |crate_name: &str, path: &AbsPath| {
337                 load_proc_macro(
338                     proc_macro_client,
339                     path,
340                     dummy_replacements.get(crate_name).map(|v| &**v).unwrap_or_default(),
341                 )
342             };
343
344             let vfs = &mut self.vfs.write().0;
345             let loader = &mut self.loader;
346             let mem_docs = &self.mem_docs;
347             let mut load = move |path: &AbsPath| {
348                 let _p = profile::span("GlobalState::load");
349                 let vfs_path = vfs::VfsPath::from(path.to_path_buf());
350                 if !mem_docs.contains(&vfs_path) {
351                     let contents = loader.handle.load_sync(path);
352                     vfs.set_file_contents(vfs_path.clone(), contents);
353                 }
354                 let res = vfs.file_id(&vfs_path);
355                 if res.is_none() {
356                     tracing::warn!("failed to load {}", path.display())
357                 }
358                 res
359             };
360
361             let mut crate_graph = CrateGraph::default();
362             for ws in self.workspaces.iter() {
363                 crate_graph.extend(ws.to_crate_graph(&mut load_proc_macro, &mut load));
364             }
365             crate_graph
366         };
367         change.set_crate_graph(crate_graph);
368
369         self.source_root_config = project_folders.source_root_config;
370
371         self.analysis_host.apply_change(change);
372         self.process_changes();
373         self.reload_flycheck();
374         tracing::info!("did switch workspaces");
375     }
376
377     fn fetch_workspace_error(&self) -> Result<(), String> {
378         let mut buf = String::new();
379
380         for ws in self.fetch_workspaces_queue.last_op_result() {
381             if let Err(err) = ws {
382                 stdx::format_to!(buf, "rust-analyzer failed to load workspace: {:#}\n", err);
383             }
384         }
385
386         if buf.is_empty() {
387             return Ok(());
388         }
389
390         Err(buf)
391     }
392
393     fn fetch_build_data_error(&self) -> Result<(), String> {
394         let mut buf = String::new();
395
396         for ws in &self.fetch_build_data_queue.last_op_result().1 {
397             match ws {
398                 Ok(data) => match data.error() {
399                     Some(stderr) => stdx::format_to!(buf, "{:#}\n", stderr),
400                     _ => (),
401                 },
402                 // io errors
403                 Err(err) => stdx::format_to!(buf, "{:#}\n", err),
404             }
405         }
406
407         if buf.is_empty() {
408             Ok(())
409         } else {
410             Err(buf)
411         }
412     }
413
414     fn reload_flycheck(&mut self) {
415         let _p = profile::span("GlobalState::reload_flycheck");
416         let config = match self.config.flycheck() {
417             Some(it) => it,
418             None => {
419                 self.flycheck = Vec::new();
420                 self.diagnostics.clear_check();
421                 return;
422             }
423         };
424
425         let sender = self.flycheck_sender.clone();
426         self.flycheck = self
427             .workspaces
428             .iter()
429             .enumerate()
430             .filter_map(|(id, w)| match w {
431                 ProjectWorkspace::Cargo { cargo, .. } => Some((id, cargo.workspace_root())),
432                 ProjectWorkspace::Json { project, .. } => {
433                     // Enable flychecks for json projects if a custom flycheck command was supplied
434                     // in the workspace configuration.
435                     match config {
436                         FlycheckConfig::CustomCommand { .. } => Some((id, project.path())),
437                         _ => None,
438                     }
439                 }
440                 ProjectWorkspace::DetachedFiles { .. } => None,
441             })
442             .map(|(id, root)| {
443                 let sender = sender.clone();
444                 FlycheckHandle::spawn(
445                     id,
446                     Box::new(move |msg| sender.send(msg).unwrap()),
447                     config.clone(),
448                     root.to_path_buf(),
449                 )
450             })
451             .collect();
452     }
453 }
454
455 #[derive(Default)]
456 pub(crate) struct ProjectFolders {
457     pub(crate) load: Vec<vfs::loader::Entry>,
458     pub(crate) watch: Vec<usize>,
459     pub(crate) source_root_config: SourceRootConfig,
460 }
461
462 impl ProjectFolders {
463     pub(crate) fn new(
464         workspaces: &[ProjectWorkspace],
465         global_excludes: &[AbsPathBuf],
466     ) -> ProjectFolders {
467         let mut res = ProjectFolders::default();
468         let mut fsc = FileSetConfig::builder();
469         let mut local_filesets = vec![];
470
471         for root in workspaces.iter().flat_map(|ws| ws.to_roots()) {
472             let file_set_roots: Vec<VfsPath> =
473                 root.include.iter().cloned().map(VfsPath::from).collect();
474
475             let entry = {
476                 let mut dirs = vfs::loader::Directories::default();
477                 dirs.extensions.push("rs".into());
478                 dirs.include.extend(root.include);
479                 dirs.exclude.extend(root.exclude);
480                 for excl in global_excludes {
481                     if dirs
482                         .include
483                         .iter()
484                         .any(|incl| incl.starts_with(excl) || excl.starts_with(incl))
485                     {
486                         dirs.exclude.push(excl.clone());
487                     }
488                 }
489
490                 vfs::loader::Entry::Directories(dirs)
491             };
492
493             if root.is_local {
494                 res.watch.push(res.load.len());
495             }
496             res.load.push(entry);
497
498             if root.is_local {
499                 local_filesets.push(fsc.len());
500             }
501             fsc.add_file_set(file_set_roots)
502         }
503
504         let fsc = fsc.build();
505         res.source_root_config = SourceRootConfig { fsc, local_filesets };
506
507         res
508     }
509 }
510
511 #[derive(Default, Debug)]
512 pub(crate) struct SourceRootConfig {
513     pub(crate) fsc: FileSetConfig,
514     pub(crate) local_filesets: Vec<usize>,
515 }
516
517 impl SourceRootConfig {
518     pub(crate) fn partition(&self, vfs: &vfs::Vfs) -> Vec<SourceRoot> {
519         let _p = profile::span("SourceRootConfig::partition");
520         self.fsc
521             .partition(vfs)
522             .into_iter()
523             .enumerate()
524             .map(|(idx, file_set)| {
525                 let is_local = self.local_filesets.contains(&idx);
526                 if is_local {
527                     SourceRoot::new_local(file_set)
528                 } else {
529                     SourceRoot::new_library(file_set)
530                 }
531             })
532             .collect()
533     }
534 }
535
536 /// Load the proc-macros for the given lib path, replacing all expanders whose names are in `dummy_replace`
537 /// with an identity dummy expander.
538 pub(crate) fn load_proc_macro(
539     server: Option<&ProcMacroServer>,
540     path: &AbsPath,
541     dummy_replace: &[Box<str>],
542 ) -> ProcMacroLoadResult {
543     let res: Result<Vec<_>, String> = (|| {
544         let dylib = MacroDylib::new(path.to_path_buf())
545             .map_err(|io| format!("Proc-macro dylib loading failed: {io}"))?;
546         let server = server.ok_or_else(|| format!("Proc-macro server not started"))?;
547         let vec = server.load_dylib(dylib).map_err(|e| format!("{e}"))?;
548         if vec.is_empty() {
549             return Err("proc macro library returned no proc macros".to_string());
550         }
551         Ok(vec
552             .into_iter()
553             .map(|expander| expander_to_proc_macro(expander, dummy_replace))
554             .collect())
555     })();
556     return match res {
557         Ok(proc_macros) => {
558             tracing::info!(
559                 "Loaded proc-macros for {}: {:?}",
560                 path.display(),
561                 proc_macros.iter().map(|it| it.name.clone()).collect::<Vec<_>>()
562             );
563             Ok(proc_macros)
564         }
565         Err(e) => {
566             tracing::warn!("proc-macro loading for {} failed: {e}", path.display());
567             Err(e)
568         }
569     };
570
571     fn expander_to_proc_macro(
572         expander: proc_macro_api::ProcMacro,
573         dummy_replace: &[Box<str>],
574     ) -> ProcMacro {
575         let name = SmolStr::from(expander.name());
576         let kind = match expander.kind() {
577             proc_macro_api::ProcMacroKind::CustomDerive => ProcMacroKind::CustomDerive,
578             proc_macro_api::ProcMacroKind::FuncLike => ProcMacroKind::FuncLike,
579             proc_macro_api::ProcMacroKind::Attr => ProcMacroKind::Attr,
580         };
581         let expander: Arc<dyn ProcMacroExpander> =
582             if dummy_replace.iter().any(|replace| &**replace == name) {
583                 Arc::new(DummyExpander)
584             } else {
585                 Arc::new(Expander(expander))
586             };
587         ProcMacro { name, kind, expander }
588     }
589
590     #[derive(Debug)]
591     struct Expander(proc_macro_api::ProcMacro);
592
593     impl ProcMacroExpander for Expander {
594         fn expand(
595             &self,
596             subtree: &tt::Subtree,
597             attrs: Option<&tt::Subtree>,
598             env: &Env,
599         ) -> Result<tt::Subtree, ProcMacroExpansionError> {
600             let env = env.iter().map(|(k, v)| (k.to_string(), v.to_string())).collect();
601             match self.0.expand(subtree, attrs, env) {
602                 Ok(Ok(subtree)) => Ok(subtree),
603                 Ok(Err(err)) => Err(ProcMacroExpansionError::Panic(err.0)),
604                 Err(err) => Err(ProcMacroExpansionError::System(err.to_string())),
605             }
606         }
607     }
608
609     /// Dummy identity expander, used for proc-macros that are deliberately ignored by the user.
610     #[derive(Debug)]
611     struct DummyExpander;
612
613     impl ProcMacroExpander for DummyExpander {
614         fn expand(
615             &self,
616             subtree: &tt::Subtree,
617             _: Option<&tt::Subtree>,
618             _: &Env,
619         ) -> Result<tt::Subtree, ProcMacroExpansionError> {
620             Ok(subtree.clone())
621         }
622     }
623 }
624
625 pub(crate) fn should_refresh_for_change(path: &AbsPath, change_kind: ChangeKind) -> bool {
626     const IMPLICIT_TARGET_FILES: &[&str] = &["build.rs", "src/main.rs", "src/lib.rs"];
627     const IMPLICIT_TARGET_DIRS: &[&str] = &["src/bin", "examples", "tests", "benches"];
628     let file_name = path.file_name().unwrap_or_default();
629
630     if file_name == "Cargo.toml" || file_name == "Cargo.lock" {
631         return true;
632     }
633     if change_kind == ChangeKind::Modify {
634         return false;
635     }
636     if path.extension().unwrap_or_default() != "rs" {
637         if (file_name == "config.toml" || file_name == "config")
638             && path.parent().map(|parent| parent.as_ref().ends_with(".cargo")) == Some(true)
639         {
640             return true;
641         }
642         return false;
643     }
644     if IMPLICIT_TARGET_FILES.iter().any(|it| path.as_ref().ends_with(it)) {
645         return true;
646     }
647     let parent = match path.parent() {
648         Some(it) => it,
649         None => return false,
650     };
651     if IMPLICIT_TARGET_DIRS.iter().any(|it| parent.as_ref().ends_with(it)) {
652         return true;
653     }
654     if file_name == "main.rs" {
655         let grand_parent = match parent.parent() {
656             Some(it) => it,
657             None => return false,
658         };
659         if IMPLICIT_TARGET_DIRS.iter().any(|it| grand_parent.as_ref().ends_with(it)) {
660             return true;
661         }
662     }
663     false
664 }