use log::warn; pub use lsp_types::request::*; pub use lsp_types::*; use anyhow::{anyhow, Context, Result}; use collections::HashMap; use futures::{channel::oneshot, io::BufWriter, AsyncRead, AsyncWrite, FutureExt}; use gpui::{executor, AsyncAppContext, Task}; use parking_lot::Mutex; use postage::{barrier, prelude::Stream}; use serde::{de::DeserializeOwned, Deserialize, Serialize}; use serde_json::{json, value::RawValue, Value}; use smol::{ channel, io::{AsyncBufReadExt, AsyncReadExt, AsyncWriteExt, BufReader}, process::{self, Child}, }; use std::{ ffi::OsString, fmt, future::Future, io::Write, path::PathBuf, str::{self, FromStr as _}, sync::{ atomic::{AtomicUsize, Ordering::SeqCst}, Arc, Weak, }, time::{Duration, Instant}, }; use std::{path::Path, process::Stdio}; use util::{ResultExt, TryFutureExt}; const JSON_RPC_VERSION: &str = "2.0"; const CONTENT_LEN_HEADER: &str = "Content-Length: "; const LSP_REQUEST_TIMEOUT: Duration = Duration::from_secs(60 * 2); type NotificationHandler = Box, &str, AsyncAppContext)>; type ResponseHandler = Box)>; type IoHandler = Box; #[derive(Debug, Clone, Copy)] pub enum IoKind { StdOut, StdIn, StdErr, } #[derive(Debug, Clone, Deserialize)] pub struct LanguageServerBinary { pub path: PathBuf, pub arguments: Vec, } pub struct LanguageServer { server_id: LanguageServerId, next_id: AtomicUsize, outbound_tx: channel::Sender, name: String, capabilities: ServerCapabilities, code_action_kinds: Option>, notification_handlers: Arc>>, response_handlers: Arc>>>, io_handlers: Arc>>, executor: Arc, #[allow(clippy::type_complexity)] io_tasks: Mutex>, Task>)>>, output_done_rx: Mutex>, root_path: PathBuf, _server: Option>, } #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] #[repr(transparent)] pub struct LanguageServerId(pub usize); pub enum Subscription { Notification { method: &'static str, notification_handlers: Option>>>, }, Io { id: usize, io_handlers: Option>>>, }, } #[derive(Serialize, Deserialize)] pub struct Request<'a, T> { jsonrpc: &'static str, id: usize, method: &'a str, params: T, } #[derive(Serialize, Deserialize)] struct AnyResponse<'a> { jsonrpc: &'a str, id: usize, #[serde(default)] error: Option, #[serde(borrow)] result: Option<&'a RawValue>, } #[derive(Serialize)] struct Response { jsonrpc: &'static str, id: usize, result: Option, error: Option, } #[derive(Serialize, Deserialize)] struct Notification<'a, T> { jsonrpc: &'static str, #[serde(borrow)] method: &'a str, params: T, } #[derive(Debug, Clone, Deserialize)] struct AnyNotification<'a> { #[serde(default)] id: Option, #[serde(borrow)] method: &'a str, #[serde(borrow, default)] params: Option<&'a RawValue>, } #[derive(Debug, Serialize, Deserialize)] struct Error { message: String, } impl LanguageServer { pub fn new( server_id: LanguageServerId, binary: LanguageServerBinary, root_path: &Path, code_action_kinds: Option>, cx: AsyncAppContext, ) -> Result { let working_dir = if root_path.is_dir() { root_path } else { root_path.parent().unwrap_or_else(|| Path::new("/")) }; let mut server = process::Command::new(&binary.path) .current_dir(working_dir) .args(binary.arguments) .stdin(Stdio::piped()) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .kill_on_drop(true) .spawn()?; let stdin = server.stdin.take().unwrap(); let stdout = server.stdout.take().unwrap(); let stderr = server.stderr.take().unwrap(); let mut server = Self::new_internal( server_id.clone(), stdin, stdout, Some(stderr), Some(server), root_path, code_action_kinds, cx, move |notification| { log::info!( "{} unhandled notification {}:\n{}", server_id, notification.method, serde_json::to_string_pretty( ¬ification .params .and_then(|params| Value::from_str(params.get()).ok()) .unwrap_or(Value::Null) ) .unwrap(), ); }, ); if let Some(name) = binary.path.file_name() { server.name = name.to_string_lossy().to_string(); } Ok(server) } fn new_internal( server_id: LanguageServerId, stdin: Stdin, stdout: Stdout, stderr: Option, server: Option, root_path: &Path, code_action_kinds: Option>, cx: AsyncAppContext, on_unhandled_notification: F, ) -> Self where Stdin: AsyncWrite + Unpin + Send + 'static, Stdout: AsyncRead + Unpin + Send + 'static, Stderr: AsyncRead + Unpin + Send + 'static, F: FnMut(AnyNotification) + 'static + Send + Clone, { let (outbound_tx, outbound_rx) = channel::unbounded::(); let (output_done_tx, output_done_rx) = barrier::channel(); let notification_handlers = Arc::new(Mutex::new(HashMap::<_, NotificationHandler>::default())); let response_handlers = Arc::new(Mutex::new(Some(HashMap::<_, ResponseHandler>::default()))); let io_handlers = Arc::new(Mutex::new(HashMap::default())); let stdout_input_task = cx.spawn(|cx| { { Self::handle_input( stdout, on_unhandled_notification.clone(), notification_handlers.clone(), response_handlers.clone(), io_handlers.clone(), cx, ) } .log_err() }); let stderr_input_task = stderr .map(|stderr| cx.spawn(|_| Self::handle_stderr(stderr, io_handlers.clone()).log_err())) .unwrap_or_else(|| Task::Ready(Some(None))); let input_task = cx.spawn(|_| async move { let (stdout, stderr) = futures::join!(stdout_input_task, stderr_input_task); stdout.or(stderr) }); let output_task = cx.background().spawn({ Self::handle_output( stdin, outbound_rx, output_done_tx, response_handlers.clone(), io_handlers.clone(), ) .log_err() }); Self { server_id, notification_handlers, response_handlers, io_handlers, name: Default::default(), capabilities: Default::default(), code_action_kinds, next_id: Default::default(), outbound_tx, executor: cx.background(), io_tasks: Mutex::new(Some((input_task, output_task))), output_done_rx: Mutex::new(Some(output_done_rx)), root_path: root_path.to_path_buf(), _server: server.map(|server| Mutex::new(server)), } } pub fn code_action_kinds(&self) -> Option> { self.code_action_kinds.clone() } async fn handle_input( stdout: Stdout, mut on_unhandled_notification: F, notification_handlers: Arc>>, response_handlers: Arc>>>, io_handlers: Arc>>, cx: AsyncAppContext, ) -> anyhow::Result<()> where Stdout: AsyncRead + Unpin + Send + 'static, F: FnMut(AnyNotification) + 'static + Send, { let mut stdout = BufReader::new(stdout); let _clear_response_handlers = util::defer({ let response_handlers = response_handlers.clone(); move || { response_handlers.lock().take(); } }); let mut buffer = Vec::new(); loop { buffer.clear(); stdout.read_until(b'\n', &mut buffer).await?; stdout.read_until(b'\n', &mut buffer).await?; let header = std::str::from_utf8(&buffer)?; let message_len: usize = header .strip_prefix(CONTENT_LEN_HEADER) .ok_or_else(|| anyhow!("invalid LSP message header {header:?}"))? .trim_end() .parse()?; buffer.resize(message_len, 0); stdout.read_exact(&mut buffer).await?; if let Ok(message) = str::from_utf8(&buffer) { log::trace!("incoming message: {}", message); for handler in io_handlers.lock().values_mut() { handler(IoKind::StdOut, message); } } if let Ok(msg) = serde_json::from_slice::(&buffer) { if let Some(handler) = notification_handlers.lock().get_mut(msg.method) { handler( msg.id, &msg.params.map(|params| params.get()).unwrap_or("null"), cx.clone(), ); } else { on_unhandled_notification(msg); } } else if let Ok(AnyResponse { id, error, result, .. }) = serde_json::from_slice(&buffer) { if let Some(handler) = response_handlers .lock() .as_mut() .and_then(|handlers| handlers.remove(&id)) { if let Some(error) = error { handler(Err(error)); } else if let Some(result) = result { handler(Ok(result.get().into())); } else { handler(Ok("null".into())); } } } else { warn!( "failed to deserialize LSP message:\n{}", std::str::from_utf8(&buffer)? ); } // Don't starve the main thread when receiving lots of messages at once. smol::future::yield_now().await; } } async fn handle_stderr( stderr: Stderr, io_handlers: Arc>>, ) -> anyhow::Result<()> where Stderr: AsyncRead + Unpin + Send + 'static, { let mut stderr = BufReader::new(stderr); let mut buffer = Vec::new(); loop { buffer.clear(); stderr.read_until(b'\n', &mut buffer).await?; if let Ok(message) = str::from_utf8(&buffer) { log::trace!("incoming stderr message:{message}"); for handler in io_handlers.lock().values_mut() { handler(IoKind::StdErr, message); } } // Don't starve the main thread when receiving lots of messages at once. smol::future::yield_now().await; } } async fn handle_output( stdin: Stdin, outbound_rx: channel::Receiver, output_done_tx: barrier::Sender, response_handlers: Arc>>>, io_handlers: Arc>>, ) -> anyhow::Result<()> where Stdin: AsyncWrite + Unpin + Send + 'static, { let mut stdin = BufWriter::new(stdin); let _clear_response_handlers = util::defer({ let response_handlers = response_handlers.clone(); move || { response_handlers.lock().take(); } }); let mut content_len_buffer = Vec::new(); while let Ok(message) = outbound_rx.recv().await { log::trace!("outgoing message:{}", message); for handler in io_handlers.lock().values_mut() { handler(IoKind::StdIn, &message); } content_len_buffer.clear(); write!(content_len_buffer, "{}", message.len()).unwrap(); stdin.write_all(CONTENT_LEN_HEADER.as_bytes()).await?; stdin.write_all(&content_len_buffer).await?; stdin.write_all("\r\n\r\n".as_bytes()).await?; stdin.write_all(message.as_bytes()).await?; stdin.flush().await?; } drop(output_done_tx); Ok(()) } /// Initializes a language server. /// Note that `options` is used directly to construct [`InitializeParams`], /// which is why it is owned. pub async fn initialize(mut self, options: Option) -> Result> { let root_uri = Url::from_file_path(&self.root_path).unwrap(); #[allow(deprecated)] let params = InitializeParams { process_id: Default::default(), root_path: Default::default(), root_uri: Some(root_uri.clone()), initialization_options: options, capabilities: ClientCapabilities { workspace: Some(WorkspaceClientCapabilities { configuration: Some(true), did_change_watched_files: Some(DidChangeWatchedFilesClientCapabilities { dynamic_registration: Some(true), relative_pattern_support: Some(true), }), did_change_configuration: Some(DynamicRegistrationClientCapabilities { dynamic_registration: Some(true), }), workspace_folders: Some(true), symbol: Some(WorkspaceSymbolClientCapabilities { resolve_support: None, ..WorkspaceSymbolClientCapabilities::default() }), inlay_hint: Some(InlayHintWorkspaceClientCapabilities { refresh_support: Some(true), }), ..Default::default() }), text_document: Some(TextDocumentClientCapabilities { definition: Some(GotoCapability { link_support: Some(true), ..Default::default() }), code_action: Some(CodeActionClientCapabilities { code_action_literal_support: Some(CodeActionLiteralSupport { code_action_kind: CodeActionKindLiteralSupport { value_set: vec![ CodeActionKind::REFACTOR.as_str().into(), CodeActionKind::QUICKFIX.as_str().into(), CodeActionKind::SOURCE.as_str().into(), ], }, }), data_support: Some(true), resolve_support: Some(CodeActionCapabilityResolveSupport { properties: vec!["edit".to_string(), "command".to_string()], }), ..Default::default() }), completion: Some(CompletionClientCapabilities { completion_item: Some(CompletionItemCapability { snippet_support: Some(true), resolve_support: Some(CompletionItemCapabilityResolveSupport { properties: vec!["additionalTextEdits".to_string()], }), ..Default::default() }), completion_list: Some(CompletionListCapability { item_defaults: Some(vec![ "commitCharacters".to_owned(), "editRange".to_owned(), "insertTextMode".to_owned(), "data".to_owned(), ]), }), ..Default::default() }), rename: Some(RenameClientCapabilities { prepare_support: Some(true), ..Default::default() }), hover: Some(HoverClientCapabilities { content_format: Some(vec![MarkupKind::Markdown]), ..Default::default() }), inlay_hint: Some(InlayHintClientCapabilities { resolve_support: Some(InlayHintResolveClientCapabilities { properties: vec![ "textEdits".to_string(), "tooltip".to_string(), "label.tooltip".to_string(), "label.location".to_string(), "label.command".to_string(), ], }), dynamic_registration: Some(false), }), ..Default::default() }), experimental: Some(json!({ "serverStatusNotification": true, })), window: Some(WindowClientCapabilities { work_done_progress: Some(true), ..Default::default() }), ..Default::default() }, trace: Default::default(), workspace_folders: Some(vec![WorkspaceFolder { uri: root_uri, name: Default::default(), }]), client_info: Default::default(), locale: Default::default(), }; let response = self.request::(params).await?; if let Some(info) = response.server_info { self.name = info.name; } self.capabilities = response.capabilities; self.notify::(InitializedParams {})?; Ok(Arc::new(self)) } pub fn shutdown(&self) -> Option>> { if let Some(tasks) = self.io_tasks.lock().take() { let response_handlers = self.response_handlers.clone(); let next_id = AtomicUsize::new(self.next_id.load(SeqCst)); let outbound_tx = self.outbound_tx.clone(); let executor = self.executor.clone(); let mut output_done = self.output_done_rx.lock().take().unwrap(); let shutdown_request = Self::request_internal::( &next_id, &response_handlers, &outbound_tx, &executor, (), ); let exit = Self::notify_internal::(&outbound_tx, ()); outbound_tx.close(); Some( async move { log::debug!("language server shutdown started"); shutdown_request.await?; response_handlers.lock().take(); exit?; output_done.recv().await; log::debug!("language server shutdown finished"); drop(tasks); anyhow::Ok(()) } .log_err(), ) } else { None } } #[must_use] pub fn on_notification(&self, f: F) -> Subscription where T: notification::Notification, F: 'static + Send + FnMut(T::Params, AsyncAppContext), { self.on_custom_notification(T::METHOD, f) } #[must_use] pub fn on_request(&self, f: F) -> Subscription where T: request::Request, T::Params: 'static + Send, F: 'static + Send + FnMut(T::Params, AsyncAppContext) -> Fut, Fut: 'static + Future>, { self.on_custom_request(T::METHOD, f) } #[must_use] pub fn on_io(&self, f: F) -> Subscription where F: 'static + Send + FnMut(IoKind, &str), { let id = self.next_id.fetch_add(1, SeqCst); self.io_handlers.lock().insert(id, Box::new(f)); Subscription::Io { id, io_handlers: Some(Arc::downgrade(&self.io_handlers)), } } pub fn remove_request_handler(&self) { self.notification_handlers.lock().remove(T::METHOD); } pub fn remove_notification_handler(&self) { self.notification_handlers.lock().remove(T::METHOD); } pub fn has_notification_handler(&self) -> bool { self.notification_handlers.lock().contains_key(T::METHOD) } #[must_use] pub fn on_custom_notification(&self, method: &'static str, mut f: F) -> Subscription where F: 'static + Send + FnMut(Params, AsyncAppContext), Params: DeserializeOwned, { let prev_handler = self.notification_handlers.lock().insert( method, Box::new(move |_, params, cx| { if let Some(params) = serde_json::from_str(params).log_err() { f(params, cx); } }), ); assert!( prev_handler.is_none(), "registered multiple handlers for the same LSP method" ); Subscription::Notification { method, notification_handlers: Some(self.notification_handlers.clone()), } } #[must_use] pub fn on_custom_request( &self, method: &'static str, mut f: F, ) -> Subscription where F: 'static + Send + FnMut(Params, AsyncAppContext) -> Fut, Fut: 'static + Future>, Params: DeserializeOwned + Send + 'static, Res: Serialize, { let outbound_tx = self.outbound_tx.clone(); let prev_handler = self.notification_handlers.lock().insert( method, Box::new(move |id, params, cx| { if let Some(id) = id { match serde_json::from_str(params) { Ok(params) => { let response = f(params, cx.clone()); cx.foreground() .spawn({ let outbound_tx = outbound_tx.clone(); async move { let response = match response.await { Ok(result) => Response { jsonrpc: JSON_RPC_VERSION, id, result: Some(result), error: None, }, Err(error) => Response { jsonrpc: JSON_RPC_VERSION, id, result: None, error: Some(Error { message: error.to_string(), }), }, }; if let Some(response) = serde_json::to_string(&response).log_err() { outbound_tx.try_send(response).ok(); } } }) .detach(); } Err(error) => { log::error!( "error deserializing {} request: {:?}, message: {:?}", method, error, params ); let response = AnyResponse { jsonrpc: JSON_RPC_VERSION, id, result: None, error: Some(Error { message: error.to_string(), }), }; if let Some(response) = serde_json::to_string(&response).log_err() { outbound_tx.try_send(response).ok(); } } } } }), ); assert!( prev_handler.is_none(), "registered multiple handlers for the same LSP method" ); Subscription::Notification { method, notification_handlers: Some(self.notification_handlers.clone()), } } pub fn name(&self) -> &str { &self.name } pub fn capabilities(&self) -> &ServerCapabilities { &self.capabilities } pub fn server_id(&self) -> LanguageServerId { self.server_id } pub fn root_path(&self) -> &PathBuf { &self.root_path } pub fn request( &self, params: T::Params, ) -> impl Future> where T::Result: 'static + Send, { Self::request_internal::( &self.next_id, &self.response_handlers, &self.outbound_tx, &self.executor, params, ) } fn request_internal( next_id: &AtomicUsize, response_handlers: &Mutex>>, outbound_tx: &channel::Sender, executor: &Arc, params: T::Params, ) -> impl 'static + Future> where T::Result: 'static + Send, { let id = next_id.fetch_add(1, SeqCst); let message = serde_json::to_string(&Request { jsonrpc: JSON_RPC_VERSION, id, method: T::METHOD, params, }) .unwrap(); let (tx, rx) = oneshot::channel(); let handle_response = response_handlers .lock() .as_mut() .ok_or_else(|| anyhow!("server shut down")) .map(|handlers| { let executor = executor.clone(); handlers.insert( id, Box::new(move |result| { executor .spawn(async move { let response = match result { Ok(response) => serde_json::from_str(&response) .context("failed to deserialize response"), Err(error) => Err(anyhow!("{}", error.message)), }; _ = tx.send(response); }) .detach(); }), ); }); let send = outbound_tx .try_send(message) .context("failed to write to language server's stdin"); let mut timeout = executor.timer(LSP_REQUEST_TIMEOUT).fuse(); let started = Instant::now(); async move { handle_response?; send?; let method = T::METHOD; futures::select! { response = rx.fuse() => { let elapsed = started.elapsed(); log::trace!("Took {elapsed:?} to recieve response to {method:?} id {id}"); response? } _ = timeout => { log::error!("Cancelled LSP request task for {method:?} id {id} which took over {LSP_REQUEST_TIMEOUT:?}"); anyhow::bail!("LSP request timeout"); } } } } pub fn notify(&self, params: T::Params) -> Result<()> { Self::notify_internal::(&self.outbound_tx, params) } fn notify_internal( outbound_tx: &channel::Sender, params: T::Params, ) -> Result<()> { let message = serde_json::to_string(&Notification { jsonrpc: JSON_RPC_VERSION, method: T::METHOD, params, }) .unwrap(); outbound_tx.try_send(message)?; Ok(()) } } impl Drop for LanguageServer { fn drop(&mut self) { if let Some(shutdown) = self.shutdown() { self.executor.spawn(shutdown).detach(); } } } impl Subscription { pub fn detach(&mut self) { match self { Subscription::Notification { notification_handlers, .. } => *notification_handlers = None, Subscription::Io { io_handlers, .. } => *io_handlers = None, } } } impl fmt::Display for LanguageServerId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) } } impl fmt::Debug for LanguageServer { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("LanguageServer") .field("id", &self.server_id.0) .field("name", &self.name) .finish_non_exhaustive() } } impl Drop for Subscription { fn drop(&mut self) { match self { Subscription::Notification { method, notification_handlers, } => { if let Some(handlers) = notification_handlers { handlers.lock().remove(method); } } Subscription::Io { id, io_handlers } => { if let Some(io_handlers) = io_handlers.as_ref().and_then(|h| h.upgrade()) { io_handlers.lock().remove(id); } } } } } #[cfg(any(test, feature = "test-support"))] #[derive(Clone)] pub struct FakeLanguageServer { pub server: Arc, notifications_rx: channel::Receiver<(String, String)>, } #[cfg(any(test, feature = "test-support"))] impl LanguageServer { pub fn full_capabilities() -> ServerCapabilities { ServerCapabilities { document_highlight_provider: Some(OneOf::Left(true)), code_action_provider: Some(CodeActionProviderCapability::Simple(true)), document_formatting_provider: Some(OneOf::Left(true)), document_range_formatting_provider: Some(OneOf::Left(true)), definition_provider: Some(OneOf::Left(true)), type_definition_provider: Some(TypeDefinitionProviderCapability::Simple(true)), ..Default::default() } } pub fn fake( name: String, capabilities: ServerCapabilities, cx: AsyncAppContext, ) -> (Self, FakeLanguageServer) { let (stdin_writer, stdin_reader) = async_pipe::pipe(); let (stdout_writer, stdout_reader) = async_pipe::pipe(); let (notifications_tx, notifications_rx) = channel::unbounded(); let server = Self::new_internal( LanguageServerId(0), stdin_writer, stdout_reader, None::, None, Path::new("/"), None, cx.clone(), |_| {}, ); let fake = FakeLanguageServer { server: Arc::new(Self::new_internal( LanguageServerId(0), stdout_writer, stdin_reader, None::, None, Path::new("/"), None, cx, move |msg| { notifications_tx .try_send(( msg.method.to_string(), msg.params .map(|raw_value| raw_value.get()) .unwrap_or("null") .to_string(), )) .ok(); }, )), notifications_rx, }; fake.handle_request::({ let capabilities = capabilities; move |_, _| { let capabilities = capabilities.clone(); let name = name.clone(); async move { Ok(InitializeResult { capabilities, server_info: Some(ServerInfo { name, ..Default::default() }), }) } } }); (server, fake) } } #[cfg(any(test, feature = "test-support"))] impl FakeLanguageServer { pub fn notify(&self, params: T::Params) { self.server.notify::(params).ok(); } pub async fn request(&self, params: T::Params) -> Result where T: request::Request, T::Result: 'static + Send, { self.server.executor.start_waiting(); self.server.request::(params).await } pub async fn receive_notification(&mut self) -> T::Params { self.server.executor.start_waiting(); self.try_receive_notification::().await.unwrap() } pub async fn try_receive_notification( &mut self, ) -> Option { use futures::StreamExt as _; loop { let (method, params) = self.notifications_rx.next().await?; if method == T::METHOD { return Some(serde_json::from_str::(¶ms).unwrap()); } else { log::info!("skipping message in fake language server {:?}", params); } } } pub fn handle_request( &self, mut handler: F, ) -> futures::channel::mpsc::UnboundedReceiver<()> where T: 'static + request::Request, T::Params: 'static + Send, F: 'static + Send + FnMut(T::Params, gpui::AsyncAppContext) -> Fut, Fut: 'static + Send + Future>, { let (responded_tx, responded_rx) = futures::channel::mpsc::unbounded(); self.server.remove_request_handler::(); self.server .on_request::(move |params, cx| { let result = handler(params, cx.clone()); let responded_tx = responded_tx.clone(); async move { cx.background().simulate_random_delay().await; let result = result.await; responded_tx.unbounded_send(()).ok(); result } }) .detach(); responded_rx } pub fn handle_notification( &self, mut handler: F, ) -> futures::channel::mpsc::UnboundedReceiver<()> where T: 'static + notification::Notification, T::Params: 'static + Send, F: 'static + Send + FnMut(T::Params, gpui::AsyncAppContext), { let (handled_tx, handled_rx) = futures::channel::mpsc::unbounded(); self.server.remove_notification_handler::(); self.server .on_notification::(move |params, cx| { handler(params, cx.clone()); handled_tx.unbounded_send(()).ok(); }) .detach(); handled_rx } pub fn remove_request_handler(&mut self) where T: 'static + request::Request, { self.server.remove_request_handler::(); } pub async fn start_progress(&self, token: impl Into) { let token = token.into(); self.request::(WorkDoneProgressCreateParams { token: NumberOrString::String(token.clone()), }) .await .unwrap(); self.notify::(ProgressParams { token: NumberOrString::String(token), value: ProgressParamsValue::WorkDone(WorkDoneProgress::Begin(Default::default())), }); } pub fn end_progress(&self, token: impl Into) { self.notify::(ProgressParams { token: NumberOrString::String(token.into()), value: ProgressParamsValue::WorkDone(WorkDoneProgress::End(Default::default())), }); } } #[cfg(test)] mod tests { use super::*; use gpui::TestAppContext; #[ctor::ctor] fn init_logger() { if std::env::var("RUST_LOG").is_ok() { env_logger::init(); } } #[gpui::test] async fn test_fake(cx: &mut TestAppContext) { let (server, mut fake) = LanguageServer::fake("the-lsp".to_string(), Default::default(), cx.to_async()); let (message_tx, message_rx) = channel::unbounded(); let (diagnostics_tx, diagnostics_rx) = channel::unbounded(); server .on_notification::(move |params, _| { message_tx.try_send(params).unwrap() }) .detach(); server .on_notification::(move |params, _| { diagnostics_tx.try_send(params).unwrap() }) .detach(); let server = server.initialize(None).await.unwrap(); server .notify::(DidOpenTextDocumentParams { text_document: TextDocumentItem::new( Url::from_str("file://a/b").unwrap(), "rust".to_string(), 0, "".to_string(), ), }) .unwrap(); assert_eq!( fake.receive_notification::() .await .text_document .uri .as_str(), "file://a/b" ); fake.notify::(ShowMessageParams { typ: MessageType::ERROR, message: "ok".to_string(), }); fake.notify::(PublishDiagnosticsParams { uri: Url::from_str("file://b/c").unwrap(), version: Some(5), diagnostics: vec![], }); assert_eq!(message_rx.recv().await.unwrap().message, "ok"); assert_eq!( diagnostics_rx.recv().await.unwrap().uri.as_str(), "file://b/c" ); fake.handle_request::(|_, _| async move { Ok(()) }); drop(server); fake.receive_notification::().await; } }