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