icydb-core 0.124.2

//! Module: db::query::plan::tests::order
//! Covers planner-owned scalar order-expression parsing and canonical
//! index-order rendering contracts.
//! Does not own: grouped order policy or executor slot materialization.
//! Boundary: keeps shared planner order-expression helper coverage under the
//! planner `tests/` boundary instead of one leaf rendering helper.

use crate::{
    db::query::plan::{
        GroupedIndexOrderMatch, OrderDirection, OrderSpec,
        expr::{
            parse_supported_computed_order_expr, parse_supported_order_expr,
            render_supported_order_expr, supported_order_expr_field,
            supported_order_expr_is_plain_field,
        },
        index_order_terms,
    },
    model::index::{IndexExpression, IndexKeyItem, IndexModel},
};

const EXPRESSION_INDEX_FIELDS: [&str; 1] = ["name"];
const EXPRESSION_INDEX_KEY_ITEMS: [IndexKeyItem; 1] =
    [IndexKeyItem::Expression(IndexExpression::Lower("name"))];
const EXPRESSION_INDEX_MODEL: IndexModel = IndexModel::generated_with_key_items(
    "order_term_tests::idx_name_lower",
    "order_term_tests::Store",
    &EXPRESSION_INDEX_FIELDS,
    &EXPRESSION_INDEX_KEY_ITEMS,
    false,
);
const GROUPED_INDEX_FIELDS: [&str; 2] = ["group", "rank"];
const GROUPED_INDEX_MODEL: IndexModel = IndexModel::generated(
    "order_term_tests::idx_group_rank",
    "order_term_tests::Store",
    &GROUPED_INDEX_FIELDS,
    false,
);

#[test]
fn supported_order_expr_helpers_round_trip_supported_scalar_text_terms() {
    let lower = parse_supported_order_expr("LOWER(name)")
        .expect("lower(name) should parse onto the canonical expression tree");
    assert_eq!(
        supported_order_expr_field(&lower)
            .expect("lower(name) should preserve one field leaf")
            .as_str(),
        "name"
    );
    assert_eq!(
        render_supported_order_expr(&lower),
        Some("LOWER(name)".to_string())
    );

    let upper = parse_supported_order_expr("UPPER(email)")
        .expect("upper(email) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&upper),
        Some("UPPER(email)".to_string())
    );

    let trim = parse_supported_order_expr("TRIM(name)")
        .expect("trim(name) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&trim),
        Some("TRIM(name)".to_string())
    );

    let ltrim = parse_supported_order_expr("LTRIM(name)")
        .expect("ltrim(name) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&ltrim),
        Some("LTRIM(name)".to_string())
    );

    let rtrim = parse_supported_order_expr("RTRIM(name)")
        .expect("rtrim(name) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&rtrim),
        Some("RTRIM(name)".to_string())
    );

    let length = parse_supported_order_expr("LENGTH(name)")
        .expect("length(name) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&length),
        Some("LENGTH(name)".to_string())
    );

    let left = parse_supported_order_expr("LEFT(name, 2)")
        .expect("left(name, 2) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&left),
        Some("LEFT(name, 2)".to_string())
    );

    let position = parse_supported_order_expr("POSITION('a', name)")
        .expect("position('a', name) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&position),
        Some("POSITION('a', name)".to_string())
    );
}

#[test]
fn supported_order_expr_helpers_round_trip_bounded_numeric_terms() {
    let arithmetic = parse_supported_order_expr("age + rank")
        .expect("bounded field-to-field arithmetic should parse onto the canonical tree");
    assert_eq!(
        render_supported_order_expr(&arithmetic),
        Some("age + rank".to_string())
    );

    let rounded = parse_supported_order_expr("ROUND(age + rank, 2)")
        .expect("bounded ROUND(arithmetic, scale) should parse onto the canonical tree");
    assert_eq!(
        render_supported_order_expr(&rounded),
        Some("ROUND(age + rank, 2)".to_string())
    );

    let nested = parse_supported_order_expr("ROUND((age + rank) / (age + 1), 2)").expect(
        "bounded ROUND(parenthesized arithmetic, scale) should parse onto the canonical tree",
    );
    assert_eq!(
        render_supported_order_expr(&nested),
        Some("ROUND((age + rank) / (age + 1), 2)".to_string())
    );
}

#[test]
fn supported_order_expr_helpers_round_trip_nested_scalar_wrappers() {
    let abs = parse_supported_order_expr("ABS(age - 30)")
        .expect("abs(age - 30) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&abs),
        Some("ABS(age - 30)".to_string())
    );

    let coalesce = parse_supported_order_expr("COALESCE(NULLIF(age, 20), 99)")
        .expect("coalesce(nullif(age, 20), 99) should parse onto the canonical expression tree");
    assert_eq!(
        render_supported_order_expr(&coalesce),
        Some("COALESCE(NULLIF(age, 20), 99)".to_string())
    );

    let nested = parse_supported_order_expr("LOWER(COALESCE(name, 'fallback'))").expect(
        "lower(coalesce(name, 'fallback')) should parse onto the canonical expression tree",
    );
    assert_eq!(
        render_supported_order_expr(&nested),
        Some("LOWER(COALESCE(name, 'fallback'))".to_string())
    );
}

#[test]
fn supported_order_expr_helpers_distinguish_plain_fields_from_computed_terms() {
    let field = parse_supported_order_expr("id")
        .expect("plain field order terms should parse onto the canonical expression tree");
    assert!(
        supported_order_expr_is_plain_field(&field),
        "plain field order terms must stay on the schema-field path",
    );
    assert_eq!(
        parse_supported_computed_order_expr("id"),
        None,
        "plain field order terms must not re-enter computed-expression paths",
    );

    let lower = parse_supported_order_expr("LOWER(name)")
        .expect("lower(name) should parse onto the canonical expression tree");
    assert!(
        !supported_order_expr_is_plain_field(&lower),
        "computed order terms must stay on the expression path",
    );
    assert_eq!(
        parse_supported_computed_order_expr("LOWER(name)"),
        Some(lower),
        "computed order terms must stay parseable through the shared helper",
    );
}

#[test]
fn index_order_terms_use_canonical_key_item_text() {
    assert_eq!(
        index_order_terms(&EXPRESSION_INDEX_MODEL),
        vec!["LOWER(name)".to_string()]
    );
}

#[test]
fn grouped_index_order_contract_classifies_full_and_suffix_matches() {
    let full_order = OrderSpec {
        fields: vec![
            crate::db::query::plan::OrderTerm::field("group", OrderDirection::Asc),
            crate::db::query::plan::OrderTerm::field("rank", OrderDirection::Asc),
        ],
    };
    let full_contract = full_order
        .grouped_index_order_contract()
        .expect("uniform-direction grouped ORDER BY should build one grouped index-order contract");
    let suffix_order = OrderSpec {
        fields: vec![crate::db::query::plan::OrderTerm::field(
            "rank",
            OrderDirection::Asc,
        )],
    };
    let suffix_contract = suffix_order.grouped_index_order_contract().expect(
        "uniform-direction grouped ORDER BY suffix should build one grouped index-order contract",
    );
    let index_terms = index_order_terms(&GROUPED_INDEX_MODEL);

    assert_eq!(
        full_contract.classify_index_match(&index_terms, 0),
        GroupedIndexOrderMatch::Full,
    );
    assert_eq!(
        suffix_contract.classify_index_match(&index_terms, 1),
        GroupedIndexOrderMatch::Suffix,
    );
}