umadb-core 0.6.14

Core event store implementation for UmaDB
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
use crate::common::{PageID, Position};
use crate::slice_reader::SliceReader;
use std::io::{Cursor, Write};
use umadb_dcb::{DcbError, DcbResult};

/// A simple leaf-only node for the tracking tree.
/// Keys are UTF-8 source strings; values are positions.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TrackingLeafNode {
    pub keys: Vec<String>,
    pub values: Vec<Position>,
}

impl TrackingLeafNode {
    pub fn new() -> Self {
        Self {
            keys: Vec::new(),
            values: Vec::new(),
        }
    }

    pub fn calc_serialized_size(&self) -> usize {
        // layout (v1 and newer on write):
        // u8: node version (1 for sorted keys)
        // u16: key_count
        // repeated key_count times: u8 key_len + [u8; key_len]
        // repeated key_count times: u64 position
        let mut size = 1 + 2; // version + count(u16)
        for k in &self.keys {
            size += 1 + k.len();
        }
        size += 8 * self.values.len();
        size
    }

    pub fn serialize_into(&self, buf: &mut [u8]) -> DcbResult<usize> {
        let mut cursor = Cursor::new(buf);

        // Version (1 = keys are sorted)
        cursor.write_all(&[1])?;

        // Keys length
        let klen = self.keys.len() as u16;
        cursor.write_all(&klen.to_le_bytes())?;

        // Keys (expected to be maintained in sorted order by the node)
        for k in &self.keys {
            let kb = k.as_bytes();

            // Safely check length without panicking, converting to io::Error if it fails
            let kb_len = u8::try_from(kb.len()).map_err(|_| {
                std::io::Error::new(
                    std::io::ErrorKind::InvalidInput,
                    "tracking key too long to serialize (len > 255)",
                )
            })?;

            cursor.write_all(&[kb_len])?;
            cursor.write_all(kb)?;
        }

        // Values
        for v in &self.values {
            cursor.write_all(&v.0.to_le_bytes())?;
        }

        Ok(cursor.position() as usize)
    }

    pub fn from_slice(slice: &[u8]) -> DcbResult<Self> {
        let mut reader = SliceReader::new(slice);

        // Read format version
        let ver = reader.read_u8()?;

        // Read element count based on version
        let count = if ver == 0 {
            let cnt_u32 = reader.read_u32()?;
            u16::try_from(cnt_u32).map_err(|_| {
                DcbError::DeserializationError("v0 tracking leaf count exceeds u16".to_string())
            })? as usize
        } else {
            reader.read_u16()? as usize
        };

        // Read keys
        let mut keys = Vec::with_capacity(count);
        for _ in 0..count {
            let klen = if ver == 0 {
                let klen_u32 = reader.read_u32()?;
                u8::try_from(klen_u32).map_err(|_| {
                    DcbError::DeserializationError(
                        "v0 tracking leaf key length exceeds u8".to_string(),
                    )
                })? as usize
            } else {
                reader.read_u8()? as usize
            };

            let k = reader.read_string(klen)?;
            keys.push(k);
        }

        // Read values (Positions)
        let mut values = Vec::with_capacity(count);
        for _ in 0..count {
            values.push(reader.read_position()?);
        }

        // Handle legacy sorting requirements
        if ver == 0 {
            // Old format: keys may be unsorted. Sort keys and keep values aligned.
            let mut pairs: Vec<(String, Position)> = keys.into_iter().zip(values).collect();
            pairs.sort_by(|a, b| a.0.cmp(&b.0));
            let (new_keys, new_vals): (Vec<String>, Vec<Position>) = pairs.into_iter().unzip();
            Ok(Self {
                keys: new_keys,
                values: new_vals,
            })
        } else {
            // v>=1: keys are already sorted on disk
            Ok(Self { keys, values })
        }
    }

    pub fn get(&self, source: &str) -> Option<Position> {
        match self.keys.binary_search_by(|k| k.as_str().cmp(source)) {
            Ok(i) => Some(self.values[i]),
            Err(_) => None,
        }
    }

