reifydb_engine/vm/

executor.rs

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (c) 2025 ReifyDB

use std::{ops::Deref, sync::Arc};

use reifydb_catalog::{catalog::Catalog, vtable::system::flow_operator_store::FlowOperatorStore};
use reifydb_core::{util::ioc::IocContainer, value::column::columns::Columns};
use reifydb_function::registry::Functions;
use reifydb_metric::metric::MetricReader;
use reifydb_policy::inject_read_policies;
use reifydb_rql::compiler::{CompilationResult, constrain_policy};
use reifydb_runtime::clock::Clock;
use reifydb_store_single::SingleStore;
use reifydb_transaction::transaction::{
	Transaction, admin::AdminTransaction, command::CommandTransaction, query::QueryTransaction,
};
use reifydb_type::{
	params::Params,
	value::{Value, frame::frame::Frame, identity::IdentityId, r#type::Type},
};
use tracing::instrument;

use crate::{
	Result,
	policy::PolicyEvaluator,
	procedure::registry::Procedures,
	transform::registry::Transforms,
	vm::{
		Admin, Command, Query,
		services::Services,
		stack::{SymbolTable, Variable},
		vm::Vm,
	},
};

/// Executor is the orchestration layer for RQL statement execution.
pub struct Executor(Arc<Services>);

impl Clone for Executor {
	fn clone(&self) -> Self {
		Self(self.0.clone())
	}
}

impl Deref for Executor {
	type Target = Services;

	fn deref(&self) -> &Self::Target {
		&self.0
	}
}

impl Executor {
	pub fn new(
		catalog: Catalog,
		clock: Clock,
		functions: Functions,
		procedures: Procedures,
		transforms: Transforms,
		flow_operator_store: FlowOperatorStore,
		stats_reader: MetricReader<SingleStore>,
		ioc: IocContainer,
	) -> Self {
		Self(Arc::new(Services::new(
			catalog,
			clock,
			functions,
			procedures,
			transforms,
			flow_operator_store,
			stats_reader,
			ioc,
		)))
	}

	/// Get a reference to the underlying Services
	pub fn services(&self) -> &Arc<Services> {
		&self.0
	}

	/// Construct an Executor from an existing `Arc<Services>`.
	pub fn from_services(services: Arc<Services>) -> Self {
		Self(services)
	}

	#[allow(dead_code)]
	pub fn testing() -> Self {
		Self(Services::testing())
	}
}

/// Populate a stack with parameters so they can be accessed as variables.
fn populate_stack(stack: &mut SymbolTable, params: &Params) -> Result<()> {
	match params {
		Params::Positional(values) => {
			for (index, value) in values.iter().enumerate() {
				let param_name = (index + 1).to_string();
				stack.set(param_name, Variable::scalar(value.clone()), false)?;
			}
		}
		Params::Named(map) => {
			for (name, value) in map {
				stack.set(name.clone(), Variable::scalar(value.clone()), false)?;
			}
		}
		Params::None => {}
	}
	Ok(())
}

/// Populate the `$identity` variable in the symbol table so policy bodies
/// (and user RQL) can reference `$identity.id`, `$identity.name`, and `$identity.roles`.
fn populate_identity(
	stack: &mut SymbolTable,
	catalog: &Catalog,
	tx: &mut Transaction<'_>,
	identity: IdentityId,
) -> Result<()> {
	if identity.is_privileged() {
		return Ok(());
	}
	if identity.is_anonymous() {
		let columns = Columns::single_row([
			("id", Value::IdentityId(identity)),
			("name", Value::none_of(Type::Utf8)),
			("roles", Value::List(vec![])),
		]);
		stack.set("identity".to_string(), Variable::Columns(columns), false)?;
		return Ok(());
	}
	if let Some(user) = catalog.find_user_by_identity(tx, identity)? {
		let roles = catalog.find_role_names_for_identity(tx, identity)?;
		let role_values: Vec<Value> = roles.into_iter().map(Value::Utf8).collect();
		let columns = Columns::single_row([
			("id", Value::IdentityId(identity)),
			("name", Value::Utf8(user.name)),
			("roles", Value::List(role_values)),
		]);
		stack.set("identity".to_string(), Variable::Columns(columns), false)?;
	}
	Ok(())
}

impl Executor {
	/// Execute RQL against an existing open transaction.
	///
	/// This is the universal RQL execution interface: it compiles and runs
	/// arbitrary RQL within whatever transaction variant the caller provides.
	#[instrument(name = "executor::rql", level = "debug", skip(self, tx, params), fields(rql = %rql))]
	pub fn rql(
		&self,
		tx: &mut Transaction<'_>,
		identity: IdentityId,
		rql: &str,
		params: Params,
	) -> Result<Vec<Frame>> {
		let mut result = vec![];
		let mut symbol_table = SymbolTable::new();
		populate_stack(&mut symbol_table, &params)?;
		populate_identity(&mut symbol_table, &self.catalog, tx, identity)?;

		let compiled = match self.compiler.compile_with_policy(tx, rql, |plans, bump, cat, tx| {
			inject_read_policies(plans, bump, cat, tx, identity)
		})? {
			CompilationResult::Ready(compiled) => compiled,
			CompilationResult::Incremental(_) => {
				unreachable!("incremental compilation not supported in rql()")
			}
		};

		for compiled in compiled.iter() {
			result.clear();
			let mut vm = Vm::new(symbol_table, identity);
			vm.run(&self.0, tx, &compiled.instructions, &params, &mut result)?;
			symbol_table = vm.symbol_table;
		}

		Ok(result)
	}

	#[instrument(name = "executor::admin", level = "debug", skip(self, txn, cmd), fields(rql = %cmd.rql))]
	pub fn admin(&self, txn: &mut AdminTransaction, cmd: Admin<'_>) -> Result<Vec<Frame>> {
		let mut result = vec![];
		let mut output_results: Vec<Frame> = Vec::new();
		let mut symbol_table = SymbolTable::new();
		populate_stack(&mut symbol_table, &cmd.params)?;

		let identity = cmd.identity;
		populate_identity(&mut symbol_table, &self.catalog, &mut Transaction::Admin(&mut *txn), identity)?;

		PolicyEvaluator::new(&self.0, &symbol_table).enforce_session_policy(
			&mut Transaction::Admin(&mut *txn),
			identity,
			"admin",
			true,
		)?;

		match self.compiler.compile_with_policy(
			&mut Transaction::Admin(txn),
			cmd.rql,
			|plans, bump, cat, tx| inject_read_policies(plans, bump, cat, tx, identity),
		)? {
			CompilationResult::Ready(compiled) => {
				for compiled in compiled.iter() {
					result.clear();
					let mut tx = Transaction::Admin(txn);
					let mut vm = Vm::new(symbol_table, identity);
					vm.run(&self.0, &mut tx, &compiled.instructions, &cmd.params, &mut result)?;
					symbol_table = vm.symbol_table;

					if compiled.is_output {
						output_results.append(&mut result);
					}
				}
			}
			CompilationResult::Incremental(mut state) => {
				let policy = constrain_policy(|plans, bump, cat, tx| {
					inject_read_policies(plans, bump, cat, tx, identity)
				});
				while let Some(compiled) = self.compiler.compile_next_with_policy(
					&mut Transaction::Admin(txn),
					&mut state,
					&policy,
				)? {
					result.clear();
					let mut tx = Transaction::Admin(txn);
					let mut vm = Vm::new(symbol_table, identity);
					vm.run(&self.0, &mut tx, &compiled.instructions, &cmd.params, &mut result)?;
					symbol_table = vm.symbol_table;

					if compiled.is_output {
						output_results.append(&mut result);
					}
				}
			}
		}

		let mut final_result = output_results;
		final_result.append(&mut result);
		Ok(final_result)
	}

	#[instrument(name = "executor::command", level = "debug", skip(self, txn, cmd), fields(rql = %cmd.rql))]
	pub fn command(&self, txn: &mut CommandTransaction, cmd: Command<'_>) -> Result<Vec<Frame>> {
		let mut result = vec![];
		let mut output_results: Vec<Frame> = Vec::new();
		let mut symbol_table = SymbolTable::new();
		populate_stack(&mut symbol_table, &cmd.params)?;

		let identity = cmd.identity;
		populate_identity(&mut symbol_table, &self.catalog, &mut Transaction::Command(&mut *txn), identity)?;

		PolicyEvaluator::new(&self.0, &symbol_table).enforce_session_policy(
			&mut Transaction::Command(&mut *txn),
			identity,
			"command",
			false,
		)?;

		let compiled = match self.compiler.compile_with_policy(
			&mut Transaction::Command(txn),
			cmd.rql,
			|plans, bump, cat, tx| inject_read_policies(plans, bump, cat, tx, identity),
		)? {
			CompilationResult::Ready(compiled) => compiled,
			CompilationResult::Incremental(_) => {
				unreachable!("DDL statements require admin transactions, not command transactions")
			}
		};

		for compiled in compiled.iter() {
			result.clear();
			let mut tx = Transaction::Command(txn);
			let mut vm = Vm::new(symbol_table, identity);
			vm.run(&self.0, &mut tx, &compiled.instructions, &cmd.params, &mut result)?;
			symbol_table = vm.symbol_table;

			if compiled.is_output {
				output_results.append(&mut result);
			}
		}

		let mut final_result = output_results;
		final_result.append(&mut result);
		Ok(final_result)
	}

	/// Call a procedure by fully-qualified name (e.g., "banking.transfer_funds").
	#[instrument(name = "executor::call_procedure", level = "debug", skip(self, txn, params), fields(name = %name))]
	pub fn call_procedure(
		&self,
		txn: &mut CommandTransaction,
		identity: IdentityId,
		name: &str,
		params: &Params,
	) -> Result<Vec<Frame>> {
		// Compile and execute CALL <name>(<params>)
		let rql = format!("CALL {}()", name);
		let mut result = vec![];
		let mut symbol_table = SymbolTable::new();
		populate_stack(&mut symbol_table, params)?;
		populate_identity(&mut symbol_table, &self.catalog, &mut Transaction::Command(&mut *txn), identity)?;

		let compiled = match self.compiler.compile(&mut Transaction::Command(txn), &rql)? {
			CompilationResult::Ready(compiled) => compiled,
			CompilationResult::Incremental(_) => {
				unreachable!("CALL statements should not require incremental compilation")
			}
		};

		for compiled in compiled.iter() {
			result.clear();
			let mut tx = Transaction::Command(txn);
			let mut vm = Vm::new(symbol_table, identity);
			vm.run(&self.0, &mut tx, &compiled.instructions, params, &mut result)?;
			symbol_table = vm.symbol_table;
		}

		Ok(result)
	}

	#[instrument(name = "executor::query", level = "debug", skip(self, txn, qry), fields(rql = %qry.rql))]
	pub fn query(&self, txn: &mut QueryTransaction, qry: Query<'_>) -> Result<Vec<Frame>> {
		let mut result = vec![];
		let mut output_results: Vec<Frame> = Vec::new();
		let mut symbol_table = SymbolTable::new();
		populate_stack(&mut symbol_table, &qry.params)?;

		let identity = qry.identity;
		populate_identity(&mut symbol_table, &self.catalog, &mut Transaction::Query(&mut *txn), identity)?;

		PolicyEvaluator::new(&self.0, &symbol_table).enforce_session_policy(
			&mut Transaction::Query(&mut *txn),
			identity,
			"query",
			false,
		)?;

		let compiled = match self.compiler.compile_with_policy(
			&mut Transaction::Query(txn),
			qry.rql,
			|plans, bump, cat, tx| inject_read_policies(plans, bump, cat, tx, identity),
		)? {
			CompilationResult::Ready(compiled) => compiled,
			CompilationResult::Incremental(_) => {
				unreachable!("DDL statements require admin transactions, not query transactions")
			}
		};

		for compiled in compiled.iter() {
			result.clear();
			let mut tx = Transaction::Query(txn);
			let mut vm = Vm::new(symbol_table, identity);
			vm.run(&self.0, &mut tx, &compiled.instructions, &qry.params, &mut result)?;
			symbol_table = vm.symbol_table;

			if compiled.is_output {
				output_results.append(&mut result);
			}
		}

		let mut final_result = output_results;
		final_result.append(&mut result);
		Ok(final_result)
	}
}