haematite 0.6.1

Content-addressed, branchable, actor-native storage engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use std::fmt;

pub type CustomMergeFn = fn(&[u8], Option<&[u8]>, Option<&[u8]>, Option<&[u8]>) -> Option<Vec<u8>>;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ConflictInput {
    pub key: Vec<u8>,
    pub ancestor_value: Option<Vec<u8>>,
    pub parent_value: Option<Vec<u8>>,
    pub branch_value: Option<Vec<u8>>,
}

impl ConflictInput {
    pub const fn new(
        key: Vec<u8>,
        ancestor_value: Option<Vec<u8>>,
        parent_value: Option<Vec<u8>>,
        branch_value: Option<Vec<u8>>,
    ) -> Self {
        Self {
            key,
            ancestor_value,
            parent_value,
            branch_value,
        }
    }
}

#[derive(Debug, Clone, Copy)]
pub enum ConflictPolicy {
    Lww,
    VectorClock,
    Custom(CustomMergeFn),
}

impl ConflictPolicy {
    pub fn resolve(&self, conflict: &ConflictInput) -> Result<Option<Vec<u8>>, ConflictError> {
        match self {
            Self::Lww => Ok(conflict.branch_value.clone()),
            Self::VectorClock => Err(ConflictError::Unimplemented {
                feature: "vector-clock conflict resolution",
            }),
            Self::Custom(function) => Ok(function(
                conflict.key.as_slice(),
                conflict.ancestor_value.as_deref(),
                conflict.parent_value.as_deref(),
                conflict.branch_value.as_deref(),
            )),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ConflictError {
    Unimplemented { feature: &'static str },
    Unresolved { key: Vec<u8> },
}

impl fmt::Display for ConflictError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Unimplemented { feature } => write!(formatter, "{feature} is not implemented"),
            Self::Unresolved { key } => write!(
                formatter,
                "conflict on key {} is unresolved",
                String::from_utf8_lossy(key)
            ),
        }
    }
}

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

#[cfg(test)]
mod tests {
    use super::{ConflictError, ConflictInput, ConflictPolicy};

    fn custom_resolution(
        key: &[u8],
        ancestor_value: Option<&[u8]>,
        parent_value: Option<&[u8]>,
        branch_value: Option<&[u8]>,
    ) -> Option<Vec<u8>> {
        if key.is_empty()
            && ancestor_value.is_none()
            && parent_value.is_none()
            && branch_value.is_none()
        {
            return None;
        }

        let mut resolved = Vec::new();
        resolved.extend_from_slice(key);
        resolved.push(b'|');
        resolved.extend_from_slice(ancestor_value.unwrap_or(b"none"));
        resolved.push(b'|');
        resolved.extend_from_slice(parent_value.unwrap_or(b"none"));
        resolved.push(b'|');
        resolved.extend_from_slice(branch_value.unwrap_or(b"none"));
        Some(resolved)
    }

    #[test]
    fn lww_takes_branch_value() -> Result<(), ConflictError> {
        let conflict = ConflictInput::new(
            b"k".to_vec(),
            Some(b"base".to_vec()),
            Some(b"parent".to_vec()),
            Some(b"branch".to_vec()),
        );

        assert_eq!(
            ConflictPolicy::Lww.resolve(&conflict)?,
            Some(b"branch".to_vec())
        );
        Ok(())
    }

    #[test]
    fn lww_takes_branch_delete() -> Result<(), ConflictError> {
        let conflict = ConflictInput::new(
            b"k".to_vec(),
            Some(b"base".to_vec()),
            Some(b"parent".to_vec()),
            None,
        );

        assert_eq!(ConflictPolicy::Lww.resolve(&conflict)?, None);
        Ok(())
    }

    #[test]
    fn custom_function_receives_all_values() -> Result<(), ConflictError> {
        let conflict = ConflictInput::new(
            b"k".to_vec(),
            Some(b"base".to_vec()),
            Some(b"parent".to_vec()),
            Some(b"branch".to_vec()),
        );

        assert_eq!(
            ConflictPolicy::Custom(custom_resolution).resolve(&conflict)?,
            Some(b"k|base|parent|branch".to_vec())
        );
        Ok(())
    }

    #[test]
    fn vector_clock_is_exposed_but_deferred() {
        let conflict = ConflictInput::new(
            b"k".to_vec(),
            Some(b"base".to_vec()),
            Some(b"parent".to_vec()),
            Some(b"branch".to_vec()),
        );

        assert_eq!(
            ConflictPolicy::VectorClock.resolve(&conflict),
            Err(ConflictError::Unimplemented {
                feature: "vector-clock conflict resolution"
            })
        );
    }

    #[test]
    fn conflict_policy_is_debuggable() {
        assert!(format!("{:?}", ConflictPolicy::Lww).contains("Lww"));
        assert!(format!("{:?}", ConflictPolicy::VectorClock).contains("VectorClock"));
        assert!(format!("{:?}", ConflictPolicy::Custom(custom_resolution)).contains("Custom"));
    }
}