kimun_notes/components/text_editor/

widener_metrics.rs

//! Counters for the hybrid widener's per-keystroke outcomes.
//!
//! Always on (atomic increments cost ~5ns). Surfaced when the env
//! var `KIMUN_DUMP_WIDENER_METRICS=1` is set: [`dump_if_enabled`]
//! prints the snapshot to stderr at app exit.
//!
//! Categories are exclusive — each call to
//! `MarkdownEditorView::try_incremental_parse` increments exactly one
//! of {`incremental_reset`, `incremental_fallback`,
//! `full_line_count_change`, `full_kind_guard`, `full_lazy_depth`,
//! `full_blank_transition`, `full_cap_trip`, `full_verify_failed`,
//! `full_downstream_flip`,
//! `full_no_damage`}. `attempted` is the sum.
//!
//! Derived metrics the consumer cares about:
//!
//! - successful_incremental_rate
//!   = (reset + fallback) / attempted
//! - fast_path_share
//!   = reset / (reset + fallback)
//!   — climbing toward 1 means Option A (tighten reset_boundaries)
//!   would eliminate the fallback path's overhead with low impact.
//! - guard_sprawl
//!   = (kind_guard + lazy_depth + blank_transition) / attempted
//!   — high values mean the call-site guard tower is the bottleneck
//!   and the underlying boundary model is too loose.
//! - verify_hit_rate
//!   = verify_failed / fallback
//!   — non-zero proves widen_to_safe needs the verify in release;
//!   zero across many sessions argues for demoting verify to debug.

use std::sync::atomic::{AtomicU64, Ordering};

/// Why `try_incremental_parse` did NOT take the splice path. One of
/// these is recorded for every full rebuild; on success a separate
/// `IncrementalReset` / `IncrementalFallback` is recorded.
#[derive(Debug, Clone, Copy)]
pub enum BailReason {
    /// Line-count gate at the top of `try_incremental_parse`.
    LineCountChange,
    /// `compute_damage_range` returned None — no actual text change
    /// despite the generation bump.
    NoDamage,
    /// One of the v1 `looks_like_*` flip checks or kind-was-marker
    /// guards triggered.
    KindGuard,
    /// V2 `lazy_depth[row±1] > 0` guard triggered.
    LazyDepth,
    /// V2 blank ↔ non-blank transition with non-blank neighbour
    /// triggered.
    BlankTransition,
    /// Both `expand_to_reset_boundary` AND `widen_to_safe` returned
    /// `FullRebuild` — no widening fits under the caps.
    CapTrip,
    /// Post-slice undamaged-row verify (widen_to_safe fallback path)
    /// detected a kinds/elements/content_vis divergence.
    VerifyFailed,
    /// Downstream verify (the reset-boundary walk past `widened.end`) found a
    /// row the splice would not replace whose classification the edit changed.
    ///
    /// Separate from [`Self::VerifyFailed`] because they answer different
    /// questions. The in-window verify says the slice disagrees with the parent
    /// where it overlaps it; this says the edit reached *past* the window. Only
    /// the second gates the `Blockquote`/`ListContinuation` relaxation, so
    /// conflating them hides whether that relaxation is paying for itself.
    DownstreamFlip,
}

/// Which widener produced the splice that succeeded.
#[derive(Debug, Clone, Copy)]
pub enum SuccessPath {
    /// `expand_to_reset_boundary(reset_boundaries, ...)` succeeded —
    /// the boundary set is known reset, so no post-slice verify
    /// ran. Provably equivalent to a fresh parse.
    ResetBoundary,
    /// `widen_to_safe` succeeded after the strict reset-boundary
    /// widener returned `FullRebuild`. The post-slice verify ran
    /// and passed.
    WidenToSafe,
}

pub struct WidenerMetrics {
    pub incremental_reset: AtomicU64,
    pub incremental_fallback: AtomicU64,
    pub full_line_count_change: AtomicU64,
    pub full_no_damage: AtomicU64,
    pub full_kind_guard: AtomicU64,
    pub full_lazy_depth: AtomicU64,
    pub full_blank_transition: AtomicU64,
    pub full_cap_trip: AtomicU64,
    pub full_verify_failed: AtomicU64,
    pub full_downstream_flip: AtomicU64,
}

