vantage-vista 0.5.5

use ciborium::Value as CborValue;
use vantage_core::{Result, error};
use vantage_types::Record;

use crate::{
    capabilities::VistaCapabilities,
    column::Column,
    flags,
    reference::{Reference, ReferenceKind},
    sort::SortDirection,
    source::TableShell,
};

/// Universal, schema-bearing data handle.
///
/// A `Vista` is produced by a driver factory from a typed `Table<T, E>` or
/// from a YAML schema. The schema (columns, references, id column) lives
/// on the wrapped [`TableShell`] — `Vista` is the user-facing surface that
/// forwards both data and metadata queries to the shell.
///
/// A `Vista` is strictly **single-persistence**: every reference it exposes
/// targets the same backend. Cross-persistence traversal is the job of
/// `vantage-vista-factory`'s `VistaCatalog`, one layer up.
pub struct Vista {
    pub(crate) name: String,
    pub(crate) capabilities: VistaCapabilities,
    pub source: Box<dyn TableShell>,
}

impl Vista {
    pub fn new(name: impl Into<String>, source: Box<dyn TableShell>) -> Self {
        let capabilities = source.capabilities().clone();
        Self {
            name: name.into(),
            capabilities,
            source,
        }
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    /// Override the vista's display name. Used by spec-driven construction
    /// to expose `spec.name` rather than the underlying file/table name.
    pub fn set_name(&mut self, name: impl Into<String>) {
        self.name = name.into();
    }

    pub fn capabilities(&self) -> &VistaCapabilities {
        &self.capabilities
    }

    /// Short human label for the underlying driver (e.g. `"csv"`, `"sqlite"`,
    /// `"postgres"`, `"mongodb"`).
    pub fn driver(&self) -> &'static str {
        self.source.driver_name()
    }

    // ---- metadata accessors -----------------------------------------------
    //
    // All schema accessors forward to the shell. Vista holds none of the
    // schema state itself; the shell is the source of truth.

    pub fn get_id_column(&self) -> Option<&str> {
        self.source.id_column()
    }

    /// Columns flagged `title` (in declaration order).
    pub fn get_title_columns(&self) -> Vec<&str> {
        self.source
            .columns()
            .values()
            .filter(|c| c.is_title())
            .map(|c| c.name.as_str())
            .collect()
    }

    pub fn get_column_names(&self) -> Vec<&str> {
        self.source.columns().keys().map(String::as_str).collect()
    }

    pub fn get_column(&self, name: &str) -> Option<&Column> {
        self.source.columns().get(name)
    }

    /// Names of references the Vista exposes (shell-declared, same-persistence).
    /// For the *complete* picture with cardinality, use
    /// [`list_references`](Self::list_references) instead.
    pub fn get_references(&self) -> Vec<String> {
        self.list_references().into_iter().map(|(n, _)| n).collect()
    }

    /// All references the Vista exposes, with their cardinality.
    ///
    /// These are the same-persistence references declared by the wrapped shell
    /// (typically derived from the typed `Table`'s `with_many` / `with_one`
    /// registrations via [`TableShell::get_ref_kinds`]).
    pub fn list_references(&self) -> Vec<(String, ReferenceKind)> {
        self.source.get_ref_kinds()
    }

    pub fn get_reference(&self, name: &str) -> Option<&Reference> {
        self.source.references().get(name)
    }

    // ---- conditions --------------------------------------------------------

    /// Narrow the vista to records matching `field == value`. Delegates to the
    /// underlying driver, which translates the value into its native condition
    /// type (BSON document for Mongo, `Expression` for CSV/SQL, …) and applies
    /// it to the wrapped table.
    ///
    /// Returns `Err` if the field is unknown to the driver or the value cannot
    /// be translated into the driver's condition vocabulary.
    pub fn add_condition_eq(&mut self, field: impl Into<String>, value: CborValue) -> Result<()> {
        self.source.add_eq_condition(&field.into(), &value)
    }

    /// Narrow to a single row by id.
    ///
    /// Convenience for the "I only know an id" workflow: pair with
    /// [`ReadableValueSet::get_some_value`](vantage_dataset::traits::ReadableValueSet::get_some_value)
    /// to fetch the row, then traverse via [`get_ref`](Self::get_ref).
    pub fn with_id(&mut self, id: impl Into<CborValue>) -> Result<&mut Self> {
        let id_column = self
            .get_id_column()
            .ok_or_else(|| error!("vista has no id column"))?
            .to_string();
        self.add_condition_eq(id_column, id.into())?;
        Ok(self)
    }

    // ---- index key ---------------------------------------------------------

