radicle-heartwood-lfs/radicle/src/cob/test.rs

use std::collections::{BTreeMap, BTreeSet};
use std::marker::PhantomData;
use std::ops::{ControlFlow, Deref};

use nonempty::NonEmpty;
use serde::Serialize;

use crate::cob::common::clock;
use crate::cob::op::{Op, Ops};
use crate::cob::patch;
use crate::cob::patch::Patch;
use crate::cob::store::encoding;
use crate::cob::History;
use crate::crypto::{PublicKey, Signer};
use crate::git;
use crate::git::Oid;
use crate::prelude::Did;
use crate::storage::ReadRepository;
use crate::test::arbitrary;

use super::store::FromHistory;

/// Convenience type for building histories.
#[derive(Debug, Clone)]
pub struct HistoryBuilder<T> {
    history: History,
    resource: Oid,
    witness: PhantomData<T>,
}

impl<T: FromHistory> HistoryBuilder<T>
where
    T::Action: Serialize + Eq,
{
    pub fn new(op: &Op<T::Action>) -> HistoryBuilder<T> {
        let entry = arbitrary::oid();
        let resource = arbitrary::oid();
        let data = encoding::encode(&op.action).unwrap();

        Self {
            history: History::new_from_root(
                entry,
                op.author,
                resource,
                NonEmpty::new(data),
                op.timestamp.as_secs(),
            ),
            resource,
            witness: PhantomData,
        }
    }

    pub fn append(&mut self, op: &Op<T::Action>) -> &mut Self {
        let data = encoding::encode(&op.action).unwrap();

        self.history.extend(
            arbitrary::oid(),
            op.author,
            self.resource,
            NonEmpty::new(data),
            op.timestamp.as_secs(),
        );
        self
    }

    pub fn merge(&mut self, other: Self) {
        self.history.merge(other.history);
    }

    /// Return a sorted list of operations by traversing the history in topological order.
    pub fn sorted(&self) -> Vec<Op<T::Action>> {
        self.history.traverse(Vec::new(), |mut acc, entry| {
            let Ops(ops) =
                Ops::try_from(entry).expect("HistoryBuilder::sorted: operations must be valid");
            acc.extend(ops);

            ControlFlow::Continue(acc)
        })
    }

    /// Return `n` permutations of the topological ordering of operations.
    /// *This function will never return if less than `n` permutations exist.*
    pub fn permutations(&self, n: usize) -> impl IntoIterator<Item = Vec<Op<T::Action>>> {
        let mut permutations = BTreeSet::new();
        while permutations.len() < n {
            permutations.insert(self.sorted());
        }
        permutations.into_iter()
    }
}

impl<A> Deref for HistoryBuilder<A> {
    type Target = History;

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

/// Create a new test history.
pub fn history<T: FromHistory>(op: &Op<T::Action>) -> HistoryBuilder<T>
where
    T::Action: Serialize + Eq,
{
    HistoryBuilder::new(op)
}

/// An object that can be used to create and sign operations.
pub struct Actor<G, A> {
    pub signer: G,
    pub clock: clock::Lamport,
    pub ops: BTreeMap<(clock::Lamport, PublicKey), Op<A>>,
}

impl<G: Default, A> Default for Actor<G, A> {
    fn default() -> Self {
        Self::new(G::default())
    }
}

impl<G, A> Actor<G, A> {
    pub fn new(signer: G) -> Self {
        Self {
            signer,
            clock: clock::Lamport::default(),
            ops: BTreeMap::default(),
        }
    }
}

impl<G: Signer, A: Clone + Serialize> Actor<G, A> {
    pub fn receive(&mut self, ops: impl IntoIterator<Item = Op<A>>) -> clock::Lamport {
        for op in ops {
            let clock = op.clock;

            self.ops.insert((clock, op.author), op);
            self.clock.merge(clock);
        }
        self.clock
    }

    /// Reset actor state to initial state.
    pub fn reset(&mut self) {
        self.ops.clear();
        self.clock = clock::Lamport::default();
    }

    /// Returned an ordered list of events.
    pub fn timeline(&self) -> impl Iterator<Item = &Op<A>> {
        self.ops.values()
    }

    /// Create a new operation.
    pub fn op_with(&mut self, action: A, clock: clock::Lamport, identity: Oid) -> Op<A> {
        let id = arbitrary::oid().into();
        let author = *self.signer.public_key();
        let timestamp = clock::Physical::now();

        Op {
            id,
            action,
            author,
            clock,
            timestamp,
            identity,
        }
    }

    /// Create a new operation.
    pub fn op(&mut self, action: A) -> Op<A> {
        let clock = self.clock.tick();
        let identity = arbitrary::oid();
        let op = self.op_with(action, clock, identity);

        self.ops.insert((self.clock, op.author), op.clone());

        op
    }

    /// Get the actor's DID.
    pub fn did(&self) -> Did {
        self.signer.public_key().into()
    }
}

impl<G: Signer> Actor<G, super::patch::Action> {
    /// Create a patch.
    pub fn patch<R: ReadRepository>(
        &mut self,
        title: impl ToString,
        description: impl ToString,
        base: git::Oid,
        oid: git::Oid,
        repo: &R,
    ) -> Result<Patch, patch::Error> {
        Patch::from_ops(
            [
                self.op(patch::Action::Revision {
                    description: description.to_string(),
                    base,
                    oid,
                }),
                self.op(patch::Action::Edit {
                    title: title.to_string(),
                    target: patch::MergeTarget::default(),
                }),
            ],
            repo,
        )
    }
}