fallow_output/

audit_brief.rs

//! Audit brief output contracts.

use crate::root_envelopes::{attach_telemetry_meta, serialize_named_json_output};
use fallow_types::envelope::{ElapsedMs, Meta, ToolVersion};
use serde::Serialize;
use serde_json::Value;

/// Wire version for the `fallow audit --brief --format json` envelope.
///
/// Version 13 tracks the embedded health contract: the required
/// `targets[].category` enum gained `resolve_hidden_coupling`.
pub const REVIEW_BRIEF_SCHEMA_VERSION: u32 = 13;

/// Maximum number of affected-but-not-in-diff paths sampled into
/// [`ImpactClosureFacts::affected_not_shown`].
///
/// The full count is preserved in [`ImpactClosureFacts::affected_count`]
/// (aggregate-before-truncate), so capping the sample never distorts the count,
/// and the SHAPE of the reach is carried by
/// [`ImpactClosureFacts::affected_by_dir`] rather than by which files landed in
/// the sample. Nothing that ranks or gates reads this list: the decision surface
/// takes its blast metric from the uncapped engine closure.
pub const AFFECTED_SAMPLE_CAP: usize = 10;

/// Maximum number of directories reported in
/// [`ImpactClosureFacts::affected_by_dir`]. Directories beyond the cap are the
/// lightest ones and are counted in
/// [`ImpactClosureFacts::affected_by_dir_omitted`].
pub const AFFECTED_DIR_CAP: usize = 25;

/// Maximum number of entries in [`ImpactClosureFacts::co_change_gap`]. The
/// full count is in [`ImpactClosureFacts::co_change_gap_count`].
pub const CO_CHANGE_GAP_CAP: usize = 10;

/// Independently-versioned wire-version newtype for the brief envelope.
/// Serializes as the integer `REVIEW_BRIEF_SCHEMA_VERSION`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[cfg_attr(
    feature = "schema",
    schemars(extend("const" = REVIEW_BRIEF_SCHEMA_VERSION))
)]
pub struct ReviewBriefSchemaVersion(pub u32);

impl Default for ReviewBriefSchemaVersion {
    fn default() -> Self {
        Self(REVIEW_BRIEF_SCHEMA_VERSION)
    }
}

/// Coarse risk classification for a changeset, a pure function of the change
/// size (file count plus, once threaded, net lines).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
pub enum RiskClass {
    /// Small, contained change.
    Low,
    /// Moderately sized change.
    Medium,
    /// Large change spanning many files or lines.
    High,
}

/// Suggested reviewer effort, a pure function of [`RiskClass`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
pub enum ReviewEffort {
    /// A quick scan is enough.
    Glance,
    /// A normal line-by-line review.
    Review,
    /// A careful, deep review is warranted.
    DeepDive,
}

/// Stage 0 of the brief: triage facts derived purely from the diff size.
///
/// `hunks` and `net_lines` are populated when the caller supplies parsed diff
/// evidence. They remain absent when no diff is available.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct DiffTriage {
    /// Number of changed files in the audit scope.
    pub files: usize,
    /// Number of diff hunks, or `None` when no diff evidence was supplied.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub hunks: Option<usize>,
    /// Net added-minus-removed lines, or `None` without diff evidence.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub net_lines: Option<i64>,
    /// Coarse risk class derived from the change size.
    pub risk_class: RiskClass,
    /// Suggested reviewer effort derived from `risk_class`.
    pub review_effort: ReviewEffort,
}

/// Stage 1 of the brief: graph-derived orientation facts.
///
/// `boundaries_touched` is derived from the run's boundary-violation zones.
/// `exports_added` and `api_width_delta` both report the exports-aware public
/// API widening count. Removed exports are not represented in this
/// widening-only signal. The set of modules the changed code reaches is Stage
/// 3's `impact_closure`, which owns both its magnitude and its paths.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct GraphFacts {
    /// Number of public API exports added by the changeset. Zero means the
    /// changeset adds no public API exports.
    pub exports_added: usize,
    /// Widening-only public API delta, currently equal to `exports_added`.
    /// Removed exports are not represented, so zero means no public API exports
    /// were added.
    pub api_width_delta: i64,
    /// Architecture boundary zones touched by the changeset, deduped and sorted.
    /// Derived from the run's boundary-violation findings.
    pub boundaries_touched: Vec<String>,
}

