ZIm/crates/assistant_tools/src/bash_tool.rs

use crate::schema::json_schema_for;
use anyhow::{Context as _, Result, anyhow};
use assistant_tool::{ActionLog, Tool};
use futures::io::BufReader;
use futures::{AsyncBufReadExt, AsyncReadExt};
use gpui::{App, AppContext, Entity, Task};
use language_model::{LanguageModelRequestMessage, LanguageModelToolSchemaFormat};
use project::Project;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::path::Path;
use std::sync::Arc;
use ui::IconName;
use util::command::new_smol_command;
use util::markdown::MarkdownString;

#[derive(Debug, Serialize, Deserialize, JsonSchema)]
pub struct BashToolInput {
    /// The bash one-liner command to execute.
    command: String,
    /// Working directory for the command. This must be one of the root directories of the project.
    cd: String,
}

pub struct BashTool;

impl Tool for BashTool {
    fn name(&self) -> String {
        "bash".to_string()
    }

    fn needs_confirmation(&self, _: &serde_json::Value, _: &App) -> bool {
        true
    }

    fn description(&self) -> String {
        include_str!("./bash_tool/description.md").to_string()
    }

    fn icon(&self) -> IconName {
        IconName::Terminal
    }

    fn input_schema(&self, format: LanguageModelToolSchemaFormat) -> serde_json::Value {
        json_schema_for::<BashToolInput>(format)
    }

    fn ui_text(&self, input: &serde_json::Value) -> String {
        match serde_json::from_value::<BashToolInput>(input.clone()) {
            Ok(input) => {
                let mut lines = input.command.lines();
                let first_line = lines.next().unwrap_or_default();
                let remaining_line_count = lines.count();
                match remaining_line_count {
                    0 => MarkdownString::inline_code(&first_line).0,
                    1 => {
                        MarkdownString::inline_code(&format!(
                            "{} - {} more line",
                            first_line, remaining_line_count
                        ))
                        .0
                    }
                    n => {
                        MarkdownString::inline_code(&format!("{} - {} more lines", first_line, n)).0
                    }
                }
            }
            Err(_) => "Run bash command".to_string(),
        }
    }

    fn run(
        self: Arc<Self>,
        input: serde_json::Value,
        _messages: &[LanguageModelRequestMessage],
        project: Entity<Project>,
        _action_log: Entity<ActionLog>,
        cx: &mut App,
    ) -> Task<Result<String>> {
        let input: BashToolInput = match serde_json::from_value(input) {
            Ok(input) => input,
            Err(err) => return Task::ready(Err(anyhow!(err))),
        };

        let project = project.read(cx);
        let input_path = Path::new(&input.cd);
        let working_dir = if input.cd == "." {
            // Accept "." as meaning "the one worktree" if we only have one worktree.
            let mut worktrees = project.worktrees(cx);

            let only_worktree = match worktrees.next() {
                Some(worktree) => worktree,
                None => return Task::ready(Err(anyhow!("No worktrees found in the project"))),
            };

            if worktrees.next().is_some() {
                return Task::ready(Err(anyhow!(
                    "'.' is ambiguous in multi-root workspaces. Please specify a root directory explicitly."
                )));
            }

            only_worktree.read(cx).abs_path()
        } else if input_path.is_absolute() {
            // Absolute paths are allowed, but only if they're in one of the project's worktrees.
            if !project
                .worktrees(cx)
                .any(|worktree| input_path.starts_with(&worktree.read(cx).abs_path()))
            {
                return Task::ready(Err(anyhow!(
                    "The absolute path must be within one of the project's worktrees"
                )));
            }

            input_path.into()
        } else {
            let Some(worktree) = project.worktree_for_root_name(&input.cd, cx) else {
                return Task::ready(Err(anyhow!(
                    "`cd` directory {} not found in the project",
                    &input.cd
                )));
            };

            worktree.read(cx).abs_path()
        };

        cx.background_spawn(run_command_limited(working_dir, input.command))
    }
}

const LIMIT: usize = 16 * 1024;

