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 futures::StreamExt;
7use gpui::{App, AsyncApp, Entity, Task};
8use http_client::github::{GitHubLspBinaryVersion, latest_github_release};
9use language::{
10 Buffer, ContextProvider, LanguageName, LanguageRegistry, LocalFile as _, LspAdapter,
11 LspAdapterDelegate, LspInstaller, Toolchain,
12};
13use lsp::{LanguageServerBinary, LanguageServerName, Uri};
14use node_runtime::{NodeRuntime, VersionStrategy};
15use project::lsp_store::language_server_settings;
16use semver::Version;
17use serde_json::{Value, json};
18use settings::SettingsLocation;
19use smol::{
20 fs::{self},
21 io::BufReader,
22};
23use std::{
24 borrow::Cow,
25 env::consts,
26 ffi::OsString,
27 path::{Path, PathBuf},
28 str::FromStr,
29 sync::Arc,
30};
31use task::{TaskTemplate, TaskTemplates, VariableName};
32use util::{
33 ResultExt, archive::extract_zip, fs::remove_matching, maybe, merge_json_value_into,
34 paths::PathStyle, rel_path::RelPath,
35};
36
37use crate::PackageJsonData;
38
39const SERVER_PATH: &str =
40 "node_modules/vscode-langservers-extracted/bin/vscode-json-language-server";
41
42pub(crate) struct JsonTaskProvider;
43
44impl ContextProvider for JsonTaskProvider {
45 fn associated_tasks(
46 &self,
47 buffer: Option<Entity<Buffer>>,
48 cx: &App,
49 ) -> gpui::Task<Option<TaskTemplates>> {
50 let file = buffer.as_ref().and_then(|buf| buf.read(cx).file());
51 let Some(file) = project::File::from_dyn(file).cloned() else {
52 return Task::ready(None);
53 };
54 let is_package_json = file.path.ends_with(RelPath::unix("package.json").unwrap());
55 let is_composer_json = file.path.ends_with(RelPath::unix("composer.json").unwrap());
56 if !is_package_json && !is_composer_json {
57 return Task::ready(None);
58 }
59
60 cx.spawn(async move |cx| {
61 let contents = file
62 .worktree
63 .update(cx, |this, cx| this.load_file(&file.path, cx))
64 .await
65 .ok()?;
66 let path = cx.update(|cx| file.abs_path(cx)).as_path().into();
67
68 let task_templates = if is_package_json {
69 let package_json = serde_json_lenient::from_str::<
70 HashMap<String, serde_json_lenient::Value>,
71 >(&contents.text)
72 .ok()?;
73 let package_json = PackageJsonData::new(path, package_json);
74 let command = package_json.package_manager.unwrap_or("npm").to_owned();
75 package_json
76 .scripts
77 .into_iter()
78 .map(|(_, key)| TaskTemplate {
79 label: format!("run {key}"),
80 command: command.clone(),
81 args: vec!["run".into(), key],
82 cwd: Some(VariableName::Dirname.template_value()),
83 ..TaskTemplate::default()
84 })
85 .chain([TaskTemplate {
86 label: "package script $ZED_CUSTOM_script".to_owned(),
87 command: command.clone(),
88 args: vec![
89 "run".into(),
90 VariableName::Custom("script".into()).template_value(),
91 ],
92 cwd: Some(VariableName::Dirname.template_value()),
93 tags: vec!["package-script".into()],
94 ..TaskTemplate::default()
95 }])
96 .collect()
97 } else if is_composer_json {
98 serde_json_lenient::Value::from_str(&contents.text)
99 .ok()?
100 .get("scripts")?
101 .as_object()?
102 .keys()
103 .map(|key| TaskTemplate {
104 label: format!("run {key}"),
105 command: "composer".to_owned(),
106 args: vec!["-d".into(), "$ZED_DIRNAME".into(), key.into()],
107 ..TaskTemplate::default()
108 })
109 .chain([TaskTemplate {
110 label: "composer script $ZED_CUSTOM_script".to_owned(),
111 command: "composer".to_owned(),
112 args: vec![
113 "-d".into(),
114 "$ZED_DIRNAME".into(),
115 VariableName::Custom("script".into()).template_value(),
116 ],
117 tags: vec!["composer-script".into()],
118 ..TaskTemplate::default()
119 }])
120 .collect()
121 } else {
122 vec![]
123 };
124
125 Some(TaskTemplates(task_templates))
126 })
127 }
128}
129
130fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
131 vec![server_path.into(), "--stdio".into()]
132}
133
134pub struct JsonLspAdapter {
135 languages: Arc<LanguageRegistry>,
136 node: NodeRuntime,
137}
138
139impl JsonLspAdapter {
140 const PACKAGE_NAME: &str = "vscode-langservers-extracted";
141
142 pub fn new(languages: Arc<LanguageRegistry>, node: NodeRuntime) -> Self {
143 Self { languages, node }
144 }
145}
146
147impl LspInstaller for JsonLspAdapter {
148 type BinaryVersion = Version;
149
150 async fn fetch_latest_server_version(
151 &self,
152 _: &dyn LspAdapterDelegate,
153 _: bool,
154 _: &mut AsyncApp,
155 ) -> Result<Self::BinaryVersion> {
156 self.node
157 .npm_package_latest_version(Self::PACKAGE_NAME)
158 .await
159 }
160
161 async fn check_if_user_installed(
162 &self,
163 delegate: &dyn LspAdapterDelegate,
164 _: Option<Toolchain>,
165 _: &AsyncApp,
166 ) -> Option<LanguageServerBinary> {
167 let path = delegate
168 .which("vscode-json-language-server".as_ref())
169 .await?;
170 let env = delegate.shell_env().await;
171
172 Some(LanguageServerBinary {
173 path,
174 env: Some(env),
175 arguments: vec!["--stdio".into()],
176 })
177 }
178
179 async fn check_if_version_installed(
180 &self,
181 version: &Self::BinaryVersion,
182 container_dir: &PathBuf,
183 _: &dyn LspAdapterDelegate,
184 ) -> Option<LanguageServerBinary> {
185 let server_path = container_dir.join(SERVER_PATH);
186
187 let should_install_language_server = self
188 .node
189 .should_install_npm_package(
190 Self::PACKAGE_NAME,
191 &server_path,
192 container_dir,
193 VersionStrategy::Latest(version),
194 )
195 .await;
196
197 if should_install_language_server {
198 None
199 } else {
200 Some(LanguageServerBinary {
201 path: self.node.binary_path().await.ok()?,
202 env: None,
203 arguments: server_binary_arguments(&server_path),
204 })
205 }
206 }
207
208 async fn fetch_server_binary(
209 &self,
210 latest_version: Self::BinaryVersion,
211 container_dir: PathBuf,
212 _: &dyn LspAdapterDelegate,
213 ) -> Result<LanguageServerBinary> {
214 let server_path = container_dir.join(SERVER_PATH);
215 let latest_version = latest_version.to_string();
216
217 self.node
218 .npm_install_packages(
219 &container_dir,
220 &[(Self::PACKAGE_NAME, latest_version.as_str())],
221 )
222 .await?;
223
224 Ok(LanguageServerBinary {
225 path: self.node.binary_path().await?,
226 env: None,
227 arguments: server_binary_arguments(&server_path),
228 })
229 }
230
231 async fn cached_server_binary(
232 &self,
233 container_dir: PathBuf,
234 _: &dyn LspAdapterDelegate,
235 ) -> Option<LanguageServerBinary> {
236 get_cached_server_binary(container_dir, &self.node).await
237 }
238}
239
240#[async_trait(?Send)]
241impl LspAdapter for JsonLspAdapter {
242 fn name(&self) -> LanguageServerName {
243 LanguageServerName("json-language-server".into())
244 }
245
246 async fn initialization_options(
247 self: Arc<Self>,
248 _: &Arc<dyn LspAdapterDelegate>,
249 _: &mut AsyncApp,
250 ) -> Result<Option<serde_json::Value>> {
251 Ok(Some(json!({
252 "provideFormatter": true
253 })))
254 }
255
256 async fn workspace_configuration(
257 self: Arc<Self>,
258 delegate: &Arc<dyn LspAdapterDelegate>,
259 _: Option<Toolchain>,
260 requested_uri: Option<Uri>,
261 cx: &mut AsyncApp,
262 ) -> Result<Value> {
263 let requested_path = requested_uri.as_ref().and_then(|uri| {
264 (uri.scheme() == "file")
265 .then(|| uri.to_file_path().ok())
266 .flatten()
267 });
268 let path_in_worktree = requested_path
269 .as_ref()
270 .and_then(|abs_path| {
271 let rel_path = abs_path.strip_prefix(delegate.worktree_root_path()).ok()?;
272 RelPath::new(rel_path, PathStyle::local()).ok()
273 })
274 .unwrap_or_else(|| Cow::Borrowed(RelPath::empty()));
275 let mut config = cx.update(|cx| {
276 let schemas = json_schema_store::all_schema_file_associations(
277 &self.languages,
278 Some(SettingsLocation {
279 worktree_id: delegate.worktree_id(),
280 path: path_in_worktree.as_ref(),
281 }),
282 cx,
283 );
284
285 // This can be viewed via `dev: open language server logs` -> `json-language-server` ->
286 // `Server Info`
287 serde_json::json!({
288 "json": {
289 "format": {
290 "enable": true,
291 },
292 "validate": {
293 "enable": true,
294 },
295 "schemas": schemas
296 }
297 })
298 });
299 let project_options = cx.update(|cx| {
300 language_server_settings(delegate.as_ref(), &self.name(), cx)
301 .and_then(|s| worktree_root(delegate, s.settings.clone()))
302 });
303
304 if let Some(override_options) = project_options {
305 merge_json_value_into(override_options, &mut config);
306 }
307
308 Ok(config)
309 }
310
311 fn language_ids(&self) -> HashMap<LanguageName, String> {
312 [
313 (LanguageName::new_static("JSON"), "json".into()),
314 (LanguageName::new_static("JSONC"), "jsonc".into()),
315 ]
316 .into_iter()
317 .collect()
318 }
319
320 fn is_primary_zed_json_schema_adapter(&self) -> bool {
321 true
322 }
323}
324
325fn worktree_root(delegate: &Arc<dyn LspAdapterDelegate>, settings: Option<Value>) -> Option<Value> {
326 let Some(Value::Object(mut settings_map)) = settings else {
327 return settings;
328 };
329
330 let Some(Value::Object(json_config)) = settings_map.get_mut("json") else {
331 return Some(Value::Object(settings_map));
332 };
333
334 let Some(Value::Array(schemas)) = json_config.get_mut("schemas") else {
335 return Some(Value::Object(settings_map));
336 };
337
338 for schema in schemas.iter_mut() {
339 let Value::Object(schema_map) = schema else {
340 continue;
341 };
342 let Some(Value::String(url)) = schema_map.get_mut("url") else {
343 continue;
344 };
345
346 if !url.starts_with(".") && !url.starts_with("~") {
347 continue;
348 }
349
350 *url = delegate
351 .resolve_relative_path(url.clone().into())
352 .to_string_lossy()
353 .into_owned();
354 }
355
356 Some(Value::Object(settings_map))
357}
358
359async fn get_cached_server_binary(
360 container_dir: PathBuf,
361 node: &NodeRuntime,
362) -> Option<LanguageServerBinary> {
363 maybe!(async {
364 let server_path = container_dir.join(SERVER_PATH);
365 anyhow::ensure!(
366 server_path.exists(),
367 "missing executable in directory {server_path:?}"
368 );
369 Ok(LanguageServerBinary {
370 path: node.binary_path().await?,
371 env: None,
372 arguments: server_binary_arguments(&server_path),
373 })
374 })
375 .await
376 .log_err()
377}
378
379pub struct NodeVersionAdapter;
380
381impl NodeVersionAdapter {
382 const SERVER_NAME: LanguageServerName =
383 LanguageServerName::new_static("package-version-server");
384}
385
386impl LspInstaller for NodeVersionAdapter {
387 type BinaryVersion = GitHubLspBinaryVersion;
388
389 async fn fetch_latest_server_version(
390 &self,
391 delegate: &dyn LspAdapterDelegate,
392 _: bool,
393 _: &mut AsyncApp,
394 ) -> Result<GitHubLspBinaryVersion> {
395 let release = latest_github_release(
396 "zed-industries/package-version-server",
397 true,
398 false,
399 delegate.http_client(),
400 )
401 .await?;
402 let os = match consts::OS {
403 "macos" => "apple-darwin",
404 "linux" => "unknown-linux-gnu",
405 "windows" => "pc-windows-msvc",
406 other => bail!("Running on unsupported os: {other}"),
407 };
408 let suffix = if consts::OS == "windows" {
409 ".zip"
410 } else {
411 ".tar.gz"
412 };
413 let asset_name = format!("{}-{}-{os}{suffix}", Self::SERVER_NAME, consts::ARCH);
414 let asset = release
415 .assets
416 .iter()
417 .find(|asset| asset.name == asset_name)
418 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
419 Ok(GitHubLspBinaryVersion {
420 name: release.tag_name,
421 url: asset.browser_download_url.clone(),
422 digest: asset.digest.clone(),
423 })
424 }
425
426 async fn check_if_user_installed(
427 &self,
428 delegate: &dyn LspAdapterDelegate,
429 _: Option<Toolchain>,
430 _: &AsyncApp,
431 ) -> Option<LanguageServerBinary> {
432 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
433 Some(LanguageServerBinary {
434 path,
435 env: None,
436 arguments: Default::default(),
437 })
438 }
439
440 async fn fetch_server_binary(
441 &self,
442 latest_version: GitHubLspBinaryVersion,
443 container_dir: PathBuf,
444 delegate: &dyn LspAdapterDelegate,
445 ) -> Result<LanguageServerBinary> {
446 let version = &latest_version;
447 let destination_path = container_dir.join(format!(
448 "{}-{}{}",
449 Self::SERVER_NAME,
450 version.name,
451 std::env::consts::EXE_SUFFIX
452 ));
453 let destination_container_path =
454 container_dir.join(format!("{}-{}-tmp", Self::SERVER_NAME, version.name));
455 if fs::metadata(&destination_path).await.is_err() {
456 let mut response = delegate
457 .http_client()
458 .get(&version.url, Default::default(), true)
459 .await
460 .context("downloading release")?;
461 if version.url.ends_with(".zip") {
462 extract_zip(&destination_container_path, response.body_mut()).await?;
463 } else if version.url.ends_with(".tar.gz") {
464 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
465 let archive = Archive::new(decompressed_bytes);
466 archive.unpack(&destination_container_path).await?;
467 }
468
469 fs::copy(
470 destination_container_path.join(format!(
471 "{}{}",
472 Self::SERVER_NAME,
473 std::env::consts::EXE_SUFFIX
474 )),
475 &destination_path,
476 )
477 .await?;
478 remove_matching(&container_dir, |entry| entry != destination_path).await;
479 }
480 Ok(LanguageServerBinary {
481 path: destination_path,
482 env: None,
483 arguments: Default::default(),
484 })
485 }
486
487 async fn cached_server_binary(
488 &self,
489 container_dir: PathBuf,
490 _delegate: &dyn LspAdapterDelegate,
491 ) -> Option<LanguageServerBinary> {
492 get_cached_version_server_binary(container_dir).await
493 }
494}
495
496#[async_trait(?Send)]
497impl LspAdapter for NodeVersionAdapter {
498 fn name(&self) -> LanguageServerName {
499 Self::SERVER_NAME
500 }
501}
502
503async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
504 maybe!(async {
505 let mut last = None;
506 let mut entries = fs::read_dir(&container_dir).await?;
507 while let Some(entry) = entries.next().await {
508 last = Some(entry?.path());
509 }
510
511 anyhow::Ok(LanguageServerBinary {
512 path: last.context("no cached binary")?,
513 env: None,
514 arguments: Default::default(),
515 })
516 })
517 .await
518 .log_err()
519}