lemma/planning/

temporal.rs

use crate::engine::{Context, TemporalBound};
use crate::parsing::ast::{DateTimeValue, FactValue, LemmaSpec, TypeDef};
use crate::parsing::source::Source;
use crate::Error;
use std::collections::BTreeSet;
use std::sync::Arc;

/// A temporal slice: an interval within a spec's active range where the
/// entire transitive dependency tree resolves to the same set of versions.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TemporalSlice {
    /// Inclusive start. None = -∞.
    pub from: Option<DateTimeValue>,
    /// Exclusive end. None = +∞.
    pub to: Option<DateTimeValue>,
}

/// Collect names of implicit (unpinned) dependency references with their source locations.
/// Includes both fact-level spec refs and type imports (named and inline) that are not hash-pinned.
fn implicit_spec_refs(spec: &LemmaSpec) -> Vec<(String, Source)> {
    let mut refs: Vec<(String, Source)> = Vec::new();

    for fact in &spec.facts {
        match &fact.value {
            FactValue::SpecReference(spec_ref) => {
                if spec_ref.hash_pin.is_none() {
                    refs.push((spec_ref.name.clone(), fact.source_location.clone()));
                }
            }
            FactValue::TypeDeclaration {
                from: Some(from_ref),
                ..
            } => {
                if from_ref.hash_pin.is_none() {
                    refs.push((from_ref.name.clone(), fact.source_location.clone()));
                }
            }
            _ => {}
        }
    }

    for type_def in &spec.types {
        match type_def {
            TypeDef::Import {
                from,
                source_location,
                ..
            } => {
                if from.hash_pin.is_none() {
                    refs.push((from.name.clone(), source_location.clone()));
                }
            }
            TypeDef::Inline {
                from: Some(from_ref),
                source_location,
                ..
            } => {
                if from_ref.hash_pin.is_none() {
                    refs.push((from_ref.name.clone(), source_location.clone()));
                }
            }
            _ => {}
        }
    }

    refs
}

/// Collect just the names (for callers that don't need locations).
fn implicit_spec_ref_names(spec: &LemmaSpec) -> Vec<String> {
    implicit_spec_refs(spec)
        .into_iter()
        .map(|(n, _)| n)
        .collect()
}

/// Compute temporal slices for a spec within its effective range.
///
/// A slice boundary occurs at every `effective_from` date of a dependency version
/// that falls strictly within the spec's effective range. Transitive
/// dependencies are followed recursively (fixed-point) to discover all
/// boundaries.
///
/// Returns sorted, non-overlapping slices that partition the spec's
/// effective range. For specs without implicit spec refs or without
/// any version boundaries in range, returns a single slice covering the
/// full effective range.
pub fn compute_temporal_slices(spec_arc: &Arc<LemmaSpec>, context: &Context) -> Vec<TemporalSlice> {
    let (eff_from, eff_to) = context.effective_range(spec_arc);
    let range_start = TemporalBound::from_start(eff_from.as_ref());
    let range_end = TemporalBound::from_end(eff_to.as_ref());

    let direct_implicit_names = implicit_spec_ref_names(spec_arc);
    if direct_implicit_names.is_empty() {
        return vec![TemporalSlice {
            from: eff_from,
            to: eff_to,
        }];
    }

    // Fixed-point: collect all boundary points from transitive implicit deps.
    // We track which spec names we've already visited to avoid cycles.
    let mut visited_names: BTreeSet<String> = BTreeSet::new();
    let mut pending_names: Vec<String> = direct_implicit_names;
    let mut all_boundaries: BTreeSet<DateTimeValue> = BTreeSet::new();

    while let Some(dep_name) = pending_names.pop() {
        if !visited_names.insert(dep_name.clone()) {
            continue;
        }

        let dep_versions: Vec<Arc<LemmaSpec>> =
            context.iter().filter(|d| d.name == dep_name).collect();
        if dep_versions.is_empty() {
            // Missing dep — validate_temporal_coverage already reported an error.
            // Skip so graph building can still collect additional errors.
            continue;
        }

        let boundaries = context.version_boundaries(&dep_name);
        for boundary in boundaries {
            let bound = TemporalBound::At(boundary.clone());
            if bound > range_start && bound < range_end {
                all_boundaries.insert(boundary);
            }
        }
        for dep_spec in &dep_versions {
            for transitive_name in implicit_spec_ref_names(dep_spec) {
                if !visited_names.contains(&transitive_name) {
                    pending_names.push(transitive_name);
                }
            }
        }
    }

    if all_boundaries.is_empty() {
        return vec![TemporalSlice {
            from: eff_from,
            to: eff_to,
        }];
    }

    // Split the effective range at each boundary point.
    let mut slices = Vec::new();
    let mut cursor = eff_from.clone();

    for boundary in &all_boundaries {
        slices.push(TemporalSlice {
            from: cursor,
            to: Some(boundary.clone()),
        });
        cursor = Some(boundary.clone());
    }

    slices.push(TemporalSlice {
        from: cursor,
        to: eff_to,
    });

    slices
}