/// Stage 3 of the brief: the impact closure. The transitive
/// affected-but-not-in-diff set plus the coordination gap. The differentiator a
/// diff tool fundamentally cannot do, because it has no graph.
///
/// Honest scope (ADR-001, syntactic): the coordination gap is an attention
/// pointer at the exact inter-module failure mode, NOT a correctness proof.
#[derive(Debug, Clone, Default, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ImpactClosureFacts {
    /// The FULL number of files transitively affected by the changeset
    /// (reverse-deps + re-export chains) that are NOT in the diff. Computed
    /// BEFORE [`affected_not_shown`](Self::affected_not_shown) is capped to a
    /// sample, so it is always the true magnitude of the blast radius.
    pub affected_count: usize,
    /// A capped, path-sorted sample of the affected root-relative paths (at most
    /// [`AFFECTED_SAMPLE_CAP`]), deduped. The full count lives in
    /// [`affected_count`](Self::affected_count) and the distribution in
    /// [`affected_by_dir`](Self::affected_by_dir); use this list to jump to
    /// representative files, NEVER to enumerate the blast radius or to infer its
    /// shape. Because it is a prefix of the sorted set, it clusters in whichever
    /// directory sorts first. To reconstruct the full set, run
    /// `fallow check --impact-closure <path>` once per changed file and union the
    /// results: that flag seeds from a single file, so no single command
    /// reproduces this changeset-wide union.
    pub affected_not_shown: Vec<String>,
    /// The blast radius rolled up by parent directory: how the affected files
    /// distribute, heaviest directory first, ties broken by directory path so the
    /// order is deterministic. This is the SHAPE signal, and unlike
    /// [`affected_not_shown`](Self::affected_not_shown) its counts are exact for
    /// every directory it lists. At most [`AFFECTED_DIR_CAP`] entries.
    pub affected_by_dir: Vec<AffectedDirectory>,
    /// How many directories did not fit within [`AFFECTED_DIR_CAP`] and are
    /// absent from [`affected_by_dir`](Self::affected_by_dir). They are the
    /// lightest ones; their files are still counted in
    /// [`affected_count`](Self::affected_count). Zero when nothing was omitted.
    /// Add this to `affected_by_dir.len()` for the true number of directories
    /// the change reaches.
    pub affected_by_dir_omitted: usize,
    /// Coordination gaps: a changed file exports a contract consumed by a module
    /// absent from the diff. One entry per (changed file, consumer) pair. NOT a
    /// subset of [`affected_not_shown`](Self::affected_not_shown): the gap
    /// deliberately skips story and test consumers that the affected set counts.
    pub coordination_gap: Vec<CoordinationGapFact>,
    /// Co-change gaps: a changed file has a hidden change-coupling partner
    /// that is absent from the diff. The two files changed together in most
    /// commits of the history window, but no import or re-export chain
    /// connects them, so the graph facts above cannot point at the partner.
    /// Advisory, never gates. Omitted when empty.
    /// At most 10 entries (`CO_CHANGE_GAP_CAP`), strongest degree first.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub co_change_gap: Vec<CoChangeGapFact>,
    /// All co-change gaps, before the cap cuts `co_change_gap`. Omitted
    /// when zero.
    #[serde(default, skip_serializing_if = "is_zero")]
    pub co_change_gap_count: usize,
    /// Consumers that a whole-word text search for a changed export name does
    /// not find (`missed`), or finds only under another local name
    /// (`renamed`). Only exports whose declaration statement overlaps an added
    /// diff line count, and only consumers outside the diff. Absent when no
    /// such consumer exists.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub search_gap: Option<SearchGapFacts>,
}

#[expect(
    clippy::trivially_copy_pass_by_ref,
    reason = "serde skip_serializing_if passes a reference"
)]
const fn is_zero(value: &usize) -> bool {
    *value == 0
}

/// Maximum number of consumers listed per export in
/// [`ExportSearchGapFact::consumers`]. The full count is in
/// [`ExportSearchGapFact::total`].
pub const SEARCH_GAP_CONSUMER_CAP: usize = 10;

/// The literal-search gap of the changed exports: the consumers that a text
/// search for the export name does not find or finds only under another name.
#[derive(Debug, Clone, Default, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct SearchGapFacts {
    /// Sum of the per-export totals, before the per-export cap. A consumer of
    /// two changed exports counts once for each export.
    pub total: usize,
    /// One entry per changed export with at least one such consumer, sorted
    /// by file and line.
    pub exports: Vec<ExportSearchGapFact>,
}

/// The `missed` and `renamed` consumers of one changed export.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ExportSearchGapFact {
    /// Root-relative path of the changed file that declares the export.
    pub file: String,
    /// The export name, `default` for a default export.
    pub export_name: String,
    /// 1-based line of the export.
    pub line: u32,
    /// Number of `missed` and `renamed` consumers of this export, before the
    /// cap.
    pub total: usize,
    /// At most [`SEARCH_GAP_CONSUMER_CAP`] consumers, `missed` first, then by
    /// path.
    pub consumers: Vec<SearchGapConsumerFact>,
}

/// One consumer that a text search for the export name does not find, or
/// finds only under another local name.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct SearchGapConsumerFact {
    /// Root-relative path of the consumer.
    pub consumer_file: String,
    /// 1-based line of the import statement in the consumer, when known.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub line: Option<u32>,
    /// `missed` or `renamed`.
    pub search_visibility: fallow_types::trace::SearchVisibility,
    /// Why the text search does not find the uses.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<fallow_types::trace::SearchGapReason>,
    /// The name to search for in this consumer instead.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub search_as: Option<String>,
}

impl ImpactClosureFacts {
    /// Set the co-change gaps: keep the first [`CO_CHANGE_GAP_CAP`] entries
    /// and record the full count.
    pub fn set_co_change_gaps(&mut self, gaps: &[CoChangeGapFact]) {
        self.co_change_gap_count = gaps.len();
        self.co_change_gap = gaps.iter().take(CO_CHANGE_GAP_CAP).cloned().collect();
    }

