run-benchmarks.sh

#!/bin/bash

# Benchmark runner script for the Image Color Palette Extractor
# This script runs comprehensive performance benchmarks

echo "🚀 Running Image Color Palette Extractor Benchmarks"
echo "====================================================="

# Function to check if command exists
command_exists() {
    command -v "$1" >/dev/null 2>&1
}

# Check if cargo is installed
if ! command_exists cargo; then
    echo "❌ Cargo is not installed!"
    echo "Please install Rust and Cargo from https://rustup.rs/"
    exit 1
fi

# Ensure wasmtime is installed (via cargo) and available in PATH for this session
ensure_wasmtime() {
    if command_exists wasmtime; then
        echo "✅ wasmtime is already installed."
        return 0
    fi

    echo "⚠️ wasmtime not found. Installing via 'cargo install wasmtime-cli'..."
    cargo install wasmtime-cli
    if [ $? -ne 0 ]; then
        echo "❌ Failed to install wasmtime via cargo."
        return 1
    fi

    # add cargo bin to PATH for this execution
    if [ -n "$CARGO_HOME" ]; then
        cargo_bin="$CARGO_HOME/bin"
    else
        cargo_bin="$HOME/.cargo/bin"
    fi

    if [ -d "$cargo_bin" ]; then
        PATH="$cargo_bin:$PATH"
        export PATH
    fi

    if command_exists wasmtime; then
        echo "✅ wasmtime installed and available."
        return 0
    else
        echo "❌ wasmtime still not available after install. Please add $cargo_bin to your PATH."
        return 1
    fi
}

# Ensure wasm32-wasi target is installed
ensure_wasi_target() {
    if ! command_exists rustup; then
        echo "⚠️ rustup not found; cannot auto-add wasm32-wasi target. Skipping wasm builds."
        return 1
    fi

    echo "🔧 Ensuring a WASI-compatible target is installed (trying 'wasm32-wasi' then 'wasm32-wasip1')..."
    # Try wasm32-wasi first
    if rustup target add wasm32-wasi >/dev/null 2>&1; then
        wasm_target="wasm32-wasi"
        echo "✅ wasm32-wasi target ready."
        return 0
    fi

    # Fallback to wasm32-wasip1 when wasm32-wasi isn't supported on this toolchain
    if rustup target add wasm32-wasip1 >/dev/null 2>&1; then
        wasm_target="wasm32-wasip1"
        echo "✅ wasm32-wasip1 target ready (will use wasm32-wasip1)."
        return 0
    fi

    echo "❌ Failed to add a WASI-compatible target (wasm32-wasi / wasm32-wasip1)."
    return 1
}

# default wasm target name; may be overridden by ensure_wasi_target
wasm_target="wasm32-wasi"

# Build and run a native benchmark by executing only real executables found in
# the target deps directory. This avoids attempting to run .wasm/.pdb/.d files.
run_native_bench() {
    bench="$1"
    host="$2"

    if [ -n "$host" ] && [[ "$host" == *-* ]]; then
        echo "📦 Building native bench '$bench' for $host (release)..."
        if ! cargo build -q --target "$host" --release --bench "$bench" >/dev/null 2>&1; then
            echo "❌ Failed to build native bench $bench for $host"
            return 1
        fi
        search_dir="target/$host/release/deps"
    else
        echo "📦 Building native bench '$bench' (release)..."
        if ! cargo build -q --release --bench "$bench" >/dev/null 2>&1; then
            echo "❌ Failed to build native bench $bench"
            return 1
        fi
        search_dir="target/release/deps"
    fi

    native_files=$(find "$search_dir" -type f -executable -name "*$bench*" 2>/dev/null || true)
    if [ -z "$native_files" ]; then
        echo "⚠️ No native benchmark artifact found to run for $bench in $search_dir."
        return 1
    fi

    for f in $native_files; do
        # Prefer using 'file' to determine if this artifact is an actual executable/script
        runnable=false
        if command_exists file; then
            desc=$(file -b "$f" 2>/dev/null || true)
            if echo "$desc" | grep -E 'ELF|executable|script|Mach-O' >/dev/null 2>&1; then
                runnable=true
            fi
        else
            # Fallback: require executable bit and avoid common non-binary extensions like .d
            if [ -x "$f" ] && ! [[ "$f" == *.d ]]; then
                runnable=true
            fi
        fi

        if [ "$runnable" != true ]; then
            echo "⚠️ Skipping non-runnable artifact: $f"
            continue
        fi

        echo "▶ Running native benchmark: $f"
        "$f"
        if [ $? -ne 0 ]; then
            echo "❌ native benchmark run failed: $f"
            return 1
        fi
    done

    return 0
}

echo ""
echo "📊 Available Benchmark Suites:"
echo "1. Full Benchmarks (comprehensive, ~5-10 minutes)"
echo "2. Micro Benchmarks (quick, ~30 seconds)"
echo "3. All Benchmarks"
echo ""