/// Validate temporal coverage for all specs in the context.
///
/// For each spec, checks that every implicit (unpinned) dependency has
/// versions that fully cover the spec's effective range. Returns errors
/// for any dependency that has gaps.
///
/// Allows interface evolution: coverage is checked here, and interface
/// compatibility is validated per-slice during graph building.
pub fn validate_temporal_coverage(context: &Context) -> Vec<Error> {
    let mut errors = Vec::new();

    for spec_arc in context.iter() {
        let (eff_from, eff_to) = context.effective_range(&spec_arc);
        let dep_refs = implicit_spec_refs(&spec_arc);

        for (dep_name, ref_source) in &dep_refs {
            let gaps = context.dep_coverage_gaps(dep_name, eff_from.as_ref(), eff_to.as_ref());

            for (gap_start, gap_end) in &gaps {
                let (message, suggestion) =
                    format_coverage_gap(&spec_arc.name, dep_name, gap_start, gap_end, &eff_from);
                errors.push(Error::validation_with_context(
                    message,
                    Some(ref_source.clone()),
                    Some(suggestion),
                    Some(Arc::clone(&spec_arc)),
                    None,
                ));
            }
        }
    }

    errors
}

fn format_coverage_gap(
    spec_name: &str,
    dep_name: &str,
    gap_start: &Option<DateTimeValue>,
    gap_end: &Option<DateTimeValue>,
    spec_from: &Option<DateTimeValue>,
) -> (String, String) {
    let message = match (gap_start, gap_end) {
        (None, Some(end)) => format!(
            "'{}' depends on '{}', but no version of '{}' is active before {}",
            spec_name, dep_name, dep_name, end
        ),
        (Some(start), None) => format!(
            "'{}' depends on '{}', but no version of '{}' is active after {}",
            spec_name, dep_name, dep_name, start
        ),
        (Some(start), Some(end)) => format!(
            "'{}' depends on '{}', but no version of '{}' is active between {} and {}",
            spec_name, dep_name, dep_name, start, end
        ),
        (None, None) => format!(
            "'{}' depends on '{}', but no version of '{}' exists",
            spec_name, dep_name, dep_name
        ),
    };

    let suggestion = if gap_start.is_none() && gap_end.is_none() && dep_name.starts_with('@') {
        format!(
            "Run `lemma get` or `lemma get {}` to fetch this dependency.",
            dep_name
        )
    } else if gap_start.is_none() && spec_from.is_none() {
        format!(
            "Add an effective_from date to '{}' so it starts when '{}' is available, \
             or add an earlier version of '{}'.",
            spec_name, dep_name, dep_name
        )
    } else if gap_end.is_none() {
        format!(
            "Add a newer version of '{}' that covers the remaining range.",
            dep_name
        )
    } else {
        format!(
            "Add a version of '{}' that covers the gap, \
             or adjust the effective_from date on '{}'.",
            dep_name, spec_name
        )
    };

    (message, suggestion)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parsing::ast::{FactValue, LemmaFact, LemmaSpec, Reference, SpecRef};
    use crate::parsing::source::Source;
    use crate::Span;

    fn date(year: i32, month: u32, day: u32) -> DateTimeValue {
        DateTimeValue {
            year,
            month,
            day,
            hour: 0,
            minute: 0,
            second: 0,
            microsecond: 0,
            timezone: None,
        }
    }

    fn dummy_source() -> Source {
        Source::new(
            "test",
            Span {
                start: 0,
                end: 0,
                line: 0,
                col: 0,
            },
        )
    }

    fn make_spec(name: &str) -> LemmaSpec {
        LemmaSpec::new(name.to_string())
    }

    fn make_spec_with_range(name: &str, effective_from: Option<DateTimeValue>) -> LemmaSpec {
        let mut spec = make_spec(name);
        spec.effective_from = effective_from;
        spec
    }

    fn add_spec_ref_fact(spec: &mut LemmaSpec, fact_name: &str, dep_name: &str) {
        spec.facts.push(LemmaFact {
            reference: Reference::local(fact_name.to_string()),
            value: FactValue::SpecReference(SpecRef {
                name: dep_name.to_string(),
                from_registry: false,
                hash_pin: None,
                effective: None,
            }),
            source_location: dummy_source(),
        });
    }

    #[test]
    fn no_deps_produces_single_slice() {
        let mut ctx = Context::new();
        let spec = Arc::new(make_spec_with_range("a", Some(date(2025, 1, 1))));
        ctx.insert_spec(Arc::clone(&spec), false).unwrap();

        let slices = compute_temporal_slices(&spec, &ctx);
        assert_eq!(slices.len(), 1);
        assert_eq!(slices[0].from, Some(date(2025, 1, 1)));
        assert_eq!(slices[0].to, None);
    }

    #[test]
    fn single_dep_no_boundary_in_range() {
        let mut ctx = Context::new();
        let mut main_spec = make_spec_with_range("main", Some(date(2025, 1, 1)));
        add_spec_ref_fact(&mut main_spec, "dep", "config");
        let main_arc = Arc::new(main_spec);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();

        let config = Arc::new(make_spec("config"));
        ctx.insert_spec(config, false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 1);
    }

    #[test]
    fn single_dep_one_boundary_produces_two_slices() {
        let mut ctx = Context::new();

        let config_v1 = Arc::new(make_spec("config"));
        ctx.insert_spec(config_v1, false).unwrap();
        let config_v2 = Arc::new(make_spec_with_range("config", Some(date(2025, 2, 1))));
        ctx.insert_spec(config_v2, false).unwrap();

        // main: [Jan 1, +inf) depends on config
        let mut main_spec = make_spec_with_range("main", Some(date(2025, 1, 1)));
        add_spec_ref_fact(&mut main_spec, "cfg", "config");
        let main_arc = Arc::new(main_spec);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 2);
        assert_eq!(slices[0].from, Some(date(2025, 1, 1)));
        assert_eq!(slices[0].to, Some(date(2025, 2, 1)));
        assert_eq!(slices[1].from, Some(date(2025, 2, 1)));
        assert_eq!(slices[1].to, None);
    }

    #[test]
    fn boundary_outside_range_ignored() {
        let mut ctx = Context::new();

        let config_v1 = Arc::new(make_spec("config"));
        ctx.insert_spec(config_v1, false).unwrap();
        let config_v2 = Arc::new(make_spec_with_range("config", Some(date(2025, 6, 1))));
        ctx.insert_spec(config_v2, false).unwrap();

        // main v1: [Jan 1, Mar 1) — successor main v2 defines the end
        let main_v1 = make_spec_with_range("main", Some(date(2025, 1, 1)));
        let main_v2 = make_spec_with_range("main", Some(date(2025, 3, 1)));
        let mut main_v1 = main_v1;
        add_spec_ref_fact(&mut main_v1, "cfg", "config");
        let main_arc = Arc::new(main_v1);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();
        ctx.insert_spec(Arc::new(main_v2), false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 1);
    }

    #[test]
    fn transitive_dep_boundary_included() {
        let mut ctx = Context::new();

        let mut config = make_spec("config");
        add_spec_ref_fact(&mut config, "rates_ref", "rates");
        ctx.insert_spec(Arc::new(config), false).unwrap();

        let rates_v1 = Arc::new(make_spec("rates"));
        ctx.insert_spec(rates_v1, false).unwrap();
        let rates_v2 = Arc::new(make_spec_with_range("rates", Some(date(2025, 2, 1))));
        ctx.insert_spec(rates_v2, false).unwrap();

        // main: [Jan 1, +inf) depends on config
        let mut main_spec = make_spec_with_range("main", Some(date(2025, 1, 1)));
        add_spec_ref_fact(&mut main_spec, "cfg", "config");
        let main_arc = Arc::new(main_spec);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 2);
        assert_eq!(slices[0].to, Some(date(2025, 2, 1)));
        assert_eq!(slices[1].from, Some(date(2025, 2, 1)));
    }

    #[test]
    fn unbounded_spec_with_versioned_dep() {
        let mut ctx = Context::new();

        let dep_v1 = Arc::new(make_spec("dep"));
        ctx.insert_spec(dep_v1, false).unwrap();
        let dep_v2 = Arc::new(make_spec_with_range("dep", Some(date(2025, 6, 1))));
        ctx.insert_spec(dep_v2, false).unwrap();

        let mut main_spec = make_spec("main");
        add_spec_ref_fact(&mut main_spec, "d", "dep");
        let main_arc = Arc::new(main_spec);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 2);
        assert_eq!(slices[0].from, None);
        assert_eq!(slices[0].to, Some(date(2025, 6, 1)));
        assert_eq!(slices[1].from, Some(date(2025, 6, 1)));
        assert_eq!(slices[1].to, None);
    }

    #[test]
    fn pinned_ref_does_not_create_boundary() {
        let mut ctx = Context::new();

        let dep_v1 = Arc::new(make_spec("dep"));
        ctx.insert_spec(dep_v1, false).unwrap();
        let dep_v2 = Arc::new(make_spec_with_range("dep", Some(date(2025, 6, 1))));
        ctx.insert_spec(dep_v2, false).unwrap();

        let mut main_spec = make_spec("main");
        main_spec.facts.push(LemmaFact {
            reference: Reference::local("d".to_string()),
            value: FactValue::SpecReference(SpecRef {
                name: "dep".to_string(),
                from_registry: false,
                hash_pin: Some("abcd1234".to_string()),
                effective: None,
            }),
            source_location: dummy_source(),
        });
        let main_arc = Arc::new(main_spec);
        ctx.insert_spec(Arc::clone(&main_arc), false).unwrap();

        let slices = compute_temporal_slices(&main_arc, &ctx);
        assert_eq!(slices.len(), 1);
    }
}