    /// Build the facts from the full closure, capping the file sample and the
    /// directory rollup while preserving the exact total.
    ///
    /// `affected` must arrive deduped and path-sorted (the engine closure
    /// guarantees both); the sample is its prefix.
    #[must_use]
    pub fn new(affected: &[String], coordination_gap: Vec<CoordinationGapFact>) -> Self {
        let (affected_by_dir, affected_by_dir_omitted) = roll_up_by_directory(affected);
        Self {
            affected_count: affected.len(),
            affected_not_shown: affected.iter().take(AFFECTED_SAMPLE_CAP).cloned().collect(),
            affected_by_dir,
            affected_by_dir_omitted,
            coordination_gap,
            co_change_gap: Vec::new(),
            co_change_gap_count: 0,
            search_gap: None,
        }
    }
}

/// One co-change gap: `changed_file` is in the diff, `partner_file` is not,
/// and history shows that the two files usually change together.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct CoChangeGapFact {
    /// Root-relative path of the changed file.
    pub changed_file: String,
    /// Root-relative path of the hidden partner that the diff does not touch.
    pub partner_file: String,
    /// Commits in the history window that changed both files.
    pub shared_revisions: u32,
    /// Coupling degree from 0 to 1.
    pub degree: f64,
    /// Scope note: history evidence, not a proof that the partner must change.
    pub note: String,
}

/// One directory of the blast radius and how many affected files it holds.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct AffectedDirectory {
    /// Root-relative parent directory, forward-slashed. The empty string is the
    /// repository root.
    pub dir: String,
    /// How many affected-but-not-in-diff files live directly in `dir`. Exact,
    /// never sampled.
    pub count: usize,
}

/// Roll the affected paths up by parent directory, heaviest first, capped at
/// [`AFFECTED_DIR_CAP`]. Returns the kept rows and how many directories were
/// dropped.
///
/// Sorting by count descending keeps the heaviest directories, which is the
/// question a reviewer is actually asking ("did this leak somewhere new, or is
/// it all inside the module I already changed?"). The directory path breaks
/// ties so the order is total and stable across runs.
fn roll_up_by_directory(affected: &[String]) -> (Vec<AffectedDirectory>, usize) {
    let mut counts: rustc_hash::FxHashMap<&str, usize> = rustc_hash::FxHashMap::default();
    for path in affected {
        let dir = path.rsplit_once('/').map_or("", |(head, _)| head);
        *counts.entry(dir).or_default() += 1;
    }
    let mut rows: Vec<AffectedDirectory> = counts
        .into_iter()
        .map(|(dir, count)| AffectedDirectory {
            dir: dir.to_string(),
            count,
        })
        .collect();
    rows.sort_by(|a, b| b.count.cmp(&a.count).then_with(|| a.dir.cmp(&b.dir)));
    let omitted = rows.len().saturating_sub(AFFECTED_DIR_CAP);
    rows.truncate(AFFECTED_DIR_CAP);
    (rows, omitted)
}

/// One coordination-gap entry: a changed file exports symbols consumed by a
/// `consumer_file` that is NOT in the diff. Deduped per (changed, consumer) pair
/// (firing-precision rule R2).
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct CoordinationGapFact {
    /// Root-relative path of the changed file whose contract is consumed elsewhere.
    pub changed_file: String,
    /// Root-relative path of the consumer module that is NOT in the diff.
    pub consumer_file: String,
    /// The exported symbol names the consumer references, sorted.
    pub consumed_symbols: Vec<String>,
    /// Honest scope note: this is a syntactic attention pointer, not a proof.
    pub note: String,
}

/// Stage 2 of the brief: the partition + order. The changed files split into
/// coherent BY-MODULE units (the only byte-identical-deterministic clustering
/// definition straight from the graph), plus a dependency-sensible review ORDER
/// over those units (definitions before consumers, mechanical/leaf units last,
/// ties broken by the path sort). Stage 2 sits UNDER the decision surface as a
/// drill-down; it is the backbone the directed-review loop hands the agent.
///
/// Feature-cluster and concern partitioning are deferred (they need scoring
/// heuristics whose tie-breaks are a fresh nondeterminism surface).
#[derive(Debug, Clone, Default, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct PartitionFacts {
    /// The by-module units, sorted by module directory. Empty when no graph was
    /// retained or no changed file maps to a known module.
    pub units: Vec<ReviewUnitFact>,
    /// The dependency-sensible review order: module-directory strings,
    /// definitions before consumers, mechanical/leaf units last. A permutation of
    /// the `units` module directories.
    pub order: Vec<String>,
    /// Connected components of the inter-unit dependency graph: groups of
    /// module directories that share no import edge with any unit outside the
    /// group. Present only when there are two or more; a single slice is just
    /// `order`. A slice proves the absence of import edges to the rest of the
    /// change, nothing more: whether it can land on its own is still a
    /// judgment (generated files and lockstep contracts share no edge and
    /// still belong together). An orientation fact, never a demand to split.
    #[serde(default, skip_serializing_if = "fewer_than_two_slices")]
    pub independent_slices: Vec<Vec<String>>,
}

fn fewer_than_two_slices(slices: &[Vec<String>]) -> bool {
    slices.len() < 2
}

