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