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