/// One review unit: a coherent by-module cluster of the changed set.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ReviewUnitFact {
    /// The module directory the unit covers (root-relative, forward-slashed).
    /// The empty string is the repository-root group.
    pub module_dir: String,
    /// The changed files in this unit, path-sorted.
    pub files: Vec<String>,
}

/// Diff-aware deterministic deltas (6.A), framed new-vs-pre-existing against
/// the audit base snapshot. Each entry is a brief summary/verdict line.
///
/// `public_api` is batch-consolidated to ONE decision per change (rule R1):
/// the `added` list carries the introduced public-export keys as evidence, but a
/// reviewer reads "the public surface widened by N", never one decision per
/// symbol.
#[derive(Debug, Clone, Default, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ReviewDeltas {
    /// Cross-zone boundary EDGES introduced vs base (R2 first-edge-only: one per
    /// `<from_zone>-><to_zone>` pair, never per import). New-vs-pre-existing.
    pub boundary_introduced: Vec<String>,
    /// Circular dependencies introduced vs base (canonical file-set keys).
    pub cycle_introduced: Vec<String>,
    /// Exports-aware public-API surface delta: the public-export keys
    /// (`<rel_path>::<name>`) added vs base, resolved through `package.json`
    /// `exports` + re-export reachability. A symbol re-exported only through an
    /// internal barrel NOT in `exports` is absent here (zero delta); one
    /// reachable through an `exports` path is present (exactly one).
    pub public_api_added: Vec<String>,
    /// Third-party dependencies a changed `package.json` declares that the base
    /// manifest did not, as `<manifest>::<name>` keys. Every dependency section
    /// participates. Always present, empty when no manifest changed.
    pub dependency_added: Vec<String>,
    /// Declared dependencies whose range moved across a major version (or a
    /// `0.x` minor) vs base, as `<manifest>::<name>@<from>-><to>` keys. Minor
    /// and patch moves are not candidates; a non-numeric range is skipped.
    /// Always present, empty when nothing crossed a major version.
    pub dependency_major_bumped: Vec<String>,
}

/// The full `fallow audit --brief --format json` envelope. Carries the
/// informational verdict, the triage and graph-facts orientation stages, plus
/// the reused "subtract" section (the same dead-code / duplication / complexity
/// payload `fallow audit --format json` emits).
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[cfg_attr(
    feature = "schema",
    schemars(title = "fallow audit --brief --format json")
)]
pub struct ReviewBriefOutput<Focus, Weakening, Routing, Decisions> {
    /// Independently-versioned brief schema version.
    pub schema_version: ReviewBriefSchemaVersion,
    /// Fallow CLI version that produced this output.
    pub version: String,
    /// Command discriminator singleton: always `"audit-brief"`.
    pub command: String,
    /// Stage 0: change-size triage (file/hunk/line counts, risk class, effort).
    pub triage: DiffTriage,
    /// Stage 1: graph orientation facts.
    pub graph_facts: GraphFacts,
    /// Stage 2: the partition + order (by-module units + dependency-sensible
    /// review order). The backbone the directed-review loop hands the agent.
    pub partition: PartitionFacts,
    /// Stage 3: the impact closure (affected-not-shown + coordination gap).
    pub impact_closure: ImpactClosureFacts,
    /// Stage 4: the weighted focus map. A composite attention score per
    /// changed-file unit (fan-in/out + security taint + risk zone + change shape),
    /// with `review-here` / `not-prioritized` labels (NEVER `skip` in free mode),
    /// a per-unit confidence flag, and the FULL `deprioritized` escape-hatch list
    /// so every de-prioritized piece is reachable. Stage 4 sits UNDER the decision
    /// surface as drill-down.
    pub focus: Focus,
    /// 6.A: diff-aware deterministic deltas (boundary/cycle introduced +
    /// exports-aware public-API surface delta), new-vs-pre-existing.
    pub deltas: ReviewDeltas,
    /// 6.F, headline: reviewer-private weakening signals (tests
    /// removed/skipped, thresholds lowered, suppressions added, security steps
    /// removed). Advisory, never gates, never auto-posted.
    pub weakening: Vec<Weakening>,
    /// 6.D: ownership-aware reviewer routing (per-file expert + bus-factor).
    pub routing: Routing,
    /// How far the change reaches across CODEOWNERS owner groups, computed
    /// from the CODEOWNERS file alone. Absent when no CODEOWNERS file is
    /// found or the file cannot be read.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ownership: Option<crate::OwnershipFacts>,
    /// 6.G, the APEX: the decision surface. The ranked, capped,
    /// signal_id-anchored set of consequential structural decisions, each framed
    /// as a judgment question with its routed expert. This is the only thing the
    /// brief visibly leads with; the stages above are its drill-down derivation.
    pub decisions: Decisions,
    /// Branching conservation across the changeset: total branching against
    /// the number of functions now holding it. Absent when no base comparison
    /// ran, which keeps the wire shape byte-identical for a consumer that
    /// never had a base snapshot.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub branching: Option<crate::BranchingReport>,
    /// How tests reach the value exports that the diff changes. Advisory,
    /// never gates. Absent when the diff changes no value export or no diff
    /// is known.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub test_reach: Option<crate::TestReachFacts>,
}

