mrecordlog 0.2.0

Quickwit's shared record log.
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

use std::io;

use crate::block_read_write::{ArrayReader, VecBlockWriter};
use crate::frame::header::{FrameType, HEADER_LEN};
use crate::frame::{FrameReader, FrameWriter, ReadFrameError};
use crate::BLOCK_NUM_BYTES;

#[tokio::test]
async fn test_frame_simple() {
    let block_writer = {
        let wrt: VecBlockWriter = VecBlockWriter::default();
        let mut frame_writer = FrameWriter::create(wrt);
        frame_writer
            .write_frame(FrameType::First, &b"abc"[..])
            .await
            .unwrap();
        frame_writer
            .write_frame(FrameType::Middle, &b"de"[..])
            .await
            .unwrap();
        frame_writer
            .write_frame(FrameType::Last, &b"fgh"[..])
            .await
            .unwrap();
        frame_writer.flush().await.unwrap();
        frame_writer.into_writer()
    };
    let buffer: Vec<u8> = block_writer.into();
    let mut frame_reader = FrameReader::open(ArrayReader::from(&buffer[..]));
    let read_frame_res = frame_reader.read_frame().await;
    assert_eq!(read_frame_res.unwrap(), (FrameType::First, &b"abc"[..]));
    assert_eq!(
        frame_reader.read_frame().await.unwrap(),
        (FrameType::Middle, &b"de"[..])
    );
    assert_eq!(
        frame_reader.read_frame().await.unwrap(),
        (FrameType::Last, &b"fgh"[..])
    );
    assert!(matches!(
        frame_reader.read_frame().await.unwrap_err(),
        ReadFrameError::NotAvailable
    ));
}

#[tokio::test]
async fn test_frame_corruption_in_payload() -> io::Result<()> {
    let mut buf: Vec<u8> = {
        let mut frame_writer = FrameWriter::create(VecBlockWriter::default());
        frame_writer
            .write_frame(FrameType::First, &b"abc"[..])
            .await?;
        frame_writer.flush().await?;
        frame_writer
            .write_frame(FrameType::Middle, &b"de"[..])
            .await?;
        frame_writer.flush().await?;
        frame_writer.into_writer().into()
    };
    buf[8] = 0u8;
    let mut frame_reader = FrameReader::open(ArrayReader::from(&buf[..]));
    assert!(matches!(
        frame_reader.read_frame().await,
        Err(ReadFrameError::Corruption)
    ));
    assert!(matches!(
        frame_reader.read_frame().await,
        Ok((FrameType::Middle, b"de"))
    ));
    Ok(())
}

async fn repeat_empty_frame_util(repeat: usize) -> Vec<u8> {
    let mut frame_writer = FrameWriter::create(VecBlockWriter::default());
    for _ in 0..repeat {
        frame_writer
            .write_frame(FrameType::Full, &b""[..])
            .await
            .unwrap();
    }
    frame_writer.flush().await.unwrap();
    frame_writer.into_writer().into()
}

#[tokio::test]
async fn test_simple_multiple_blocks() -> io::Result<()> {
    let num_frames = 1 + BLOCK_NUM_BYTES / HEADER_LEN;
    let buffer = repeat_empty_frame_util(num_frames).await;
    let mut frame_reader = FrameReader::open(ArrayReader::from(&buffer[..]));
    for _ in 0..num_frames {
        let read_frame_res = frame_reader.read_frame().await;
        assert!(matches!(read_frame_res, Ok((FrameType::Full, &[]))));
    }
    assert!(matches!(
        frame_reader.read_frame().await,
        Err(ReadFrameError::NotAvailable)
    ));
    Ok(())
}

#[tokio::test]
async fn test_multiple_blocks_corruption_on_length() -> io::Result<()> {
    // We end up with 4681 frames on the first block.
    // 1 frame on the second block
    let num_frames = 1 + crate::BLOCK_NUM_BYTES / HEADER_LEN;
    let mut buffer = repeat_empty_frame_util(num_frames).await;
    buffer[2000 * HEADER_LEN + 5] = 255u8;
    let mut frame_reader = FrameReader::open(ArrayReader::from(&buffer[..]));
    for _ in 0..2000 {
        let read_frame_res = frame_reader.read_frame().await;
        assert!(matches!(read_frame_res, Ok((FrameType::Full, &[]))));
    }
    assert!(matches!(
        frame_reader.read_frame().await,
        Err(ReadFrameError::Corruption)
    ));
    assert!(matches!(
        frame_reader.read_frame().await,
        Ok((FrameType::Full, &[]))
    ));
    assert!(matches!(
        frame_reader.read_frame().await,
        Err(ReadFrameError::NotAvailable)
    ));
    Ok(())
}