icydb-core 0.69.8

//! Module: db::schema::info
//! Responsibility: schema model/index integrity checks used during schema info construction.
//! Does not own: query planning policy or runtime predicate evaluation.
//! Boundary: validates entity/index model consistency for predicate schema metadata.

use crate::{
    db::{
        identity::{EntityName, IndexName},
        index::canonical_index_predicate,
        schema::{FieldType, ValidateError, field_type_from_model_kind, validate},
    },
    model::{
        entity::EntityModel,
        field::FieldKind,
        index::{IndexExpression, IndexKeyItem, IndexKeyItemsRef, IndexModel},
    },
};

type SchemaFieldEntry = (&'static str, SchemaFieldInfo);

fn schema_field_info<'a>(
    fields: &'a [SchemaFieldEntry],
    name: &str,
) -> Option<&'a SchemaFieldInfo> {
    fields
        .binary_search_by_key(&name, |(field_name, _)| *field_name)
        .ok()
        .map(|index| &fields[index].1)
}

// Resolve one index field reference and enforce baseline queryability invariants.
fn index_field_type<'a>(
    fields: &'a [SchemaFieldEntry],
    index: &IndexModel,
    field: &'static str,
) -> Result<&'a FieldType, ValidateError> {
    let Some(field_info) = schema_field_info(fields, field) else {
        return Err(ValidateError::IndexFieldUnknown {
            index: *index,
            field: field.to_string(),
        });
    };
    let field_type = &field_info.ty;

    // Guardrail: map fields are deterministic stored values but remain
    // non-queryable and non-indexable in 0.7.
    if matches!(field_type, FieldType::Map { .. }) {
        return Err(ValidateError::IndexFieldMapNotQueryable {
            index: *index,
            field: field.to_string(),
        });
    }
    if !field_type.value_kind().is_queryable() {
        return Err(ValidateError::IndexFieldNotQueryable {
            index: *index,
            field: field.to_string(),
        });
    }

    Ok(field_type)
}

// Validate one field key item, including duplicate-field rejection for one index.
fn validate_index_field_reference(
    fields: &[SchemaFieldEntry],
    index: &IndexModel,
    field: &'static str,
    seen: &mut Vec<&'static str>,
) -> Result<(), ValidateError> {
    index_field_type(fields, index, field)?;

    if seen.contains(&field) {
        return Err(ValidateError::IndexFieldDuplicate {
            index: *index,
            field: field.to_string(),
        });
    }
    seen.push(field);

    Ok(())
}

// Validate one expression key item against declared schema field types.
fn validate_index_expression_reference(
    fields: &[SchemaFieldEntry],
    index: &IndexModel,
    expression: IndexExpression,
) -> Result<(), ValidateError> {
    let field = expression.field();
    let field_type = index_field_type(fields, index, field)?;

    match expression {
        IndexExpression::Lower(_)
        | IndexExpression::Upper(_)
        | IndexExpression::Trim(_)
        | IndexExpression::LowerTrim(_) => {
            if !field_type.is_text() {
                return Err(ValidateError::invalid_index_expression_field_type(
                    *index,
                    expression,
                    "a text field",
                ));
            }
        }
        IndexExpression::Date(_)
        | IndexExpression::Year(_)
        | IndexExpression::Month(_)
        | IndexExpression::Day(_) => {
            if !field_type.is_date_or_timestamp() {
                return Err(ValidateError::invalid_index_expression_field_type(
                    *index,
                    expression,
                    "a date or timestamp field",
                ));
            }
        }
    }

    Ok(())
}

fn validate_index_fields(
    fields: &[SchemaFieldEntry],
    indexes: &[&IndexModel],
) -> Result<(), ValidateError> {
    let mut seen_names = Vec::with_capacity(indexes.len());
    for index in indexes {
        if seen_names.contains(&index.name()) {
            return Err(ValidateError::DuplicateIndexName {
                name: index.name().to_string(),
            });
        }
        seen_names.push(index.name());

        let mut seen = Vec::new();
        match index.key_items() {
            IndexKeyItemsRef::Fields(fields_ref) => {
                for field in fields_ref {
                    validate_index_field_reference(fields, index, field, &mut seen)?;
                }
            }
            IndexKeyItemsRef::Items(items) => {
                for &item in items {
                    match item {
                        IndexKeyItem::Field(field) => {
                            validate_index_field_reference(fields, index, field, &mut seen)?;
                        }
                        IndexKeyItem::Expression(expression) => {
                            validate_index_expression_reference(fields, index, expression)?;
                        }
                    }
                }
            }
        }
    }

    Ok(())
}

