Skip to main content

reddb_server/runtime/
statement_frame.rs

1use std::cell::RefCell;
2use std::collections::HashSet;
3use std::rc::Rc;
4use std::sync::Arc;
5
6use super::impl_core::{
7    collections_referenced, current_auth_identity, current_connection_id, current_tenant,
8    has_with_prefix, intent_lock_modes_for, peek_top_level_as_of_with_table,
9    query_has_volatile_builtin, query_is_ask_statement, ConfigSnapshotGuard, CurrentSnapshotGuard,
10    KvStoreGuard, SecretStoreGuard, SnapshotContext, TxLocalTenantGuard,
11};
12use super::{RedDBRuntime, RuntimeQueryResult, RuntimeResultCacheEntry};
13use crate::api::{RedDBError, RedDBResult};
14use crate::auth::Role;
15use crate::storage::query::ast::QueryExpr;
16use crate::storage::query::modes::{detect_mode, parse_multi, QueryMode};
17use crate::storage::transaction::snapshot::{Snapshot, Xid};
18
19/// Coarse privilege classification for a statement, computed once at
20/// frame-build time from the SQL text. Mirrors the three-role auth
21/// model (`Role::Read < Role::Write < Role::Admin`) so the frame can
22/// answer "can this identity run this statement?" without re-walking
23/// the parsed `QueryExpr` at every call site.
24///
25/// `None` means the statement does not touch the privilege gate at
26/// all (transaction control, SET, SHOW). Such statements must remain
27/// runnable under any authenticated identity.
28#[derive(Debug, Clone, Copy, PartialEq, Eq)]
29pub(crate) enum Privilege {
30    /// Read-only data access (SELECT, EXPLAIN, SHOW). Satisfied by
31    /// any role from `Role::Read` upward.
32    Read,
33    /// Mutation of user data or schema author DDL (INSERT, UPDATE,
34    /// DELETE, CREATE/ALTER/DROP TABLE, CREATE MIGRATION). Requires
35    /// at least `Role::Write`.
36    Write,
37    /// Authority statements — GRANT, REVOKE, ALTER USER, APPLY /
38    /// ROLLBACK MIGRATION, IAM policy mutation. Requires `Role::Admin`.
39    Admin,
40    /// Statement does not consult the privilege gate (BEGIN, COMMIT,
41    /// ROLLBACK, SET, SHOW with no data exposure). Always permitted
42    /// for any authenticated identity.
43    None,
44}
45
46impl Privilege {
47    /// `true` iff `role` is sufficient to execute a statement carrying
48    /// this required privilege. Encodes the standard `Read ⊆ Write ⊆
49    /// Admin` containment used by the auth fallback path.
50    pub(crate) fn is_satisfied_by(self, role: Role) -> bool {
51        match self {
52            Self::None => true,
53            Self::Read => role.can_read(),
54            Self::Write => role.can_write(),
55            Self::Admin => role.can_admin(),
56        }
57    }
58}
59
60/// Coarse lock intent for a statement, computed once at frame-build
61/// time. Maps onto the storage-layer's `LockMode` matrix downstream
62/// but stays decoupled here so the runtime can answer "does this
63/// statement need the lock manager at all?" without a `use storage::`
64/// at every call site.
65#[derive(Debug, Clone, Copy, PartialEq, Eq)]
66pub(crate) enum LockIntent {
67    /// No collection-level lock needed (transaction control, SET,
68    /// SHOW, EXPLAIN). The lock-acquisition path can short-circuit.
69    None,
70    /// Reader-style intent: SELECT, joins, graph / queue / search
71    /// reads. Maps to `(IS, IS)` at the storage layer.
72    Shared,
73    /// Writer- or DDL-style intent: INSERT/UPDATE/DELETE (`(IX, IX)`)
74    /// and CREATE/ALTER/DROP (`(IX, X)`). Both are surfaced as
75    /// `Exclusive` at this granularity — call sites that need the
76    /// finer distinction still consult `intent_lock_modes_for`.
77    Exclusive,
78}
79
80/// Small, stable Interface that *represents* a read statement's
81/// execution context. Every read caller that needs to know "under
82/// what scope / identity / snapshot am I running, and is there an
83/// AS OF floor in effect?" consults this trait — never the
84/// underlying thread-locals or runtime fields directly.
85///
86/// The deletion test: removing this trait would force the four
87/// concerns it exposes back into ad-hoc lookups at every read
88/// callsite (`current_tenant()`, `current_auth_identity()`,
89/// `capture_current_snapshot()`, AS OF re-parsing). The trait
90/// concentrates them in one place so future changes (per-statement
91/// logging, audit, scope policy) have a single seam to extend.
92pub(crate) trait ReadFrame {
93    /// Effective tenant scope for the statement after WITHIN /
94    /// SET LOCAL TENANT / SET TENANT resolution. `None` means
95    /// "no tenant bound" (RLS deny-default applies).
96    fn effective_scope(&self) -> Option<&str>;
97
98    /// Authenticated identity observed at frame-build time, if any.
99    /// Returns `(username, role)` so callers can render audit lines
100    /// or feed RLS policy lookups without re-reading thread-locals.
101    fn identity(&self) -> Option<(&str, Role)>;
102
103    /// MVCC snapshot the statement reads against. For autocommit
104    /// this is a fresh snapshot; inside an active transaction it
105    /// is the txn's snapshot; under AS OF it is the resolved
106    /// historical xid.
107    fn snapshot(&self) -> &Snapshot;
108
109    /// AS OF xid floor when AS OF was applied for this statement,
110    /// `None` for live reads. Useful for downstream callers that
111    /// want to gate behaviour on historical-read mode without
112    /// re-parsing the query.
113    fn as_of_floor(&self) -> Option<Xid>;
114
115    /// Stable result-cache key for the statement (already mixes
116    /// effective tenant + identity).
117    fn cache_key(&self) -> &str;
118
119    /// Whether the statement is safe to serve from / populate the
120    /// result cache. Combines two underlying signals:
121    ///
122    ///   * the query does not call a volatile builtin (e.g. `NOW()`,
123    ///     `RANDOM()`, `UUID()`), which would change between calls,
124    ///   * the connection is not inside an active transaction with
125    ///     uncommitted writes that other readers shouldn't observe.
126    ///
127    /// SELECT cache callsites (read + write) consult this method
128    /// instead of re-deriving safety from globals or poking the
129    /// frame's private fields. Removing it would force every cache
130    /// callsite to re-run `query_has_volatile_builtin` plus
131    /// `result_cache_safe(conn_id)` inline.
132    fn should_cache_result(&self) -> bool;
133
134    /// Coarse privilege class the statement requires, computed once
135    /// at frame-build time from the SQL prefix. Read/write dispatch
136    /// sites consult this instead of re-classifying the parsed
137    /// `QueryExpr` inline at every callsite.
138    ///
139    /// Removing this method would force every privilege gate to
140    /// recompute the (action, resource) classification from the
141    /// parsed expression and re-check the role hierarchy inline.
142    fn required_privilege(&self) -> Privilege;
143
144    /// Coarse collection-level lock intent the statement implies.
145    /// `None` lets the lock-acquisition path short-circuit without
146    /// touching the lock manager.
147    ///
148    /// Removing this method would force the lock-acquisition path
149    /// to always invoke `intent_lock_modes_for` (which itself walks
150    /// the parsed expression) even for transaction-control / SET /
151    /// SHOW statements that need no collection lock at all.
152    fn lock_intent(&self) -> LockIntent;
153
154    /// Set of collection ids the calling identity is allowed to
155    /// observe under the active `(tenant, role)` scope. Computed once
156    /// at frame-build time via the `AuthStore` visible-collections
157    /// cache (see `auth::scope_cache`) and used by `AuthorizedSearch`
158    /// to pre-filter SEARCH SIMILAR / SEARCH CONTEXT candidate sets
159    /// before any similarity score is computed (issue #119).
160    ///
161    /// `None` means the frame was built without an auth store wired —
162    /// embedded / single-tenant tests run that way. AI search call
163    /// sites refuse to proceed with `None`, which is the deny-default
164    /// the issue requires; pure SELECT paths fall back to the existing
165    /// per-row RLS gate.
166    fn visible_collections(&self) -> Option<&std::collections::HashSet<String>>;
167}
168
169/// Cheap first-word classification of a SQL statement, used at
170/// frame-build time to derive `Privilege` + `LockIntent` without
171/// re-parsing the query. Matches the keywords that the legacy
172/// inline checks in `RedDBRuntime::check_query_privilege` and
173/// `intent_lock_modes_for` already key on.
174fn statement_kind(query: &str) -> &'static str {
175    let trimmed = query.trim_start();
176    // Skip a leading line / block comment so the classifier doesn't
177    // misread `/* ... */ SELECT ...` as an unknown statement.
178    let trimmed = if let Some(rest) = trimmed.strip_prefix("--") {
179        rest.split_once('\n')
180            .map(|(_, r)| r)
181            .unwrap_or("")
182            .trim_start()
183    } else {
184        trimmed
185    };
186    let mut tokens = trimmed.split(|c: char| c.is_whitespace() || c == '(' || c == ';');
187    let first = tokens.next().unwrap_or("");
188    let second = tokens.next().unwrap_or("");
189    if first.eq_ignore_ascii_case("KV") {
190        if second.eq_ignore_ascii_case("GET")
191            || second.eq_ignore_ascii_case("LIST")
192            || second.eq_ignore_ascii_case("WATCH")
193        {
194            return "read";
195        }
196        return "write";
197    }
198    if first.eq_ignore_ascii_case("VAULT") {
199        if second.eq_ignore_ascii_case("LIST")
200            || second.eq_ignore_ascii_case("WATCH")
201            || second.eq_ignore_ascii_case("HISTORY")
202        {
203            return "read";
204        }
205        return "write";
206    }
207    // ASCII-uppercase compare without allocating: SQL keywords are ASCII.
208    let mut buf = [0u8; 16];
209    let bytes = first.as_bytes();
210    let n = bytes.len().min(buf.len());
211    for i in 0..n {
212        buf[i] = bytes[i].to_ascii_uppercase();
213    }
214    match &buf[..n] {
215        b"SELECT" | b"WITH" | b"SHOW" | b"EXPLAIN" | b"DESCRIBE" | b"DESC" | b"RANK"
216        | b"APPROX" | b"APPROXIMATE" | b"ZRANK" | b"ZRANGE" | b"LIST" | b"WATCH" | b"GET"
217        | b"HISTORY" => "read",
218        b"INSERT" | b"UPDATE" | b"DELETE" | b"UPSERT" | b"MERGE" | b"COPY" | b"TRUNCATE" => "write",
219        b"CREATE" | b"ALTER" | b"DROP" | b"REINDEX" | b"VACUUM" | b"ANALYZE" => "ddl",
220        b"GRANT" | b"REVOKE" => "admin",
221        b"BEGIN" | b"START" | b"COMMIT" | b"ROLLBACK" | b"SAVEPOINT" | b"RELEASE" | b"END"
222        | b"SET" | b"RESET" | b"PREPARE" | b"EXECUTE" | b"DEALLOCATE" | b"USE" => "control",
223        b"PUT" | b"INCR" | b"DECR" | b"ADD" | b"ROTATE" | b"PURGE" | b"UNSEAL" | b"INVALIDATE" => {
224            "write"
225        }
226        _ => "unknown",
227    }
228}
229
230fn classify_privilege(query: &str) -> Privilege {
231    match statement_kind(query) {
232        "read" => Privilege::Read,
233        "write" => Privilege::Write,
234        // DDL is gated at `Role::Write` in the legacy fallback (see
235        // `RedDBRuntime::check_query_privilege` for CreateTable et al.),
236        // so it classifies as Write here. APPLY / ROLLBACK MIGRATION and
237        // GRANT / REVOKE upgrade to Admin via finer checks at the call
238        // site — the frame surfaces only the coarse class.
239        "ddl" => Privilege::Write,
240        "admin" => Privilege::Admin,
241        _ => Privilege::None,
242    }
243}
244
245fn classify_lock_intent(query: &str) -> LockIntent {
246    match statement_kind(query) {
247        "read" => LockIntent::Shared,
248        "write" | "ddl" => LockIntent::Exclusive,
249        _ => LockIntent::None,
250    }
251}
252
253pub(super) struct StatementExecutionFrame {
254    tx_local_tenant: Option<Option<String>>,
255    snapshot: Snapshot,
256    own_xids: HashSet<Xid>,
257    serializable_reader: Option<Xid>,
258    cache_key: String,
259    is_volatile_query: bool,
260    cache_safe: bool,
261    /// Effective tenant captured at frame-build time after WITHIN /
262    /// SET LOCAL TENANT / SET TENANT resolution. Stored on the frame
263    /// so the `ReadFrame` Interface can return a borrow without
264    /// re-touching the thread-local stack.
265    effective_scope: Option<String>,
266    /// Auth identity captured at frame-build time. `None` for
267    /// embedded / anonymous callers.
268    identity: Option<(String, Role)>,
269    /// `Some(xid)` when AS OF resolved to a historical xid; `None`
270    /// for live reads.
271    as_of_floor: Option<Xid>,
272    /// True when the statement snapshot can require tuple versions that
273    /// current secondary indexes no longer contain.
274    requires_index_fallback: bool,
275    /// Privilege class required by the statement, derived from the
276    /// SQL text at frame-build time. Read/write dispatch sites
277    /// consult this instead of re-classifying the parsed expression.
278    required_privilege: Privilege,
279    /// Collection-level lock intent the statement implies. The
280    /// lock-acquisition path short-circuits when this is `None`.
281    lock_intent: LockIntent,
282    /// Set of collection ids the active `(tenant, role)` scope is
283    /// allowed to observe. Computed at frame-build time via the
284    /// `AuthStore` visibility cache and consumed by `AuthorizedSearch`
285    /// to gate SEARCH SIMILAR / SEARCH CONTEXT candidate sets before
286    /// scoring (issue #119). `None` when no auth store is wired
287    /// (embedded test mode) — AI search refuses on `None`.
288    visible_collections: Option<HashSet<String>>,
289    /// Per-owner buffer arena for query-result row chunks (#885). Owned
290    /// by the frame because the frame already owns the query lifecycle;
291    /// lent to the row-streaming path (`execute_runtime_table_query_in`)
292    /// so chunk buffers are reused across the statement's chunk-fetches
293    /// instead of allocated fresh per chunk. Reclaimed when the frame
294    /// drops at statement end — no `thread_local!` scratch, which would
295    /// be unsound under tokio's work-stealing runtime.
296    row_arena: Rc<RefCell<super::query_exec::RowBufferArena>>,
297}
298
299pub(super) struct StatementFrameGuards {
300    _tx_local_guard: TxLocalTenantGuard,
301    _config_snapshot_guard: ConfigSnapshotGuard,
302    _secret_store_guard: SecretStoreGuard,
303    _kv_store_guard: KvStoreGuard,
304    _snapshot_guard: CurrentSnapshotGuard,
305}
306
307pub(super) struct PreparedStatement {
308    pub(super) expr: QueryExpr,
309    pub(super) mode: QueryMode,
310}
311
312impl StatementExecutionFrame {
313    pub(super) fn build(runtime: &RedDBRuntime, query: &str) -> RedDBResult<Self> {
314        let conn_id = current_connection_id();
315        let tx_local_tenant = runtime.inner.tx_local_tenants.read().get(&conn_id).cloned();
316        let tx_context = runtime.inner.tx_contexts.read().get(&conn_id).cloned();
317        let own_xids = own_transaction_xids(tx_context.as_ref());
318        let serializable_reader = tx_context
319            .as_ref()
320            .filter(|ctx| {
321                ctx.isolation == crate::storage::transaction::IsolationLevel::Serializable
322            })
323            .map(|ctx| ctx.xid);
324        let (snapshot, as_of_floor) = runtime.statement_snapshot(query)?;
325        let requires_index_fallback = as_of_floor.is_some() || tx_context.is_some();
326        let cache_key = result_cache_key(query);
327        let is_volatile_query = query_has_volatile_builtin(query) || query_is_ask_statement(query);
328        let cache_safe = runtime.result_cache_safe(conn_id);
329        // Capture identity + effective scope under the same
330        // thread-local view that the cache key was built from, so
331        // the Interface and the cache key agree on what "this
332        // statement" means.
333        let effective_scope = current_tenant();
334        let identity = current_auth_identity();
335
336        // Coarse classification of the statement, computed once from
337        // the SQL prefix so downstream callers don't re-derive it
338        // from the parsed `QueryExpr` at every privilege / lock site.
339        let required_privilege = classify_privilege(query);
340        let lock_intent = classify_lock_intent(query);
341
342        // Issue #119: resolve the visible-collections set for the
343        // active (tenant, role) scope. Only meaningful when an auth
344        // store is wired *and* an identity was captured — embedded
345        // anonymous callers fall back to `None`, and AI search call
346        // sites refuse on `None`.
347        let visible_collections = match (runtime.inner.auth_store.read().clone(), identity.as_ref())
348        {
349            (Some(store), Some((principal, role))) => {
350                let collections = runtime.inner.db.store().list_collections();
351                Some(store.visible_collections_for_scope(
352                    effective_scope.as_deref(),
353                    *role,
354                    principal,
355                    &collections,
356                ))
357            }
358            _ => None,
359        };
360
361        Ok(Self {
362            tx_local_tenant,
363            snapshot,
364            own_xids,
365            serializable_reader,
366            cache_key,
367            is_volatile_query,
368            cache_safe,
369            effective_scope,
370            identity,
371            as_of_floor,
372            requires_index_fallback,
373            required_privilege,
374            lock_intent,
375            visible_collections,
376            row_arena: Rc::new(RefCell::new(super::query_exec::RowBufferArena::new())),
377        })
378    }
379
380    /// Lend the frame's per-owner row-buffer arena (#885) to the
381    /// row-streaming path. Returns a cloned `Rc` handle; the frame remains
382    /// the owner and the arena is reclaimed when the frame drops at
383    /// statement end.
384    pub(super) fn row_arena(&self) -> Rc<RefCell<super::query_exec::RowBufferArena>> {
385        Rc::clone(&self.row_arena)
386    }
387
388    pub(super) fn install(&self, runtime: &RedDBRuntime) -> StatementFrameGuards {
389        StatementFrameGuards {
390            _tx_local_guard: TxLocalTenantGuard::install(self.tx_local_tenant.clone()),
391            _config_snapshot_guard: ConfigSnapshotGuard::install(Arc::clone(&runtime.inner.db)),
392            _secret_store_guard: SecretStoreGuard::install(runtime.inner.auth_store.read().clone()),
393            _kv_store_guard: KvStoreGuard::install(runtime.inner.auth_store.read().clone()),
394            _snapshot_guard: CurrentSnapshotGuard::install(SnapshotContext {
395                snapshot: self.snapshot.clone(),
396                manager: Arc::clone(&runtime.inner.snapshot_manager),
397                own_xids: self.own_xids.clone(),
398                requires_index_fallback: self.requires_index_fallback,
399                serializable_reader: self.serializable_reader,
400            }),
401        }
402    }
403
404    pub(super) fn cache_key(&self) -> &str {
405        &self.cache_key
406    }
407
408    pub(super) fn can_read_result_cache(&self) -> bool {
409        // Delegates to the `ReadFrame` Interface so the volatile +
410        // active-tx safety decision lives in exactly one place.
411        <Self as ReadFrame>::should_cache_result(self)
412    }
413
414    pub(super) fn should_write_result_cache(&self, result: &RuntimeQueryResult) -> bool {
415        // Cache-safety (volatile builtin, active-tx writes) comes from
416        // the Interface; the rest are write-side payload heuristics
417        // (statement shape, result size) that aren't part of the
418        // safety contract.
419        <Self as ReadFrame>::should_cache_result(self)
420            && result.statement_type == "select"
421            && result.engine != "vault"
422            && result.engine != "runtime-rank"
423            // `QUEUE READ` is a stateful read: a delayed message
424            // (issue #722) becomes deliverable over time without a
425            // producer push to invalidate the cache, so a cached empty
426            // result would hide it. Skip caching entirely.
427            && result.statement != "queue_group_read"
428            && result.result.pre_serialized_json.is_none()
429            // Graph-analytics TVF output (issue #802) is deterministic and
430            // expensive to recompute, so it is cached at any row count. The
431            // ≤5-row heuristic only bounds payload size for ordinary SELECTs.
432            && (is_graph_tvf_engine(result.engine) || result.result.records.len() <= 5)
433    }
434
435    pub(super) fn read_result_cache(&self, runtime: &RedDBRuntime) -> Option<RuntimeQueryResult> {
436        if self.can_read_result_cache() {
437            runtime.get_result_cache_entry(self.cache_key())
438        } else {
439            None
440        }
441    }
442
443    pub(super) fn write_result_cache(
444        &self,
445        runtime: &RedDBRuntime,
446        result: &RuntimeQueryResult,
447        scopes: HashSet<String>,
448    ) {
449        if self.should_write_result_cache(result) {
450            runtime.put_result_cache_entry(
451                self.cache_key(),
452                RuntimeResultCacheEntry {
453                    result: result.clone(),
454                    cached_at: std::time::Instant::now(),
455                    scopes,
456                },
457            );
458        }
459    }
460
461    pub(super) fn prepare_cte(&self, query: &str) -> RedDBResult<Option<QueryExpr>> {
462        // Detected via cheap prefix check so non-CTE queries skip the
463        // full parse here. CTE-bearing queries bypass the plan cache
464        // and result cache (rare workload — perf optimization is a
465        // follow-up). Inlining substitutes every CTE reference with
466        // its body as a subquery in FROM, after which the existing
467        // subquery-in-FROM machinery handles execution. Recursive
468        // CTEs are rejected explicitly until fixpoint execution wires
469        // through the runtime.
470        if !has_with_prefix(query) {
471            return Ok(None);
472        }
473        let parsed = crate::storage::query::parser::parse(query)
474            .map_err(|err| RedDBError::Query(err.to_string()))?;
475        if parsed.with_clause.is_some() {
476            let rewritten = crate::storage::query::executors::inline_ctes(parsed)
477                .map_err(|err| RedDBError::Query(err.to_string()))?;
478            return Ok(Some(rewritten));
479        }
480        // No WITH after parse (the prefix matched something else like
481        // `WITHIN` that already routed elsewhere) — fall through to
482        // the normal path with the original query.
483        Ok(None)
484    }
485
486    pub(super) fn prepare_statement(
487        &self,
488        runtime: &RedDBRuntime,
489        query: &str,
490    ) -> RedDBResult<PreparedStatement> {
491        let mode = detect_mode(query);
492        if matches!(mode, QueryMode::Unknown) {
493            return Err(RedDBError::Query("unable to detect query mode".to_string()));
494        }
495
496        // ── Plan cache: reuse only exact-query ASTs ──
497        //
498        // DML statements (INSERT/UPDATE/DELETE) almost always have unique literal
499        // values, so caching them burns CPU on eviction bookkeeping (Vec::remove(0)
500        // shifts the entire LRU list) with zero hit rate. Skip the cache entirely
501        // Plan cache applies to statements whose shape can be
502        // normalised + rebound (`UPDATE t SET x=? WHERE _entity_id=?`
503        // reuses the same plan across thousands of varying literals).
504        // INSERT is still bypassed — its shape changes per column set
505        // and bulk paths don't go through here anyway.
506        let first_word = query
507            .trim()
508            .split_ascii_whitespace()
509            .next()
510            .unwrap_or("")
511            .to_ascii_uppercase();
512        let is_insert = first_word == "INSERT";
513        // #1370 — volatile queries ($config / $secret resolve mutable runtime
514        // state at execution time) must bypass the plan cache too. A cached
515        // optimized plan drops the live `$config` resolution, so a later
516        // `SET CONFIG` would be ignored and the query would serve a stale value.
517        // Re-parse fresh every time so the resolver runs against current state.
518        let bypass_plan_cache = is_insert || self.is_volatile_query;
519
520        // Fused normalize+extract: one byte-scan produces both the
521        // cache_key AND the literal bindings. Saves a second Lexer
522        // pass over the query text on every cache hit — dominant
523        // cost on tight UPDATE loops that hit the same shape
524        // thousands of times with varying literals.
525        let (cache_key, prescan_binds) = if bypass_plan_cache {
526            (String::new(), Vec::new())
527        } else {
528            crate::storage::query::planner::cache_key::normalize_and_extract(query)
529        };
530
531        let expr = if bypass_plan_cache {
532            // Bypass plan cache for INSERT — shape varies per query.
533            parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
534        } else {
535            // ── Hot path: read lock only (no writer serialization on cache hits) ──
536            //
537            // peek() is a non-mutating probe: no LRU promotion, no touch().
538            // This lets concurrent readers proceed without blocking each other.
539            // On hit we bind literals if needed and return immediately.
540            // Only on miss do we drop to a write lock to parse + insert.
541            let hit = {
542                let plan_cache = runtime.inner.query_cache.read();
543                plan_cache.peek(&cache_key).map(|cached| {
544                    let parameter_count = cached.parameter_count;
545                    let optimized = cached.plan.optimized.clone();
546                    let exact_query = cached.exact_query.clone();
547                    (parameter_count, optimized, exact_query)
548                })
549            };
550
551            if let Some((parameter_count, optimized, exact_query)) = hit {
552                if parameter_count > 0 {
553                    // Shape hit: use the binds extracted during normalise.
554                    let shape_binds = prescan_binds.clone();
555                    if let Some(bound) =
556                        crate::storage::query::planner::shape::bind_parameterized_query(
557                            &optimized,
558                            &shape_binds,
559                            parameter_count,
560                        )
561                    {
562                        bound
563                    } else if exact_query.as_deref() == Some(query) {
564                        // Bind failed but exact query matches — use as-is.
565                        optimized
566                    } else {
567                        // Bind failed and literals differ: re-parse fresh.
568                        parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
569                    }
570                } else {
571                    // No parameters means either there truly are no literals,
572                    // or this statement type does not participate in shape
573                    // parameterization (for example graph/queue commands).
574                    // Reusing a normalized-cache hit across a different exact
575                    // query can therefore leak stale literals into execution.
576                    if exact_query.as_deref() == Some(query) {
577                        optimized
578                    } else {
579                        parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
580                    }
581                }
582            } else {
583                // Cache miss — parse, parameterize, store.
584                let parsed =
585                    parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?;
586                let (cached_expr, parameter_count) = if let Some(prepared) =
587                    crate::storage::query::planner::shape::parameterize_query_expr(&parsed)
588                {
589                    (prepared.shape, prepared.parameter_count)
590                } else {
591                    (parsed.clone(), 0)
592                };
593                {
594                    let mut pc = runtime.inner.query_cache.write();
595                    let plan = crate::storage::query::planner::QueryPlan::new(
596                        parsed.clone(),
597                        cached_expr,
598                        Default::default(),
599                    );
600                    pc.insert(
601                        cache_key.clone(),
602                        crate::storage::query::planner::CachedPlan::new(plan)
603                            .with_shape_key(cache_key.clone())
604                            .with_exact_query(query.to_string())
605                            .with_parameter_count(parameter_count),
606                    );
607                }
608                parsed
609            }
610        };
611
612        // Phase 5 PG parity: substitute any registered view name that
613        // appears in the expression with its stored body. Runs after
614        // parse and before dispatch so the SQL entrypoint gets the
615        // same view resolution `execute_query_expr` already does.
616        let expr = runtime.rewrite_view_refs(expr);
617
618        Ok(PreparedStatement { expr, mode })
619    }
620
621    pub(super) fn check_query_privilege(
622        &self,
623        runtime: &RedDBRuntime,
624        expr: &QueryExpr,
625    ) -> RedDBResult<()> {
626        // Frame-level coarse gate. We consult `required_privilege()`
627        // (computed once at frame-build) against the captured identity
628        // before the deep grant engine walks the parsed expression.
629        // The coarse gate cannot ALLOW anything the grant engine would
630        // deny — it only short-circuits the obvious "Role::Read tries
631        // INSERT" case so a downstream caller never has to redo this
632        // check inline. `Privilege::None` (transaction control / SET /
633        // SHOW) flows through unchanged; the grant engine treats those
634        // as bypass too.
635        if let Some((username, role)) = <Self as ReadFrame>::identity(self) {
636            let needed = <Self as ReadFrame>::required_privilege(self);
637            if !needed.is_satisfied_by(role) {
638                // Issue #205 — when the deep grant engine *also*
639                // denies, we treat this as an ordinary permission
640                // failure. But when an Admin-only statement reaches
641                // this gate without an auth_store wired (so the deep
642                // engine can't double-check), the coarse rejection is
643                // the only line of defence — emit an OperatorEvent so
644                // the operator notices an Admin-class statement was
645                // attempted with insufficient role.
646                if matches!(needed, Privilege::Admin) && runtime.inner.auth_store.read().is_none() {
647                    crate::telemetry::operator_event::OperatorEvent::AuthBypass {
648                        principal: username.to_string(),
649                        resource: format!("statement requiring {needed:?}"),
650                        detail: format!(
651                            "auth_store not wired; coarse gate is sole defence (role={role:?})"
652                        ),
653                    }
654                    .emit_global();
655                }
656                return Err(RedDBError::Query(format!(
657                    "permission denied: principal=`{username}` role=`{role:?}` lacks {needed:?} privilege"
658                )));
659            }
660        }
661        runtime
662            .check_query_privilege(expr)
663            .map_err(|err| RedDBError::Query(format!("permission denied: {err}")))
664    }
665
666    pub(super) fn prepare_dispatch(
667        &self,
668        runtime: &RedDBRuntime,
669        expr: &QueryExpr,
670    ) -> RedDBResult<Option<crate::runtime::locking::LockerGuard>> {
671        runtime.validate_model_operations_before_auth(expr)?;
672        self.check_query_privilege(runtime, expr)?;
673        Ok(self.acquire_intent_locks(runtime, expr))
674    }
675
676    pub(super) fn acquire_intent_locks(
677        &self,
678        runtime: &RedDBRuntime,
679        expr: &QueryExpr,
680    ) -> Option<crate::runtime::locking::LockerGuard> {
681        if !runtime.config_bool("concurrency.locking.enabled", true) {
682            return None;
683        }
684        // Frame-level short-circuit: if the statement carries no lock
685        // intent (transaction control, SET, SHOW), skip the lock
686        // manager entirely instead of letting `intent_lock_modes_for`
687        // walk the parsed expression to reach the same conclusion.
688        if matches!(<Self as ReadFrame>::lock_intent(self), LockIntent::None) {
689            return None;
690        }
691        intent_lock_modes_for(expr).map(|(global_mode, coll_mode)| {
692            let mut guard =
693                crate::runtime::locking::LockerGuard::new(runtime.inner.lock_manager.clone());
694            let _ = guard.acquire(crate::runtime::locking::Resource::Global, global_mode);
695            for collection in collections_referenced(expr) {
696                let _ = guard.acquire(
697                    crate::runtime::locking::Resource::Collection(collection),
698                    coll_mode,
699                );
700            }
701            guard
702        })
703    }
704}
705
706impl ReadFrame for StatementExecutionFrame {
707    fn effective_scope(&self) -> Option<&str> {
708        self.effective_scope.as_deref()
709    }
710
711    fn identity(&self) -> Option<(&str, Role)> {
712        self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
713    }
714
715    fn snapshot(&self) -> &Snapshot {
716        &self.snapshot
717    }
718
719    fn as_of_floor(&self) -> Option<Xid> {
720        self.as_of_floor
721    }
722
723    fn cache_key(&self) -> &str {
724        &self.cache_key
725    }
726
727    fn should_cache_result(&self) -> bool {
728        !self.is_volatile_query && self.cache_safe
729    }
730
731    fn required_privilege(&self) -> Privilege {
732        self.required_privilege
733    }
734
735    fn lock_intent(&self) -> LockIntent {
736        self.lock_intent
737    }
738
739    fn visible_collections(&self) -> Option<&HashSet<String>> {
740        self.visible_collections.as_ref()
741    }
742}
743
744/// Lightweight `ReadFrame` carrier used by AI command entry points
745/// (`SEARCH SIMILAR`, `SEARCH CONTEXT`, `ASK`).
746///
747/// Issue #119 calls this struct `EffectiveScope`. It bundles the
748/// `(tenant, identity, role, visible_collections, snapshot)` tuple so
749/// every AI runtime entry can pass *one* value to `AuthorizedSearch`
750/// instead of re-reading thread-locals at every call site.
751///
752/// Built via `RedDBRuntime::ai_scope()` which sources tenant + identity
753/// from the per-statement thread-locals (identical to how
754/// `StatementExecutionFrame::build` derives them) and resolves
755/// `visible_collections` via the `AuthStore` cache.
756pub struct EffectiveScope {
757    pub(crate) tenant: Option<String>,
758    pub(crate) identity: Option<(String, Role)>,
759    pub(crate) snapshot: Snapshot,
760    pub(crate) visible_collections: Option<HashSet<String>>,
761}
762
763impl EffectiveScope {
764    /// Capability check used by the AI runtime (`runtime/ai/ner.rs`)
765    /// to gate LLM-backed NER calls behind `ai:ner:read`.
766    ///
767    /// Placeholder for now: always returns `false`. The auth engine's
768    /// capability matrix is future work; until it lands, every routed
769    /// LLM-NER call denies at the gate and `extract_tokens_routed`'s
770    /// heuristic fallback fires (see `ask_pipeline::extract_tokens_routed`).
771    /// Documented in code so the wire-up is a one-line change once
772    /// the auth engine learns capabilities.
773    pub fn has_capability(&self, _capability: &str) -> bool {
774        false
775    }
776}
777
778impl ReadFrame for EffectiveScope {
779    fn effective_scope(&self) -> Option<&str> {
780        self.tenant.as_deref()
781    }
782    fn identity(&self) -> Option<(&str, Role)> {
783        self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
784    }
785    fn snapshot(&self) -> &Snapshot {
786        &self.snapshot
787    }
788    fn as_of_floor(&self) -> Option<Xid> {
789        None
790    }
791    fn cache_key(&self) -> &str {
792        ""
793    }
794    fn should_cache_result(&self) -> bool {
795        false
796    }
797    fn required_privilege(&self) -> Privilege {
798        Privilege::Read
799    }
800    fn lock_intent(&self) -> LockIntent {
801        LockIntent::Shared
802    }
803    fn visible_collections(&self) -> Option<&HashSet<String>> {
804        self.visible_collections.as_ref()
805    }
806}
807
808fn own_transaction_xids(
809    ctx: Option<&crate::storage::transaction::snapshot::TxnContext>,
810) -> HashSet<Xid> {
811    let mut set = HashSet::new();
812    if let Some(ctx) = ctx {
813        set.insert(ctx.xid);
814        for (_, sub) in &ctx.savepoints {
815            set.insert(*sub);
816        }
817        for sub in &ctx.released_sub_xids {
818            set.insert(*sub);
819        }
820    }
821    set
822}
823
824impl RedDBRuntime {
825    /// Build the AI command `EffectiveScope` from the current
826    /// statement thread-locals + auth store.
827    ///
828    /// Returns `None` for embedded callers (no auth store, no
829    /// identity) — `AuthorizedSearch` treats `None` as deny-default.
830    pub(crate) fn ai_scope(&self) -> EffectiveScope {
831        let tenant = super::impl_core::current_tenant();
832        let identity = super::impl_core::current_auth_identity();
833        let snapshot = self.current_snapshot();
834        let visible_collections = match (self.inner.auth_store.read().clone(), identity.as_ref()) {
835            (Some(store), Some((principal, role))) => {
836                let collections = self.inner.db.store().list_collections();
837                Some(store.visible_collections_for_scope(
838                    tenant.as_deref(),
839                    *role,
840                    principal,
841                    &collections,
842                ))
843            }
844            _ => None,
845        };
846        EffectiveScope {
847            tenant,
848            identity,
849            snapshot,
850            visible_collections,
851        }
852    }
853}
854
855/// Test fixtures for callers that need to drive `ReadFrame` without
856/// booting a runtime. Lives behind `cfg(test)` and `pub(crate)` so it
857/// only leaks across module boundaries inside the crate.
858#[cfg(test)]
859pub(crate) mod test_support {
860    use super::{LockIntent, Privilege, ReadFrame};
861    use crate::auth::Role;
862    use crate::storage::transaction::snapshot::{Snapshot, Xid};
863    use std::collections::HashSet;
864
865    /// A `ReadFrame` impl with hand-set fields. Used by
866    /// `authorized_search` tests to assert the deny-default and
867    /// scope-trim behaviour without going through frame construction.
868    pub(crate) struct FakeReadFrame {
869        pub tenant: Option<String>,
870        pub identity: Option<(String, Role)>,
871        pub snapshot: Snapshot,
872        pub visible: Option<HashSet<String>>,
873    }
874
875    impl FakeReadFrame {
876        pub(crate) fn without_scope() -> Self {
877            Self {
878                tenant: None,
879                identity: None,
880                snapshot: Snapshot {
881                    xid: 0,
882                    in_progress: HashSet::new(),
883                },
884                visible: None,
885            }
886        }
887
888        pub(crate) fn with_visible(visible: HashSet<String>) -> Self {
889            Self {
890                tenant: Some("acme".to_string()),
891                identity: Some(("alice".to_string(), Role::Read)),
892                snapshot: Snapshot {
893                    xid: 0,
894                    in_progress: HashSet::new(),
895                },
896                visible: Some(visible),
897            }
898        }
899    }
900
901    impl ReadFrame for FakeReadFrame {
902        fn effective_scope(&self) -> Option<&str> {
903            self.tenant.as_deref()
904        }
905        fn identity(&self) -> Option<(&str, Role)> {
906            self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
907        }
908        fn snapshot(&self) -> &Snapshot {
909            &self.snapshot
910        }
911        fn as_of_floor(&self) -> Option<Xid> {
912            None
913        }
914        fn cache_key(&self) -> &str {
915            ""
916        }
917        fn should_cache_result(&self) -> bool {
918            false
919        }
920        fn required_privilege(&self) -> Privilege {
921            Privilege::Read
922        }
923        fn lock_intent(&self) -> LockIntent {
924            LockIntent::Shared
925        }
926        fn visible_collections(&self) -> Option<&HashSet<String>> {
927            self.visible.as_ref()
928        }
929    }
930}
931
932impl RedDBRuntime {
933    /// Resolve the snapshot for the current statement, returning
934    /// the snapshot itself and (when AS OF is in effect) the
935    /// resolved xid floor. The floor is the same xid carried inside
936    /// `Snapshot.xid` for AS OF reads — exposing it separately lets
937    /// the `ReadFrame` Interface tell "live read" from "historical
938    /// read" without inferring from `in_progress.is_empty()`.
939    fn statement_snapshot(&self, query: &str) -> RedDBResult<(Snapshot, Option<Xid>)> {
940        match peek_top_level_as_of_with_table(query) {
941            Some((spec, Some(table))) => {
942                if !table.starts_with("red_") && !self.vcs_is_versioned(&table)? {
943                    return Err(RedDBError::InvalidConfig(format!(
944                        "AS OF requires a versioned collection — \
945                         `{table}` has not opted in. \
946                         Call vcs.set_versioned(\"{table}\", true) first."
947                    )));
948                }
949                let xid = self.vcs_resolve_as_of(spec)?;
950                Ok((
951                    Snapshot {
952                        xid,
953                        in_progress: HashSet::new(),
954                    },
955                    Some(xid),
956                ))
957            }
958            Some((spec, None)) => {
959                let xid = self.vcs_resolve_as_of(spec)?;
960                Ok((
961                    Snapshot {
962                        xid,
963                        in_progress: HashSet::new(),
964                    },
965                    Some(xid),
966                ))
967            }
968            None => Ok((self.current_snapshot(), None)),
969        }
970    }
971
972    fn result_cache_safe(&self, conn_id: u64) -> bool {
973        let has_active_xids = self.inner.snapshot_manager.oldest_active_xid().is_some();
974        let in_own_tx = self.inner.tx_contexts.read().contains_key(&conn_id);
975        !has_active_xids && !in_own_tx
976    }
977}
978
979/// Whether a result's `engine` tag is one of the graph-analytics TVF
980/// executors (issue #802). Graph-collection (`louvain(g)`) and inline
981/// (`louvain(nodes => …, edges => …)`) forms both produce deterministic
982/// algorithm output that is cached regardless of row count.
983fn is_graph_tvf_engine(engine: &str) -> bool {
984    matches!(engine, "runtime-graph-tvf" | "runtime-graph-tvf-inline")
985}
986
987fn result_cache_key(query: &str) -> String {
988    let tenant = current_tenant().unwrap_or_default();
989    let auth = current_auth_identity()
990        .map(|(user, role)| format!("{}|{:?}", user, role))
991        .unwrap_or_default();
992    if tenant.is_empty() && auth.is_empty() {
993        query.to_string()
994    } else {
995        format!("{query}\u{001e}{tenant}\u{001e}{auth}")
996    }
997}
998
999#[cfg(test)]
1000mod tests {
1001    use super::*;
1002    use crate::api::RedDBOptions;
1003    use crate::runtime::impl_core::{
1004        clear_current_auth_identity, clear_current_tenant, set_current_auth_identity,
1005        set_current_tenant,
1006    };
1007    use crate::runtime::RedDBRuntime;
1008
1009    fn fresh_runtime() -> RedDBRuntime {
1010        RedDBRuntime::with_options(RedDBOptions::in_memory()).expect("in-memory runtime")
1011    }
1012
1013    /// Ensure thread-local state from a prior test can't leak into
1014    /// the next one — tests in the same binary share the thread.
1015    fn reset_thread_locals() {
1016        clear_current_tenant();
1017        clear_current_auth_identity();
1018    }
1019
1020    #[test]
1021    fn autocommit_select_takes_live_snapshot() {
1022        reset_thread_locals();
1023        let rt = fresh_runtime();
1024        let frame =
1025            StatementExecutionFrame::build(&rt, "SELECT 1").expect("frame builds for SELECT 1");
1026
1027        // Live reads: no AS OF floor, snapshot bounded by the
1028        // manager's `peek_next_xid` so committed tuples are visible.
1029        let f: &dyn ReadFrame = &frame;
1030        assert!(f.as_of_floor().is_none(), "live read has no AS OF floor");
1031        assert!(
1032            f.snapshot().xid >= 1,
1033            "autocommit snapshot xid is bounded by peek_next_xid"
1034        );
1035    }
1036
1037    #[test]
1038    fn frame_captures_identity_and_scope() {
1039        reset_thread_locals();
1040        set_current_tenant("acme".to_string());
1041        set_current_auth_identity("alice".to_string(), Role::Write);
1042
1043        let rt = fresh_runtime();
1044        let frame = StatementExecutionFrame::build(&rt, "SELECT 1").expect("frame builds");
1045        let f: &dyn ReadFrame = &frame;
1046
1047        assert_eq!(f.effective_scope(), Some("acme"));
1048        let id = f.identity().expect("identity captured");
1049        assert_eq!(id.0, "alice");
1050        assert!(matches!(id.1, Role::Write));
1051
1052        // Cache key mixes scope + identity so two callers under
1053        // different tenants never share a cache slot.
1054        assert!(
1055            f.cache_key().contains("acme") && f.cache_key().contains("alice"),
1056            "cache key folds in scope + identity, got {:?}",
1057            f.cache_key()
1058        );
1059
1060        reset_thread_locals();
1061    }
1062
1063    #[test]
1064    fn as_of_rejects_non_versioned_user_collection() {
1065        reset_thread_locals();
1066        let rt = fresh_runtime();
1067
1068        // `not_versioned` is a plain user collection — the frame
1069        // builder must reject AS OF until the caller opts in via
1070        // `vcs.set_versioned`.
1071        let err = match StatementExecutionFrame::build(
1072            &rt,
1073            "SELECT * FROM not_versioned AS OF COMMIT 'deadbeef'",
1074        ) {
1075            Err(e) => e,
1076            Ok(_) => panic!("AS OF on non-versioned user collection rejected"),
1077        };
1078
1079        let msg = format!("{err}");
1080        assert!(
1081            msg.contains("AS OF requires a versioned collection"),
1082            "expected AS OF rejection, got: {msg}"
1083        );
1084    }
1085
1086    /// End-to-end proof that the SELECT path consumes a `ReadFrame`.
1087    ///
1088    /// Sets a tenant + identity via the public thread-local API the
1089    /// runtime uses for ambient scope, drives a real `SELECT` through
1090    /// `execute_query`, then inspects the result cache that the SELECT
1091    /// path populates via `frame.cache_key()`. The key only carries
1092    /// the tenant + identity *because* it was built through the frame —
1093    /// reverting the wiring to inline `current_tenant()` /
1094    /// `current_auth_identity()` reads would still pass this test, but
1095    /// dropping the frame entirely (so the SELECT path stopped touching
1096    /// `cache_key`) would break it.
1097    #[test]
1098    fn select_path_routes_through_frame_cache_key() {
1099        reset_thread_locals();
1100        set_current_tenant("acme".to_string());
1101        set_current_auth_identity("alice".to_string(), Role::Read);
1102
1103        let rt = fresh_runtime();
1104        let result = rt
1105            .execute_query("SELECT 1")
1106            .expect("SELECT 1 executes under tenant=acme/identity=alice");
1107        assert_eq!(result.statement_type, "select");
1108
1109        // The textual SELECT path builds a frame and
1110        // writes its result through `frame.cache_key()`. That key folds
1111        // tenant + identity in via `result_cache_key`, so finding "acme"
1112        // and "alice" inside any cached key proves the frame was the
1113        // seam used.
1114        let cache = rt.inner.result_cache.read();
1115        let any_keyed_with_scope = cache
1116            .0
1117            .keys()
1118            .any(|k| k.contains("acme") && k.contains("alice"));
1119        assert!(
1120            any_keyed_with_scope,
1121            "expected at least one result-cache key carrying tenant+identity, \
1122             got keys: {:?}",
1123            cache.0.keys().collect::<Vec<_>>()
1124        );
1125
1126        reset_thread_locals();
1127    }
1128
1129    /// A SELECT that calls a volatile builtin (here:
1130    /// `pg_advisory_unlock`, the volatile token the runtime currently
1131    /// recognises in `query_has_volatile_builtin`) must NOT populate
1132    /// the result cache. Any caller hitting the cache after this would
1133    /// see a stale answer for an inherently-volatile query, so the
1134    /// SELECT path gates writes through `frame.should_cache_result()`.
1135    ///
1136    /// Deletion test: removing `ReadFrame::should_cache_result`, or
1137    /// reverting the SELECT path to skip its safety gate, would let
1138    /// the result cache silently absorb this statement and break the
1139    /// assertion below.
1140    #[test]
1141    fn volatile_select_does_not_populate_result_cache() {
1142        reset_thread_locals();
1143        let rt = fresh_runtime();
1144
1145        // Frame-level invariant: the volatile-builtin signal collapses
1146        // `should_cache_result` to false even for an autocommit /
1147        // out-of-tx connection.
1148        let frame =
1149            StatementExecutionFrame::build(&rt, "SELECT pg_advisory_unlock(1)").expect("frame");
1150        let f: &dyn ReadFrame = &frame;
1151        assert!(
1152            !f.should_cache_result(),
1153            "volatile builtin must disable result-cache safety"
1154        );
1155
1156        // End-to-end: drive the volatile SELECT through `execute_query`
1157        // and confirm no entry was stamped under its cache key. Other
1158        // entries from prior tests sharing the binary may exist, so we
1159        // assert specifically on this query's key.
1160        let _ = rt
1161            .execute_query("SELECT pg_advisory_unlock(1)")
1162            .expect("volatile SELECT executes");
1163        let cache = rt.inner.result_cache.read();
1164        let key = result_cache_key("SELECT pg_advisory_unlock(1)");
1165        assert!(
1166            !cache.0.contains_key(&key),
1167            "volatile SELECT must not populate result cache, found key {key:?} in {:?}",
1168            cache.0.keys().collect::<Vec<_>>()
1169        );
1170
1171        reset_thread_locals();
1172    }
1173
1174    #[test]
1175    fn blob_cache_backend_populates_blob_path_without_legacy_write() {
1176        reset_thread_locals();
1177        let rt = fresh_runtime();
1178        rt.inner
1179            .db
1180            .store()
1181            .set_config_tree("runtime.result_cache.backend", &crate::json!("blob_cache"));
1182
1183        let result = rt.execute_query("SELECT 1").expect("SELECT 1 executes");
1184        assert_eq!(result.statement_type, "select");
1185
1186        let key = result_cache_key("SELECT 1");
1187        assert!(
1188            rt.inner
1189                .result_blob_cache
1190                .get("runtime.result_cache", &key)
1191                .is_some(),
1192            "blob backend should stamp the Blob Cache path"
1193        );
1194        assert!(rt.inner.result_blob_entries.read().0.contains_key(&key));
1195        assert!(
1196            !rt.inner.result_cache.read().0.contains_key(&key),
1197            "blob backend should not write the legacy map"
1198        );
1199    }
1200
1201    #[test]
1202    fn blob_cache_backend_keeps_volatile_select_out_of_blob_path() {
1203        reset_thread_locals();
1204        let rt = fresh_runtime();
1205        rt.inner
1206            .db
1207            .store()
1208            .set_config_tree("runtime.result_cache.backend", &crate::json!("blob_cache"));
1209
1210        let _ = rt
1211            .execute_query("SELECT pg_advisory_unlock(1)")
1212            .expect("volatile SELECT executes");
1213        let key = result_cache_key("SELECT pg_advisory_unlock(1)");
1214        assert!(
1215            rt.inner
1216                .result_blob_cache
1217                .get("runtime.result_cache", &key)
1218                .is_none(),
1219            "volatile SELECT must not populate blob result cache"
1220        );
1221        assert!(!rt.inner.result_blob_entries.read().0.contains_key(&key));
1222    }
1223
1224    #[test]
1225    fn shadow_backend_dual_writes_and_reports_no_divergence_on_equal_results() {
1226        reset_thread_locals();
1227        let rt = fresh_runtime();
1228        rt.inner
1229            .db
1230            .store()
1231            .set_config_tree("runtime.result_cache.backend", &crate::json!("shadow"));
1232
1233        let first = rt.execute_query("SELECT 1").expect("first SELECT");
1234        let second = rt.execute_query("SELECT 1").expect("cached SELECT");
1235        assert_eq!(first.result.len(), second.result.len());
1236
1237        let key = result_cache_key("SELECT 1");
1238        assert!(rt.inner.result_cache.read().0.contains_key(&key));
1239        assert!(rt.inner.result_blob_entries.read().0.contains_key(&key));
1240        assert_eq!(rt.result_cache_shadow_divergences(), 0);
1241        assert_eq!(
1242            crate::runtime::METRIC_CACHE_SHADOW_DIVERGENCE_TOTAL,
1243            "cache_shadow_divergence_total"
1244        );
1245    }
1246
1247    #[test]
1248    fn as_of_on_red_collection_records_floor() {
1249        reset_thread_locals();
1250        let rt = fresh_runtime();
1251
1252        // `red_*` collections always allow AS OF. The frame should
1253        // resolve to a concrete xid and surface it via the Interface.
1254        let frame =
1255            StatementExecutionFrame::build(&rt, "SELECT * FROM red_commits AS OF SNAPSHOT 1")
1256                .expect("AS OF SNAPSHOT 1 on red_commits resolves");
1257
1258        let f: &dyn ReadFrame = &frame;
1259        assert_eq!(
1260            f.as_of_floor(),
1261            Some(1),
1262            "AS OF SNAPSHOT 1 records xid=1 as the floor"
1263        );
1264        assert_eq!(f.snapshot().xid, 1);
1265        assert!(
1266            f.snapshot().in_progress.is_empty(),
1267            "historical reads have no in-progress set"
1268        );
1269    }
1270
1271    /// The frame classifies common SQL prefixes into the coarse
1272    /// `Privilege` / `LockIntent` buckets at build time. This test
1273    /// pins the mapping so a regression that silently re-routes
1274    /// (e.g. INSERT classified as Read) surfaces here, not at a
1275    /// downstream privilege gate.
1276    #[test]
1277    fn frame_classifies_privilege_and_lock_intent_from_prefix() {
1278        reset_thread_locals();
1279        let rt = fresh_runtime();
1280
1281        let cases = [
1282            ("SELECT 1", Privilege::Read, LockIntent::Shared),
1283            ("LIST KV settings", Privilege::Read, LockIntent::Shared),
1284            (
1285                "KV GET settings.feature",
1286                Privilege::Read,
1287                LockIntent::Shared,
1288            ),
1289            ("VAULT LIST secrets", Privilege::Read, LockIntent::Shared),
1290            (
1291                "INSERT INTO t (id) VALUES (1)",
1292                Privilege::Write,
1293                LockIntent::Exclusive,
1294            ),
1295            (
1296                "KV PUT settings.feature = 'on'",
1297                Privilege::Write,
1298                LockIntent::Exclusive,
1299            ),
1300            (
1301                "VAULT PUT secrets.api = 'x'",
1302                Privilege::Write,
1303                LockIntent::Exclusive,
1304            ),
1305            (
1306                "UPDATE t SET x = 1 WHERE id = 1",
1307                Privilege::Write,
1308                LockIntent::Exclusive,
1309            ),
1310            (
1311                "DELETE FROM t WHERE id = 1",
1312                Privilege::Write,
1313                LockIntent::Exclusive,
1314            ),
1315            (
1316                "CREATE TABLE foo (id INT)",
1317                Privilege::Write,
1318                LockIntent::Exclusive,
1319            ),
1320            ("BEGIN", Privilege::None, LockIntent::None),
1321            ("COMMIT", Privilege::None, LockIntent::None),
1322            ("SET timezone = 'UTC'", Privilege::None, LockIntent::None),
1323        ];
1324
1325        for (q, want_priv, want_lock) in cases {
1326            let frame = StatementExecutionFrame::build(&rt, q)
1327                .unwrap_or_else(|e| panic!("frame builds for {q:?}: {e}"));
1328            let f: &dyn ReadFrame = &frame;
1329            assert_eq!(f.required_privilege(), want_priv, "privilege for {q:?}");
1330            assert_eq!(f.lock_intent(), want_lock, "lock intent for {q:?}");
1331        }
1332    }
1333
1334    /// Deletion-test for `ReadFrame::required_privilege`: a SELECT
1335    /// driven through `execute_query` under an identity whose role
1336    /// doesn't satisfy the frame's coarse `Read` privilege gets
1337    /// denied with the frame's signal.
1338    ///
1339    /// We test the gate by classifying an INSERT (which the frame
1340    /// reports as `Privilege::Write`) under `Role::Read` — the only
1341    /// pair the legacy fallback would also reject, but here the
1342    /// rejection comes through `frame.check_query_privilege` BEFORE
1343    /// the parsed-expression walker runs. Removing
1344    /// `required_privilege` (or the `is_satisfied_by` consult inside
1345    /// `check_query_privilege`) would force the deny path back to the
1346    /// inline `RedDBRuntime::check_query_privilege` walker — but the
1347    /// auth_store gate up there is bypassed when no auth_store is
1348    /// wired (embedded test mode), so this test would FLIP from
1349    /// denied to permitted and break the assertion below.
1350    #[test]
1351    fn insert_under_read_role_denied_via_frame_privilege() {
1352        reset_thread_locals();
1353        set_current_auth_identity("alice".to_string(), Role::Read);
1354
1355        let rt = fresh_runtime();
1356        // Bypass parser by reaching into the frame directly: the
1357        // frame derives privilege from the SQL prefix without
1358        // needing an auth_store wired up. Driving end-to-end via
1359        // `execute_query` would also reject (no table `t`), but for
1360        // a different reason — we want to pin the privilege seam.
1361        let frame = StatementExecutionFrame::build(&rt, "INSERT INTO t (id) VALUES (1)")
1362            .expect("frame builds for INSERT");
1363        let f: &dyn ReadFrame = &frame;
1364        assert_eq!(
1365            f.required_privilege(),
1366            Privilege::Write,
1367            "INSERT classified as Write"
1368        );
1369        let id = f.identity().expect("identity captured");
1370        assert!(
1371            !f.required_privilege().is_satisfied_by(id.1),
1372            "Role::Read does not satisfy Privilege::Write — frame must deny"
1373        );
1374
1375        // End-to-end: the frame's `check_query_privilege` sees the
1376        // (Read role, Write privilege) mismatch and denies before
1377        // dispatch. We drive a synthetic `QueryExpr::Table` because
1378        // the SELECT/INSERT parser would happen to also fail, and we
1379        // want the failure to come from the privilege seam.
1380        use crate::storage::query::ast::{QueryExpr, TableQuery};
1381        let expr = QueryExpr::Table(TableQuery::new("t"));
1382        let err = frame
1383            .check_query_privilege(&rt, &expr)
1384            .expect_err("denied via frame's coarse privilege gate");
1385        let msg = format!("{err}");
1386        assert!(
1387            msg.contains("permission denied") && msg.contains("Write"),
1388            "expected frame-level Write deny, got: {msg}"
1389        );
1390
1391        reset_thread_locals();
1392    }
1393
1394    /// End-to-end proof that the frame-owned row-buffer arena (#885) is
1395    /// wired into the SELECT path and produces observable results
1396    /// byte-identical to the per-request-allocation baseline.
1397    ///
1398    /// A table with more rows than the streaming high-water mark
1399    /// (`DEFAULT_HIGH_WATER_MARK`) forces the `execute_runtime_table_query_in`
1400    /// path to assemble many chunks, each leasing/recycling the frame
1401    /// arena's single chunk buffer. Driving it through `execute_query`
1402    /// (which builds a `StatementExecutionFrame` and lends its arena)
1403    /// must return every inserted row, in order — exactly what the
1404    /// allocate-per-chunk path returned. A bug in the arena wiring
1405    /// (dropped rows, bled rows, mis-ordering) would surface here.
1406    #[test]
1407    fn large_select_through_frame_arena_returns_all_rows_in_order() {
1408        reset_thread_locals();
1409        let rt = fresh_runtime();
1410        rt.execute_query("CREATE TABLE big (id INT)")
1411            .expect("create table");
1412
1413        // > DEFAULT_HIGH_WATER_MARK (1024) rows so the streaming channel
1414        // spans multiple chunks and the arena buffer is reused.
1415        const N: usize = 2_500;
1416        for start in (0..N).step_by(250) {
1417            let end = (start + 250).min(N);
1418            let values = (start..end)
1419                .map(|i| format!("({i})"))
1420                .collect::<Vec<_>>()
1421                .join(", ");
1422            rt.execute_query(&format!("INSERT INTO big (id) VALUES {values}"))
1423                .unwrap_or_else(|err| panic!("insert rows {start}..{end}: {err:?}"));
1424        }
1425
1426        let result = rt
1427            .execute_query("SELECT id FROM big ORDER BY id")
1428            .expect("large SELECT executes through the frame arena path");
1429        assert_eq!(result.statement_type, "select");
1430        assert_eq!(
1431            result.result.records.len(),
1432            N,
1433            "every inserted row streams back through the arena-backed channel"
1434        );
1435        for (i, record) in result.result.records.iter().enumerate() {
1436            assert_eq!(
1437                record.get("id"),
1438                Some(&crate::storage::schema::Value::Integer(i as i64)),
1439                "row {i} is byte-identical to the per-request-allocation baseline"
1440            );
1441        }
1442
1443        reset_thread_locals();
1444    }
1445
1446    /// Transport adapters may decode their wire-specific parameter value
1447    /// shapes, but SQL parsing/binding must stay behind the runtime's
1448    /// statement entrypoint. This pins the deeper seam introduced for
1449    /// parameterized query execution: HTTP, JSON-RPC, RedWire, PG wire,
1450    /// and gRPC all call `RedDBRuntime::execute_query_with_params`, which
1451    /// installs a real `StatementExecutionFrame` before dispatch.
1452    #[test]
1453    fn parameterized_transport_adapters_delegate_binding_to_runtime() {
1454        let manifest_dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR"));
1455        let adapters = [
1456            "src/server/handlers_query.rs",
1457            "src/rpc_stdio.rs",
1458            "src/wire/redwire/session.rs",
1459            "src/wire/postgres/server.rs",
1460            "src/grpc.rs",
1461        ];
1462
1463        for relative in adapters {
1464            let path = manifest_dir.join(relative);
1465            let text = std::fs::read_to_string(&path)
1466                .unwrap_or_else(|err| panic!("read {}: {err}", path.display()));
1467            assert!(
1468                text.contains("execute_query_with_params"),
1469                "{relative} should delegate parameterized query execution to the runtime"
1470            );
1471            assert!(
1472                !text.contains("user_params::bind"),
1473                "{relative} must not bind SQL params in the transport adapter"
1474            );
1475        }
1476    }
1477
1478    /// Deletion-test for `ReadFrame::lock_intent`: a transaction
1479    /// control statement carries `LockIntent::None` and the
1480    /// `acquire_intent_locks` path returns `None` without consulting
1481    /// `intent_lock_modes_for`. Removing the method (or its consult
1482    /// site in `acquire_intent_locks`) would force the lock-mode
1483    /// helper to walk a fabricated parsed expression to reach the
1484    /// same conclusion — but the assertion that no guard is allocated
1485    /// for a `BEGIN` frame would still hold, so we additionally pin
1486    /// the classifier mapping above to make the deletion observable.
1487    #[test]
1488    fn control_statement_skips_intent_locks_via_frame() {
1489        reset_thread_locals();
1490        let rt = fresh_runtime();
1491
1492        let frame = StatementExecutionFrame::build(&rt, "BEGIN").expect("frame builds for BEGIN");
1493        let f: &dyn ReadFrame = &frame;
1494        assert_eq!(f.lock_intent(), LockIntent::None);
1495
1496        // Drive `acquire_intent_locks` against a fabricated SELECT
1497        // expression that WOULD normally yield `(IS, IS)`; the frame's
1498        // `lock_intent() == None` short-circuit must still suppress
1499        // the guard.
1500        use crate::storage::query::ast::{QueryExpr, TableQuery};
1501        let expr = QueryExpr::Table(TableQuery::new("t"));
1502        let guard = frame.acquire_intent_locks(&rt, &expr);
1503        assert!(
1504            guard.is_none(),
1505            "BEGIN frame's lock_intent=None must short-circuit lock acquisition"
1506        );
1507    }
1508}