prolly/prolly/

error.rs

//! Error types for Prolly Trees

use super::cid::Cid;
use serde::{Deserialize, Serialize};

/// A mutation to apply to the tree
///
/// Represents a single operation in a batch mutation: either an upsert (insert or update)
/// or a delete operation.
///
#[derive(Clone, Debug, PartialEq)]
pub enum Mutation {
    /// Insert or update a key-value pair
    Upsert { key: Vec<u8>, val: Vec<u8> },
    /// Delete a key
    Delete { key: Vec<u8> },
}

impl Mutation {
    /// Get the key for this mutation
    ///
    pub fn key(&self) -> &[u8] {
        match self {
            Mutation::Upsert { key, .. } => key,
            Mutation::Delete { key } => key,
        }
    }

    /// Check if this is a delete mutation
    pub fn is_delete(&self) -> bool {
        matches!(self, Mutation::Delete { .. })
    }
}

/// Difference between two trees
///
/// Represents a single change between a base tree and another tree.
///
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub enum Diff {
    /// Entry exists in the new tree but not in the base tree
    Added { key: Vec<u8>, val: Vec<u8> },
    /// Entry exists in the base tree but not in the new tree
    Removed { key: Vec<u8>, val: Vec<u8> },
    /// Entry exists in both trees but with different values
    Changed {
        key: Vec<u8>,
        old: Vec<u8>,
        new: Vec<u8>,
    },
}

impl Diff {
    /// Borrow the key affected by this diff entry.
    pub fn key(&self) -> &[u8] {
        match self {
            Diff::Added { key, .. } | Diff::Removed { key, .. } | Diff::Changed { key, .. } => key,
        }
    }
}

/// Merge conflict information
///
/// Contains all the information needed to resolve a conflict during a three-way merge.
///
#[derive(Clone, Debug)]
pub struct Conflict {
    /// The key where the conflict occurred
    pub key: Vec<u8>,
    /// The value in the base tree (None if key didn't exist in base)
    pub base: Option<Vec<u8>>,
    /// The value in the left tree (None if the key is absent)
    pub left: Option<Vec<u8>>,
    /// The value in the right tree (None if the key is absent)
    pub right: Option<Vec<u8>>,
}

/// Resolution for a standard three-way merge conflict.
///
/// `Value` keeps the key with the provided value, `Delete` removes the key,
/// and `Unresolved` returns [`Error::Conflict`] to the caller.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Resolution {
    /// Keep the key with this value.
    Value(Vec<u8>),
    /// Delete the key from the merged tree.
    Delete,
    /// Leave the conflict unresolved.
    Unresolved,
}

impl Resolution {
    /// Resolve the conflict to a concrete value.
    pub fn value(value: impl Into<Vec<u8>>) -> Self {
        Self::Value(value.into())
    }

    /// Resolve the conflict by deleting the key.
    pub fn delete() -> Self {
        Self::Delete
    }

    /// Leave the conflict unresolved.
    pub fn unresolved() -> Self {
        Self::Unresolved
    }
}

/// Conflict resolution strategy
///
/// A function that takes a conflict and returns an explicit resolution.
/// If [`Resolution::Unresolved`] is returned, the merge will fail with a
/// `Conflict` error.
///
///
/// # Example
/// ```
/// use prolly::{Resolution, Resolver};
///
/// // Always prefer the left value
/// let prefer_left: Resolver = Box::new(|conflict| {
///     match &conflict.left {
///         Some(value) => Resolution::value(value.clone()),
///         None => Resolution::delete(),
///     }
/// });
///
/// // Always prefer the right value
/// let prefer_right: Resolver = Box::new(|conflict| {
///     match &conflict.right {
///         Some(value) => Resolution::value(value.clone()),
///         None => Resolution::delete(),
///     }
/// });
///
/// // Concatenate values
/// let concat: Resolver = Box::new(|conflict| {
///     match (&conflict.left, &conflict.right) {
///         (Some(left), Some(right)) => {
///             let mut result = left.clone();
///             result.extend(right);
///             Resolution::value(result)
///         }
///         _ => Resolution::unresolved(),
///     }
/// });
/// ```
pub type Resolver = Box<dyn Fn(&Conflict) -> Resolution + Send + Sync>;

/// Ready-made standard merge resolvers.
pub mod resolver {
    use super::{Conflict, Resolution};

