json.rs

  1use anyhow::{Context as _, Result, bail};
  2use async_compression::futures::bufread::GzipDecoder;
  3use async_tar::Archive;
  4use async_trait::async_trait;
  5use collections::HashMap;
  6use futures::StreamExt;
  7use gpui::{App, AsyncApp, Task};
  8use http_client::github::{GitHubLspBinaryVersion, latest_github_release};
  9use language::{
 10    ContextProvider, LanguageName, LocalFile as _, LspAdapter, LspAdapterDelegate, LspInstaller,
 11    Toolchain,
 12};
 13use lsp::{LanguageServerBinary, LanguageServerName};
 14use node_runtime::{NodeRuntime, VersionStrategy};
 15use project::lsp_store::language_server_settings;
 16use serde_json::{Value, json};
 17use smol::{
 18    fs::{self},
 19    io::BufReader,
 20};
 21use std::{
 22    env::consts,
 23    ffi::OsString,
 24    path::{Path, PathBuf},
 25    str::FromStr,
 26    sync::Arc,
 27};
 28use task::{TaskTemplate, TaskTemplates, VariableName};
 29use util::{
 30    ResultExt, archive::extract_zip, fs::remove_matching, maybe, merge_json_value_into,
 31    rel_path::RelPath,
 32};
 33
 34use crate::PackageJsonData;
 35
 36const SERVER_PATH: &str =
 37    "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
 38
 39pub(crate) struct JsonTaskProvider;
 40
 41impl ContextProvider for JsonTaskProvider {
 42    fn associated_tasks(
 43        &self,
 44        file: Option<Arc<dyn language::File>>,
 45        cx: &App,
 46    ) -> gpui::Task<Option<TaskTemplates>> {
 47        let Some(file) = project::File::from_dyn(file.as_ref()).cloned() else {
 48            return Task::ready(None);
 49        };
 50        let is_package_json = file.path.ends_with(RelPath::unix("package.json").unwrap());
 51        let is_composer_json = file.path.ends_with(RelPath::unix("composer.json").unwrap());
 52        if !is_package_json && !is_composer_json {
 53            return Task::ready(None);
 54        }
 55
 56        cx.spawn(async move |cx| {
 57            let contents = file
 58                .worktree
 59                .update(cx, |this, cx| {
 60                    this.load_file(&file.path, &Default::default(), cx)
 61                })
 62                .ok()?
 63                .await
 64                .ok()?;
 65            let path = cx.update(|cx| file.abs_path(cx)).ok()?.as_path().into();
 66
 67            let task_templates = if is_package_json {
 68                let package_json = serde_json_lenient::from_str::<
 69                    HashMap<String, serde_json_lenient::Value>,
 70                >(&contents.text)
 71                .ok()?;
 72                let package_json = PackageJsonData::new(path, package_json);
 73                let command = package_json.package_manager.unwrap_or("npm").to_owned();
 74                package_json
 75                    .scripts
 76                    .into_iter()
 77                    .map(|(_, key)| TaskTemplate {
 78                        label: format!("run {key}"),
 79                        command: command.clone(),
 80                        args: vec!["run".into(), key],
 81                        cwd: Some(VariableName::Dirname.template_value()),
 82                        ..TaskTemplate::default()
 83                    })
 84                    .chain([TaskTemplate {
 85                        label: "package script $ZED_CUSTOM_script".to_owned(),
 86                        command: command.clone(),
 87                        args: vec![
 88                            "run".into(),
 89                            VariableName::Custom("script".into()).template_value(),
 90                        ],
 91                        cwd: Some(VariableName::Dirname.template_value()),
 92                        tags: vec!["package-script".into()],
 93                        ..TaskTemplate::default()
 94                    }])
 95                    .collect()
 96            } else if is_composer_json {
 97                serde_json_lenient::Value::from_str(&contents.text)
 98                    .ok()?
 99                    .get("scripts")?
100                    .as_object()?
101                    .keys()
102                    .map(|key| TaskTemplate {
103                        label: format!("run {key}"),
104                        command: "composer".to_owned(),
105                        args: vec!["-d".into(), "$ZED_DIRNAME".into(), key.into()],
106                        ..TaskTemplate::default()
107                    })
108                    .chain([TaskTemplate {
109                        label: "composer script $ZED_CUSTOM_script".to_owned(),
110                        command: "composer".to_owned(),
111                        args: vec![
112                            "-d".into(),
113                            "$ZED_DIRNAME".into(),
114                            VariableName::Custom("script".into()).template_value(),
115                        ],
116                        tags: vec!["composer-script".into()],
117                        ..TaskTemplate::default()
118                    }])
119                    .collect()
120            } else {
121                vec![]
122            };
123
124            Some(TaskTemplates(task_templates))
125        })
126    }
127}
128
129fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
130    vec![server_path.into(), "--stdio".into()]
131}
132
133pub struct JsonLspAdapter {
134    node: NodeRuntime,
135}
136
137impl JsonLspAdapter {
138    const PACKAGE_NAME: &str = "vscode-langservers-extracted";
139
140    pub fn new(node: NodeRuntime) -> Self {
141        Self { node }
142    }
143}
144
145impl LspInstaller for JsonLspAdapter {
146    type BinaryVersion = String;
147
148    async fn fetch_latest_server_version(
149        &self,
150        _: &dyn LspAdapterDelegate,
151        _: bool,
152        _: &mut AsyncApp,
153    ) -> Result<String> {
154        self.node
155            .npm_package_latest_version(Self::PACKAGE_NAME)
156            .await
157    }
158
159    async fn check_if_user_installed(
160        &self,
161        delegate: &dyn LspAdapterDelegate,
162        _: Option<Toolchain>,
163        _: &AsyncApp,
164    ) -> Option<LanguageServerBinary> {
165        let path = delegate
166            .which("vscode-json-language-server".as_ref())
167            .await?;
168        let env = delegate.shell_env().await;
169
170        Some(LanguageServerBinary {
171            path,
172            env: Some(env),
173            arguments: vec!["--stdio".into()],
174        })
175    }
176
177    async fn check_if_version_installed(
178        &self,
179        version: &String,
180        container_dir: &PathBuf,
181        _: &dyn LspAdapterDelegate,
182    ) -> Option<LanguageServerBinary> {
183        let server_path = container_dir.join(SERVER_PATH);
184
185        let should_install_language_server = self
186            .node
187            .should_install_npm_package(
188                Self::PACKAGE_NAME,
189                &server_path,
190                container_dir,
191                VersionStrategy::Latest(version),
192            )
193            .await;
194
195        if should_install_language_server {
196            None
197        } else {
198            Some(LanguageServerBinary {
199                path: self.node.binary_path().await.ok()?,
200                env: None,
201                arguments: server_binary_arguments(&server_path),
202            })
203        }
204    }
205
206    async fn fetch_server_binary(
207        &self,
208        latest_version: String,
209        container_dir: PathBuf,
210        _: &dyn LspAdapterDelegate,
211    ) -> Result<LanguageServerBinary> {
212        let server_path = container_dir.join(SERVER_PATH);
213
214        self.node
215            .npm_install_packages(
216                &container_dir,
217                &[(Self::PACKAGE_NAME, latest_version.as_str())],
218            )
219            .await?;
220
221        Ok(LanguageServerBinary {
222            path: self.node.binary_path().await?,
223            env: None,
224            arguments: server_binary_arguments(&server_path),
225        })
226    }
227
228    async fn cached_server_binary(
229        &self,
230        container_dir: PathBuf,
231        _: &dyn LspAdapterDelegate,
232    ) -> Option<LanguageServerBinary> {
233        get_cached_server_binary(container_dir, &self.node).await
234    }
235}
236
237#[async_trait(?Send)]
238impl LspAdapter for JsonLspAdapter {
239    fn name(&self) -> LanguageServerName {
240        LanguageServerName("json-language-server".into())
241    }
242
243    async fn initialization_options(
244        self: Arc<Self>,
245        _: &Arc<dyn LspAdapterDelegate>,
246    ) -> Result<Option<serde_json::Value>> {
247        Ok(Some(json!({
248            "provideFormatter": true
249        })))
250    }
251
252    async fn workspace_configuration(
253        self: Arc<Self>,
254        delegate: &Arc<dyn LspAdapterDelegate>,
255        _: Option<Toolchain>,
256        cx: &mut AsyncApp,
257    ) -> Result<Value> {
258        let mut config = cx.update(|cx| {
259            let schemas = json_schema_store::all_schema_file_associations(cx);
260
261            // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
262            // `Server Info`
263            serde_json::json!({
264                "json": {
265                    "format": {
266                        "enable": true,
267                    },
268                    "validate": {
269                        "enable": true,
270                    },
271                    "schemas": schemas
272                }
273            })
274        })?;
275        let project_options = cx.update(|cx| {
276            language_server_settings(delegate.as_ref(), &self.name(), cx)
277                .and_then(|s| s.settings.clone())
278        })?;
279
280        if let Some(override_options) = project_options {
281            merge_json_value_into(override_options, &mut config);
282        }
283
284        Ok(config)
285    }
286
287    fn language_ids(&self) -> HashMap<LanguageName, String> {
288        [
289            (LanguageName::new("JSON"), "json".into()),
290            (LanguageName::new("JSONC"), "jsonc".into()),
291        ]
292        .into_iter()
293        .collect()
294    }
295
296    fn is_primary_zed_json_schema_adapter(&self) -> bool {
297        true
298    }
299}
300
301async fn get_cached_server_binary(
302    container_dir: PathBuf,
303    node: &NodeRuntime,
304) -> Option<LanguageServerBinary> {
305    maybe!(async {
306        let mut last_version_dir = None;
307        let mut entries = fs::read_dir(&container_dir).await?;
308        while let Some(entry) = entries.next().await {
309            let entry = entry?;
310            if entry.file_type().await?.is_dir() {
311                last_version_dir = Some(entry.path());
312            }
313        }
314
315        let last_version_dir = last_version_dir.context("no cached binary")?;
316        let server_path = last_version_dir.join(SERVER_PATH);
317        anyhow::ensure!(
318            server_path.exists(),
319            "missing executable in directory {last_version_dir:?}"
320        );
321        Ok(LanguageServerBinary {
322            path: node.binary_path().await?,
323            env: None,
324            arguments: server_binary_arguments(&server_path),
325        })
326    })
327    .await
328    .log_err()
329}
330
331pub struct NodeVersionAdapter;
332
333impl NodeVersionAdapter {
334    const SERVER_NAME: LanguageServerName =
335        LanguageServerName::new_static("package-version-server");
336}
337
338impl LspInstaller for NodeVersionAdapter {
339    type BinaryVersion = GitHubLspBinaryVersion;
340
341    async fn fetch_latest_server_version(
342        &self,
343        delegate: &dyn LspAdapterDelegate,
344        _: bool,
345        _: &mut AsyncApp,
346    ) -> Result<GitHubLspBinaryVersion> {
347        let release = latest_github_release(
348            "zed-industries/package-version-server",
349            true,
350            false,
351            delegate.http_client(),
352        )
353        .await?;
354        let os = match consts::OS {
355            "macos" => "apple-darwin",
356            "linux" => "unknown-linux-gnu",
357            "windows" => "pc-windows-msvc",
358            other => bail!("Running on unsupported os: {other}"),
359        };
360        let suffix = if consts::OS == "windows" {
361            ".zip"
362        } else {
363            ".tar.gz"
364        };
365        let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
366        let asset = release
367            .assets
368            .iter()
369            .find(|asset| asset.name == asset_name)
370            .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
371        Ok(GitHubLspBinaryVersion {
372            name: release.tag_name,
373            url: asset.browser_download_url.clone(),
374            digest: asset.digest.clone(),
375        })
376    }
377
378    async fn check_if_user_installed(
379        &self,
380        delegate: &dyn LspAdapterDelegate,
381        _: Option<Toolchain>,
382        _: &AsyncApp,
383    ) -> Option<LanguageServerBinary> {
384        let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
385        Some(LanguageServerBinary {
386            path,
387            env: None,
388            arguments: Default::default(),
389        })
390    }
391
392    async fn fetch_server_binary(
393        &self,
394        latest_version: GitHubLspBinaryVersion,
395        container_dir: PathBuf,
396        delegate: &dyn LspAdapterDelegate,
397    ) -> Result<LanguageServerBinary> {
398        let version = &latest_version;
399        let destination_path = container_dir.join(format!(
400            "{}-{}{}",
401            Self::SERVER_NAME,
402            version.name,
403            std::env::consts::EXE_SUFFIX
404        ));
405        let destination_container_path =
406            container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
407        if fs::metadata(&destination_path).await.is_err() {
408            let mut response = delegate
409                .http_client()
410                .get(&version.url, Default::default(), true)
411                .await
412                .context("downloading release")?;
413            if version.url.ends_with(".zip") {
414                extract_zip(&destination_container_path, response.body_mut()).await?;
415            } else if version.url.ends_with(".tar.gz") {
416                let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
417                let archive = Archive::new(decompressed_bytes);
418                archive.unpack(&destination_container_path).await?;
419            }
420
421            fs::copy(
422                destination_container_path.join(format!(
423                    "{}{}",
424                    Self::SERVER_NAME,
425                    std::env::consts::EXE_SUFFIX
426                )),
427                &destination_path,
428            )
429            .await?;
430            remove_matching(&container_dir, |entry| entry != destination_path).await;
431        }
432        Ok(LanguageServerBinary {
433            path: destination_path,
434            env: None,
435            arguments: Default::default(),
436        })
437    }
438
439    async fn cached_server_binary(
440        &self,
441        container_dir: PathBuf,
442        _delegate: &dyn LspAdapterDelegate,
443    ) -> Option<LanguageServerBinary> {
444        get_cached_version_server_binary(container_dir).await
445    }
446}
447
448#[async_trait(?Send)]
449impl LspAdapter for NodeVersionAdapter {
450    fn name(&self) -> LanguageServerName {
451        Self::SERVER_NAME
452    }
453}
454
455async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
456    maybe!(async {
457        let mut last = None;
458        let mut entries = fs::read_dir(&container_dir).await?;
459        while let Some(entry) = entries.next().await {
460            last = Some(entry?.path());
461        }
462
463        anyhow::Ok(LanguageServerBinary {
464            path: last.context("no cached binary")?,
465            env: None,
466            arguments: Default::default(),
467        })
468    })
469    .await
470    .log_err()
471}