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