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