1use anyhow::{Context, Result, anyhow, bail};
2use async_compression::futures::bufread::GzipDecoder;
3use async_tar::Archive;
4use async_trait::async_trait;
5use collections::HashMap;
6use futures::StreamExt;
7use gpui::{App, AsyncApp};
8use http_client::github::{GitHubLspBinaryVersion, latest_github_release};
9use language::{LanguageRegistry, LanguageToolchainStore, LspAdapter, LspAdapterDelegate};
10use lsp::{LanguageServerBinary, LanguageServerName};
11use node_runtime::NodeRuntime;
12use project::{ContextProviderWithTasks, Fs, lsp_store::language_server_settings};
13use serde_json::{Value, json};
14use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore};
15use smol::{
16 fs::{self},
17 io::BufReader,
18 lock::RwLock,
19};
20use std::{
21 any::Any,
22 env::consts,
23 ffi::OsString,
24 path::{Path, PathBuf},
25 str::FromStr,
26 sync::Arc,
27};
28use task::{TaskTemplate, TaskTemplates, VariableName};
29use util::{ResultExt, fs::remove_matching, maybe, merge_json_value_into};
30
31const SERVER_PATH: &str =
32 "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
33
34// Origin: https://github.com/SchemaStore/schemastore
35const TSCONFIG_SCHEMA: &str = include_str!("json/schemas/tsconfig.json");
36const PACKAGE_JSON_SCHEMA: &str = include_str!("json/schemas/package.json");
37
38pub(super) fn json_task_context() -> ContextProviderWithTasks {
39 ContextProviderWithTasks::new(TaskTemplates(vec![
40 TaskTemplate {
41 label: "package script $ZED_CUSTOM_script".to_owned(),
42 command: "npm --prefix $ZED_DIRNAME run".to_owned(),
43 args: vec![VariableName::Custom("script".into()).template_value()],
44 tags: vec!["package-script".into()],
45 ..TaskTemplate::default()
46 },
47 TaskTemplate {
48 label: "composer script $ZED_CUSTOM_script".to_owned(),
49 command: "composer -d $ZED_DIRNAME".to_owned(),
50 args: vec![VariableName::Custom("script".into()).template_value()],
51 tags: vec!["composer-script".into()],
52 ..TaskTemplate::default()
53 },
54 ]))
55}
56
57fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
58 vec![server_path.into(), "--stdio".into()]
59}
60
61pub struct JsonLspAdapter {
62 node: NodeRuntime,
63 languages: Arc<LanguageRegistry>,
64 workspace_config: RwLock<Option<Value>>,
65}
66
67impl JsonLspAdapter {
68 const PACKAGE_NAME: &str = "vscode-langservers-extracted";
69
70 pub fn new(node: NodeRuntime, languages: Arc<LanguageRegistry>) -> Self {
71 Self {
72 node,
73 languages,
74 workspace_config: Default::default(),
75 }
76 }
77
78 fn get_workspace_config(language_names: Vec<String>, cx: &mut App) -> Value {
79 let keymap_schema = KeymapFile::generate_json_schema_for_registered_actions(cx);
80 let font_names = &cx.text_system().all_font_names();
81 let settings_schema = cx.global::<SettingsStore>().json_schema(
82 &SettingsJsonSchemaParams {
83 language_names: &language_names,
84 font_names,
85 },
86 cx,
87 );
88 let tasks_schema = task::TaskTemplates::generate_json_schema();
89 let debug_schema = task::DebugTaskFile::generate_json_schema();
90 let snippets_schema = snippet_provider::format::VsSnippetsFile::generate_json_schema();
91 let tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
92 let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
93
94 // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
95 // `Server Info`
96 serde_json::json!({
97 "json": {
98 "format": {
99 "enable": true,
100 },
101 "validate":
102 {
103 "enable": true,
104 },
105 "schemas": [
106 {
107 "fileMatch": ["tsconfig.json"],
108 "schema":tsconfig_schema
109 },
110 {
111 "fileMatch": ["package.json"],
112 "schema":package_json_schema
113 },
114 {
115 "fileMatch": [
116 schema_file_match(paths::settings_file()),
117 paths::local_settings_file_relative_path()
118 ],
119 "schema": settings_schema,
120 },
121 {
122 "fileMatch": [schema_file_match(paths::keymap_file())],
123 "schema": keymap_schema,
124 },
125 {
126 "fileMatch": [
127 schema_file_match(paths::tasks_file()),
128 paths::local_tasks_file_relative_path()
129 ],
130 "schema": tasks_schema,
131 },
132 {
133 "fileMatch": [
134 schema_file_match(
135 paths::snippets_dir()
136 .join("*.json")
137 .as_path()
138 )
139 ],
140 "schema": snippets_schema,
141 },
142 {
143 "fileMatch": [
144 schema_file_match(paths::debug_scenarios_file()),
145 paths::local_debug_file_relative_path()
146 ],
147 "schema": debug_schema,
148
149 },
150 ]
151 }
152 })
153 }
154
155 async fn get_or_init_workspace_config(&self, cx: &mut AsyncApp) -> Result<Value> {
156 {
157 let reader = self.workspace_config.read().await;
158 if let Some(config) = reader.as_ref() {
159 return Ok(config.clone());
160 }
161 }
162 let mut writer = self.workspace_config.write().await;
163 let config =
164 cx.update(|cx| Self::get_workspace_config(self.languages.language_names(), cx))?;
165 writer.replace(config.clone());
166 return Ok(config);
167 }
168}
169
170#[async_trait(?Send)]
171impl LspAdapter for JsonLspAdapter {
172 fn name(&self) -> LanguageServerName {
173 LanguageServerName("json-language-server".into())
174 }
175
176 async fn check_if_user_installed(
177 &self,
178 delegate: &dyn LspAdapterDelegate,
179 _: Arc<dyn LanguageToolchainStore>,
180 _: &AsyncApp,
181 ) -> Option<LanguageServerBinary> {
182 let path = delegate
183 .which("vscode-json-language-server".as_ref())
184 .await?;
185 let env = delegate.shell_env().await;
186
187 Some(LanguageServerBinary {
188 path,
189 env: Some(env),
190 arguments: vec!["--stdio".into()],
191 })
192 }
193
194 async fn fetch_latest_server_version(
195 &self,
196 _: &dyn LspAdapterDelegate,
197 ) -> Result<Box<dyn 'static + Send + Any>> {
198 Ok(Box::new(
199 self.node
200 .npm_package_latest_version(Self::PACKAGE_NAME)
201 .await?,
202 ) as Box<_>)
203 }
204
205 async fn check_if_version_installed(
206 &self,
207 version: &(dyn 'static + Send + Any),
208 container_dir: &PathBuf,
209 _: &dyn LspAdapterDelegate,
210 ) -> Option<LanguageServerBinary> {
211 let version = version.downcast_ref::<String>().unwrap();
212 let server_path = container_dir.join(SERVER_PATH);
213
214 let should_install_language_server = self
215 .node
216 .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
217 .await;
218
219 if should_install_language_server {
220 None
221 } else {
222 Some(LanguageServerBinary {
223 path: self.node.binary_path().await.ok()?,
224 env: None,
225 arguments: server_binary_arguments(&server_path),
226 })
227 }
228 }
229
230 async fn fetch_server_binary(
231 &self,
232 latest_version: Box<dyn 'static + Send + Any>,
233 container_dir: PathBuf,
234 _: &dyn LspAdapterDelegate,
235 ) -> Result<LanguageServerBinary> {
236 let latest_version = latest_version.downcast::<String>().unwrap();
237 let server_path = container_dir.join(SERVER_PATH);
238
239 self.node
240 .npm_install_packages(
241 &container_dir,
242 &[(Self::PACKAGE_NAME, latest_version.as_str())],
243 )
244 .await?;
245
246 Ok(LanguageServerBinary {
247 path: self.node.binary_path().await?,
248 env: None,
249 arguments: server_binary_arguments(&server_path),
250 })
251 }
252
253 async fn cached_server_binary(
254 &self,
255 container_dir: PathBuf,
256 _: &dyn LspAdapterDelegate,
257 ) -> Option<LanguageServerBinary> {
258 get_cached_server_binary(container_dir, &self.node).await
259 }
260
261 async fn initialization_options(
262 self: Arc<Self>,
263 _: &dyn Fs,
264 _: &Arc<dyn LspAdapterDelegate>,
265 ) -> Result<Option<serde_json::Value>> {
266 Ok(Some(json!({
267 "provideFormatter": true
268 })))
269 }
270
271 async fn workspace_configuration(
272 self: Arc<Self>,
273 _: &dyn Fs,
274 delegate: &Arc<dyn LspAdapterDelegate>,
275 _: Arc<dyn LanguageToolchainStore>,
276 cx: &mut AsyncApp,
277 ) -> Result<Value> {
278 let mut config = self.get_or_init_workspace_config(cx).await?;
279
280 let project_options = cx.update(|cx| {
281 language_server_settings(delegate.as_ref(), &self.name(), cx)
282 .and_then(|s| s.settings.clone())
283 })?;
284
285 if let Some(override_options) = project_options {
286 merge_json_value_into(override_options, &mut config);
287 }
288
289 Ok(config)
290 }
291
292 fn language_ids(&self) -> HashMap<String, String> {
293 [
294 ("JSON".into(), "json".into()),
295 ("JSONC".into(), "jsonc".into()),
296 ]
297 .into_iter()
298 .collect()
299 }
300
301 fn is_primary_zed_json_schema_adapter(&self) -> bool {
302 true
303 }
304
305 async fn clear_zed_json_schema_cache(&self) {
306 self.workspace_config.write().await.take();
307 }
308}
309
310async fn get_cached_server_binary(
311 container_dir: PathBuf,
312 node: &NodeRuntime,
313) -> Option<LanguageServerBinary> {
314 maybe!(async {
315 let mut last_version_dir = None;
316 let mut entries = fs::read_dir(&container_dir).await?;
317 while let Some(entry) = entries.next().await {
318 let entry = entry?;
319 if entry.file_type().await?.is_dir() {
320 last_version_dir = Some(entry.path());
321 }
322 }
323
324 let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
325 let server_path = last_version_dir.join(SERVER_PATH);
326 if server_path.exists() {
327 Ok(LanguageServerBinary {
328 path: node.binary_path().await?,
329 env: None,
330 arguments: server_binary_arguments(&server_path),
331 })
332 } else {
333 Err(anyhow!(
334 "missing executable in directory {:?}",
335 last_version_dir
336 ))
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 .map_err(|err| anyhow!("error downloading release: {}", err))?;
434 if version.url.ends_with(".zip") {
435 node_runtime::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.ok_or_else(|| anyhow!("no cached binary"))?,
492 env: None,
493 arguments: Default::default(),
494 })
495 })
496 .await
497 .log_err()
498}