mosaik 0.3.17

use {
	super::{
		CollectionConfig,
		CollectionFromDef,
		Error,
		READER,
		SyncConfig,
		WRITER,
		When,
		primitives::{Key, StoreId, Value, Version},
		sync::{
			Snapshot,
			SnapshotStateMachine,
			SnapshotSync,
			protocol::SnapshotRequest,
		},
	},
	crate::{
		Group,
		Network,
		PeerId,
		UniqueId,
		groups::*,
		primitives::{EncodeError, Encoded, Short, ShortFmtExt, UnboundedChannel},
	},
	chrono::{DateTime, Utc},
	core::{any::type_name, cmp::Ordering, ops::Range},
	futures::{FutureExt, TryFutureExt},
	serde::{Deserialize, Serialize},
	std::sync::OnceLock,
	tokio::sync::{broadcast, mpsc::UnboundedSender, watch},
};

/// Mutable access to a replicated vector.
///
/// Has higher priority for assuming group leadership.
pub type VecWriter<T> = Vec<T, WRITER>;

/// Read-only access to a vector.
///
/// Has lower priority for assuming group leadership.
pub type VecReader<T> = Vec<T, READER>;

/// Replicated ordered, index-addressable sequence.
pub struct Vec<T: Value, const IS_WRITER: bool = WRITER> {
	when: When,
	group: Group<VecStateMachine<T>>,
	data: watch::Receiver<im::Vector<T>>,
}

// read-only access, available to both readers and writers
impl<T: Value, const IS_WRITER: bool> Vec<T, IS_WRITER> {
	/// Create a new vector in reader mode.
	///
	/// The returned reader provides read-only access to the vector's contents.
	/// Readers can be used by multiple nodes concurrently, and they will see all
	/// changes made by any writer. However, readers cannot modify the vector, and
	/// they will not be able to make any changes themselves. Readers have longer
	/// election timeouts to reduce the likelihood of them being elected as
	/// group leaders, which reduces latency for read operations.
	///
	/// This creates a new vector with the specified sync configuration. If you
	/// want to use the default sync configuration, use the `reader` method
	/// instead.
	///
	/// Note that different sync configurations will create different groups ids
	/// and the resulting vectors will not be able to see each other. Make sure
	/// that the sync configuration used for readers is compatible with the sync
	/// configuration used for writers, otherwise the readers will not see any of
	/// the writers' changes.
	pub fn reader_with_config(
		network: &Network,
		store_id: impl Into<StoreId>,
		config: impl Into<CollectionConfig>,
	) -> Self {
		Vec::<T, READER>::create(network, store_id, config.into())
	}

	/// Create a new vector in reader mode.
	///
	/// The returned reader provides read-only access to the vector's contents.
	/// Readers can be used by multiple nodes concurrently, and they will see all
	/// changes made by any writer. However, readers cannot modify the vector, and
	/// they will not be able to make any changes themselves. Readers have longer
	/// election timeouts to reduce the likelihood of them being elected as
	/// group leaders, which reduces latency for read operations.
	///
	/// This creates a new vector with the default sync configuration. If you want
	/// to specify a custom sync configuration, use the `reader_with_config`
	/// method instead.
	pub fn reader(network: &Network, store_id: impl Into<StoreId>) -> Self {
		Self::reader_with_config(network, store_id, CollectionConfig::default())
	}

	/// Get the length of a vector.
	///
	/// Time: O(1)
	pub fn len(&self) -> usize {
		self.data.borrow().len()
	}

	/// Test whether a vector is empty.
	///
	/// Time: O(1)
	pub fn is_empty(&self) -> bool {
		self.data.borrow().is_empty()
	}

	/// Get the last element of a vector.
	///
	/// If the vector is empty, `None` is returned.
	///
	/// Time: O(log n)
	pub fn back(&self) -> Option<T> {
		self.data.borrow().back().cloned()
	}

	/// Get the last element of a vector.
	///
	/// If the vector is empty, `None` is returned.
	///
	/// This is an alias for the [`back`](Self::back) method.
	///
	/// Time: O(log n)
	pub fn last(&self) -> Option<T> {
		self.data.borrow().last().cloned()
	}

	/// Get the first element of a vector.
	///
	/// If the vector is empty, `None` is returned.
	///
	/// Time: O(log n)
	pub fn front(&self) -> Option<T> {
		self.data.borrow().front().cloned()
	}

	/// Get the first element of a vector.
	///
	/// If the vector is empty, `None` is returned.
	///
	/// This is an alias for the [`front`](Self::front) method.
	///
	/// Time: O(log n)
	pub fn head(&self) -> Option<T> {
		self.data.borrow().head().cloned()
	}

