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