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