Add ability to specify binary path/args for rust-analyzer (#9293)

Thorsten Ball and Ricard Mallafre created 2 years ago

This fixes #9292 by adding a section to the language server settings
that allows users to specify the binary path and arguments with which to
start up a language server.

Example user settings for `rust-analyzer`:

```json
{
  "lsp": {
    "rust-analyzer": {
      "binary": {
        "path": "/Users/thorstenball/tmp/rust-analyzer-aarch64-apple-darwin",
        "arguments": ["--no-log-buffering"]
      }
    }
  }
}
```

Constraints:

* Right now this only allows ABSOLUTE paths.
* This is only used by `rust-analyzer` integration right now, but the
setting can be used for other language servers. We just need to update
the adapters to also respect that setting.



Release Notes:

- Added ability to specify `rust-analyzer` binary `path` (must be
absolute) and `arguments` in user settings. Example: `{"lsp":
{"rust-analyzer": {"binary": {"path": "/my/abs/path/rust-analyzer",
"arguments": ["--no-log-buffering"] }}}}`
([#9292](https://github.com/zed-industries/zed/issues/9292)).

Co-authored-by: Ricard Mallafre <[e-mail]>

Change summary

crates/editor/src/editor_tests.rs             |  4 ++
crates/extension/src/extension_lsp_adapter.rs |  2 
crates/language/src/language.rs               |  7 ++-
crates/languages/src/astro.rs                 |  2 
crates/languages/src/c.rs                     |  2 
crates/languages/src/clojure.rs               |  2 
crates/languages/src/csharp.rs                |  2 
crates/languages/src/css.rs                   |  2 
crates/languages/src/dart.rs                  |  2 
crates/languages/src/deno.rs                  |  2 
crates/languages/src/dockerfile.rs            |  2 
crates/languages/src/elixir.rs                |  6 +-
crates/languages/src/elm.rs                   |  2 
crates/languages/src/erlang.rs                |  2 
crates/languages/src/gleam.rs                 |  2 
crates/languages/src/go.rs                    |  3 +
crates/languages/src/haskell.rs               |  2 
crates/languages/src/html.rs                  |  2 
crates/languages/src/json.rs                  |  2 
crates/languages/src/lua.rs                   |  2 
crates/languages/src/nu.rs                    |  2 
crates/languages/src/ocaml.rs                 |  2 
crates/languages/src/php.rs                   |  2 
crates/languages/src/prisma.rs                |  2 
crates/languages/src/purescript.rs            |  2 
crates/languages/src/python.rs                |  2 
crates/languages/src/ruby.rs                  |  2 
crates/languages/src/rust.rs                  | 40 +++++++++++++++++++-
crates/languages/src/svelte.rs                |  2 
crates/languages/src/tailwind.rs              |  2 
crates/languages/src/terraform.rs             |  2 
crates/languages/src/toml.rs                  |  2 
crates/languages/src/typescript.rs            |  4 +-
crates/languages/src/uiua.rs                  |  2 
crates/languages/src/vue.rs                   |  2 
crates/languages/src/yaml.rs                  |  2 
crates/languages/src/zig.rs                   |  4 +
crates/project/src/project_settings.rs        |  7 +++
38 files changed, 92 insertions(+), 43 deletions(-)

Detailed changes

crates/editor/src/editor_tests.rs

@@ -8320,6 +8320,7 @@ async fn test_language_server_restart_due_to_settings_change(cx: &mut gpui::Test
         project_settings.lsp.insert(
             "Some other server name".into(),
             LspSettings {
+                binary: None,
                 settings: None,
                 initialization_options: Some(json!({
                     "some other init value": false
@@ -8338,6 +8339,7 @@ async fn test_language_server_restart_due_to_settings_change(cx: &mut gpui::Test
         project_settings.lsp.insert(
             language_server_name.into(),
             LspSettings {
+                binary: None,
                 settings: None,
                 initialization_options: Some(json!({
                     "anotherInitValue": false
@@ -8356,6 +8358,7 @@ async fn test_language_server_restart_due_to_settings_change(cx: &mut gpui::Test
         project_settings.lsp.insert(
             language_server_name.into(),
             LspSettings {
+                binary: None,
                 settings: None,
                 initialization_options: Some(json!({
                     "anotherInitValue": false
@@ -8374,6 +8377,7 @@ async fn test_language_server_restart_due_to_settings_change(cx: &mut gpui::Test
         project_settings.lsp.insert(
             language_server_name.into(),
             LspSettings {
+                binary: None,
                 settings: None,
                 initialization_options: None,
             },

crates/extension/src/extension_lsp_adapter.rs

@@ -19,7 +19,7 @@ pub struct ExtensionLspAdapter {
     pub(crate) host: Arc<WasmHost>,
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for ExtensionLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName(self.config.name.clone().into())

crates/language/src/language.rs

@@ -282,7 +282,7 @@ pub trait LspAdapterDelegate: Send + Sync {
     async fn read_text_file(&self, path: PathBuf) -> Result<String>;
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 pub trait LspAdapter: 'static + Send + Sync {
     fn name(&self) -> LanguageServerName;
 
@@ -306,7 +306,7 @@ pub trait LspAdapter: 'static + Send + Sync {
             // We only want to cache when we fall back to the global one,
             // because we don't want to download and overwrite our global one
             // for each worktree we might have open.
-            if let Some(binary) = self.check_if_user_installed(delegate.as_ref()).await {
+            if let Some(binary) = self.check_if_user_installed(delegate.as_ref(), cx).await {
                 log::info!(
                     "found user-installed language server for {}. path: {:?}, arguments: {:?}",
                     language.name(),
@@ -380,6 +380,7 @@ pub trait LspAdapter: 'static + Send + Sync {
     async fn check_if_user_installed(
         &self,
         _: &dyn LspAdapterDelegate,
+        _: &AsyncAppContext,
     ) -> Option<LanguageServerBinary> {
         None
     }
@@ -1457,7 +1458,7 @@ impl Default for FakeLspAdapter {
 }
 
 #[cfg(any(test, feature = "test-support"))]
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for FakeLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName(self.name.into())

crates/languages/src/astro.rs

@@ -30,7 +30,7 @@ impl AstroLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for AstroLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("astro-language-server".into())

crates/languages/src/c.rs

@@ -14,7 +14,7 @@ use util::{
 
 pub struct CLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for CLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("clangd".into())

crates/languages/src/clojure.rs

@@ -12,7 +12,7 @@ use util::{
 #[derive(Copy, Clone)]
 pub struct ClojureLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for ClojureLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("clojure-lsp".into())

crates/languages/src/csharp.rs

@@ -15,7 +15,7 @@ use util::{github::GitHubLspBinaryVersion, ResultExt};
 
 pub struct OmniSharpAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for OmniSharpAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("OmniSharp".into())

crates/languages/src/css.rs

@@ -31,7 +31,7 @@ impl CssLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for CssLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("vscode-css-language-server".into())

crates/languages/src/dart.rs

@@ -13,7 +13,7 @@ use std::{
 
 pub struct DartLanguageServer;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for DartLanguageServer {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("dart".into())

crates/languages/src/deno.rs

@@ -56,7 +56,7 @@ impl DenoLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for DenoLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("deno-language-server".into())

crates/languages/src/dockerfile.rs

@@ -29,7 +29,7 @@ impl DockerfileLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for DockerfileLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("docker-langserver".into())

crates/languages/src/elixir.rs

@@ -65,7 +65,7 @@ impl Settings for ElixirSettings {
 
 pub struct ElixirLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for ElixirLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("elixir-ls".into())
@@ -292,7 +292,7 @@ async fn get_cached_server_binary_elixir_ls(
 
 pub struct NextLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for NextLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("next-ls".into())
@@ -446,7 +446,7 @@ pub struct LocalLspAdapter {
     pub arguments: Vec<String>,
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for LocalLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("local-ls".into())

crates/languages/src/elm.rs

@@ -34,7 +34,7 @@ impl ElmLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for ElmLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName(SERVER_NAME.into())

crates/languages/src/erlang.rs

@@ -6,7 +6,7 @@ use std::{any::Any, path::PathBuf};
 
 pub struct ErlangLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for ErlangLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("erlang_ls".into())

crates/languages/src/gleam.rs

@@ -21,7 +21,7 @@ fn server_binary_arguments() -> Vec<OsString> {
 
 pub struct GleamLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for GleamLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("gleam".into())

crates/languages/src/go.rs

@@ -32,7 +32,7 @@ lazy_static! {
     static ref GOPLS_VERSION_REGEX: Regex = Regex::new(r"\d+\.\d+\.\d+").unwrap();
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for GoLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("gopls".into())
@@ -57,6 +57,7 @@ impl super::LspAdapter for GoLspAdapter {
     async fn check_if_user_installed(
         &self,
         delegate: &dyn LspAdapterDelegate,
+        _: &AsyncAppContext,
     ) -> Option<LanguageServerBinary> {
         let env = delegate.shell_env().await;
         let path = delegate.which("gopls".as_ref()).await?;

crates/languages/src/haskell.rs

@@ -6,7 +6,7 @@ use std::{any::Any, path::PathBuf};
 
 pub struct HaskellLanguageServer;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for HaskellLanguageServer {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("hls".into())

crates/languages/src/html.rs

@@ -31,7 +31,7 @@ impl HtmlLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for HtmlLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("vscode-html-language-server".into())

crates/languages/src/json.rs

@@ -83,7 +83,7 @@ impl JsonLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for JsonLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("json-language-server".into())

crates/languages/src/lua.rs

@@ -16,7 +16,7 @@ use util::{
 #[derive(Copy, Clone)]
 pub struct LuaLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for LuaLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("lua-language-server".into())

crates/languages/src/nu.rs

@@ -6,7 +6,7 @@ use std::{any::Any, path::PathBuf};
 
 pub struct NuLanguageServer;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for NuLanguageServer {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("nu".into())

crates/languages/src/ocaml.rs

@@ -12,7 +12,7 @@ const OPERATOR_CHAR: [char; 17] = [
 
 pub struct OCamlLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for OCamlLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("ocamllsp".into())

crates/languages/src/php.rs

@@ -34,7 +34,7 @@ impl IntelephenseLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for IntelephenseLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("intelephense".into())

crates/languages/src/prisma.rs

@@ -29,7 +29,7 @@ impl PrismaLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for PrismaLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("prisma-language-server".into())

crates/languages/src/purescript.rs

@@ -33,7 +33,7 @@ impl PurescriptLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for PurescriptLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("purescript-language-server".into())

crates/languages/src/python.rs

@@ -28,7 +28,7 @@ impl PythonLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for PythonLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("pyright".into())

crates/languages/src/ruby.rs

@@ -6,7 +6,7 @@ use std::{any::Any, path::PathBuf, sync::Arc};
 
 pub struct RubyLanguageServer;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for RubyLanguageServer {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("solargraph".into())

crates/languages/src/rust.rs

@@ -2,12 +2,15 @@ use anyhow::{anyhow, bail, Result};
 use async_compression::futures::bufread::GzipDecoder;
 use async_trait::async_trait;
 use futures::{io::BufReader, StreamExt};
+use gpui::AsyncAppContext;
 pub use language::*;
 use lazy_static::lazy_static;
 use lsp::LanguageServerBinary;
+use project::project_settings::ProjectSettings;
 use regex::Regex;
+use settings::Settings;
 use smol::fs::{self, File};
-use std::{any::Any, borrow::Cow, env::consts, path::PathBuf, str, sync::Arc};
+use std::{any::Any, borrow::Cow, env::consts, path::PathBuf, sync::Arc};
 use util::{
     async_maybe,
     fs::remove_matching,
@@ -17,10 +20,41 @@ use util::{
 
 pub struct RustLspAdapter;
 
-#[async_trait]
+impl RustLspAdapter {
+    const SERVER_NAME: &'static str = "rust-analyzer";
+}
+
+#[async_trait(?Send)]
 impl LspAdapter for RustLspAdapter {
     fn name(&self) -> LanguageServerName {
-        LanguageServerName("rust-analyzer".into())
+        LanguageServerName(Self::SERVER_NAME.into())
+    }
+
+    async fn check_if_user_installed(
+        &self,
+        _delegate: &dyn LspAdapterDelegate,
+        cx: &AsyncAppContext,
+    ) -> Option<LanguageServerBinary> {
+        let binary = cx
+            .update(|cx| {
+                ProjectSettings::get_global(cx)
+                    .lsp
+                    .get(Self::SERVER_NAME)
+                    .and_then(|s| s.binary.clone())
+            })
+            .ok()??;
+
+        let path = binary.path?;
+        Some(LanguageServerBinary {
+            path: path.into(),
+            arguments: binary
+                .arguments
+                .unwrap_or_default()
+                .iter()
+                .map(|arg| arg.into())
+                .collect(),
+            env: None,
+        })
     }
 
     async fn fetch_latest_server_version(

crates/languages/src/svelte.rs

@@ -30,7 +30,7 @@ impl SvelteLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for SvelteLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("svelte-language-server".into())

crates/languages/src/tailwind.rs

@@ -32,7 +32,7 @@ impl TailwindLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for TailwindLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("tailwindcss-language-server".into())

crates/languages/src/terraform.rs

@@ -19,7 +19,7 @@ fn terraform_ls_binary_arguments() -> Vec<OsString> {
 
 pub struct TerraformLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for TerraformLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("terraform-ls".into())

crates/languages/src/toml.rs

@@ -12,7 +12,7 @@ use util::{github::GitHubLspBinaryVersion, ResultExt};
 
 pub struct TaploLspAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for TaploLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("taplo-ls".into())

crates/languages/src/typescript.rs

@@ -50,7 +50,7 @@ struct TypeScriptVersions {
     server_version: String,
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for TypeScriptLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("typescript-language-server".into())
@@ -224,7 +224,7 @@ impl EsLintLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for EsLintLspAdapter {
     fn workspace_configuration(&self, workspace_root: &Path, cx: &mut AppContext) -> Value {
         let eslint_user_settings = ProjectSettings::get_global(cx)

crates/languages/src/uiua.rs

@@ -6,7 +6,7 @@ use std::{any::Any, path::PathBuf};
 
 pub struct UiuaLanguageServer;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for UiuaLanguageServer {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("uiua".into())

crates/languages/src/vue.rs

@@ -38,7 +38,7 @@ impl VueLspAdapter {
         }
     }
 }
-#[async_trait]
+#[async_trait(?Send)]
 impl super::LspAdapter for VueLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("vue-language-server".into())

crates/languages/src/yaml.rs

@@ -33,7 +33,7 @@ impl YamlLspAdapter {
     }
 }
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for YamlLspAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("yaml-language-server".into())

crates/languages/src/zig.rs

@@ -3,6 +3,7 @@ use async_compression::futures::bufread::GzipDecoder;
 use async_tar::Archive;
 use async_trait::async_trait;
 use futures::{io::BufReader, StreamExt};
+use gpui::AsyncAppContext;
 use language::{LanguageServerName, LspAdapter, LspAdapterDelegate};
 use lsp::LanguageServerBinary;
 use smol::fs;
@@ -14,7 +15,7 @@ use util::{github::GitHubLspBinaryVersion, ResultExt};
 
 pub struct ZlsAdapter;
 
-#[async_trait]
+#[async_trait(?Send)]
 impl LspAdapter for ZlsAdapter {
     fn name(&self) -> LanguageServerName {
         LanguageServerName("zls".into())
@@ -43,6 +44,7 @@ impl LspAdapter for ZlsAdapter {
     async fn check_if_user_installed(
         &self,
         delegate: &dyn LspAdapterDelegate,
+        _cx: &AsyncAppContext,
     ) -> Option<LanguageServerBinary> {
         let env = delegate.shell_env().await;
         let path = delegate.which("zls".as_ref()).await?;

crates/project/src/project_settings.rs

@@ -41,9 +41,16 @@ pub enum GitGutterSetting {
     Hide,
 }
 
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
+pub struct BinarySettings {
+    pub path: Option<String>,
+    pub arguments: Option<Vec<String>>,
+}
+
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
 #[serde(rename_all = "snake_case")]
 pub struct LspSettings {
+    pub binary: Option<BinarySettings>,
     pub initialization_options: Option<serde_json::Value>,
     pub settings: Option<serde_json::Value>,
 }