teaql_core/

lib.rs

extern crate self as teaql_core;

mod entity;
mod entity_graph;
mod expr;
mod list;
mod meta;
mod mutation;
mod naming;
mod query;
pub mod request;
mod safe_expression;
pub mod serde_utils;
pub mod time;
mod trace;
mod value;
mod web;
mod xls;

pub use entity::{
    Audited, BaseEntity, BaseEntityData, Entity, EntityDescriptorStore, EntityError,
    IdentifiableEntity, TeaqlBoxedRelations, TeaqlEntity, VersionedEntity,
};
pub use entity_graph::{EntityGraph, EntityGraphBuilder, EntityGraphNode, EntityGraphOperation};
pub use expr::{BinaryOp, Expr, ExprFunction};
pub use list::SmartList;
pub use meta::{EntityDescriptor, PropertyDescriptor, RelationDescriptor};
pub use mutation::{
    BatchInsertCommand, BatchUpdateCommand, DeleteCommand, EntitySnapshot, GeneratedValues,
    InsertCommand, MutationKind, MutationValues, RecoverCommand, UpdateCommand,
};
pub use naming::default_table_name;
pub use query::{
    Aggregate, AggregateFunction, AggregationCacheOptions, CompactRow, ContinuousPageFetchOptions,
    IdSetPaginationOptions, NamedExpr, ObjectGroupBy, OrderBy, PARTITION_RANK_PROPERTY,
    RawSqlProjection, Record, RelationAggregate, RelationLoad, SelectQuery, Slice, SortDirection,
    StreamConfig, compact_row_to_json_value, record_to_json_value,
};
pub use safe_expression::{SafeExpression, TeaqlEmpty};
pub use trace::{TraceKind, TraceNode};
pub use value::{DataType, Decimal, Value};
pub use web::{ACTION_LIST_KEY, STYLE_KEY, WEB_RESPONSE_VERSION, WebAction, WebResponse, WebStyle};
pub use xls::{XlsBlock, XlsBlockBuildContext, XlsPage, XlsWorkbook};

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use super::*;
    use chrono::{NaiveDate, TimeZone, Utc};
    use teaql_macros::TeaqlEntity;

    #[derive(Default)]
    struct TestStore {
        descriptors: Vec<EntityDescriptor>,
    }

    impl EntityDescriptorStore for TestStore {
        fn register_descriptor(&mut self, descriptor: EntityDescriptor) {
            self.descriptors.push(descriptor);
        }
    }

    #[allow(dead_code)]
    #[derive(Clone, TeaqlEntity)]
    #[teaql(entity = "Order", table = "orders")]
    struct OrderRow {
        #[teaql(id)]
        id: u64,
        #[teaql(version)]
        version: i64,
        #[teaql(column = "display_name")]
        name: String,
    }

    #[allow(dead_code)]
    #[derive(Debug, TeaqlEntity)]
    #[teaql(entity = "TypedNumber", table = "typed_number")]
    struct TypedNumberRow {
        #[teaql(id)]
        id: u64,
        signed: i32,
        unsigned: u32,
        amount: Decimal,
    }

    #[test]
    fn derive_entity_descriptor() {
        let descriptor = OrderRow::entity_descriptor();
        assert_eq!(descriptor.name, "Order");
        assert_eq!(descriptor.table_name, "orders");
        assert_eq!(
            descriptor.id_property().map(|p| p.name.as_str()),
            Some("id")
        );
        assert_eq!(
            descriptor
                .property_by_name("name")
                .map(|p| p.column_name.as_str()),
            Some("display_name")
        );
    }

    #[test]
    fn derive_maps_checked_integer_and_decimal_fields() {
        let descriptor = TypedNumberRow::entity_descriptor();
        assert_eq!(
            descriptor.property_by_name("amount").map(|p| p.data_type),
            Some(DataType::Decimal)
        );

        let row = TypedNumberRow::from_compact_row(CompactRow::from_map(Record::from([
            ("id".to_owned(), Value::I64(7)),
            ("signed".to_owned(), Value::I64(2_147_483_647)),
            ("unsigned".to_owned(), Value::U64(4_294_967_295)),
            ("amount".to_owned(), Value::Decimal(Decimal::new(12345, 2))),
        ])))
        .unwrap();
        assert_eq!(row.id, 7);
        assert_eq!(row.signed, i32::MAX);
        assert_eq!(row.unsigned, u32::MAX);
        assert_eq!(row.amount, Decimal::new(12345, 2));

        let signed_overflow =
            TypedNumberRow::from_compact_row(CompactRow::from_map(Record::from([
                ("id".to_owned(), Value::U64(1)),
                ("signed".to_owned(), Value::I64(i64::from(i32::MAX) + 1)),
                ("unsigned".to_owned(), Value::U64(1)),
                ("amount".to_owned(), Value::Decimal(Decimal::ONE)),
            ])));
        assert!(
            signed_overflow
                .unwrap_err()
                .message
                .contains("out of i32 range")
        );

        let unsigned_negative =
            TypedNumberRow::from_compact_row(CompactRow::from_map(Record::from([
                ("id".to_owned(), Value::U64(1)),
                ("signed".to_owned(), Value::I64(1)),
                ("unsigned".to_owned(), Value::I64(-1)),
                ("amount".to_owned(), Value::Decimal(Decimal::ONE)),
            ])));
        assert!(
            unsigned_negative
                .unwrap_err()
                .message
                .contains("out of u32 range")
        );
    }

    #[test]
    fn derive_allows_partial_projected_records() {
        let row = OrderRow::from_compact_row(CompactRow::from_map(Record::from([(
            "name".to_owned(),
            Value::Text("projected".to_owned()),
        )])))
        .unwrap();
        assert_eq!(row.id, 0);
        assert_eq!(row.version, 0);
        assert_eq!(row.name, "projected");

        let nulls = OrderRow::from_compact_row(CompactRow::from_map(Record::from([
            ("id".to_owned(), Value::Null),
            ("version".to_owned(), Value::Null),
            ("name".to_owned(), Value::Null),
        ])))
        .unwrap();
        assert_eq!(nulls.id, 0);
        assert_eq!(nulls.version, 0);
        assert_eq!(nulls.name, "");

        match OrderRow::from_compact_row(CompactRow::from_map(Record::from([(
            "name".to_owned(),
            Value::U64(1),
        )]))) {
            Ok(_) => panic!("wrong field type should fail"),
            Err(err) => assert!(err.message.contains("invalid field name")),
        }
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    #[teaql(entity = "Product", table = "product")]
    struct ProductRow {
        #[teaql(id)]
        id: u64,
        name: String,
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    #[teaql(entity = "OrderLine", table = "orderline")]
    struct OrderLineRow {
        #[teaql(id)]
        id: u64,
        #[teaql(column = "order_id")]
        order_id: u64,
        #[teaql(relation(
            target = "Product",
            local_key = "product_id",
            foreign_key = "id",
            attach = false,
            delete_missing = false
        ))]
        product: Option<ProductRow>,
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    #[teaql(entity = "BoxedOrderLine", table = "boxed_orderline")]
    struct BoxedOrderLineRow {
        #[teaql(id)]
        id: u64,
        #[teaql(relation(target = "Product", local_key = "product_id", foreign_key = "id"))]
        product: Option<Box<ProductRow>>,
    }

    #[test]
    fn derive_relation_descriptor_and_register() {
        let descriptor = OrderLineRow::entity_descriptor();
        let relation = descriptor.relation_by_name("product").unwrap();
        assert_eq!(relation.target_entity, "Product");
        assert_eq!(relation.local_key, "product_id");
        assert_eq!(relation.foreign_key, "id");
        assert!(!relation.attach);
        assert!(!relation.delete_missing);

        let mut store = TestStore::default();
        OrderLineRow::register_into(&mut store);
        assert_eq!(store.descriptors.len(), 1);
        assert_eq!(store.descriptors[0].name, "OrderLine");
    }

    #[test]
    fn derive_decodes_boxed_forward_relation_without_changing_relation_semantics() {
        let product = Record::from([
            ("id".to_owned(), Value::U64(7)),
            ("name".to_owned(), Value::Text("boxed".to_owned())),
        ]);
        let row = BoxedOrderLineRow::from_compact_row(CompactRow::from_map(Record::from([
            ("id".to_owned(), Value::U64(1)),
            ("product".to_owned(), Value::object(product)),
        ])))
        .unwrap();
        assert_eq!(row.product.as_deref().map(|product| product.id), Some(7));

        let values = row.into_values();
        let Value::Object(product) = values.get("product").unwrap() else {
            panic!("boxed relation must retain object serialization");
        };
        assert_eq!(product.get("id").and_then(Value::try_u64), Some(7));
    }

    #[test]
    fn register_entities_macro_registers_multiple_descriptors() {
        let mut store = TestStore::default();
        crate::register_entities!(&mut store, OrderRow, OrderLineRow);

        assert_eq!(store.descriptors.len(), 2);
        assert_eq!(store.descriptors[0].name, "Order");
        assert_eq!(store.descriptors[1].name, "OrderLine");
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    struct DefaultTableNameRow {
        #[teaql(id)]
        id: u64,
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    struct TypedValueRow {
        #[teaql(id)]
        id: u64,
        payload: serde_json::Value,
        birthday: NaiveDate,
        happened_at: crate::time::Timestamp,
    }

    #[allow(dead_code)]
    #[derive(TeaqlEntity)]
    #[teaql(entity = "OrderAggregate", table = "order_aggregate")]
    struct OrderAggregateRow {
        #[teaql(id)]
        id: u64,
        #[teaql(dynamic)]
        dynamic: BTreeMap<String, Value>,
    }

    #[test]
    fn default_table_name_matches_java_sql_repository_rule() {
        assert_eq!(default_table_name("Order"), "order_data");
        assert_eq!(default_table_name("OrderLine"), "order_line_data");
        assert_eq!(EntityDescriptor::new("Order").table_name, "order_data");
        assert_eq!(
            EntityDescriptor::new("OrderLine").table_name,
            "order_line_data"
        );
        assert_eq!(
            DefaultTableNameRow::entity_descriptor().table_name,
            "default_table_name_row_data"
        );
    }

    #[test]
    fn derive_maps_json_date_and_timestamp_types() {
        let descriptor = TypedValueRow::entity_descriptor();
        assert_eq!(
            descriptor.property_by_name("payload").map(|p| p.data_type),
            Some(DataType::Json)
        );
        assert_eq!(
            descriptor.property_by_name("birthday").map(|p| p.data_type),
            Some(DataType::Date)
        );
        assert_eq!(
            descriptor
                .property_by_name("happened_at")
                .map(|p| p.data_type),
            Some(DataType::Timestamp)
        );

        let birthday = NaiveDate::from_ymd_opt(2024, 2, 3).unwrap();
        let happened_at = Utc.with_ymd_and_hms(2024, 2, 3, 4, 5, 6).unwrap();
        assert_eq!(
            Value::from(serde_json::json!({"a": 1})),
            Value::Json(serde_json::json!({"a": 1}))
        );
        assert_eq!(Value::from(birthday), Value::Date(birthday));
        assert_eq!(
            Value::from(happened_at),
            Value::Timestamp(crate::time::Timestamp(happened_at.timestamp_millis()))
        );
    }

    #[test]
    fn query_builders_cover_filters_sort_aggregates_and_relations() {
        let query = SelectQuery::new("Order")
            .projects(["id", "name"])
            .filter(Expr::gte("version", 1_i64))
            .and_filter(Expr::not_in_list(
                "name",
                vec![Value::from("archived"), Value::from("deleted")],
            ))
            .and_filter(Expr::in_large(
                "id",
                vec![Value::from(1_u64), Value::from(2_u64)],
            ))
            .and_filter(Expr::contain("name", "rob"))
            .and_filter(Expr::sound_like("name", "Robert"))
            .and_filter(Expr::compare_columns(
                "updated_at",
                BinaryOp::Gte,
                "created_at",
            ))
            .or_filter(Expr::is_null("name"))
            .project_expr("nameSound", Expr::soundex(Expr::column("name")))
            .order_desc("id")
            .order_gbk_asc("name")
            .group_by("name")
            .count("total")
            .sum("version", "versionSum")
            .stddev("version", "versionStddev")
            .enable_aggregation_cache_for(1_000)
            .propagate_aggregation_cache(2_000)
            .having(Expr::gt("total", 1_i64))
            .relation("lines")
            .relation_query(
                "customer",
                SelectQuery::new("Customer")
                    .project("name")
                    .filter(Expr::eq("status", "active")),
            )
            .page(20, 10);

        assert_eq!(query.projection, vec!["id", "name"]);
        assert_eq!(
            query.expr_projection,
            vec![NamedExpr::new(
                "nameSound",
                Expr::soundex(Expr::column("name"))
            )]
        );
        assert_eq!(
            query.order_by,
            vec![OrderBy::desc("id"), OrderBy::asc_gbk("name")]
        );
        assert_eq!(query.group_by, vec!["name"]);
        assert_eq!(
            query.aggregates,
            vec![
                Aggregate::count("total"),
                Aggregate::sum("version", "versionSum"),
                Aggregate::stddev("version", "versionStddev")
            ]
        );
        assert_eq!(
            query.aggregation_cache,
            Some(AggregationCacheOptions {
                enabled: true,
                cache_expired_millis: 1_000,
                propagate: true,
                propagate_cache_expired_millis: 2_000,
            })
        );
        assert_eq!(query.having, Some(Expr::gt("total", 1_i64)));
        assert_eq!(
            query.relations,
            vec![
                RelationLoad::new("lines"),
                RelationLoad::with_query(
                    "customer",
                    SelectQuery::new("Customer")
                        .project("name")
                        .filter(Expr::eq("status", "active")),
                )
            ]
        );
        assert_eq!(
            query.slice,
            Some(Slice {
                limit: Some(10),
                offset: 20
            })
        );
        assert!(matches!(query.filter, Some(Expr::Or(_))));
    }

    #[test]
    fn compare_columns_builds_property_to_property_filter() {
        assert_eq!(
            Expr::compare_columns("updated_at", BinaryOp::Gte, "created_at"),
            Expr::Binary {
                left: Box::new(Expr::Column("updated_at".to_owned())),
                op: BinaryOp::Gte,
                right: Box::new(Expr::Column("created_at".to_owned())),
            }
        );
    }

    #[test]
    fn sound_like_builds_soundex_equality() {
        assert_eq!(
            Expr::sound_like("name", "Robert"),
            Expr::binary(
                Expr::soundex(Expr::column("name")),
                BinaryOp::Eq,
                Expr::soundex(Expr::value("Robert"))
            )
        );
    }

    #[test]
    fn java_style_string_match_builders_expand_like_patterns() {
        assert_eq!(Expr::contain("name", "tea"), Expr::like("name", "%tea%"));
        assert_eq!(
            Expr::not_contain("name", "tea"),
            Expr::not_like("name", "%tea%")
        );
        assert_eq!(Expr::begin_with("name", "tea"), Expr::like("name", "tea%"));
        assert_eq!(
            Expr::not_begin_with("name", "tea"),
            Expr::not_like("name", "tea%")
        );
        assert_eq!(Expr::end_with("name", "tea"), Expr::like("name", "%tea"));
        assert_eq!(
            Expr::not_end_with("name", "tea"),
            Expr::not_like("name", "%tea")
        );
    }

    #[test]
    fn large_in_builders_use_large_binary_ops() {
        assert_eq!(
            Expr::in_large("id", vec![Value::from(1_u64)]),
            Expr::binary(
                Expr::column("id"),
                BinaryOp::InLarge,
                Expr::value(Value::List(vec![Value::from(1_u64)]))
            )
        );
        assert_eq!(
            Expr::not_in_large("id", vec![Value::from(1_u64)]),
            Expr::binary(
                Expr::column("id"),
                BinaryOp::NotInLarge,
                Expr::value(Value::List(vec![Value::from(1_u64)]))
            )
        );
    }

    #[test]
    fn ordinary_in_builders_promote_more_than_twenty_values() {
        let twenty = (1_u64..=20).map(Value::from).collect::<Vec<_>>();
        let twenty_one = (1_u64..=21).map(Value::from).collect::<Vec<_>>();

        let Expr::Binary { op, .. } = Expr::in_list("id", twenty.clone()) else {
            panic!("expected IN expression");
        };
        assert_eq!(op, BinaryOp::In);

        let Expr::Binary { op, .. } = Expr::in_list("id", twenty_one.clone()) else {
            panic!("expected large IN expression");
        };
        assert_eq!(op, BinaryOp::InLarge);

        let Expr::Binary { op, .. } = Expr::not_in_list("id", twenty) else {
            panic!("expected NOT IN expression");
        };
        assert_eq!(op, BinaryOp::NotIn);

        let Expr::Binary { op, .. } = Expr::not_in_list("id", twenty_one) else {
            panic!("expected large NOT IN expression");
        };
        assert_eq!(op, BinaryOp::NotInLarge);
    }

    #[test]
    fn subquery_builder_projects_requested_field() {
        let query = SelectQuery::new("OrderLine").filter(Expr::eq("name", "line-1"));
        let expr = Expr::in_subquery("id", OrderLineRow::entity_descriptor(), query, "order_id");

        let Expr::SubQuery {
            left,
            op,
            entity,
            query,
        } = expr
        else {
            panic!("expected subquery expression");
        };
        assert_eq!(*left, Expr::column("id"));
        assert_eq!(op, BinaryOp::In);
        assert_eq!(entity.name, "OrderLine");
        assert_eq!(query.projection, vec!["order_id"]);
    }

    #[test]
    fn smart_list_supports_entity_ids_versions_and_records() {
        let rows = SmartList::from(vec![
            OrderRow {
                id: 1,
                version: 2,
                name: String::from("a"),
            },
            OrderRow {
                id: 3,
                version: 4,
                name: String::from("b"),
            },
        ]);

        assert_eq!(rows.ids(), vec![Value::U64(1), Value::U64(3)]);
        assert_eq!(rows.versions(), vec![2, 4]);

        let records = rows.into_values();
        assert_eq!(records.len(), 2);
        assert_eq!(records.data[0].get("id"), Some(&Value::U64(1)));
        assert_eq!(records.data[1].get("version"), Some(&Value::I64(4)));
    }

    #[test]
    fn smart_list_supports_java_style_collection_helpers() {
        let mut rows = SmartList::empty()
            .with_total_count(10)
            .with_aggregation("count", 2_u64)
            .with_summary("label", "orders");
        rows.push(OrderRow {
            id: 1,
            version: 2,
            name: String::from("a"),
        });
        rows.extend(vec![OrderRow {
            id: 3,
            version: 4,
            name: String::from("b"),
        }]);

        assert_eq!(rows.total_count_or_len(), 10);
        assert_eq!(rows.get(1).map(|row| row.name.as_str()), Some("b"));
        assert_eq!(rows.last().map(|row| row.id), Some(3));
        assert_eq!(rows.aggregation("count"), Some(&Value::U64(2)));
        assert_eq!(
            rows.summary("label"),
            Some(&Value::Text(String::from("orders")))
        );
        assert_eq!(rows.aggregation_json(), serde_json::json!({"count": 2}));
        assert_eq!(rows.summary_json(), serde_json::json!({"label": "orders"}));

        let names = rows.to_list(|row| row.name.clone());
        assert_eq!(names, vec![String::from("a"), String::from("b")]);
        let ids = rows.to_set(|row| row.id);
        assert_eq!(ids.into_iter().collect::<Vec<_>>(), vec![1, 3]);

        let by_id = rows.map_by_id();
        assert_eq!(by_id.get("u:1").map(|row| row.name.as_str()), Some("a"));
        assert_eq!(by_id.get("u:3").map(|row| row.name.as_str()), Some("b"));

        let identity = rows.identity_map(|row| row.name.clone());
        assert_eq!(identity.get("a").map(|row| row.id), Some(1));
        let grouped = rows.group_by(|row| row.version % 2);
        assert_eq!(grouped.get(&0).map(Vec::len), Some(2));

        rows.merge_by(
            vec![
                OrderRow {
                    id: 3,
                    version: 5,
                    name: String::from("b2"),
                },
                OrderRow {
                    id: 4,
                    version: 1,
                    name: String::from("c"),
                },
            ],
            |row| row.id,
        );
        assert_eq!(rows.len(), 3);
        assert_eq!(rows.map_by_id().get("u:3").map(|row| row.version), Some(5));

        rows.retain(|row| row.id != 1);
        assert_eq!(rows.ids(), vec![Value::U64(3), Value::U64(4)]);
        assert_eq!((&rows).into_iter().count(), 2);
        assert_eq!(rows[0].name, "b2");
    }

    #[derive(Clone)]
    struct SafeExpressionEntity {
        base: BaseEntityData,
        name: String,
        lines: SmartList<OrderRow>,
    }

    impl TeaqlEntity for SafeExpressionEntity {
        const ENTITY_NAME: &'static str = "SafeExpressionEntity";

        fn entity_descriptor() -> EntityDescriptor {
            EntityDescriptor::new("SafeExpressionEntity")
        }
    }

    impl Entity for SafeExpressionEntity {
        fn from_compact_row(_row: CompactRow) -> Result<Self, EntityError> {
            unimplemented!("test helper does not need record mapping")
        }

        fn into_values(self) -> MutationValues {
            MutationValues::new()
        }
    }

    impl BaseEntity for SafeExpressionEntity {
        fn base(&self) -> &BaseEntityData {
            &self.base
        }

        fn base_mut(&mut self) -> &mut BaseEntityData {
            &mut self.base
        }
    }

    #[test]
    fn safe_expression_supports_null_safe_chaining_and_defaults() {
        let entity = SafeExpressionEntity {
            base: BaseEntityData::new().with_id(7).with_version(3),
            name: "demo".to_owned(),
            lines: SmartList::from(vec![OrderRow {
                id: 11,
                version: 1,
                name: "line".to_owned(),
            }]),
        };

        let expr = SafeExpression::value(entity);
        assert_eq!(expr.clone().entity_id().eval(), Some(7));
        assert_eq!(expr.clone().entity_version().eval(), Some(3));
        assert_eq!(
            expr.clone()
                .apply(|entity| entity.name)
                .or_else("x".to_owned()),
            "demo"
        );
        assert_eq!(
            expr.clone()
                .apply(|entity| entity.lines)
                .first()
                .apply(|line| line.id)
                .eval(),
            Some(11)
        );
        assert!(
            expr.clone()
                .apply(|entity| entity.lines)
                .get(4)
                .apply(|line| line.id)
                .is_null()
        );
        assert_eq!(
            expr.clone().apply(|entity| entity.lines).size().or_else(0),
            1
        );
    }

    #[test]
    fn safe_expression_exposes_java_style_empty_and_callbacks() {
        let empty = SafeExpression::value(String::new());
        assert!(empty.is_empty());
        assert_eq!(empty.or_else("fallback".to_owned()), String::new());

        let missing = SafeExpression::new((), |_| None::<String>);
        assert!(missing.is_null());
        assert_eq!(missing.or_else("fallback".to_owned()), "fallback");

        let mut saw_null = false;
        missing.when_is_null(|| {
            saw_null = true;
        });
        assert!(saw_null);

        let value = SafeExpression::value("teaql".to_owned());
        let mut captured = String::new();
        value.when_not_empty(|text| {
            captured = text;
        });
        assert_eq!(captured, "teaql");
    }

    #[test]
    fn web_style_and_action_bind_frontend_metadata() {
        let mut base = BaseEntityData::new();
        WebStyle::with_background_color("#ffeecc")
            .font_color("#111111")
            .bind_base(&mut base);
        WebAction::view_web_action().bind_base(&mut base);
        WebAction::modify_web_action("EDIT", "/orders/1/edit").bind_base(&mut base);

        assert_eq!(
            base.dynamic(STYLE_KEY)
                .map(Value::to_json_value)
                .and_then(|value| value.get("backgroundColor").cloned()),
            Some(serde_json::json!("#ffeecc"))
        );
        assert_eq!(
            base.dynamic(STYLE_KEY)
                .map(Value::to_json_value)
                .and_then(|value| value.get("color").cloned()),
            Some(serde_json::json!("#111111"))
        );

        let actions_value = base
            .dynamic(ACTION_LIST_KEY)
            .map(Value::to_json_value)
            .unwrap();
        let actions = actions_value.as_array().unwrap();
        assert_eq!(actions.len(), 2);
        assert_eq!(actions[0]["execute"], serde_json::json!("switchview"));
        assert_eq!(actions[0]["target"], serde_json::json!("detail"));
        assert_eq!(actions[1]["name"], serde_json::json!("EDIT"));
        assert_eq!(
            actions[1]["requestURL"],
            serde_json::json!("/orders/1/edit")
        );
    }

    #[test]
    fn web_response_wraps_entity_and_list_payloads() {
        let entity = OrderRow {
            id: 7,
            version: 2,
            name: "order".to_owned(),
        };
        let response = WebResponse::from_entity(&entity);
        assert_eq!(response.result_code, 0);
        assert_eq!(response.status.as_deref(), Some("YES"));
        assert_eq!(response.record_count, 1);
        assert_eq!(response.version, WEB_RESPONSE_VERSION);
        assert_eq!(response.data[0]["id"], serde_json::json!(7));

        let list = SmartList::from(vec![entity]).with_total_count(99);
        let response = WebResponse::from_smart_list(list);
        assert_eq!(response.record_count, 99);
        assert_eq!(response.data.len(), 1);

        let failed = WebResponse::fail("bad request").to_json_value();
        assert_eq!(failed["status"], serde_json::json!("NO"));
        assert_eq!(failed["message"], serde_json::json!("bad request"));
        assert_eq!(failed["version"], serde_json::json!("1.001"));
    }

    #[test]
    fn web_response_includes_facets() {
        let entity = OrderRow {
            id: 7,
            version: 2,
            name: "order".to_owned(),
        };
        let mut facet_record = Record::new();
        facet_record.insert("status".to_owned(), Value::Text("PENDING".to_owned()));
        facet_record.insert("count".to_owned(), Value::I64(5));

        let facet_list = SmartList::from(vec![CompactRow::from_map(facet_record)]);

        let mut list = SmartList::from(vec![entity])
            .with_total_count(99)
            .with_facet("status", facet_list);

        // Verify getter/mutator APIs on SmartList
        assert!(list.facets().contains_key("status"));
        assert_eq!(list.facet("status").unwrap().len(), 1);
        assert!(list.facet_mut("status").is_some());
        assert!(list.facets_mut().contains_key("status"));

        let response = WebResponse::from_smart_list(list);
        assert_eq!(response.record_count, 99);
        assert_eq!(response.data.len(), 1);

        let json = response.to_json_value();
        assert!(json.get("facets").is_some());
        let facets_map = json["facets"].as_object().unwrap();
        assert!(facets_map.contains_key("status"));
        let status_facet = facets_map["status"].as_array().unwrap();
        assert_eq!(status_facet.len(), 1);
        assert_eq!(status_facet[0]["status"], serde_json::json!("PENDING"));
        assert_eq!(status_facet[0]["count"], serde_json::json!(5));

        // Test removing and taking facets
        let mut list2 = SmartList::new(vec![OrderRow {
            id: 8,
            version: 1,
            name: "other".to_owned(),
        }])
        .with_facet("status", SmartList::empty());

        let removed = list2.remove_facet("status");
        assert!(removed.is_some());
        assert!(list2.facet("status").is_none());

        list2.add_facet("status", SmartList::empty());
        let taken = list2.take_facets();
        assert!(taken.contains_key("status"));
        assert!(list2.facets().is_empty());
    }

    #[test]
    fn xls_block_context_matches_java_navigation_model() {
        let context = XlsBlockBuildContext::new("orders", 2, 3);
        let header = context
            .to_block("Order No")
            .add_property("bold", true)
            .span(2, 1);
        let next = context.next().to_block("Amount");
        let next_line = context.next_line().to_block("SO-1");
        let new_line = context.new_line().to_block("reset-left");

        assert_eq!(header.page, "orders");
        assert_eq!(
            (header.left, header.top, header.right, header.bottom),
            (2, 3, 3, 3)
        );
        assert_eq!(header.width(), 2);
        assert_eq!(header.height(), 1);
        assert!(header.contains(3, 3));
        assert!(!header.contains(4, 3));
        assert_eq!((next.left, next.top), (3, 3));
        assert_eq!((next_line.left, next_line.top), (2, 4));
        assert_eq!((new_line.left, new_line.top), (0, 4));
        assert_eq!(
            header.properties.get("bold"),
            Some(&serde_json::json!(true))
        );
    }

    #[test]
    fn xls_workbook_groups_pages_and_blocks_as_json_payload() {
        let style = XlsBlock::new("orders", 0, 0, serde_json::Value::Null)
            .add_property("backgroundColor", "#ffeecc");
        let title = XlsBlock::new("orders", 0, 0, "Orders")
            .style(style)
            .span(3, 1);
        let page = XlsPage::new("orders").add_block(title);
        let workbook = XlsWorkbook::new().add_page(page);

        assert!(workbook.page("orders").is_some());
        assert_eq!(
            workbook
                .page("orders")
                .and_then(|page| page.block_at(1, 0))
                .map(|block| block.value.clone()),
            Some(serde_json::json!("Orders"))
        );

        let json = workbook.to_json_value();
        assert_eq!(json["pages"][0]["name"], serde_json::json!("orders"));
        assert_eq!(json["pages"][0]["blocks"][0]["right"], serde_json::json!(2));
        assert_eq!(
            json["pages"][0]["blocks"][0]["styleReferBlock"]["properties"]["backgroundColor"],
            serde_json::json!("#ffeecc")
        );
    }

    #[test]
    fn dynamic_properties_roundtrip_into_json() {
        let aggregate = OrderAggregateRow::from_compact_row(CompactRow::from_map(Record::from([
            (String::from("id"), Value::U64(7)),
            (String::from("lineCount"), Value::I64(3)),
            (String::from("amount"), Value::F64(18.5)),
            (
                String::from("detail"),
                Value::Object(Record::from([(String::from("status"), Value::from("ok"))])),
            ),
        ])))
        .unwrap();

        assert_eq!(aggregate.dynamic.get("lineCount"), Some(&Value::I64(3)));
        assert_eq!(aggregate.dynamic.get("amount"), Some(&Value::F64(18.5)));
        assert_eq!(
            aggregate.dynamic.get("detail"),
            Some(&Value::Object(Record::from([(
                String::from("status"),
                Value::Text(String::from("ok")),
            )])))
        );

        let json = aggregate.into_json();
        assert_eq!(json["id"], serde_json::json!(7));
        assert_eq!(json["lineCount"], serde_json::json!(3));
        assert_eq!(json["amount"], serde_json::json!(18.5));
        assert_eq!(json["detail"], serde_json::json!({"status": "ok"}));
    }

    #[test]
    fn base_entity_data_roundtrips_record_and_dynamic_properties() {
        let mut base = BaseEntityData::new()
            .with_id(11)
            .with_version(3)
            .with_dynamic("lineCount", 5)
            .with_dynamic("detail", serde_json::json!({"status": "ok"}));
        assert_eq!(base.dynamic("lineCount"), Some(&Value::I64(5)));
        assert_eq!(base.dynamic_i64("lineCount"), Some(5));
        base.put_dynamic("amount", 18.5);
        assert_eq!(base.dynamic_f64("amount"), Some(18.5));

        let record = base.to_values_map();
        assert_eq!(record.get("id"), Some(&Value::U64(11)));
        assert_eq!(record.get("version"), Some(&Value::I64(3)));
        assert_eq!(record.get("lineCount"), Some(&Value::I64(5)));
        assert_eq!(
            record.get("detail"),
            Some(&Value::Json(serde_json::json!({"status": "ok"})))
        );

        let restored = BaseEntityData::from_values_map(&record).unwrap();
        assert_eq!(restored.id, 11);
        assert_eq!(restored.version, 3);
        assert_eq!(restored.dynamic("amount"), Some(&Value::F64(18.5)));
        assert_eq!(restored.dynamic_f64("amount"), Some(18.5));
    }
}
pub mod eval;