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"PROMOTE" | 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(
392 Arc::clone(&runtime.inner.db),
393 runtime.inner.auth_store.read().clone(),
394 ),
395 _secret_store_guard: SecretStoreGuard::install(runtime.inner.auth_store.read().clone()),
396 _kv_store_guard: KvStoreGuard::install(runtime.inner.auth_store.read().clone()),
397 _snapshot_guard: CurrentSnapshotGuard::install(SnapshotContext {
398 snapshot: self.snapshot.clone(),
399 manager: Arc::clone(&runtime.inner.snapshot_manager),
400 own_xids: self.own_xids.clone(),
401 requires_index_fallback: self.requires_index_fallback,
402 serializable_reader: self.serializable_reader,
403 }),
404 }
405 }
406
407 pub(super) fn cache_key(&self) -> &str {
408 &self.cache_key
409 }
410
411 pub(super) fn can_read_result_cache(&self) -> bool {
412 // Delegates to the `ReadFrame` Interface so the volatile +
413 // active-tx safety decision lives in exactly one place.
414 <Self as ReadFrame>::should_cache_result(self)
415 }
416
417 pub(super) fn should_write_result_cache(&self, result: &RuntimeQueryResult) -> bool {
418 // Cache-safety (volatile builtin, active-tx writes) comes from
419 // the Interface; the rest are write-side payload heuristics
420 // (statement shape, result size) that aren't part of the
421 // safety contract.
422 <Self as ReadFrame>::should_cache_result(self)
423 && result.statement_type == "select"
424 && result.engine != "vault"
425 && result.engine != "runtime-rank"
426 // `QUEUE READ` is a stateful read: a delayed message
427 // (issue #722) becomes deliverable over time without a
428 // producer push to invalidate the cache, so a cached empty
429 // result would hide it. Skip caching entirely.
430 && result.statement != "queue_group_read"
431 && result.result.pre_serialized_json.is_none()
432 // Graph-analytics TVF output (issue #802) is deterministic and
433 // expensive to recompute, so it is cached at any row count. The
434 // ≤5-row heuristic only bounds payload size for ordinary SELECTs.
435 && (is_graph_tvf_engine(result.engine) || result.result.records.len() <= 5)
436 }
437
438 pub(super) fn read_result_cache(&self, runtime: &RedDBRuntime) -> Option<RuntimeQueryResult> {
439 if self.can_read_result_cache() {
440 runtime.get_result_cache_entry(self.cache_key())
441 } else {
442 None
443 }
444 }
445
446 pub(super) fn write_result_cache(
447 &self,
448 runtime: &RedDBRuntime,
449 result: &RuntimeQueryResult,
450 scopes: HashSet<String>,
451 ) {
452 if self.should_write_result_cache(result) {
453 runtime.put_result_cache_entry(
454 self.cache_key(),
455 RuntimeResultCacheEntry {
456 result: result.clone(),
457 cached_at: std::time::Instant::now(),
458 scopes,
459 },
460 );
461 }
462 }
463
464 pub(super) fn prepare_cte(&self, query: &str) -> RedDBResult<Option<QueryExpr>> {
465 // Detected via cheap prefix check so non-CTE queries skip the
466 // full parse here. CTE-bearing queries bypass the plan cache
467 // and result cache (rare workload — perf optimization is a
468 // follow-up). Inlining substitutes every CTE reference with
469 // its body as a subquery in FROM, after which the existing
470 // subquery-in-FROM machinery handles execution. Recursive
471 // CTEs are rejected explicitly until fixpoint execution wires
472 // through the runtime.
473 if !has_with_prefix(query) {
474 return Ok(None);
475 }
476 let parsed = crate::storage::query::parser::parse(query)
477 .map_err(|err| RedDBError::Query(err.to_string()))?;
478 if parsed.with_clause.is_some() {
479 let rewritten = crate::storage::query::executors::inline_ctes(parsed)
480 .map_err(|err| RedDBError::Query(err.to_string()))?;
481 return Ok(Some(rewritten));
482 }
483 // No WITH after parse (the prefix matched something else like
484 // `WITHIN` that already routed elsewhere) — fall through to
485 // the normal path with the original query.
486 Ok(None)
487 }
488
489 pub(super) fn prepare_statement(
490 &self,
491 runtime: &RedDBRuntime,
492 query: &str,
493 ) -> RedDBResult<PreparedStatement> {
494 let mode = detect_mode(query);
495 if matches!(mode, QueryMode::Unknown) {
496 return Err(RedDBError::Query("unable to detect query mode".to_string()));
497 }
498
499 // ── Plan cache: reuse only exact-query ASTs ──
500 //
501 // DML statements (INSERT/UPDATE/DELETE) almost always have unique literal
502 // values, so caching them burns CPU on eviction bookkeeping (Vec::remove(0)
503 // shifts the entire LRU list) with zero hit rate. Skip the cache entirely
504 // Plan cache applies to statements whose shape can be
505 // normalised + rebound (`UPDATE t SET x=? WHERE _entity_id=?`
506 // reuses the same plan across thousands of varying literals).
507 // INSERT is still bypassed — its shape changes per column set
508 // and bulk paths don't go through here anyway.
509 let first_word = query
510 .trim()
511 .split_ascii_whitespace()
512 .next()
513 .unwrap_or("")
514 .to_ascii_uppercase();
515 let is_insert = first_word == "INSERT";
516 // #1370 — volatile queries ($config / $secret resolve mutable runtime
517 // state at execution time) must bypass the plan cache too. A cached
518 // optimized plan drops the live `$config` resolution, so a later
519 // `SET CONFIG` would be ignored and the query would serve a stale value.
520 // Re-parse fresh every time so the resolver runs against current state.
521 let bypass_plan_cache = is_insert || self.is_volatile_query;
522
523 // Fused normalize+extract: one byte-scan produces both the
524 // cache_key AND the literal bindings. Saves a second Lexer
525 // pass over the query text on every cache hit — dominant
526 // cost on tight UPDATE loops that hit the same shape
527 // thousands of times with varying literals.
528 let (cache_key, prescan_binds) = if bypass_plan_cache {
529 (String::new(), Vec::new())
530 } else {
531 crate::storage::query::planner::cache_key::normalize_and_extract(query)
532 };
533
534 let expr = if bypass_plan_cache {
535 // Bypass plan cache for INSERT — shape varies per query.
536 parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
537 } else {
538 // ── Hot path: read lock only (no writer serialization on cache hits) ──
539 //
540 // peek() is a non-mutating probe: no LRU promotion, no touch().
541 // This lets concurrent readers proceed without blocking each other.
542 // On hit we bind literals if needed and return immediately.
543 // Only on miss do we drop to a write lock to parse + insert.
544 let hit = {
545 let plan_cache = runtime.inner.query_cache.read();
546 plan_cache.peek(&cache_key).map(|cached| {
547 let parameter_count = cached.parameter_count;
548 let optimized = cached.plan.optimized.clone();
549 let exact_query = cached.exact_query.clone();
550 (parameter_count, optimized, exact_query)
551 })
552 };
553
554 if let Some((parameter_count, optimized, exact_query)) = hit {
555 if parameter_count > 0 {
556 // Shape hit: use the binds extracted during normalise.
557 let shape_binds = prescan_binds.clone();
558 if let Some(bound) =
559 crate::storage::query::planner::shape::bind_parameterized_query(
560 &optimized,
561 &shape_binds,
562 parameter_count,
563 )
564 {
565 bound
566 } else if exact_query.as_deref() == Some(query) {
567 // Bind failed but exact query matches — use as-is.
568 optimized
569 } else {
570 // Bind failed and literals differ: re-parse fresh.
571 parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
572 }
573 } else {
574 // No parameters means either there truly are no literals,
575 // or this statement type does not participate in shape
576 // parameterization (for example graph/queue commands).
577 // Reusing a normalized-cache hit across a different exact
578 // query can therefore leak stale literals into execution.
579 if exact_query.as_deref() == Some(query) {
580 optimized
581 } else {
582 parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?
583 }
584 }
585 } else {
586 // Cache miss — parse, parameterize, store.
587 let parsed =
588 parse_multi(query).map_err(|err| RedDBError::Query(err.to_string()))?;
589 let (cached_expr, parameter_count) = if let Some(prepared) =
590 crate::storage::query::planner::shape::parameterize_query_expr(&parsed)
591 {
592 (prepared.shape, prepared.parameter_count)
593 } else {
594 (parsed.clone(), 0)
595 };
596 {
597 let mut pc = runtime.inner.query_cache.write();
598 let plan = crate::storage::query::planner::QueryPlan::new(
599 parsed.clone(),
600 cached_expr,
601 Default::default(),
602 );
603 pc.insert(
604 cache_key.clone(),
605 crate::storage::query::planner::CachedPlan::new(plan)
606 .with_shape_key(cache_key.clone())
607 .with_exact_query(query.to_string())
608 .with_parameter_count(parameter_count),
609 );
610 }
611 parsed
612 }
613 };
614
615 // Phase 5 PG parity: substitute any registered view name that
616 // appears in the expression with its stored body. Runs after
617 // parse and before dispatch so the SQL entrypoint gets the
618 // same view resolution `execute_query_expr` already does.
619 let expr = runtime.rewrite_view_refs(expr);
620
621 Ok(PreparedStatement { expr, mode })
622 }
623
624 pub(super) fn check_query_privilege(
625 &self,
626 runtime: &RedDBRuntime,
627 expr: &QueryExpr,
628 ) -> RedDBResult<()> {
629 // Frame-level coarse gate. We consult `required_privilege()`
630 // (computed once at frame-build) against the captured identity
631 // before the deep grant engine walks the parsed expression.
632 // The coarse gate cannot ALLOW anything the grant engine would
633 // deny — it only short-circuits the obvious "Role::Read tries
634 // INSERT" case so a downstream caller never has to redo this
635 // check inline. `Privilege::None` (transaction control / SET /
636 // SHOW) flows through unchanged; the grant engine treats those
637 // as bypass too.
638 if let Some((username, role)) = <Self as ReadFrame>::identity(self) {
639 let needed = <Self as ReadFrame>::required_privilege(self);
640 if !needed.is_satisfied_by(role) {
641 // Issue #205 — when the deep grant engine *also*
642 // denies, we treat this as an ordinary permission
643 // failure. But when an Admin-only statement reaches
644 // this gate without an auth_store wired (so the deep
645 // engine can't double-check), the coarse rejection is
646 // the only line of defence — emit an OperatorEvent so
647 // the operator notices an Admin-class statement was
648 // attempted with insufficient role.
649 if matches!(needed, Privilege::Admin) && runtime.inner.auth_store.read().is_none() {
650 crate::telemetry::operator_event::OperatorEvent::AuthBypass {
651 principal: username.to_string(),
652 resource: format!("statement requiring {needed:?}"),
653 detail: format!(
654 "auth_store not wired; coarse gate is sole defence (role={role:?})"
655 ),
656 }
657 .emit_global();
658 }
659 return Err(RedDBError::Query(format!(
660 "permission denied: principal=`{username}` role=`{role:?}` lacks {needed:?} privilege"
661 )));
662 }
663 }
664 runtime
665 .check_query_privilege(expr)
666 .map_err(|err| RedDBError::Query(format!("permission denied: {err}")))
667 }
668
669 pub(super) fn prepare_dispatch(
670 &self,
671 runtime: &RedDBRuntime,
672 expr: &QueryExpr,
673 ) -> RedDBResult<Option<crate::runtime::locking::LockerGuard>> {
674 runtime.validate_model_operations_before_auth(expr)?;
675 self.check_query_privilege(runtime, expr)?;
676 Ok(self.acquire_intent_locks(runtime, expr))
677 }
678
679 pub(super) fn acquire_intent_locks(
680 &self,
681 runtime: &RedDBRuntime,
682 expr: &QueryExpr,
683 ) -> Option<crate::runtime::locking::LockerGuard> {
684 if !runtime.config_bool("concurrency.locking.enabled", true) {
685 return None;
686 }
687 // Frame-level short-circuit: if the statement carries no lock
688 // intent (transaction control, SET, SHOW), skip the lock
689 // manager entirely instead of letting `intent_lock_modes_for`
690 // walk the parsed expression to reach the same conclusion.
691 if matches!(<Self as ReadFrame>::lock_intent(self), LockIntent::None) {
692 return None;
693 }
694 intent_lock_modes_for(expr).map(|(global_mode, coll_mode)| {
695 let mut guard =
696 crate::runtime::locking::LockerGuard::new(runtime.inner.lock_manager.clone());
697 let _ = guard.acquire(crate::runtime::locking::Resource::Global, global_mode);
698 for collection in collections_referenced(expr) {
699 let _ = guard.acquire(
700 crate::runtime::locking::Resource::Collection(collection),
701 coll_mode,
702 );
703 }
704 guard
705 })
706 }
707}
708
709impl ReadFrame for StatementExecutionFrame {
710 fn effective_scope(&self) -> Option<&str> {
711 self.effective_scope.as_deref()
712 }
713
714 fn identity(&self) -> Option<(&str, Role)> {
715 self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
716 }
717
718 fn snapshot(&self) -> &Snapshot {
719 &self.snapshot
720 }
721
722 fn as_of_floor(&self) -> Option<Xid> {
723 self.as_of_floor
724 }
725
726 fn cache_key(&self) -> &str {
727 &self.cache_key
728 }
729
730 fn should_cache_result(&self) -> bool {
731 !self.is_volatile_query && self.cache_safe
732 }
733
734 fn required_privilege(&self) -> Privilege {
735 self.required_privilege
736 }
737
738 fn lock_intent(&self) -> LockIntent {
739 self.lock_intent
740 }
741
742 fn visible_collections(&self) -> Option<&HashSet<String>> {
743 self.visible_collections.as_ref()
744 }
745}
746
747/// Lightweight `ReadFrame` carrier used by AI command entry points
748/// (`SEARCH SIMILAR`, `SEARCH CONTEXT`, `ASK`).
749///
750/// Issue #119 calls this struct `EffectiveScope`. It bundles the
751/// `(tenant, identity, role, visible_collections, snapshot)` tuple so
752/// every AI runtime entry can pass *one* value to `AuthorizedSearch`
753/// instead of re-reading thread-locals at every call site.
754///
755/// Built via `RedDBRuntime::ai_scope()` which sources tenant + identity
756/// from the per-statement thread-locals (identical to how
757/// `StatementExecutionFrame::build` derives them) and resolves
758/// `visible_collections` via the `AuthStore` cache.
759pub struct EffectiveScope {
760 pub(crate) tenant: Option<String>,
761 pub(crate) identity: Option<(String, Role)>,
762 pub(crate) snapshot: Snapshot,
763 pub(crate) visible_collections: Option<HashSet<String>>,
764}
765
766impl EffectiveScope {
767 /// Capability check used by the AI runtime (`runtime/ai/ner.rs`)
768 /// to gate LLM-backed NER calls behind `ai:ner:read`.
769 ///
770 /// Placeholder for now: always returns `false`. The auth engine's
771 /// capability matrix is future work; until it lands, every routed
772 /// LLM-NER call denies at the gate and `extract_tokens_routed`'s
773 /// heuristic fallback fires (see `ask_pipeline::extract_tokens_routed`).
774 /// Documented in code so the wire-up is a one-line change once
775 /// the auth engine learns capabilities.
776 pub fn has_capability(&self, _capability: &str) -> bool {
777 false
778 }
779}
780
781impl ReadFrame for EffectiveScope {
782 fn effective_scope(&self) -> Option<&str> {
783 self.tenant.as_deref()
784 }
785 fn identity(&self) -> Option<(&str, Role)> {
786 self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
787 }
788 fn snapshot(&self) -> &Snapshot {
789 &self.snapshot
790 }
791 fn as_of_floor(&self) -> Option<Xid> {
792 None
793 }
794 fn cache_key(&self) -> &str {
795 ""
796 }
797 fn should_cache_result(&self) -> bool {
798 false
799 }
800 fn required_privilege(&self) -> Privilege {
801 Privilege::Read
802 }
803 fn lock_intent(&self) -> LockIntent {
804 LockIntent::Shared
805 }
806 fn visible_collections(&self) -> Option<&HashSet<String>> {
807 self.visible_collections.as_ref()
808 }
809}
810
811fn own_transaction_xids(
812 ctx: Option<&crate::storage::transaction::snapshot::TxnContext>,
813) -> HashSet<Xid> {
814 let mut set = HashSet::new();
815 if let Some(ctx) = ctx {
816 set.insert(ctx.xid);
817 for (_, sub) in &ctx.savepoints {
818 set.insert(*sub);
819 }
820 for sub in &ctx.released_sub_xids {
821 set.insert(*sub);
822 }
823 }
824 set
825}
826
827impl RedDBRuntime {
828 /// Build the AI command `EffectiveScope` from the current
829 /// statement thread-locals + auth store.
830 ///
831 /// Returns `None` for embedded callers (no auth store, no
832 /// identity) — `AuthorizedSearch` treats `None` as deny-default.
833 pub(crate) fn ai_scope(&self) -> EffectiveScope {
834 let tenant = super::impl_core::current_tenant();
835 let identity = super::impl_core::current_auth_identity();
836 let snapshot = self.current_snapshot();
837 let visible_collections = match (self.inner.auth_store.read().clone(), identity.as_ref()) {
838 (Some(store), Some((principal, role))) => {
839 let collections = self.inner.db.store().list_collections();
840 Some(store.visible_collections_for_scope(
841 tenant.as_deref(),
842 *role,
843 principal,
844 &collections,
845 ))
846 }
847 _ => None,
848 };
849 EffectiveScope {
850 tenant,
851 identity,
852 snapshot,
853 visible_collections,
854 }
855 }
856}
857
858/// Test fixtures for callers that need to drive `ReadFrame` without
859/// booting a runtime. Lives behind `cfg(test)` and `pub(crate)` so it
860/// only leaks across module boundaries inside the crate.
861#[cfg(test)]
862pub(crate) mod test_support {
863 use super::{LockIntent, Privilege, ReadFrame};
864 use crate::auth::Role;
865 use crate::storage::transaction::snapshot::{Snapshot, Xid};
866 use std::collections::HashSet;
867
868 /// A `ReadFrame` impl with hand-set fields. Used by
869 /// `authorized_search` tests to assert the deny-default and
870 /// scope-trim behaviour without going through frame construction.
871 pub(crate) struct FakeReadFrame {
872 pub tenant: Option<String>,
873 pub identity: Option<(String, Role)>,
874 pub snapshot: Snapshot,
875 pub visible: Option<HashSet<String>>,
876 }
877
878 impl FakeReadFrame {
879 pub(crate) fn without_scope() -> Self {
880 Self {
881 tenant: None,
882 identity: None,
883 snapshot: Snapshot {
884 xid: 0,
885 in_progress: HashSet::new(),
886 },
887 visible: None,
888 }
889 }
890
891 pub(crate) fn with_visible(visible: HashSet<String>) -> Self {
892 Self {
893 tenant: Some("acme".to_string()),
894 identity: Some(("alice".to_string(), Role::Read)),
895 snapshot: Snapshot {
896 xid: 0,
897 in_progress: HashSet::new(),
898 },
899 visible: Some(visible),
900 }
901 }
902 }
903
904 impl ReadFrame for FakeReadFrame {
905 fn effective_scope(&self) -> Option<&str> {
906 self.tenant.as_deref()
907 }
908 fn identity(&self) -> Option<(&str, Role)> {
909 self.identity.as_ref().map(|(u, r)| (u.as_str(), *r))
910 }
911 fn snapshot(&self) -> &Snapshot {
912 &self.snapshot
913 }
914 fn as_of_floor(&self) -> Option<Xid> {
915 None
916 }
917 fn cache_key(&self) -> &str {
918 ""
919 }
920 fn should_cache_result(&self) -> bool {
921 false
922 }
923 fn required_privilege(&self) -> Privilege {
924 Privilege::Read
925 }
926 fn lock_intent(&self) -> LockIntent {
927 LockIntent::Shared
928 }
929 fn visible_collections(&self) -> Option<&HashSet<String>> {
930 self.visible.as_ref()
931 }
932 }
933}
934
935impl RedDBRuntime {
936 /// Resolve the snapshot for the current statement, returning
937 /// the snapshot itself and (when AS OF is in effect) the
938 /// resolved xid floor. The floor is the same xid carried inside
939 /// `Snapshot.xid` for AS OF reads — exposing it separately lets
940 /// the `ReadFrame` Interface tell "live read" from "historical
941 /// read" without inferring from `in_progress.is_empty()`.
942 fn statement_snapshot(&self, query: &str) -> RedDBResult<(Snapshot, Option<Xid>)> {
943 match peek_top_level_as_of_with_table(query) {
944 Some((spec, Some(table))) => {
945 if !table.starts_with("red_") && !self.vcs_is_versioned(&table)? {
946 return Err(RedDBError::InvalidConfig(format!(
947 "AS OF requires a versioned collection — \
948 `{table}` has not opted in. \
949 Call vcs.set_versioned(\"{table}\", true) first."
950 )));
951 }
952 let xid = self.vcs_resolve_as_of(spec)?;
953 Ok((
954 Snapshot {
955 xid,
956 in_progress: HashSet::new(),
957 },
958 Some(xid),
959 ))
960 }
961 Some((spec, None)) => {
962 let xid = self.vcs_resolve_as_of(spec)?;
963 Ok((
964 Snapshot {
965 xid,
966 in_progress: HashSet::new(),
967 },
968 Some(xid),
969 ))
970 }
971 None => Ok((self.current_snapshot(), None)),
972 }
973 }
974
975 fn result_cache_safe(&self, conn_id: u64) -> bool {
976 let has_active_xids = self.inner.snapshot_manager.oldest_active_xid().is_some();
977 let in_own_tx = self.inner.tx_contexts.read().contains_key(&conn_id);
978 !has_active_xids && !in_own_tx
979 }
980}
981
982/// Whether a result's `engine` tag is one of the graph-analytics TVF
983/// executors (issue #802). Graph-collection (`louvain(g)`) and inline
984/// (`louvain(nodes => …, edges => …)`) forms both produce deterministic
985/// algorithm output that is cached regardless of row count.
986fn is_graph_tvf_engine(engine: &str) -> bool {
987 matches!(engine, "runtime-graph-tvf" | "runtime-graph-tvf-inline")
988}
989
990fn result_cache_key(query: &str) -> String {
991 let tenant = current_tenant().unwrap_or_default();
992 let auth = current_auth_identity()
993 .map(|(user, role)| format!("{}|{:?}", user, role))
994 .unwrap_or_default();
995 if tenant.is_empty() && auth.is_empty() {
996 query.to_string()
997 } else {
998 format!("{query}\u{001e}{tenant}\u{001e}{auth}")
999 }
1000}
1001
1002#[cfg(test)]
1003mod tests {
1004 use super::*;
1005 use crate::api::RedDBOptions;
1006 use crate::runtime::impl_core::{
1007 clear_current_auth_identity, clear_current_tenant, set_current_auth_identity,
1008 set_current_tenant,
1009 };
1010 use crate::runtime::RedDBRuntime;
1011
1012 fn fresh_runtime() -> RedDBRuntime {
1013 RedDBRuntime::with_options(RedDBOptions::in_memory()).expect("in-memory runtime")
1014 }
1015
1016 /// Ensure thread-local state from a prior test can't leak into
1017 /// the next one — tests in the same binary share the thread.
1018 fn reset_thread_locals() {
1019 clear_current_tenant();
1020 clear_current_auth_identity();
1021 }
1022
1023 #[test]
1024 fn autocommit_select_takes_live_snapshot() {
1025 reset_thread_locals();
1026 let rt = fresh_runtime();
1027 let frame =
1028 StatementExecutionFrame::build(&rt, "SELECT 1").expect("frame builds for SELECT 1");
1029
1030 // Live reads: no AS OF floor, snapshot bounded by the
1031 // manager's `peek_next_xid` so committed tuples are visible.
1032 let f: &dyn ReadFrame = &frame;
1033 assert!(f.as_of_floor().is_none(), "live read has no AS OF floor");
1034 assert!(
1035 f.snapshot().xid >= 1,
1036 "autocommit snapshot xid is bounded by peek_next_xid"
1037 );
1038 }
1039
1040 #[test]
1041 fn frame_captures_identity_and_scope() {
1042 reset_thread_locals();
1043 set_current_tenant("acme".to_string());
1044 set_current_auth_identity("alice".to_string(), Role::Write);
1045
1046 let rt = fresh_runtime();
1047 let frame = StatementExecutionFrame::build(&rt, "SELECT 1").expect("frame builds");
1048 let f: &dyn ReadFrame = &frame;
1049
1050 assert_eq!(f.effective_scope(), Some("acme"));
1051 let id = f.identity().expect("identity captured");
1052 assert_eq!(id.0, "alice");
1053 assert!(matches!(id.1, Role::Write));
1054
1055 // Cache key mixes scope + identity so two callers under
1056 // different tenants never share a cache slot.
1057 assert!(
1058 f.cache_key().contains("acme") && f.cache_key().contains("alice"),
1059 "cache key folds in scope + identity, got {:?}",
1060 f.cache_key()
1061 );
1062
1063 reset_thread_locals();
1064 }
1065
1066 #[test]
1067 fn as_of_rejects_non_versioned_user_collection() {
1068 reset_thread_locals();
1069 let rt = fresh_runtime();
1070
1071 // `not_versioned` is a plain user collection — the frame
1072 // builder must reject AS OF until the caller opts in via
1073 // `vcs.set_versioned`.
1074 let err = match StatementExecutionFrame::build(
1075 &rt,
1076 "SELECT * FROM not_versioned AS OF COMMIT 'deadbeef'",
1077 ) {
1078 Err(e) => e,
1079 Ok(_) => panic!("AS OF on non-versioned user collection rejected"),
1080 };
1081
1082 let msg = format!("{err}");
1083 assert!(
1084 msg.contains("AS OF requires a versioned collection"),
1085 "expected AS OF rejection, got: {msg}"
1086 );
1087 }
1088
1089 /// End-to-end proof that the SELECT path consumes a `ReadFrame`.
1090 ///
1091 /// Sets a tenant + identity via the public thread-local API the
1092 /// runtime uses for ambient scope, drives a real `SELECT` through
1093 /// `execute_query`, then inspects the result cache that the SELECT
1094 /// path populates via `frame.cache_key()`. The key only carries
1095 /// the tenant + identity *because* it was built through the frame —
1096 /// reverting the wiring to inline `current_tenant()` /
1097 /// `current_auth_identity()` reads would still pass this test, but
1098 /// dropping the frame entirely (so the SELECT path stopped touching
1099 /// `cache_key`) would break it.
1100 #[test]
1101 fn select_path_routes_through_frame_cache_key() {
1102 reset_thread_locals();
1103 set_current_tenant("acme".to_string());
1104 set_current_auth_identity("alice".to_string(), Role::Read);
1105
1106 let rt = fresh_runtime();
1107 let result = rt
1108 .execute_query("SELECT 1")
1109 .expect("SELECT 1 executes under tenant=acme/identity=alice");
1110 assert_eq!(result.statement_type, "select");
1111
1112 // The textual SELECT path builds a frame and
1113 // writes its result through `frame.cache_key()`. That key folds
1114 // tenant + identity in via `result_cache_key`, so finding "acme"
1115 // and "alice" inside any cached key proves the frame was the
1116 // seam used.
1117 let cache = rt.inner.result_cache.read();
1118 let any_keyed_with_scope = cache
1119 .0
1120 .keys()
1121 .any(|k| k.contains("acme") && k.contains("alice"));
1122 assert!(
1123 any_keyed_with_scope,
1124 "expected at least one result-cache key carrying tenant+identity, \
1125 got keys: {:?}",
1126 cache.0.keys().collect::<Vec<_>>()
1127 );
1128
1129 reset_thread_locals();
1130 }
1131
1132 /// A SELECT that calls a volatile builtin (here:
1133 /// `pg_advisory_unlock`, the volatile token the runtime currently
1134 /// recognises in `query_has_volatile_builtin`) must NOT populate
1135 /// the result cache. Any caller hitting the cache after this would
1136 /// see a stale answer for an inherently-volatile query, so the
1137 /// SELECT path gates writes through `frame.should_cache_result()`.
1138 ///
1139 /// Deletion test: removing `ReadFrame::should_cache_result`, or
1140 /// reverting the SELECT path to skip its safety gate, would let
1141 /// the result cache silently absorb this statement and break the
1142 /// assertion below.
1143 #[test]
1144 fn volatile_select_does_not_populate_result_cache() {
1145 reset_thread_locals();
1146 let rt = fresh_runtime();
1147
1148 // Frame-level invariant: the volatile-builtin signal collapses
1149 // `should_cache_result` to false even for an autocommit /
1150 // out-of-tx connection.
1151 let frame =
1152 StatementExecutionFrame::build(&rt, "SELECT pg_advisory_unlock(1)").expect("frame");
1153 let f: &dyn ReadFrame = &frame;
1154 assert!(
1155 !f.should_cache_result(),
1156 "volatile builtin must disable result-cache safety"
1157 );
1158
1159 // End-to-end: drive the volatile SELECT through `execute_query`
1160 // and confirm no entry was stamped under its cache key. Other
1161 // entries from prior tests sharing the binary may exist, so we
1162 // assert specifically on this query's key.
1163 let _ = rt
1164 .execute_query("SELECT pg_advisory_unlock(1)")
1165 .expect("volatile SELECT executes");
1166 let cache = rt.inner.result_cache.read();
1167 let key = result_cache_key("SELECT pg_advisory_unlock(1)");
1168 assert!(
1169 !cache.0.contains_key(&key),
1170 "volatile SELECT must not populate result cache, found key {key:?} in {:?}",
1171 cache.0.keys().collect::<Vec<_>>()
1172 );
1173
1174 reset_thread_locals();
1175 }
1176
1177 #[test]
1178 fn blob_cache_backend_populates_blob_path_without_legacy_write() {
1179 reset_thread_locals();
1180 let rt = fresh_runtime();
1181 rt.inner
1182 .db
1183 .store()
1184 .set_config_tree("runtime.result_cache.backend", &crate::json!("blob_cache"));
1185
1186 let result = rt.execute_query("SELECT 1").expect("SELECT 1 executes");
1187 assert_eq!(result.statement_type, "select");
1188
1189 let key = result_cache_key("SELECT 1");
1190 assert!(
1191 rt.inner
1192 .result_blob_cache
1193 .get("runtime.result_cache", &key)
1194 .is_some(),
1195 "blob backend should stamp the Blob Cache path"
1196 );
1197 assert!(rt.inner.result_blob_entries.read().0.contains_key(&key));
1198 assert!(
1199 !rt.inner.result_cache.read().0.contains_key(&key),
1200 "blob backend should not write the legacy map"
1201 );
1202 }
1203
1204 #[test]
1205 fn blob_cache_backend_keeps_volatile_select_out_of_blob_path() {
1206 reset_thread_locals();
1207 let rt = fresh_runtime();
1208 rt.inner
1209 .db
1210 .store()
1211 .set_config_tree("runtime.result_cache.backend", &crate::json!("blob_cache"));
1212
1213 let _ = rt
1214 .execute_query("SELECT pg_advisory_unlock(1)")
1215 .expect("volatile SELECT executes");
1216 let key = result_cache_key("SELECT pg_advisory_unlock(1)");
1217 assert!(
1218 rt.inner
1219 .result_blob_cache
1220 .get("runtime.result_cache", &key)
1221 .is_none(),
1222 "volatile SELECT must not populate blob result cache"
1223 );
1224 assert!(!rt.inner.result_blob_entries.read().0.contains_key(&key));
1225 }
1226
1227 #[test]
1228 fn shadow_backend_dual_writes_and_reports_no_divergence_on_equal_results() {
1229 reset_thread_locals();
1230 let rt = fresh_runtime();
1231 rt.inner
1232 .db
1233 .store()
1234 .set_config_tree("runtime.result_cache.backend", &crate::json!("shadow"));
1235
1236 let first = rt.execute_query("SELECT 1").expect("first SELECT");
1237 let second = rt.execute_query("SELECT 1").expect("cached SELECT");
1238 assert_eq!(first.result.len(), second.result.len());
1239
1240 let key = result_cache_key("SELECT 1");
1241 assert!(rt.inner.result_cache.read().0.contains_key(&key));
1242 assert!(rt.inner.result_blob_entries.read().0.contains_key(&key));
1243 assert_eq!(rt.result_cache_shadow_divergences(), 0);
1244 assert_eq!(
1245 crate::runtime::METRIC_CACHE_SHADOW_DIVERGENCE_TOTAL,
1246 "cache_shadow_divergence_total"
1247 );
1248 }
1249
1250 #[test]
1251 fn as_of_on_red_collection_records_floor() {
1252 reset_thread_locals();
1253 let rt = fresh_runtime();
1254
1255 // `red_*` collections always allow AS OF. The frame should
1256 // resolve to a concrete xid and surface it via the Interface.
1257 let frame =
1258 StatementExecutionFrame::build(&rt, "SELECT * FROM red_commits AS OF SNAPSHOT 1")
1259 .expect("AS OF SNAPSHOT 1 on red_commits resolves");
1260
1261 let f: &dyn ReadFrame = &frame;
1262 assert_eq!(
1263 f.as_of_floor(),
1264 Some(1),
1265 "AS OF SNAPSHOT 1 records xid=1 as the floor"
1266 );
1267 assert_eq!(f.snapshot().xid, 1);
1268 assert!(
1269 f.snapshot().in_progress.is_empty(),
1270 "historical reads have no in-progress set"
1271 );
1272 }
1273
1274 /// The frame classifies common SQL prefixes into the coarse
1275 /// `Privilege` / `LockIntent` buckets at build time. This test
1276 /// pins the mapping so a regression that silently re-routes
1277 /// (e.g. INSERT classified as Read) surfaces here, not at a
1278 /// downstream privilege gate.
1279 #[test]
1280 fn frame_classifies_privilege_and_lock_intent_from_prefix() {
1281 reset_thread_locals();
1282 let rt = fresh_runtime();
1283
1284 let cases = [
1285 ("SELECT 1", Privilege::Read, LockIntent::Shared),
1286 ("LIST KV settings", Privilege::Read, LockIntent::Shared),
1287 (
1288 "KV GET settings.feature",
1289 Privilege::Read,
1290 LockIntent::Shared,
1291 ),
1292 ("VAULT LIST secrets", Privilege::Read, LockIntent::Shared),
1293 (
1294 "INSERT INTO t (id) VALUES (1)",
1295 Privilege::Write,
1296 LockIntent::Exclusive,
1297 ),
1298 (
1299 "KV PUT settings.feature = 'on'",
1300 Privilege::Write,
1301 LockIntent::Exclusive,
1302 ),
1303 (
1304 "VAULT PUT secrets.api = 'x'",
1305 Privilege::Write,
1306 LockIntent::Exclusive,
1307 ),
1308 (
1309 "UPDATE t SET x = 1 WHERE id = 1",
1310 Privilege::Write,
1311 LockIntent::Exclusive,
1312 ),
1313 (
1314 "DELETE FROM t WHERE id = 1",
1315 Privilege::Write,
1316 LockIntent::Exclusive,
1317 ),
1318 (
1319 "CREATE TABLE foo (id INT)",
1320 Privilege::Write,
1321 LockIntent::Exclusive,
1322 ),
1323 ("BEGIN", Privilege::None, LockIntent::None),
1324 ("COMMIT", Privilege::None, LockIntent::None),
1325 ("SET timezone = 'UTC'", Privilege::None, LockIntent::None),
1326 ];
1327
1328 for (q, want_priv, want_lock) in cases {
1329 let frame = StatementExecutionFrame::build(&rt, q)
1330 .unwrap_or_else(|e| panic!("frame builds for {q:?}: {e}"));
1331 let f: &dyn ReadFrame = &frame;
1332 assert_eq!(f.required_privilege(), want_priv, "privilege for {q:?}");
1333 assert_eq!(f.lock_intent(), want_lock, "lock intent for {q:?}");
1334 }
1335 }
1336
1337 /// Deletion-test for `ReadFrame::required_privilege`: a SELECT
1338 /// driven through `execute_query` under an identity whose role
1339 /// doesn't satisfy the frame's coarse `Read` privilege gets
1340 /// denied with the frame's signal.
1341 ///
1342 /// We test the gate by classifying an INSERT (which the frame
1343 /// reports as `Privilege::Write`) under `Role::Read` — the only
1344 /// pair the legacy fallback would also reject, but here the
1345 /// rejection comes through `frame.check_query_privilege` BEFORE
1346 /// the parsed-expression walker runs. Removing
1347 /// `required_privilege` (or the `is_satisfied_by` consult inside
1348 /// `check_query_privilege`) would force the deny path back to the
1349 /// inline `RedDBRuntime::check_query_privilege` walker — but the
1350 /// auth_store gate up there is bypassed when no auth_store is
1351 /// wired (embedded test mode), so this test would FLIP from
1352 /// denied to permitted and break the assertion below.
1353 #[test]
1354 fn insert_under_read_role_denied_via_frame_privilege() {
1355 reset_thread_locals();
1356 set_current_auth_identity("alice".to_string(), Role::Read);
1357
1358 let rt = fresh_runtime();
1359 // Bypass parser by reaching into the frame directly: the
1360 // frame derives privilege from the SQL prefix without
1361 // needing an auth_store wired up. Driving end-to-end via
1362 // `execute_query` would also reject (no table `t`), but for
1363 // a different reason — we want to pin the privilege seam.
1364 let frame = StatementExecutionFrame::build(&rt, "INSERT INTO t (id) VALUES (1)")
1365 .expect("frame builds for INSERT");
1366 let f: &dyn ReadFrame = &frame;
1367 assert_eq!(
1368 f.required_privilege(),
1369 Privilege::Write,
1370 "INSERT classified as Write"
1371 );
1372 let id = f.identity().expect("identity captured");
1373 assert!(
1374 !f.required_privilege().is_satisfied_by(id.1),
1375 "Role::Read does not satisfy Privilege::Write — frame must deny"
1376 );
1377
1378 // End-to-end: the frame's `check_query_privilege` sees the
1379 // (Read role, Write privilege) mismatch and denies before
1380 // dispatch. We drive a synthetic `QueryExpr::Table` because
1381 // the SELECT/INSERT parser would happen to also fail, and we
1382 // want the failure to come from the privilege seam.
1383 use crate::storage::query::ast::{QueryExpr, TableQuery};
1384 let expr = QueryExpr::Table(TableQuery::new("t"));
1385 let err = frame
1386 .check_query_privilege(&rt, &expr)
1387 .expect_err("denied via frame's coarse privilege gate");
1388 let msg = format!("{err}");
1389 assert!(
1390 msg.contains("permission denied") && msg.contains("Write"),
1391 "expected frame-level Write deny, got: {msg}"
1392 );
1393
1394 reset_thread_locals();
1395 }
1396
1397 /// End-to-end proof that the frame-owned row-buffer arena (#885) is
1398 /// wired into the SELECT path and produces observable results
1399 /// byte-identical to the per-request-allocation baseline.
1400 ///
1401 /// A table with more rows than the streaming high-water mark
1402 /// (`DEFAULT_HIGH_WATER_MARK`) forces the `execute_runtime_table_query_in`
1403 /// path to assemble many chunks, each leasing/recycling the frame
1404 /// arena's single chunk buffer. Driving it through `execute_query`
1405 /// (which builds a `StatementExecutionFrame` and lends its arena)
1406 /// must return every inserted row, in order — exactly what the
1407 /// allocate-per-chunk path returned. A bug in the arena wiring
1408 /// (dropped rows, bled rows, mis-ordering) would surface here.
1409 #[test]
1410 fn large_select_through_frame_arena_returns_all_rows_in_order() {
1411 reset_thread_locals();
1412 let rt = fresh_runtime();
1413 rt.execute_query("CREATE TABLE big (id INT)")
1414 .expect("create table");
1415
1416 // > DEFAULT_HIGH_WATER_MARK (1024) rows so the streaming channel
1417 // spans multiple chunks and the arena buffer is reused.
1418 const N: usize = 2_500;
1419 for start in (0..N).step_by(250) {
1420 let end = (start + 250).min(N);
1421 let values = (start..end)
1422 .map(|i| format!("({i})"))
1423 .collect::<Vec<_>>()
1424 .join(", ");
1425 rt.execute_query(&format!("INSERT INTO big (id) VALUES {values}"))
1426 .unwrap_or_else(|err| panic!("insert rows {start}..{end}: {err:?}"));
1427 }
1428
1429 let result = rt
1430 .execute_query("SELECT id FROM big ORDER BY id")
1431 .expect("large SELECT executes through the frame arena path");
1432 assert_eq!(result.statement_type, "select");
1433 assert_eq!(
1434 result.result.records.len(),
1435 N,
1436 "every inserted row streams back through the arena-backed channel"
1437 );
1438 for (i, record) in result.result.records.iter().enumerate() {
1439 assert_eq!(
1440 record.get("id"),
1441 Some(&crate::storage::schema::Value::Integer(i as i64)),
1442 "row {i} is byte-identical to the per-request-allocation baseline"
1443 );
1444 }
1445
1446 reset_thread_locals();
1447 }
1448
1449 /// Transport adapters may decode their wire-specific parameter value
1450 /// shapes, but SQL parsing/binding must stay behind the runtime's
1451 /// statement entrypoint. This pins the deeper seam introduced for
1452 /// parameterized query execution: HTTP, JSON-RPC, RedWire, PG wire,
1453 /// and gRPC all call `RedDBRuntime::execute_query_with_params`, which
1454 /// installs a real `StatementExecutionFrame` before dispatch.
1455 #[test]
1456 fn parameterized_transport_adapters_delegate_binding_to_runtime() {
1457 let manifest_dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR"));
1458 let adapters = [
1459 "src/server/handlers_query.rs",
1460 "src/rpc_stdio.rs",
1461 "src/wire/redwire/session.rs",
1462 "src/wire/postgres/server.rs",
1463 "src/grpc.rs",
1464 ];
1465
1466 for relative in adapters {
1467 let path = manifest_dir.join(relative);
1468 let text = std::fs::read_to_string(&path)
1469 .unwrap_or_else(|err| panic!("read {}: {err}", path.display()));
1470 assert!(
1471 text.contains("execute_query_with_params"),
1472 "{relative} should delegate parameterized query execution to the runtime"
1473 );
1474 assert!(
1475 !text.contains("user_params::bind"),
1476 "{relative} must not bind SQL params in the transport adapter"
1477 );
1478 }
1479 }
1480
1481 /// Deletion-test for `ReadFrame::lock_intent`: a transaction
1482 /// control statement carries `LockIntent::None` and the
1483 /// `acquire_intent_locks` path returns `None` without consulting
1484 /// `intent_lock_modes_for`. Removing the method (or its consult
1485 /// site in `acquire_intent_locks`) would force the lock-mode
1486 /// helper to walk a fabricated parsed expression to reach the
1487 /// same conclusion — but the assertion that no guard is allocated
1488 /// for a `BEGIN` frame would still hold, so we additionally pin
1489 /// the classifier mapping above to make the deletion observable.
1490 #[test]
1491 fn control_statement_skips_intent_locks_via_frame() {
1492 reset_thread_locals();
1493 let rt = fresh_runtime();
1494
1495 let frame = StatementExecutionFrame::build(&rt, "BEGIN").expect("frame builds for BEGIN");
1496 let f: &dyn ReadFrame = &frame;
1497 assert_eq!(f.lock_intent(), LockIntent::None);
1498
1499 // Drive `acquire_intent_locks` against a fabricated SELECT
1500 // expression that WOULD normally yield `(IS, IS)`; the frame's
1501 // `lock_intent() == None` short-circuit must still suppress
1502 // the guard.
1503 use crate::storage::query::ast::{QueryExpr, TableQuery};
1504 let expr = QueryExpr::Table(TableQuery::new("t"));
1505 let guard = frame.acquire_intent_locks(&rt, &expr);
1506 assert!(
1507 guard.is_none(),
1508 "BEGIN frame's lock_intent=None must short-circuit lock acquisition"
1509 );
1510 }
1511}