1use anyhow::{anyhow, Context, Result};
2use async_trait::async_trait;
3use futures::StreamExt;
4use gpui::{AsyncAppContext, Task};
5pub use language::*;
6use lazy_static::lazy_static;
7use lsp::LanguageServerBinary;
8use regex::Regex;
9use serde_json::json;
10use smol::{fs, process};
11use std::{
12 any::Any,
13 ffi::{OsStr, OsString},
14 ops::Range,
15 path::PathBuf,
16 str,
17 sync::{
18 atomic::{AtomicBool, Ordering::SeqCst},
19 Arc,
20 },
21};
22use util::{async_maybe, fs::remove_matching, github::latest_github_release, ResultExt};
23
24fn server_binary_arguments() -> Vec<OsString> {
25 vec!["-mode=stdio".into()]
26}
27
28#[derive(Copy, Clone)]
29pub struct GoLspAdapter;
30
31lazy_static! {
32 static ref GOPLS_VERSION_REGEX: Regex = Regex::new(r"\d+\.\d+\.\d+").unwrap();
33}
34
35#[async_trait(?Send)]
36impl super::LspAdapter for GoLspAdapter {
37 fn name(&self) -> LanguageServerName {
38 LanguageServerName("gopls".into())
39 }
40
41 async fn fetch_latest_server_version(
42 &self,
43 delegate: &dyn LspAdapterDelegate,
44 ) -> Result<Box<dyn 'static + Send + Any>> {
45 let release =
46 latest_github_release("golang/tools", false, false, delegate.http_client()).await?;
47 let version: Option<String> = release.tag_name.strip_prefix("gopls/v").map(str::to_string);
48 if version.is_none() {
49 log::warn!(
50 "couldn't infer gopls version from GitHub release tag name '{}'",
51 release.tag_name
52 );
53 }
54 Ok(Box::new(version) as Box<_>)
55 }
56
57 async fn check_if_user_installed(
58 &self,
59 delegate: &dyn LspAdapterDelegate,
60 _: &AsyncAppContext,
61 ) -> Option<LanguageServerBinary> {
62 let env = delegate.shell_env().await;
63 let path = delegate.which("gopls".as_ref()).await?;
64 Some(LanguageServerBinary {
65 path,
66 arguments: server_binary_arguments(),
67 env: Some(env),
68 })
69 }
70
71 fn will_fetch_server(
72 &self,
73 delegate: &Arc<dyn LspAdapterDelegate>,
74 cx: &mut AsyncAppContext,
75 ) -> Option<Task<Result<()>>> {
76 static DID_SHOW_NOTIFICATION: AtomicBool = AtomicBool::new(false);
77
78 const NOTIFICATION_MESSAGE: &str =
79 "Could not install the Go language server `gopls`, because `go` was not found.";
80
81 let delegate = delegate.clone();
82 Some(cx.spawn(|cx| async move {
83 let install_output = process::Command::new("go").args(["version"]).output().await;
84 if install_output.is_err() {
85 if DID_SHOW_NOTIFICATION
86 .compare_exchange(false, true, SeqCst, SeqCst)
87 .is_ok()
88 {
89 cx.update(|cx| {
90 delegate.show_notification(NOTIFICATION_MESSAGE, cx);
91 })?
92 }
93 return Err(anyhow!("cannot install gopls"));
94 }
95 Ok(())
96 }))
97 }
98
99 async fn fetch_server_binary(
100 &self,
101 version: Box<dyn 'static + Send + Any>,
102 container_dir: PathBuf,
103 delegate: &dyn LspAdapterDelegate,
104 ) -> Result<LanguageServerBinary> {
105 let version = version.downcast::<Option<String>>().unwrap();
106 let this = *self;
107
108 if let Some(version) = *version {
109 let binary_path = container_dir.join(&format!("gopls_{version}"));
110 if let Ok(metadata) = fs::metadata(&binary_path).await {
111 if metadata.is_file() {
112 remove_matching(&container_dir, |entry| {
113 entry != binary_path && entry.file_name() != Some(OsStr::new("gobin"))
114 })
115 .await;
116
117 return Ok(LanguageServerBinary {
118 path: binary_path.to_path_buf(),
119 arguments: server_binary_arguments(),
120 env: None,
121 });
122 }
123 }
124 } else if let Some(path) = this
125 .cached_server_binary(container_dir.clone(), delegate)
126 .await
127 {
128 return Ok(path);
129 }
130
131 let gobin_dir = container_dir.join("gobin");
132 fs::create_dir_all(&gobin_dir).await?;
133 let install_output = process::Command::new("go")
134 .env("GO111MODULE", "on")
135 .env("GOBIN", &gobin_dir)
136 .args(["install", "golang.org/x/tools/gopls@latest"])
137 .output()
138 .await?;
139
140 if !install_output.status.success() {
141 log::error!(
142 "failed to install gopls via `go install`. stdout: {:?}, stderr: {:?}",
143 String::from_utf8_lossy(&install_output.stdout),
144 String::from_utf8_lossy(&install_output.stderr)
145 );
146
147 return Err(anyhow!("failed to install gopls with `go install`. Is `go` installed and in the PATH? Check logs for more information."));
148 }
149
150 let installed_binary_path = gobin_dir.join("gopls");
151 let version_output = process::Command::new(&installed_binary_path)
152 .arg("version")
153 .output()
154 .await
155 .context("failed to run installed gopls binary")?;
156 let version_stdout = str::from_utf8(&version_output.stdout)
157 .context("gopls version produced invalid utf8 output")?;
158 let version = GOPLS_VERSION_REGEX
159 .find(version_stdout)
160 .with_context(|| format!("failed to parse golps version output '{version_stdout}'"))?
161 .as_str();
162 let binary_path = container_dir.join(&format!("gopls_{version}"));
163 fs::rename(&installed_binary_path, &binary_path).await?;
164
165 Ok(LanguageServerBinary {
166 path: binary_path.to_path_buf(),
167 arguments: server_binary_arguments(),
168 env: None,
169 })
170 }
171
172 async fn cached_server_binary(
173 &self,
174 container_dir: PathBuf,
175 _: &dyn LspAdapterDelegate,
176 ) -> Option<LanguageServerBinary> {
177 get_cached_server_binary(container_dir).await
178 }
179
180 async fn installation_test_binary(
181 &self,
182 container_dir: PathBuf,
183 ) -> Option<LanguageServerBinary> {
184 get_cached_server_binary(container_dir)
185 .await
186 .map(|mut binary| {
187 binary.arguments = vec!["--help".into()];
188 binary
189 })
190 }
191
192 fn initialization_options(&self) -> Option<serde_json::Value> {
193 Some(json!({
194 "usePlaceholders": true,
195 "hints": {
196 "assignVariableTypes": true,
197 "compositeLiteralFields": true,
198 "compositeLiteralTypes": true,
199 "constantValues": true,
200 "functionTypeParameters": true,
201 "parameterNames": true,
202 "rangeVariableTypes": true
203 }
204 }))
205 }
206
207 async fn label_for_completion(
208 &self,
209 completion: &lsp::CompletionItem,
210 language: &Arc<Language>,
211 ) -> Option<CodeLabel> {
212 let label = &completion.label;
213
214 // Gopls returns nested fields and methods as completions.
215 // To syntax highlight these, combine their final component
216 // with their detail.
217 let name_offset = label.rfind('.').unwrap_or(0);
218
219 match completion.kind.zip(completion.detail.as_ref()) {
220 Some((lsp::CompletionItemKind::MODULE, detail)) => {
221 let text = format!("{label} {detail}");
222 let source = Rope::from(format!("import {text}").as_str());
223 let runs = language.highlight_text(&source, 7..7 + text.len());
224 return Some(CodeLabel {
225 text,
226 runs,
227 filter_range: 0..label.len(),
228 });
229 }
230 Some((
231 lsp::CompletionItemKind::CONSTANT | lsp::CompletionItemKind::VARIABLE,
232 detail,
233 )) => {
234 let text = format!("{label} {detail}");
235 let source =
236 Rope::from(format!("var {} {}", &text[name_offset..], detail).as_str());
237 let runs = adjust_runs(
238 name_offset,
239 language.highlight_text(&source, 4..4 + text.len()),
240 );
241 return Some(CodeLabel {
242 text,
243 runs,
244 filter_range: 0..label.len(),
245 });
246 }
247 Some((lsp::CompletionItemKind::STRUCT, _)) => {
248 let text = format!("{label} struct {{}}");
249 let source = Rope::from(format!("type {}", &text[name_offset..]).as_str());
250 let runs = adjust_runs(
251 name_offset,
252 language.highlight_text(&source, 5..5 + text.len()),
253 );
254 return Some(CodeLabel {
255 text,
256 runs,
257 filter_range: 0..label.len(),
258 });
259 }
260 Some((lsp::CompletionItemKind::INTERFACE, _)) => {
261 let text = format!("{label} interface {{}}");
262 let source = Rope::from(format!("type {}", &text[name_offset..]).as_str());
263 let runs = adjust_runs(
264 name_offset,
265 language.highlight_text(&source, 5..5 + text.len()),
266 );
267 return Some(CodeLabel {
268 text,
269 runs,
270 filter_range: 0..label.len(),
271 });
272 }
273 Some((lsp::CompletionItemKind::FIELD, detail)) => {
274 let text = format!("{label} {detail}");
275 let source =
276 Rope::from(format!("type T struct {{ {} }}", &text[name_offset..]).as_str());
277 let runs = adjust_runs(
278 name_offset,
279 language.highlight_text(&source, 16..16 + text.len()),
280 );
281 return Some(CodeLabel {
282 text,
283 runs,
284 filter_range: 0..label.len(),
285 });
286 }
287 Some((lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD, detail)) => {
288 if let Some(signature) = detail.strip_prefix("func") {
289 let text = format!("{label}{signature}");
290 let source = Rope::from(format!("func {} {{}}", &text[name_offset..]).as_str());
291 let runs = adjust_runs(
292 name_offset,
293 language.highlight_text(&source, 5..5 + text.len()),
294 );
295 return Some(CodeLabel {
296 filter_range: 0..label.len(),
297 text,
298 runs,
299 });
300 }
301 }
302 _ => {}
303 }
304 None
305 }
306
307 async fn label_for_symbol(
308 &self,
309 name: &str,
310 kind: lsp::SymbolKind,
311 language: &Arc<Language>,
312 ) -> Option<CodeLabel> {
313 let (text, filter_range, display_range) = match kind {
314 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
315 let text = format!("func {} () {{}}", name);
316 let filter_range = 5..5 + name.len();
317 let display_range = 0..filter_range.end;
318 (text, filter_range, display_range)
319 }
320 lsp::SymbolKind::STRUCT => {
321 let text = format!("type {} struct {{}}", name);
322 let filter_range = 5..5 + name.len();
323 let display_range = 0..text.len();
324 (text, filter_range, display_range)
325 }
326 lsp::SymbolKind::INTERFACE => {
327 let text = format!("type {} interface {{}}", name);
328 let filter_range = 5..5 + name.len();
329 let display_range = 0..text.len();
330 (text, filter_range, display_range)
331 }
332 lsp::SymbolKind::CLASS => {
333 let text = format!("type {} T", name);
334 let filter_range = 5..5 + name.len();
335 let display_range = 0..filter_range.end;
336 (text, filter_range, display_range)
337 }
338 lsp::SymbolKind::CONSTANT => {
339 let text = format!("const {} = nil", name);
340 let filter_range = 6..6 + name.len();
341 let display_range = 0..filter_range.end;
342 (text, filter_range, display_range)
343 }
344 lsp::SymbolKind::VARIABLE => {
345 let text = format!("var {} = nil", name);
346 let filter_range = 4..4 + name.len();
347 let display_range = 0..filter_range.end;
348 (text, filter_range, display_range)
349 }
350 lsp::SymbolKind::MODULE => {
351 let text = format!("package {}", name);
352 let filter_range = 8..8 + name.len();
353 let display_range = 0..filter_range.end;
354 (text, filter_range, display_range)
355 }
356 _ => return None,
357 };
358
359 Some(CodeLabel {
360 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
361 text: text[display_range].to_string(),
362 filter_range,
363 })
364 }
365}
366
367async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
368 async_maybe!({
369 let mut last_binary_path = None;
370 let mut entries = fs::read_dir(&container_dir).await?;
371 while let Some(entry) = entries.next().await {
372 let entry = entry?;
373 if entry.file_type().await?.is_file()
374 && entry
375 .file_name()
376 .to_str()
377 .map_or(false, |name| name.starts_with("gopls_"))
378 {
379 last_binary_path = Some(entry.path());
380 }
381 }
382
383 if let Some(path) = last_binary_path {
384 Ok(LanguageServerBinary {
385 path,
386 arguments: server_binary_arguments(),
387 env: None,
388 })
389 } else {
390 Err(anyhow!("no cached binary"))
391 }
392 })
393 .await
394 .log_err()
395}
396
397fn adjust_runs(
398 delta: usize,
399 mut runs: Vec<(Range<usize>, HighlightId)>,
400) -> Vec<(Range<usize>, HighlightId)> {
401 for (range, _) in &mut runs {
402 range.start += delta;
403 range.end += delta;
404 }
405 runs
406}
407
408#[cfg(test)]
409mod tests {
410 use super::*;
411 use crate::language;
412 use gpui::Hsla;
413 use theme::SyntaxTheme;
414
415 #[gpui::test]
416 async fn test_go_label_for_completion() {
417 let adapter = Arc::new(GoLspAdapter);
418 let language = language("go", tree_sitter_go::language());
419
420 let theme = SyntaxTheme::new_test([
421 ("type", Hsla::default()),
422 ("keyword", Hsla::default()),
423 ("function", Hsla::default()),
424 ("number", Hsla::default()),
425 ("property", Hsla::default()),
426 ]);
427 language.set_theme(&theme);
428
429 let grammar = language.grammar().unwrap();
430 let highlight_function = grammar.highlight_id_for_name("function").unwrap();
431 let highlight_type = grammar.highlight_id_for_name("type").unwrap();
432 let highlight_keyword = grammar.highlight_id_for_name("keyword").unwrap();
433 let highlight_number = grammar.highlight_id_for_name("number").unwrap();
434
435 assert_eq!(
436 adapter
437 .label_for_completion(
438 &lsp::CompletionItem {
439 kind: Some(lsp::CompletionItemKind::FUNCTION),
440 label: "Hello".to_string(),
441 detail: Some("func(a B) c.D".to_string()),
442 ..Default::default()
443 },
444 &language
445 )
446 .await,
447 Some(CodeLabel {
448 text: "Hello(a B) c.D".to_string(),
449 filter_range: 0..5,
450 runs: vec![
451 (0..5, highlight_function),
452 (8..9, highlight_type),
453 (13..14, highlight_type),
454 ],
455 })
456 );
457
458 // Nested methods
459 assert_eq!(
460 adapter
461 .label_for_completion(
462 &lsp::CompletionItem {
463 kind: Some(lsp::CompletionItemKind::METHOD),
464 label: "one.two.Three".to_string(),
465 detail: Some("func() [3]interface{}".to_string()),
466 ..Default::default()
467 },
468 &language
469 )
470 .await,
471 Some(CodeLabel {
472 text: "one.two.Three() [3]interface{}".to_string(),
473 filter_range: 0..13,
474 runs: vec![
475 (8..13, highlight_function),
476 (17..18, highlight_number),
477 (19..28, highlight_keyword),
478 ],
479 })
480 );
481
482 // Nested fields
483 assert_eq!(
484 adapter
485 .label_for_completion(
486 &lsp::CompletionItem {
487 kind: Some(lsp::CompletionItemKind::FIELD),
488 label: "two.Three".to_string(),
489 detail: Some("a.Bcd".to_string()),
490 ..Default::default()
491 },
492 &language
493 )
494 .await,
495 Some(CodeLabel {
496 text: "two.Three a.Bcd".to_string(),
497 filter_range: 0..9,
498 runs: vec![(12..15, highlight_type)],
499 })
500 );
501 }
502}