// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. use std::sync::Arc; use async_trait::async_trait; use deno_core::anyhow::anyhow; use deno_core::anyhow::bail; use deno_core::error::AnyError; use deno_core::serde_json; use deno_core::serde_json::Value; use deno_core::task::spawn; use tower_lsp::lsp_types as lsp; use tower_lsp::lsp_types::ConfigurationItem; use crate::lsp::repl::get_repl_workspace_settings; use super::config::SpecifierSettings; use super::config::SETTINGS_SECTION; use super::lsp_custom; use super::testing::lsp_custom as testing_lsp_custom; use super::urls::LspClientUrl; #[derive(Debug)] pub enum TestingNotification { Module(testing_lsp_custom::TestModuleNotificationParams), DeleteModule(testing_lsp_custom::TestModuleDeleteNotificationParams), Progress(testing_lsp_custom::TestRunProgressParams), } #[derive(Clone)] pub struct Client(Arc); impl std::fmt::Debug for Client { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_tuple("Client").finish() } } impl Client { pub fn from_tower(client: tower_lsp::Client) -> Self { Self(Arc::new(TowerClient(client))) } pub fn new_for_repl() -> Self { Self(Arc::new(ReplClient)) } /// Gets additional methods that should only be called outside /// the LSP's lock to prevent deadlocking scenarios. pub fn when_outside_lsp_lock(&self) -> OutsideLockClient { OutsideLockClient(self.0.clone()) } pub fn send_registry_state_notification( &self, params: lsp_custom::RegistryStateNotificationParams, ) { // do on a task in case the caller currently is in the lsp lock let client = self.0.clone(); spawn(async move { client.send_registry_state_notification(params).await; }); } /// This notification is sent to the client during internal testing /// purposes only in order to let the test client know when the latest /// diagnostics have been published. pub fn send_diagnostic_batch_notification( &self, params: lsp_custom::DiagnosticBatchNotificationParams, ) { // do on a task in case the caller currently is in the lsp lock let client = self.0.clone(); spawn(async move { client.send_diagnostic_batch_notification(params).await; }); } pub fn send_test_notification(&self, params: TestingNotification) { // do on a task in case the caller currently is in the lsp lock let client = self.0.clone(); spawn(async move { client.send_test_notification(params).await; }); } pub fn show_message( &self, message_type: lsp::MessageType, message: impl std::fmt::Display, ) { // do on a task in case the caller currently is in the lsp lock let client = self.0.clone(); let message = message.to_string(); spawn(async move { client.show_message(message_type, message).await; }); } } /// DANGER: The methods on this client should only be called outside /// the LSP's lock. The reason is you never want to call into the client /// while holding the lock because the client might call back into the /// server and cause a deadlock. pub struct OutsideLockClient(Arc); impl OutsideLockClient { pub async fn register_capability( &self, registrations: Vec, ) -> Result<(), AnyError> { self.0.register_capability(registrations).await } pub async fn specifier_configurations( &self, specifiers: Vec, ) -> Result>, AnyError> { self .0 .specifier_configurations( specifiers.into_iter().map(|s| s.into_url()).collect(), ) .await } pub async fn specifier_configuration( &self, specifier: &LspClientUrl, ) -> Result { let values = self .0 .specifier_configurations(vec![specifier.as_url().clone()]) .await?; if let Some(value) = values.into_iter().next() { value.map_err(|err| { anyhow!( "Error converting specifier settings ({}): {}", specifier, err ) }) } else { bail!( "Expected the client to return a configuration item for specifier: {}", specifier ); } } pub async fn workspace_configuration(&self) -> Result { self.0.workspace_configuration().await } pub async fn publish_diagnostics( &self, uri: LspClientUrl, diags: Vec, version: Option, ) { self .0 .publish_diagnostics(uri.into_url(), diags, version) .await; } } #[async_trait] trait ClientTrait: Send + Sync { async fn publish_diagnostics( &self, uri: lsp::Url, diagnostics: Vec, version: Option, ); async fn send_registry_state_notification( &self, params: lsp_custom::RegistryStateNotificationParams, ); async fn send_diagnostic_batch_notification( &self, params: lsp_custom::DiagnosticBatchNotificationParams, ); async fn send_test_notification(&self, params: TestingNotification); async fn specifier_configurations( &self, uris: Vec, ) -> Result>, AnyError>; async fn workspace_configuration(&self) -> Result; async fn show_message(&self, message_type: lsp::MessageType, text: String); async fn register_capability( &self, registrations: Vec, ) -> Result<(), AnyError>; } #[derive(Clone)] struct TowerClient(tower_lsp::Client); #[async_trait] impl ClientTrait for TowerClient { async fn publish_diagnostics( &self, uri: lsp::Url, diagnostics: Vec, version: Option, ) { self.0.publish_diagnostics(uri, diagnostics, version).await } async fn send_registry_state_notification( &self, params: lsp_custom::RegistryStateNotificationParams, ) { self .0 .send_notification::(params) .await } async fn send_diagnostic_batch_notification( &self, params: lsp_custom::DiagnosticBatchNotificationParams, ) { self .0 .send_notification::(params) .await } async fn send_test_notification(&self, notification: TestingNotification) { match notification { TestingNotification::Module(params) => { self .0 .send_notification::( params, ) .await } TestingNotification::DeleteModule(params) => self .0 .send_notification::( params, ) .await, TestingNotification::Progress(params) => { self .0 .send_notification::( params, ) .await } } } async fn specifier_configurations( &self, uris: Vec, ) -> Result>, AnyError> { let config_response = self .0 .configuration( uris .into_iter() .map(|uri| ConfigurationItem { scope_uri: Some(uri), section: Some(SETTINGS_SECTION.to_string()), }) .collect(), ) .await?; Ok( config_response .into_iter() .map(|value| { serde_json::from_value::(value).map_err(|err| { anyhow!("Error converting specifier settings: {}", err) }) }) .collect(), ) } async fn workspace_configuration(&self) -> Result { let config_response = self .0 .configuration(vec![ConfigurationItem { scope_uri: None, section: Some(SETTINGS_SECTION.to_string()), }]) .await; match config_response { Ok(value_vec) => match value_vec.get(0).cloned() { Some(value) => Ok(value), None => bail!("Missing response workspace configuration."), }, Err(err) => { bail!("Error getting workspace configuration: {}", err) } } } async fn show_message( &self, message_type: lsp::MessageType, message: String, ) { self.0.show_message(message_type, message).await } async fn register_capability( &self, registrations: Vec, ) -> Result<(), AnyError> { self .0 .register_capability(registrations) .await .map_err(|err| anyhow!("{}", err)) } } #[derive(Clone)] struct ReplClient; #[async_trait] impl ClientTrait for ReplClient { async fn publish_diagnostics( &self, _uri: lsp::Url, _diagnostics: Vec, _version: Option, ) { } async fn send_registry_state_notification( &self, _params: lsp_custom::RegistryStateNotificationParams, ) { } async fn send_diagnostic_batch_notification( &self, _params: lsp_custom::DiagnosticBatchNotificationParams, ) { } async fn send_test_notification(&self, _params: TestingNotification) {} async fn specifier_configurations( &self, uris: Vec, ) -> Result>, AnyError> { // all specifiers are enabled for the REPL let settings = uris .into_iter() .map(|_| { Ok(SpecifierSettings { enable: true, ..Default::default() }) }) .collect(); Ok(settings) } async fn workspace_configuration(&self) -> Result { Ok(serde_json::to_value(get_repl_workspace_settings()).unwrap()) } async fn show_message( &self, _message_type: lsp::MessageType, _message: String, ) { } async fn register_capability( &self, _registrations: Vec, ) -> Result<(), AnyError> { Ok(()) } }