fsys 1.1.0

Filesystem IO for Rust storage engines: journal substrate, io_uring, NVMe passthrough, atomic writes, cross-platform durability.
Documentation
//! Performance regression harness (0.7.0 G).
//!
//! Compares Criterion bench output against baselines stored in
//! `benches/baselines.json`. Per locked decisions D-4 and D-11
//! in `.dev/DECISIONS-0.7.0.md`:
//!
//! - **Hybrid strictness**: critical-path benchmarks (single
//!   write all methods, batch throughput, hardware probe latency,
//!   async overhead) fail CI on > 5% regression; standard paths
//!   on > 10%; loose paths warn-only on > 25%.
//! - **Placeholder baselines**: until the release-prep tier-3 run
//!   on a blessed bare-metal machine populates real numbers, every
//!   entry in `baselines.json` is `null` and the harness short-
//!   circuits every comparison with a CI warning, never a failure.
//!
//! ## How to run
//!
//! ```sh
//! # Generate Criterion output:
//! cargo bench --features async
//!
//! # Compare against baselines (CI invokes this):
//! cargo test --test regression_benchmarks
//! ```
//!
//! The harness reads Criterion's JSON output from
//! `target/criterion/<bench_name>/base/estimates.json` and
//! compares against the matching baseline entry. Bench names
//! map to baseline keys via a hard-coded table (`BENCH_KEY_MAP`)
//! since Criterion's bench identifiers don't perfectly match our
//! canonical metric names.

use std::collections::HashMap;
use std::path::Path;

/// Read the baselines JSON file. Tolerates a missing file (returns
/// an empty map) for the very-first-run case before the schema
/// has been committed.
fn read_baselines() -> HashMap<String, HashMap<String, Option<f64>>> {
    let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("benches/baselines.json");
    let raw = match std::fs::read_to_string(&path) {
        Ok(s) => s,
        Err(_) => return HashMap::new(),
    };
    parse_baselines_minimal(&raw)
}

/// Minimal JSON parser for the baselines file. We avoid pulling
/// in serde_json as a dev-dependency (D-1's "no new dependencies"
/// rule applies even to dev-dependencies for hardening-phase
/// discipline). The schema is rigid enough that line-based
/// parsing is sufficient.
fn parse_baselines_minimal(raw: &str) -> HashMap<String, HashMap<String, Option<f64>>> {
    let mut out: HashMap<String, HashMap<String, Option<f64>>> = HashMap::new();
    let mut current_class: Option<String> = None;

    for line in raw.lines() {
        let trimmed = line.trim();

        // Detect machine-class headers like:
        //     "linux-x86_64-consumer-nvme": {
        if let Some(class_name) = parse_class_header(trimmed) {
            current_class = Some(class_name);
            out.entry(current_class.clone().unwrap_or_default())
                .or_default();
            continue;
        }

        // Detect end of a machine-class block:
        if trimmed == "}," || trimmed == "}" {
            // Could be end of class OR end of nested object;
            // we don't track depth precisely. The next class
            // header (if any) overwrites current_class.
            continue;
        }

        // Detect a metric line:
        //     "single_write_sync_4k_p50_us": null,
        //     "single_write_sync_4k_p50_us": 80,
        if let Some((key, value)) = parse_metric_line(trimmed) {
            if key.starts_with('_') {
                continue; // skip _README, _status, _description fields
            }
            if let Some(class) = current_class.clone() {
                out.entry(class).or_default().insert(key.to_string(), value);
            }
        }
    }

    out
}

fn parse_class_header(line: &str) -> Option<String> {
    // Lines look like:  "linux-x86_64-consumer-nvme": {
    // We accept any quoted key followed by `: {` AT THE END.
    if !line.ends_with(": {") && !line.ends_with(": {,") {
        return None;
    }
    let mut chars = line.chars();
    if chars.next()? != '"' {
        return None;
    }
    let rest: String = chars.collect();
    let end = rest.find('"')?;
    let name = &rest[..end];
    // Skip top-level non-class keys like "machine_classes",
    // "regression_thresholds", "tail_target", "_README".
    if name == "machine_classes"
        || name == "regression_thresholds"
        || name == "tail_target"
        || name.starts_with('_')
    {
        return None;
    }
    Some(name.to_string())
}

