omgbase_surface/

planner.rs

//! The tier-3 pushdown planner: reduces the row set a query scans by
//! translating its pushable top-level `where` conjuncts into ONE SQL
//! statement against the store, then handing the produced rows (plus the
//! untranslatable residual) back to the in-memory engine to finish. Port of
//! `packages/core/src/oqx-js/planner.ts` over the [`oqx`] seam
//! ([`QueryPlanner`], [`Plan`], [`oqx::partition_pushable`],
//! [`oqx::residual_query`], [`oqx::ROWS_ROOT`]).
//!
//! Correctness is guaranteed by the residual fallback — anything
//! [`crate::translate`] declines stays in-memory — and verified by the
//! differential gate (planned == in-memory over every corpus-backed query
//! case and the conformance list). Deliberately conservative: only simple
//! top-level target scans (no `follow`, no `from E` re-projection) whose
//! source is a bare `docs|blocks|nodes|links` or `<target>`, with at
//! least one pushable scalar conjunct, are planned; everything else declines
//! to a full in-memory run.
//!
//! One shape difference from the reference, forced by ownership: the
//! reference attaches a store context to its plan (`makeStoreContext(…,
//! rowsRoot)`), but a [`crate::StoreContext`] borrows the store's connection
//! and `Plan::context` must be `'static`, so the plan carries no context and
//! the runner ([`mod@crate::query`]) builds the rows-root context itself
//! ([`crate::StoreContext::with_rows_root`]) — the same six lines
//! `oqx::PlannedEngine::run` would execute.

use oqx::Consumer;
use oqx::ast::{Expr, Follow, FollowDestination, OpNode, Query, SelectItem, Subquery, Where};
use oqx::{Plan, QueryPlanner, Value, partition_pushable, residual_query};
use rusqlite::Connection;
use rusqlite::types::Value as SqlValue;

use crate::context::{REVISION_COLS, REVISION_FROM, Target, fetch_rows, tag_rows};
use crate::translate::{TranslateCtx, translate_predicate};

/// The SQL aliases of the scanned row (`self`) and its owning doc (`doc`).
fn aliases(t: Target) -> (&'static str, &'static str) {
    match t {
        Target::Docs => ("d", "d"),
        Target::Blocks => ("b", "d"),
        Target::Nodes => ("n", "d"),
        Target::Links => ("e", "d"),
        Target::Revisions => ("r", "d"),
    }
}

/// The scan's `FROM`. The `revisions` arms here and below (4.7) are the
/// context's own scan spelled as clauses, so a caller keyed by target
/// (`names::present`, a probe) can speak of the kind; the planner itself
/// never plans a revisions scan ([`compile`]).
pub(crate) fn from_clause(t: Target) -> &'static str {
    match t {
        Target::Docs => "docs d",
        Target::Blocks => "blocks b JOIN docs d ON d.doc_id = b.doc_id",
        Target::Nodes => "nodes n JOIN docs d ON d.doc_id = n.doc_id",
        Target::Links => "edges e JOIN docs d ON d.doc_id = e.src_doc",
        Target::Revisions => REVISION_FROM,
    }
}

/// Row columns + the owning-doc path as `__path` (matches the context's
/// roots so produced rows are indistinguishable from a full scan's).
pub(crate) fn columns(t: Target) -> &'static str {
    match t {
        Target::Docs => "d.*",
        Target::Blocks => "b.*, d.path AS __path",
        Target::Nodes => "n.*, d.path AS __path",
        Target::Links => "e.*, d.path AS __path",
        Target::Revisions => REVISION_COLS,
    }
}

/// The root order (`spec/surface` §1.1).
pub(crate) fn order_clause(t: Target) -> &'static str {
    match t {
        Target::Docs => "d.path, d.doc_id",
        Target::Blocks => "d.path, b.block_id",
        Target::Nodes => "d.path, n.node_id",
        Target::Links => "d.path, e.edge_id",
        Target::Revisions => "r.path, r.rev_id",
    }
}

