use anyhow::{Context as _, Result, bail}; use async_compression::futures::bufread::GzipDecoder; use async_tar::Archive; use async_trait::async_trait; use collections::HashMap; use dap::DapRegistry; use futures::StreamExt; use gpui::{App, AsyncApp, Task}; use http_client::github::{GitHubLspBinaryVersion, latest_github_release}; use language::{ ContextProvider, LanguageName, LanguageRegistry, LocalFile as _, LspAdapter, LspAdapterDelegate, Toolchain, }; use lsp::{LanguageServerBinary, LanguageServerName}; use node_runtime::{NodeRuntime, VersionStrategy}; use project::{Fs, lsp_store::language_server_settings}; use serde_json::{Value, json}; use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore}; use smol::{ fs::{self}, io::BufReader, lock::RwLock, }; use std::{ any::Any, env::consts, ffi::OsString, path::{Path, PathBuf}, str::FromStr, sync::Arc, }; use task::{AdapterSchemas, TaskTemplate, TaskTemplates, VariableName}; use util::{ResultExt, archive::extract_zip, fs::remove_matching, maybe, merge_json_value_into}; use crate::PackageJsonData; const SERVER_PATH: &str = "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server"; // Origin: https://github.com/SchemaStore/schemastore const TSCONFIG_SCHEMA: &str = include_str!("json/schemas/tsconfig.json"); const PACKAGE_JSON_SCHEMA: &str = include_str!("json/schemas/package.json"); pub(crate) struct JsonTaskProvider; impl ContextProvider for JsonTaskProvider { fn associated_tasks( &self, _: Arc, file: Option>, cx: &App, ) -> gpui::Task> { let Some(file) = project::File::from_dyn(file.as_ref()).cloned() else { return Task::ready(None); }; let is_package_json = file.path.ends_with("package.json"); let is_composer_json = file.path.ends_with("composer.json"); if !is_package_json && !is_composer_json { return Task::ready(None); } cx.spawn(async move |cx| { let contents = file .worktree .update(cx, |this, cx| this.load_file(&file.path, cx)) .ok()? .await .ok()?; let path = cx.update(|cx| file.abs_path(cx)).ok()?.as_path().into(); let task_templates = if is_package_json { let package_json = serde_json_lenient::from_str::< HashMap, >(&contents.text) .ok()?; let package_json = PackageJsonData::new(path, package_json); let command = package_json.package_manager.unwrap_or("npm").to_owned(); package_json .scripts .into_iter() .map(|(_, key)| TaskTemplate { label: format!("run {key}"), command: command.clone(), args: vec!["run".into(), key], cwd: Some(VariableName::Dirname.template_value()), ..TaskTemplate::default() }) .chain([TaskTemplate { label: "package script $ZED_CUSTOM_script".to_owned(), command: command.clone(), args: vec![ "run".into(), VariableName::Custom("script".into()).template_value(), ], cwd: Some(VariableName::Dirname.template_value()), tags: vec!["package-script".into()], ..TaskTemplate::default() }]) .collect() } else if is_composer_json { serde_json_lenient::Value::from_str(&contents.text) .ok()? .get("scripts")? .as_object()? .keys() .map(|key| TaskTemplate { label: format!("run {key}"), command: "composer".to_owned(), args: vec!["-d".into(), "$ZED_DIRNAME".into(), key.into()], ..TaskTemplate::default() }) .chain([TaskTemplate { label: "composer script $ZED_CUSTOM_script".to_owned(), command: "composer".to_owned(), args: vec![ "-d".into(), "$ZED_DIRNAME".into(), VariableName::Custom("script".into()).template_value(), ], tags: vec!["composer-script".into()], ..TaskTemplate::default() }]) .collect() } else { vec![] }; Some(TaskTemplates(task_templates)) }) } } fn server_binary_arguments(server_path: &Path) -> Vec { vec![server_path.into(), "--stdio".into()] } pub struct JsonLspAdapter { node: NodeRuntime, languages: Arc, workspace_config: RwLock>, } impl JsonLspAdapter { const PACKAGE_NAME: &str = "vscode-langservers-extracted"; pub fn new(node: NodeRuntime, languages: Arc) -> Self { Self { node, languages, workspace_config: Default::default(), } } fn get_workspace_config( language_names: Vec, adapter_schemas: AdapterSchemas, cx: &mut App, ) -> Value { let keymap_schema = KeymapFile::generate_json_schema_for_registered_actions(cx); let font_names = &cx.text_system().all_font_names(); let settings_schema = cx.global::().json_schema( &SettingsJsonSchemaParams { language_names: &language_names, font_names, }, cx, ); let tasks_schema = task::TaskTemplates::generate_json_schema(); let debug_schema = task::DebugTaskFile::generate_json_schema(&adapter_schemas); let snippets_schema = snippet_provider::format::VsSnippetsFile::generate_json_schema(); let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap(); let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap(); #[allow(unused_mut)] let mut schemas = serde_json::json!([ { "fileMatch": ["tsconfig.json"], "schema":tsconfig_schema }, { "fileMatch": ["package.json"], "schema":package_json_schema }, { "fileMatch": [ schema_file_match(paths::settings_file()), paths::local_settings_file_relative_path() ], "schema": settings_schema, }, { "fileMatch": [schema_file_match(paths::keymap_file())], "schema": keymap_schema, }, { "fileMatch": [ schema_file_match(paths::tasks_file()), paths::local_tasks_file_relative_path() ], "schema": tasks_schema, }, { "fileMatch": [ schema_file_match( paths::snippets_dir() .join("*.json") .as_path() ) ], "schema": snippets_schema, }, { "fileMatch": [ schema_file_match(paths::debug_scenarios_file()), paths::local_debug_file_relative_path() ], "schema": debug_schema, }, ]); #[cfg(debug_assertions)] { schemas.as_array_mut().unwrap().push(serde_json::json!( { "fileMatch": [ "zed-inspector-style.json" ], "schema": generate_inspector_style_schema(), } )) } schemas .as_array_mut() .unwrap() .extend(cx.all_action_names().iter().map(|&name| { project::lsp_store::json_language_server_ext::url_schema_for_action(name) })); // This can be viewed via `dev: open language server logs` -> `json-language-server` -> // `Server Info` serde_json::json!({ "json": { "format": { "enable": true, }, "validate": { "enable": true, }, "schemas": schemas } }) } async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result { { let reader = self.workspace_config.read().await; if let Some(config) = reader.as_ref() { return Ok(config.clone()); } } let mut writer = self.workspace_config.write().await; let adapter_schemas = cx .read_global::(|dap_registry, _| dap_registry.to_owned())? .adapters_schema() .await; let config = cx.update(|cx| { Self::get_workspace_config( self.languages .language_names() .into_iter() .map(|name| name.to_string()) .collect(), adapter_schemas, cx, ) })?; writer.replace(config.clone()); Ok(config) } } #[cfg(debug_assertions)] fn generate_inspector_style_schema() -> serde_json_lenient::Value { let schema = schemars::generate::SchemaSettings::draft2019_09() .with_transform(util::schemars::DefaultDenyUnknownFields) .into_generator() .root_schema_for::(); serde_json_lenient::to_value(schema).unwrap() } #[async_trait(?Send)] impl LspAdapter for JsonLspAdapter { fn name(&self) -> LanguageServerName { LanguageServerName("json-language-server".into()) } async fn check_if_user_installed( &self, delegate: &dyn LspAdapterDelegate, _: Option, _: &AsyncApp, ) -> Option { let path = delegate .which("vscode-json-language-server".as_ref()) .await?; let env = delegate.shell_env().await; Some(LanguageServerBinary { path, env: Some(env), arguments: vec!["--stdio".into()], }) } async fn fetch_latest_server_version( &self, _: &dyn LspAdapterDelegate, ) -> Result> { Ok(Box::new( self.node .npm_package_latest_version(Self::PACKAGE_NAME) .await?, ) as Box<_>) } async fn check_if_version_installed( &self, version: &(dyn 'static + Send + Any), container_dir: &PathBuf, _: &dyn LspAdapterDelegate, ) -> Option { let version = version.downcast_ref::().unwrap(); let server_path = container_dir.join(SERVER_PATH); let should_install_language_server = self .node .should_install_npm_package( Self::PACKAGE_NAME, &server_path, container_dir, VersionStrategy::Latest(version), ) .await; if should_install_language_server { None } else { Some(LanguageServerBinary { path: self.node.binary_path().await.ok()?, env: None, arguments: server_binary_arguments(&server_path), }) } } async fn fetch_server_binary( &self, latest_version: Box, container_dir: PathBuf, _: &dyn LspAdapterDelegate, ) -> Result { let latest_version = latest_version.downcast::().unwrap(); let server_path = container_dir.join(SERVER_PATH); self.node .npm_install_packages( &container_dir, &[(Self::PACKAGE_NAME, latest_version.as_str())], ) .await?; Ok(LanguageServerBinary { path: self.node.binary_path().await?, env: None, arguments: server_binary_arguments(&server_path), }) } async fn cached_server_binary( &self, container_dir: PathBuf, _: &dyn LspAdapterDelegate, ) -> Option { get_cached_server_binary(container_dir, &self.node).await } async fn initialization_options( self: Arc, _: &dyn Fs, _: &Arc, ) -> Result> { Ok(Some(json!({ "provideFormatter": true }))) } async fn workspace_configuration( self: Arc, _: &dyn Fs, delegate: &Arc, _: Option, cx: &mut AsyncApp, ) -> Result { let mut config = self.get_or_init_workspace_config(cx).await?; let project_options = cx.update(|cx| { language_server_settings(delegate.as_ref(), &self.name(), cx) .and_then(|s| s.settings.clone()) })?; if let Some(override_options) = project_options { merge_json_value_into(override_options, &mut config); } Ok(config) } fn language_ids(&self) -> HashMap { [ (LanguageName::new("JSON"), "json".into()), (LanguageName::new("JSONC"), "jsonc".into()), ] .into_iter() .collect() } fn is_primary_zed_json_schema_adapter(&self) -> bool { true } async fn clear_zed_json_schema_cache(&self) { self.workspace_config.write().await.take(); } } async fn get_cached_server_binary( container_dir: PathBuf, node: &NodeRuntime, ) -> Option { maybe!(async { let mut last_version_dir = None; let mut entries = fs::read_dir(&container_dir).await?; while let Some(entry) = entries.next().await { let entry = entry?; if entry.file_type().await?.is_dir() { last_version_dir = Some(entry.path()); } } let last_version_dir = last_version_dir.context("no cached binary")?; let server_path = last_version_dir.join(SERVER_PATH); anyhow::ensure!( server_path.exists(), "missing executable in directory {last_version_dir:?}" ); Ok(LanguageServerBinary { path: node.binary_path().await?, env: None, arguments: server_binary_arguments(&server_path), }) }) .await .log_err() } #[inline] fn schema_file_match(path: &Path) -> String { path.strip_prefix(path.parent().unwrap().parent().unwrap()) .unwrap() .display() .to_string() .replace('\\', "/") } pub struct NodeVersionAdapter; impl NodeVersionAdapter { const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("package-version-server"); } #[async_trait(?Send)] impl LspAdapter for NodeVersionAdapter { fn name(&self) -> LanguageServerName { Self::SERVER_NAME } async fn fetch_latest_server_version( &self, delegate: &dyn LspAdapterDelegate, ) -> Result> { let release = latest_github_release( "zed-industries/package-version-server", true, false, delegate.http_client(), ) .await?; let os = match consts::OS { "macos" => "apple-darwin", "linux" => "unknown-linux-gnu", "windows" => "pc-windows-msvc", other => bail!("Running on unsupported os: {other}"), }; let suffix = if consts::OS == "windows" { ".zip" } else { ".tar.gz" }; let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH); let asset = release .assets .iter() .find(|asset| asset.name == asset_name) .with_context(|| format!("no asset found matching `{asset_name:?}`"))?; Ok(Box::new(GitHubLspBinaryVersion { name: release.tag_name, url: asset.browser_download_url.clone(), digest: asset.digest.clone(), })) } async fn check_if_user_installed( &self, delegate: &dyn LspAdapterDelegate, _: Option, _: &AsyncApp, ) -> Option { let path = delegate.which(Self::SERVER_NAME.as_ref()).await?; Some(LanguageServerBinary { path, env: None, arguments: Default::default(), }) } async fn fetch_server_binary( &self, latest_version: Box, container_dir: PathBuf, delegate: &dyn LspAdapterDelegate, ) -> Result { let version = latest_version.downcast::().unwrap(); let destination_path = container_dir.join(format!( "{}-{}{}", Self::SERVER_NAME, version.name, std::env::consts::EXE_SUFFIX )); let destination_container_path = container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name)); if fs::metadata(&destination_path).await.is_err() { let mut response = delegate .http_client() .get(&version.url, Default::default(), true) .await .context("downloading release")?; if version.url.ends_with(".zip") { extract_zip(&destination_container_path, response.body_mut()).await?; } else if version.url.ends_with(".tar.gz") { let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut())); let archive = Archive::new(decompressed_bytes); archive.unpack(&destination_container_path).await?; } fs::copy( destination_container_path.join(format!( "{}{}", Self::SERVER_NAME, std::env::consts::EXE_SUFFIX )), &destination_path, ) .await?; remove_matching(&container_dir, |entry| entry != destination_path).await; } Ok(LanguageServerBinary { path: destination_path, env: None, arguments: Default::default(), }) } async fn cached_server_binary( &self, container_dir: PathBuf, _delegate: &dyn LspAdapterDelegate, ) -> Option { get_cached_version_server_binary(container_dir).await } } async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option { maybe!(async { let mut last = None; let mut entries = fs::read_dir(&container_dir).await?; while let Some(entry) = entries.next().await { last = Some(entry?.path()); } anyhow::Ok(LanguageServerBinary { path: last.context("no cached binary")?, env: None, arguments: Default::default(), }) }) .await .log_err() }