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