/// The liveness guards of the root scan, with the repo id bound. The history
/// has no liveness: every revision of every document of the repository,
/// tombstoned ones included (§1.1, 4.7) — the repository guard through the
/// owning `docs` row, since `revisions` carries no `repo_id`.
pub(crate) fn guards(t: Target) -> &'static str {
    match t {
        Target::Docs => "d.repo_id = ? AND d.deleted_commit IS NULL",
        Target::Blocks => "b.repo_id = ? AND b.deleted_commit IS NULL AND d.deleted_commit IS NULL",
        Target::Nodes => "n.repo_id = ? AND d.deleted_commit IS NULL",
        Target::Links => "e.repo_id = ? AND e.to_commit IS NULL AND d.deleted_commit IS NULL",
        Target::Revisions => "d.repo_id = ?",
    }
}

/// The joined targets driven FROM the document: the same rows and columns as
/// [`from_clause`], with the loop order fixed by `CROSS JOIN` so a predicate on
/// the document (`d.path = ?`) is the outer search and the target's rows are
/// reached through their `doc_id` / `src_doc` index (the store indexes'
/// `path` probes). [`guards_by_doc`] goes with it; `Docs` is `from_clause`.
pub(crate) fn from_by_doc(t: Target) -> &'static str {
    match t {
        Target::Docs | Target::Revisions => from_clause(t),
        Target::Blocks => "docs d CROSS JOIN blocks b ON b.doc_id = d.doc_id",
        Target::Nodes => "docs d CROSS JOIN nodes n ON n.doc_id = d.doc_id",
        Target::Links => "docs d CROSS JOIN edges e ON e.src_doc = d.doc_id",
    }
}

/// [`guards`] for a [`from_by_doc`] statement: the same tests, with the
/// document's repo first and the target's repo term behind SQLite's unary `+`
/// so it stays a filter and never selects a `(repo_id, …)` index over the
/// `doc_id` one. Two repo-id binds (`Docs`: one, as `guards`).
pub(crate) fn guards_by_doc(t: Target) -> &'static str {
    match t {
        Target::Docs | Target::Revisions => guards(t),
        Target::Blocks => {
            "d.repo_id = ? AND +b.repo_id = ? AND b.deleted_commit IS NULL AND d.deleted_commit IS NULL"
        }
        Target::Nodes => "d.repo_id = ? AND +n.repo_id = ? AND d.deleted_commit IS NULL",
        Target::Links => {
            "d.repo_id = ? AND +e.repo_id = ? AND e.to_commit IS NULL AND d.deleted_commit IS NULL"
        }
    }
}

/// The root collection a query scans, if it is a bare
/// `docs|blocks|nodes|links|revisions` source at the root scope (else `None` —
/// a nested `^docs` is a block's receiver, never the query's source). The
/// runner asks too: a bare root scan's rows are store rows by construction.
/// Five-wide (the reference's `ROOTS` test); [`compile`] plans four — a
/// `revisions` scan (4.7) always runs in memory.
pub(crate) fn root_target(source: &Expr) -> Option<Target> {
    match source {
        Expr::Ident { name, .. } => Target::parse(name),
        _ => None,
    }
}

/// Whether `name` is a relation of `target`'s rows that is named after a
/// target (§1.2, `_`-prefixed since 5.0: `_nodes`, `_blocks`, `_revisions` on
/// docs, `_nodes` on blocks, `_blocks` on nodes). A BARE root name on a row is
/// never a relation.
fn is_target_relation_of(target: Target, name: &str) -> bool {
    matches!(
        (target, name),
        (Target::Docs, "_nodes" | "_blocks" | "_revisions")
            | (Target::Blocks, "_nodes")
            | (Target::Nodes, "_blocks")
    )
}

/// The row a reach-through head reaches (`_doc.x`, `_block.x`, and a link's
/// `_dst.x`; the self aliases are gone in 5.0).
fn reach_through(head: &str) -> Option<Target> {
    match head {
        "_doc" | "_dst" => Some(Target::Docs),
        "_block" => Some(Target::Blocks),
        _ => None,
    }
}

// ---- the residual-error decline (surface 1.1 patch, §1) ---------------------------------

