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, LanguageToolchainStore, LocalFile as _,
12 LspAdapter, LspAdapterDelegate,
13};
14use lsp::{LanguageServerBinary, LanguageServerName};
15use node_runtime::NodeRuntime;
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().into_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 return 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 _: Arc<dyn LanguageToolchainStore>,
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 ) -> Result<Box<dyn 'static + Send + Any>> {
325 Ok(Box::new(
326 self.node
327 .npm_package_latest_version(Self::PACKAGE_NAME)
328 .await?,
329 ) as Box<_>)
330 }
331
332 async fn check_if_version_installed(
333 &self,
334 version: &(dyn 'static + Send + Any),
335 container_dir: &PathBuf,
336 _: &dyn LspAdapterDelegate,
337 ) -> Option<LanguageServerBinary> {
338 let version = version.downcast_ref::<String>().unwrap();
339 let server_path = container_dir.join(SERVER_PATH);
340
341 let should_install_language_server = self
342 .node
343 .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
344 .await;
345
346 if should_install_language_server {
347 None
348 } else {
349 Some(LanguageServerBinary {
350 path: self.node.binary_path().await.ok()?,
351 env: None,
352 arguments: server_binary_arguments(&server_path),
353 })
354 }
355 }
356
357 async fn fetch_server_binary(
358 &self,
359 latest_version: Box<dyn 'static + Send + Any>,
360 container_dir: PathBuf,
361 _: &dyn LspAdapterDelegate,
362 ) -> Result<LanguageServerBinary> {
363 let latest_version = latest_version.downcast::<String>().unwrap();
364 let server_path = container_dir.join(SERVER_PATH);
365
366 self.node
367 .npm_install_packages(
368 &container_dir,
369 &[(Self::PACKAGE_NAME, latest_version.as_str())],
370 )
371 .await?;
372
373 Ok(LanguageServerBinary {
374 path: self.node.binary_path().await?,
375 env: None,
376 arguments: server_binary_arguments(&server_path),
377 })
378 }
379
380 async fn cached_server_binary(
381 &self,
382 container_dir: PathBuf,
383 _: &dyn LspAdapterDelegate,
384 ) -> Option<LanguageServerBinary> {
385 get_cached_server_binary(container_dir, &self.node).await
386 }
387
388 async fn initialization_options(
389 self: Arc<Self>,
390 _: &dyn Fs,
391 _: &Arc<dyn LspAdapterDelegate>,
392 ) -> Result<Option<serde_json::Value>> {
393 Ok(Some(json!({
394 "provideFormatter": true
395 })))
396 }
397
398 async fn workspace_configuration(
399 self: Arc<Self>,
400 _: &dyn Fs,
401 delegate: &Arc<dyn LspAdapterDelegate>,
402 _: Arc<dyn LanguageToolchainStore>,
403 cx: &mut AsyncApp,
404 ) -> Result<Value> {
405 let mut config = self.get_or_init_workspace_config(cx).await?;
406
407 let project_options = cx.update(|cx| {
408 language_server_settings(delegate.as_ref(), &self.name(), cx)
409 .and_then(|s| s.settings.clone())
410 })?;
411
412 if let Some(override_options) = project_options {
413 merge_json_value_into(override_options, &mut config);
414 }
415
416 Ok(config)
417 }
418
419 fn language_ids(&self) -> HashMap<LanguageName, String> {
420 [
421 (LanguageName::new("JSON"), "json".into()),
422 (LanguageName::new("JSONC"), "jsonc".into()),
423 ]
424 .into_iter()
425 .collect()
426 }
427
428 fn is_primary_zed_json_schema_adapter(&self) -> bool {
429 true
430 }
431
432 async fn clear_zed_json_schema_cache(&self) {
433 self.workspace_config.write().await.take();
434 }
435}
436
437async fn get_cached_server_binary(
438 container_dir: PathBuf,
439 node: &NodeRuntime,
440) -> Option<LanguageServerBinary> {
441 maybe!(async {
442 let mut last_version_dir = None;
443 let mut entries = fs::read_dir(&container_dir).await?;
444 while let Some(entry) = entries.next().await {
445 let entry = entry?;
446 if entry.file_type().await?.is_dir() {
447 last_version_dir = Some(entry.path());
448 }
449 }
450
451 let last_version_dir = last_version_dir.context("no cached binary")?;
452 let server_path = last_version_dir.join(SERVER_PATH);
453 anyhow::ensure!(
454 server_path.exists(),
455 "missing executable in directory {last_version_dir:?}"
456 );
457 Ok(LanguageServerBinary {
458 path: node.binary_path().await?,
459 env: None,
460 arguments: server_binary_arguments(&server_path),
461 })
462 })
463 .await
464 .log_err()
465}
466
467#[inline]
468fn schema_file_match(path: &Path) -> String {
469 path.strip_prefix(path.parent().unwrap().parent().unwrap())
470 .unwrap()
471 .display()
472 .to_string()
473 .replace('\\', "/")
474}
475
476pub struct NodeVersionAdapter;
477
478impl NodeVersionAdapter {
479 const SERVER_NAME: LanguageServerName =
480 LanguageServerName::new_static("package-version-server");
481}
482
483#[async_trait(?Send)]
484impl LspAdapter for NodeVersionAdapter {
485 fn name(&self) -> LanguageServerName {
486 Self::SERVER_NAME.clone()
487 }
488
489 async fn fetch_latest_server_version(
490 &self,
491 delegate: &dyn LspAdapterDelegate,
492 ) -> Result<Box<dyn 'static + Send + Any>> {
493 let release = latest_github_release(
494 "zed-industries/package-version-server",
495 true,
496 false,
497 delegate.http_client(),
498 )
499 .await?;
500 let os = match consts::OS {
501 "macos" => "apple-darwin",
502 "linux" => "unknown-linux-gnu",
503 "windows" => "pc-windows-msvc",
504 other => bail!("Running on unsupported os: {other}"),
505 };
506 let suffix = if consts::OS == "windows" {
507 ".zip"
508 } else {
509 ".tar.gz"
510 };
511 let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
512 let asset = release
513 .assets
514 .iter()
515 .find(|asset| asset.name == asset_name)
516 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
517 Ok(Box::new(GitHubLspBinaryVersion {
518 name: release.tag_name,
519 url: asset.browser_download_url.clone(),
520 }))
521 }
522
523 async fn check_if_user_installed(
524 &self,
525 delegate: &dyn LspAdapterDelegate,
526 _: Arc<dyn LanguageToolchainStore>,
527 _: &AsyncApp,
528 ) -> Option<LanguageServerBinary> {
529 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
530 Some(LanguageServerBinary {
531 path,
532 env: None,
533 arguments: Default::default(),
534 })
535 }
536
537 async fn fetch_server_binary(
538 &self,
539 latest_version: Box<dyn 'static + Send + Any>,
540 container_dir: PathBuf,
541 delegate: &dyn LspAdapterDelegate,
542 ) -> Result<LanguageServerBinary> {
543 let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
544 let destination_path = container_dir.join(format!(
545 "{}-{}{}",
546 Self::SERVER_NAME,
547 version.name,
548 std::env::consts::EXE_SUFFIX
549 ));
550 let destination_container_path =
551 container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
552 if fs::metadata(&destination_path).await.is_err() {
553 let mut response = delegate
554 .http_client()
555 .get(&version.url, Default::default(), true)
556 .await
557 .context("downloading release")?;
558 if version.url.ends_with(".zip") {
559 extract_zip(&destination_container_path, response.body_mut()).await?;
560 } else if version.url.ends_with(".tar.gz") {
561 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
562 let archive = Archive::new(decompressed_bytes);
563 archive.unpack(&destination_container_path).await?;
564 }
565
566 fs::copy(
567 destination_container_path.join(format!(
568 "{}{}",
569 Self::SERVER_NAME,
570 std::env::consts::EXE_SUFFIX
571 )),
572 &destination_path,
573 )
574 .await?;
575 remove_matching(&container_dir, |entry| entry != destination_path).await;
576 }
577 Ok(LanguageServerBinary {
578 path: destination_path,
579 env: None,
580 arguments: Default::default(),
581 })
582 }
583
584 async fn cached_server_binary(
585 &self,
586 container_dir: PathBuf,
587 _delegate: &dyn LspAdapterDelegate,
588 ) -> Option<LanguageServerBinary> {
589 get_cached_version_server_binary(container_dir).await
590 }
591}
592
593async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
594 maybe!(async {
595 let mut last = None;
596 let mut entries = fs::read_dir(&container_dir).await?;
597 while let Some(entry) = entries.next().await {
598 last = Some(entry?.path());
599 }
600
601 anyhow::Ok(LanguageServerBinary {
602 path: last.context("no cached binary")?,
603 env: None,
604 arguments: Default::default(),
605 })
606 })
607 .await
608 .log_err()
609}