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