/// The standard audit brief payload shape used by the CLI, schema emitter,
/// API, and agent-facing review surfaces.
pub type StandardReviewBriefOutput = ReviewBriefOutput<
    crate::audit_focus::FocusMap,
    crate::audit_weakening::WeakeningSignal,
    crate::audit_routing::RoutingFacts,
    crate::audit_decision_surface::DecisionSurface,
>;

/// Informational audit metadata carried by the review brief wire envelope.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ReviewBriefHeader<Verdict, Summary, Attribution> {
    /// Fallow CLI version that produced this output.
    pub version: ToolVersion,
    /// Audit verdict, informational only on the brief path.
    pub verdict: Verdict,
    /// Number of changed files in the audit scope.
    pub changed_files_count: u32,
    /// Base ref used to determine the changeset.
    pub base_ref: String,
    /// Human-readable description of the resolved base, when available.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_description: Option<String>,
    /// Head commit SHA, when the audit ran against a committed head.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub head_sha: Option<String>,
    /// Analysis duration in milliseconds.
    pub elapsed_ms: ElapsedMs,
    /// Whether base-snapshot analysis was skipped for this run.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_snapshot_skipped: Option<bool>,
    /// Per-category audit summary.
    pub summary: Summary,
    /// Introduced-versus-inherited issue attribution.
    pub attribution: Attribution,
}

/// Complete `fallow audit --brief --format json` wire envelope.
///
/// This is distinct from [`ReviewBriefOutput`], which is the reusable review
/// digest embedded in walkthrough output. The wire envelope also carries audit
/// metadata, optional telemetry, and the subtract-style analysis subreports.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[cfg_attr(
    feature = "schema",
    schemars(title = "fallow audit --brief --format json")
)]
pub struct ReviewBriefWireOutput<
    Focus,
    Weakening,
    Routing,
    Decisions,
    Verdict,
    Summary,
    Attribution,
    DeadCode,
    Duplication,
    Complexity,
> {
    /// Independently-versioned brief schema version.
    pub schema_version: ReviewBriefSchemaVersion,
    /// Fallow CLI version that produced this output.
    pub version: ToolVersion,
    /// Command discriminator singleton: always `"audit-brief"`.
    pub command: String,
    /// Audit verdict, informational only on the brief path.
    pub verdict: Verdict,
    /// Number of changed files in the audit scope.
    pub changed_files_count: u32,
    /// Base ref used to determine the changeset.
    pub base_ref: String,
    /// Human-readable description of the resolved base, when available.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_description: Option<String>,
    /// Head commit SHA, when available.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub head_sha: Option<String>,
    /// Analysis duration in milliseconds.
    pub elapsed_ms: ElapsedMs,
    /// Whether base-snapshot analysis was skipped for this run.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_snapshot_skipped: Option<bool>,
    /// Per-category audit summary.
    pub summary: Summary,
    /// Introduced-versus-inherited issue attribution.
    pub attribution: Attribution,
    /// Optional metric definitions and local telemetry correlation metadata.
    #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<Meta>,
    /// Ranked, capped review decisions.
    pub decisions: Decisions,
    /// Diff-size triage facts.
    pub triage: DiffTriage,
    /// Graph-derived orientation facts.
    pub graph_facts: GraphFacts,
    /// Changed-file partition and review order.
    pub partition: PartitionFacts,
    /// Transitive impact closure outside the diff.
    pub impact_closure: ImpactClosureFacts,
    /// Weighted focus map for changed-file units.
    pub focus: Focus,
    /// Deterministic introduced deltas against the base snapshot.
    pub deltas: ReviewDeltas,
    /// Reviewer-private weakening signals.
    pub weakening: Vec<Weakening>,
    /// Ownership-aware reviewer routing.
    pub routing: Routing,
    /// Owner-group reach from the CODEOWNERS file. Absent when no CODEOWNERS
    /// file is found or the file cannot be read.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ownership: Option<crate::OwnershipFacts>,
    /// Dead-code findings scoped to the audit changeset.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dead_code: Option<DeadCode>,
    /// Duplication findings scoped to the audit changeset.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub duplication: Option<Duplication>,
    /// Complexity findings scoped to the audit changeset.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub complexity: Option<Complexity>,
    /// Branching conservation across the changeset. Absent when no base
    /// comparison ran.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub branching: Option<crate::BranchingReport>,
    /// How tests reach the value exports that the diff changes. Advisory,
    /// never gates. Absent when the diff changes no value export or no diff
    /// is known.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub test_reach: Option<crate::TestReachFacts>,
}

/// CLI-built audit subreports that are embedded in the audit brief envelope.
///
/// The brief envelope and field ordering belong to `fallow-output`; the
/// underlying subreport payloads are still supplied by the CLI until their
/// builders are fully command-neutral.
#[derive(Debug, Clone, Default)]
pub struct ReviewBriefSubtractSections<DeadCode = Value, Duplication = Value, Complexity = Value> {
    /// Dead-code subreport, when the CLI produced one for this changeset.
    pub dead_code: Option<DeadCode>,
    /// Duplication subreport, when the CLI produced one for this changeset.
    pub duplication: Option<Duplication>,
    /// Complexity subreport, when the CLI produced one for this changeset.
    pub complexity: Option<Complexity>,
}

