reifydb_transaction/multi/transaction/

mod.rs

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 ReifyDB

// This file includes and modifies code from the skipdb project (https://github.com/al8n/skipdb),
// originally licensed under the Apache License, Version 2.0.
// Original copyright:
//   Copyright (c) 2024 Al Liu
//
// The original Apache License can be found at:
//   http://www.apache.org/licenses/LICENSE-2.0

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

use reifydb_core::{
	common::CommitVersion,
	event::EventBus,
	interface::{
		catalog::config::GetConfig,
		store::{MultiVersionCommit, MultiVersionContains, MultiVersionGet},
	},
	key::any::TaggedKey,
	testing::ProfileConfig,
};
use reifydb_runtime::{
	actor::system::{ActorSpawner, ActorSystem},
	context::{
		clock::{Clock, MockClock},
		rng::Rng,
	},
	version_epoch::VersionEpoch,
};
use reifydb_store_multi::MultiStore;
use reifydb_value::{Result, value::duration::Duration};
use tracing::{instrument, warn};
use version::{StandardVersionProvider, VersionProvider};

pub(crate) use crate::multi::oracle::Oracle;
use crate::{TransactionId, error::TransactionError, multi::types::*, single::SingleTransaction};

pub mod manager;
pub mod read;
pub(crate) mod version;
pub mod write;

use reifydb_store_single::SingleStore;

use crate::multi::{
	MultiReadTransaction, MultiWriteTransaction,
	lease::{VersionLeaseGuard, VersionLeases},
	transaction::manager::TransactionManagerQuery,
};

pub struct TransactionManager<L>
where
	L: VersionProvider,
{
	inner: Arc<Oracle<L>>,
}

impl<L> Clone for TransactionManager<L>
where
	L: VersionProvider,
{
	fn clone(&self) -> Self {
		Self {
			inner: self.inner.clone(),
		}
	}
}

impl<L> TransactionManager<L>
where
	L: VersionProvider,
{
	#[allow(clippy::too_many_arguments)]
	#[instrument(
		name = "transaction::manager::new",
		level = "debug",
		skip(clock, spawner, store, metrics_clock, version_epoch, rng, config)
	)]
	pub fn new(
		clock: L,
		spawner: ActorSpawner,
		store: Arc<dyn MultiVersionCommit>,
		metrics_clock: Clock,
		version_epoch: VersionEpoch,
		rng: Rng,
		config: Arc<dyn GetConfig>,
	) -> Result<Self>
	where
		L: 'static,
	{
		let version = clock.next()?;
		let oracle = Oracle::new(clock, spawner, store, metrics_clock, version_epoch, rng, config);
		oracle.query.advance_to(version);
		oracle.command.advance_to(version);
		Ok(Self {
			inner: Arc::new(oracle),
		})
	}

	pub fn spawner(&self) -> ActorSpawner {
		self.inner.spawner()
	}

	pub fn config(&self) -> Arc<dyn GetConfig> {
		self.inner.config()
	}

	pub(crate) fn oracle(&self) -> &Arc<Oracle<L>> {
		&self.inner
	}

	pub fn bootstrapping_completed(&self) {
		self.inner.bootstrapping_completed();
	}

	#[instrument(name = "transaction::manager::version", level = "trace", skip(self))]
	pub fn version(&self) -> Result<CommitVersion> {
		self.inner.version()
	}
}

