radicle-heartwood-lfs/radicle-fetch/src/sigrefs.rs

use std::collections::{BTreeMap, BTreeSet};
use std::ops::{Deref, DerefMut, Not as _};

pub use radicle::storage::refs::{DiffedRefs, SignedRefsAt};
pub use radicle::storage::{git::Validation, Validations};

use radicle::storage::refs;
use radicle::{crypto::PublicKey, storage::ValidateRepository};

use crate::state::Cached;

pub mod error {
    use radicle::crypto::PublicKey;
    use thiserror::Error;

    #[derive(Debug, Error)]
    #[non_exhaustive]
    pub enum RemoteRefs {
        #[error("required sigrefs of {0} not found")]
        NotFound(PublicKey),
        #[error(transparent)]
        Load(#[from] Load),
    }

    pub type Load = radicle::storage::refs::Error;
}

/// A data carrier that associates that data with whether a given
/// `PublicKey` is a delegate or a non-delegate.
///
/// Construct a `DelegateStatus` via [`DelegateStatus::empty`], if no
/// data is required, or [`DelegateStatus::new`] if there is data to
/// associate.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) enum DelegateStatus<T = ()> {
    Delegate { remote: PublicKey, data: T },
    NonDelegate { remote: PublicKey, data: T },
}

impl DelegateStatus {
    /// Construct a `DelegateStatus` without any data.
    pub fn empty(remote: PublicKey, delegates: &BTreeSet<PublicKey>) -> Self {
        Self::new((), remote, delegates)
    }
}

impl<T> DelegateStatus<T> {
    pub fn new(data: T, remote: PublicKey, delegates: &BTreeSet<PublicKey>) -> Self {
        if delegates.contains(&remote) {
            Self::Delegate { remote, data }
        } else {
            Self::NonDelegate { remote, data }
        }
    }

    /// Construct a `DelegateStatus` with [`SignedRefsAt`] signed reference
    /// data, if it can be found in `repo`.
    pub fn load<S>(
        self,
        cached: &Cached<S>,
    ) -> Result<DelegateStatus<Option<SignedRefsAt>>, radicle::storage::refs::Error> {
        let remote = *self.remote();
        self.traverse(|_| cached.load(&remote))
    }

    fn remote(&self) -> &PublicKey {
        match self {
            Self::Delegate { remote, .. } => remote,
            Self::NonDelegate { remote, .. } => remote,
        }
    }

    fn traverse<U, E>(self, f: impl FnOnce(T) -> Result<U, E>) -> Result<DelegateStatus<U>, E> {
        match self {
            Self::Delegate { remote, data } => Ok(DelegateStatus::Delegate {
                remote,
                data: f(data)?,
            }),
            Self::NonDelegate { remote, data } => Ok(DelegateStatus::NonDelegate {
                remote,
                data: f(data)?,
            }),
        }
    }
}

pub(crate) fn validate(
    repo: &impl ValidateRepository,
    SignedRefsAt { sigrefs, .. }: SignedRefsAt,
) -> Result<Option<Validations>, radicle::storage::Error> {
    let remote = radicle::storage::Remote::<radicle::crypto::Verified>::new(sigrefs);
    let validations = repo.validate_remote(&remote)?;
    Ok(validations.is_empty().not().then_some(validations))
}

/// The sigrefs found for each remote.
///
/// Construct using [`RemoteRefs::load`].
#[derive(Debug, Default)]
pub struct RemoteRefs(BTreeMap<PublicKey, SignedRefsAt>);

impl RemoteRefs {
    /// Load the sigrefs for the given `must` and `may` remotes.
    ///
    /// The `must` remotes have to be present, otherwise an error will
    /// be returned.
    ///
    /// The `may` remotes do not have to be present and any missing
    /// sigrefs for that remote will be ignored.
    pub(crate) fn load<S>(
        cached: &Cached<S>,
        Select { must, may }: Select,
    ) -> Result<Self, error::RemoteRefs> {
        let must = must.iter().map(|id| {
            cached
                .load(id)
                .map_err(error::RemoteRefs::from)
                .and_then(|sr| match sr {
                    None => Err(error::RemoteRefs::NotFound(*id)),
                    Some(sr) => Ok((id, sr)),
                })
        });
        let may = may.iter().filter_map(|id| match cached.load(id) {
            Ok(None) => None,
            Ok(Some(sr)) => Some(Ok((id, sr))),
            Err(e) => Some(Err(e.into())),
        });

        must.chain(may)
            .try_fold(RemoteRefs::default(), |mut acc, remote_refs| {
                let (id, sigrefs) = remote_refs?;
                acc.0.insert(*id, sigrefs);
                Ok(acc)
            })
    }
}

impl Deref for RemoteRefs {
    type Target = BTreeMap<PublicKey, SignedRefsAt>;

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

impl<'a> IntoIterator for &'a RemoteRefs {
    type Item = <&'a BTreeMap<PublicKey, SignedRefsAt> as IntoIterator>::Item;
    type IntoIter = <&'a BTreeMap<PublicKey, SignedRefsAt> as IntoIterator>::IntoIter;

    fn into_iter(self) -> Self::IntoIter {
        self.0.iter()
    }
}

/// A set of [`DiffedRefs`] per remote `PublicKey`.
///
/// To construct use [`DiffedRefs::load`].
#[derive(Clone, Debug, Default)]
pub struct RemoteDiffedRefs(BTreeMap<PublicKey, DiffedRefs>);

impl RemoteDiffedRefs {
    /// Given a set of [`refs::RefsUpdate`]s, compute its
    /// [`DiffedRefs`] and use its [`refs::RefsUpdate::remote`] as the
    /// key for the `RemoteDiffedRefs` entry.
    ///
    /// If the `remote` is in the `may` set, then it is allowed to
    /// fail and will not be inserted in the set iff it does fail to
    /// load.
    ///
    /// If the `remote` is in the `must` set, then this method will
    /// fail iff loading the `DiffedRefs` fails.
    pub(crate) fn load<S>(
        cached: &Cached<S>,
        updates: Vec<refs::SignedRefsUpdate>,
        Select { must, may }: Select,
    ) -> Result<Self, error::Load> {
        updates
            .into_iter()
            .try_fold(Self::default(), |mut refs, update| {
                match cached.load_diffed_refs(&update) {
                    Ok(diff) => {
                        refs.insert(update.remote, diff);
                        Ok(refs)
                    }
                    Err(e) if must.contains(&update.remote) => Err(e),
                    Err(_) if may.contains(&update.remote) => Ok(refs),
                    Err(e) => Err(e),
                }
            })
    }
}

impl Deref for RemoteDiffedRefs {
    type Target = BTreeMap<PublicKey, DiffedRefs>;

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

impl DerefMut for RemoteDiffedRefs {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<'a> IntoIterator for &'a RemoteDiffedRefs {
    type Item = <&'a BTreeMap<PublicKey, DiffedRefs> as IntoIterator>::Item;
    type IntoIter = <&'a BTreeMap<PublicKey, DiffedRefs> as IntoIterator>::IntoIter;

    fn into_iter(self) -> Self::IntoIter {
        self.0.iter()
    }
}

pub struct Select<'a> {
    pub must: &'a BTreeSet<PublicKey>,
    pub may: &'a BTreeSet<PublicKey>,
}