//! The main loop of `rust-analyzer` responsible for dispatching LSP //! requests/replies and notifications back to the client. mod handlers; mod subscriptions; pub(crate) mod pending_requests; use std::{ borrow::Cow, env, error::Error, fmt, ops::Range, panic, sync::Arc, time::{Duration, Instant}, }; use crossbeam_channel::{never, select, unbounded, RecvError, Sender}; use lsp_server::{Connection, ErrorCode, Message, Notification, Request, RequestId, Response}; use lsp_types::{ DidChangeTextDocumentParams, NumberOrString, TextDocumentContentChangeEvent, WorkDoneProgress, WorkDoneProgressBegin, WorkDoneProgressCreateParams, WorkDoneProgressEnd, WorkDoneProgressReport, }; use ra_flycheck::{CheckTask, Status}; use ra_ide::{Canceled, FileId, LibraryData, LineIndex, SourceRootId}; use ra_prof::profile; use ra_project_model::{PackageRoot, ProjectWorkspace}; use ra_vfs::{VfsFile, VfsTask, Watch}; use relative_path::RelativePathBuf; use rustc_hash::FxHashSet; use serde::{de::DeserializeOwned, Serialize}; use threadpool::ThreadPool; use crate::{ config::{Config, FilesWatcher, LinkedProject}, diagnostics::{to_proto::url_from_path_with_drive_lowercasing, DiagnosticTask}, from_proto, global_state::{GlobalState, GlobalStateSnapshot}, lsp_ext, main_loop::{ pending_requests::{PendingRequest, PendingRequests}, subscriptions::Subscriptions, }, Result, }; #[derive(Debug)] pub struct LspError { pub code: i32, pub message: String, } impl LspError { pub const UNKNOWN_FILE: i32 = -32900; pub fn new(code: i32, message: String) -> LspError { LspError { code, message } } } impl fmt::Display for LspError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "Language Server request failed with {}. ({})", self.code, self.message) } } impl Error for LspError {} pub fn main_loop(config: Config, connection: Connection) -> Result<()> { log::info!("initial config: {:#?}", config); // Windows scheduler implements priority boosts: if thread waits for an // event (like a condvar), and event fires, priority of the thread is // temporary bumped. This optimization backfires in our case: each time the // `main_loop` schedules a task to run on a threadpool, the worker threads // gets a higher priority, and (on a machine with fewer cores) displaces the // main loop! We work-around this by marking the main loop as a // higher-priority thread. // // https://docs.microsoft.com/en-us/windows/win32/procthread/scheduling-priorities // https://docs.microsoft.com/en-us/windows/win32/procthread/priority-boosts // https://github.com/rust-analyzer/rust-analyzer/issues/2835 #[cfg(windows)] unsafe { use winapi::um::processthreadsapi::*; let thread = GetCurrentThread(); let thread_priority_above_normal = 1; SetThreadPriority(thread, thread_priority_above_normal); } let mut loop_state = LoopState::default(); let mut global_state = { let workspaces = { if config.linked_projects.is_empty() && config.notifications.cargo_toml_not_found { show_message( lsp_types::MessageType::Error, "rust-analyzer failed to discover workspace".to_string(), &connection.sender, ); }; config .linked_projects .iter() .filter_map(|project| match project { LinkedProject::ProjectManifest(manifest) => { ra_project_model::ProjectWorkspace::load( manifest.clone(), &config.cargo, config.with_sysroot, ) .map_err(|err| { log::error!("failed to load workspace: {:#}", err); show_message( lsp_types::MessageType::Error, format!("rust-analyzer failed to load workspace: {:#}", err), &connection.sender, ); }) .ok() } LinkedProject::JsonProject(it) => Some(it.clone().into()), }) .collect::>() }; let globs = config .files .exclude .iter() .map(|glob| crate::vfs_glob::Glob::new(glob)) .collect::, _>>()?; if let FilesWatcher::Client = config.files.watcher { let registration_options = lsp_types::DidChangeWatchedFilesRegistrationOptions { watchers: workspaces .iter() .flat_map(ProjectWorkspace::to_roots) .filter(PackageRoot::is_member) .map(|root| format!("{}/**/*.rs", root.path().display())) .map(|glob_pattern| lsp_types::FileSystemWatcher { glob_pattern, kind: None }) .collect(), }; let registration = lsp_types::Registration { id: "file-watcher".to_string(), method: "workspace/didChangeWatchedFiles".to_string(), register_options: Some(serde_json::to_value(registration_options).unwrap()), }; let params = lsp_types::RegistrationParams { registrations: vec![registration] }; let request = request_new::( loop_state.next_request_id(), params, ); connection.sender.send(request.into()).unwrap(); } GlobalState::new( workspaces, config.lru_capacity, &globs, Watch(matches!(config.files.watcher, FilesWatcher::Notify)), config, ) }; loop_state.roots_total = global_state.vfs.read().n_roots(); let pool = ThreadPool::default(); let (task_sender, task_receiver) = unbounded::(); let (libdata_sender, libdata_receiver) = unbounded::(); log::info!("server initialized, serving requests"); { let task_sender = task_sender; let libdata_sender = libdata_sender; loop { log::trace!("selecting"); let event = select! { recv(&connection.receiver) -> msg => match msg { Ok(msg) => Event::Msg(msg), Err(RecvError) => return Err("client exited without shutdown".into()), }, recv(task_receiver) -> task => Event::Task(task.unwrap()), recv(global_state.task_receiver) -> task => match task { Ok(task) => Event::Vfs(task), Err(RecvError) => return Err("vfs died".into()), }, recv(libdata_receiver) -> data => Event::Lib(data.unwrap()), recv(global_state.flycheck.as_ref().map_or(&never(), |it| &it.task_recv)) -> task => match task { Ok(task) => Event::CheckWatcher(task), Err(RecvError) => return Err("check watcher died".into()), } }; if let Event::Msg(Message::Request(req)) = &event { if connection.handle_shutdown(&req)? { break; }; } loop_turn( &pool, &task_sender, &libdata_sender, &connection, &mut global_state, &mut loop_state, event, )?; } } global_state.analysis_host.request_cancellation(); log::info!("waiting for tasks to finish..."); task_receiver.into_iter().for_each(|task| { on_task(task, &connection.sender, &mut loop_state.pending_requests, &mut global_state) }); libdata_receiver.into_iter().for_each(drop); log::info!("...tasks have finished"); log::info!("joining threadpool..."); pool.join(); drop(pool); log::info!("...threadpool has finished"); let vfs = Arc::try_unwrap(global_state.vfs).expect("all snapshots should be dead"); drop(vfs); Ok(()) } #[derive(Debug)] enum Task { Respond(Response), Notify(Notification), Diagnostic(DiagnosticTask), } enum Event { Msg(Message), Task(Task), Vfs(VfsTask), Lib(LibraryData), CheckWatcher(CheckTask), } impl fmt::Debug for Event { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let debug_verbose_not = |not: &Notification, f: &mut fmt::Formatter| { f.debug_struct("Notification").field("method", ¬.method).finish() }; match self { Event::Msg(Message::Notification(not)) => { if notification_is::(not) || notification_is::(not) { return debug_verbose_not(not, f); } } Event::Task(Task::Notify(not)) => { if notification_is::(not) { return debug_verbose_not(not, f); } } Event::Task(Task::Respond(resp)) => { return f .debug_struct("Response") .field("id", &resp.id) .field("error", &resp.error) .finish(); } _ => (), } match self { Event::Msg(it) => fmt::Debug::fmt(it, f), Event::Task(it) => fmt::Debug::fmt(it, f), Event::Vfs(it) => fmt::Debug::fmt(it, f), Event::Lib(it) => fmt::Debug::fmt(it, f), Event::CheckWatcher(it) => fmt::Debug::fmt(it, f), } } } #[derive(Debug, Default)] struct LoopState { next_request_id: u64, pending_responses: FxHashSet, pending_requests: PendingRequests, subscriptions: Subscriptions, // We try not to index more than MAX_IN_FLIGHT_LIBS libraries at the same // time to always have a thread ready to react to input. in_flight_libraries: usize, pending_libraries: Vec<(SourceRootId, Vec<(FileId, RelativePathBuf, Arc)>)>, workspace_loaded: bool, roots_progress_reported: Option, roots_scanned: usize, roots_total: usize, configuration_request_id: Option, } impl LoopState { fn next_request_id(&mut self) -> RequestId { self.next_request_id += 1; let res: RequestId = self.next_request_id.into(); let inserted = self.pending_responses.insert(res.clone()); assert!(inserted); res } } fn loop_turn( pool: &ThreadPool, task_sender: &Sender, libdata_sender: &Sender, connection: &Connection, global_state: &mut GlobalState, loop_state: &mut LoopState, event: Event, ) -> Result<()> { let loop_start = Instant::now(); // NOTE: don't count blocking select! call as a loop-turn time let _p = profile("main_loop_inner/loop-turn"); log::info!("loop turn = {:?}", event); let queue_count = pool.queued_count(); if queue_count > 0 { log::info!("queued count = {}", queue_count); } match event { Event::Task(task) => { on_task(task, &connection.sender, &mut loop_state.pending_requests, global_state); global_state.maybe_collect_garbage(); } Event::Vfs(task) => { global_state.vfs.write().handle_task(task); } Event::Lib(lib) => { global_state.add_lib(lib); global_state.maybe_collect_garbage(); loop_state.in_flight_libraries -= 1; loop_state.roots_scanned += 1; } Event::CheckWatcher(task) => on_check_task(task, global_state, task_sender)?, Event::Msg(msg) => match msg { Message::Request(req) => on_request( global_state, &mut loop_state.pending_requests, pool, task_sender, &connection.sender, loop_start, req, )?, Message::Notification(not) => { on_notification(&connection.sender, global_state, loop_state, not)?; } Message::Response(resp) => { let removed = loop_state.pending_responses.remove(&resp.id); if !removed { log::error!("unexpected response: {:?}", resp) } if Some(&resp.id) == loop_state.configuration_request_id.as_ref() { loop_state.configuration_request_id = None; log::debug!("config update response: '{:?}", resp); let Response { error, result, .. } = resp; match (error, result) { (Some(err), _) => { log::error!("failed to fetch the server settings: {:?}", err) } (None, Some(configs)) => { if let Some(new_config) = configs.get(0) { let mut config = global_state.config.clone(); config.update(&new_config); global_state.update_configuration(config); } } (None, None) => { log::error!("received empty server settings response from the client") } } } } }, }; let mut state_changed = false; if let Some(changes) = global_state.process_changes(&mut loop_state.roots_scanned) { state_changed = true; loop_state.pending_libraries.extend(changes); } let max_in_flight_libs = pool.max_count().saturating_sub(2).max(1); while loop_state.in_flight_libraries < max_in_flight_libs { let (root, files) = match loop_state.pending_libraries.pop() { Some(it) => it, None => break, }; loop_state.in_flight_libraries += 1; let sender = libdata_sender.clone(); pool.execute(move || { log::info!("indexing {:?} ... ", root); let data = LibraryData::prepare(root, files); sender.send(data).unwrap(); }); } let show_progress = !loop_state.workspace_loaded && global_state.config.client_caps.work_done_progress; if !loop_state.workspace_loaded && loop_state.roots_scanned == loop_state.roots_total && loop_state.pending_libraries.is_empty() && loop_state.in_flight_libraries == 0 { state_changed = true; loop_state.workspace_loaded = true; if let Some(flycheck) = &global_state.flycheck { flycheck.update(); } } if show_progress { send_startup_progress(&connection.sender, loop_state); } if state_changed && loop_state.workspace_loaded { update_file_notifications_on_threadpool( pool, global_state.snapshot(), task_sender.clone(), loop_state.subscriptions.subscriptions(), ); pool.execute({ let subs = loop_state.subscriptions.subscriptions(); let snap = global_state.snapshot(); move || snap.analysis().prime_caches(subs).unwrap_or_else(|_: Canceled| ()) }); } let loop_duration = loop_start.elapsed(); if loop_duration > Duration::from_millis(100) { log::error!("overly long loop turn: {:?}", loop_duration); if env::var("RA_PROFILE").is_ok() { show_message( lsp_types::MessageType::Error, format!("overly long loop turn: {:?}", loop_duration), &connection.sender, ); } } Ok(()) } fn on_task( task: Task, msg_sender: &Sender, pending_requests: &mut PendingRequests, state: &mut GlobalState, ) { match task { Task::Respond(response) => { if let Some(completed) = pending_requests.finish(&response.id) { log::info!("handled req#{} in {:?}", completed.id, completed.duration); state.complete_request(completed); msg_sender.send(response.into()).unwrap(); } } Task::Notify(n) => { msg_sender.send(n.into()).unwrap(); } Task::Diagnostic(task) => on_diagnostic_task(task, msg_sender, state), } } fn on_request( global_state: &mut GlobalState, pending_requests: &mut PendingRequests, pool: &ThreadPool, task_sender: &Sender, msg_sender: &Sender, request_received: Instant, req: Request, ) -> Result<()> { let mut pool_dispatcher = PoolDispatcher { req: Some(req), pool, global_state, task_sender, msg_sender, pending_requests, request_received, }; pool_dispatcher .on_sync::(|s, ()| Ok(s.collect_garbage()))? .on_sync::(|s, p| handlers::handle_join_lines(s.snapshot(), p))? .on_sync::(|s, p| handlers::handle_on_enter(s.snapshot(), p))? .on_sync::(|s, p| { handlers::handle_selection_range(s.snapshot(), p) })? .on_sync::(|s, p| handlers::handle_matching_brace(s.snapshot(), p))? .on::(handlers::handle_analyzer_status)? .on::(handlers::handle_syntax_tree)? .on::(handlers::handle_expand_macro)? .on::(handlers::handle_parent_module)? .on::(handlers::handle_runnables)? .on::(handlers::handle_inlay_hints)? .on::(handlers::handle_code_action)? .on::(handlers::handle_on_type_formatting)? .on::(handlers::handle_document_symbol)? .on::(handlers::handle_workspace_symbol)? .on::(handlers::handle_goto_definition)? .on::(handlers::handle_goto_implementation)? .on::(handlers::handle_goto_type_definition)? .on::(handlers::handle_completion)? .on::(handlers::handle_code_lens)? .on::(handlers::handle_code_lens_resolve)? .on::(handlers::handle_folding_range)? .on::(handlers::handle_signature_help)? .on::(handlers::handle_hover)? .on::(handlers::handle_prepare_rename)? .on::(handlers::handle_rename)? .on::(handlers::handle_references)? .on::(handlers::handle_formatting)? .on::(handlers::handle_document_highlight)? .on::(handlers::handle_call_hierarchy_prepare)? .on::( handlers::handle_call_hierarchy_incoming, )? .on::( handlers::handle_call_hierarchy_outgoing, )? .on::(handlers::handle_semantic_tokens)? .on::( handlers::handle_semantic_tokens_range, )? .on::(handlers::handle_ssr)? .finish(); Ok(()) } fn on_notification( msg_sender: &Sender, state: &mut GlobalState, loop_state: &mut LoopState, not: Notification, ) -> Result<()> { let not = match notification_cast::(not) { Ok(params) => { let id: RequestId = match params.id { NumberOrString::Number(id) => id.into(), NumberOrString::String(id) => id.into(), }; if loop_state.pending_requests.cancel(&id) { let response = Response::new_err( id, ErrorCode::RequestCanceled as i32, "canceled by client".to_string(), ); msg_sender.send(response.into()).unwrap() } return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let uri = params.text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; if let Some(file_id) = state.vfs.write().add_file_overlay(&path, params.text_document.text) { loop_state.subscriptions.add_sub(FileId(file_id.0)); } return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let DidChangeTextDocumentParams { text_document, content_changes } = params; let world = state.snapshot(); let file_id = from_proto::file_id(&world, &text_document.uri)?; let line_index = world.analysis().file_line_index(file_id)?; let uri = text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; state.vfs.write().change_file_overlay(&path, |old_text| { apply_document_changes(old_text, Cow::Borrowed(&line_index), content_changes); }); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(_params) => { if let Some(flycheck) = &state.flycheck { flycheck.update(); } return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let uri = params.text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; if let Some(file_id) = state.vfs.write().remove_file_overlay(path.as_path()) { loop_state.subscriptions.remove_sub(FileId(file_id.0)); } let params = lsp_types::PublishDiagnosticsParams { uri, diagnostics: Vec::new(), version: None }; let not = notification_new::(params); msg_sender.send(not.into()).unwrap(); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(_) => { // As stated in https://github.com/microsoft/language-server-protocol/issues/676, // this notification's parameters should be ignored and the actual config queried separately. let request_id = loop_state.next_request_id(); let request = request_new::( request_id.clone(), lsp_types::ConfigurationParams { items: vec![lsp_types::ConfigurationItem { scope_uri: None, section: Some("rust-analyzer".to_string()), }], }, ); msg_sender.send(request.into())?; loop_state.configuration_request_id = Some(request_id); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let mut vfs = state.vfs.write(); for change in params.changes { let uri = change.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; vfs.notify_changed(path) } return Ok(()); } Err(not) => not, }; if not.method.starts_with("$/") { return Ok(()); } log::error!("unhandled notification: {:?}", not); Ok(()) } fn apply_document_changes( old_text: &mut String, mut line_index: Cow<'_, LineIndex>, content_changes: Vec, ) { // Remove when https://github.com/rust-analyzer/rust-analyzer/issues/4263 is fixed. let backup_text = old_text.clone(); let backup_changes = content_changes.clone(); // The changes we got must be applied sequentially, but can cross lines so we // have to keep our line index updated. // Some clients (e.g. Code) sort the ranges in reverse. As an optimization, we // remember the last valid line in the index and only rebuild it if needed. enum IndexValid { All, UpToLineExclusive(u64), } impl IndexValid { fn covers(&self, line: u64) -> bool { match *self { IndexValid::UpToLineExclusive(to) => to > line, _ => true, } } } let mut index_valid = IndexValid::All; for change in content_changes { match change.range { Some(range) => { if !index_valid.covers(range.end.line) { line_index = Cow::Owned(LineIndex::new(&old_text)); } index_valid = IndexValid::UpToLineExclusive(range.start.line); let range = from_proto::text_range(&line_index, range); let mut text = old_text.to_owned(); match std::panic::catch_unwind(move || { text.replace_range(Range::::from(range), &change.text); text }) { Ok(t) => *old_text = t, Err(e) => { eprintln!("Bug in incremental text synchronization. Please report the following output on https://github.com/rust-analyzer/rust-analyzer/issues/4263"); dbg!(&backup_text); dbg!(&backup_changes); std::panic::resume_unwind(e); } } } None => { *old_text = change.text; index_valid = IndexValid::UpToLineExclusive(0); } } } } fn on_check_task( task: CheckTask, global_state: &mut GlobalState, task_sender: &Sender, ) -> Result<()> { match task { CheckTask::ClearDiagnostics => { task_sender.send(Task::Diagnostic(DiagnosticTask::ClearCheck))?; } CheckTask::AddDiagnostic { workspace_root, diagnostic } => { let diagnostics = crate::diagnostics::to_proto::map_rust_diagnostic_to_lsp( &diagnostic, &workspace_root, ); for diag in diagnostics { let path = diag .location .uri .to_file_path() .map_err(|()| format!("invalid uri: {}", diag.location.uri))?; let file_id = match global_state.vfs.read().path2file(&path) { Some(file) => FileId(file.0), None => { log::error!( "File with cargo diagnostic not found in VFS: {}", path.display() ); return Ok(()); } }; task_sender.send(Task::Diagnostic(DiagnosticTask::AddCheck( file_id, diag.diagnostic, diag.fixes.into_iter().map(|it| it.into()).collect(), )))?; } } CheckTask::Status(status) => { if global_state.config.client_caps.work_done_progress { let progress = match status { Status::Being => { lsp_types::WorkDoneProgress::Begin(lsp_types::WorkDoneProgressBegin { title: "Running `cargo check`".to_string(), cancellable: Some(false), message: None, percentage: None, }) } Status::Progress(target) => { lsp_types::WorkDoneProgress::Report(lsp_types::WorkDoneProgressReport { cancellable: Some(false), message: Some(target), percentage: None, }) } Status::End => { lsp_types::WorkDoneProgress::End(lsp_types::WorkDoneProgressEnd { message: None, }) } }; let params = lsp_types::ProgressParams { token: lsp_types::ProgressToken::String( "rustAnalyzer/cargoWatcher".to_string(), ), value: lsp_types::ProgressParamsValue::WorkDone(progress), }; let not = notification_new::(params); task_sender.send(Task::Notify(not)).unwrap(); } } }; Ok(()) } fn on_diagnostic_task(task: DiagnosticTask, msg_sender: &Sender, state: &mut GlobalState) { let subscriptions = state.diagnostics.handle_task(task); for file_id in subscriptions { let path = state.vfs.read().file2path(VfsFile(file_id.0)); let uri = match url_from_path_with_drive_lowercasing(&path) { Ok(uri) => uri, Err(err) => { log::error!("Couldn't convert path to url ({}): {}", err, path.display()); continue; } }; let diagnostics = state.diagnostics.diagnostics_for(file_id).cloned().collect(); let params = lsp_types::PublishDiagnosticsParams { uri, diagnostics, version: None }; let not = notification_new::(params); msg_sender.send(not.into()).unwrap(); } } fn send_startup_progress(sender: &Sender, loop_state: &mut LoopState) { let total: usize = loop_state.roots_total; let prev = loop_state.roots_progress_reported; let progress = loop_state.roots_scanned; loop_state.roots_progress_reported = Some(progress); match (prev, loop_state.workspace_loaded) { (None, false) => { let work_done_progress_create = request_new::( loop_state.next_request_id(), WorkDoneProgressCreateParams { token: lsp_types::ProgressToken::String("rustAnalyzer/startup".into()), }, ); sender.send(work_done_progress_create.into()).unwrap(); send_startup_progress_notif( sender, WorkDoneProgress::Begin(WorkDoneProgressBegin { title: "rust-analyzer".into(), cancellable: None, message: Some(format!("{}/{} packages", progress, total)), percentage: Some(100.0 * progress as f64 / total as f64), }), ); } (Some(prev), false) if progress != prev => send_startup_progress_notif( sender, WorkDoneProgress::Report(WorkDoneProgressReport { cancellable: None, message: Some(format!("{}/{} packages", progress, total)), percentage: Some(100.0 * progress as f64 / total as f64), }), ), (_, true) => send_startup_progress_notif( sender, WorkDoneProgress::End(WorkDoneProgressEnd { message: Some(format!("rust-analyzer loaded, {} packages", progress)), }), ), _ => {} } fn send_startup_progress_notif(sender: &Sender, work_done_progress: WorkDoneProgress) { let notif = notification_new::(lsp_types::ProgressParams { token: lsp_types::ProgressToken::String("rustAnalyzer/startup".into()), value: lsp_types::ProgressParamsValue::WorkDone(work_done_progress), }); sender.send(notif.into()).unwrap(); } } struct PoolDispatcher<'a> { req: Option, pool: &'a ThreadPool, global_state: &'a mut GlobalState, pending_requests: &'a mut PendingRequests, msg_sender: &'a Sender, task_sender: &'a Sender, request_received: Instant, } impl<'a> PoolDispatcher<'a> { /// Dispatches the request onto the current thread fn on_sync( &mut self, f: fn(&mut GlobalState, R::Params) -> Result, ) -> Result<&mut Self> where R: lsp_types::request::Request + 'static, R::Params: DeserializeOwned + panic::UnwindSafe + 'static, R::Result: Serialize + 'static, { let (id, params) = match self.parse::() { Some(it) => it, None => { return Ok(self); } }; let world = panic::AssertUnwindSafe(&mut *self.global_state); let task = panic::catch_unwind(move || { let result = f(world.0, params); result_to_task::(id, result) }) .map_err(|_| format!("sync task {:?} panicked", R::METHOD))?; on_task(task, self.msg_sender, self.pending_requests, self.global_state); Ok(self) } /// Dispatches the request onto thread pool fn on( &mut self, f: fn(GlobalStateSnapshot, R::Params) -> Result, ) -> Result<&mut Self> where R: lsp_types::request::Request + 'static, R::Params: DeserializeOwned + Send + 'static, R::Result: Serialize + 'static, { let (id, params) = match self.parse::() { Some(it) => it, None => { return Ok(self); } }; self.pool.execute({ let world = self.global_state.snapshot(); let sender = self.task_sender.clone(); move || { let result = f(world, params); let task = result_to_task::(id, result); sender.send(task).unwrap(); } }); Ok(self) } fn parse(&mut self) -> Option<(RequestId, R::Params)> where R: lsp_types::request::Request + 'static, R::Params: DeserializeOwned + 'static, { let req = self.req.take()?; let (id, params) = match req.extract::(R::METHOD) { Ok(it) => it, Err(req) => { self.req = Some(req); return None; } }; self.pending_requests.start(PendingRequest { id: id.clone(), method: R::METHOD.to_string(), received: self.request_received, }); Some((id, params)) } fn finish(&mut self) { match self.req.take() { None => (), Some(req) => { log::error!("unknown request: {:?}", req); let resp = Response::new_err( req.id, ErrorCode::MethodNotFound as i32, "unknown request".to_string(), ); self.msg_sender.send(resp.into()).unwrap(); } } } } fn result_to_task(id: RequestId, result: Result) -> Task where R: lsp_types::request::Request + 'static, R::Params: DeserializeOwned + 'static, R::Result: Serialize + 'static, { let response = match result { Ok(resp) => Response::new_ok(id, &resp), Err(e) => match e.downcast::() { Ok(lsp_error) => { if lsp_error.code == LspError::UNKNOWN_FILE { // Work-around for https://github.com/rust-analyzer/rust-analyzer/issues/1521 Response::new_ok(id, ()) } else { Response::new_err(id, lsp_error.code, lsp_error.message) } } Err(e) => { if is_canceled(&e) { Response::new_err( id, ErrorCode::ContentModified as i32, "content modified".to_string(), ) } else { Response::new_err(id, ErrorCode::InternalError as i32, e.to_string()) } } }, }; Task::Respond(response) } fn update_file_notifications_on_threadpool( pool: &ThreadPool, world: GlobalStateSnapshot, task_sender: Sender, subscriptions: Vec, ) { log::trace!("updating notifications for {:?}", subscriptions); if world.config.publish_diagnostics { pool.execute(move || { for file_id in subscriptions { match handlers::publish_diagnostics(&world, file_id) { Err(e) => { if !is_canceled(&e) { log::error!("failed to compute diagnostics: {:?}", e); } } Ok(task) => { task_sender.send(Task::Diagnostic(task)).unwrap(); } } } }) } } pub fn show_message( typ: lsp_types::MessageType, message: impl Into, sender: &Sender, ) { let message = message.into(); let params = lsp_types::ShowMessageParams { typ, message }; let not = notification_new::(params); sender.send(not.into()).unwrap(); } fn is_canceled(e: &Box) -> bool { e.downcast_ref::().is_some() } fn notification_is(notification: &Notification) -> bool { notification.method == N::METHOD } fn notification_cast(notification: Notification) -> std::result::Result where N: lsp_types::notification::Notification, N::Params: DeserializeOwned, { notification.extract(N::METHOD) } fn notification_new(params: N::Params) -> Notification where N: lsp_types::notification::Notification, N::Params: Serialize, { Notification::new(N::METHOD.to_string(), params) } fn request_new(id: RequestId, params: R::Params) -> Request where R: lsp_types::request::Request, R::Params: Serialize, { Request::new(id, R::METHOD.to_string(), params) } #[cfg(test)] mod tests { use std::borrow::Cow; use lsp_types::{Position, Range, TextDocumentContentChangeEvent}; use ra_ide::LineIndex; #[test] fn apply_document_changes() { fn run(text: &mut String, changes: Vec) { let line_index = Cow::Owned(LineIndex::new(&text)); super::apply_document_changes(text, line_index, changes); } macro_rules! c { [$($sl:expr, $sc:expr; $el:expr, $ec:expr => $text:expr),+] => { vec![$(TextDocumentContentChangeEvent { range: Some(Range { start: Position { line: $sl, character: $sc }, end: Position { line: $el, character: $ec }, }), range_length: None, text: String::from($text), }),+] }; } let mut text = String::new(); run(&mut text, vec![]); assert_eq!(text, ""); run( &mut text, vec![TextDocumentContentChangeEvent { range: None, range_length: None, text: String::from("the"), }], ); assert_eq!(text, "the"); run(&mut text, c![0, 3; 0, 3 => " quick"]); assert_eq!(text, "the quick"); run(&mut text, c![0, 0; 0, 4 => "", 0, 5; 0, 5 => " foxes"]); assert_eq!(text, "quick foxes"); run(&mut text, c![0, 11; 0, 11 => "\ndream"]); assert_eq!(text, "quick foxes\ndream"); run(&mut text, c![1, 0; 1, 0 => "have "]); assert_eq!(text, "quick foxes\nhave dream"); run(&mut text, c![0, 0; 0, 0 => "the ", 1, 4; 1, 4 => " quiet", 1, 16; 1, 16 => "s\n"]); assert_eq!(text, "the quick foxes\nhave quiet dreams\n"); run(&mut text, c![0, 15; 0, 15 => "\n", 2, 17; 2, 17 => "\n"]); assert_eq!(text, "the quick foxes\n\nhave quiet dreams\n\n"); run( &mut text, c![1, 0; 1, 0 => "DREAM", 2, 0; 2, 0 => "they ", 3, 0; 3, 0 => "DON'T THEY?"], ); assert_eq!(text, "the quick foxes\nDREAM\nthey have quiet dreams\nDON'T THEY?\n"); run(&mut text, c![0, 10; 1, 5 => "", 2, 0; 2, 12 => ""]); assert_eq!(text, "the quick \nthey have quiet dreams\n"); text = String::from("❤️"); run(&mut text, c![0, 0; 0, 0 => "a"]); assert_eq!(text, "a❤️"); text = String::from("a\nb"); run(&mut text, c![0, 1; 1, 0 => "\nțc", 0, 1; 1, 1 => "d"]); assert_eq!(text, "adcb"); text = String::from("a\nb"); run(&mut text, c![0, 1; 1, 0 => "ț\nc", 0, 2; 0, 2 => "c"]); assert_eq!(text, "ațc\ncb"); } }