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, LocalFile as _, LspAdapter,
12 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 // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
235 // `Server Info`
236 serde_json::json!({
237 "json": {
238 "format": {
239 "enable": true,
240 },
241 "validate":
242 {
243 "enable": true,
244 },
245 "schemas": schemas
246 }
247 })
248 }
249
250 async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result<Value> {
251 {
252 let reader = self.workspace_config.read().await;
253 if let Some(config) = reader.as_ref() {
254 return Ok(config.clone());
255 }
256 }
257 let mut writer = self.workspace_config.write().await;
258
259 let adapter_schemas = cx
260 .read_global::<DapRegistry, _>(|dap_registry, _| dap_registry.to_owned())?
261 .adapters_schema()
262 .await;
263
264 let config = cx.update(|cx| {
265 Self::get_workspace_config(self.languages.language_names().clone(), adapter_schemas, cx)
266 })?;
267 writer.replace(config.clone());
268 return Ok(config);
269 }
270}
271
272#[cfg(debug_assertions)]
273fn generate_inspector_style_schema() -> serde_json_lenient::Value {
274 let schema = schemars::generate::SchemaSettings::draft2019_09()
275 .with_transform(util::schemars::DefaultDenyUnknownFields)
276 .into_generator()
277 .root_schema_for::<gpui::StyleRefinement>();
278
279 serde_json_lenient::to_value(schema).unwrap()
280}
281
282#[async_trait(?Send)]
283impl LspAdapter for JsonLspAdapter {
284 fn name(&self) -> LanguageServerName {
285 LanguageServerName("json-language-server".into())
286 }
287
288 async fn check_if_user_installed(
289 &self,
290 delegate: &dyn LspAdapterDelegate,
291 _: Arc<dyn LanguageToolchainStore>,
292 _: &AsyncApp,
293 ) -> Option<LanguageServerBinary> {
294 let path = delegate
295 .which("vscode-json-language-server".as_ref())
296 .await?;
297 let env = delegate.shell_env().await;
298
299 Some(LanguageServerBinary {
300 path,
301 env: Some(env),
302 arguments: vec!["--stdio".into()],
303 })
304 }
305
306 async fn fetch_latest_server_version(
307 &self,
308 _: &dyn LspAdapterDelegate,
309 ) -> Result<Box<dyn 'static + Send + Any>> {
310 Ok(Box::new(
311 self.node
312 .npm_package_latest_version(Self::PACKAGE_NAME)
313 .await?,
314 ) as Box<_>)
315 }
316
317 async fn check_if_version_installed(
318 &self,
319 version: &(dyn 'static + Send + Any),
320 container_dir: &PathBuf,
321 _: &dyn LspAdapterDelegate,
322 ) -> Option<LanguageServerBinary> {
323 let version = version.downcast_ref::<String>().unwrap();
324 let server_path = container_dir.join(SERVER_PATH);
325
326 let should_install_language_server = self
327 .node
328 .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
329 .await;
330
331 if should_install_language_server {
332 None
333 } else {
334 Some(LanguageServerBinary {
335 path: self.node.binary_path().await.ok()?,
336 env: None,
337 arguments: server_binary_arguments(&server_path),
338 })
339 }
340 }
341
342 async fn fetch_server_binary(
343 &self,
344 latest_version: Box<dyn 'static + Send + Any>,
345 container_dir: PathBuf,
346 _: &dyn LspAdapterDelegate,
347 ) -> Result<LanguageServerBinary> {
348 let latest_version = latest_version.downcast::<String>().unwrap();
349 let server_path = container_dir.join(SERVER_PATH);
350
351 self.node
352 .npm_install_packages(
353 &container_dir,
354 &[(Self::PACKAGE_NAME, latest_version.as_str())],
355 )
356 .await?;
357
358 Ok(LanguageServerBinary {
359 path: self.node.binary_path().await?,
360 env: None,
361 arguments: server_binary_arguments(&server_path),
362 })
363 }
364
365 async fn cached_server_binary(
366 &self,
367 container_dir: PathBuf,
368 _: &dyn LspAdapterDelegate,
369 ) -> Option<LanguageServerBinary> {
370 get_cached_server_binary(container_dir, &self.node).await
371 }
372
373 async fn initialization_options(
374 self: Arc<Self>,
375 _: &dyn Fs,
376 _: &Arc<dyn LspAdapterDelegate>,
377 ) -> Result<Option<serde_json::Value>> {
378 Ok(Some(json!({
379 "provideFormatter": true
380 })))
381 }
382
383 async fn workspace_configuration(
384 self: Arc<Self>,
385 _: &dyn Fs,
386 delegate: &Arc<dyn LspAdapterDelegate>,
387 _: Arc<dyn LanguageToolchainStore>,
388 cx: &mut AsyncApp,
389 ) -> Result<Value> {
390 let mut config = self.get_or_init_workspace_config(cx).await?;
391
392 let project_options = cx.update(|cx| {
393 language_server_settings(delegate.as_ref(), &self.name(), cx)
394 .and_then(|s| s.settings.clone())
395 })?;
396
397 if let Some(override_options) = project_options {
398 merge_json_value_into(override_options, &mut config);
399 }
400
401 Ok(config)
402 }
403
404 fn language_ids(&self) -> HashMap<String, String> {
405 [
406 ("JSON".into(), "json".into()),
407 ("JSONC".into(), "jsonc".into()),
408 ]
409 .into_iter()
410 .collect()
411 }
412
413 fn is_primary_zed_json_schema_adapter(&self) -> bool {
414 true
415 }
416
417 async fn clear_zed_json_schema_cache(&self) {
418 self.workspace_config.write().await.take();
419 }
420}
421
422async fn get_cached_server_binary(
423 container_dir: PathBuf,
424 node: &NodeRuntime,
425) -> Option<LanguageServerBinary> {
426 maybe!(async {
427 let mut last_version_dir = None;
428 let mut entries = fs::read_dir(&container_dir).await?;
429 while let Some(entry) = entries.next().await {
430 let entry = entry?;
431 if entry.file_type().await?.is_dir() {
432 last_version_dir = Some(entry.path());
433 }
434 }
435
436 let last_version_dir = last_version_dir.context("no cached binary")?;
437 let server_path = last_version_dir.join(SERVER_PATH);
438 anyhow::ensure!(
439 server_path.exists(),
440 "missing executable in directory {last_version_dir:?}"
441 );
442 Ok(LanguageServerBinary {
443 path: node.binary_path().await?,
444 env: None,
445 arguments: server_binary_arguments(&server_path),
446 })
447 })
448 .await
449 .log_err()
450}
451
452#[inline]
453fn schema_file_match(path: &Path) -> String {
454 path.strip_prefix(path.parent().unwrap().parent().unwrap())
455 .unwrap()
456 .display()
457 .to_string()
458 .replace('\\', "/")
459}
460
461pub struct NodeVersionAdapter;
462
463impl NodeVersionAdapter {
464 const SERVER_NAME: LanguageServerName =
465 LanguageServerName::new_static("package-version-server");
466}
467
468#[async_trait(?Send)]
469impl LspAdapter for NodeVersionAdapter {
470 fn name(&self) -> LanguageServerName {
471 Self::SERVER_NAME.clone()
472 }
473
474 async fn fetch_latest_server_version(
475 &self,
476 delegate: &dyn LspAdapterDelegate,
477 ) -> Result<Box<dyn 'static + Send + Any>> {
478 let release = latest_github_release(
479 "zed-industries/package-version-server",
480 true,
481 false,
482 delegate.http_client(),
483 )
484 .await?;
485 let os = match consts::OS {
486 "macos" => "apple-darwin",
487 "linux" => "unknown-linux-gnu",
488 "windows" => "pc-windows-msvc",
489 other => bail!("Running on unsupported os: {other}"),
490 };
491 let suffix = if consts::OS == "windows" {
492 ".zip"
493 } else {
494 ".tar.gz"
495 };
496 let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
497 let asset = release
498 .assets
499 .iter()
500 .find(|asset| asset.name == asset_name)
501 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
502 Ok(Box::new(GitHubLspBinaryVersion {
503 name: release.tag_name,
504 url: asset.browser_download_url.clone(),
505 }))
506 }
507
508 async fn check_if_user_installed(
509 &self,
510 delegate: &dyn LspAdapterDelegate,
511 _: Arc<dyn LanguageToolchainStore>,
512 _: &AsyncApp,
513 ) -> Option<LanguageServerBinary> {
514 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
515 Some(LanguageServerBinary {
516 path,
517 env: None,
518 arguments: Default::default(),
519 })
520 }
521
522 async fn fetch_server_binary(
523 &self,
524 latest_version: Box<dyn 'static + Send + Any>,
525 container_dir: PathBuf,
526 delegate: &dyn LspAdapterDelegate,
527 ) -> Result<LanguageServerBinary> {
528 let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
529 let destination_path = container_dir.join(format!(
530 "{}-{}{}",
531 Self::SERVER_NAME,
532 version.name,
533 std::env::consts::EXE_SUFFIX
534 ));
535 let destination_container_path =
536 container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
537 if fs::metadata(&destination_path).await.is_err() {
538 let mut response = delegate
539 .http_client()
540 .get(&version.url, Default::default(), true)
541 .await
542 .context("downloading release")?;
543 if version.url.ends_with(".zip") {
544 extract_zip(&destination_container_path, response.body_mut()).await?;
545 } else if version.url.ends_with(".tar.gz") {
546 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
547 let archive = Archive::new(decompressed_bytes);
548 archive.unpack(&destination_container_path).await?;
549 }
550
551 fs::copy(
552 destination_container_path.join(format!(
553 "{}{}",
554 Self::SERVER_NAME,
555 std::env::consts::EXE_SUFFIX
556 )),
557 &destination_path,
558 )
559 .await?;
560 remove_matching(&container_dir, |entry| entry != destination_path).await;
561 }
562 Ok(LanguageServerBinary {
563 path: destination_path,
564 env: None,
565 arguments: Default::default(),
566 })
567 }
568
569 async fn cached_server_binary(
570 &self,
571 container_dir: PathBuf,
572 _delegate: &dyn LspAdapterDelegate,
573 ) -> Option<LanguageServerBinary> {
574 get_cached_version_server_binary(container_dir).await
575 }
576}
577
578async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
579 maybe!(async {
580 let mut last = None;
581 let mut entries = fs::read_dir(&container_dir).await?;
582 while let Some(entry) = entries.next().await {
583 last = Some(entry?.path());
584 }
585
586 anyhow::Ok(LanguageServerBinary {
587 path: last.context("no cached binary")?,
588 env: None,
589 arguments: Default::default(),
590 })
591 })
592 .await
593 .log_err()
594}