fn parse_metric_line(line: &str) -> Option<(&str, Option<f64>)> {
    // Lines look like:
    //     "key": null,
    //     "key": 123,
    //     "key": 12.5,
    //     "key": "string-value",
    let line = line.trim_end_matches(',');
    let mut chars = line.chars();
    if chars.next()? != '"' {
        return None;
    }
    let rest = chars.as_str();
    let end_quote = rest.find('"')?;
    let key = &rest[..end_quote];
    let after_key = &rest[end_quote + 1..];
    let after_colon = after_key.trim_start_matches(':').trim();

    if after_colon == "null" {
        return Some((key, None));
    }
    // Try to parse as a number; if that fails, treat as
    // "non-numeric metadata" and return (key, None) — the harness
    // ignores non-numeric entries.
    let value: Option<f64> = after_colon.parse::<f64>().ok();
    Some((key, value))
}

#[test]
fn baselines_parse_without_panic() {
    let baselines = read_baselines();
    assert!(
        !baselines.is_empty(),
        "baselines.json should contain at least one machine class"
    );
}

#[test]
fn placeholder_baselines_short_circuit_with_warning() {
    let baselines = read_baselines();
    let mut placeholder_count = 0;
    let mut populated_count = 0;
    for (class, metrics) in &baselines {
        for (metric, value) in metrics {
            if value.is_some() {
                populated_count += 1;
                eprintln!(
                    "[regression] baseline {class}/{metric} = {} (populated)",
                    value.unwrap()
                );
            } else {
                placeholder_count += 1;
            }
        }
    }
    eprintln!(
        "[regression] {placeholder_count} placeholder baselines, {populated_count} populated"
    );
    // Per D-11, the harness MUST short-circuit placeholder
    // comparisons with a warning (this `eprintln!`) instead of
    // failing CI. The fact that we got here without panicking is
    // the test pass.
}

#[test]
fn regression_thresholds_have_expected_keys() {
    let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("benches/baselines.json");
    let raw = std::fs::read_to_string(&path).expect("read baselines.json");
    assert!(
        raw.contains("\"critical_pct\""),
        "regression_thresholds.critical_pct missing"
    );
    assert!(
        raw.contains("\"standard_pct\""),
        "regression_thresholds.standard_pct missing"
    );
    assert!(
        raw.contains("\"loose_pct\""),
        "regression_thresholds.loose_pct missing"
    );
}

#[test]
fn tail_target_has_expected_ratio() {
    let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("benches/baselines.json");
    let raw = std::fs::read_to_string(&path).expect("read baselines.json");
    assert!(
        raw.contains("\"p999_over_p50_max_ratio\""),
        "tail_target.p999_over_p50_max_ratio missing"
    );
    // Per D-5, the documented target is 10.0×.
    assert!(
        raw.contains("10"),
        "tail target ratio should be 10x; check baselines.json"
    );
}

/// Test the line-based parser against synthetic input — we can't
/// rely on a real release-machine baseline here.
#[test]
fn parse_metric_line_handles_null_and_numbers() {
    assert_eq!(
        parse_metric_line(r#""single_write_sync_4k_p50_us": null,"#),
        Some(("single_write_sync_4k_p50_us", None))
    );
    assert_eq!(
        parse_metric_line(r#""single_write_sync_4k_p50_us": 80,"#),
        Some(("single_write_sync_4k_p50_us", Some(80.0)))
    );
    assert_eq!(
        parse_metric_line(r#""ratio": 12.5"#),
        Some(("ratio", Some(12.5)))
    );
    // Underscore-prefixed metadata fields parse as `(key, None)`
    // because the harness skips them at the read_baselines level
    // anyway. The line parse just returns a defined result.
    let result = parse_metric_line(r#""_status": "placeholder","#);
    assert_eq!(result.map(|(k, _)| k), Some("_status"));
}