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