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