crates/rust-analyzer/src/main_loop.rs

   1 //! The main loop of `rust-analyzer` responsible for dispatching LSP
   2 //! requests/replies and notifications back to the client.
   3 use std::{
   4     fmt,
   5     sync::Arc,
   6     time::{Duration, Instant},
   7 };
   8
   9 use always_assert::always;
  10 use crossbeam_channel::{select, Receiver};
  11 use ide_db::base_db::{SourceDatabaseExt, VfsPath};
  12 use lsp_server::{Connection, Notification, Request};
  13 use lsp_types::notification::Notification as _;
  14 use vfs::{ChangeKind, FileId};
  15
  16 use crate::{
  17     config::Config,
  18     dispatch::{NotificationDispatcher, RequestDispatcher},
  19     from_proto,
  20     global_state::{file_id_to_url, url_to_file_id, GlobalState},
  21     handlers, lsp_ext,
  22     lsp_utils::{apply_document_changes, is_cancelled, notification_is, Progress},
  23     mem_docs::DocumentData,
  24     reload::{BuildDataProgress, ProjectWorkspaceProgress},
  25     Result,
  26 };
  27
  28 pub fn main_loop(config: Config, connection: Connection) -> Result<()> {
  29     tracing::info!("initial config: {:#?}", config);
  30
  31     // Windows scheduler implements priority boosts: if thread waits for an
  32     // event (like a condvar), and event fires, priority of the thread is
  33     // temporary bumped. This optimization backfires in our case: each time the
  34     // `main_loop` schedules a task to run on a threadpool, the worker threads
  35     // gets a higher priority, and (on a machine with fewer cores) displaces the
  36     // main loop! We work-around this by marking the main loop as a
  37     // higher-priority thread.
  38     //
  39     // https://docs.microsoft.com/en-us/windows/win32/procthread/scheduling-priorities
  40     // https://docs.microsoft.com/en-us/windows/win32/procthread/priority-boosts
  41     // https://github.com/rust-analyzer/rust-analyzer/issues/2835
  42     #[cfg(windows)]
  43     unsafe {
  44         use winapi::um::processthreadsapi::*;
  45         let thread = GetCurrentThread();
  46         let thread_priority_above_normal = 1;
  47         SetThreadPriority(thread, thread_priority_above_normal);
  48     }
  49
  50     GlobalState::new(connection.sender, config).run(connection.receiver)
  51 }
  52
  53 enum Event {
  54     Lsp(lsp_server::Message),
  55     Task(Task),
  56     Vfs(vfs::loader::Message),
  57     Flycheck(flycheck::Message),
  58 }
  59
  60 #[derive(Debug)]
  61 pub(crate) enum Task {
  62     Response(lsp_server::Response),
  63     Diagnostics(Vec<(FileId, Vec<lsp_types::Diagnostic>)>),
  64     PrimeCaches(PrimeCachesProgress),
  65     FetchWorkspace(ProjectWorkspaceProgress),
  66     FetchBuildData(BuildDataProgress),
  67 }
  68
  69 #[derive(Debug)]
  70 pub(crate) enum PrimeCachesProgress {
  71     Begin,
  72     Report(ide::PrimeCachesProgress),
  73     End { cancelled: bool },
  74 }
  75
  76 impl fmt::Debug for Event {
  77     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  78         let debug_verbose_not = |not: &Notification, f: &mut fmt::Formatter| {
  79             f.debug_struct("Notification").field("method", &not.method).finish()
  80         };
  81
  82         match self {
  83             Event::Lsp(lsp_server::Message::Notification(not)) => {
  84                 if notification_is::<lsp_types::notification::DidOpenTextDocument>(not)
  85                     || notification_is::<lsp_types::notification::DidChangeTextDocument>(not)
  86                 {
  87                     return debug_verbose_not(not, f);
  88                 }
  89             }
  90             Event::Task(Task::Response(resp)) => {
  91                 return f
  92                     .debug_struct("Response")
  93                     .field("id", &resp.id)
  94                     .field("error", &resp.error)
  95                     .finish();
  96             }
  97             _ => (),
  98         }
  99         match self {
 100             Event::Lsp(it) => fmt::Debug::fmt(it, f),
 101             Event::Task(it) => fmt::Debug::fmt(it, f),
 102             Event::Vfs(it) => fmt::Debug::fmt(it, f),
 103             Event::Flycheck(it) => fmt::Debug::fmt(it, f),
 104         }
 105     }
 106 }
 107
 108 impl GlobalState {
 109     fn run(mut self, inbox: Receiver<lsp_server::Message>) -> Result<()> {
 110         if self.config.linked_projects().is_empty()
 111             && self.config.detached_files().is_empty()
 112             && self.config.notifications().cargo_toml_not_found
 113         {
 114             self.show_message(
 115                 lsp_types::MessageType::Error,
 116                 "rust-analyzer failed to discover workspace".to_string(),
 117             );
 118         };
 119
 120         if self.config.did_save_text_document_dynamic_registration() {
 121             let save_registration_options = lsp_types::TextDocumentSaveRegistrationOptions {
 122                 include_text: Some(false),
 123                 text_document_registration_options: lsp_types::TextDocumentRegistrationOptions {
 124                     document_selector: Some(vec![
 125                         lsp_types::DocumentFilter {
 126                             language: None,
 127                             scheme: None,
 128                             pattern: Some("**/*.rs".into()),
 129                         },
 130                         lsp_types::DocumentFilter {
 131                             language: None,
 132                             scheme: None,
 133                             pattern: Some("**/Cargo.toml".into()),
 134                         },
 135                         lsp_types::DocumentFilter {
 136                             language: None,
 137                             scheme: None,
 138                             pattern: Some("**/Cargo.lock".into()),
 139                         },
 140                     ]),
 141                 },
 142             };
 143
 144             let registration = lsp_types::Registration {
 145                 id: "textDocument/didSave".to_string(),
 146                 method: "textDocument/didSave".to_string(),
 147                 register_options: Some(serde_json::to_value(save_registration_options).unwrap()),
 148             };
 149             self.send_request::<lsp_types::request::RegisterCapability>(
 150                 lsp_types::RegistrationParams { registrations: vec![registration] },
 151                 |_, _| (),
 152             );
 153         }
 154
 155         self.fetch_workspaces_queue.request_op();
 156         if self.fetch_workspaces_queue.should_start_op() {
 157             self.fetch_workspaces();
 158         }
 159
 160         while let Some(event) = self.next_event(&inbox) {
 161             if let Event::Lsp(lsp_server::Message::Notification(not)) = &event {
 162                 if not.method == lsp_types::notification::Exit::METHOD {
 163                     return Ok(());
 164                 }
 165             }
 166             self.handle_event(event)?
 167         }
 168
 169         Err("client exited without proper shutdown sequence")?
 170     }
 171
 172     fn next_event(&self, inbox: &Receiver<lsp_server::Message>) -> Option<Event> {
 173         select! {
 174             recv(inbox) -> msg =>
 175                 msg.ok().map(Event::Lsp),
 176
 177             recv(self.task_pool.receiver) -> task =>
 178                 Some(Event::Task(task.unwrap())),
 179
 180             recv(self.loader.receiver) -> task =>
 181                 Some(Event::Vfs(task.unwrap())),
 182
 183             recv(self.flycheck_receiver) -> task =>
 184                 Some(Event::Flycheck(task.unwrap())),
 185         }
 186     }
 187
 188     fn handle_event(&mut self, event: Event) -> Result<()> {
 189         let loop_start = Instant::now();
 190         // NOTE: don't count blocking select! call as a loop-turn time
 191         let _p = profile::span("GlobalState::handle_event");
 192
 193         tracing::info!("handle_event({:?})", event);
 194         let task_queue_len = self.task_pool.handle.len();
 195         if task_queue_len > 0 {
 196             tracing::info!("task queue len: {}", task_queue_len);
 197         }
 198
 199         let was_quiescent = self.is_quiescent();
 200         match event {
 201             Event::Lsp(msg) => match msg {
 202                 lsp_server::Message::Request(req) => self.on_request(loop_start, req)?,
 203                 lsp_server::Message::Notification(not) => {
 204                     self.on_notification(not)?;
 205                 }
 206                 lsp_server::Message::Response(resp) => self.complete_request(resp),
 207             },
 208             Event::Task(mut task) => {
 209                 let _p = profile::span("GlobalState::handle_event/task");
 210                 let mut prime_caches_progress = Vec::new();
 211                 loop {
 212                     match task {
 213                         Task::Response(response) => self.respond(response),
 214                         Task::Diagnostics(diagnostics_per_file) => {
 215                             for (file_id, diagnostics) in diagnostics_per_file {
 216                                 self.diagnostics.set_native_diagnostics(file_id, diagnostics)
 217                             }
 218                         }
 219                         Task::PrimeCaches(progress) => match progress {
 220                             PrimeCachesProgress::Begin => prime_caches_progress.push(progress),
 221                             PrimeCachesProgress::Report(_) => {
 222                                 match prime_caches_progress.last_mut() {
 223                                     Some(last @ PrimeCachesProgress::Report(_)) => {
 224                                         // Coalesce subsequent update events.
 225                                         *last = progress;
 226                                     }
 227                                     _ => prime_caches_progress.push(progress),
 228                                 }
 229                             }
 230                             PrimeCachesProgress::End { .. } => prime_caches_progress.push(progress),
 231                         },
 232                         Task::FetchWorkspace(progress) => {
 233                             let (state, msg) = match progress {
 234                                 ProjectWorkspaceProgress::Begin => (Progress::Begin, None),
 235                                 ProjectWorkspaceProgress::Report(msg) => {
 236                                     (Progress::Report, Some(msg))
 237                                 }
 238                                 ProjectWorkspaceProgress::End(workspaces) => {
 239                                     self.fetch_workspaces_queue.op_completed(workspaces);
 240
 241                                     let old = Arc::clone(&self.workspaces);
 242                                     self.switch_workspaces();
 243                                     let workspaces_updated = !Arc::ptr_eq(&old, &self.workspaces);
 244
 245                                     if self.config.run_build_scripts() && workspaces_updated {
 246                                         self.fetch_build_data_queue.request_op()
 247                                     }
 248
 249                                     (Progress::End, None)
 250                                 }
 251                             };
 252
 253                             self.report_progress("Fetching", state, msg, None);
 254                         }
 255                         Task::FetchBuildData(progress) => {
 256                             let (state, msg) = match progress {
 257                                 BuildDataProgress::Begin => (Some(Progress::Begin), None),
 258                                 BuildDataProgress::Report(msg) => {
 259                                     (Some(Progress::Report), Some(msg))
 260                                 }
 261                                 BuildDataProgress::End(build_data_result) => {
 262                                     self.fetch_build_data_queue.op_completed(build_data_result);
 263
 264                                     self.switch_workspaces();
 265
 266                                     (Some(Progress::End), None)
 267                                 }
 268                             };
 269
 270                             if let Some(state) = state {
 271                                 self.report_progress("Loading", state, msg, None);
 272                             }
 273                         }
 274                     }
 275
 276                     // Coalesce multiple task events into one loop turn
 277                     task = match self.task_pool.receiver.try_recv() {
 278                         Ok(task) => task,
 279                         Err(_) => break,
 280                     };
 281                 }
 282
 283                 for progress in prime_caches_progress {
 284                     let (state, message, fraction);
 285                     match progress {
 286                         PrimeCachesProgress::Begin => {
 287                             state = Progress::Begin;
 288                             message = None;
 289                             fraction = 0.0;
 290                         }
 291                         PrimeCachesProgress::Report(report) => {
 292                             state = Progress::Report;
 293                             message = Some(format!(
 294                                 "{}/{} ({})",
 295                                 report.n_done, report.n_total, report.on_crate
 296                             ));
 297                             fraction = Progress::fraction(report.n_done, report.n_total);
 298                         }
 299                         PrimeCachesProgress::End { cancelled } => {
 300                             state = Progress::End;
 301                             message = None;
 302                             fraction = 1.0;
 303
 304                             self.prime_caches_queue.op_completed(());
 305                             if cancelled {
 306                                 self.prime_caches_queue.request_op();
 307                             }
 308                         }
 309                     };
 310
 311                     self.report_progress("Indexing", state, message, Some(fraction));
 312                 }
 313             }
 314             Event::Vfs(mut task) => {
 315                 let _p = profile::span("GlobalState::handle_event/vfs");
 316                 loop {
 317                     match task {
 318                         vfs::loader::Message::Loaded { files } => {
 319                             let vfs = &mut self.vfs.write().0;
 320                             for (path, contents) in files {
 321                                 let path = VfsPath::from(path);
 322                                 if !self.mem_docs.contains(&path) {
 323                                     vfs.set_file_contents(path, contents);
 324                                 }
 325                             }
 326                         }
 327                         vfs::loader::Message::Progress { n_total, n_done, config_version } => {
 328                             always!(config_version <= self.vfs_config_version);
 329
 330                             self.vfs_progress_config_version = config_version;
 331                             self.vfs_progress_n_total = n_total;
 332                             self.vfs_progress_n_done = n_done;
 333
 334                             let state = if n_done == 0 {
 335                                 Progress::Begin
 336                             } else if n_done < n_total {
 337                                 Progress::Report
 338                             } else {
 339                                 assert_eq!(n_done, n_total);
 340                                 Progress::End
 341                             };
 342                             self.report_progress(
 343                                 "Roots Scanned",
 344                                 state,
 345                                 Some(format!("{}/{}", n_done, n_total)),
 346                                 Some(Progress::fraction(n_done, n_total)),
 347                             )
 348                         }
 349                     }
 350                     // Coalesce many VFS event into a single loop turn
 351                     task = match self.loader.receiver.try_recv() {
 352                         Ok(task) => task,
 353                         Err(_) => break,
 354                     }
 355                 }
 356             }
 357             Event::Flycheck(mut task) => {
 358                 let _p = profile::span("GlobalState::handle_event/flycheck");
 359                 loop {
 360                     match task {
 361                         flycheck::Message::AddDiagnostic { workspace_root, diagnostic } => {
 362                             let diagnostics =
 363                                 crate::diagnostics::to_proto::map_rust_diagnostic_to_lsp(
 364                                     &self.config.diagnostics_map(),
 365                                     &diagnostic,
 366                                     &workspace_root,
 367                                 );
 368                             for diag in diagnostics {
 369                                 match url_to_file_id(&self.vfs.read().0, &diag.url) {
 370                                     Ok(file_id) => self.diagnostics.add_check_diagnostic(
 371                                         file_id,
 372                                         diag.diagnostic,
 373                                         diag.fixes,
 374                                     ),
 375                                     Err(err) => {
 376                                         tracing::error!(
 377                                             "File with cargo diagnostic not found in VFS: {}",
 378                                             err
 379                                         );
 380                                     }
 381                                 };
 382                             }
 383                         }
 384
 385                         flycheck::Message::Progress { id, progress } => {
 386                             let (state, message) = match progress {
 387                                 flycheck::Progress::DidStart => {
 388                                     self.diagnostics.clear_check();
 389                                     (Progress::Begin, None)
 390                                 }
 391                                 flycheck::Progress::DidCheckCrate(target) => {
 392                                     (Progress::Report, Some(target))
 393                                 }
 394                                 flycheck::Progress::DidCancel => (Progress::End, None),
 395                                 flycheck::Progress::DidFinish(result) => {
 396                                     if let Err(err) = result {
 397                                         tracing::error!("cargo check failed: {}", err)
 398                                     }
 399                                     (Progress::End, None)
 400                                 }
 401                             };
 402
 403                             // When we're running multiple flychecks, we have to include a disambiguator in
 404                             // the title, or the editor complains. Note that this is a user-facing string.
 405                             let title = if self.flycheck.len() == 1 {
 406                                 "cargo check".to_string()
 407                             } else {
 408                                 format!("cargo check (#{})", id + 1)
 409                             };
 410                             self.report_progress(&title, state, message, None);
 411                         }
 412                     }
 413                     // Coalesce many flycheck updates into a single loop turn
 414                     task = match self.flycheck_receiver.try_recv() {
 415                         Ok(task) => task,
 416                         Err(_) => break,
 417                     }
 418                 }
 419             }
 420         }
 421
 422         let state_changed = self.process_changes();
 423         let memdocs_added_or_removed = self.mem_docs.take_changes();
 424
 425         if self.is_quiescent() {
 426             if !was_quiescent {
 427                 for flycheck in &self.flycheck {
 428                     flycheck.update();
 429                 }
 430                 self.prime_caches_queue.request_op();
 431             }
 432
 433             if !was_quiescent || state_changed {
 434                 // Refresh semantic tokens if the client supports it.
 435                 if self.config.semantic_tokens_refresh() {
 436                     self.semantic_tokens_cache.lock().clear();
 437                     self.send_request::<lsp_types::request::SemanticTokensRefesh>((), |_, _| ());
 438                 }
 439
 440                 // Refresh code lens if the client supports it.
 441                 if self.config.code_lens_refresh() {
 442                     self.send_request::<lsp_types::request::CodeLensRefresh>((), |_, _| ());
 443                 }
 444             }
 445
 446             if !was_quiescent || state_changed || memdocs_added_or_removed {
 447                 if self.config.publish_diagnostics() {
 448                     self.update_diagnostics()
 449                 }
 450             }
 451         }
 452
 453         if let Some(diagnostic_changes) = self.diagnostics.take_changes() {
 454             for file_id in diagnostic_changes {
 455                 let db = self.analysis_host.raw_database();
 456                 let source_root = db.file_source_root(file_id);
 457                 if db.source_root(source_root).is_library {
 458                     // Only publish diagnostics for files in the workspace, not from crates.io deps
 459                     // or the sysroot.
 460                     // While theoretically these should never have errors, we have quite a few false
 461                     // positives particularly in the stdlib, and those diagnostics would stay around
 462                     // forever if we emitted them here.
 463                     continue;
 464                 }
 465
 466                 let url = file_id_to_url(&self.vfs.read().0, file_id);
 467                 let diagnostics = self.diagnostics.diagnostics_for(file_id).cloned().collect();
 468                 let version = from_proto::vfs_path(&url)
 469                     .map(|path| self.mem_docs.get(&path).map(|it| it.version))
 470                     .unwrap_or_default();
 471
 472                 self.send_notification::<lsp_types::notification::PublishDiagnostics>(
 473                     lsp_types::PublishDiagnosticsParams { uri: url, diagnostics, version },
 474                 );
 475             }
 476         }
 477
 478         if self.config.cargo_autoreload() {
 479             if self.fetch_workspaces_queue.should_start_op() {
 480                 self.fetch_workspaces();
 481             }
 482         }
 483         if self.fetch_build_data_queue.should_start_op() {
 484             self.fetch_build_data();
 485         }
 486         if self.prime_caches_queue.should_start_op() {
 487             self.task_pool.handle.spawn_with_sender({
 488                 let analysis = self.snapshot().analysis;
 489                 move |sender| {
 490                     sender.send(Task::PrimeCaches(PrimeCachesProgress::Begin)).unwrap();
 491                     let res = analysis.prime_caches(|progress| {
 492                         let report = PrimeCachesProgress::Report(progress);
 493                         sender.send(Task::PrimeCaches(report)).unwrap();
 494                     });
 495                     sender
 496                         .send(Task::PrimeCaches(PrimeCachesProgress::End {
 497                             cancelled: res.is_err(),
 498                         }))
 499                         .unwrap();
 500                 }
 501             });
 502         }
 503
 504         let status = self.current_status();
 505         if self.last_reported_status.as_ref() != Some(&status) {
 506             self.last_reported_status = Some(status.clone());
 507
 508             if let (lsp_ext::Health::Error, Some(message)) = (status.health, &status.message) {
 509                 self.show_message(lsp_types::MessageType::Error, message.clone());
 510             }
 511
 512             if self.config.server_status_notification() {
 513                 self.send_notification::<lsp_ext::ServerStatusNotification>(status);
 514             }
 515         }
 516
 517         let loop_duration = loop_start.elapsed();
 518         if loop_duration > Duration::from_millis(100) {
 519             tracing::warn!("overly long loop turn: {:?}", loop_duration);
 520             self.poke_rust_analyzer_developer(format!(
 521                 "overly long loop turn: {:?}",
 522                 loop_duration
 523             ));
 524         }
 525         Ok(())
 526     }
 527
 528     fn on_request(&mut self, request_received: Instant, req: Request) -> Result<()> {
 529         self.register_request(&req, request_received);
 530
 531         if self.shutdown_requested {
 532             self.respond(lsp_server::Response::new_err(
 533                 req.id,
 534                 lsp_server::ErrorCode::InvalidRequest as i32,
 535                 "Shutdown already requested.".to_owned(),
 536             ));
 537
 538             return Ok(());
 539         }
 540
 541         // Avoid flashing a bunch of unresolved references during initial load.
 542         if self.workspaces.is_empty() && !self.is_quiescent() {
 543             self.respond(lsp_server::Response::new_err(
 544                 req.id,
 545                 // FIXME: i32 should impl From<ErrorCode> (from() guarantees lossless conversion)
 546                 lsp_server::ErrorCode::ContentModified as i32,
 547                 "waiting for cargo metadata or cargo check".to_owned(),
 548             ));
 549             return Ok(());
 550         }
 551
 552         RequestDispatcher { req: Some(req), global_state: self }
 553             .on_sync_mut::<lsp_ext::ReloadWorkspace>(|s, ()| {
 554                 s.fetch_workspaces_queue.request_op();
 555                 Ok(())
 556             })?
 557             .on_sync_mut::<lsp_types::request::Shutdown>(|s, ()| {
 558                 s.shutdown_requested = true;
 559                 Ok(())
 560             })?
 561             .on_sync_mut::<lsp_ext::MemoryUsage>(|s, p| handlers::handle_memory_usage(s, p))?
 562             .on_sync::<lsp_ext::JoinLines>(handlers::handle_join_lines)?
 563             .on_sync::<lsp_ext::OnEnter>(handlers::handle_on_enter)?
 564             .on_sync::<lsp_types::request::SelectionRangeRequest>(handlers::handle_selection_range)?
 565             .on_sync::<lsp_ext::MatchingBrace>(handlers::handle_matching_brace)?
 566             .on::<lsp_ext::AnalyzerStatus>(handlers::handle_analyzer_status)
 567             .on::<lsp_ext::SyntaxTree>(handlers::handle_syntax_tree)
 568             .on::<lsp_ext::ViewHir>(handlers::handle_view_hir)
 569             .on::<lsp_ext::ViewCrateGraph>(handlers::handle_view_crate_graph)
 570             .on::<lsp_ext::ViewItemTree>(handlers::handle_view_item_tree)
 571             .on::<lsp_ext::ExpandMacro>(handlers::handle_expand_macro)
 572             .on::<lsp_ext::ParentModule>(handlers::handle_parent_module)
 573             .on::<lsp_ext::Runnables>(handlers::handle_runnables)
 574             .on::<lsp_ext::RelatedTests>(handlers::handle_related_tests)
 575             .on::<lsp_ext::InlayHints>(handlers::handle_inlay_hints)
 576             .on::<lsp_ext::CodeActionRequest>(handlers::handle_code_action)
 577             .on::<lsp_ext::CodeActionResolveRequest>(handlers::handle_code_action_resolve)
 578             .on::<lsp_ext::HoverRequest>(handlers::handle_hover)
 579             .on::<lsp_ext::ExternalDocs>(handlers::handle_open_docs)
 580             .on::<lsp_ext::OpenCargoToml>(handlers::handle_open_cargo_toml)
 581             .on::<lsp_ext::MoveItem>(handlers::handle_move_item)
 582             .on::<lsp_ext::WorkspaceSymbol>(handlers::handle_workspace_symbol)
 583             .on::<lsp_types::request::OnTypeFormatting>(handlers::handle_on_type_formatting)
 584             .on::<lsp_types::request::DocumentSymbolRequest>(handlers::handle_document_symbol)
 585             .on::<lsp_types::request::GotoDefinition>(handlers::handle_goto_definition)
 586             .on::<lsp_types::request::GotoDeclaration>(handlers::handle_goto_declaration)
 587             .on::<lsp_types::request::GotoImplementation>(handlers::handle_goto_implementation)
 588             .on::<lsp_types::request::GotoTypeDefinition>(handlers::handle_goto_type_definition)
 589             .on::<lsp_types::request::Completion>(handlers::handle_completion)
 590             .on::<lsp_types::request::ResolveCompletionItem>(handlers::handle_completion_resolve)
 591             .on::<lsp_types::request::CodeLensRequest>(handlers::handle_code_lens)
 592             .on::<lsp_types::request::CodeLensResolve>(handlers::handle_code_lens_resolve)
 593             .on::<lsp_types::request::FoldingRangeRequest>(handlers::handle_folding_range)
 594             .on::<lsp_types::request::SignatureHelpRequest>(handlers::handle_signature_help)
 595             .on::<lsp_types::request::PrepareRenameRequest>(handlers::handle_prepare_rename)
 596             .on::<lsp_types::request::Rename>(handlers::handle_rename)
 597             .on::<lsp_types::request::References>(handlers::handle_references)
 598             .on::<lsp_types::request::Formatting>(handlers::handle_formatting)
 599             .on::<lsp_types::request::RangeFormatting>(handlers::handle_range_formatting)
 600             .on::<lsp_types::request::DocumentHighlightRequest>(handlers::handle_document_highlight)
 601             .on::<lsp_types::request::CallHierarchyPrepare>(handlers::handle_call_hierarchy_prepare)
 602             .on::<lsp_types::request::CallHierarchyIncomingCalls>(
 603                 handlers::handle_call_hierarchy_incoming,
 604             )
 605             .on::<lsp_types::request::CallHierarchyOutgoingCalls>(
 606                 handlers::handle_call_hierarchy_outgoing,
 607             )
 608             .on::<lsp_types::request::SemanticTokensFullRequest>(
 609                 handlers::handle_semantic_tokens_full,
 610             )
 611             .on::<lsp_types::request::SemanticTokensFullDeltaRequest>(
 612                 handlers::handle_semantic_tokens_full_delta,
 613             )
 614             .on::<lsp_types::request::SemanticTokensRangeRequest>(
 615                 handlers::handle_semantic_tokens_range,
 616             )
 617             .on::<lsp_types::request::WillRenameFiles>(handlers::handle_will_rename_files)
 618             .on::<lsp_ext::Ssr>(handlers::handle_ssr)
 619             .finish();
 620         Ok(())
 621     }
 622     fn on_notification(&mut self, not: Notification) -> Result<()> {
 623         NotificationDispatcher { not: Some(not), global_state: self }
 624             .on::<lsp_types::notification::Cancel>(|this, params| {
 625                 let id: lsp_server::RequestId = match params.id {
 626                     lsp_types::NumberOrString::Number(id) => id.into(),
 627                     lsp_types::NumberOrString::String(id) => id.into(),
 628                 };
 629                 this.cancel(id);
 630                 Ok(())
 631             })?
 632             .on::<lsp_types::notification::WorkDoneProgressCancel>(|_this, _params| {
 633                 // Just ignore this. It is OK to continue sending progress
 634                 // notifications for this token, as the client can't know when
 635                 // we accepted notification.
 636                 Ok(())
 637             })?
 638             .on::<lsp_types::notification::DidOpenTextDocument>(|this, params| {
 639                 if let Ok(path) = from_proto::vfs_path(&params.text_document.uri) {
 640                     if this
 641                         .mem_docs
 642                         .insert(path.clone(), DocumentData::new(params.text_document.version))
 643                         .is_err()
 644                     {
 645                         tracing::error!("duplicate DidOpenTextDocument: {}", path)
 646                     }
 647                     this.vfs
 648                         .write()
 649                         .0
 650                         .set_file_contents(path, Some(params.text_document.text.into_bytes()));
 651                 }
 652                 Ok(())
 653             })?
 654             .on::<lsp_types::notification::DidChangeTextDocument>(|this, params| {
 655                 if let Ok(path) = from_proto::vfs_path(&params.text_document.uri) {
 656                     match this.mem_docs.get_mut(&path) {
 657                         Some(doc) => {
 658                             // The version passed in DidChangeTextDocument is the version after all edits are applied
 659                             // so we should apply it before the vfs is notified.
 660                             doc.version = params.text_document.version;
 661                         }
 662                         None => {
 663                             tracing::error!("expected DidChangeTextDocument: {}", path);
 664                             return Ok(());
 665                         }
 666                     };
 667
 668                     let vfs = &mut this.vfs.write().0;
 669                     let file_id = vfs.file_id(&path).unwrap();
 670                     let mut text = String::from_utf8(vfs.file_contents(file_id).to_vec()).unwrap();
 671                     apply_document_changes(&mut text, params.content_changes);
 672
 673                     vfs.set_file_contents(path, Some(text.into_bytes()));
 674                 }
 675                 Ok(())
 676             })?
 677             .on::<lsp_types::notification::DidCloseTextDocument>(|this, params| {
 678                 if let Ok(path) = from_proto::vfs_path(&params.text_document.uri) {
 679                     if this.mem_docs.remove(&path).is_err() {
 680                         tracing::error!("orphan DidCloseTextDocument: {}", path);
 681                     }
 682
 683                     this.semantic_tokens_cache.lock().remove(&params.text_document.uri);
 684
 685                     if let Some(path) = path.as_path() {
 686                         this.loader.handle.invalidate(path.to_path_buf());
 687                     }
 688                 }
 689                 Ok(())
 690             })?
 691             .on::<lsp_types::notification::DidSaveTextDocument>(|this, params| {
 692                 for flycheck in &this.flycheck {
 693                     flycheck.update();
 694                 }
 695                 if let Ok(abs_path) = from_proto::abs_path(&params.text_document.uri) {
 696                     this.maybe_refresh(&[(abs_path, ChangeKind::Modify)]);
 697                 }
 698                 Ok(())
 699             })?
 700             .on::<lsp_types::notification::DidChangeConfiguration>(|this, _params| {
 701                 // As stated in https://github.com/microsoft/language-server-protocol/issues/676,
 702                 // this notification's parameters should be ignored and the actual config queried separately.
 703                 this.send_request::<lsp_types::request::WorkspaceConfiguration>(
 704                     lsp_types::ConfigurationParams {
 705                         items: vec![lsp_types::ConfigurationItem {
 706                             scope_uri: None,
 707                             section: Some("rust-analyzer".to_string()),
 708                         }],
 709                     },
 710                     |this, resp| {
 711                         tracing::debug!("config update response: '{:?}", resp);
 712                         let lsp_server::Response { error, result, .. } = resp;
 713
 714                         match (error, result) {
 715                             (Some(err), _) => {
 716                                 tracing::error!("failed to fetch the server settings: {:?}", err)
 717                             }
 718                             (None, Some(mut configs)) => {
 719                                 if let Some(json) = configs.get_mut(0) {
 720                                     // Note that json can be null according to the spec if the client can't
 721                                     // provide a configuration. This is handled in Config::update below.
 722                                     let mut config = Config::clone(&*this.config);
 723                                     config.update(json.take());
 724                                     this.update_configuration(config);
 725                                 }
 726                             }
 727                             (None, None) => tracing::error!(
 728                                 "received empty server settings response from the client"
 729                             ),
 730                         }
 731                     },
 732                 );
 733
 734                 Ok(())
 735             })?
 736             .on::<lsp_types::notification::DidChangeWatchedFiles>(|this, params| {
 737                 for change in params.changes {
 738                     if let Ok(path) = from_proto::abs_path(&change.uri) {
 739                         this.loader.handle.invalidate(path);
 740                     }
 741                 }
 742                 Ok(())
 743             })?
 744             .finish();
 745         Ok(())
 746     }
 747
 748     fn update_diagnostics(&mut self) {
 749         let subscriptions = self
 750             .mem_docs
 751             .iter()
 752             .map(|path| self.vfs.read().0.file_id(path).unwrap())
 753             .collect::<Vec<_>>();
 754
 755         tracing::trace!("updating notifications for {:?}", subscriptions);
 756
 757         let snapshot = self.snapshot();
 758         self.task_pool.handle.spawn(move || {
 759             let diagnostics = subscriptions
 760                 .into_iter()
 761                 .filter_map(|file_id| {
 762                     handlers::publish_diagnostics(&snapshot, file_id)
 763                         .map_err(|err| {
 764                             if !is_cancelled(&*err) {
 765                                 tracing::error!("failed to compute diagnostics: {:?}", err);
 766                             }
 767                             ()
 768                         })
 769                         .ok()
 770                         .map(|diags| (file_id, diags))
 771                 })
 772                 .collect::<Vec<_>>();
 773             Task::Diagnostics(diagnostics)
 774         })
 775     }
 776 }