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