json.rs

  1use anyhow::{anyhow, bail, Context, Result};
  2use async_compression::futures::bufread::GzipDecoder;
  3use async_tar::Archive;
  4use async_trait::async_trait;
  5use collections::HashMap;
  6use futures::StreamExt;
  7use gpui::{AppContext, AsyncAppContext};
  8use http_client::github::{latest_github_release, GitHubLspBinaryVersion};
  9use language::{LanguageRegistry, LanguageToolchainStore, LspAdapter, LspAdapterDelegate};
 10use lsp::{LanguageServerBinary, LanguageServerName};
 11use node_runtime::NodeRuntime;
 12use project::{lsp_store::language_server_settings, ContextProviderWithTasks};
 13use serde_json::{json, Value};
 14use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore};
 15use smol::{
 16    fs::{self},
 17    io::BufReader,
 18};
 19use std::{
 20    any::Any,
 21    env::consts,
 22    ffi::OsString,
 23    path::{Path, PathBuf},
 24    str::FromStr,
 25    sync::{Arc, OnceLock},
 26};
 27use task::{TaskTemplate, TaskTemplates, VariableName};
 28use util::{fs::remove_matching, maybe, merge_json_value_into, ResultExt};
 29
 30const SERVER_PATH: &str =
 31    "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
 32
 33// Origin: https://github.com/SchemaStore/schemastore
 34const TSCONFIG_SCHEMA: &str = include_str!("json/schemas/tsconfig.json");
 35const PACKAGE_JSON_SCHEMA: &str = include_str!("json/schemas/package.json");
 36
 37pub(super) fn json_task_context() -> ContextProviderWithTasks {
 38    ContextProviderWithTasks::new(TaskTemplates(vec![
 39        TaskTemplate {
 40            label: "package script $ZED_CUSTOM_script".to_owned(),
 41            command: "npm --prefix $ZED_DIRNAME run".to_owned(),
 42            args: vec![VariableName::Custom("script".into()).template_value()],
 43            tags: vec!["package-script".into()],
 44            ..TaskTemplate::default()
 45        },
 46        TaskTemplate {
 47            label: "composer script $ZED_CUSTOM_script".to_owned(),
 48            command: "composer -d $ZED_DIRNAME".to_owned(),
 49            args: vec![VariableName::Custom("script".into()).template_value()],
 50            tags: vec!["composer-script".into()],
 51            ..TaskTemplate::default()
 52        },
 53    ]))
 54}
 55
 56fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
 57    vec![server_path.into(), "--stdio".into()]
 58}
 59
 60pub struct JsonLspAdapter {
 61    node: NodeRuntime,
 62    languages: Arc<LanguageRegistry>,
 63    workspace_config: OnceLock<Value>,
 64}
 65
 66impl JsonLspAdapter {
 67    pub fn new(node: NodeRuntime, languages: Arc<LanguageRegistry>) -> Self {
 68        Self {
 69            node,
 70            languages,
 71            workspace_config: Default::default(),
 72        }
 73    }
 74
 75    fn get_workspace_config(language_names: Vec<String>, cx: &mut AppContext) -> Value {
 76        let action_names = cx.all_action_names();
 77
 78        let font_names = &cx.text_system().all_font_names();
 79        let settings_schema = cx.global::<SettingsStore>().json_schema(
 80            &SettingsJsonSchemaParams {
 81                language_names: &language_names,
 82                font_names,
 83            },
 84            cx,
 85        );
 86        let tasks_schema = task::TaskTemplates::generate_json_schema();
 87        let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
 88        let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
 89
 90        serde_json::json!({
 91            "json": {
 92                "format": {
 93                    "enable": true,
 94                },
 95                "validate":
 96                {
 97                    "enable": true,
 98                },
 99                "schemas": [
100                    {
101                        "fileMatch": ["tsconfig.json"],
102                        "schema":tsconfig_schema
103                    },
104                    {
105                        "fileMatch": ["package.json"],
106                        "schema":package_json_schema
107                    },
108                    {
109                        "fileMatch": [
110                            schema_file_match(paths::settings_file()),
111                            paths::local_settings_file_relative_path()
112                        ],
113                        "schema": settings_schema,
114                    },
115                    {
116                        "fileMatch": [schema_file_match(paths::keymap_file())],
117                        "schema": KeymapFile::generate_json_schema(action_names),
118                    },
119                    {
120                        "fileMatch": [
121                            schema_file_match(paths::tasks_file()),
122                            paths::local_tasks_file_relative_path()
123                        ],
124                        "schema": tasks_schema,
125                    }
126
127                ]
128            }
129        })
130    }
131}
132
133#[async_trait(?Send)]
134impl LspAdapter for JsonLspAdapter {
135    fn name(&self) -> LanguageServerName {
136        LanguageServerName("json-language-server".into())
137    }
138
139    async fn fetch_latest_server_version(
140        &self,
141        _: &dyn LspAdapterDelegate,
142    ) -> Result<Box<dyn 'static + Send + Any>> {
143        Ok(Box::new(
144            self.node
145                .npm_package_latest_version("vscode-langservers-extracted")
146                .await?,
147        ) as Box<_>)
148    }
149
150    async fn fetch_server_binary(
151        &self,
152        latest_version: Box<dyn 'static + Send + Any>,
153        container_dir: PathBuf,
154        _: &dyn LspAdapterDelegate,
155    ) -> Result<LanguageServerBinary> {
156        let latest_version = latest_version.downcast::<String>().unwrap();
157        let server_path = container_dir.join(SERVER_PATH);
158        let package_name = "vscode-langservers-extracted";
159
160        let should_install_language_server = self
161            .node
162            .should_install_npm_package(package_name, &server_path, &container_dir, &latest_version)
163            .await;
164
165        if should_install_language_server {
166            self.node
167                .npm_install_packages(&container_dir, &[(package_name, latest_version.as_str())])
168                .await?;
169        }
170
171        Ok(LanguageServerBinary {
172            path: self.node.binary_path().await?,
173            env: None,
174            arguments: server_binary_arguments(&server_path),
175        })
176    }
177
178    async fn cached_server_binary(
179        &self,
180        container_dir: PathBuf,
181        _: &dyn LspAdapterDelegate,
182    ) -> Option<LanguageServerBinary> {
183        get_cached_server_binary(container_dir, &self.node).await
184    }
185
186    async fn initialization_options(
187        self: Arc<Self>,
188        _: &Arc<dyn LspAdapterDelegate>,
189    ) -> Result<Option<serde_json::Value>> {
190        Ok(Some(json!({
191            "provideFormatter": true
192        })))
193    }
194
195    async fn workspace_configuration(
196        self: Arc<Self>,
197        delegate: &Arc<dyn LspAdapterDelegate>,
198        _: Arc<dyn LanguageToolchainStore>,
199        cx: &mut AsyncAppContext,
200    ) -> Result<Value> {
201        let mut config = cx.update(|cx| {
202            self.workspace_config
203                .get_or_init(|| Self::get_workspace_config(self.languages.language_names(), cx))
204                .clone()
205        })?;
206
207        let project_options = cx.update(|cx| {
208            language_server_settings(delegate.as_ref(), &self.name(), cx)
209                .and_then(|s| s.settings.clone())
210        })?;
211
212        if let Some(override_options) = project_options {
213            merge_json_value_into(override_options, &mut config);
214        }
215
216        Ok(config)
217    }
218
219    fn language_ids(&self) -> HashMap<String, String> {
220        [
221            ("JSON".into(), "json".into()),
222            ("JSONC".into(), "jsonc".into()),
223        ]
224        .into_iter()
225        .collect()
226    }
227}
228
229async fn get_cached_server_binary(
230    container_dir: PathBuf,
231    node: &NodeRuntime,
232) -> Option<LanguageServerBinary> {
233    maybe!(async {
234        let mut last_version_dir = None;
235        let mut entries = fs::read_dir(&container_dir).await?;
236        while let Some(entry) = entries.next().await {
237            let entry = entry?;
238            if entry.file_type().await?.is_dir() {
239                last_version_dir = Some(entry.path());
240            }
241        }
242
243        let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
244        let server_path = last_version_dir.join(SERVER_PATH);
245        if server_path.exists() {
246            Ok(LanguageServerBinary {
247                path: node.binary_path().await?,
248                env: None,
249                arguments: server_binary_arguments(&server_path),
250            })
251        } else {
252            Err(anyhow!(
253                "missing executable in directory {:?}",
254                last_version_dir
255            ))
256        }
257    })
258    .await
259    .log_err()
260}
261
262#[inline]
263fn schema_file_match(path: &Path) -> String {
264    path.strip_prefix(path.parent().unwrap().parent().unwrap())
265        .unwrap()
266        .display()
267        .to_string()
268        .replace('\\', "/")
269}
270
271pub(super) struct NodeVersionAdapter;
272
273#[async_trait(?Send)]
274impl LspAdapter for NodeVersionAdapter {
275    fn name(&self) -> LanguageServerName {
276        LanguageServerName("package-version-server".into())
277    }
278
279    async fn fetch_latest_server_version(
280        &self,
281        delegate: &dyn LspAdapterDelegate,
282    ) -> Result<Box<dyn 'static + Send + Any>> {
283        let release = latest_github_release(
284            "zed-industries/package-version-server",
285            true,
286            false,
287            delegate.http_client(),
288        )
289        .await?;
290        let os = match consts::OS {
291            "macos" => "apple-darwin",
292            "linux" => "unknown-linux-gnu",
293            "windows" => "pc-windows-msvc",
294            other => bail!("Running on unsupported os: {other}"),
295        };
296        let suffix = if consts::OS == "windows" {
297            ".zip"
298        } else {
299            ".tar.gz"
300        };
301        let asset_name = format!("package-version-server-{}-{os}{suffix}", consts::ARCH);
302        let asset = release
303            .assets
304            .iter()
305            .find(|asset| asset.name == asset_name)
306            .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
307        Ok(Box::new(GitHubLspBinaryVersion {
308            name: release.tag_name,
309            url: asset.browser_download_url.clone(),
310        }))
311    }
312
313    async fn fetch_server_binary(
314        &self,
315        latest_version: Box<dyn 'static + Send + Any>,
316        container_dir: PathBuf,
317        delegate: &dyn LspAdapterDelegate,
318    ) -> Result<LanguageServerBinary> {
319        let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
320        let destination_path = container_dir.join(format!(
321            "package-version-server-{}{}",
322            version.name,
323            std::env::consts::EXE_SUFFIX
324        ));
325        let destination_container_path =
326            container_dir.join(format!("package-version-server-{}-tmp", version.name));
327        if fs::metadata(&destination_path).await.is_err() {
328            let mut response = delegate
329                .http_client()
330                .get(&version.url, Default::default(), true)
331                .await
332                .map_err(|err| anyhow!("error downloading release: {}", err))?;
333            if version.url.ends_with(".zip") {
334                node_runtime::extract_zip(
335                    &destination_container_path,
336                    BufReader::new(response.body_mut()),
337                )
338                .await?;
339            } else if version.url.ends_with(".tar.gz") {
340                let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
341                let archive = Archive::new(decompressed_bytes);
342                archive.unpack(&destination_container_path).await?;
343            }
344
345            fs::copy(
346                destination_container_path.join(format!(
347                    "package-version-server{}",
348                    std::env::consts::EXE_SUFFIX
349                )),
350                &destination_path,
351            )
352            .await?;
353            // todo("windows")
354            #[cfg(not(windows))]
355            {
356                fs::set_permissions(
357                    &destination_path,
358                    <fs::Permissions as fs::unix::PermissionsExt>::from_mode(0o755),
359                )
360                .await?;
361            }
362            remove_matching(&container_dir, |entry| entry != destination_path).await;
363        }
364        Ok(LanguageServerBinary {
365            path: destination_path,
366            env: None,
367            arguments: Default::default(),
368        })
369    }
370
371    async fn cached_server_binary(
372        &self,
373        container_dir: PathBuf,
374        _delegate: &dyn LspAdapterDelegate,
375    ) -> Option<LanguageServerBinary> {
376        get_cached_version_server_binary(container_dir).await
377    }
378}
379
380async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
381    maybe!(async {
382        let mut last = None;
383        let mut entries = fs::read_dir(&container_dir).await?;
384        while let Some(entry) = entries.next().await {
385            last = Some(entry?.path());
386        }
387
388        anyhow::Ok(LanguageServerBinary {
389            path: last.ok_or_else(|| anyhow!("no cached binary"))?,
390            env: None,
391            arguments: Default::default(),
392        })
393    })
394    .await
395    .log_err()
396}