/// Build the complete `fallow audit --brief --format json` value.
///
/// `header` carries informational audit scope fields such as verdict, base ref,
/// summary, and attribution. The independent brief schema and command always
/// come from the typed brief payload.
pub fn build_review_brief_json_output<
    Focus,
    Weakening,
    Routing,
    Decisions,
    Verdict,
    Summary,
    Attribution,
    DeadCode,
    Duplication,
    Complexity,
>(
    brief: ReviewBriefOutput<Focus, Weakening, Routing, Decisions>,
    header: ReviewBriefHeader<Verdict, Summary, Attribution>,
    subtract: ReviewBriefSubtractSections<DeadCode, Duplication, Complexity>,
) -> Result<Value, serde_json::Error>
where
    Focus: Serialize,
    Weakening: Serialize,
    Routing: Serialize,
    Decisions: Serialize,
    Verdict: Serialize,
    Summary: Serialize,
    Attribution: Serialize,
    DeadCode: Serialize,
    Duplication: Serialize,
    Complexity: Serialize,
{
    serde_json::to_value(ReviewBriefWireOutput {
        schema_version: brief.schema_version,
        version: header.version,
        command: brief.command,
        verdict: header.verdict,
        changed_files_count: header.changed_files_count,
        base_ref: header.base_ref,
        base_description: header.base_description,
        head_sha: header.head_sha,
        elapsed_ms: header.elapsed_ms,
        base_snapshot_skipped: header.base_snapshot_skipped,
        summary: header.summary,
        attribution: header.attribution,
        meta: None,
        decisions: brief.decisions,
        triage: brief.triage,
        graph_facts: brief.graph_facts,
        partition: brief.partition,
        impact_closure: brief.impact_closure,
        focus: brief.focus,
        deltas: brief.deltas,
        weakening: brief.weakening,
        routing: brief.routing,
        ownership: brief.ownership,
        dead_code: subtract.dead_code,
        duplication: subtract.duplication,
        complexity: subtract.complexity,
        branching: brief.branching,
        test_reach: brief.test_reach,
    })
}

fn serialize_agent_contract_json_output<T: Serialize>(
    output: T,
    kind: &'static str,
    analysis_run_id: Option<&str>,
) -> Result<Value, serde_json::Error> {
    let mut value = serialize_named_json_output(output, kind)?;
    attach_telemetry_meta(&mut value, analysis_run_id);
    Ok(value)
}

/// Serialize the `fallow audit --brief --format json` envelope.
///
/// # Errors
///
/// Returns a serde error when the brief output cannot be converted to JSON.
pub fn serialize_review_brief_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<Value, serde_json::Error> {
    serialize_agent_contract_json_output(output, "audit-brief", analysis_run_id)
}

/// Serialize the standalone decision-surface envelope.
///
/// # Errors
///
/// Returns a serde error when the decision-surface output cannot be converted
/// to JSON.
pub fn serialize_decision_surface_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<Value, serde_json::Error> {
    serialize_agent_contract_json_output(output, "decision-surface", analysis_run_id)
}

/// Serialize the review walkthrough guide envelope.
///
/// # Errors
///
/// Returns a serde error when the walkthrough guide cannot be converted to
/// JSON.
pub fn serialize_walkthrough_guide_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<Value, serde_json::Error> {
    serialize_agent_contract_json_output(output, "review-walkthrough-guide", analysis_run_id)
}

