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, 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 AppContext) -> 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 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 // This can be viewed via `debug: open language server logs` -> `json-language-server` ->
92 // `Server Info`
93 serde_json::json!({
94 "json": {
95 "format": {
96 "enable": true,
97 },
98 "validate":
99 {
100 "enable": true,
101 },
102 "schemas": [
103 {
104 "fileMatch": ["tsconfig.json"],
105 "schema":tsconfig_schema
106 },
107 {
108 "fileMatch": ["package.json"],
109 "schema":package_json_schema
110 },
111 {
112 "fileMatch": [
113 schema_file_match(paths::settings_file()),
114 paths::local_settings_file_relative_path()
115 ],
116 "schema": settings_schema,
117 },
118 {
119 "fileMatch": [schema_file_match(paths::keymap_file())],
120 "schema": keymap_schema,
121 },
122 {
123 "fileMatch": [
124 schema_file_match(paths::tasks_file()),
125 paths::local_tasks_file_relative_path()
126 ],
127 "schema": tasks_schema,
128 }
129
130 ]
131 }
132 })
133 }
134}
135
136#[async_trait(?Send)]
137impl LspAdapter for JsonLspAdapter {
138 fn name(&self) -> LanguageServerName {
139 LanguageServerName("json-language-server".into())
140 }
141
142 async fn fetch_latest_server_version(
143 &self,
144 _: &dyn LspAdapterDelegate,
145 ) -> Result<Box<dyn 'static + Send + Any>> {
146 Ok(Box::new(
147 self.node
148 .npm_package_latest_version(Self::PACKAGE_NAME)
149 .await?,
150 ) as Box<_>)
151 }
152
153 async fn check_if_version_installed(
154 &self,
155 version: &(dyn 'static + Send + Any),
156 container_dir: &PathBuf,
157 _: &dyn LspAdapterDelegate,
158 ) -> Option<LanguageServerBinary> {
159 let version = version.downcast_ref::<String>().unwrap();
160 let server_path = container_dir.join(SERVER_PATH);
161
162 let should_install_language_server = self
163 .node
164 .should_install_npm_package(Self::PACKAGE_NAME, &server_path, &container_dir, &version)
165 .await;
166
167 if should_install_language_server {
168 None
169 } else {
170 Some(LanguageServerBinary {
171 path: self.node.binary_path().await.ok()?,
172 env: None,
173 arguments: server_binary_arguments(&server_path),
174 })
175 }
176 }
177
178 async fn fetch_server_binary(
179 &self,
180 latest_version: Box<dyn 'static + Send + Any>,
181 container_dir: PathBuf,
182 _: &dyn LspAdapterDelegate,
183 ) -> Result<LanguageServerBinary> {
184 let latest_version = latest_version.downcast::<String>().unwrap();
185 let server_path = container_dir.join(SERVER_PATH);
186
187 self.node
188 .npm_install_packages(
189 &container_dir,
190 &[(Self::PACKAGE_NAME, latest_version.as_str())],
191 )
192 .await?;
193
194 Ok(LanguageServerBinary {
195 path: self.node.binary_path().await?,
196 env: None,
197 arguments: server_binary_arguments(&server_path),
198 })
199 }
200
201 async fn cached_server_binary(
202 &self,
203 container_dir: PathBuf,
204 _: &dyn LspAdapterDelegate,
205 ) -> Option<LanguageServerBinary> {
206 get_cached_server_binary(container_dir, &self.node).await
207 }
208
209 async fn initialization_options(
210 self: Arc<Self>,
211 _: &dyn Fs,
212 _: &Arc<dyn LspAdapterDelegate>,
213 ) -> Result<Option<serde_json::Value>> {
214 Ok(Some(json!({
215 "provideFormatter": true
216 })))
217 }
218
219 async fn workspace_configuration(
220 self: Arc<Self>,
221 _: &dyn Fs,
222 delegate: &Arc<dyn LspAdapterDelegate>,
223 _: Arc<dyn LanguageToolchainStore>,
224 cx: &mut AsyncAppContext,
225 ) -> Result<Value> {
226 let mut config = cx.update(|cx| {
227 self.workspace_config
228 .get_or_init(|| Self::get_workspace_config(self.languages.language_names(), cx))
229 .clone()
230 })?;
231
232 let project_options = cx.update(|cx| {
233 language_server_settings(delegate.as_ref(), &self.name(), cx)
234 .and_then(|s| s.settings.clone())
235 })?;
236
237 if let Some(override_options) = project_options {
238 merge_json_value_into(override_options, &mut config);
239 }
240
241 Ok(config)
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: &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 Ok(LanguageServerBinary {
390 path: destination_path,
391 env: None,
392 arguments: Default::default(),
393 })
394 }
395
396 async fn cached_server_binary(
397 &self,
398 container_dir: PathBuf,
399 _delegate: &dyn LspAdapterDelegate,
400 ) -> Option<LanguageServerBinary> {
401 get_cached_version_server_binary(container_dir).await
402 }
403}
404
405async fn get_cached_version_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
406 maybe!(async {
407 let mut last = None;
408 let mut entries = fs::read_dir(&container_dir).await?;
409 while let Some(entry) = entries.next().await {
410 last = Some(entry?.path());
411 }
412
413 anyhow::Ok(LanguageServerBinary {
414 path: last.ok_or_else(|| anyhow!("no cached binary"))?,
415 env: None,
416 arguments: Default::default(),
417 })
418 })
419 .await
420 .log_err()
421}