    /// Prefer the left side. If left deleted the key, delete it.
    pub fn prefer_left(conflict: &Conflict) -> Resolution {
        match &conflict.left {
            Some(value) => Resolution::value(value.clone()),
            None => Resolution::delete(),
        }
    }

    /// Prefer the right side. If right deleted the key, delete it.
    pub fn prefer_right(conflict: &Conflict) -> Resolution {
        match &conflict.right {
            Some(value) => Resolution::value(value.clone()),
            None => Resolution::delete(),
        }
    }

    /// Delete the key when either side deleted it; otherwise leave unresolved.
    pub fn delete_wins(conflict: &Conflict) -> Resolution {
        if conflict.left.is_none() || conflict.right.is_none() {
            Resolution::delete()
        } else {
            Resolution::unresolved()
        }
    }

    /// Keep the updated side for delete/update conflicts; otherwise leave unresolved.
    pub fn update_wins(conflict: &Conflict) -> Resolution {
        match (&conflict.left, &conflict.right) {
            (Some(value), None) | (None, Some(value)) => Resolution::value(value.clone()),
            _ => Resolution::unresolved(),
        }
    }
}

use super::secondary_index::IndexProjection;
use super::transaction::TransactionConflict;
use super::versioned_map::MapVersionId;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum IndexErrorCode {
    FormatUnsupported,
    StoreProfileUnsupported,
    Conflict,
    Corruption,
    DefinitionInvalid,
    RuntimeDefinitionMissing,
    ManagedWriteRequired,
    OperationUnsupported,
    ExtractionFailed,
    ProjectionInvalid,
    ResourceLimit,
    CursorInvalid,
    BundleInvalid,
    SnapshotUnavailable,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum RetryAdvice {
    Never,
    RetryFreshState,
    RetryAfter,
}

impl IndexErrorCode {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::FormatUnsupported => "format_unsupported",
            Self::StoreProfileUnsupported => "store_profile_unsupported",
            Self::Conflict => "conflict",
            Self::Corruption => "corruption",
            Self::DefinitionInvalid => "definition_invalid",
            Self::RuntimeDefinitionMissing => "runtime_definition_missing",
            Self::ManagedWriteRequired => "managed_write_required",
            Self::OperationUnsupported => "operation_unsupported",
            Self::ExtractionFailed => "extraction_failed",
            Self::ProjectionInvalid => "projection_invalid",
            Self::ResourceLimit => "resource_limit",
            Self::CursorInvalid => "cursor_invalid",
            Self::BundleInvalid => "bundle_invalid",
            Self::SnapshotUnavailable => "snapshot_unavailable",
        }
    }
}

impl RetryAdvice {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Never => "never",
            Self::RetryFreshState => "retry_fresh_state",
            Self::RetryAfter => "retry_after",
        }
    }
}