/// Serialize the review walkthrough validation envelope.
///
/// # Errors
///
/// Returns a serde error when the walkthrough validation cannot be converted
/// to JSON.
pub fn serialize_walkthrough_validation_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<Value, serde_json::Error> {
    serialize_agent_contract_json_output(output, "review-walkthrough-validation", analysis_run_id)
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    /// Serialize a minimal brief through the real wire mapping.
    fn brief_wire_value(branching: Option<crate::BranchingReport>) -> Value {
        let brief = ReviewBriefOutput {
            branching,
            test_reach: None,
            schema_version: ReviewBriefSchemaVersion::default(),
            version: "1.2.3".to_string(),
            command: "audit-brief".to_string(),
            triage: DiffTriage {
                files: 1,
                hunks: None,
                net_lines: None,
                risk_class: RiskClass::Low,
                review_effort: ReviewEffort::Glance,
            },
            graph_facts: GraphFacts {
                exports_added: 0,
                api_width_delta: 0,
                boundaries_touched: Vec::new(),
            },
            partition: PartitionFacts::default(),
            impact_closure: ImpactClosureFacts::default(),
            focus: json!({"units": []}),
            deltas: ReviewDeltas::default(),
            weakening: Vec::<Value>::new(),
            routing: json!({"units": []}),
            ownership: None,
            decisions: json!({"decisions": []}),
        };
        let header = ReviewBriefHeader {
            version: ToolVersion("1.2.3".to_string()),
            verdict: json!("fail"),
            changed_files_count: 1,
            base_ref: "main".to_string(),
            base_description: Some("merge base".to_string()),
            head_sha: Some("abc123".to_string()),
            elapsed_ms: ElapsedMs(12),
            base_snapshot_skipped: Some(false),
            summary: json!({"dead_code_issues": 0}),
            attribution: json!({"gate": "new_only"}),
        };

        build_review_brief_json_output(
            brief,
            header,
            ReviewBriefSubtractSections::<Value, Value, Value> {
                dead_code: Some(json!({"issues": []})),
                duplication: None,
                complexity: None,
            },
        )
        .expect("brief output should serialize")
    }

    #[test]
    fn review_brief_json_output_assembles_typed_wire_contract() {
        let value = brief_wire_value(None);

        assert_eq!(value["schema_version"], REVIEW_BRIEF_SCHEMA_VERSION);
        assert_eq!(value["command"], "audit-brief");
        assert_eq!(value["verdict"], "fail");
        assert_eq!(value["base_ref"], "main");
        assert_eq!(value["summary"]["dead_code_issues"], 0);
        assert_eq!(value["attribution"]["gate"], "new_only");
        assert_eq!(value["dead_code"]["issues"], json!([]));
        assert!(
            value.get("branching").is_none(),
            "absent when no base comparison ran, so the wire shape is unchanged              for a consumer that never had a base snapshot"
        );
    }

    #[test]
    fn review_brief_json_output_carries_the_branching_block() {
        // Widening `ReviewBriefOutput` alone would land the block in the
        // walkthrough digest and leave it out of the brief JSON, because the
        // wire struct is mapped field by field.
        let base: crate::BranchingSnapshot = std::iter::once((
            "src/a.ts".to_string(),
            fallow_types::extract::FileBranching {
                branch_points: 12,
                functions: 1,
                peak_cyclomatic: 13,
                cognitive: 12,
                cognitive_nesting_weight: 6,
                has_module_unit: false,
                has_synthetic_units: false,
            },
        ))
        .collect();
        let head: crate::BranchingSnapshot = std::iter::once((
            "src/a.ts".to_string(),
            fallow_types::extract::FileBranching {
                branch_points: 12,
                functions: 5,
                peak_cyclomatic: 4,
                cognitive: 6,
                cognitive_nesting_weight: 0,
                has_module_unit: false,
                has_synthetic_units: false,
            },
        ))
        .collect();
        let report = crate::BranchingReport::compare(
            &base,
            &head,
            crate::DEFAULT_BRANCHING_TOLERANCE,
            &|_| false,
        );

        let value = brief_wire_value(Some(report));

        assert_eq!(
            value["branching"]["split_in_place"][0]["path"], "src/a.ts",
            "the local claim reaches the wire, not only the digest"
        );
        assert_eq!(
            value["branching"]["split_in_place"][0]["functions_after"],
            5
        );
        assert!(
            !value["branching"]
                .as_object()
                .expect("branching is an object")
                .contains_key("verdict"),
            "there is no changeset-level verdict to publish"
        );
        assert_eq!(value["branching"]["branch_points"]["delta"], 0);
        assert_eq!(value["branching"]["functions"]["delta"], 4);
        assert_eq!(value["branching"]["peak_unit_cyclomatic"]["delta"], -9);
        assert_eq!(
            value["branching"]["cognitive"]["attributed_to"],
            "nesting-reset"
        );
        assert_eq!(value["branching"]["tolerance"], 2);
        assert_eq!(value["branching"]["by_file"][0]["path"], "src/a.ts");
    }

    #[test]
    fn review_brief_serializer_owns_root_contract() {
        let value = serialize_review_brief_json_output(
            json!({"command": "audit-brief"}),
            Some("run-brief"),
        )
        .expect("brief output should serialize");

        assert_eq!(value["kind"], "audit-brief");
        assert_eq!(value["_meta"]["telemetry"]["analysis_run_id"], "run-brief");
    }

    #[test]
    fn decision_surface_serializer_owns_root_contract() {
        let value =
            serialize_decision_surface_json_output(json!({"decisions": []}), Some("run-decision"))
                .expect("decision surface should serialize");

        assert_eq!(value["kind"], "decision-surface");
        assert_eq!(
            value["_meta"]["telemetry"]["analysis_run_id"],
            "run-decision"
        );
    }

    /// `<dirs>` directories holding `<per_dir>` files each, path-sorted the way
    /// the engine closure hands them over.
    fn affected(dirs: usize, per_dir: usize) -> Vec<String> {
        let mut paths: Vec<String> = (0..dirs)
            .flat_map(|d| (0..per_dir).map(move |f| format!("src/zone{d:03}/file{f:03}.ts")))
            .collect();
        paths.sort();
        paths
    }

    #[test]
    fn a_closure_within_the_caps_is_reported_whole() {
        let paths = affected(2, 3);
        let facts = ImpactClosureFacts::new(&paths, Vec::new());

        assert_eq!(facts.affected_count, 6);
        assert_eq!(facts.affected_not_shown, paths);
        assert_eq!(facts.affected_by_dir_omitted, 0);
        assert_eq!(
            facts
                .affected_by_dir
                .iter()
                .map(|row| (row.dir.as_str(), row.count))
                .collect::<Vec<_>>(),
            vec![("src/zone000", 3), ("src/zone001", 3)]
        );
    }

    #[test]
    fn the_count_survives_capping_the_sample() {
        let paths = affected(4, 40);
        let facts = ImpactClosureFacts::new(&paths, Vec::new());

        assert_eq!(
            facts.affected_count, 160,
            "the magnitude is computed before the sample is capped"
        );
        assert_eq!(facts.affected_not_shown.len(), AFFECTED_SAMPLE_CAP);
        assert_eq!(
            facts
                .affected_by_dir
                .iter()
                .map(|row| row.count)
                .sum::<usize>(),
            facts.affected_count,
            "an uncapped rollup accounts for every affected file"
        );
    }

    #[test]
    fn the_rollup_carries_weight_the_sample_cannot() {
        // A prefix sample lands entirely in the directory that sorts first, so
        // the rollup is the only thing that can say where the reach actually is.
        let mut paths = affected(1, 12);
        paths.extend((0..90).map(|f| format!("src/zzz_heavy/file{f:03}.ts")));
        paths.sort();
        let facts = ImpactClosureFacts::new(&paths, Vec::new());

        assert!(
            facts
                .affected_not_shown
                .iter()
                .all(|path| path.starts_with("src/zone000/")),
            "the fixture must produce a one-directory sample: {:?}",
            facts.affected_not_shown
        );
        let heaviest = facts.affected_by_dir.first().expect("a rollup row");
        assert_eq!(
            (heaviest.dir.as_str(), heaviest.count),
            ("src/zzz_heavy", 90)
        );
    }

    #[test]
    fn co_change_gaps_beyond_the_cap_are_counted() {
        let gaps: Vec<CoChangeGapFact> = (0..CO_CHANGE_GAP_CAP + 3)
            .map(|index| CoChangeGapFact {
                changed_file: format!("src/changed{index}.ts"),
                partner_file: format!("src/partner{index}.ts"),
                shared_revisions: 5,
                degree: 0.5,
                note: String::new(),
            })
            .collect();
        let mut facts = ImpactClosureFacts::new(&[], Vec::new());
        facts.set_co_change_gaps(&gaps);

        assert_eq!(facts.co_change_gap.len(), CO_CHANGE_GAP_CAP);
        assert_eq!(facts.co_change_gap_count, CO_CHANGE_GAP_CAP + 3);
        assert_eq!(facts.co_change_gap[0].changed_file, "src/changed0.ts");

        let mut empty = ImpactClosureFacts::new(&[], Vec::new());
        empty.set_co_change_gaps(&[]);
        let json = serde_json::to_value(&empty).expect("facts serialize");
        assert!(json.get("co_change_gap").is_none());
        assert!(json.get("co_change_gap_count").is_none());
    }

    #[test]
    fn rollup_rows_beyond_the_cap_are_counted_not_dropped_silently() {
        let paths = affected(AFFECTED_DIR_CAP + 7, 1);
        let facts = ImpactClosureFacts::new(&paths, Vec::new());

        assert_eq!(facts.affected_by_dir.len(), AFFECTED_DIR_CAP);
        assert_eq!(facts.affected_by_dir_omitted, 7);
        assert_eq!(facts.affected_count, AFFECTED_DIR_CAP + 7);
    }

    #[test]
    fn equal_weight_directories_are_ordered_by_path() {
        let facts = ImpactClosureFacts::new(&affected(3, 2), Vec::new());
        let dirs: Vec<&str> = facts
            .affected_by_dir
            .iter()
            .map(|row| row.dir.as_str())
            .collect();
        assert_eq!(
            dirs,
            vec!["src/zone000", "src/zone001", "src/zone002"],
            "the path is the tie-break, so the order is total across runs"
        );
    }

    #[test]
    fn the_coordination_gap_is_never_capped() {
        // The human brief routes a reader to `--format json` for the gaps and
        // their symbols. That promise holds only while this constructor stores
        // both whole, alongside two fields it does deliberately cap.
        let symbols: Vec<String> = (0..40).map(|i| format!("symbol{i:02}")).collect();
        let gaps: Vec<CoordinationGapFact> = (0..60)
            .map(|i| CoordinationGapFact {
                changed_file: "src/core.ts".to_string(),
                consumer_file: format!("src/consumer{i:02}.ts"),
                consumed_symbols: symbols.clone(),
                note: String::new(),
            })
            .collect();
        let facts = ImpactClosureFacts::new(&affected(40, 3), gaps);

        assert_eq!(facts.coordination_gap.len(), 60);
        assert!(
            facts
                .coordination_gap
                .iter()
                .all(|gap| gap.consumed_symbols.len() == 40),
            "every consumed symbol survives, or the brief's json route is a lie"
        );
        assert!(
            facts.affected_not_shown.len() < facts.affected_count
                && facts.affected_by_dir_omitted > 0,
            "the fixture must show the sibling fields really are capped"
        );
    }

    #[test]
    fn root_level_files_roll_up_under_the_empty_directory() {
        let facts =
            ImpactClosureFacts::new(&["play.ts".to_string(), "setup.ts".to_string()], Vec::new());
        assert_eq!(facts.affected_by_dir.len(), 1);
        assert_eq!(facts.affected_by_dir[0].dir, "");
        assert_eq!(facts.affected_by_dir[0].count, 2);
    }
}