/// Whether a residual `where` could raise an OQX eval error the pushed
/// conjuncts might hide by emptying the scan. In memory every conjunct of the
/// original `&&` is evaluated for the first row and a throwing one aborts the
/// run; planned, a pushed conjunct that matches no row means the residual
/// never runs and the error vanishes. So a residual containing any function
/// or method call (an unknown function, a bad regex, a wrong arity…), a
/// nested block with the `single` consumer (more than one row raises), a
/// `^`-escaped name (no enclosing scope at the top level) sends the whole
/// query to the in-memory engine unplanned (an engine attribute never
/// raises; a bare root name read as a property — inside a block at any depth,
/// since 5.0 the relations are `_blocks`/`_nodes`/`_revisions` — does). Only
/// comparisons, logical
/// operators, `in`, `!`, literals, bindings and plain reads keep the push.
///
/// The walk is generic over the whole `oqx` AST — every `Where` node, every
/// nested block (its `from`, `where`, `select`, `order by`, `follow`,
/// `limit` / `offset`) and every `Expr`. A `^name:` lift in a nested select
/// counts as a `^`-escaped name. Same decisions as the reference's
/// `residualMayRaise`.
fn residual_may_raise(w: &Where, target: Target) -> bool {
    where_may_raise(w, target, true)
}

fn where_may_raise(w: &Where, target: Target, root: bool) -> bool {
    match w {
        Where::And { parts, .. } | Where::Or { parts, .. } => {
            parts.iter().any(|p| where_may_raise(p, target, root))
        }
        Where::Not { expr, .. } => where_may_raise(expr, target, root),
        Where::Scalar { expr, .. } => expr_may_raise(expr, target, root),
        Where::Op(op) => op_may_raise(op, target, root),
    }
}

fn op_may_raise(op: &OpNode, target: Target, root: bool) -> bool {
    op.op == Consumer::Single
        || expr_may_raise(&op.receiver, target, root)
        || subquery_may_raise(&op.sub, target)
}

fn subquery_may_raise(sub: &Subquery, target: Target) -> bool {
    let inner = |e: &Expr| expr_may_raise(e, target, false);
    sub.from.iter().any(inner)
        || sub
            .r#where
            .as_ref()
            .is_some_and(|w| where_may_raise(w, target, false))
        || sub.select.iter().any(|item| match item {
            SelectItem::Field { expr, lift, .. } => *lift > 0 || inner(expr),
            SelectItem::Collect { op, .. } => op_may_raise(op, target, false),
        })
        || sub.order_by.iter().flatten().any(|o| inner(&o.expr))
        || sub
            .follow
            .as_ref()
            .is_some_and(|f| follow_may_raise(f, target))
        || sub.frontier.as_ref().is_some_and(inner)
        // A flattened block (oqx 0.25) evaluates each `flatten` expression per row.
        || sub.flatten.iter().any(|f| inner(&f.expr))
        // A grouped block (oqx 0.24) evaluates its keys, `having` and its
        // aggregates (`sum` over a string raises) per group.
        || sub
            .group_by
            .as_ref()
            .is_some_and(|g| g.keys.iter().any(|k| inner(&k.expr)))
        || sub
            .having
            .as_ref()
            .is_some_and(|h| where_may_raise(h, target, false))
        || sub.limit.as_ref().is_some_and(inner)
        || sub.offset.as_ref().is_some_and(inner)
}

// A destination is a relation read in the frontier row's scope, or a destination
// block (whose receiver, body, `frontier` and `depth` are its own — oqx 0.20).
fn follow_may_raise(f: &Follow, target: Target) -> bool {
    let inner = |e: &Expr| expr_may_raise(e, target, false);
    f.destinations.iter().any(|d| match d {
        FollowDestination::Relation(e) => inner(e),
        FollowDestination::Block(op) => op_may_raise(op, target, false),
    })
}