/// Prolly tree errors
pub enum Error {
    /// Node not found in store
    NotFound(Cid),
    /// Invalid node structure
    InvalidNode,
    /// Persisted tree format parameters are invalid.
    InvalidFormat(String),
    /// Runtime execution limits must be finite and nonzero.
    InvalidExecutionConfig { field: &'static str, value: usize },
    /// A node was decoded under a different persisted tree format.
    FormatMismatch { expected: Cid, actual: Cid },
    /// One entry cannot fit below the persisted hard byte limit.
    EntryTooLarge { encoded_bytes: u64, limit: u64 },
    /// Deserialization failed
    Deserialize(String),
    /// Serialization failed
    Serialize(String),
    /// Storage error
    Store(Box<dyn std::error::Error + Send + Sync>),
    /// Stored bytes did not hash to the CID they were stored under.
    CidMismatch { expected: Cid, actual: Cid },
    /// Merge conflict - occurs when both trees modify the same key differently
    /// and no resolver is provided or the resolver returns `Resolution::Unresolved`
    ///
    Conflict(Conflict),
    /// Mutation buffer is full - adding a mutation would exceed the buffer size limit
    BufferFull,
    /// A savepoint belongs to another write-session generation.
    InvalidSavepoint,
    /// A patch does not describe the selected immutable base.
    PatchBaseMismatch,
    /// A structural patch is malformed or cannot be safely applied.
    InvalidStructuralPatch(String),
    /// Sorted bulk loading received keys out of order.
    UnsortedInput { previous: Vec<u8>, next: Vec<u8> },
    /// Splice received more than one mutation for a logical key.
    DuplicateMutation { key: Vec<u8> },
    /// Splice manager and immutable tree use different shape settings.
    SpliceConfigMismatch,
    /// A GC retention policy referenced named roots that were not present.
    MissingNamedRoots { names: Vec<Vec<u8>> },
    /// A portable snapshot bundle is malformed or not self-contained.
    InvalidSnapshotBundle(String),
    /// The configured store does not support strict atomic transactions.
    UnsupportedTransactions { store: &'static str },
    /// The configured store has not proved the required indexed-store profile.
    UnsupportedIndexedStoreProfile {
        store: &'static str,
        required: &'static str,
        actual: &'static str,
    },
    /// A named root from an obsolete secondary-index architecture was found.
    IndexFormatUnsupported,
    /// A transaction could not commit because a validated named root changed.
    TransactionConflict(Box<TransactionConflict>),
    /// A built-in versioned-map catalog is missing or internally inconsistent.
    InvalidVersionedMap(String),
    /// A runtime secondary-index definition is invalid.
    InvalidIndexDefinition { reason: String },
    /// Persisted active index semantics have no matching runtime extractor.
    IndexRuntimeDefinitionMissing { name: Vec<u8>, generation: u64 },
    /// Runtime and persisted descriptor fingerprints disagree.
    IndexDefinitionMismatch {
        name: Vec<u8>,
        persisted: Cid,
        runtime: Cid,
    },
    /// A managed source map must be mutated through `IndexedMap`.
    IndexesRequireIndexedMap {
        map_id: Vec<u8>,
        active_indexes: Vec<Vec<u8>>,
    },
    /// The requested operation has no safe canonical indexed implementation.
    IndexOperationUnsupported { operation: &'static str },
    /// An application extractor rejected one source record.
    IndexExtractionFailed {
        name: Vec<u8>,
        primary_key: Vec<u8>,
        reason: String,
    },
    /// An extractor emission is incompatible with its projection mode.
    IndexProjectionMismatch {
        name: Vec<u8>,
        mode: IndexProjection,
        primary_key: Vec<u8>,
    },
    /// One source record emitted different projections for the same term.
    ConflictingIndexProjection {
        name: Vec<u8>,
        primary_key: Vec<u8>,
        term: Vec<u8>,
    },
    /// Repeated source movement prevented index activation.
    IndexBuildConflictLimitExceeded { name: Vec<u8>, attempts: usize },
    /// No exact snapshot exists for an index at the selected source version.
    IndexUnavailableAtVersion {
        name: Vec<u8>,
        source_version: MapVersionId,
    },
    /// A persisted snapshot disagrees with the selected source or index root.
    IndexSnapshotMismatch {
        name: Vec<u8>,
        source_version: MapVersionId,
        reason: String,
    },
    /// A cursor belongs to a different immutable indexed snapshot.
    IndexCursorVersionMismatch { expected: String, actual: String },
    /// A destructive index GC sweep lacks a quiescence/lease safety proof.
    IndexGcUnsafe,
    /// Index work exceeded a configured resource bound.
    IndexResourceLimitExceeded {
        resource: &'static str,
        limit: usize,
        actual: usize,
    },
    /// A current indexed-snapshot bundle is malformed or inconsistent.
    InvalidIndexedSnapshotBundle { reason: String },
    /// A proximity-map shape configuration is invalid.
    InvalidProximityConfig { reason: String },
    /// Persisted proximity bytes use a format version this build does not read.
    UnsupportedProximityVersion { found: u8, required: u8 },
    /// A vector is incompatible with the proximity-map configuration.
    InvalidProximityVector { reason: String },
    /// Cosine distance cannot prepare a vector with zero Euclidean norm.
    ZeroCosineVector,
    /// A proximity build or mutation contains the same logical key twice.
    DuplicateProximityKey { key: Vec<u8> },
    /// Proximity search options are invalid.
    InvalidProximitySearch { reason: String },
    /// Proximity accelerator construction exceeded an explicit resource bound.
    ProximityResourceLimitExceeded {
        resource: &'static str,
        limit: usize,
        actual: usize,
    },
    /// A persisted proximity record, node, or descriptor is malformed.
    InvalidProximityObject { kind: &'static str, reason: String },
    /// One canonical proximity node exceeds the configured hard byte limit.
    ProximityNodeTooLarge {
        level: u8,
        entries: usize,
        encoded_bytes: usize,
        limit: usize,
    },
    /// A typed content-graph traversal exceeded a configured resource limit.
    ContentGraphResourceLimitExceeded {
        resource: &'static str,
        limit: usize,
        actual: usize,
    },
}

impl std::fmt::Debug for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        // Error values routinely reach generic `Debug` logging through
        // `unwrap`, tracing, and binding adapters. Keep that path on the same
        // redacted contract as `Display`; raw keys, terms, cursor bounds, and
        // extractor diagnostics remain available only in explicitly matched
        // structured variants.
        std::fmt::Display::fmt(self, f)
    }
}

impl Error {
    pub(crate) fn transaction_conflict(conflict: TransactionConflict) -> Self {
        Self::TransactionConflict(Box::new(conflict))
    }

    pub fn index_code(&self) -> Option<IndexErrorCode> {
        use IndexErrorCode as Code;
        Some(match self {
            Self::IndexFormatUnsupported => Code::FormatUnsupported,
            Self::UnsupportedIndexedStoreProfile { .. } => Code::StoreProfileUnsupported,
            Self::TransactionConflict(_) | Self::IndexBuildConflictLimitExceeded { .. } => {
                Code::Conflict
            }
            Self::IndexSnapshotMismatch { .. } => Code::Corruption,
            Self::InvalidIndexDefinition { .. } | Self::IndexDefinitionMismatch { .. } => {
                Code::DefinitionInvalid
            }
            Self::IndexRuntimeDefinitionMissing { .. } => Code::RuntimeDefinitionMissing,
            Self::IndexesRequireIndexedMap { .. } => Code::ManagedWriteRequired,
            Self::IndexOperationUnsupported { .. } => Code::OperationUnsupported,
            Self::IndexExtractionFailed { .. } => Code::ExtractionFailed,
            Self::IndexProjectionMismatch { .. } | Self::ConflictingIndexProjection { .. } => {
                Code::ProjectionInvalid
            }
            Self::IndexResourceLimitExceeded { .. } => Code::ResourceLimit,
            Self::IndexCursorVersionMismatch { .. } => Code::CursorInvalid,
            Self::IndexGcUnsafe => Code::OperationUnsupported,
            Self::InvalidIndexedSnapshotBundle { .. } => Code::BundleInvalid,
            Self::IndexUnavailableAtVersion { .. } => Code::SnapshotUnavailable,
            _ => return None,
        })
    }

    pub fn retry_advice(&self) -> RetryAdvice {
        match self {
            Self::TransactionConflict(_) | Self::IndexBuildConflictLimitExceeded { .. } => {
                RetryAdvice::RetryFreshState
            }
            Self::Store(_) => RetryAdvice::RetryAfter,
            _ => RetryAdvice::Never,
        }
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Error::NotFound(cid) => write!(f, "node not found: {:?}", cid),
            Error::InvalidNode => write!(f, "invalid node structure"),
            Error::InvalidFormat(message) => write!(f, "invalid tree format: {message}"),
            Error::InvalidExecutionConfig { field, value } => {
                write!(f, "invalid execution config: {field} must be nonzero, got {value}")
            }
            Error::FormatMismatch { expected, actual } => write!(
                f,
                "tree format mismatch: expected {:?}, got {:?}",
                expected, actual
            ),
            Error::EntryTooLarge {
                encoded_bytes,
                limit,
            } => write!(
                f,
                "entry encodes to {encoded_bytes} bytes, exceeding node limit {limit}"
            ),
            Error::Deserialize(e) => write!(f, "deserialize error: {}", e),
            Error::Serialize(e) => write!(f, "serialize error: {}", e),
            Error::Store(e) => write!(f, "storage error: {}", e),
            Error::CidMismatch { expected, actual } => {
                write!(
                    f,
                    "content CID mismatch: expected {:?}, got {:?}",
                    expected, actual
                )
            }
            Error::Conflict(c) => write!(f, "merge conflict at key: {:?}", c.key),
            Error::BufferFull => write!(f, "mutation buffer is full"),
            Error::InvalidSavepoint => write!(f, "invalid or stale write-session savepoint"),
            Error::PatchBaseMismatch => write!(f, "patch base root or values do not match"),
            Error::InvalidStructuralPatch(reason) => {
                write!(f, "invalid structural patch: {reason}")
            }
            Error::UnsortedInput { previous, next } => write!(
                f,
                "sorted input keys are out of order: previous={:?} next={:?}",
                previous, next
            ),
            Error::DuplicateMutation { key } => {
                write!(f, "duplicate splice mutation: {key:?}")
            }
            Error::SpliceConfigMismatch => {
                write!(f, "splice manager/tree configuration mismatch")
            }
            Error::MissingNamedRoots { names } => {
                write!(f, "missing named roots for retention policy: {:?}", names)
            }
            Error::InvalidSnapshotBundle(message) => {
                write!(f, "invalid snapshot bundle: {message}")
            }
            Error::UnsupportedTransactions { store } => {
                write!(f, "store does not support strict transactions: {store}")
            }
            Error::UnsupportedIndexedStoreProfile {
                store,
                required,
                actual,
            } => write!(
                f,
                "store {store} does not satisfy indexed-store requirement {required}: {actual}"
            ),
            Error::TransactionConflict(conflict) => {
                write!(
                    f,
                    "transaction conflict for named root: {:?}",
                    conflict.name
                )
            }
            Error::InvalidVersionedMap(message) => {
                write!(f, "invalid versioned map: {message}")
            }
            Error::IndexFormatUnsupported => {
                write!(f, "secondary index format is unsupported; hard cutover required")
            }
            Error::InvalidIndexDefinition { .. } => {
                write!(f, "invalid secondary index definition")
            }
            Error::IndexRuntimeDefinitionMissing { generation, .. } => write!(
                f,
                "runtime secondary index definition missing: generation={generation}"
            ),
            Error::IndexDefinitionMismatch { .. } => {
                write!(f, "secondary index definition mismatch")
            }
            Error::IndexesRequireIndexedMap { .. } => {
                write!(f, "managed map requires IndexedMap coordinator")
            }
            Error::IndexOperationUnsupported { operation } => {
                write!(f, "indexed map operation is unsupported: {operation}")
            }
            Error::IndexExtractionFailed { .. } => {
                write!(f, "secondary index extraction failed")
            }
            Error::IndexProjectionMismatch { mode, .. } => {
                write!(f, "secondary index projection mismatch: mode={mode:?}")
            }
            Error::ConflictingIndexProjection { .. } => {
                write!(f, "conflicting secondary index projection")
            }
            Error::IndexBuildConflictLimitExceeded { attempts, .. } => write!(
                f,
                "secondary index conflict limit exceeded: attempts={attempts}"
            ),
            Error::IndexUnavailableAtVersion { .. } => {
                write!(f, "secondary index unavailable at selected snapshot")
            }
            Error::IndexSnapshotMismatch { .. } => {
                write!(f, "secondary index snapshot closure is inconsistent")
            }
            Error::IndexCursorVersionMismatch { .. } => {
                write!(f, "secondary index cursor does not match the query snapshot")
            }
            Error::IndexGcUnsafe => {
                write!(f, "secondary index garbage collection lacks a safety proof")
            }
            Error::IndexResourceLimitExceeded {
                resource,
                limit,
                actual,
            } => write!(
                f,
                "secondary index resource limit exceeded: resource={resource} limit={limit} actual={actual}"
            ),
            Error::InvalidIndexedSnapshotBundle { .. } => {
                write!(f, "invalid indexed snapshot bundle")
            }
            Error::InvalidProximityConfig { reason } => {
                write!(f, "invalid proximity configuration: {reason}")
            }
            Error::UnsupportedProximityVersion { found, required } => write!(
                f,
                "unsupported proximity format version: found={found} required={required}"
            ),
            Error::InvalidProximityVector { reason } => {
                write!(f, "invalid proximity vector: {reason}")
            }
            Error::ZeroCosineVector => write!(f, "cosine proximity vector has zero norm"),
            Error::DuplicateProximityKey { key } => {
                write!(f, "duplicate proximity key: {key:?}")
            }
            Error::InvalidProximitySearch { reason } => {
                write!(f, "invalid proximity search options: {reason}")
            }
            Error::ProximityResourceLimitExceeded {
                resource,
                limit,
                actual,
            } => write!(
                f,
                "proximity accelerator resource limit exceeded: resource={resource} limit={limit} actual={actual}"
            ),
            Error::InvalidProximityObject { kind, reason } => {
                write!(f, "invalid proximity {kind}: {reason}")
            }
            Error::ProximityNodeTooLarge {
                level,
                entries,
                encoded_bytes,
                limit,
            } => write!(
                f,
                "proximity node exceeds byte limit: level={level} entries={entries} bytes={encoded_bytes} limit={limit}"
            ),
            Error::ContentGraphResourceLimitExceeded {
                resource,
                limit,
                actual,
            } => write!(
                f,
                "content graph resource limit exceeded: resource={resource} limit={limit} actual={actual}"
            ),
        }
    }
}

impl std::error::Error for Error {}