1use anyhow::{Context as _, Result, bail};
  2use async_compression::futures::bufread::GzipDecoder;
  3use async_tar::Archive;
  4use async_trait::async_trait;
  5use collections::HashMap;
  6use dap::DapRegistry;
  7use futures::StreamExt;
  8use gpui::{App, AsyncApp, Task};
  9use http_client::github::{GitHubLspBinaryVersion, latest_github_release};
 10use language::{
 11    ContextProvider, LanguageName, LanguageRegistry, LocalFile as _, LspAdapter,
 12    LspAdapterDelegate, Toolchain,
 13};
 14use lsp::{LanguageServerBinary, LanguageServerName};
 15use node_runtime::{NodeRuntime, VersionStrategy};
 16use project::{Fs, lsp_store::language_server_settings};
 17use serde_json::{Value, json};
 18use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore};
 19use smol::{
 20    fs::{self},
 21    io::BufReader,
 22    lock::RwLock,
 23};
 24use std::{
 25    any::Any,
 26    env::consts,
 27    ffi::OsString,
 28    path::{Path, PathBuf},
 29    str::FromStr,
 30    sync::Arc,
 31};
 32use task::{AdapterSchemas, TaskTemplate, TaskTemplates, VariableName};
 33use util::{ResultExt, archive::extract_zip, fs::remove_matching, maybe, merge_json_value_into};
 34
 35use crate::PackageJsonData;
 36
 37const SERVER_PATH: &str =
 38    "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
 39
 40// Origin: https://github.com/SchemaStore/schemastore
 41const TSCONFIG_SCHEMA: &str = include_str!("json/schemas/tsconfig.json");
 42const PACKAGE_JSON_SCHEMA: &str = include_str!("json/schemas/package.json");
 43
 44pub(crate) struct JsonTaskProvider;
 45
 46impl ContextProvider for JsonTaskProvider {
 47    fn associated_tasks(
 48        &self,
 49        _: Arc<dyn Fs>,
 50        file: Option<Arc<dyn language::File>>,
 51        cx: &App,
 52    ) -> gpui::Task<Option<TaskTemplates>> {
 53        let Some(file) = project::File::from_dyn(file.as_ref()).cloned() else {
 54            return Task::ready(None);
 55        };
 56        let is_package_json = file.path.ends_with("package.json");
 57        let is_composer_json = file.path.ends_with("composer.json");
 58        if !is_package_json && !is_composer_json {
 59            return Task::ready(None);
 60        }
 61
 62        cx.spawn(async move |cx| {
 63            let contents = file
 64                .worktree
 65                .update(cx, |this, cx| this.load_file(&file.path, cx))
 66                .ok()?
 67                .await
 68                .ok()?;
 69            let path = cx.update(|cx| file.abs_path(cx)).ok()?.as_path().into();
 70
 71            let task_templates = if is_package_json {
 72                let package_json = serde_json_lenient::from_str::<
 73                    HashMap<String, serde_json_lenient::Value>,
 74                >(&contents.text)
 75                .ok()?;
 76                let package_json = PackageJsonData::new(path, package_json);
 77                let command = package_json.package_manager.unwrap_or("npm").to_owned();
 78                package_json
 79                    .scripts
 80                    .into_iter()
 81                    .map(|(_, key)| TaskTemplate {
 82                        label: format!("run {key}"),
 83                        command: command.clone(),
 84                        args: vec!["run".into(), key],
 85                        cwd: Some(VariableName::Dirname.template_value()),
 86                        ..TaskTemplate::default()
 87                    })
 88                    .chain([TaskTemplate {
 89                        label: "package script $ZED_CUSTOM_script".to_owned(),
 90                        command: command.clone(),
 91                        args: vec![
 92                            "run".into(),
 93                            VariableName::Custom("script".into()).template_value(),
 94                        ],
 95                        cwd: Some(VariableName::Dirname.template_value()),
 96                        tags: vec!["package-script".into()],
 97                        ..TaskTemplate::default()
 98                    }])
 99                    .collect()
100            } else if is_composer_json {
101                serde_json_lenient::Value::from_str(&contents.text)
102                    .ok()?
103                    .get("scripts")?
104                    .as_object()?
105                    .keys()
106                    .map(|key| TaskTemplate {
107                        label: format!("run {key}"),
108                        command: "composer".to_owned(),
109                        args: vec!["-d".into(), "$ZED_DIRNAME".into(), key.into()],
110                        ..TaskTemplate::default()
111                    })
112                    .chain([TaskTemplate {
113                        label: "composer script $ZED_CUSTOM_script".to_owned(),
114                        command: "composer".to_owned(),
115                        args: vec![
116                            "-d".into(),
117                            "$ZED_DIRNAME".into(),
118                            VariableName::Custom("script".into()).template_value(),
119                        ],
120                        tags: vec!["composer-script".into()],
121                        ..TaskTemplate::default()
122                    }])
123                    .collect()
124            } else {
125                vec![]
126            };
127
128            Some(TaskTemplates(task_templates))
129        })
130    }
131}
132
133fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
134    vec![server_path.into(), "--stdio".into()]
135}
136
137pub struct JsonLspAdapter {
138    node: NodeRuntime,
139    languages: Arc<LanguageRegistry>,
140    workspace_config: RwLock<Option<Value>>,
141}
142
143impl JsonLspAdapter {
144    const PACKAGE_NAME: &str = "vscode-langservers-extracted";
145
146    pub fn new(node: NodeRuntime, languages: Arc<LanguageRegistry>) -> Self {
147        Self {
148            node,
149            languages,
150            workspace_config: Default::default(),
151        }
152    }
153
154    fn get_workspace_config(
155        language_names: Vec<String>,
156        adapter_schemas: AdapterSchemas,
157        cx: &mut App,
158    ) -> Value {
159        let keymap_schema = KeymapFile::generate_json_schema_for_registered_actions(cx);
160        let font_names = &cx.text_system().all_font_names();
161        let settings_schema = cx.global::<SettingsStore>().json_schema(
162            &SettingsJsonSchemaParams {
163                language_names: &language_names,
164                font_names,
165            },
166            cx,
167        );
168
169        let tasks_schema = task::TaskTemplates::generate_json_schema();
170        let debug_schema = task::DebugTaskFile::generate_json_schema(&adapter_schemas);
171        let snippets_schema = snippet_provider::format::VsSnippetsFile::generate_json_schema();
172        let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
173        let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
174
175        #[allow(unused_mut)]
176        let mut schemas = serde_json::json!([
177            {
178                "fileMatch": ["tsconfig.json"],
179                "schema":tsconfig_schema
180            },
181            {
182                "fileMatch": ["package.json"],
183                "schema":package_json_schema
184            },
185            {
186                "fileMatch": [
187                    schema_file_match(paths::settings_file()),
188                    paths::local_settings_file_relative_path()
189                ],
190                "schema": settings_schema,
191            },
192            {
193                "fileMatch": [schema_file_match(paths::keymap_file())],
194                "schema": keymap_schema,
195            },
196            {
197                "fileMatch": [
198                    schema_file_match(paths::tasks_file()),
199                    paths::local_tasks_file_relative_path()
200                ],
201                "schema": tasks_schema,
202            },
203            {
204                "fileMatch": [
205                    schema_file_match(
206                        paths::snippets_dir()
207                            .join("*.json")
208                            .as_path()
209                    )
210                ],
211                "schema": snippets_schema,
212            },
213            {
214                "fileMatch": [
215                    schema_file_match(paths::debug_scenarios_file()),
216                    paths::local_debug_file_relative_path()
217                ],
218                "schema": debug_schema,
219            },
220        ]);
221
222        #[cfg(debug_assertions)]
223        {
224            schemas.as_array_mut().unwrap().push(serde_json::json!(
225                {
226                    "fileMatch": [
227                        "zed-inspector-style.json"
228                    ],
229                    "schema": generate_inspector_style_schema(),
230                }
231            ))
232        }
233
234        schemas
235            .as_array_mut()
236            .unwrap()
237            .extend(cx.all_action_names().iter().map(|&name| {
238                project::lsp_store::json_language_server_ext::url_schema_for_action(name)
239            }));
240
241        // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
242        // `Server Info`
243        serde_json::json!({
244            "json": {
245                "format": {
246                    "enable": true,
247                },
248                "validate":
249                {
250                    "enable": true,
251                },
252                "schemas": schemas
253            }
254        })
255    }
256
257    async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result<Value> {
258        {
259            let reader = self.workspace_config.read().await;
260            if let Some(config) = reader.as_ref() {
261                return Ok(config.clone());
262            }
263        }
264        let mut writer = self.workspace_config.write().await;
265
266        let adapter_schemas = cx
267            .read_global::<DapRegistry, _>(|dap_registry, _| dap_registry.to_owned())?
268            .adapters_schema()
269            .await;
270
271        let config = cx.update(|cx| {
272            Self::get_workspace_config(
273                self.languages
274                    .language_names()
275                    .into_iter()
276                    .map(|name| name.to_string())
277                    .collect(),
278                adapter_schemas,
279                cx,
280            )
281        })?;
282        writer.replace(config.clone());
283        Ok(config)
284    }
285}
286
287#[cfg(debug_assertions)]
288fn generate_inspector_style_schema() -> serde_json_lenient::Value {
289    let schema = schemars::generate::SchemaSettings::draft2019_09()
290        .with_transform(util::schemars::DefaultDenyUnknownFields)
291        .into_generator()
292        .root_schema_for::<gpui::StyleRefinement>();
293
294    serde_json_lenient::to_value(schema).unwrap()
295}
296
297#[async_trait(?Send)]
298impl LspAdapter for JsonLspAdapter {
299    fn name(&self) -> LanguageServerName {
300        LanguageServerName("json-language-server".into())
301    }
302
303    async fn check_if_user_installed(
304        &self,
305        delegate: &dyn LspAdapterDelegate,
306        _: Option<Toolchain>,
307        _: &AsyncApp,
308    ) -> Option<LanguageServerBinary> {
309        let path = delegate
310            .which("vscode-json-language-server".as_ref())
311            .await?;
312        let env = delegate.shell_env().await;
313
314        Some(LanguageServerBinary {
315            path,
316            env: Some(env),
317            arguments: vec!["--stdio".into()],
318        })
319    }
320
321    async fn fetch_latest_server_version(
322        &self,
323        _: &dyn LspAdapterDelegate,
324        _: &AsyncApp,
325    ) -> Result<Box<dyn 'static + Send + Any>> {
326        Ok(Box::new(
327            self.node
328                .npm_package_latest_version(Self::PACKAGE_NAME)
329                .await?,
330        ) as Box<_>)
331    }
332
333    async fn check_if_version_installed(
334        &self,
335        version: &(dyn 'static + Send + Any),
336        container_dir: &PathBuf,
337        _: &dyn LspAdapterDelegate,
338    ) -> Option<LanguageServerBinary> {
339        let version = version.downcast_ref::<String>().unwrap();
340        let server_path = container_dir.join(SERVER_PATH);
341
342        let should_install_language_server = self
343            .node
344            .should_install_npm_package(
345                Self::PACKAGE_NAME,
346                &server_path,
347                container_dir,
348                VersionStrategy::Latest(version),
349            )
350            .await;
351
352        if should_install_language_server {
353            None
354        } else {
355            Some(LanguageServerBinary {
356                path: self.node.binary_path().await.ok()?,
357                env: None,
358                arguments: server_binary_arguments(&server_path),
359            })
360        }
361    }
362
363    async fn fetch_server_binary(
364        &self,
365        latest_version: Box<dyn 'static + Send + Any>,
366        container_dir: PathBuf,
367        _: &dyn LspAdapterDelegate,
368    ) -> Result<LanguageServerBinary> {
369        let latest_version = latest_version.downcast::<String>().unwrap();
370        let server_path = container_dir.join(SERVER_PATH);
371
372        self.node
373            .npm_install_packages(
374                &container_dir,
375                &[(Self::PACKAGE_NAME, latest_version.as_str())],
376            )
377            .await?;
378
379        Ok(LanguageServerBinary {
380            path: self.node.binary_path().await?,
381            env: None,
382            arguments: server_binary_arguments(&server_path),
383        })
384    }
385
386    async fn cached_server_binary(
387        &self,
388        container_dir: PathBuf,
389        _: &dyn LspAdapterDelegate,
390    ) -> Option<LanguageServerBinary> {
391        get_cached_server_binary(container_dir, &self.node).await
392    }
393
394    async fn initialization_options(
395        self: Arc<Self>,
396        _: &dyn Fs,
397        _: &Arc<dyn LspAdapterDelegate>,
398    ) -> Result<Option<serde_json::Value>> {
399        Ok(Some(json!({
400            "provideFormatter": true
401        })))
402    }
403
404    async fn workspace_configuration(
405        self: Arc<Self>,
406        _: &dyn Fs,
407        delegate: &Arc<dyn LspAdapterDelegate>,
408        _: Option<Toolchain>,
409        cx: &mut AsyncApp,
410    ) -> Result<Value> {
411        let mut config = self.get_or_init_workspace_config(cx).await?;
412
413        let project_options = cx.update(|cx| {
414            language_server_settings(delegate.as_ref(), &self.name(), cx)
415                .and_then(|s| s.settings.clone())
416        })?;
417
418        if let Some(override_options) = project_options {
419            merge_json_value_into(override_options, &mut config);
420        }
421
422        Ok(config)
423    }
424
425    fn language_ids(&self) -> HashMap<LanguageName, String> {
426        [
427            (LanguageName::new("JSON"), "json".into()),
428            (LanguageName::new("JSONC"), "jsonc".into()),
429        ]
430        .into_iter()
431        .collect()
432    }
433
434    fn is_primary_zed_json_schema_adapter(&self) -> bool {
435        true
436    }
437
438    async fn clear_zed_json_schema_cache(&self) {
439        self.workspace_config.write().await.take();
440    }
441}
442
443async fn get_cached_server_binary(
444    container_dir: PathBuf,
445    node: &NodeRuntime,
446) -> Option<LanguageServerBinary> {
447    maybe!(async {
448        let mut last_version_dir = None;
449        let mut entries = fs::read_dir(&container_dir).await?;
450        while let Some(entry) = entries.next().await {
451            let entry = entry?;
452            if entry.file_type().await?.is_dir() {
453                last_version_dir = Some(entry.path());
454            }
455        }
456
457        let last_version_dir = last_version_dir.context("no cached binary")?;
458        let server_path = last_version_dir.join(SERVER_PATH);
459        anyhow::ensure!(
460            server_path.exists(),
461            "missing executable in directory {last_version_dir:?}"
462        );
463        Ok(LanguageServerBinary {
464            path: node.binary_path().await?,
465            env: None,
466            arguments: server_binary_arguments(&server_path),
467        })
468    })
469    .await
470    .log_err()
471}
472
473#[inline]
474fn schema_file_match(path: &Path) -> String {
475    path.strip_prefix(path.parent().unwrap().parent().unwrap())
476        .unwrap()
477        .display()
478        .to_string()
479        .replace('\\', "/")
480}
481
482pub struct NodeVersionAdapter;
483
484impl NodeVersionAdapter {
485    const SERVER_NAME: LanguageServerName =
486        LanguageServerName::new_static("package-version-server");
487}
488
489#[async_trait(?Send)]
490impl LspAdapter for NodeVersionAdapter {
491    fn name(&self) -> LanguageServerName {
492        Self::SERVER_NAME
493    }
494
495    async fn fetch_latest_server_version(
496        &self,
497        delegate: &dyn LspAdapterDelegate,
498        _: &AsyncApp,
499    ) -> Result<Box<dyn 'static + Send + Any>> {
500        let release = latest_github_release(
501            "zed-industries/package-version-server",
502            true,
503            false,
504            delegate.http_client(),
505        )
506        .await?;
507        let os = match consts::OS {
508            "macos" => "apple-darwin",
509            "linux" => "unknown-linux-gnu",
510            "windows" => "pc-windows-msvc",
511            other => bail!("Running on unsupported os: {other}"),
512        };
513        let suffix = if consts::OS == "windows" {
514            ".zip"
515        } else {
516            ".tar.gz"
517        };
518        let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
519        let asset = release
520            .assets
521            .iter()
522            .find(|asset| asset.name == asset_name)
523            .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
524        Ok(Box::new(GitHubLspBinaryVersion {
525            name: release.tag_name,
526            url: asset.browser_download_url.clone(),
527            digest: asset.digest.clone(),
528        }))
529    }
530
531    async fn check_if_user_installed(
532        &self,
533        delegate: &dyn LspAdapterDelegate,
534        _: Option<Toolchain>,
535        _: &AsyncApp,
536    ) -> Option<LanguageServerBinary> {
537        let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
538        Some(LanguageServerBinary {
539            path,
540            env: None,
541            arguments: Default::default(),
542        })
543    }
544
545    async fn fetch_server_binary(
546        &self,
547        latest_version: Box<dyn 'static + Send + Any>,
548        container_dir: PathBuf,
549        delegate: &dyn LspAdapterDelegate,
550    ) -> Result<LanguageServerBinary> {
551        let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
552        let destination_path = container_dir.join(format!(
553            "{}-{}{}",
554            Self::SERVER_NAME,
555            version.name,
556            std::env::consts::EXE_SUFFIX
557        ));
558        let destination_container_path =
559            container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
560        if fs::metadata(&destination_path).await.is_err() {
561            let mut response = delegate
562                .http_client()
563                .get(&version.url, Default::default(), true)
564                .await
565                .context("downloading release")?;
566            if version.url.ends_with(".zip") {
567                extract_zip(&destination_container_path, response.body_mut()).await?;
568            } else if version.url.ends_with(".tar.gz") {
569                let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
570                let archive = Archive::new(decompressed_bytes);
571                archive.unpack(&destination_container_path).await?;
572            }
573
574            fs::copy(
575                destination_container_path.join(format!(
576                    "{}{}",
577                    Self::SERVER_NAME,
578                    std::env::consts::EXE_SUFFIX
579                )),
580                &destination_path,
581            )
582            .await?;
583            remove_matching(&container_dir, |entry| entry != destination_path).await;
584        }
585        Ok(LanguageServerBinary {
586            path: destination_path,
587            env: None,
588            arguments: Default::default(),
589        })
590    }
591
592    async fn cached_server_binary(
593        &self,
594        container_dir: PathBuf,
595        _delegate: &dyn LspAdapterDelegate,
596    ) -> Option<LanguageServerBinary> {
597        get_cached_version_server_binary(container_dir).await
598    }
599}
600
601async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
602    maybe!(async {
603        let mut last = None;
604        let mut entries = fs::read_dir(&container_dir).await?;
605        while let Some(entry) = entries.next().await {
606            last = Some(entry?.path());
607        }
608
609        anyhow::Ok(LanguageServerBinary {
610            path: last.context("no cached binary")?,
611            env: None,
612            arguments: Default::default(),
613        })
614    })
615    .await
616    .log_err()
617}