impl<L> TransactionManager<L>
where
	L: VersionProvider,
{
	#[instrument(name = "transaction::manager::query", level = "debug", skip(self), fields(as_of_version = ?version))]
	pub fn query(&self, version: Option<CommitVersion>) -> Result<TransactionManagerQuery<L>> {
		Ok(if let Some(version) = version {
			let safe_version = self.inner.version()?;
			if version > safe_version {
				return Err(TransactionError::SnapshotVersionEvicted {
					version,
					cutoff: safe_version,
				}
				.into());
			}
			TransactionManagerQuery::new_time_travel(
				TransactionId::generate(self.inner.metrics_clock(), self.inner.rng()),
				self.clone(),
				version,
			)
		} else {
			let safe_version = self.inner.query.register_in_flight_with(|| self.inner.version())?;
			TransactionManagerQuery::new_current(
				TransactionId::generate(self.inner.metrics_clock(), self.inner.rng()),
				self.clone(),
				safe_version,
			)
		})
	}

	pub fn begin_commit(&self, version: CommitVersion) {
		self.inner.command.register_in_flight(version);
	}

	pub fn done_commit(&self, version: CommitVersion) {
		self.inner.done_commit(version);
	}

	#[instrument(name = "transaction::manager::done_until", level = "trace", skip(self))]
	pub fn done_until(&self) -> CommitVersion {
		self.inner.command.done_until()
	}

	#[instrument(name = "transaction::manager::query_done_until", level = "trace", skip(self))]
	pub fn query_done_until(&self) -> CommitVersion {
		self.inner.query.done_until()
	}

	#[instrument(name = "transaction::manager::wait_for_mark_timeout", level = "trace", skip(self))]
	pub fn wait_for_mark_timeout(&self, version: CommitVersion, timeout: Duration) -> bool {
		self.inner.command.wait_for_mark_timeout(version, timeout)
	}

	pub fn notify_on_mark(&self, version: CommitVersion, callback: Box<dyn FnOnce() + Send>) {
		self.inner.command.notify_on_mark(version, callback);
	}

	pub fn advance_version_to(&self, version: CommitVersion) {
		self.inner.clock.advance_to(version);
		self.inner.command.advance_to(version);
		self.inner.query.advance_to(version);
	}

	pub fn leases(&self) -> Arc<VersionLeases> {
		self.inner.leases.clone()
	}

	pub fn acquire_version_lease(&self, version: CommitVersion) -> Result<VersionLeaseGuard> {
		self.inner.leases.try_acquire(version, self.inner.query.done_until())
	}

	pub fn acquire_current_snapshot_lease(&self) -> Result<(CommitVersion, VersionLeaseGuard)> {
		let oracle = self.inner.clone();
		let (guard, version) = oracle.leases.try_acquire_with(|| {
			let version = oracle.version()?;
			let qdu = oracle.query.done_until();
			Ok((version, qdu, version))
		})?;
		Ok((version, guard))
	}
}

pub struct MultiTransaction(Arc<Inner>);

pub struct Inner {
	pub(crate) tm: TransactionManager<StandardVersionProvider>,
	pub(crate) store: MultiStore,
	pub(crate) event_bus: EventBus,
}

impl Deref for MultiTransaction {
	type Target = Inner;

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

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

impl Inner {
	#[allow(clippy::too_many_arguments)]
	fn new(
		store: MultiStore,
		single: SingleTransaction,
		event_bus: EventBus,
		spawner: ActorSpawner,
		metrics_clock: Clock,
		version_epoch: VersionEpoch,
		rng: Rng,
		config: Arc<dyn GetConfig>,
	) -> Result<Self> {
		let version_provider = StandardVersionProvider::new(single)?;
		let tm = TransactionManager::new(
			version_provider,
			spawner,
			Arc::new(store.clone()),
			metrics_clock,
			version_epoch,
			rng,
			config,
		)?;

		Ok(Self {
			tm,
			store,
			event_bus,
		})
	}

	fn version(&self) -> Result<CommitVersion> {
		self.tm.version()
	}

	fn spawner(&self) -> ActorSpawner {
		self.tm.spawner()
	}

	fn bootstrapping_completed(&self) {
		self.tm.bootstrapping_completed();
	}
}

impl MultiTransaction {
	pub fn oracle_window_count(&self) -> usize {
		self.tm.oracle().window_count()
	}