    /// Stable string identifying one query variant — the vista's name plus the
    /// given conditions and sort. Two variants with the same name, the same set
    /// of conditions (order-insensitive), and the same sort produce the same
    /// key; any difference produces a different key.
    ///
    /// Diorama uses this to cache one ordered index per variant: switching
    /// filters/sort selects (or builds) the matching index, while the
    /// id→record detail table is shared across all variants by vista name.
    /// Deliberately simple — a readable, deterministic rendering rather than a
    /// hash; collision-resistance is not a goal at this layer.
    pub fn index_key(
        &self,
        conditions: &[(String, CborValue)],
        sort: Option<(&str, SortDirection)>,
    ) -> String {
        let mut conds: Vec<String> = conditions
            .iter()
            .map(|(field, value)| format!("{}={}", field, cbor_repr(value)))
            .collect();
        // Normalize away condition order so the key is set-stable.
        conds.sort();

        let sort_repr = match sort {
            Some((col, SortDirection::Ascending)) => format!("{}:asc", col),
            Some((col, SortDirection::Descending)) => format!("{}:desc", col),
            None => String::new(),
        };

        format!("{}|c:{}|s:{}", self.name, conds.join(";"), sort_repr)
    }

    // ---- aggregates (not part of ValueSet) ---------------------------------

    pub async fn get_count(&self) -> Result<i64> {
        self.source.get_vista_count(self).await
    }

    /// Fetch one record by id, passing the caller's existing record down to the
    /// driver. Pairs with the two-pass detail pass, which holds the cheap
    /// list-pass row and lets the detail script read its columns. Drivers that
    /// don't use it fall back to plain id lookup (see
    /// [`TableShell::get_vista_value_with_row`]).
    pub async fn get_value_with_row(
        &self,
        id: &String,
        row: &Record<CborValue>,
    ) -> Result<Option<Record<CborValue>>> {
        self.source.get_vista_value_with_row(self, id, row).await
    }

