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