microsandbox-cli 0.6.5

//! `msb ping` command — check agent reachability for running sandboxes.

use std::time::Duration;

use clap::Args;
use microsandbox::sandbox::Sandbox;

use crate::ui;

use super::common;

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Check whether one or more sandbox agents are reachable.
#[derive(Debug, Args)]
pub struct PingArgs {
    /// Sandbox(es) to ping. Required unless `--label` is given.
    #[arg(required_unless_present = "label")]
    pub names: Vec<String>,

    /// Ping every sandbox carrying this label (`KEY=VALUE`). Repeatable;
    /// AND-matched. Unioned with any explicitly named sandboxes.
    #[arg(long)]
    pub label: Vec<String>,

    /// Refresh the sandbox idle timer after a successful ping.
    #[arg(long)]
    pub touch: bool,

    /// Suppress progress output.
    #[arg(short, long)]
    pub quiet: bool,
}

//--------------------------------------------------------------------------------------------------
// Functions
//--------------------------------------------------------------------------------------------------

/// Execute the `msb ping` command.
pub async fn run(args: PingArgs) -> anyhow::Result<()> {
    let names = common::resolve_bulk_targets(&args.names, &args.label, args.quiet).await?;
    let mut failed = false;

    for name in &names {
        match ping_one(name, args.touch, args.quiet).await {
            Ok(()) => {}
            Err(e) => {
                if !args.quiet {
                    ui::error(&format!("{e}"));
                }
                failed = true;
            }
        }
    }

    if failed {
        std::process::exit(1);
    }

    Ok(())
}

async fn ping_one(name: &str, touch: bool, quiet: bool) -> anyhow::Result<()> {
    let handle = Sandbox::get(name).await?;
    let spinner = if quiet {
        ui::Spinner::quiet()
    } else {
        ui::Spinner::start("Pinging", name)
    };

    match handle.ping().await {
        Ok(result) => {
            spinner.finish_clear();
            if !quiet {
                ui::success(
                    "Reachable",
                    &format!("{} ({})", result.name, format_latency(result.latency)),
                );
            }
        }
        Err(e) => {
            spinner.finish_clear();
            return Err(e.into());
        }
    }

    if touch {
        touch_after_ping(name, quiet).await?;
    }

    Ok(())
}

async fn touch_after_ping(name: &str, quiet: bool) -> anyhow::Result<()> {
    let handle = Sandbox::get(name).await?;
    let spinner = if quiet {
        ui::Spinner::quiet()
    } else {
        ui::Spinner::start("Touching", name)
    };

    match handle.touch().await {
        Ok(_) => {
            spinner.finish_success("Touched");
            Ok(())
        }
        Err(e) => {
            spinner.finish_clear();
            Err(e.into())
        }
    }
}

fn format_latency(duration: Duration) -> String {
    if duration.as_secs() > 0 {
        return microsandbox_utils::format::format_duration(duration);
    }

    let millis = duration.as_millis();
    if millis > 0 {
        return format!("{millis}ms");
    }

    format!("{}us", duration.as_micros().max(1))
}

//--------------------------------------------------------------------------------------------------
// Tests
//--------------------------------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use clap::Parser;

    use super::*;

    #[derive(Parser)]
    struct TestCli {
        #[command(flatten)]
        args: PingArgs,
    }

    fn parse_ping_args(args: &[&str]) -> PingArgs {
        TestCli::parse_from(std::iter::once("msb").chain(args.iter().copied())).args
    }

    #[test]
    fn parses_one_name() {
        let args = parse_ping_args(&["api"]);

        assert_eq!(args.names, vec!["api"]);
    }

    #[test]
    fn parses_label_touch_and_quiet() {
        let args = parse_ping_args(&["--label", "app=api", "--touch", "--quiet"]);

        assert!(args.names.is_empty());
        assert_eq!(args.label, vec!["app=api"]);
        assert!(args.touch);
        assert!(args.quiet);
    }

    #[test]
    fn formats_subsecond_latency() {
        assert_eq!(format_latency(Duration::from_micros(700)), "700us");
        assert_eq!(format_latency(Duration::from_millis(8)), "8ms");
    }
}