    /// Push a driver-native condition into the wrapped table. The
    /// boxed value must match the driver's `T::Condition`. Used by
    /// YAML-driven relation factories that need to inject deferred
    /// FK eq-conditions (i.e. conditions whose value is resolved at
    /// fetch time by reading a parent record).
    pub fn add_raw_condition<C: Send + Sync + 'static>(&mut self, condition: C) -> Result<()> {
        self.source.add_raw_condition(Box::new(condition))
    }

    // ---- pagination -------------------------------------------------------

    /// Declare how many records constitute one page. Some backends (notably
    /// REST APIs with server-fixed page sizes) refuse this — check
    /// `capabilities().can_set_page_size` before calling.
    pub fn set_page_size(&mut self, size: usize) -> Result<()> {
        self.source.set_page_size(size)
    }

    /// Fetch a specific page (1-based) using offset-style pagination. The
    /// per-page count comes from the most recent
    /// [`set_page_size`](Self::set_page_size). Returns `Unsupported` when the
    /// driver does not advertise `can_fetch_page`; cursor-only drivers
    /// (DynamoDB, most token-paginated REST APIs) only support
    /// [`fetch_next`](Self::fetch_next) instead.
    pub async fn fetch_page(&self, page: usize) -> Result<Vec<(String, Record<CborValue>)>> {
        self.source.fetch_page(self, page).await
    }

    /// Cursor-style chain fetch. Pass `None` on the first call; pass the
    /// previous call's returned token on subsequent calls. Returned token is
    /// `None` when the result set is exhausted.
    ///
    /// The token is **driver-private** — its shape is whatever the backend
    /// uses (DynamoDB `LastEvaluatedKey`, REST `nextToken`, offset count,
    /// …). Consumers treat it as opaque and round-trip it back unchanged.
    /// Returns `Unsupported` when the driver does not advertise
    /// `can_fetch_next`.
    pub async fn fetch_next(
        &self,
        token: Option<CborValue>,
    ) -> Result<(Vec<(String, Record<CborValue>)>, Option<CborValue>)> {
        self.source.fetch_next(self, token).await
    }

    // ---- quicksearch -------------------------------------------------------

    /// Apply a quicksearch filter. The driver decides which columns participate;
    /// typically those carrying the [`SEARCHABLE`](crate::flags::SEARCHABLE)
    /// flag.
    ///
    /// **Replace semantics**: calling `add_search` again drops the previous
    /// search filter. Returns `Unsupported` when the driver does not advertise
    /// `can_search`.
    pub fn add_search(&mut self, text: impl Into<String>) -> Result<()> {
        self.source.add_search(&text.into())
    }

    /// Drop any quicksearch filter previously applied. Returns `Unsupported`
    /// from the driver shell when search is unsupported.
    pub fn clear_search(&mut self) -> Result<()> {
        self.source.clear_search()
    }

    // ---- ordering ---------------------------------------------------------

    /// Sort results by `column` in the given direction.
    ///
    /// **Replace semantics**: calling `add_order` again wipes the previous
    /// order and pushes the new one. V1 supports a single sort column only;
    /// multi-column sort can be added later without renaming.
    ///
    /// Returns `Unsupported` when the column is not flagged
    /// [`ORDERABLE`](crate::flags::ORDERABLE) — drivers like DynamoDB only
    /// flag their declared sort-key columns. Returns `Unsupported` from the
    /// driver shell when the driver itself does not support ordering at all
    /// (`capabilities().can_order == false`).
    pub fn add_order(&mut self, column: &str, dir: SortDirection) -> Result<()> {
        let col = self
            .source
            .columns()
            .get(column)
            .ok_or_else(|| error!("Unknown column for add_order", column = column))?;
        if !col.has_flag(flags::ORDERABLE) {
            return Err(error!(
                format!("column '{}' is not orderable", column),
                column = column
            )
            .is_unsupported());
        }
        self.source.add_order(column, dir)
    }

    /// Wipe every sort previously applied through `add_order`. Returns
    /// `Unsupported` from the driver shell when ordering is unsupported.
    pub fn clear_orders(&mut self) -> Result<()> {
        self.source.clear_orders()
    }

    // ---- references --------------------------------------------------------

    /// Traverse a named **same-persistence** reference using a known source row.
    ///
    /// Routes in this order:
    /// 1. Contained (embedded-in-row) relations via
    ///    [`TableShell::get_contained_ref`].
    /// 2. Foreign-key refs forwarded through [`TableShell::get_ref`], which
    ///    consults the wrapped typed `Table`'s `with_one` / `with_many`
    ///    registrations.
    ///
    /// The target always lives in the same backend as this Vista.
    /// Cross-persistence traversal is handled one layer up by
    /// `vantage-vista-factory`'s `VistaCatalog`.
    ///
    /// The `row` must come from this Vista (typically via
    /// [`get_value`](vantage_dataset::traits::ReadableValueSet::get_value)
    /// or [`get_some_value`](vantage_dataset::traits::ReadableValueSet::get_some_value)).
    /// The join value is read out of the record and pushed as a plain
    /// eq-condition on the target — no subqueries, no deferred fetch.
    pub fn get_ref(&self, relation: &str, row: &Record<CborValue>) -> Result<Vista> {
        if self.source.contained().contains_key(relation) {
            return self.source.get_contained_ref(relation, row);
        }
        self.source.get_ref(relation, row)
    }

    /// Contained (embedded-in-row) relations the Vista exposes, with their
    /// cardinality. Distinct from [`list_references`](Self::list_references),
    /// which covers foreign-key relations.
    pub fn list_contained(&self) -> Vec<(String, crate::reference::ContainedKind)> {
        self.source
            .contained()
            .values()
            .map(|s| (s.name.clone(), s.kind))
            .collect()
    }

    /// Build the bare target of a same-persistence relation — the unconditioned
    /// table a new related row is inserted into. Forwards to
    /// [`TableShell::get_ref_target`].
    pub fn get_ref_target(&self, relation: &str) -> Result<Vista> {
        self.source.get_ref_target(relation)
    }
}

/// Deterministic, type-tagged rendering of a [`CborValue`] for
/// [`Vista::index_key`]. The type tag prevents collisions between values that
/// stringify alike (e.g. the text `"1"` vs the integer `1`). Containers recurse
/// so nested condition values stay distinguishable.
fn cbor_repr(value: &CborValue) -> String {
    match value {
        CborValue::Null => "nul".to_string(),
        CborValue::Bool(b) => format!("b:{b}"),
        CborValue::Integer(n) => {
            let n: i128 = (*n).into();
            format!("i:{n}")
        }
        CborValue::Float(f) => format!("f:{f}"),
        CborValue::Text(s) => format!("t:{s}"),
        CborValue::Bytes(bytes) => {
            use std::fmt::Write;
            let mut s = String::from("x:");
            for byte in bytes {
                let _ = write!(s, "{byte:02x}");
            }
            s
        }
        CborValue::Array(items) => {
            let inner: Vec<String> = items.iter().map(cbor_repr).collect();
            format!("a:[{}]", inner.join(","))
        }
        CborValue::Map(pairs) => {
            // Sort by rendered key so map ordering never affects the result.
            let mut inner: Vec<String> = pairs
                .iter()
                .map(|(k, v)| format!("{}={}", cbor_repr(k), cbor_repr(v)))
                .collect();
            inner.sort();
            format!("m:{{{}}}", inner.join(","))
        }
        other => format!("?:{other:?}"),
    }
}