# CLI arg parsing: --suite <full|micro|all|1|2|3>  --toolchain <wasm|native|both|1|2|3>
while [ $# -gt 0 ]; do
    case "$1" in
        -s|--suite)
            suite_arg="$2"; shift 2; ;;
        -o|--report-out)
            report_out="$2"; shift 2; ;;
        -t|--toolchain)
            tool_arg="$2"; shift 2; ;;
        --help)
            echo "Usage: $0 [-s|--suite <full|micro|all|1|2|3>] [-t|--toolchain <wasm|native|both|1|2|3>]"; exit 0 ;;
        *)
            echo "Unknown argument: $1"; shift ;;
    esac
done

choice=""
if [ -n "$suite_arg" ]; then
    case "${suite_arg,,}" in
        1|full) choice=1 ;;
        2|micro) choice=2 ;;
        3|all) choice=3 ;;
        *) echo "⚠️ Unknown suite '$suite_arg'; falling back to interactive prompt." ;;
    esac
fi

toolChoice=""
if [ -n "$tool_arg" ]; then
    case "${tool_arg,,}" in
        1|wasm) toolChoice=1 ;;
        2|native) toolChoice=2 ;;
        3|both) toolChoice=3 ;;
        *) echo "⚠️ Unknown toolchain '$tool_arg'; falling back to interactive prompt." ;;
    esac
fi

if [ -z "$choice" ]; then
    read -p "Select benchmark suite (1-3, or 'q' to quit): " choice
fi

if [ -z "$toolChoice" ]; then
    echo ""
    echo "Which toolchains should the benchmarks run on?"
    echo "1. wasm (wasm32-wasi + wasmtime)"
    echo "2. native (host architecture)"
    echo "3. both"
    read -p "Select toolchain (1-3): " toolChoice
fi

runWasm=false
runNative=false
case $toolChoice in
    1) runWasm=true ;;
    2) runNative=true ;;
    3) runWasm=true; runNative=true ;;
    *) echo "⚠️ Invalid toolchain choice; defaulting to native only."; runNative=true ;;
esac

# Prepare wasm support only when requested
canRunWasm=false
if $runWasm; then
    if ensure_wasmtime && ensure_wasi_target; then
        canRunWasm=true
    else
        echo "⚠️ wasm toolchain unavailable; wasm runs will be skipped."
        canRunWasm=false
    fi
fi

# Auto-detect host target triple (fallback to x86_64-pc-windows-msvc)
host_target="x86_64-pc-windows-msvc"
if command_exists rustc; then
    host_line=$(rustc -vV 2>/dev/null | grep '^host:')
    if [ -n "$host_line" ]; then
        host_target=$(echo "$host_line" | awk '{print $2}')
    else
        echo "⚠️ Could not detect host target via rustc; defaulting to $host_target"
    fi
else
    echo "⚠️ rustc not found; defaulting host target to $host_target"
fi