	pub fn testing() -> Self {
		let multi_store = MultiStore::testing_memory();
		let single_store = SingleStore::testing_memory();
		let actor_system = ActorSystem::testing(Clock::Real);
		let spawner = actor_system.spawner();
		let event_bus = EventBus::new(&spawner);

		let config = Arc::new(ProfileConfig);

		Self::new(
			multi_store,
			SingleTransaction::new(single_store, event_bus.clone()),
			event_bus,
			spawner,
			Clock::Mock(MockClock::from_millis(1000)),
			VersionEpoch::new(),
			Rng::seeded(42),
			config,
		)
		.expect("failed to create testing MultiTransaction")
	}
}

impl MultiTransaction {
	#[instrument(
		name = "transaction::new",
		level = "debug",
		skip(store, single, event_bus, spawner, metrics_clock, version_epoch, rng, config)
	)]
	#[allow(clippy::too_many_arguments)]
	pub fn new(
		store: MultiStore,
		single: SingleTransaction,
		event_bus: EventBus,
		spawner: ActorSpawner,
		metrics_clock: Clock,
		version_epoch: VersionEpoch,
		rng: Rng,
		config: Arc<dyn GetConfig>,
	) -> Result<Self> {
		Ok(Self(Arc::new(Inner::new(
			store,
			single,
			event_bus,
			spawner,
			metrics_clock,
			version_epoch,
			rng,
			config,
		)?)))
	}

	pub fn spawner(&self) -> ActorSpawner {
		self.0.spawner()
	}

	pub fn config(&self) -> Arc<dyn GetConfig> {
		self.0.tm.config()
	}

	pub fn advance_version_to(&self, version: CommitVersion) {
		self.0.tm.advance_version_to(version);
	}

	pub fn bootstrapping_completed(&self) {
		self.0.bootstrapping_completed();
	}

	#[instrument(name = "transaction::query_done_until", level = "trace", skip(self))]
	pub fn query_done_until(&self) -> CommitVersion {
		self.0.tm.query_done_until()
	}
}

impl MultiTransaction {
	#[instrument(name = "transaction::version", level = "trace", skip(self))]
	pub fn version(&self) -> Result<CommitVersion> {
		self.0.version()
	}

	#[instrument(name = "transaction::begin_query", level = "trace", skip(self))]
	pub fn begin_query(&self) -> Result<MultiReadTransaction> {
		MultiReadTransaction::new(self.clone(), None)
	}

	#[instrument(name = "transaction::begin_query_at_version", level = "trace", skip(self, lease), fields(version = %lease.version().0))]
	pub fn begin_query_at_version(&self, lease: &VersionLeaseGuard) -> Result<MultiReadTransaction> {
		MultiReadTransaction::new_with_lease(self.clone(), lease.clone())
	}

	pub fn acquire_version_lease(&self, version: CommitVersion) -> Result<VersionLeaseGuard> {
		self.0.tm.acquire_version_lease(version)
	}

	pub fn acquire_current_snapshot_lease(&self) -> Result<(CommitVersion, VersionLeaseGuard)> {
		self.0.tm.acquire_current_snapshot_lease()
	}

	pub fn leases(&self) -> Arc<VersionLeases> {
		self.0.tm.leases()
	}
}

impl MultiTransaction {
	#[instrument(name = "transaction::begin_command", level = "debug", skip(self))]
	pub fn begin_command(&self) -> Result<MultiWriteTransaction> {
		MultiWriteTransaction::new(self.clone())
	}
}

pub enum TransactionType {
	Query(MultiReadTransaction),
	Command(Box<MultiWriteTransaction>),
}

impl MultiTransaction {
	#[instrument(name = "transaction::get", level = "trace", skip(self, key), fields(version = version.0))]
	pub fn get(&self, key: &TaggedKey, version: CommitVersion) -> Result<Option<Committed>> {
		Ok(MultiVersionGet::get(&self.store, key, version)?.map(|sv| sv.into()))
	}

	#[instrument(name = "transaction::contains_key", level = "trace", skip(self, key), fields(version = version.0))]
	pub fn contains_key(&self, key: &TaggedKey, version: CommitVersion) -> Result<bool> {
		MultiVersionContains::contains(&self.store, key, version)
	}

	pub fn store(&self) -> &MultiStore {
		&self.store
	}
}