fn expr_may_raise(e: &Expr, target: Target, root: bool) -> bool {
    let again = |e: &Expr| expr_may_raise(e, target, root);
    match e {
        Expr::Lit { .. } | Expr::Binding { .. } => false,
        // A bare target name read as a property raises (the root-row rule,
        // `crate::query`): at the root scope the scan itself (the source) is
        // the one bare spelling that does not; inside a block it always does.
        Expr::Ident { name, .. } if Target::parse(name).is_some() => {
            !root || !is_target_relation_of(target, name)
        }
        // An engine attribute or an authored read never raises.
        Expr::Ident { .. } => false,
        Expr::Outer { .. } | Expr::Call { .. } => true,
        // `<head>.<target>` raises unless the head is a reach-through whose row
        // has that relation.
        Expr::Member { recv, name, .. } => {
            (Target::parse(name).is_some()
                && !matches!(&**recv, Expr::Ident { name: head, .. }
                        if reach_through(head).is_some_and(|t| is_target_relation_of(t, name))))
                || again(recv)
        }
        Expr::Unary { expr, .. } => again(expr),
        // `x!` raises when absent; a value-position directive may `single`-fail
        // or read anything its block reads.
        Expr::Required { .. } => true,
        Expr::Op(op) => op_may_raise(op, target, root),
        // A regex operator (oqx 0.22) is a `matches` call: an invalid pattern
        // raises, exactly as the call would.
        Expr::Binary {
            op, left, right, ..
        } => op.is_regex() || again(left) || again(right),
        Expr::Logical { left, right, .. } | Expr::In { left, right, .. } => {
            again(left) || again(right)
        }
        Expr::Range { lo, hi, .. } => {
            lo.as_deref().is_some_and(again) || hi.as_deref().is_some_and(again)
        }
        // A tuple (oqx 0.20) is never pushed down; it raises iff an element does.
        Expr::Tuple { items, .. } => items.iter().any(again),
        // A template literal (oqx 0.21) is never pushed down; interpolating a
        // list or a record is an eval error only the data decides, so with any
        // interpolation it may raise.
        Expr::Template { parts, .. } => oqx::walk::template_exprs(parts).next().is_some(),
        // An aggregate (oqx 0.24) raises on a non-number under `sum`/`avg`,
        // which only the data decides; a grouped query is never planned anyway
        // (`compile`).
        Expr::Aggregate { .. } => true,
    }
}

/// A compiled plan before execution: the statement, its params and the
/// residual query. Pure — what the planner would run, for inspection.
#[derive(Clone, Debug, PartialEq)]
pub struct Compiled {
    pub target: Target,
    pub sql: String,
    pub params: Vec<SqlValue>,
    pub residual: Query,
}

/// Compile `query` against `repo_id`, or `None` when the shape declines: a
/// `follow`, a `from E` re-projection, a `group by` (oqx 0.24) or a `flatten`
/// (oqx 0.25) — a grouped or flattened query is declined whole: its `where`
/// conjuncts could be pushed (the fan-out and the grouping happen after them,
/// so the residual would flatten and group the produced rows correctly), but
/// a pushed conjunct that empties the scan would hide an eval error a
/// `flatten` expression, an aggregate or `having` raises in memory, so decline
/// (c) extends to the post-where clauses; SQL `GROUP BY` / `json_each`
/// pushdown is a later round — a source that is not a root scan, or no
/// pushable conjunct at all (the engine then does everything).
#[must_use]
pub fn compile(query: &Query, params: &[Value], repo_id: &str) -> Option<Compiled> {
    if query.follow.is_some()
        || !query.from.is_empty()
        || query.group_by.is_some()
        || !query.flatten.is_empty()
    {
        return None;
    }
    let target = root_target(&query.source)?;
    // The history (4.7) is never planned: no store index, no pushdown — the
    // scan runs in memory, as the reference's four-wide `rootTarget` decides.
    if target == Target::Revisions {
        return None;
    }
    let (self_alias, doc_alias) = aliases(target);
    let ctx = TranslateCtx {
        target,
        self_alias,
        doc_alias,
        params,
    };
    let (pushed, residual) = partition_pushable(query.r#where.as_ref(), |e| {
        translate_predicate(e, &ctx).is_some()
    });
    if pushed.is_empty() {
        return None;
    }
    // Decline (c): a residual that could raise must not be hidden behind an
    // emptied scan — the whole query runs in memory.
    if residual
        .as_ref()
        .is_some_and(|w| residual_may_raise(w, target))
    {
        return None;
    }
    let mut where_sql = guards(target).to_owned();
    let mut sql_params = vec![SqlValue::Text(repo_id.to_owned())];
    for e in &pushed {
        let frag = translate_predicate(e, &ctx).expect("accepted by partition_pushable");
        where_sql.push_str(" AND (");
        where_sql.push_str(&frag.sql);
        where_sql.push(')');
        sql_params.extend(frag.params);
    }
    let sql = format!(
        "SELECT {} FROM {} WHERE {where_sql} ORDER BY {}",
        columns(target),
        from_clause(target),
        order_clause(target)
    );
    Some(Compiled {
        target,
        sql,
        params: sql_params,
        residual: residual_query(query, residual),
    })
}

/// The SQLite planner over one repo of the store.
pub struct SqlitePlanner<'a> {
    conn: &'a Connection,
    repo_id: String,
}

