s2-lite 0.29.29

Lightweight server implementation of S2, the durable streams API, backed by object storage
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

use bytes::{Buf, BufMut, Bytes, BytesMut};
use enum_ordinalize::Ordinalize;
use s2_common::record::{Encodable, Metered, StoredRecord, StreamPosition};

use super::{DeserializationError, KeyType, check_exact_size, invalid_value_err};
use crate::stream_id::StreamId;

const KEY_LEN: usize = 1 + StreamId::LEN + 8 + 8;

pub fn ser_key(stream_id: StreamId, pos: StreamPosition) -> Bytes {
    let mut buf = BytesMut::with_capacity(KEY_LEN);
    buf.put_u8(KeyType::StreamRecordData.ordinal());
    buf.put_slice(stream_id.as_bytes());
    buf.put_u64(pos.seq_num);
    buf.put_u64(pos.timestamp);
    debug_assert_eq!(buf.len(), KEY_LEN, "serialized length mismatch");
    buf.freeze()
}

pub fn deser_key(mut bytes: Bytes) -> Result<(StreamId, StreamPosition), DeserializationError> {
    check_exact_size(&bytes, KEY_LEN)?;
    let ordinal = bytes.get_u8();
    if ordinal != KeyType::StreamRecordData.ordinal() {
        return Err(DeserializationError::InvalidOrdinal(ordinal));
    }
    let mut stream_id_bytes = [0u8; StreamId::LEN];
    bytes.copy_to_slice(&mut stream_id_bytes);
    let seq_num = bytes.get_u64();
    let timestamp = bytes.get_u64();
    Ok((
        stream_id_bytes.into(),
        StreamPosition { seq_num, timestamp },
    ))
}

pub fn ser_value(record: Metered<&StoredRecord>) -> Bytes {
    record.to_bytes()
}

pub fn deser_value(bytes: Bytes) -> Result<Metered<StoredRecord>, DeserializationError> {
    Metered::try_from(bytes).map_err(|e| invalid_value_err("record", e))
}

#[cfg(test)]
mod tests {
    use bytes::Bytes;
    use proptest::prelude::*;
    use s2_common::record::{Metered, SeqNum, StreamPosition, Timestamp};

    use crate::{backend::kv::DeserializationError, stream_id::StreamId};

    #[test]
    fn stream_record_data_rejects_invalid_payload() {
        let err = super::deser_value(Bytes::from_static(&[0x00])).unwrap_err();
        assert!(matches!(
            err,
            DeserializationError::InvalidValue { name: "record", .. }
        ));
    }

    proptest! {
        #[test]
        fn roundtrip_stream_record_data_key(
            stream_id_bytes in any::<[u8; StreamId::LEN]>(),
            seq_num in any::<SeqNum>(),
            timestamp in any::<Timestamp>(),
        ) {
            let stream_id = StreamId::from(stream_id_bytes);
            let pos = StreamPosition { seq_num, timestamp };
            let key_bytes = super::ser_key(stream_id, pos);
            let (decoded_stream_id, decoded_pos) = super::deser_key(key_bytes).unwrap();
            prop_assert_eq!(stream_id, decoded_stream_id);
            prop_assert_eq!(pos, decoded_pos);
        }

        #[test]
        fn roundtrip_stream_record_data_value(
            header_name in prop::collection::vec(any::<u8>(), 1..20),
            header_value in prop::collection::vec(any::<u8>(), 0..50),
            body in prop::collection::vec(any::<u8>(), 0..200),
        ) {
            use s2_common::record::{Header, MeteredSize, Record, StoredRecord};

            let header_name = Bytes::from(header_name);
            let header_value = Bytes::from(header_value);
            let headers = vec![Header {
                name: header_name.clone(),
                value: header_value.clone(),
            }];
            let body = Bytes::from(body);
            let expected_headers = headers.clone();
            let expected_body = body.clone();
            let record = Record::try_from_parts(headers.clone(), body).unwrap();
            let metered_record: Metered<Record> = record.into();
            let original_size = metered_record.metered_size();

            let bytes = super::ser_value(
                Metered::from(StoredRecord::from(metered_record.into_inner())).as_ref()
            );
            let decoded = super::deser_value(bytes).unwrap();
            let decoded: Metered<Record> = super::ser_value(decoded.as_ref()).try_into().unwrap();

            prop_assert_eq!(original_size, decoded.metered_size());
            let (decoded_headers, decoded_body) = decoded.into_inner().into_parts();
            prop_assert_eq!(decoded_headers, expected_headers);
            prop_assert_eq!(decoded_body, expected_body);
        }
    }
}