impl WidenerMetrics {
    const fn new() -> Self {
        Self {
            incremental_reset: AtomicU64::new(0),
            incremental_fallback: AtomicU64::new(0),
            full_line_count_change: AtomicU64::new(0),
            full_no_damage: AtomicU64::new(0),
            full_kind_guard: AtomicU64::new(0),
            full_lazy_depth: AtomicU64::new(0),
            full_blank_transition: AtomicU64::new(0),
            full_cap_trip: AtomicU64::new(0),
            full_verify_failed: AtomicU64::new(0),
            full_downstream_flip: AtomicU64::new(0),
        }
    }

    /// Record a full-rebuild outcome and return `None` so callers can
    /// `return METRICS.bail(...)` in one line.
    pub fn bail<T>(&self, reason: BailReason) -> Option<T> {
        let counter = match reason {
            BailReason::LineCountChange => &self.full_line_count_change,
            BailReason::NoDamage => &self.full_no_damage,
            BailReason::KindGuard => &self.full_kind_guard,
            BailReason::LazyDepth => &self.full_lazy_depth,
            BailReason::BlankTransition => &self.full_blank_transition,
            BailReason::CapTrip => &self.full_cap_trip,
            BailReason::VerifyFailed => &self.full_verify_failed,
            BailReason::DownstreamFlip => &self.full_downstream_flip,
        };
        counter.fetch_add(1, Ordering::Relaxed);
        None
    }

    /// Record a successful incremental splice.
    pub fn ok(&self, path: SuccessPath) {
        let counter = match path {
            SuccessPath::ResetBoundary => &self.incremental_reset,
            SuccessPath::WidenToSafe => &self.incremental_fallback,
        };
        counter.fetch_add(1, Ordering::Relaxed);
    }

    /// Read every counter into a snapshot for printing/derivations.
    pub fn snapshot(&self) -> Snapshot {
        Snapshot {
            incremental_reset: self.incremental_reset.load(Ordering::Relaxed),
            incremental_fallback: self.incremental_fallback.load(Ordering::Relaxed),
            full_line_count_change: self.full_line_count_change.load(Ordering::Relaxed),
            full_no_damage: self.full_no_damage.load(Ordering::Relaxed),
            full_kind_guard: self.full_kind_guard.load(Ordering::Relaxed),
            full_lazy_depth: self.full_lazy_depth.load(Ordering::Relaxed),
            full_blank_transition: self.full_blank_transition.load(Ordering::Relaxed),
            full_cap_trip: self.full_cap_trip.load(Ordering::Relaxed),
            full_verify_failed: self.full_verify_failed.load(Ordering::Relaxed),
            full_downstream_flip: self.full_downstream_flip.load(Ordering::Relaxed),
        }
    }
}

pub static METRICS: WidenerMetrics = WidenerMetrics::new();

#[derive(Debug, Clone, Copy)]
pub struct Snapshot {
    pub incremental_reset: u64,
    pub incremental_fallback: u64,
    pub full_line_count_change: u64,
    pub full_no_damage: u64,
    pub full_kind_guard: u64,
    pub full_lazy_depth: u64,
    pub full_blank_transition: u64,
    pub full_cap_trip: u64,
    pub full_verify_failed: u64,
    pub full_downstream_flip: u64,
}

impl Snapshot {
    pub fn attempted(&self) -> u64 {
        self.incremental_reset
            + self.incremental_fallback
            + self.full_line_count_change
            + self.full_no_damage
            + self.full_kind_guard
            + self.full_lazy_depth
            + self.full_blank_transition
            + self.full_cap_trip
            + self.full_verify_failed
            + self.full_downstream_flip
    }

    pub fn successful_incremental(&self) -> u64 {
        self.incremental_reset + self.incremental_fallback
    }

    pub fn successful_incremental_rate(&self) -> f64 {
        let denom = self.attempted();
        if denom == 0 {
            0.0
        } else {
            self.successful_incremental() as f64 / denom as f64
        }
    }