async fn run_command_limited(working_dir: Arc<Path>, command: String) -> Result<String> {
    // Add 2>&1 to merge stderr into stdout for proper interleaving.
    let command = format!("({}) 2>&1", command);

    let mut cmd = new_smol_command("bash")
        .arg("-c")
        .arg(&command)
        .current_dir(working_dir)
        .stdout(std::process::Stdio::piped())
        .spawn()
        .context("Failed to execute bash command")?;

    // Capture stdout with a limit
    let stdout = cmd.stdout.take().unwrap();
    let mut reader = BufReader::new(stdout);

    // Read one more byte to determine whether the output was truncated
    let mut buffer = vec![0; LIMIT + 1];
    let mut bytes_read = 0;

    // Read until we reach the limit
    loop {
        let read = reader.read(&mut buffer[bytes_read..]).await?;
        if read == 0 {
            break;
        }

        bytes_read += read;
        if bytes_read > LIMIT {
            bytes_read = LIMIT + 1;
            break;
        }
    }

    // Repeatedly fill the output reader's buffer without copying it.
    loop {
        let skipped_bytes = reader.fill_buf().await?;
        if skipped_bytes.is_empty() {
            break;
        }
        let skipped_bytes_len = skipped_bytes.len();
        reader.consume_unpin(skipped_bytes_len);
    }

    let output_bytes = &buffer[..bytes_read.min(LIMIT)];

    let status = cmd.status().await.context("Failed to get command status")?;

    let output_string = if bytes_read > LIMIT {
        // Valid to find `\n` in UTF-8 since 0-127 ASCII characters are not used in
        // multi-byte characters.
        let last_line_ix = output_bytes.iter().rposition(|b| *b == b'\n');
        let until_last_line = &output_bytes[..last_line_ix.unwrap_or(output_bytes.len())];
        let output_string = String::from_utf8_lossy(until_last_line);

        format!(
            "Command output too long. The first {} bytes:\n\n{}",
            output_string.len(),
            output_block(&output_string),
        )
    } else {
        output_block(&String::from_utf8_lossy(&output_bytes))
    };

    let output_with_status = if status.success() {
        if output_string.is_empty() {
            "Command executed successfully.".to_string()
        } else {
            output_string.to_string()
        }
    } else {
        format!(
            "Command failed with exit code {}\n\n{}",
            status.code().unwrap_or(-1),
            output_string,
        )
    };

    Ok(output_with_status)
}

fn output_block(output: &str) -> String {
    format!(
        "```\n{}{}```",
        output,
        if output.ends_with('\n') { "" } else { "\n" }
    )
}

#[cfg(test)]
#[cfg(not(windows))]
mod tests {
    use gpui::TestAppContext;

    use super::*;

    #[gpui::test]
    async fn test_run_command_simple(cx: &mut TestAppContext) {
        cx.executor().allow_parking();

        let result =
            run_command_limited(Path::new(".").into(), "echo 'Hello, World!'".to_string()).await;

        assert!(result.is_ok());
        assert_eq!(result.unwrap(), "```\nHello, World!\n```");
    }

    #[gpui::test]
    async fn test_interleaved_stdout_stderr(cx: &mut TestAppContext) {
        cx.executor().allow_parking();

        let command =
            "echo 'stdout 1' && echo 'stderr 1' >&2 && echo 'stdout 2' && echo 'stderr 2' >&2";
        let result = run_command_limited(Path::new(".").into(), command.to_string()).await;

        assert!(result.is_ok());
        assert_eq!(
            result.unwrap(),
            "```\nstdout 1\nstderr 1\nstdout 2\nstderr 2\n```"
        );
    }

    #[gpui::test]
    async fn test_multiple_output_reads(cx: &mut TestAppContext) {
        cx.executor().allow_parking();

        // Command with multiple outputs that might require multiple reads
        let result = run_command_limited(
            Path::new(".").into(),
            "echo '1'; sleep 0.01; echo '2'; sleep 0.01; echo '3'".to_string(),
        )
        .await;

        assert!(result.is_ok());
        assert_eq!(result.unwrap(), "```\n1\n2\n3\n```");
    }

    #[gpui::test]
    async fn test_output_truncation_single_line(cx: &mut TestAppContext) {
        cx.executor().allow_parking();

        let cmd = format!("echo '{}';", "X".repeat(LIMIT * 2));

        let result = run_command_limited(Path::new(".").into(), cmd).await;

        assert!(result.is_ok());
        let output = result.unwrap();

        let content_start = output.find("```\n").map(|i| i + 4).unwrap_or(0);
        let content_end = output.rfind("\n```").unwrap_or(output.len());
        let content_length = content_end - content_start;

        // Output should be exactly the limit
        assert_eq!(content_length, LIMIT);
    }

    #[gpui::test]
    async fn test_output_truncation_multiline(cx: &mut TestAppContext) {
        cx.executor().allow_parking();

        let cmd = format!("echo '{}'; ", "X".repeat(120)).repeat(160);
        let result = run_command_limited(Path::new(".").into(), cmd).await;

        assert!(result.is_ok());
        let output = result.unwrap();

        assert!(output.starts_with("Command output too long. The first 16334 bytes:\n\n"));

        let content_start = output.find("```\n").map(|i| i + 4).unwrap_or(0);
        let content_end = output.rfind("\n```").unwrap_or(output.len());
        let content_length = content_end - content_start;

        assert!(content_length <= LIMIT);
    }
}