	/// Get a clone of the value at index `index` in a vector.
	///
	/// Returns `None` if the index is out of bounds.
	///
	/// Time: O(log n)
	pub fn get(&self, index: u64) -> Option<T> {
		self.data.borrow().get(index as usize).cloned()
	}

	/// Get an iterator over a vector.
	pub fn iter(&self) -> impl Iterator<Item = T> {
		let iter_clone = self.data.borrow().clone();
		iter_clone.into_iter()
	}

	/// Returns an observer of the vector's state, which can be used to wait for
	/// the vector to reach a certain state version before performing an action
	/// or knowing when it is online or offline.
	pub const fn when(&self) -> &When {
		&self.when
	}

	/// The current version of the vector's state, which is the version of the
	/// latest committed state.
	pub fn version(&self) -> Version {
		Version(self.group.committed())
	}

	/// The group id of the underlying consensus group for this collection
	/// instance.
	pub fn group_id(&self) -> &GroupId {
		self.group.id()
	}
}

impl<T: Value + PartialEq, const IS_WRITER: bool> Vec<T, IS_WRITER> {
	/// Test if a given element is in the vector.
	///
	/// Searches the vector for the first occurrence of a given value,
	/// and returns `true` if it's there. If it's nowhere to be found
	/// in the vector, it returns `false`.
	///
	/// Time: O(n)
	pub fn contains(&self, value: &T) -> bool {
		self.data.borrow().clone().contains(value)
	}

	/// Get the index of a given element in the vector.
	///
	/// Searches the vector for the first occurrence of a given value,
	/// and returns the index of the value if it's there. Otherwise,
	/// it returns `None`.
	///
	/// Time: O(n)
	pub fn index_of(&self, value: &T) -> Option<u64> {
		self.data.borrow().clone().index_of(value).map(|i| i as u64)
	}
}

// Mutable operations, only available to writers
impl<T: Value> VecWriter<T> {
	/// Create a new vector in writer mode.
	///
	/// The returned writer can be used to modify the vector, and it also provides
	/// read access to the vector's contents. Writers can be used by multiple
	/// nodes concurrently, and all changes made by any writer will be replicated
	/// to all other writers and readers.
	///
	/// This create a new vector with the default sync configuration. If you want
	/// to specify a custom sync configuration, use the `writer_with_sync_config`
	/// method instead.
	///
	/// Note that different sync configurations will create different groups ids
	/// and the resulting vectors will not be able to see each other.
	pub fn writer(network: &Network, store_id: impl Into<StoreId>) -> Self {
		Self::writer_with_config(network, store_id, CollectionConfig::default())
	}

	/// Create a new vector in writer mode.
	///
	/// The returned writer can be used to modify the vector, and it also provides
	/// read access to the vector's contents. Writers can be used by multiple
	/// nodes concurrently, and all changes made by any writer will be replicated
	/// to all other writers and readers.
	///
	/// This create a new vector with the specified configuration. If you
	/// want to use the default configuration, use the `writer` method
	/// instead.
	///
	/// Note that different configurations will create different groups ids
	/// and the resulting vectors will not be able to see each other.
	pub fn writer_with_config(
		network: &Network,
		store_id: impl Into<StoreId>,
		config: impl Into<CollectionConfig>,
	) -> Self {
		Self::create::<WRITER>(network, store_id, config.into())
	}

	/// Create a new vector in writer mode.
	///
	/// This is an alias for the `writer` method.
	pub fn new(network: &Network, store_id: impl Into<StoreId>) -> Self {
		Self::writer(network, store_id)
	}

	/// Create a new vector in writer mode with the specified configuration.
	///
	/// This is an alias for the `writer_with_config` method.
	pub fn new_with_config(
		network: &Network,
		store_id: impl Into<StoreId>,
		config: impl Into<CollectionConfig>,
	) -> Self {
		Self::writer_with_config(network, store_id, config)
	}

	/// Discard all elements from the vector.
	///
	/// This leaves you with an empty vector, and all elements that
	/// were previously inside it are dropped.
	pub fn clear(
		&self,
	) -> impl Future<Output = Result<Version, Error<()>>> + Send + Sync + 'static
	{
		self.execute(
			VecCommand::Clear,
			|_| Error::Offline(()),
			|_, _| unreachable!(),
		)
	}