    /// Insert or update a key with value while enforcing page size limit (no splitting).
    /// Returns Err(InternalError("not implemented: tracking split")) if it would exceed page capacity.
    pub fn upsert_no_split(
        &mut self,
        source: &str,
        pos: Position,
        page_body_capacity: usize,
    ) -> DcbResult<()> {
        match self.keys.binary_search_by(|k| k.as_str().cmp(source)) {
            Ok(idx) => {
                // Key exists; update value in place
                self.values[idx] = pos;
                Ok(())
            }
            Err(ins_idx) => {
                // Key not found; check capacity before inserting
                let key_len = source.len();
                // Check free space as key bytes length + 8 for position (as requested)
                let additional = key_len + 8;
                let current = self.calc_serialized_size();
                if current + additional > page_body_capacity {
                    return Err(DcbError::InternalError(
                        "not implemented: tracking split".to_string(),
                    ));
                }
                self.keys.insert(ins_idx, source.to_string());
                self.values.insert(ins_idx, pos);
                Ok(())
            }
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TrackingInternalNode {
    pub keys: Vec<String>,
    pub child_ids: Vec<PageID>,
}

impl TrackingInternalNode {
    pub fn child_index_for_key(&self, key: &str) -> usize {
        match self.keys.binary_search_by(|k| k.as_str().cmp(key)) {
            Ok(idx) => idx + 1,
            Err(idx) => idx,
        }
    }

    pub fn replace_child_id_at(
        &mut self,
        idx: usize,
        old_id: PageID,
        new_id: PageID,
    ) -> DcbResult<()> {
        if idx >= self.child_ids.len() {
            return Err(DcbError::DatabaseCorrupted(
                "child index out of bounds".to_string(),
            ));
        }
        if self.child_ids[idx] != old_id {
            return Err(DcbError::DatabaseCorrupted("Child ID mismatch".to_string()));
        }
        self.child_ids[idx] = new_id;
        Ok(())
    }

    pub fn insert_promoted_at(&mut self, idx: usize, key: String, right_child: PageID) {
        self.keys.insert(idx, key);
        self.child_ids.insert(idx + 1, right_child);
    }

    /// Split this internal node around the middle key. Returns (promoted_key, right_keys, right_child_ids).
    pub fn split_off(&mut self) -> DcbResult<(String, Vec<String>, Vec<PageID>)> {
        if self.child_ids.len() < 4 || self.keys.len() + 1 != self.child_ids.len() {
            return Err(DcbError::DatabaseCorrupted(
                "Cannot split tracking internal with insufficient arity".to_string(),
            ));
        }
        let mid = self.keys.len() / 2; // promote this key
        let promoted_key = self.keys[mid].clone();
        let right_keys: Vec<String> = self.keys[mid + 1..].to_vec();
        let right_child_ids: Vec<PageID> = self.child_ids[mid + 1..].to_vec();
        // Truncate left
        self.keys.truncate(mid);
        self.child_ids.truncate(mid + 1);
        Ok((promoted_key, right_keys, right_child_ids))
    }
    pub fn new() -> Self {
        Self {
            keys: Vec::new(),
            child_ids: Vec::new(),
        }
    }

    pub fn calc_serialized_size(&self) -> usize {
        // layout (v1 write):
        // u8: version (1)
        // u16: key_count
        // repeated key_count times: u8 key_len + [u8; key_len]
        // repeated (key_count + 1) times: u64 child_page_id
        let mut size = 1 + 2; // version + count(u16)
        for k in &self.keys {
            size += 1 + k.len();
        }
        size += 8 * (self.keys.len() + 1);
        size
    }

    pub fn serialize_into(&self, buf: &mut [u8]) -> DcbResult<usize> {
        let mut cursor = Cursor::new(buf);

        // Version (1 = keys are sorted)
        cursor.write_all(&[1])?;

        // Keys length
        let klen = self.keys.len() as u16;
        cursor.write_all(&klen.to_le_bytes())?;

        // Keys
        for k in &self.keys {
            let kb = k.as_bytes();

            // Safely check length without panicking
            let kb_len = u8::try_from(kb.len()).map_err(|_| {
                std::io::Error::new(
                    std::io::ErrorKind::InvalidInput,
                    "tracking internal key too long to serialize (len > 255)",
                )
            })?;

            cursor.write_all(&[kb_len])?;
            cursor.write_all(kb)?;
        }

        // Child IDs (count is implied as keys.len() + 1)
        for id in &self.child_ids {
            cursor.write_all(&id.0.to_le_bytes())?;
        }

        Ok(cursor.position() as usize)
    }

    pub fn from_slice(slice: &[u8]) -> DcbResult<Self> {
        let mut reader = SliceReader::new(slice);

        // Read format version
        let ver = reader.read_u8()?;
        if ver == 0 {
            return Err(DcbError::DeserializationError(
                "unsupported tracking internal version 0".to_string(),
            ));
        }

        // Read keys count
        let count = reader.read_u16()? as usize;

        // Read keys
        let mut keys = Vec::with_capacity(count);
        for _ in 0..count {
            let klen = reader.read_u8()? as usize;
            let k = reader.read_string(klen)?;
            keys.push(k);
        }

        // Derive child_ids length (always keys.len() + 1 for internal B-Tree nodes)
        let child_count = keys.len() + 1;

        // Read child IDs (PageIDs)
        let mut child_ids = Vec::with_capacity(child_count);
        for _ in 0..child_count {
            child_ids.push(reader.read_page_id()?);
        }

        Ok(Self { keys, child_ids })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use byteorder::{ByteOrder, LittleEndian};

    #[test]
    fn test_tracking_leaf_roundtrip() {
        let mut node = TrackingLeafNode::new();
        node.keys = vec!["a".to_string(), "b".to_string()];
        node.values = vec![Position(1), Position(2)];
        let mut buf = vec![0u8; node.calc_serialized_size()];
        let n = node.serialize_into(&mut buf).unwrap();
        assert_eq!(n, buf.len());
        let dec = TrackingLeafNode::from_slice(&buf).unwrap();
        assert_eq!(node, dec);
        assert_eq!(dec.get("a"), Some(Position(1)));
        assert_eq!(dec.get("z"), None);
    }

    #[test]
    fn test_deserialize_v0_unsorted_sorts_and_aligns() {
        // Manually craft a v0 buffer with unsorted keys: ["b", "c", "a"] and values [2, 3, 1]
        let keys = vec!["b", "c", "a"];
        let values = vec![Position(2), Position(3), Position(1)];
        // compute size for v0: 1 (ver) + 4 (count) + sum(4 + klen) + 8*count
        let key_bytes: Vec<Vec<u8>> = keys.iter().map(|k| k.as_bytes().to_vec()).collect();
        let mut size = 1 + 4;
        for kb in &key_bytes {
            size += 4 + kb.len();
        }
        size += 8 * values.len();
        let mut buf = vec![0u8; size];
        buf[0] = 0; // version 0
        LittleEndian::write_u32(&mut buf[1..5], keys.len() as u32);
        let mut off = 5;
        for kb in &key_bytes {
            LittleEndian::write_u32(&mut buf[off..off + 4], kb.len() as u32);
            off += 4;
            buf[off..off + kb.len()].copy_from_slice(kb);
            off += kb.len();
        }
        for v in &values {
            LittleEndian::write_u64(&mut buf[off..off + 8], v.0);
            off += 8;
        }
        // Now deserialize; it should sort keys and align values accordingly
        let dec = TrackingLeafNode::from_slice(&buf).unwrap();
        assert_eq!(dec.keys, vec!["a", "b", "c"]);
        assert_eq!(dec.values, vec![Position(1), Position(2), Position(3)]);
        // Binary search based get should work
        assert_eq!(dec.get("a"), Some(Position(1)));
        assert_eq!(dec.get("c"), Some(Position(3)));
        assert_eq!(dec.get("z"), None);
    }

    #[test]
    fn test_upsert_maintains_sorted_and_capacity_check() {
        let mut node = TrackingLeafNode::new();
        // small capacity; account for version+count and future entries
        let capacity = 1 + 4 + (4 + 1) + (4 + 1) + (4 + 1) + 8 * 3; // rough upper bound; we pre-check len+8 anyway
        node.upsert_no_split("b", Position(2), capacity).unwrap();
        node.upsert_no_split("a", Position(1), capacity).unwrap();
        node.upsert_no_split("c", Position(3), capacity).unwrap();
        assert_eq!(
            node.keys,
            vec!["a".to_string(), "b".to_string(), "c".to_string()]
        );
        assert_eq!(node.get("b"), Some(Position(2)));
        // Now try to insert with too small capacity
        let mut node2 = TrackingLeafNode::new();
        let small_capacity = 1 + 4; // too small to accept any key/value
        let err = node2
            .upsert_no_split("x", Position(9), small_capacity)
            .unwrap_err();
        match err {
            DcbError::InternalError(s) => assert!(s.contains("tracking split")),
            _ => panic!("unexpected error type"),
        }
    }

    #[test]
    fn test_tracking_internal_roundtrip() {
        let node = TrackingInternalNode {
            keys: vec!["alpha".into(), "beta".into(), "gamma".into()],
            child_ids: vec![PageID(10), PageID(20), PageID(30), PageID(40)],
        };
        let mut buf = vec![0u8; node.calc_serialized_size()];
        let n = node.serialize_into(&mut buf).unwrap();
        assert_eq!(n, buf.len());
        let dec = TrackingInternalNode::from_slice(&buf).unwrap();
        assert_eq!(dec, node);
    }

    #[test]
    fn test_tracking_internal_empty_keys_one_child_roundtrip() {
        let node = TrackingInternalNode {
            keys: vec![],
            child_ids: vec![PageID(123)],
        };
        let mut buf = vec![0u8; node.calc_serialized_size()];
        let n = node.serialize_into(&mut buf).unwrap();
        assert_eq!(n, buf.len());
        let dec = TrackingInternalNode::from_slice(&buf).unwrap();
        assert_eq!(dec, node);
    }

    #[test]
    fn test_tracking_internal_from_slice_truncated_children_err() {
        // Build a valid buffer then truncate last 8 bytes to simulate missing child
        let node = TrackingInternalNode {
            keys: vec!["k1".into()],
            child_ids: vec![PageID(1), PageID(2)],
        };
        let mut buf = vec![0u8; node.calc_serialized_size()];
        let _ = node.serialize_into(&mut buf).unwrap();
        buf.truncate(buf.len() - 4); // remove less than 8 to force error path
        let err = TrackingInternalNode::from_slice(&buf).unwrap_err();
        match err {
            DcbError::DeserializationError(_) => {}
            _ => panic!("expected DeserializationError"),
        }
    }
}