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::{AppContext, AsyncAppContext};
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};
13use schemars::gen::SchemaSettings;
14use serde_json::{json, Value};
15use settings::{KeymapFile, SettingsJsonSchemaParams, SettingsStore};
16use smol::{
17 fs::{self},
18 io::BufReader,
19};
20use std::{
21 any::Any,
22 env::consts,
23 ffi::OsString,
24 path::{Path, PathBuf},
25 str::FromStr,
26 sync::{Arc, OnceLock},
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: OnceLock<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 AppContext) -> Value {
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 tsconfig_schema = serde_json::Value::from_str(TSCONFIG_SCHEMA).unwrap();
89 let package_json_schema = serde_json::Value::from_str(PACKAGE_JSON_SCHEMA).unwrap();
90
91 serde_json::json!({
92 "json": {
93 "format": {
94 "enable": true,
95 },
96 "validate":
97 {
98 "enable": true,
99 },
100 "schemas": [
101 {
102 "fileMatch": ["tsconfig.json"],
103 "schema":tsconfig_schema
104 },
105 {
106 "fileMatch": ["package.json"],
107 "schema":package_json_schema
108 },
109 {
110 "fileMatch": [
111 schema_file_match(paths::settings_file()),
112 paths::local_settings_file_relative_path()
113 ],
114 "schema": settings_schema,
115 },
116 {
117 "fileMatch": [schema_file_match(paths::keymap_file())],
118 "schema": Self::generate_keymap_schema(cx),
119 },
120 {
121 "fileMatch": [
122 schema_file_match(paths::tasks_file()),
123 paths::local_tasks_file_relative_path()
124 ],
125 "schema": tasks_schema,
126 }
127
128 ]
129 }
130 })
131 }
132
133 fn generate_keymap_schema(cx: &mut AppContext) -> Value {
134 let mut generator = SchemaSettings::draft07()
135 .with(|settings| settings.option_add_null_type = false)
136 .into_generator();
137
138 let action_schemas = cx.action_schemas(&mut generator);
139 let deprecations = cx.action_deprecations();
140 KeymapFile::generate_json_schema(generator, action_schemas, deprecations)
141 }
142}
143
144#[async_trait(?Send)]
145impl LspAdapter for JsonLspAdapter {
146 fn name(&self) -> LanguageServerName {
147 LanguageServerName("json-language-server".into())
148 }
149
150 async fn fetch_latest_server_version(
151 &self,
152 _: &dyn LspAdapterDelegate,
153 ) -> Result<Box<dyn 'static + Send + Any>> {
154 Ok(Box::new(
155 self.node
156 .npm_package_latest_version(Self::PACKAGE_NAME)
157 .await?,
158 ) as Box<_>)
159 }
160
161 async fn check_if_version_installed(
162 &self,
163 version: &(dyn 'static + Send + Any),
164 container_dir: &PathBuf,
165 _: &dyn LspAdapterDelegate,
166 ) -> Option<LanguageServerBinary> {
167 let version = version.downcast_ref::<String>().unwrap();
168 let server_path = container_dir.join(SERVER_PATH);
169
170 let should_install_language_server = self
171 .node
172 .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
173 .await;
174
175 if should_install_language_server {
176 None
177 } else {
178 Some(LanguageServerBinary {
179 path: self.node.binary_path().await.ok()?,
180 env: None,
181 arguments: server_binary_arguments(&server_path),
182 })
183 }
184 }
185
186 async fn fetch_server_binary(
187 &self,
188 latest_version: Box<dyn 'static + Send + Any>,
189 container_dir: PathBuf,
190 _: &dyn LspAdapterDelegate,
191 ) -> Result<LanguageServerBinary> {
192 let latest_version = latest_version.downcast::<String>().unwrap();
193 let server_path = container_dir.join(SERVER_PATH);
194
195 self.node
196 .npm_install_packages(
197 &container_dir,
198 &[(Self::PACKAGE_NAME, latest_version.as_str())],
199 )
200 .await?;
201
202 Ok(LanguageServerBinary {
203 path: self.node.binary_path().await?,
204 env: None,
205 arguments: server_binary_arguments(&server_path),
206 })
207 }
208
209 async fn cached_server_binary(
210 &self,
211 container_dir: PathBuf,
212 _: &dyn LspAdapterDelegate,
213 ) -> Option<LanguageServerBinary> {
214 get_cached_server_binary(container_dir, &self.node).await
215 }
216
217 async fn initialization_options(
218 self: Arc<Self>,
219 _: &Arc<dyn LspAdapterDelegate>,
220 ) -> Result<Option<serde_json::Value>> {
221 Ok(Some(json!({
222 "provideFormatter": true
223 })))
224 }
225
226 async fn workspace_configuration(
227 self: Arc<Self>,
228 delegate: &Arc<dyn LspAdapterDelegate>,
229 _: Arc<dyn LanguageToolchainStore>,
230 cx: &mut AsyncAppContext,
231 ) -> Result<Value> {
232 let mut config = cx.update(|cx| {
233 self.workspace_config
234 .get_or_init(|| Self::get_workspace_config(self.languages.language_names(), cx))
235 .clone()
236 })?;
237
238 let project_options = cx.update(|cx| {
239 language_server_settings(delegate.as_ref(), &self.name(), cx)
240 .and_then(|s| s.settings.clone())
241 })?;
242
243 if let Some(override_options) = project_options {
244 merge_json_value_into(override_options, &mut config);
245 }
246
247 Ok(config)
248 }
249
250 fn language_ids(&self) -> HashMap<String, String> {
251 [
252 ("JSON".into(), "json".into()),
253 ("JSONC".into(), "jsonc".into()),
254 ]
255 .into_iter()
256 .collect()
257 }
258}
259
260async fn get_cached_server_binary(
261 container_dir: PathBuf,
262 node: &NodeRuntime,
263) -> Option<LanguageServerBinary> {
264 maybe!(async {
265 let mut last_version_dir = None;
266 let mut entries = fs::read_dir(&container_dir).await?;
267 while let Some(entry) = entries.next().await {
268 let entry = entry?;
269 if entry.file_type().await?.is_dir() {
270 last_version_dir = Some(entry.path());
271 }
272 }
273
274 let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
275 let server_path = last_version_dir.join(SERVER_PATH);
276 if server_path.exists() {
277 Ok(LanguageServerBinary {
278 path: node.binary_path().await?,
279 env: None,
280 arguments: server_binary_arguments(&server_path),
281 })
282 } else {
283 Err(anyhow!(
284 "missing executable in directory {:?}",
285 last_version_dir
286 ))
287 }
288 })
289 .await
290 .log_err()
291}
292
293#[inline]
294fn schema_file_match(path: &Path) -> String {
295 path.strip_prefix(path.parent().unwrap().parent().unwrap())
296 .unwrap()
297 .display()
298 .to_string()
299 .replace('\\', "/")
300}
301
302pub(super) struct NodeVersionAdapter;
303
304#[async_trait(?Send)]
305impl LspAdapter for NodeVersionAdapter {
306 fn name(&self) -> LanguageServerName {
307 LanguageServerName("package-version-server".into())
308 }
309
310 async fn fetch_latest_server_version(
311 &self,
312 delegate: &dyn LspAdapterDelegate,
313 ) -> Result<Box<dyn 'static + Send + Any>> {
314 let release = latest_github_release(
315 "zed-industries/package-version-server",
316 true,
317 false,
318 delegate.http_client(),
319 )
320 .await?;
321 let os = match consts::OS {
322 "macos" => "apple-darwin",
323 "linux" => "unknown-linux-gnu",
324 "windows" => "pc-windows-msvc",
325 other => bail!("Running on unsupported os: {other}"),
326 };
327 let suffix = if consts::OS == "windows" {
328 ".zip"
329 } else {
330 ".tar.gz"
331 };
332 let asset_name = format!("package-version-server-{}-{os}{suffix}", consts::ARCH);
333 let asset = release
334 .assets
335 .iter()
336 .find(|asset| asset.name == asset_name)
337 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
338 Ok(Box::new(GitHubLspBinaryVersion {
339 name: release.tag_name,
340 url: asset.browser_download_url.clone(),
341 }))
342 }
343
344 async fn fetch_server_binary(
345 &self,
346 latest_version: Box<dyn 'static + Send + Any>,
347 container_dir: PathBuf,
348 delegate: &dyn LspAdapterDelegate,
349 ) -> Result<LanguageServerBinary> {
350 let version = latest_version.downcast::<GitHubLspBinaryVersion>().unwrap();
351 let destination_path = container_dir.join(format!(
352 "package-version-server-{}{}",
353 version.name,
354 std::env::consts::EXE_SUFFIX
355 ));
356 let destination_container_path =
357 container_dir.join(format!("package-version-server-{}-tmp", version.name));
358 if fs::metadata(&destination_path).await.is_err() {
359 let mut response = delegate
360 .http_client()
361 .get(&version.url, Default::default(), true)
362 .await
363 .map_err(|err| anyhow!("error downloading release: {}", err))?;
364 if version.url.ends_with(".zip") {
365 node_runtime::extract_zip(
366 &destination_container_path,
367 BufReader::new(response.body_mut()),
368 )
369 .await?;
370 } else if version.url.ends_with(".tar.gz") {
371 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
372 let archive = Archive::new(decompressed_bytes);
373 archive.unpack(&destination_container_path).await?;
374 }
375
376 fs::copy(
377 destination_container_path.join(format!(
378 "package-version-server{}",
379 std::env::consts::EXE_SUFFIX
380 )),
381 &destination_path,
382 )
383 .await?;
384 // todo("windows")
385 #[cfg(not(windows))]
386 {
387 fs::set_permissions(
388 &destination_path,
389 <fs::Permissions as fs::unix::PermissionsExt>::from_mode(0o755),
390 )
391 .await?;
392 }
393 remove_matching(&container_dir, |entry| entry != destination_path).await;
394 }
395 Ok(LanguageServerBinary {
396 path: destination_path,
397 env: None,
398 arguments: Default::default(),
399 })
400 }
401
402 async fn cached_server_binary(
403 &self,
404 container_dir: PathBuf,
405 _delegate: &dyn LspAdapterDelegate,
406 ) -> Option<LanguageServerBinary> {
407 get_cached_version_server_binary(container_dir).await
408 }
409}
410
411async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
412 maybe!(async {
413 let mut last = None;
414 let mut entries = fs::read_dir(&container_dir).await?;
415 while let Some(entry) = entries.next().await {
416 last = Some(entry?.path());
417 }
418
419 anyhow::Ok(LanguageServerBinary {
420 path: last.ok_or_else(|| anyhow!("no cached binary"))?,
421 env: None,
422 arguments: Default::default(),
423 })
424 })
425 .await
426 .log_err()
427}