cargo.rs

  1use anyhow::{Context as _, Result};
  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" || cargo_action == "clean" {
 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        Some(DebugScenario {
 79            adapter: adapter.0,
 80            label: resolved_label.to_string().into(),
 81            build: Some(BuildTaskDefinition::Template {
 82                task_template,
 83                locator_name: Some(self.name()),
 84            }),
 85            config: serde_json::Value::Null,
 86            tcp_connection: None,
 87        })
 88    }
 89
 90    async fn run(&self, build_config: SpawnInTerminal) -> Result<DebugRequest> {
 91        let cwd = build_config
 92            .cwd
 93            .clone()
 94            .context("Couldn't get cwd from debug config which is needed for locators")?;
 95        let builder = ShellBuilder::new(true, &build_config.shell).non_interactive();
 96        let (program, args) = builder.build(
 97            "cargo".into(),
 98            &build_config
 99                .args
100                .iter()
101                .cloned()
102                .take_while(|arg| arg != "--")
103                .chain(Some("--message-format=json".to_owned()))
104                .collect(),
105        );
106        let mut child = Command::new(program)
107            .args(args)
108            .envs(build_config.env.iter().map(|(k, v)| (k.clone(), v.clone())))
109            .current_dir(cwd)
110            .stdout(Stdio::piped())
111            .spawn()?;
112
113        let mut output = String::new();
114        if let Some(mut stdout) = child.stdout.take() {
115            stdout.read_to_string(&mut output).await?;
116        }
117
118        let status = child.status().await?;
119        anyhow::ensure!(status.success(), "Cargo command failed");
120
121        let executables = output
122            .lines()
123            .filter(|line| !line.trim().is_empty())
124            .filter_map(|line| serde_json::from_str(line).ok())
125            .filter_map(|json: Value| {
126                json.get("executable")
127                    .and_then(Value::as_str)
128                    .map(String::from)
129            })
130            .collect::<Vec<_>>();
131        anyhow::ensure!(
132            !executables.is_empty(),
133            "Couldn't get executable in cargo locator"
134        );
135        let is_test = build_config.args.first().map_or(false, |arg| arg == "test");
136
137        let mut test_name = None;
138        if is_test {
139            test_name = build_config
140                .args
141                .iter()
142                .rev()
143                .take_while(|name| "--" != name.as_str())
144                .find(|name| !name.starts_with("-"))
145                .cloned();
146        }
147        let executable = {
148            if let Some(ref name) = test_name.as_ref().and_then(|name| {
149                name.strip_prefix('$')
150                    .map(|name| build_config.env.get(name))
151                    .unwrap_or(Some(name))
152            }) {
153                find_best_executable(&executables, &name).await
154            } else {
155                None
156            }
157        };
158
159        let Some(executable) = executable.or_else(|| executables.first().cloned()) else {
160            anyhow::bail!("Couldn't get executable in cargo locator");
161        };
162
163        let args = test_name.into_iter().collect();
164
165        Ok(DebugRequest::Launch(task::LaunchRequest {
166            program: executable,
167            cwd: build_config.cwd,
168            args,
169            env: build_config.env.into_iter().collect(),
170        }))
171    }
172}