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