supercov_engine/

run_store.rs

//! Validated local run discovery and immutable run identity.
//!
//! The run store is user data. Discovery never follows links, never mutates a
//! run, and never silently treats malformed metadata as a valid run. Callers
//! receive accepted runs and rejected-entry diagnostics independently.

use std::{
    fs::{self, File},
    io::{self, Read},
    path::{Path, PathBuf},
};

use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use supercov_contracts::EVIDENCE_ARCHIVE_SCHEMA_VERSION;

use crate::query_index::{QUERY_INDEX_SCHEMA_VERSION, QueryIndexIdentity};
use crate::{
    coverage_index::{CoverageIndex, CoverageIndexError, coverage_index_sections},
    coverage_report::{ArchiveReportRequest, ExitCodeInput, ReportError, analyze_coverage_archive},
    evidence_archive::read_archive_schema_version,
    query_index::{QueryIndex, QueryIndexError, write_query_index},
};

const MAX_RUN_METADATA_BYTES: u64 = 1024 * 1024;
pub const RUST_ANALYSIS_ABI_VERSION: u32 = 1;
pub const RUST_QUERY_PRODUCER_ABI_VERSION: u32 = 3;
pub const RUST_QUERY_INDEX_FILE: &str = "query-index.v1.bin";

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RunFingerprint {
    pub algorithm: String,
    pub source: String,
    pub tests: String,
    pub dependencies: String,
    pub configuration: String,
    pub instrumenter: String,
    pub execution: String,
    pub combined: String,
    pub source_files: usize,
    pub test_files: usize,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct GitIntegrity {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub revision: Option<String>,
    pub dirty: bool,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RunIntegrity {
    pub schema_version: u32,
    pub instrumenter_version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub git: Option<GitIntegrity>,
    pub fingerprint: RunFingerprint,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stale: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stale_reasons: Option<Vec<String>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RunTimings {
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub initialization_ms: f64,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub workspace_preparation_ms: f64,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub adapter_setup_ms: f64,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub instrumented_build_ms: f64,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub test_command_ms: f64,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub evidence_publication_ms: f64,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct InstrumentedBuildCache {
    pub key: String,
    pub reused: bool,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RawEvidenceMetadata {
    pub schema_version: u32,
    pub format: String,
    pub file: String,
    pub files: usize,
    pub uncompressed_bytes: u64,
    pub compressed_bytes: u64,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RunMetadata {
    pub id: String,
    pub started_at: String,
    #[serde(serialize_with = "crate::coverage_analysis::serialize_javascript_number")]
    pub duration_ms: f64,
    pub command: Vec<String>,
    pub test_exit_code: Option<i32>,
    pub integrity: RunIntegrity,
    pub raw_evidence: RawEvidenceMetadata,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub isolated_build: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instrumented_build_cache: Option<InstrumentedBuildCache>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timings: Option<RunTimings>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub merged: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parents: Option<Vec<String>>,
    /// The `SUPERCOV_SOURCE_ROOTS` the run was measured under. It decides what
    /// the run measures, so it is part of what the run is, replayed like the
    /// command when a later query asks whether the checkout has moved on. The
    /// environment of that later query is no guide: it is usually a different
    /// shell, and a run judged against roots it was not measured under read as
    /// stale the moment it was recorded.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_roots: Option<Vec<String>>,
}

#[cfg(test)]
pub(crate) fn create_analyzable_test_run(root: &Path, id: &str) -> PathBuf {
    create_analyzable_run(root, id, None)
}

/// The same run as a suite that ran its tests at once: the coverage sits in
/// the record nobody could be credited with, and the test beside it is named,
/// run-wide, and holds nothing of its own. It is the shape Go publishes for a
/// package whose tests all call `t.Parallel()`.
#[cfg(test)]
pub(crate) fn create_run_wide_test_run(root: &Path, id: &str) -> PathBuf {
    create_analyzable_run(root, id, Some(crate::coverage_report::ATTRIBUTION_RUN_WIDE))
}

/// The same run as a Ruby suite: the test keeps the coverage it was credited
/// with, and that coverage is a lower bound rather than the whole of what it
/// ran. What its own record proves, it still proves.
#[cfg(test)]
pub(crate) fn create_partial_test_run(root: &Path, id: &str) -> PathBuf {
    create_analyzable_run(root, id, Some(crate::coverage_report::ATTRIBUTION_PARTIAL))
}

#[cfg(test)]
fn create_analyzable_run(root: &Path, id: &str, attribution: Option<&str>) -> PathBuf {
    use crate::{
        coverage_analysis::{McdcVector, PointKind},
        coverage_report::{
            BranchAlternativeMeta, BranchMeta, CoverageManifest, DecisionMeta, DecisionSnapshot,
            PointMeta, RawTestResult, RuntimeSnapshot, TestProvenance,
        },
        evidence_archive::{EvidenceArchiveEntry, write_archive},
    };

    let directory = root.join(".supercov/runs").join(id);
    fs::create_dir_all(&directory).unwrap();
    let decision = DecisionMeta {
        id: "decision".into(),
        file: "src/app.js".into(),
        line: 1,
        column: 0,
        source: "left && right".into(),
        conditions: vec!["left".into(), "right".into()],
        kind: "if".into(),
    };
    let manifest = CoverageManifest {
        unmeasured: Vec::new(),
        decisions: vec![decision.clone()],
        points: vec![PointMeta {
            id: "statement".into(),
            kind: PointKind::Statement,
            file: "src/app.js".into(),
            line: 1,
            column: 0,
            source: "work();".into(),
            label: None,
        }],
        branches: vec![BranchMeta {
            id: "branch".into(),
            kind: "if".into(),
            file: "src/app.js".into(),
            line: 1,
            column: 0,
            source: "if (left && right)".into(),
            alternatives: vec![
                BranchAlternativeMeta {
                    id: "branch:true".into(),
                    label: "true".into(),
                },
                BranchAlternativeMeta {
                    id: "branch:false".into(),
                    label: "false".into(),
                },
            ],
        }],
        limitations: vec![],
        scope: None,
    };
    let result = RawTestResult {
        test_id: Some("test".into()),
        scope: None,
        test: "test".into(),
        test_file: Some("tests/app.test.js".into()),
        title: None,
        retry: Some(0),
        status: Some("passed".into()),
        expected_status: None,
        flaky: false,
        provenance: TestProvenance {
            runner: "node:test".into(),
            kind: "unit".into(),
            project: None,
            source: "test-fixture".into(),
        },
        role: "test".into(),
        attribution: crate::coverage_report::ATTRIBUTION_EXACT.into(),
        phases: vec![],
        runtime: vec![RuntimeSnapshot {
            decisions: vec![DecisionSnapshot {
                meta: decision,
                vectors: vec![
                    McdcVector {
                        values: vec![Some(false), Some(false)],
                        outcome: false,
                    },
                    McdcVector {
                        values: vec![Some(false), Some(true)],
                        outcome: false,
                    },
                    McdcVector {
                        values: vec![Some(true), Some(false)],
                        outcome: false,
                    },
                    McdcVector {
                        values: vec![Some(true), Some(true)],
                        outcome: true,
                    },
                ],
            }],
            hits: vec![
                "statement".into(),
                "branch:true".into(),
                "branch:false".into(),
            ],
            events: vec![],
            logicals: vec![],
        }],
        browser: vec![],
        server: vec![],
    };
    let results = if attribution == Some(crate::coverage_report::ATTRIBUTION_PARTIAL) {
        // It keeps its hits: a lower bound is still a claim.
        let mut partial = result.clone();
        partial.attribution = crate::coverage_report::ATTRIBUTION_PARTIAL.into();
        vec![partial]
    } else if attribution == Some(crate::coverage_report::ATTRIBUTION_RUN_WIDE) {
        let mut unclaimed = result.clone();
        unclaimed.test = "run".into();
        unclaimed.test_id = Some("run".into());
        unclaimed.test_file = None;
        unclaimed.role = "background".into();
        let mut parallel = result.clone();
        parallel.attribution = crate::coverage_report::ATTRIBUTION_RUN_WIDE.into();
        // Named, with its real outcome, and credited with nothing.
        parallel.runtime = vec![RuntimeSnapshot {
            decisions: vec![],
            hits: vec![],
            events: vec![],
            logicals: vec![],
        }];
        vec![unclaimed, parallel]
    } else {
        vec![result]
    };
    let mut entries = vec![
        EvidenceArchiveEntry {
            path: "coverage-model.json".into(),
            contents: serde_json::to_vec(&serde_json::json!({
                "schemaVersion": 1,
                "language": "javascript",
                "variant": "fixture-v1",
                "name": "Fixture model",
                "completenessMeaning": "Every fixture obligation was observed.",
                "measured": ["fixture obligations"],
                "notMeasured": []
            }))
            .unwrap(),
        },
        EvidenceArchiveEntry {
            path: "frontend.json".into(),
            contents: serde_json::to_vec(&serde_json::json!({
                "protocolVersion": 2,
                "frontendId": "javascript",
                "frontendVersion": "fixture-v1",
                "language": "javascript",
                "structuralSource": "owned-probes",
                "runners": [{
                    "runner": "node:test",
                    "executionModel": "serial-in-process",
                    "attribution": {
                        "run": "exact",
                        "worker": "unavailable",
                        "test": "exact",
                        "retry": "exact",
                        "phase": "exact",
                        "action": "exact",
                        "assertion": "exact"
                    },
                    "limitations": [{
                        "id": "fixture-worker-unavailable",
                        "scopes": ["worker"],
                        "reason": "The fixture intentionally has no worker identity"
                    }]
                }],
                "structuralLimitations": []
            }))
            .unwrap(),
        },
        EvidenceArchiveEntry {
            path: "manifest.json".into(),
            contents: serde_json::to_vec(&manifest).unwrap(),
        },
    ];
    for (at, result) in results.iter().enumerate() {
        entries.push(EvidenceArchiveEntry {
            // One record per worker directory: the reader matches
            // `<anything>/mcdc.json`, so a second record needs its own
            // directory rather than a decorated file name.
            path: format!(
                "worker{}/mcdc.json",
                if at == 0 {
                    String::new()
                } else {
                    format!("-{at}")
                }
            ),
            contents: serde_json::to_vec(result).unwrap(),
        });
    }
    let archive = write_archive(entries, &directory.join("evidence.raw.gz")).unwrap();
    let digest = |character: char| std::iter::repeat_n(character, 64).collect::<String>();
    let metadata = RunMetadata {
        id: id.into(),
        started_at: id.into(),
        duration_ms: 1.0,
        command: vec!["node".into(), "--test".into()],
        test_exit_code: Some(0),
        integrity: RunIntegrity {
            schema_version: 2,
            instrumenter_version: "test".into(),
            git: None,
            fingerprint: RunFingerprint {
                algorithm: "sha256".into(),
                source: digest('a'),
                tests: digest('b'),
                dependencies: digest('c'),
                configuration: digest('d'),
                instrumenter: digest('e'),
                execution: digest('f'),
                combined: digest('0'),
                source_files: 1,
                test_files: 1,
            },
            stale: None,
            stale_reasons: None,
        },
        raw_evidence: RawEvidenceMetadata {
            schema_version: archive.schema_version,
            format: archive.format.into(),
            file: archive.file.into(),
            files: archive.files,
            uncompressed_bytes: archive.uncompressed_bytes,
            compressed_bytes: archive.compressed_bytes,
        },
        isolated_build: Some(true),
        instrumented_build_cache: None,
        timings: None,
        merged: None,
        parents: None,
        source_roots: None,
    };
    fs::write(
        directory.join("run.json"),
        serde_json::to_vec_pretty(&metadata).unwrap(),
    )
    .unwrap();
    directory
}

#[derive(Debug, Clone, PartialEq)]
pub struct StoredRun {
    pub id: String,
    pub directory: PathBuf,
    pub evidence_path: PathBuf,
    pub metadata_path: PathBuf,
    pub query_index_path: PathBuf,
    pub metadata: RunMetadata,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RejectedRun {
    pub entry: String,
    pub reason: String,
}

#[derive(Debug, Clone, PartialEq)]
pub struct RunInventory {
    pub runs: Vec<StoredRun>,
    pub rejected: Vec<RejectedRun>,
}

#[derive(Debug)]
pub enum RunStoreError {
    Io(io::Error),
    UnsafeStore(PathBuf),
    NoRuns,
    RunNotFound(String),
    InvalidRun(&'static str),
}

impl From<io::Error> for RunStoreError {
    fn from(value: io::Error) -> Self {
        Self::Io(value)
    }
}

impl std::fmt::Display for RunStoreError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Io(error) => write!(formatter, "{error}"),
            Self::UnsafeStore(path) => {
                write!(formatter, "unsafe run-store path: {}", path.display())
            }
            Self::NoRuns => write!(formatter, "no local coverage runs"),
            Self::RunNotFound(selector) => write!(formatter, "coverage run not found: {selector}"),
            Self::InvalidRun(reason) => write!(formatter, "invalid coverage run: {reason}"),
        }
    }
}

impl std::error::Error for RunStoreError {}

fn regular_file(path: &Path) -> Result<fs::Metadata, RunStoreError> {
    let metadata = fs::symlink_metadata(path)?;
    if !metadata.file_type().is_file() {
        return Err(RunStoreError::UnsafeStore(path.to_owned()));
    }
    Ok(metadata)
}

pub(crate) fn valid_run_id(value: &str) -> bool {
    !value.is_empty()
        && value != "."
        && value != ".."
        && !value
            .chars()
            .any(|character| matches!(character, '/' | '\\' | '\0') || character.is_control())
}

fn valid_hex_digest(value: &str, length: usize) -> bool {
    value.len() == length
        && value
            .bytes()
            .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
}

fn valid_sha256(value: &str) -> bool {
    valid_hex_digest(value, 64)
}

fn validate_integrity(integrity: &RunIntegrity) -> Result<(), RunStoreError> {
    let fingerprint = &integrity.fingerprint;
    if fingerprint.algorithm != "sha256"
        || ![
            &fingerprint.source,
            &fingerprint.tests,
            &fingerprint.dependencies,
            &fingerprint.configuration,
            &fingerprint.instrumenter,
            &fingerprint.execution,
            &fingerprint.combined,
        ]
        .into_iter()
        .all(|digest| valid_sha256(digest))
    {
        return Err(RunStoreError::InvalidRun("integrity fingerprint"));
    }
    if let Some(git) = &integrity.git
        && git.revision.as_ref().is_some_and(|revision| {
            !valid_hex_digest(revision, 40) && !valid_hex_digest(revision, 64)
        })
    {
        return Err(RunStoreError::InvalidRun("git revision"));
    }
    Ok(())
}

fn read_metadata(path: &Path) -> Result<RunMetadata, RunStoreError> {
    let metadata = regular_file(path)?;
    if metadata.len() > MAX_RUN_METADATA_BYTES {
        return Err(RunStoreError::InvalidRun("run metadata is too large"));
    }
    let capacity =
        usize::try_from(metadata.len()).map_err(|_| RunStoreError::InvalidRun("metadata size"))?;
    let mut bytes = Vec::with_capacity(capacity);
    File::open(path)?
        .take(MAX_RUN_METADATA_BYTES + 1)
        .read_to_end(&mut bytes)?;
    let metadata: RunMetadata = serde_json::from_slice(&bytes)
        .map_err(|_| RunStoreError::InvalidRun("run metadata JSON"))?;
    validate_integrity(&metadata.integrity)?;
    Ok(metadata)
}

fn load_run(directory: &Path, entry: &str) -> Result<StoredRun, RunStoreError> {
    if !valid_run_id(entry) {
        return Err(RunStoreError::InvalidRun("run directory name"));
    }
    let directory_metadata = fs::symlink_metadata(directory)?;
    if !directory_metadata.file_type().is_dir() {
        return Err(RunStoreError::UnsafeStore(directory.to_owned()));
    }
    let metadata_path = directory.join("run.json");
    let metadata = read_metadata(&metadata_path)?;
    if metadata.id != entry {
        return Err(RunStoreError::InvalidRun(
            "metadata ID differs from directory",
        ));
    }
    if metadata.raw_evidence.schema_version != EVIDENCE_ARCHIVE_SCHEMA_VERSION
        || metadata.raw_evidence.format != "framed+gzip"
        || metadata.raw_evidence.file != "evidence.raw.gz"
        || metadata.raw_evidence.files == 0
    {
        return Err(RunStoreError::InvalidRun("raw evidence metadata"));
    }
    let evidence_path = directory.join("evidence.raw.gz");
    let evidence_metadata = regular_file(&evidence_path)?;
    if evidence_metadata.len() != metadata.raw_evidence.compressed_bytes {
        return Err(RunStoreError::InvalidRun("raw evidence length"));
    }
    if read_archive_schema_version(&evidence_path)
        .map_err(|_| RunStoreError::InvalidRun("raw evidence archive"))?
        != metadata.raw_evidence.schema_version
    {
        return Err(RunStoreError::InvalidRun("raw evidence schema mismatch"));
    }
    Ok(StoredRun {
        id: entry.into(),
        directory: directory.to_owned(),
        evidence_path,
        metadata_path,
        query_index_path: directory.join(RUST_QUERY_INDEX_FILE),
        metadata,
    })
}

pub fn discover_runs(project_root: &Path) -> Result<RunInventory, RunStoreError> {
    let store = project_root.join(".supercov").join("runs");
    let store_metadata = match fs::symlink_metadata(&store) {
        Ok(metadata) => metadata,
        Err(error) if error.kind() == io::ErrorKind::NotFound => {
            return Ok(RunInventory {
                runs: Vec::new(),
                rejected: Vec::new(),
            });
        }
        Err(error) => return Err(error.into()),
    };
    if !store_metadata.file_type().is_dir() {
        return Err(RunStoreError::UnsafeStore(store));
    }
    let mut runs = Vec::new();
    let mut rejected = Vec::new();
    for entry in fs::read_dir(&store)? {
        let entry = match entry {
            Ok(entry) => entry,
            Err(error) => {
                rejected.push(RejectedRun {
                    entry: "<unreadable>".into(),
                    reason: error.to_string(),
                });
                continue;
            }
        };
        let name = entry.file_name().to_string_lossy().into_owned();
        match load_run(&entry.path(), &name) {
            Ok(run) => runs.push(run),
            Err(error) => rejected.push(RejectedRun {
                entry: name,
                reason: error.to_string(),
            }),
        }
    }
    runs.sort_by(|left, right| {
        right
            .metadata
            .started_at
            .cmp(&left.metadata.started_at)
            .then_with(|| right.id.cmp(&left.id))
    });
    rejected.sort_by(|left, right| left.entry.cmp(&right.entry));
    Ok(RunInventory { runs, rejected })
}

pub fn select_run<'a>(
    inventory: &'a RunInventory,
    selector: Option<&str>,
) -> Result<&'a StoredRun, RunStoreError> {
    if inventory.runs.is_empty() {
        return Err(RunStoreError::NoRuns);
    }
    if selector.is_none() || selector == Some("latest") {
        return Ok(&inventory.runs[0]);
    }
    let selector = selector.expect("checked selector");
    inventory
        .runs
        .iter()
        .find(|run| run.id == selector)
        .or_else(|| {
            inventory
                .runs
                .iter()
                .find(|run| run.id.starts_with(selector))
        })
        .ok_or_else(|| RunStoreError::RunNotFound(selector.into()))
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IntegrityComparison {
    pub stale: bool,
    pub reasons: Vec<String>,
}

pub fn compare_run_integrity(
    stored: Option<&RunIntegrity>,
    current: &RunIntegrity,
) -> IntegrityComparison {
    let Some(stored) = stored else {
        return IntegrityComparison {
            stale: true,
            reasons: vec!["run predates integrity fingerprints".into()],
        };
    };
    if std::env::var_os("SUPERCOV_DEBUG_INTEGRITY").is_some() {
        eprintln!("[integrity] stored : {stored:?}");
        eprintln!("[integrity] current: {current:?}");
    }
    let mut reasons = Vec::new();
    if stored.schema_version != current.schema_version {
        reasons.push("coverage schema changed".into());
    }
    // The declared contract, not the build that produced it. The instrumenter
    // digest covers Supercov's own source, so comparing it here marked every
    // stored run stale on every release -- for a checkout that had not changed
    // and evidence that is still a true record of what ran. A change in what
    // instrumentation *means* is a deliberate act, and it moves this version.
    if stored.instrumenter_version != current.instrumenter_version {
        reasons.push("instrumenter contract changed".into());
    }
    if stored.fingerprint.source != current.fingerprint.source {
        reasons.push("instrumented source changed".into());
    }
    if stored.fingerprint.tests != current.fingerprint.tests {
        reasons.push("test files changed".into());
    }
    if stored.fingerprint.dependencies != current.fingerprint.dependencies {
        reasons.push("dependencies or lockfile changed".into());
    }
    if stored.fingerprint.configuration != current.fingerprint.configuration {
        reasons.push("test/build configuration changed".into());
    }
    if reasons.is_empty() && stored.fingerprint.execution != current.fingerprint.execution {
        reasons.push("execution environment changed".into());
    }
    IntegrityComparison {
        stale: !reasons.is_empty(),
        reasons,
    }
}

fn file_sha256(path: &Path) -> Result<([u8; 32], u64), RunStoreError> {
    let metadata = regular_file(path)?;
    let mut file = File::open(path)?;
    let mut hash = Sha256::new();
    let mut buffer = [0_u8; 128 * 1024];
    loop {
        let read = file.read(&mut buffer)?;
        if read == 0 {
            break;
        }
        hash.update(&buffer[..read]);
    }
    Ok((hash.finalize().into(), metadata.len()))
}

fn domain_hash(domain: &str, version: u32) -> [u8; 32] {
    let mut hash = Sha256::new();
    hash.update(domain.as_bytes());
    hash.update([0]);
    hash.update(version.to_le_bytes());
    hash.update([0]);
    hash.update(env!("SUPERCOV_ENGINE_SOURCE_SHA256").as_bytes());
    hash.finalize().into()
}

pub fn query_index_identity(run: &StoredRun) -> Result<QueryIndexIdentity, RunStoreError> {
    let (evidence_sha256, evidence_bytes) = file_sha256(&run.evidence_path)?;
    Ok(QueryIndexIdentity {
        evidence_sha256,
        evidence_bytes,
        analysis_sha256: domain_hash("supercov-analysis", RUST_ANALYSIS_ABI_VERSION),
        producer_sha256: domain_hash(
            "supercov-query-producer",
            RUST_QUERY_PRODUCER_ABI_VERSION ^ QUERY_INDEX_SCHEMA_VERSION,
        ),
        archive_schema_version: run.metadata.raw_evidence.schema_version,
    })
}

#[derive(Debug)]
pub enum RunIndexError {
    RunStore(RunStoreError),
    QueryIndex(QueryIndexError),
    CoverageIndex(CoverageIndexError),
    Report(ReportError),
    Metadata(serde_json::Error),
    EvidenceChanged,
}

impl std::fmt::Display for RunIndexError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::RunStore(error) => write!(formatter, "{error}"),
            Self::QueryIndex(error) => write!(formatter, "{error}"),
            Self::CoverageIndex(error) => write!(formatter, "{error}"),
            Self::Report(ReportError::NoEvidence(_)) => {
                write!(formatter, "no coverage evidence was published")
            }
            Self::Report(error) => write!(formatter, "coverage analysis failed: {error:?}"),
            Self::Metadata(error) => write!(formatter, "run integrity is invalid: {error}"),
            Self::EvidenceChanged => write!(formatter, "evidence changed while indexing"),
        }
    }
}

impl std::error::Error for RunIndexError {}

impl From<RunStoreError> for RunIndexError {
    fn from(value: RunStoreError) -> Self {
        Self::RunStore(value)
    }
}

impl From<QueryIndexError> for RunIndexError {
    fn from(value: QueryIndexError) -> Self {
        Self::QueryIndex(value)
    }
}

impl From<CoverageIndexError> for RunIndexError {
    fn from(value: CoverageIndexError) -> Self {
        Self::CoverageIndex(value)
    }
}

impl From<ReportError> for RunIndexError {
    fn from(value: ReportError) -> Self {
        Self::Report(value)
    }
}

impl From<serde_json::Error> for RunIndexError {
    fn from(value: serde_json::Error) -> Self {
        Self::Metadata(value)
    }
}

fn open_validated_query_index(
    path: &Path,
    identity: &QueryIndexIdentity,
) -> Result<QueryIndex, RunIndexError> {
    let index = QueryIndex::open(path, identity)?;
    index.verify_all()?;
    CoverageIndex::new(&index)?;
    Ok(index)
}

/// Open the index this process has just written. It was synced and renamed
/// into place from the very bytes its page digests were computed over, so
/// hashing the whole file again re-derives what the write already guarantees
/// -- and on a 300-file run that was 726 MB, 29% of the query that follows a
/// test run. Nothing unverified is trusted: every page is still checked against
/// its digest the first time a query reads it. An index found on disk later is
/// verified in full on open, as before, since it may have been torn or changed
/// since it was written.
fn open_written_query_index(
    path: &Path,
    identity: &QueryIndexIdentity,
) -> Result<QueryIndex, RunIndexError> {
    let index = QueryIndex::open(path, identity)?;
    CoverageIndex::new(&index)?;
    Ok(index)
}

/// Open an existing valid index without triggering analysis or publication.
pub fn open_existing_query_index(run: &StoredRun) -> Result<Option<QueryIndex>, RunIndexError> {
    match fs::symlink_metadata(&run.query_index_path) {
        Ok(_) => {
            open_validated_query_index(&run.query_index_path, &query_index_identity(run)?).map(Some)
        }
        Err(error) if error.kind() == io::ErrorKind::NotFound => Ok(None),
        Err(error) => Err(RunStoreError::Io(error).into()),
    }
}

/// Open a valid disposable index or atomically reconstruct it from evidence.
///
/// `evidence.raw.gz` remains authoritative. Any stale, truncated, linked or
/// otherwise invalid index is ignored and replaced by a fully authenticated
/// new inode. A second evidence hash prevents publishing a mixed-generation
/// index if the supposedly immutable archive changes during analysis.
pub fn open_or_rebuild_query_index(run: &StoredRun) -> Result<QueryIndex, RunIndexError> {
    let identity = query_index_identity(run)?;
    if let Ok(index) = open_validated_query_index(&run.query_index_path, &identity) {
        return Ok(index);
    }

    let report = analyze_coverage_archive(&ArchiveReportRequest {
        archive_path: run.evidence_path.clone(),
        run_id: run.id.clone(),
        generated_at: run.metadata.started_at.clone(),
        integrity: Some(serde_json::to_value(&run.metadata.integrity)?),
        test_exit_code: ExitCodeInput::Present(run.metadata.test_exit_code),
    })?;
    let sections = coverage_index_sections(&report)?;
    if query_index_identity(run)? != identity {
        return Err(RunIndexError::EvidenceChanged);
    }
    write_query_index(&sections, &identity, &run.query_index_path)?;
    let index = open_written_query_index(&run.query_index_path, &identity)?;
    if query_index_identity(run)? != identity {
        return Err(RunIndexError::EvidenceChanged);
    }
    Ok(index)
}

#[cfg(test)]
mod tests {
    use std::{
        fs,
        time::{SystemTime, UNIX_EPOCH},
    };

    use crate::evidence_archive::{EvidenceArchiveEntry, read_archive, write_archive};

    use super::*;

    fn temporary_directory(label: &str) -> PathBuf {
        let nonce = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_nanos();
        let path = std::env::temp_dir().join(format!(
            "supercov-run-store-{label}-{}-{nonce}",
            std::process::id()
        ));
        fs::create_dir_all(&path).unwrap();
        path
    }

    fn digest(character: char) -> String {
        std::iter::repeat_n(character, 64).collect()
    }

    fn integrity() -> RunIntegrity {
        RunIntegrity {
            schema_version: 2,
            instrumenter_version: "2.0.0".into(),
            git: Some(GitIntegrity {
                revision: Some(std::iter::repeat_n('a', 40).collect()),
                dirty: false,
            }),
            fingerprint: RunFingerprint {
                algorithm: "sha256".into(),
                source: digest('a'),
                tests: digest('b'),
                dependencies: digest('c'),
                configuration: digest('d'),
                instrumenter: digest('e'),
                execution: digest('f'),
                combined: digest('0'),
                source_files: 1,
                test_files: 1,
            },
            stale: None,
            stale_reasons: None,
        }
    }

    fn create_run(root: &Path, id: &str) -> PathBuf {
        let directory = root.join(".supercov/runs").join(id);
        fs::create_dir_all(&directory).unwrap();
        let archive = write_archive(
            vec![
                EvidenceArchiveEntry {
                    path: "coverage-model.json".into(),
                    contents: br#"{"schemaVersion":1,"language":"fixture","variant":"fixture-v1","name":"Fixture model","completenessMeaning":"Fixture archive identity only.","measured":["fixture"],"notMeasured":[]}"#.to_vec(),
                },
                EvidenceArchiveEntry {
                    path: "frontend.json".into(),
                    contents: br#"{"protocolVersion":2,"frontendId":"fixture","frontendVersion":"fixture-v1","language":"fixture","structuralSource":"owned-probes","runners":[{"runner":"fixture","executionModel":"serial-in-process","attribution":{"run":"exact","worker":"unavailable","test":"unavailable","retry":"unavailable","phase":"unavailable","action":"unavailable","assertion":"unavailable"},"limitations":[{"id":"fixture-identities-unavailable","scopes":["worker","test","retry","phase","action","assertion"],"reason":"This store-only fixture has no execution evidence"}]}],"structuralLimitations":[]}"#.to_vec(),
                },
                EvidenceArchiveEntry {
                    path: "manifest.json".into(),
                    contents: b"{}".to_vec(),
                },
            ],
            &directory.join("evidence.raw.gz"),
        )
        .unwrap();
        let metadata = RunMetadata {
            id: id.into(),
            started_at: id.into(),
            duration_ms: 1.0,
            command: vec!["npm".into(), "test".into()],
            test_exit_code: Some(0),
            integrity: integrity(),
            raw_evidence: RawEvidenceMetadata {
                schema_version: archive.schema_version,
                format: archive.format.into(),
                file: archive.file.into(),
                files: archive.files,
                uncompressed_bytes: archive.uncompressed_bytes,
                compressed_bytes: archive.compressed_bytes,
            },
            isolated_build: Some(true),
            instrumented_build_cache: None,
            timings: None,
            merged: None,
            parents: None,
            source_roots: None,
        };
        fs::write(
            directory.join("run.json"),
            serde_json::to_vec_pretty(&metadata).unwrap(),
        )
        .unwrap();
        directory
    }

    fn create_indexable_run(root: &Path) -> StoredRun {
        create_analyzable_test_run(root, "test-run");
        discover_runs(root).unwrap().runs.remove(0)
    }

    fn create_indexable_python_run(root: &Path) -> StoredRun {
        let directory = create_analyzable_test_run(root, "python-run");
        let evidence_path = directory.join("evidence.raw.gz");
        let mut entries = read_archive(&evidence_path).unwrap();
        for entry in &mut entries {
            if entry.path.ends_with("/mcdc.json") {
                let mut result: serde_json::Value =
                    serde_json::from_slice(&entry.contents).unwrap();
                result["provenance"]["runner"] = "pytest".into();
                result["provenance"]["kind"] = "unit".into();
                result["testFile"] = "tests/test_app.py".into();
                entry.contents = serde_json::to_vec(&result).unwrap();
            }
        }
        entries
            .iter_mut()
            .find(|entry| entry.path == "frontend.json")
            .unwrap()
            .contents = serde_json::to_vec(&serde_json::json!({
            "protocolVersion": 2,
            "frontendId": "python",
            "frontendVersion": "python-owned-v1",
            "language": "python",
            "structuralSource": "owned-probes",
            "runners": [{
                "runner": "pytest",
                "executionModel": "serial-in-process",
                "attribution": {
                    "run": "exact",
                    "worker": "unavailable",
                    "test": "exact",
                    "retry": "exact",
                    "phase": "exact",
                    "action": "exact",
                    "assertion": "exact"
                },
                "limitations": [{
                    "id": "test-fixture-worker-unavailable",
                    "scopes": ["worker"],
                    "reason": "The persisted-run fixture intentionally has no worker identity"
                }]
            }],
            "structuralLimitations": []
        }))
        .unwrap();
        entries
            .iter_mut()
            .find(|entry| entry.path == "coverage-model.json")
            .unwrap()
            .contents = serde_json::to_vec(&serde_json::json!({
            "schemaVersion": 1,
            "language": "python",
            "variant": "all",
            "name": "python-owned-control-flow",
            "completenessMeaning": "Every declared owned-probe obligation was observed.",
            "measured": ["owned statements", "owned decisions"],
            "notMeasured": []
        }))
        .unwrap();
        let archive = write_archive(entries, &evidence_path).unwrap();
        let metadata_path = directory.join("run.json");
        let mut metadata: RunMetadata =
            serde_json::from_slice(&fs::read(&metadata_path).unwrap()).unwrap();
        metadata.raw_evidence = RawEvidenceMetadata {
            schema_version: archive.schema_version,
            format: archive.format.into(),
            file: archive.file.into(),
            files: archive.files,
            uncompressed_bytes: archive.uncompressed_bytes,
            compressed_bytes: archive.compressed_bytes,
        };
        fs::write(metadata_path, serde_json::to_vec_pretty(&metadata).unwrap()).unwrap();
        discover_runs(root).unwrap().runs.remove(0)
    }

    #[test]
    fn discovers_valid_runs_in_reverse_order_and_selects_exact_prefix_or_latest() {
        let root = temporary_directory("discovery");
        create_run(&root, "2026-08-24T00-00-00-000Z");
        create_run(&root, "2026-08-25T00-00-00-000Z");
        create_run(&root, "zz-custom-old-run");
        let custom_metadata = root.join(".supercov/runs/zz-custom-old-run/run.json");
        let mut custom: serde_json::Value =
            serde_json::from_slice(&fs::read(&custom_metadata).unwrap()).unwrap();
        custom["startedAt"] = "2026-08-23T00:00:00.000Z".into();
        fs::write(
            &custom_metadata,
            serde_json::to_vec_pretty(&custom).unwrap(),
        )
        .unwrap();
        let inventory = discover_runs(&root).unwrap();
        assert!(inventory.rejected.is_empty());
        assert_eq!(
            inventory
                .runs
                .iter()
                .map(|run| run.id.as_str())
                .collect::<Vec<_>>(),
            [
                "2026-08-25T00-00-00-000Z",
                "2026-08-24T00-00-00-000Z",
                "zz-custom-old-run"
            ]
        );
        assert_eq!(
            select_run(&inventory, None).unwrap().id,
            inventory.runs[0].id
        );
        assert_eq!(
            select_run(&inventory, Some("2026-08-24")).unwrap().id,
            "2026-08-24T00-00-00-000Z"
        );
        assert!(matches!(
            select_run(&inventory, Some("missing")),
            Err(RunStoreError::RunNotFound(_))
        ));
        fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn reports_damaged_entries_without_hiding_valid_runs() {
        let root = temporary_directory("rejected");
        create_run(&root, "valid");
        let mismatched = create_run(&root, "mismatched");
        let mut metadata: serde_json::Value =
            serde_json::from_slice(&fs::read(mismatched.join("run.json")).unwrap()).unwrap();
        metadata["id"] = "different".into();
        fs::write(
            mismatched.join("run.json"),
            serde_json::to_vec(&metadata).unwrap(),
        )
        .unwrap();
        let corrupt = create_run(&root, "wrong-length");
        fs::write(corrupt.join("evidence.raw.gz"), b"truncated").unwrap();
        let schema_mismatch = create_run(&root, "schema-mismatch");
        let metadata_path = schema_mismatch.join("run.json");
        let mut metadata: serde_json::Value =
            serde_json::from_slice(&fs::read(&metadata_path).unwrap()).unwrap();
        metadata["rawEvidence"]["schemaVersion"] = 2.into();
        fs::write(&metadata_path, serde_json::to_vec(&metadata).unwrap()).unwrap();

        let inventory = discover_runs(&root).unwrap();
        assert_eq!(inventory.runs.len(), 1);
        assert_eq!(inventory.runs[0].id, "valid");
        assert_eq!(inventory.rejected.len(), 3);
        assert!(inventory.rejected[0].reason.contains("metadata ID"));
        assert!(
            inventory
                .rejected
                .iter()
                .any(|run| run.reason.contains("raw evidence metadata"))
        );
        assert!(
            inventory
                .rejected
                .iter()
                .any(|run| run.reason.contains("raw evidence length"))
        );
        fs::remove_dir_all(root).unwrap();
    }

    #[cfg(unix)]
    #[test]
    fn refuses_linked_run_directories_and_files() {
        use std::os::unix::fs::symlink;

        let root = temporary_directory("links");
        let target = create_run(&root, "target");
        symlink(&target, root.join(".supercov/runs/linked-run")).unwrap();
        let linked_metadata = create_run(&root, "linked-metadata");
        fs::remove_file(linked_metadata.join("run.json")).unwrap();
        symlink(target.join("run.json"), linked_metadata.join("run.json")).unwrap();
        let linked_evidence = create_run(&root, "linked-evidence");
        fs::remove_file(linked_evidence.join("evidence.raw.gz")).unwrap();
        symlink(
            target.join("evidence.raw.gz"),
            linked_evidence.join("evidence.raw.gz"),
        )
        .unwrap();

        let inventory = discover_runs(&root).unwrap();
        assert_eq!(inventory.runs.len(), 1);
        assert_eq!(inventory.runs[0].id, "target");
        assert_eq!(inventory.rejected.len(), 3);
        assert!(
            inventory
                .rejected
                .iter()
                .all(|rejected| rejected.reason.contains("unsafe run-store path"))
        );
        fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn compares_integrity_in_stable_contract_order_and_binds_identity_to_evidence() {
        let root = temporary_directory("identity");
        create_run(&root, "run");
        let inventory = discover_runs(&root).unwrap();
        let run = &inventory.runs[0];
        let first = query_index_identity(run).unwrap();
        fs::write(&run.evidence_path, b"different bytes").unwrap();
        let second = query_index_identity(run).unwrap();
        assert_ne!(first.evidence_sha256, second.evidence_sha256);
        assert_ne!(first.evidence_bytes, second.evidence_bytes);
        assert_eq!(first.analysis_sha256, second.analysis_sha256);
        assert_eq!(env!("SUPERCOV_ENGINE_SOURCE_SHA256").len(), 64);

        let mut current = integrity();
        current.schema_version += 1;
        current.instrumenter_version = "javascript-v2".into();
        current.fingerprint.source = digest('2');
        current.fingerprint.tests = digest('3');
        current.fingerprint.dependencies = digest('4');
        current.fingerprint.configuration = digest('5');
        assert_eq!(
            compare_run_integrity(Some(&integrity()), &current).reasons,
            [
                "coverage schema changed",
                "instrumenter contract changed",
                "instrumented source changed",
                "test files changed",
                "dependencies or lockfile changed",
                "test/build configuration changed",
            ]
        );

        // Supercov's own digest moves on nearly every release. The checkout has
        // not changed and the recorded evidence is still a true record of what
        // ran, so it is not a reason to discard the run. Merging and the build
        // caches still consult this digest directly, where it does matter.
        let mut rebuilt = integrity();
        rebuilt.fingerprint.instrumenter = digest('1');
        assert!(!compare_run_integrity(Some(&integrity()), &rebuilt).stale);
        fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn lazily_builds_reuses_and_repairs_a_fully_authenticated_typed_index() {
        let root = temporary_directory("lazy-index");
        let run = create_indexable_run(&root);
        assert!(!run.query_index_path.exists());

        {
            let index = open_or_rebuild_query_index(&run).unwrap();
            index.verify_all().unwrap();
            CoverageIndex::new(&index).unwrap();
        }
        let canonical = fs::read(&run.query_index_path).unwrap();
        assert!(canonical.len() > crate::query_index::QUERY_INDEX_HEADER_SIZE);
        {
            let index = open_or_rebuild_query_index(&run).unwrap();
            index.verify_all().unwrap();
        }
        assert_eq!(fs::read(&run.query_index_path).unwrap(), canonical);

        let mut corrupt = canonical.clone();
        let offset = crate::query_index::QUERY_INDEX_HEADER_SIZE + 8;
        corrupt[offset] ^= 0xff;
        fs::write(&run.query_index_path, corrupt).unwrap();
        {
            let index = open_or_rebuild_query_index(&run).unwrap();
            index.verify_all().unwrap();
        }
        assert_eq!(fs::read(&run.query_index_path).unwrap(), canonical);
        fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn an_index_opened_without_the_full_check_still_refuses_a_corrupt_page() {
        // The index a process has just written is opened without hashing every
        // page first, since the write already guarantees them. What keeps that
        // safe is that no page is trusted before it is checked: reading one
        // that does not match its digest must fail, not return its bytes.
        let root = temporary_directory("written-index");
        let run = create_indexable_python_run(&root);
        let identity = query_index_identity(&run).unwrap();
        drop(open_or_rebuild_query_index(&run).unwrap());
        let lines = QueryIndex::open(&run.query_index_path, &identity)
            .unwrap()
            .descriptor(crate::coverage_index::SECTION_LINES)
            .unwrap();
        assert!(lines.length > 0, "the fixture has line records to corrupt");

        let mut bytes = fs::read(&run.query_index_path).unwrap();
        bytes[lines.offset as usize] ^= 0xff;
        fs::write(&run.query_index_path, bytes).unwrap();

        let index = open_written_query_index(&run.query_index_path, &identity)
            .expect("opening does not hash every page");
        assert!(
            matches!(
                index.bytes(crate::coverage_index::SECTION_LINES, 0, 1),
                Err(crate::query_index::QueryIndexError::CorruptPage { .. })
            ),
            "the corrupt page is refused when it is read"
        );
        assert!(
            index.verify_all().is_err(),
            "and a full check still finds it"
        );
        fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn indexes_the_declared_language_model() {
        let root = temporary_directory("v3-index");
        let run = create_indexable_python_run(&root);
        assert_eq!(
            run.metadata.raw_evidence.schema_version,
            EVIDENCE_ARCHIVE_SCHEMA_VERSION
        );
        assert_eq!(
            query_index_identity(&run).unwrap().archive_schema_version,
            EVIDENCE_ARCHIVE_SCHEMA_VERSION
        );
        let index = open_or_rebuild_query_index(&run).unwrap();
        index.verify_all().unwrap();
        let coverage_index = CoverageIndex::new(&index).unwrap();
        assert_eq!(
            coverage_index.model().unwrap().name,
            "python-owned-control-flow"
        );
        let summary = coverage_index
            .summary(crate::coverage_index::CoverageViewId::All)
            .unwrap();
        assert_eq!(summary.lines.percentage, 100.0);
        fs::remove_dir_all(root).unwrap();
    }

    #[cfg(unix)]
    #[test]
    fn atomically_replaces_a_linked_disposable_index_without_touching_its_target() {
        use std::os::unix::fs::symlink;

        let root = temporary_directory("linked-index");
        let run = create_indexable_run(&root);
        let outside = root.join("outside");
        fs::write(&outside, b"user data").unwrap();
        symlink(&outside, &run.query_index_path).unwrap();

        let index = open_or_rebuild_query_index(&run).unwrap();
        index.verify_all().unwrap();
        assert_eq!(fs::read(outside).unwrap(), b"user data");
        assert!(
            fs::symlink_metadata(&run.query_index_path)
                .unwrap()
                .file_type()
                .is_file()
        );
        fs::remove_dir_all(root).unwrap();
    }
}