	/// Push a value to the back of a vector.
	///
	/// Time: O(1)*
	pub fn push_back(
		&self,
		value: T,
	) -> impl Future<Output = Result<Version, Error<T>>> + Send + Sync + 'static
	{
		let value = Encoded(value);
		self.execute(
			VecCommand::PushBack { value },
			|cmd| match cmd {
				VecCommand::PushBack { value } => Error::Offline(value.0),
				_ => unreachable!(),
			},
			|cmd, e| match cmd {
				VecCommand::PushBack { value } => Error::Encoding(value.0, e),
				_ => unreachable!(),
			},
		)
	}

	/// Push a value to the front of a vector.
	///
	/// Time: O(1)*
	pub fn push_front(
		&self,
		value: T,
	) -> impl Future<Output = Result<Version, Error<T>>> + Send + Sync + 'static
	{
		let value = Encoded(value);
		self.execute(
			VecCommand::PushFront { value },
			|cmd| match cmd {
				VecCommand::PushFront { value } => Error::Offline(value.0),
				_ => unreachable!(),
			},
			|cmd, e| match cmd {
				VecCommand::PushFront { value } => Error::Encoding(value.0, e),
				_ => unreachable!(),
			},
		)
	}

	/// Swap the elements at indices `i` and `j`.
	pub fn swap(
		&self,
		i: u64,
		j: u64,
	) -> impl Future<Output = Result<Version, Error<()>>> + Send + Sync + 'static
	{
		self.execute(
			VecCommand::Swap { i, j },
			|_| Error::Offline(()),
			|_, _| unreachable!(),
		)
	}

	/// Insert an element into a vector.
	///
	/// Insert an element at position `index`, shifting all elements
	/// after it to the right.
	pub fn insert(
		&self,
		index: u64,
		value: T,
	) -> impl Future<Output = Result<Version, Error<T>>> + Send + Sync + 'static
	{
		let value = Encoded(value);
		self.execute(
			VecCommand::Insert { index, value },
			|cmd| match cmd {
				VecCommand::Insert { value, .. } => Error::Offline(value.0),
				_ => unreachable!(),
			},
			|cmd, e| match cmd {
				VecCommand::Insert { value, .. } => Error::Encoding(value.0, e),
				_ => unreachable!(),
			},
		)
	}

	/// Append multiple values to the back of a vector.
	pub fn extend(
		&self,
		entries: impl IntoIterator<Item = T>,
	) -> impl Future<Output = Result<Version, Error<std::vec::Vec<T>>>>
	+ Send
	+ Sync
	+ 'static {
		let entries: std::vec::Vec<Encoded<T>> =
			entries.into_iter().map(Encoded).collect();

		let is_empty = entries.is_empty();
		let current_version = self.group.committed();
		let fut = self.execute(
			VecCommand::Extend { entries },
			|cmd| match cmd {
				VecCommand::Extend { entries } => {
					Error::Offline(entries.into_iter().map(|e| e.0).collect())
				}
				_ => unreachable!(),
			},
			|cmd, e| match cmd {
				VecCommand::Extend { entries } => {
					Error::Encoding(entries.into_iter().map(|e| e.0).collect(), e)
				}
				_ => unreachable!(),
			},
		);

		async move {
			if is_empty {
				Ok(Version(current_version))
			} else {
				fut.await
			}
		}
	}

	/// Remove the last element from a vector and return it.
	///
	/// Time: O(1)*
	pub fn pop_back(
		&self,
	) -> impl Future<Output = Result<Version, Error<()>>> + Send + Sync + 'static
	{
		self.execute(
			VecCommand::PopBack,
			|_| Error::Offline(()),
			|_, _| unreachable!(),
		)
	}

	/// Remove the first element from a vector and return it.
	///
	/// Time: O(1)*
	pub fn pop_front(
		&self,
	) -> impl Future<Output = Result<Version, Error<()>>> + Send + Sync + 'static
	{
		self.execute(
			VecCommand::PopFront,
			|_| Error::Offline(()),
			|_, _| unreachable!(),
		)
	}

	/// Remove an element from a vector.
	///
	/// Remove the element from position 'index', shifting all
	/// elements after it to the left, and return the removed element.
	pub fn remove(
		&self,
		index: u64,
	) -> impl Future<Output = Result<Version, Error<u64>>> + Send + Sync + 'static
	{
		self.execute(
			VecCommand::Remove { index },
			|cmd| match cmd {
				VecCommand::Remove { index } => Error::Offline(index),
				_ => unreachable!(),
			},
			|_, _| unreachable!(),
		)
	}

	/// Truncate a vector to the given size.
	///
	/// Discards all elements in the vector beyond the given length.
	///
	/// Time: O(log n)
	pub fn truncate(
		&self,
		len: usize,
	) -> impl Future<Output = Result<Version, Error<()>>> + Send + Sync + 'static
	{
		let len = len as u64;
		self.execute(
			VecCommand::Truncate { len },
			|_| Error::Offline(()),
			|_, _| unreachable!(),
		)
	}
}

