1use anyhow::{Result, anyhow};
2use async_trait::async_trait;
3use dap::{DapLocator, DebugRequest, adapters::DebugAdapterName};
4use gpui::SharedString;
5use serde_json::Value;
6use smol::{
7 io::AsyncReadExt,
8 process::{Command, Stdio},
9};
10use task::{BuildTaskDefinition, DebugScenario, ShellBuilder, SpawnInTerminal, TaskTemplate};
11
12pub(crate) struct CargoLocator;
13
14async fn find_best_executable(executables: &[String], test_name: &str) -> Option<String> {
15 if executables.len() == 1 {
16 return executables.first().cloned();
17 }
18 for executable in executables {
19 let Some(mut child) = Command::new(&executable)
20 .arg("--list")
21 .stdout(Stdio::piped())
22 .spawn()
23 .ok()
24 else {
25 continue;
26 };
27 let mut test_lines = String::default();
28 if let Some(mut stdout) = child.stdout.take() {
29 stdout.read_to_string(&mut test_lines).await.ok();
30 for line in test_lines.lines() {
31 if line.contains(&test_name) {
32 return Some(executable.clone());
33 }
34 }
35 }
36 }
37 None
38}
39#[async_trait]
40impl DapLocator for CargoLocator {
41 fn name(&self) -> SharedString {
42 SharedString::new_static("rust-cargo-locator")
43 }
44 fn create_scenario(
45 &self,
46 build_config: &TaskTemplate,
47 resolved_label: &str,
48 adapter: DebugAdapterName,
49 ) -> Option<DebugScenario> {
50 if build_config.command != "cargo" {
51 return None;
52 }
53 let mut task_template = build_config.clone();
54 let cargo_action = task_template.args.first_mut()?;
55 if cargo_action == "check" {
56 return None;
57 }
58
59 match cargo_action.as_ref() {
60 "run" => {
61 *cargo_action = "build".to_owned();
62 }
63 "test" | "bench" => {
64 let delimiter = task_template
65 .args
66 .iter()
67 .position(|arg| arg == "--")
68 .unwrap_or(task_template.args.len());
69 if !task_template.args[..delimiter]
70 .iter()
71 .any(|arg| arg == "--no-run")
72 {
73 task_template.args.insert(delimiter, "--no-run".to_owned());
74 }
75 }
76 _ => {}
77 }
78 let label = format!("Debug `{resolved_label}`");
79 Some(DebugScenario {
80 adapter: adapter.0,
81 label: SharedString::from(label),
82 build: Some(BuildTaskDefinition::Template {
83 task_template,
84 locator_name: Some(self.name()),
85 }),
86 request: None,
87 initialize_args: None,
88 tcp_connection: None,
89 stop_on_entry: None,
90 })
91 }
92
93 async fn run(&self, build_config: SpawnInTerminal) -> Result<DebugRequest> {
94 let Some(cwd) = build_config.cwd.clone() else {
95 return Err(anyhow!(
96 "Couldn't get cwd from debug config which is needed for locators"
97 ));
98 };
99 let builder = ShellBuilder::new(true, &build_config.shell).non_interactive();
100 let (program, args) = builder.build(
101 "cargo".into(),
102 &build_config
103 .args
104 .iter()
105 .cloned()
106 .take_while(|arg| arg != "--")
107 .chain(Some("--message-format=json".to_owned()))
108 .collect(),
109 );
110 let mut child = Command::new(program)
111 .args(args)
112 .envs(build_config.env.iter().map(|(k, v)| (k.clone(), v.clone())))
113 .current_dir(cwd)
114 .stdout(Stdio::piped())
115 .spawn()?;
116
117 let mut output = String::new();
118 if let Some(mut stdout) = child.stdout.take() {
119 stdout.read_to_string(&mut output).await?;
120 }
121
122 let status = child.status().await?;
123 if !status.success() {
124 return Err(anyhow::anyhow!("Cargo command failed"));
125 }
126
127 let executables = output
128 .lines()
129 .filter(|line| !line.trim().is_empty())
130 .filter_map(|line| serde_json::from_str(line).ok())
131 .filter_map(|json: Value| {
132 json.get("executable")
133 .and_then(Value::as_str)
134 .map(String::from)
135 })
136 .collect::<Vec<_>>();
137 if executables.is_empty() {
138 return Err(anyhow!("Couldn't get executable in cargo locator"));
139 };
140 let is_test = build_config.args.first().map_or(false, |arg| arg == "test");
141
142 let mut test_name = None;
143 if is_test {
144 test_name = build_config
145 .args
146 .iter()
147 .rev()
148 .take_while(|name| "--" != name.as_str())
149 .find(|name| !name.starts_with("-"))
150 .cloned();
151 }
152 let executable = {
153 if let Some(ref name) = test_name.as_ref().and_then(|name| {
154 name.strip_prefix('$')
155 .map(|name| build_config.env.get(name))
156 .unwrap_or(Some(name))
157 }) {
158 find_best_executable(&executables, &name).await
159 } else {
160 None
161 }
162 };
163
164 let Some(executable) = executable.or_else(|| executables.first().cloned()) else {
165 return Err(anyhow!("Couldn't get executable in cargo locator"));
166 };
167
168 let args = test_name.into_iter().collect();
169
170 Ok(DebugRequest::Launch(task::LaunchRequest {
171 program: executable,
172 cwd: build_config.cwd.clone(),
173 args,
174 env: build_config
175 .env
176 .iter()
177 .map(|(k, v)| (k.clone(), v.clone()))
178 .collect(),
179 }))
180 }
181}