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    const PACKAGE_NAME: &str = "vscode-langservers-extracted";
 68
 69    pub fn new(node: NodeRuntime, languages: Arc<LanguageRegistry>) -> Self {
 70        Self {
 71            node,
 72            languages,
 73            workspace_config: Default::default(),
 74        }
 75    }
 76
 77    fn get_workspace_config(language_names: Vec<String>, cx: &mut AppContext) -> Value {
 78        let action_names = cx.all_action_names();
 79        let deprecations = cx.action_deprecations();
 80
 81        let font_names = &cx.text_system().all_font_names();
 82        let settings_schema = cx.global::<SettingsStore>().json_schema(
 83            &SettingsJsonSchemaParams {
 84                language_names: &language_names,
 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, deprecations),
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(Self::PACKAGE_NAME)
149                .await?,
150        ) as Box<_>)
151    }
152
153    async fn check_if_version_installed(
154        &self,
155        version: &(dyn 'static + Send + Any),
156        container_dir: &PathBuf,
157        _: &dyn LspAdapterDelegate,
158    ) -> Option<LanguageServerBinary> {
159        let version = version.downcast_ref::<String>().unwrap();
160        let server_path = container_dir.join(SERVER_PATH);
161
162        let should_install_language_server = self
163            .node
164            .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
165            .await;
166
167        if should_install_language_server {
168            None
169        } else {
170            Some(LanguageServerBinary {
171                path: self.node.binary_path().await.ok()?,
172                env: None,
173                arguments: server_binary_arguments(&server_path),
174            })
175        }
176    }
177
178    async fn fetch_server_binary(
179        &self,
180        latest_version: Box<dyn 'static + Send + Any>,
181        container_dir: PathBuf,
182        _: &dyn LspAdapterDelegate,
183    ) -> Result<LanguageServerBinary> {
184        let latest_version = latest_version.downcast::<String>().unwrap();
185        let server_path = container_dir.join(SERVER_PATH);
186
187        self.node
188            .npm_install_packages(
189                &container_dir,
190                &[(Self::PACKAGE_NAME, latest_version.as_str())],
191            )
192            .await?;
193
194        Ok(LanguageServerBinary {
195            path: self.node.binary_path().await?,
196            env: None,
197            arguments: server_binary_arguments(&server_path),
198        })
199    }
200
201    async fn cached_server_binary(
202        &self,
203        container_dir: PathBuf,
204        _: &dyn LspAdapterDelegate,
205    ) -> Option<LanguageServerBinary> {
206        get_cached_server_binary(container_dir, &self.node).await
207    }
208
209    async fn initialization_options(
210        self: Arc<Self>,
211        _: &Arc<dyn LspAdapterDelegate>,
212    ) -> Result<Option<serde_json::Value>> {
213        Ok(Some(json!({
214            "provideFormatter": true
215        })))
216    }
217
218    async fn workspace_configuration(
219        self: Arc<Self>,
220        delegate: &Arc<dyn LspAdapterDelegate>,
221        _: Arc<dyn LanguageToolchainStore>,
222        cx: &mut AsyncAppContext,
223    ) -> Result<Value> {
224        let mut config = cx.update(|cx| {
225            self.workspace_config
226                .get_or_init(|| Self::get_workspace_config(self.languages.language_names(), cx))
227                .clone()
228        })?;
229
230        let project_options = cx.update(|cx| {
231            language_server_settings(delegate.as_ref(), &self.name(), cx)
232                .and_then(|s| s.settings.clone())
233        })?;
234
235        if let Some(override_options) = project_options {
236            merge_json_value_into(override_options, &mut config);
237        }
238
239        Ok(config)
240    }
241
242    fn language_ids(&self) -> HashMap<String, String> {
243        [
244            ("JSON".into(), "json".into()),
245            ("JSONC".into(), "jsonc".into()),
246        ]
247        .into_iter()
248        .collect()
249    }
250}
251
252async fn get_cached_server_binary(
253    container_dir: PathBuf,
254    node: &NodeRuntime,
255) -> Option<LanguageServerBinary> {
256    maybe!(async {
257        let mut last_version_dir = None;
258        let mut entries = fs::read_dir(&container_dir).await?;
259        while let Some(entry) = entries.next().await {
260            let entry = entry?;
261            if entry.file_type().await?.is_dir() {
262                last_version_dir = Some(entry.path());
263            }
264        }
265
266        let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
267        let server_path = last_version_dir.join(SERVER_PATH);
268        if server_path.exists() {
269            Ok(LanguageServerBinary {
270                path: node.binary_path().await?,
271                env: None,
272                arguments: server_binary_arguments(&server_path),
273            })
274        } else {
275            Err(anyhow!(
276                "missing executable in directory {:?}",
277                last_version_dir
278            ))
279        }
280    })
281    .await
282    .log_err()
283}
284
285#[inline]
286fn schema_file_match(path: &Path) -> String {
287    path.strip_prefix(path.parent().unwrap().parent().unwrap())
288        .unwrap()
289        .display()
290        .to_string()
291        .replace('\\', "/")
292}
293
294pub(super) struct NodeVersionAdapter;
295
296#[async_trait(?Send)]
297impl LspAdapter for NodeVersionAdapter {
298    fn name(&self) -> LanguageServerName {
299        LanguageServerName("package-version-server".into())
300    }
301
302    async fn fetch_latest_server_version(
303        &self,
304        delegate: &dyn LspAdapterDelegate,
305    ) -> Result<Box<dyn 'static + Send + Any>> {
306        let release = latest_github_release(
307            "zed-industries/package-version-server",
308            true,
309            false,
310            delegate.http_client(),
311        )
312        .await?;
313        let os = match consts::OS {
314            "macos" => "apple-darwin",
315            "linux" => "unknown-linux-gnu",
316            "windows" => "pc-windows-msvc",
317            other => bail!("Running on unsupported os: {other}"),
318        };
319        let suffix = if consts::OS == "windows" {
320            ".zip"
321        } else {
322            ".tar.gz"
323        };
324        let asset_name = format!("package-version-server-{}-{os}{suffix}", consts::ARCH);
325        let asset = release
326            .assets
327            .iter()
328            .find(|asset| asset.name == asset_name)
329            .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
330        Ok(Box::new(GitHubLspBinaryVersion {
331            name: release.tag_name,
332            url: asset.browser_download_url.clone(),
333        }))
334    }
335
336    async fn fetch_server_binary(
337        &self,
338        latest_version: Box<dyn 'static + Send + Any>,
339        container_dir: PathBuf,
340        delegate: &dyn LspAdapterDelegate,
341    ) -> Result<LanguageServerBinary> {
342        let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
343        let destination_path = container_dir.join(format!(
344            "package-version-server-{}{}",
345            version.name,
346            std::env::consts::EXE_SUFFIX
347        ));
348        let destination_container_path =
349            container_dir.join(format!("package-version-server-{}-tmp", version.name));
350        if fs::metadata(&destination_path).await.is_err() {
351            let mut response = delegate
352                .http_client()
353                .get(&version.url, Default::default(), true)
354                .await
355                .map_err(|err| anyhow!("error downloading release: {}", err))?;
356            if version.url.ends_with(".zip") {
357                node_runtime::extract_zip(
358                    &destination_container_path,
359                    BufReader::new(response.body_mut()),
360                )
361                .await?;
362            } else if version.url.ends_with(".tar.gz") {
363                let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
364                let archive = Archive::new(decompressed_bytes);
365                archive.unpack(&destination_container_path).await?;
366            }
367
368            fs::copy(
369                destination_container_path.join(format!(
370                    "package-version-server{}",
371                    std::env::consts::EXE_SUFFIX
372                )),
373                &destination_path,
374            )
375            .await?;
376            // todo("windows")
377            #[cfg(not(windows))]
378            {
379                fs::set_permissions(
380                    &destination_path,
381                    <fs::Permissions as fs::unix::PermissionsExt>::from_mode(0o755),
382                )
383                .await?;
384            }
385            remove_matching(&container_dir, |entry| entry != destination_path).await;
386        }
387        Ok(LanguageServerBinary {
388            path: destination_path,
389            env: None,
390            arguments: Default::default(),
391        })
392    }
393
394    async fn cached_server_binary(
395        &self,
396        container_dir: PathBuf,
397        _delegate: &dyn LspAdapterDelegate,
398    ) -> Option<LanguageServerBinary> {
399        get_cached_version_server_binary(container_dir).await
400    }
401}
402
403async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
404    maybe!(async {
405        let mut last = None;
406        let mut entries = fs::read_dir(&container_dir).await?;
407        while let Some(entry) = entries.next().await {
408            last = Some(entry?.path());
409        }
410
411        anyhow::Ok(LanguageServerBinary {
412            path: last.ok_or_else(|| anyhow!("no cached binary"))?,
413            env: None,
414            arguments: Default::default(),
415        })
416    })
417    .await
418    .log_err()
419}