    /// Share of successful incremental splices taken by the strict
    /// reset-boundary path. Mirror `heuristic_path_share` for the
    /// other tier — together they sum to ≤ 1 (rounding aside).
    pub fn fast_path_share(&self) -> f64 {
        let denom = self.successful_incremental();
        if denom == 0 {
            0.0
        } else {
            self.incremental_reset as f64 / denom as f64
        }
    }

    pub fn heuristic_path_share(&self) -> f64 {
        let denom = self.successful_incremental();
        if denom == 0 {
            0.0
        } else {
            self.incremental_fallback as f64 / denom as f64
        }
    }

    pub fn guard_sprawl_rate(&self) -> f64 {
        let denom = self.attempted();
        if denom == 0 {
            0.0
        } else {
            (self.full_kind_guard + self.full_lazy_depth + self.full_blank_transition) as f64
                / denom as f64
        }
    }

    pub fn verify_hit_rate(&self) -> f64 {
        // Verify runs on the widen_to_safe (heuristic) path only.
        // Hit rate = verify_failed / (verify_failed + verify-eligible-success).
        // Deliberately excludes `full_downstream_flip`: that verify runs on a
        // different condition (a relaxed kind, not the heuristic path) and has no
        // counted denominator here, so folding it in would produce a rate over a
        // population it was not measured against.
        let denom = self.full_verify_failed + self.incremental_fallback;
        if denom == 0 {
            0.0
        } else {
            self.full_verify_failed as f64 / denom as f64
        }
    }
}

/// Print the snapshot to stderr when `KIMUN_DUMP_WIDENER_METRICS=1`.
/// No-op otherwise. Intended for the app shutdown path.
pub fn dump_if_enabled() {
    if std::env::var("KIMUN_DUMP_WIDENER_METRICS").as_deref() != Ok("1") {
        return;
    }
    let s = METRICS.snapshot();
    eprintln!(
        "[widener-metrics] session totals\n  \
         incremental_reset           = {:>10}  ({:5.1}%)\n  \
         incremental_fallback        = {:>10}  ({:5.1}%)\n  \
         full_line_count_change      = {:>10}  ({:5.1}%)\n  \
         full_no_damage              = {:>10}  ({:5.1}%)\n  \
         full_kind_guard             = {:>10}  ({:5.1}%)\n  \
         full_lazy_depth             = {:>10}  ({:5.1}%)\n  \
         full_blank_transition       = {:>10}  ({:5.1}%)\n  \
         full_cap_trip               = {:>10}  ({:5.1}%)\n  \
         full_verify_failed          = {:>10}  ({:5.1}%)\n  \
         attempted (categorised)     = {:>10}\n  \
         ---\n  \
         successful_incremental_rate = {:5.1}%\n  \
         fast_path_share             = {:5.1}%\n  \
         heuristic_path_share        = {:5.1}%\n  \
         guard_sprawl_rate           = {:5.1}%\n  \
         verify_hit_rate             = {:5.1}%",
        s.incremental_reset,
        pct(s.incremental_reset, s.attempted()),
        s.incremental_fallback,
        pct(s.incremental_fallback, s.attempted()),
        s.full_line_count_change,
        pct(s.full_line_count_change, s.attempted()),
        s.full_no_damage,
        pct(s.full_no_damage, s.attempted()),
        s.full_kind_guard,
        pct(s.full_kind_guard, s.attempted()),
        s.full_lazy_depth,
        pct(s.full_lazy_depth, s.attempted()),
        s.full_blank_transition,
        pct(s.full_blank_transition, s.attempted()),
        s.full_cap_trip,
        pct(s.full_cap_trip, s.attempted()),
        s.full_verify_failed,
        pct(s.full_verify_failed, s.attempted()),
        s.attempted(),
        s.successful_incremental_rate() * 100.0,
        s.fast_path_share() * 100.0,
        s.heuristic_path_share() * 100.0,
        s.guard_sprawl_rate() * 100.0,
        s.verify_hit_rate() * 100.0,
    );
}

fn pct(numer: u64, denom: u64) -> f64 {
    if denom == 0 {
        0.0
    } else {
        (numer as f64 / denom as f64) * 100.0
    }
}