impl<'a> SqlitePlanner<'a> {
    #[must_use]
    pub fn new(conn: &'a Connection, repo_id: &str) -> Self {
        Self {
            conn,
            repo_id: repo_id.to_owned(),
        }
    }

    /// Plan `query`: `Ok(None)` when the shape declines, `Ok(Some(plan))`
    /// with the produced rows (tagged like the context's root rows) and the
    /// residual, `Err` when the statement itself failed (a store error, not
    /// a decline — the runner reports it rather than silently rescanning).
    pub fn try_plan(&self, query: &Query, params: &[Value]) -> rusqlite::Result<Option<Plan>> {
        let Some(compiled) = compile(query, params, &self.repo_id) else {
            return Ok(None);
        };
        let rows = fetch_rows(self.conn, &compiled.sql, &compiled.params)?;
        Ok(Some(Plan::new(
            tag_rows(rows, compiled.target),
            compiled.residual,
        )))
    }
}

impl QueryPlanner for SqlitePlanner<'_> {
    /// The seam's shape: a failed statement declines (the engine falls back
    /// to a full scan). The runner uses [`Self::try_plan`] to surface it.
    fn plan(&self, query: &Query, params: &[Value]) -> Option<Plan> {
        self.try_plan(query, params).ok().flatten()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use oqx::ROWS_ROOT;
    use oqx::ast::Where;

    fn parse(src: &str) -> Query {
        oqx::parse_string(src).expect("parses")
    }

    fn text(s: &str) -> SqlValue {
        SqlValue::Text(s.to_owned())
    }

    #[test]
    fn a_pushable_scan_compiles_to_one_statement_in_root_order() {
        let c =
            compile(&parse("from docs where _path == \"index.md\""), &[], "r_1").expect("planned");
        assert_eq!(c.target, Target::Docs);
        assert_eq!(
            c.sql,
            "SELECT d.* FROM docs d WHERE d.repo_id = ? AND d.deleted_commit IS NULL AND ((('/' || d.path) IS ?)) ORDER BY d.path, d.doc_id"
        );
        assert_eq!(c.params, vec![text("r_1"), text("index.md")]);
        assert_eq!(
            c.residual.source,
            Expr::Ident {
                name: ROWS_ROOT.to_owned(),
                span: oqx::Span::EMPTY,
            }
        );
        assert_eq!(c.residual.r#where, None);
    }

    #[test]
    fn every_target_has_its_join_columns_guards_and_order() {
        let b = compile(
            &parse("from blocks where _path.startsWith(\"lab/\")"),
            &[],
            "r",
        )
        .unwrap();
        assert_eq!(
            b.sql,
            "SELECT b.*, d.path AS __path FROM blocks b JOIN docs d ON d.doc_id = b.doc_id \
             WHERE b.repo_id = ? AND b.deleted_commit IS NULL AND d.deleted_commit IS NULL \
             AND ((substr(('/' || d.path), 1, length(?)) = ?)) ORDER BY d.path, b.block_id"
        );
        assert_eq!(b.params, vec![text("r"), text("lab/"), text("lab/")]);
        let n = compile(
            &parse("nodes count { where _kind == \"md:task\" }"),
            &[],
            "r",
        )
        .unwrap();
        assert_eq!(n.target, Target::Nodes);
        assert!(n.sql.starts_with(
            "SELECT n.*, d.path AS __path FROM nodes n JOIN docs d ON d.doc_id = n.doc_id WHERE n.repo_id = ? AND d.deleted_commit IS NULL AND ((n.kind IS ?))"
        ));
        assert!(n.sql.ends_with("ORDER BY d.path, n.node_id"));
        let e = compile(
            &parse("from links where _predicate == \"references\""),
            &[],
            "r",
        )
        .unwrap();
        assert!(e.sql.starts_with(
            "SELECT e.*, d.path AS __path FROM edges e JOIN docs d ON d.doc_id = e.src_doc WHERE e.repo_id = ? AND e.to_commit IS NULL AND d.deleted_commit IS NULL AND ((e.predicate IS ?))"
        ));
        assert!(e.sql.ends_with("ORDER BY d.path, e.edge_id"));
    }

    #[test]
    fn mixed_conjunctions_push_the_translatable_parts_and_keep_the_rest() {
        let q = parse(
            "from docs where _path.startsWith(\"processes/\") && _nodes exists { where _kind == \"md:task\" } && layer == \"canon\"",
        );
        let c = compile(&q, &[], "r").expect("planned");
        assert!(
            c.sql
                .contains("(substr(('/' || d.path), 1, length(?)) = ?)"),
            "{}",
            c.sql
        );
        assert!(c.sql.contains("p.key = 'layer'"), "{}", c.sql);
        // Guards first, then the fragments' params in statement order.
        assert_eq!(
            c.params,
            vec![
                text("r"),
                text("processes/"),
                text("processes/"),
                text("canon")
            ]
        );
        // One conjunct left → it stands alone, not wrapped in an `and`.
        assert!(
            matches!(c.residual.r#where, Some(Where::Op(_))),
            "{:?}",
            c.residual.r#where
        );
        assert!(c.residual.from.is_empty());
        assert_eq!(c.residual.select, q.select);
        assert_eq!(c.residual.consumer, q.consumer);
    }

    #[test]
    fn declined_shapes_return_none() {
        // nothing pushable → let the engine do it all
        assert!(compile(&parse("from docs"), &[], "r").is_none());
        assert!(compile(&parse("from docs where era in 800..1680"), &[], "r").is_none());
        assert!(compile(&parse("from docs where !verified"), &[], "r").is_none());
        assert!(
            compile(
                &parse("from docs where _path == \"a\" || _path == \"b\""),
                &[],
                "r"
            )
            .is_none()
        );
        assert!(
            compile(
                &parse("from docs where _nodes exists { where _kind == \"md:task\" }"),
                &[],
                "r"
            )
            .is_none()
        );
        // follow
        assert!(
            compile(
                &parse("from docs where _path == \"a.md\" follow distinct _out_links collect { from _dst }"),
                &[],
                "r"
            )
            .is_none()
        );
        // flatten (oqx 0.25): declined whole, like `group by`
        assert!(
            compile(
                &parse("select _path, t from docs where layer == \"canon\" flatten _tags as t"),
                &[],
                "r"
            )
            .is_none()
        );
        assert!(
            compile(
                &parse("from docs where layer == \"canon\" flatten _blocks { where _type == \"task\" } as b"),
                &[],
                "r"
            )
            .is_none()
        );
        // follow with several destinations: relations and a destination block
        // decline exactly like a single relation (0.14)
        assert!(
            compile(
                &parse("from docs where _path == \"a.md\" follow _out_links collect { from _dst }, _in_links collect { from _doc }"),
                &[],
                "r"
            )
            .is_none()
        );
        assert!(
            compile(
                &parse(
                    "from docs where _path == \"a.md\" follow ^docs collect { where after.contains(^_path) }"
                ),
                &[],
                "r"
            )
            .is_none()
        );
        // a body-level `frontier` (oqx 0.20) plans like the `follow` it needs
        assert!(
            compile(
                &parse("from docs where _path == \"a.md\" frontier type == \"hub\" follow distinct _out_links collect { from _dst frontier type == \"practitioner\" }"),
                &[],
                "r"
            )
            .is_none()
        );
        // a grouped query is declined whole (oqx 0.24), pushable `where` or not
        assert!(
            compile(
                &parse("select layer, n: count() from docs where _path == \"a.md\" group by layer"),
                &[],
                "r"
            )
            .is_none()
        );
        // not a root scan
        assert!(compile(&parse("from things where _path == \"a.md\""), &[], "r").is_none());
        assert!(compile(&parse("from nope where _path == \"a.md\""), &[], "r").is_none());
        assert!(compile(&parse("from docs._nodes where _kind == \"x\""), &[], "r").is_none());
        // a `from E` re-projection (an AST-level shape)
        let mut q = parse("from docs where _path == \"a.md\"");
        q.from.push(Expr::Ident {
            name: "nodes".to_owned(),
            span: oqx::Span::EMPTY,
        });
        assert!(compile(&q, &[], "r").is_none());
    }

    // -- decline (c): a residual that could raise sends the whole query in memory --

    #[test]
    fn a_residual_that_could_raise_declines_the_whole_query() {
        let declined = |src: &str| {
            assert!(
                compile(&parse(src), &[], "r").is_none(),
                "should decline: {src}"
            );
        };
        let planned = |src: &str| {
            assert!(
                compile(&parse(src), &[], "r").is_some(),
                "should plan: {src}"
            );
        };
        // an engine attribute is never a raise — `_path` pushes, `_raw`/
        // `_updated_at`/`_tags` are plain residuals
        planned("from docs where _path == \"x\" && _path == \"nope.md\"");
        planned("from docs where _path == \"nope.md\" && !_raw");
        planned("from docs where _path == \"nope.md\" && _updated_at");
        planned("from docs where _path == \"nope.md\" && _tags");
        // `_doc.<attribute>` on any target, at any depth, is a plain read too
        planned("from blocks where _path == \"x\" && _doc._path == \"y\"");
        planned("from blocks where _path == \"x\" && _nodes exists { where _doc._path == \"y\" }");
        // a bare root name inside a block raises (5.0: never a relation) —
        // the whole query declines; its `_` spelling is the relation
        declined("from docs where _path == \"x\" && _nodes exists { where blocks exists { } }");
        planned(
            "from docs where _path == \"x\" && _nodes exists { where _doc._blocks exists { } }",
        );
        // a function or method call
        declined("from docs where _path.matches(\"[\") && _path == \"nope.md\"");
        declined("from docs where nope(\"x\") && _path == \"nope.md\"");
        declined("from docs where _path == \"x\" && size(_tags) > 1");
        declined(
            "from docs where _path == \"x\" && _nodes exists { where _name.lower() == \"a\" }",
        );
        declined(
            "from docs where _path == \"x\" && _nodes count { where _kind == \"a\" order by size(_name) } > 1",
        );
        // a `^`-escaped name: an outer reference or a lift
        declined("from docs where _path == \"x\" && ^slug == \"y\"");
        declined("from docs where _path == \"x\" && _nodes exists { where _name == ^_title }");
        declined("from docs where _path == \"x\" && _nodes collect { ^first_task: _name }");
        // a nested block with the `single` consumer
        declined(
            "from docs where _path == \"x\" && _blocks exists { select t: _nodes single { where _kind == \"md:task\" } }",
        );
        // the pushed side raising is impossible; only the residual matters
        planned("from docs where _path.startsWith(\"lab/\") && _path == \"x\"");
        // plain reads, comparisons, `in`, `!`, literals and bindings keep the push
        planned("from docs where _path == \"x\" && era in 800..1680");
        planned("from docs where _path == \"x\" && !verified");
        planned("from docs where _path == \"x\" && (layer == \"a\" || layer == \"b\")");
        planned("from docs where _path == \"x\" && verified == true");
        planned("from docs where _path == \"x\" && _nodes exists { where _kind == \"md:task\" }");
        planned(
            "from docs where _path == \"x\" && _nodes count { where _kind == \"md:task\" limit 5 } > 1",
        );
        // a bare `path` is an authored property on every kind (5.0), and
        // inside a block the rows are another scope — an ordinary read either way
        planned("from blocks where _path == \"x\" && !path");
        planned("from docs where _path == \"x\" && _nodes exists { where path == \"y\" }");
        planned("from docs where _path == \"x\" && _frontmatter.path == \"y\"");
        // a key read through a source handle is pushed (3.0), scoped to its
        // source; a WHOLE handle reference and `entries(…)` stay residual (and
        // the function call declines the query)
        let fm = compile(
            &parse("from docs where _frontmatter.layer == \"canon\""),
            &[],
            "r",
        )
        .expect("planned");
        assert!(fm.sql.contains("p.source = 'frontmatter'"), "{}", fm.sql);
        let data =
            compile(&parse("from docs where _data.layer == \"canon\""), &[], "r").expect("planned");
        assert!(!data.sql.contains("p.source"), "{}", data.sql);
        planned("from blocks where _doc._inline.element == \"fire\"");
        planned("from docs where _path == \"x\" && _frontmatter == null");
        declined("from docs where _path == \"x\" && entries(_frontmatter) exists { }");
    }

    #[test]
    fn a_top_level_not_or_or_is_the_whole_residual_and_declines() {
        // `!(…)` and `||` at the top are `Where::Not` / `Where::Or`, never scalar
        // parts, so nothing is pushed even when their leaves would be.
        assert!(compile(&parse("from docs where !(_path == \"a\")"), &[], "r").is_none());
        assert!(
            compile(
                &parse("from docs where (_path == \"a\" || _path == \"b\") && layer == \"canon\""),
                &[],
                "r"
            )
            .is_some()
        );
    }
}