// construction
impl<T: Value, const IS_WRITER: bool> Vec<T, IS_WRITER> {
	fn create<const W: bool>(
		network: &Network,
		store_id: impl Into<StoreId>,
		config: CollectionConfig,
	) -> Vec<T, W> {
		let store_id = store_id.into();
		let machine = VecStateMachine::new(
			store_id, //
			W,
			config.sync,
			network.local().id(),
		);

		let data = machine.data();
		let mut builder = network
			.groups()
			.with_key(store_id)
			.with_state_machine(machine);

		for validator in config.auth {
			builder = builder.require_ticket(validator);
		}

		let group = builder.join();
		let when = When::new(group.when().clone());

		Vec::<T, W> { when, group, data }
	}
}

impl<T: Value, const WRITER: bool> CollectionFromDef for Vec<T, WRITER> {
	type Reader = VecReader<T>;
	type Writer = VecWriter<T>;

	fn reader_with_config(
		network: &Network,
		store_id: StoreId,
		config: CollectionConfig,
	) -> Self::Reader {
		Self::Reader::reader_with_config(network, store_id, config)
	}

	fn writer_with_config(
		network: &Network,
		store_id: StoreId,
		config: CollectionConfig,
	) -> Self::Writer {
		Self::Writer::writer_with_config(network, store_id, config)
	}
}

// internal
impl<T: Value> Vec<T, WRITER> {
	fn execute<TErr>(
		&self,
		command: VecCommand<T>,
		offline_err: impl FnOnce(VecCommand<T>) -> Error<TErr> + Send + Sync + 'static,
		encoding_err: impl FnOnce(VecCommand<T>, EncodeError) -> Error<TErr>
		+ Send
		+ Sync
		+ 'static,
	) -> impl Future<Output = Result<Version, Error<TErr>>> + Send + Sync + 'static
	{
		self
			.group
			.execute(command)
			.map_err(|e| match e {
				CommandError::Offline(mut items) => {
					let command = items.remove(0);
					offline_err(command)
				}
				CommandError::Encoding(mut items, e) => {
					let command = items.remove(0);
					encoding_err(command, e)
				}
				CommandError::GroupTerminated => Error::NetworkDown,
				CommandError::NoCommands => unreachable!(),
			})
			.map(|position| position.map(Version))
	}
}