fn validate_index_predicates(
    schema: &SchemaInfo,
    indexes: &[&IndexModel],
) -> Result<(), ValidateError> {
    for index in indexes {
        let Some(predicate_sql) = index.predicate() else {
            continue;
        };

        let predicate = canonical_index_predicate(index)
            .map_err(|_| ValidateError::invalid_index_predicate_syntax(**index, predicate_sql))?;
        let predicate = predicate.expect("index predicate metadata was checked above");
        validate(schema, predicate)
            .map_err(|_| ValidateError::invalid_index_predicate_schema(**index, predicate_sql))?;
    }

    Ok(())
}

///
/// SchemaInfo
///
/// Lightweight, runtime-usable field-type map for one entity.
/// This is the *only* schema surface the predicate validator depends on.
///

///
/// SchemaFieldInfo
///
/// Compact per-field schema entry used by `SchemaInfo`.
/// Keeps reduced predicate type metadata and the full field-kind authority in
/// one table so schema construction does not duplicate field-name maps.
///

#[derive(Clone, Debug)]
struct SchemaFieldInfo {
    ty: FieldType,
    kind: FieldKind,
}

#[derive(Clone, Debug)]
pub(crate) struct SchemaInfo {
    fields: Vec<SchemaFieldEntry>,
}

impl SchemaInfo {
    #[must_use]
    pub(crate) fn field(&self, name: &str) -> Option<&FieldType> {
        schema_field_info(self.fields.as_slice(), name).map(|field| &field.ty)
    }

    #[must_use]
    pub(crate) fn field_kind(&self, name: &str) -> Option<&FieldKind> {
        schema_field_info(self.fields.as_slice(), name).map(|field| &field.kind)
    }

    /// Builds runtime predicate schema information from an entity model.
    pub(crate) fn from_entity_model(model: &EntityModel) -> Result<Self, ValidateError> {
        // Phase 1: validate identity constraints before building schema tables.
        let entity_name = EntityName::try_from_str(model.entity_name).map_err(|err| {
            ValidateError::InvalidEntityName {
                name: model.entity_name.to_string(),
                source: err,
            }
        })?;

        if !model
            .fields
            .iter()
            .any(|field| std::ptr::eq(field, model.primary_key))
        {
            return Err(ValidateError::InvalidPrimaryKey {
                field: model.primary_key.name.to_string(),
            });
        }

        // Phase 2: build one compact field table sorted by field name so
        // downstream lookups can stay deterministic without tree maps.
        let mut fields = Vec::with_capacity(model.fields.len());
        for field in model.fields {
            let info = SchemaFieldInfo {
                ty: field_type_from_model_kind(&field.kind),
                kind: field.kind,
            };

            match fields.binary_search_by_key(&field.name, |(name, _)| *name) {
                Ok(_) => {
                    return Err(ValidateError::DuplicateField {
                        field: field.name.to_string(),
                    });
                }
                Err(index) => fields.insert(index, (field.name, info)),
            }
        }

        // Phase 3: verify primary-key and index contracts against the compact table.
        let pk_field_type = &schema_field_info(fields.as_slice(), model.primary_key.name)
            .expect("primary key verified above")
            .ty;
        if !pk_field_type.is_keyable() {
            return Err(ValidateError::InvalidPrimaryKeyType {
                field: model.primary_key.name.to_string(),
            });
        }

        validate_index_fields(&fields, model.indexes)?;
        for index in model.indexes {
            IndexName::try_from_parts(&entity_name, index.fields()).map_err(|err| {
                ValidateError::InvalidIndexName {
                    index: **index,
                    source: err,
                }
            })?;
        }

        // Phase 4: validate predicate-bearing index metadata against the same
        // schema surface reused by planners and executors.
        let schema = Self { fields };
        validate_index_predicates(&schema, model.indexes)?;

        Ok(schema)
    }
}