//! Generic COB storage. #![allow(clippy::large_enum_variant)] #![allow(clippy::type_complexity)] use std::fmt::Debug; use std::marker::PhantomData; use nonempty::NonEmpty; use serde::{Deserialize, Serialize}; use crate::cob::op::Op; use crate::cob::{Create, Embed, EntryId, ObjectId, TypeName, Update, Updated, Version}; use crate::git; use crate::prelude::*; use crate::storage::git as storage; use crate::storage::SignRepository; use crate::{cob, identity}; pub trait CobAction: Debug { /// Parent objects this action depends on. For example, patch revisions /// have the commit objects as their parent. fn parents(&self) -> Vec { Vec::new() } } /// A collaborative object. Can be materialized from an operation history. pub trait Cob: Sized + PartialEq + Debug { /// The underlying action composing each operation. type Action: CobAction + for<'de> Deserialize<'de> + Serialize; /// Error returned by `apply` function. type Error: std::error::Error + Send + Sync + 'static; /// The object type name. fn type_name() -> &'static TypeName; /// Initialize a collarorative object from a root operation. fn from_root(op: Op, repo: &R) -> Result; /// Apply an operation to the state. fn op( &mut self, op: Op, repo: &R, ) -> Result<(), ::Error>; #[cfg(test)] /// Create an object from a history. fn from_history( history: &crate::cob::History, repo: &R, ) -> Result> { test::from_history::(history, repo) } #[cfg(test)] /// Create an object from individual operations. /// Returns an error if any of the operations fails to apply. fn from_ops( ops: impl IntoIterator>, repo: &R, ) -> Result { let mut ops = ops.into_iter(); let Some(init) = ops.next() else { panic!("FromHistory::from_ops: operations list is empty"); }; let mut state = Self::from_root(init, repo)?; for op in ops { state.op(op, repo)?; } Ok(state) } } /// Store error. #[derive(Debug, thiserror::Error)] pub enum Error { #[error("create error: {0}")] Create(#[from] cob::error::Create), #[error("update error: {0}")] Update(#[from] cob::error::Update), #[error("retrieve error: {0}")] Retrieve(#[from] cob::error::Retrieve), #[error("remove error: {0}")] Remove(#[from] cob::error::Remove), #[error(transparent)] Identity(#[from] identity::doc::DocError), #[error(transparent)] Serialize(#[from] serde_json::Error), #[error("object `{1}` of type `{0}` was not found")] NotFound(TypeName, ObjectId), #[error("signed refs: {0}")] SignRefs(#[from] storage::Error), #[error("failed to find reference '{name}': {err}")] RefLookup { name: git::RefString, #[source] err: git::Error, }, } /// Storage for collaborative objects of a specific type `T` in a single repository. pub struct Store<'a, T, R> { identity: Option, repo: &'a R, witness: PhantomData, } impl<'a, T, R> AsRef for Store<'a, T, R> { fn as_ref(&self) -> &R { self.repo } } impl<'a, T, R: ReadRepository + cob::Store> Store<'a, T, R> { /// Open a new generic store. pub fn open(repo: &'a R) -> Result { Ok(Self { repo, identity: None, witness: PhantomData, }) } /// Return a new store with the attached identity. pub fn identity(self, identity: git::Oid) -> Self { Self { repo: self.repo, witness: self.witness, identity: Some(identity), } } } impl<'a, T, R> Store<'a, T, R> where R: ReadRepository + SignRepository + cob::Store, T: Cob + cob::Evaluate, T::Action: Serialize, { /// Update an object. pub fn update( &self, object_id: ObjectId, message: &str, actions: impl Into>, embeds: Vec, signer: &G, ) -> Result, Error> { let actions = actions.into(); let parents = actions.iter().flat_map(T::Action::parents).collect(); let changes = actions.try_map(encoding::encode)?; let updated = cob::update( self.repo, signer, self.identity, parents, signer.public_key(), Update { object_id, type_name: T::type_name().clone(), message: message.to_owned(), embeds, changes, }, )?; self.repo.sign_refs(signer).map_err(Error::SignRefs)?; Ok(updated) } /// Create an object. pub fn create( &self, message: &str, actions: impl Into>, embeds: Vec, signer: &G, ) -> Result<(ObjectId, T), Error> { let actions = actions.into(); let parents = actions.iter().flat_map(T::Action::parents).collect(); let contents = actions.try_map(encoding::encode)?; let cob = cob::create::( self.repo, signer, self.identity, parents, signer.public_key(), Create { type_name: T::type_name().clone(), version: Version::default(), message: message.to_owned(), embeds, contents, }, )?; self.repo.sign_refs(signer).map_err(Error::SignRefs)?; Ok((*cob.id(), cob.object)) } /// Remove an object. pub fn remove(&self, id: &ObjectId, signer: &G) -> Result<(), Error> { let name = git::refs::storage::cob(signer.public_key(), T::type_name(), id); match self .repo .reference_oid(signer.public_key(), &name.strip_namespace()) { Ok(_) => { cob::remove(self.repo, signer.public_key(), T::type_name(), id)?; self.repo.sign_refs(signer).map_err(Error::SignRefs)?; Ok(()) } Err(git::Error::NotFound(_)) => Ok(()), Err(git::Error::Git(err)) if err.code() == git::raw::ErrorCode::NotFound => Ok(()), Err(err) => Err(Error::RefLookup { name: name.to_ref_string(), err, }), } } } impl<'a, T, R> Store<'a, T, R> where R: ReadRepository + cob::Store, T: cob::Evaluate + Cob, T::Action: Serialize, { /// Get an object. pub fn get(&self, id: &ObjectId) -> Result, Error> { cob::get::(self.repo, T::type_name(), id) .map(|r| r.map(|cob| cob.object)) .map_err(Error::from) } /// Return all objects. pub fn all(&self) -> Result> + 'a, Error> { let raw = cob::list::(self.repo, T::type_name())?; Ok(raw.into_iter().map(|o| Ok((*o.id(), o.object)))) } /// Return true if the list of issues is empty. pub fn is_empty(&self) -> Result { Ok(self.count()? == 0) } /// Return objects count. pub fn count(&self) -> Result { let raw = cob::list::(self.repo, T::type_name())?; Ok(raw.len()) } } /// Allows operations to be batched atomically. #[derive(Debug)] pub struct Transaction, R> { actions: Vec, embeds: Vec, repo: PhantomData, } impl, R> Default for Transaction { fn default() -> Self { Self { actions: Vec::new(), embeds: Vec::new(), repo: PhantomData, } } } impl, R> Transaction { /// Create a new transaction to be used as the initial set of operations for a COB. pub fn initial( message: &str, store: &mut Store, signer: &G, operations: F, ) -> Result<(ObjectId, T), Error> where G: Signer, F: FnOnce(&mut Self) -> Result<(), Error>, R: ReadRepository + SignRepository + cob::Store, T::Action: Serialize + Clone, { let mut tx = Transaction::default(); operations(&mut tx)?; let actions = NonEmpty::from_vec(tx.actions) .expect("Transaction::initial: transaction must contain at least one action"); store.create(message, actions, tx.embeds, signer) } /// Add an operation to this transaction. pub fn push(&mut self, action: T::Action) -> Result<(), Error> { self.actions.push(action); Ok(()) } /// Embed media into the transaction. pub fn embed(&mut self, embeds: impl IntoIterator) -> Result<(), Error> { self.embeds.extend(embeds); Ok(()) } /// Commit transaction. /// /// Returns an operation that can be applied onto an in-memory state. pub fn commit( self, msg: &str, id: ObjectId, store: &mut Store, signer: &G, ) -> Result<(T, EntryId), Error> where R: ReadRepository + SignRepository + cob::Store, T::Action: Serialize + Clone, { let actions = NonEmpty::from_vec(self.actions) .expect("Transaction::commit: transaction must not be empty"); let Updated { head, object, .. } = store.update(id, msg, actions, self.embeds, signer)?; Ok((object.object, head)) } } /// Get an object's operations without decoding them. pub fn ops( id: &ObjectId, type_name: &TypeName, repo: &R, ) -> Result>>, Error> { let cob = cob::get::, _>(repo, type_name, id)?; if let Some(cob) = cob { Ok(cob.object.map(Op::from)) } else { Err(Error::NotFound(type_name.clone(), *id)) } } pub mod encoding { use serde::Serialize; use crate::canonical::formatter::CanonicalFormatter; /// Serialize the change into a byte string. pub fn encode(action: A) -> Result, serde_json::Error> { let mut buf = Vec::new(); let mut serializer = serde_json::Serializer::with_formatter(&mut buf, CanonicalFormatter::new()); action.serialize(&mut serializer)?; Ok(buf) } } #[cfg(test)] pub mod test { use super::*; #[derive(Debug, thiserror::Error)] pub enum HistoryError { #[error("apply: {0}")] Apply(T::Error), #[error("operation decoding failed: {0}")] Op(#[from] cob::op::OpEncodingError), } /// Turn a history into a concrete type, by traversing the history and applying each operation /// to the state, skipping branches that return errors. pub fn from_history( history: &crate::cob::History, repo: &R, ) -> Result> { use std::ops::ControlFlow; let root = history.root(); let children = history.children_of(root.id()); let op = Op::try_from(root)?; let initial = T::from_root(op, repo).map_err(HistoryError::Apply)?; let obj = history.traverse(initial, &children, |mut acc, _, entry| { match Op::try_from(entry) { Ok(op) => { if let Err(err) = acc.op(op, repo) { log::warn!("Error applying op to `{}` state: {err}", T::type_name()); return ControlFlow::Break(acc); } } Err(err) => { log::warn!("Error decoding ops for `{}` state: {err}", T::type_name()); return ControlFlow::Break(acc); } } ControlFlow::Continue(acc) }); Ok(obj) } }