struct VecStateMachine<T: Value> {
	data: im::Vector<T>,
	latest: watch::Sender<im::Vector<T>>,
	store_id: StoreId,
	is_writer: bool,
	state_sync: SnapshotSync<Self>,
	local_id: PeerId,
	metrics_labels: OnceLock<[(&'static str, String); 2]>,
}

impl<T: Value> VecStateMachine<T> {
	pub fn new(
		store_id: StoreId,
		is_writer: bool,
		sync_config: SyncConfig,
		local_id: PeerId,
	) -> Self {
		let data = im::Vector::new();
		let state_sync = SnapshotSync::new(sync_config, |request| {
			VecCommand::TakeSnapshot(request)
		});
		let latest = watch::Sender::new(data.clone());

		Self {
			data,
			latest,
			store_id,
			is_writer,
			state_sync,
			local_id,
			metrics_labels: OnceLock::new(),
		}
	}

	pub fn data(&self) -> watch::Receiver<im::Vector<T>> {
		self.latest.subscribe()
	}
}

impl<T: Value> StateMachine for VecStateMachine<T> {
	type Command = VecCommand<T>;
	type Query = ();
	type QueryResult = ();
	type StateSync = SnapshotSync<Self>;

	fn apply(&mut self, command: Self::Command, ctx: &dyn ApplyContext) {
		self.apply_batch([command], ctx);
	}

	fn apply_batch(
		&mut self,
		commands: impl IntoIterator<Item = Self::Command>,
		ctx: &dyn ApplyContext,
	) {
		let mut commands_len = 0usize;
		let mut sync_requests = vec![];

		for command in commands {
			match command {
				VecCommand::Clear => {
					self.data.clear();
				}
				VecCommand::Swap { i, j } => {
					if i < self.data.len() as u64 && j < self.data.len() as u64 {
						self.data.swap(i as usize, j as usize);
					}
				}
				VecCommand::Insert { index, value } => {
					self.data.insert(index as usize, value.0);
				}
				VecCommand::PushBack { value } => {
					self.data.push_back(value.0);
				}
				VecCommand::PushFront { value } => {
					self.data.push_front(value.0);
				}
				VecCommand::PopBack => {
					self.data.pop_back();
				}
				VecCommand::PopFront => {
					self.data.pop_front();
				}
				VecCommand::Remove { index } => {
					if index < self.data.len() as u64 {
						self.data.remove(index as usize);
					}
				}
				VecCommand::Truncate { len } => {
					let len = len as usize;
					let len = len.min(self.data.len());
					self.data.truncate(len);
				}
				VecCommand::Extend { entries } => {
					self.data.extend(entries.into_iter().map(|e| e.0));
				}
				VecCommand::TakeSnapshot(request) => {
					if request.requested_by != self.local_id
						&& !self.state_sync.is_expired(&request)
					{
						// take note of the snapshot request, we will take the actual
						// snapshot after applying all commands from this batch.
						sync_requests.push(request);
					}
				}
			}

			commands_len += 1;
		}

		self.latest.send_replace(self.data.clone());

		let labels = self.metrics_labels.get_or_init(|| {
			[
				("network", ctx.network_id().short().to_string()),
				("group", ctx.group_id().short().to_string()),
			]
		});
		metrics::gauge!("mosaik.collections.vec.size", labels.as_slice())
			.set(self.data.len() as f64);

		if !sync_requests.is_empty() {
			let snapshot = self.create_snapshot();
			let position = Cursor::new(
				ctx.current_term(),
				ctx.committed().index() + commands_len as u64,
			);

			metrics::counter!("mosaik.collections.syncs.started", labels.as_slice())
				.increment(sync_requests.len() as u64);
			for request in sync_requests {
				self
					.state_sync
					.serve_snapshot(request, position, snapshot.clone());
			}
		}
	}

	/// The group-key for a vector is derived from the store ID and the type of
	/// the vector's elements. This ensures that different vectors (with different
	/// store IDs or element types) will be in different groups.
	fn signature(&self) -> crate::UniqueId {
		UniqueId::from("mosaik_collections_vec")
			.derive(self.store_id)
			.derive(type_name::<T>())
	}

	/// This state machine doesn't support external queries, because all of its
	/// state is observable through the `latest` watch channel. Therefore, the
	/// query method is a no-op.
	fn query(&self, (): Self::Query) {}

	/// This state machine uses the `SnapshotSync` state sync strategy.
	fn state_sync(&self) -> Self::StateSync {
		self.state_sync.clone()
	}

	/// Readers are observers and never assume group leadership.
	fn leadership_preference(&self) -> LeadershipPreference {
		if self.is_writer {
			LeadershipPreference::Normal
		} else {
			LeadershipPreference::Observer
		}
	}
}

impl<T: Value> SnapshotStateMachine for VecStateMachine<T> {
	type Snapshot = VecSnapshot<T>;

	fn create_snapshot(&self) -> Self::Snapshot {
		VecSnapshot {
			data: self.data.clone(),
		}
	}

	fn install_snapshot(&mut self, snapshot: Self::Snapshot) {
		self.data = snapshot.data;
		self.latest.send_replace(self.data.clone());
	}
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(bound = "T: Value")]
enum VecCommand<T> {
	Clear,
	Swap { i: u64, j: u64 },
	Insert { index: u64, value: Encoded<T> },
	PushBack { value: Encoded<T> },
	PushFront { value: Encoded<T> },
	PopBack,
	PopFront,
	Remove { index: u64 },
	Truncate { len: u64 },
	Extend { entries: std::vec::Vec<Encoded<T>> },
	TakeSnapshot(SnapshotRequest),
}

#[derive(Debug, Clone)]
pub struct VecSnapshot<T: Value> {
	data: im::Vector<T>,
}

impl<T: Value> Snapshot for VecSnapshot<T> {
	type Item = Encoded<T>;

	fn len(&self) -> u64 {
		self.data.len() as u64
	}

	fn iter_range(
		&self,
		range: Range<u64>,
	) -> Option<impl Iterator<Item = Self::Item>> {
		let skip = range.start as usize;
		let take = (range.end - range.start) as usize;

		if skip + take > self.data.len() {
			return None;
		}

		Some(self.data.skip(skip).take(take).into_iter().map(Encoded))
	}

	fn append(&mut self, items: impl IntoIterator<Item = Self::Item>) {
		self.data.extend(items.into_iter().map(|e| e.0));
	}
}

impl<T: Value> Default for VecSnapshot<T> {
	fn default() -> Self {
		Self {
			data: im::Vector::new(),
		}
	}
}