case $choice in
    1)
        echo ""
        echo "🔄 Running Full Benchmark Suite..."
        echo "-----------------------------------"

        if $runWasm && $canRunWasm; then
            echo "📦 Building wasm full benchmark (release) for $wasm_target..."
            cargo build --target "$wasm_target" --release --bench palette_extraction_benchmarks
            if [ $? -ne 0 ]; then
                echo "⚠️ Building wasm full benchmark failed; continuing to native run."
            else
                wasm_files=$(find "target/$wasm_target/release/deps" -name "*palette_extraction_benchmarks*.wasm" 2>/dev/null || true)
                if [ -n "$wasm_files" ]; then
                    for f in $wasm_files; do
                        echo "▶ Running wasm full benchmark: $f"
                        wasmtime "$f"
                        if [ $? -ne 0 ]; then
                            echo "❌ wasm full benchmark run failed: $f"
                        fi
                    done
                else
                    echo "⚠️ No wasm full benchmark artifact found to run."
                fi
            fi
        else
            echo "⚠️ Skipping wasm full benchmark." 
        fi

        if $runNative; then
            echo "\n📊 Running full benchmarks (native) on $host_target..."
            if run_native_bench "palette_extraction_benchmarks" "$host_target"; then
                echo "✅ Full benchmarks completed!"
            else
                echo "❌ Full benchmarks failed!"
                exit 1
            fi
        fi
        ;;
    2)
        echo ""
        echo "⚡ Running Micro Benchmark Suite..."
        echo "------------------------------------"
        if $runNative; then
            if run_native_bench "micro_benchmarks" "$host_target"; then
                echo "✅ Micro benchmarks (native) completed!"
            else
                echo "❌ Micro benchmarks (native) failed!"
                exit 1
            fi
        fi

        if $runWasm && $canRunWasm; then
            echo "📦 Building wasm micro benchmark (release) for $wasm_target..."
            cargo build --target "$wasm_target" --release --bench micro_benchmarks
            if [ $? -ne 0 ]; then
                echo "❌ Building wasm micro benchmark failed; skipping wasm run."
            else
                wasm_files=$(find "target/$wasm_target/release/deps" -name "*micro_benchmarks*.wasm" 2>/dev/null || true)
                if [ -n "$wasm_files" ]; then
                    for f in $wasm_files; do
                        echo "▶ Running wasm micro benchmark: $f"
                        wasmtime "$f"
                        if [ $? -ne 0 ]; then
                            echo "❌ wasm micro benchmark run failed: $f"
                        fi
                    done
                else
                    echo "⚠️ No wasm micro benchmark artifact found to run."
                fi
            fi
        fi
        ;;
    3)
        echo ""
        echo "🔄 Running All Benchmark Suites..."
        echo "-----------------------------------"

        if $runNative; then
            echo "⚡ Starting with micro benchmarks (native) on $host_target..."
            if ! run_native_bench "micro_benchmarks" "$host_target"; then
                echo "❌ Micro benchmarks (native) failed!"
                exit 1
            fi

            echo ""
            echo "📊 Running full benchmarks (native) on $host_target..."
            if ! run_native_bench "palette_extraction_benchmarks" "$host_target"; then
                echo "❌ Full benchmarks (native) failed!"
                exit 1
            fi
        fi

        if $runWasm && $canRunWasm; then
            echo "\n🔁 Running wasm variants..."
            echo "📦 Building wasm micro benchmark (release) for $wasm_target..."
            cargo build --target "$wasm_target" --release --bench micro_benchmarks
            if [ $? -eq 0 ]; then
                wasm_files=$(find "target/$wasm_target/release/deps" -name "*micro_benchmarks*.wasm" 2>/dev/null || true)
                if [ -n "$wasm_files" ]; then
                    for f in $wasm_files; do
                        echo "▶ Running wasm micro benchmark: $f"
                        wasmtime "$f"
                    done
                fi
            else
                echo "⚠️ Building wasm micro benchmark failed; skipping."
            fi

            echo "📦 Building wasm full benchmark (release) for $wasm_target..."
            cargo build --target "$wasm_target" --release --bench palette_extraction_benchmarks
            if [ $? -eq 0 ]; then
                wasm_files=$(find "target/$wasm_target/release/deps" -name "*palette_extraction_benchmarks*.wasm" 2>/dev/null || true)
                if [ -n "$wasm_files" ]; then
                    for f in $wasm_files; do
                        echo "▶ Running wasm full benchmark: $f"
                        wasmtime "$f"
                    done
                fi
            else
                echo "⚠️ Building wasm full benchmark failed; skipping."
            fi
        fi
        ;;
    q)
        echo "👋 Goodbye!"
        exit 0
        ;;
    *)
        echo "❌ Invalid choice. Please select 1, 2, 3, or 'q'"
        exit 1
        ;;
esac

echo ""
echo "📈 Benchmark Results Location:"
echo "- HTML Reports: target/criterion/"
echo "- Raw Data: target/criterion/*/base/"
echo ""
echo "💡 Tips:"
echo "- View detailed HTML reports by opening target/criterion/report/index.html"
echo "- Compare performance over time with: cargo bench -- --save-baseline baseline_name"
echo "- Run specific benchmarks with: cargo bench pattern_name"

# Optionally copy the Criterion HTML report to a destination directory
copy_criterion_report() {
    src="target/criterion/report"
    if [ ! -d "$src" ]; then
        echo "⚠️ Criterion report not found at '$src'. Nothing to copy."
        return 1
    fi

    if [ -z "$1" ]; then
        dest="$(pwd)/criterion-report"
    else
        dest="$1"
    fi

    mkdir -p "$dest"
    echo "📋 Copying Criterion report from '$src' to '$dest'..."
    cp -r "$src"/* "$dest"/
    if [ $? -eq 0 ]; then
        echo "✅ Report copied to: $dest"
        return 0
    else
        echo "❌ Failed to copy report to: $dest"
        return 1
    fi
}

if [ -n "$report_out" ]; then
    copy_criterion_report "$report_out"
else
    # Only prompt if stdin is a terminal
    if [ -t 0 ]; then
        read -p "Would you like to copy the HTML report to a directory? (y/N): " copy_choice
        if [ "${copy_choice,,}" = "y" ]; then
            read -p "Enter destination directory path (leave blank for ./criterion-report): " dest_path
            if [ -z "$dest_path" ]; then
                copy_criterion_report
            else
                copy_criterion_report "$dest_path"
            fi
        fi
    else
        echo "ℹ️ Non-interactive session: to copy the Criterion report provide --report-out <path>"
    fi
fi