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
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

use super::*;
use crate::{BlockRead, BlockWrite, BLOCK_NUM_BYTES};

#[tokio::test]
async fn test_read_write() {
    let tmp_dir = tempfile::tempdir().unwrap();
    let mut buffer = [0u8; BLOCK_NUM_BYTES];
    {
        let rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
        assert!(&rolling_reader.block().iter().all(|&b| b == 0));
        let mut writer: RollingWriter = rolling_reader.into_writer().await.unwrap();
        buffer.fill(0u8);
        writer.write(&buffer[..]).await.unwrap();
        buffer.fill(1u8);
        writer.write(&buffer[..]).await.unwrap();
        buffer.fill(2u8);
        writer.write(&buffer[..]).await.unwrap();
        writer.flush().await.unwrap();
    }
    let mut rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
    assert!(rolling_reader.block().iter().all(|&b| b == 0));
    assert!(rolling_reader.next_block().await.unwrap());
    assert!(rolling_reader.block().iter().all(|&b| b == 1));
    assert!(rolling_reader.next_block().await.unwrap());
    assert!(rolling_reader.block().iter().all(|&b| b == 2));
}

#[tokio::test]
async fn test_read_write_2nd_block() {
    let tmp_dir = tempfile::tempdir().unwrap();
    let mut buffer = [0u8; BLOCK_NUM_BYTES];
    {
        let rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
        let mut writer: RollingWriter = rolling_reader.into_writer().await.unwrap();
        for i in 1..=10 {
            buffer.fill(i);
            writer.write(&buffer[..]).await.unwrap();
        }
        writer.flush().await.unwrap();
    }
    {
        let mut rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
        assert!(rolling_reader.block().iter().all(|&b| b == 1));
        assert!(rolling_reader.next_block().await.unwrap());
        assert!(rolling_reader.block().iter().all(|&b| b == 2));
        assert!(rolling_reader.next_block().await.unwrap());
        assert!(rolling_reader.block().iter().all(|&b| b == 3));
        let mut writer: RollingWriter = rolling_reader.into_writer().await.unwrap();
        for i in 13..=23 {
            buffer.fill(i);
            writer.write(&buffer[..]).await.unwrap();
        }
        writer.flush().await.unwrap();
    }
    {
        let mut rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
        assert!(rolling_reader.block().iter().all(|&b| b == 1));
        assert!(rolling_reader.next_block().await.unwrap());
        assert!(rolling_reader.block().iter().all(|&b| b == 2));
        for i in 13..=23 {
            assert!(rolling_reader.next_block().await.unwrap());
            assert!(rolling_reader.block().iter().all(|&b| b == i));
        }
    }
}

#[tokio::test]
async fn test_read_truncated() {
    let tmp_dir = tempfile::tempdir().unwrap();
    let mut buffer = [0u8; BLOCK_NUM_BYTES];
    let to_write = NUM_BLOCKS_PER_FILE * 3;
    {
        let rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
        let mut writer: RollingWriter = rolling_reader.into_writer().await.unwrap();
        for i in 0..to_write {
            buffer.fill(i as u8);
            writer.write(&buffer[..]).await.unwrap();
        }
        writer.flush().await.unwrap();
        let file_ids = writer.list_file_numbers();
        let middle_file = file_ids[1];
        let filepath =
            crate::rolling::directory::filepath(tmp_dir.path(), &FileNumber::for_test(middle_file));

        // voluntarily corrupt data by truncating a wal file.
        tokio::fs::OpenOptions::new()
            .truncate(true)
            .write(true)
            .open(&filepath)
            .await
            .unwrap();
    }
    {
        let mut rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();

        for i in 0..to_write {
            // ignore file 1 as it was corrupted
            if i / NUM_BLOCKS_PER_FILE == 1 {
                continue;
            }
            assert!(rolling_reader.block().iter().all(|&b| b == i as u8));
            // check we manage to get the next block, except for the last block: there is nothing
            // after
            assert_eq!(
                rolling_reader.next_block().await.unwrap(),
                i != to_write - 1
            );
        }
    }
}

#[tokio::test]
async fn test_directory_single_file() {
    let tmp_dir = tempfile::tempdir().unwrap();
    {
        let directory = Directory::open(tmp_dir.path()).await.unwrap();
        let first_file = directory.first_file_number();
        assert_eq!(first_file.unroll(&directory.files), &[0]);
    }
    let mut rolling_reader: RollingReader = RollingReader::open(tmp_dir.path()).await.unwrap();
    for _ in 0..NUM_BLOCKS_PER_FILE - 1 {
        assert!(rolling_reader.next_block().await.unwrap());
    }
    assert!(!rolling_reader.next_block().await.unwrap());
}

#[tokio::test]
async fn test_directory_simple() {
    let tmp_dir = tempfile::tempdir().unwrap();
    {
        let mut writer: RollingWriter = RollingReader::open(tmp_dir.path())
            .await
            .unwrap()
            .into_writer()
            .await
            .unwrap();
        let buf = vec![1u8; FRAME_NUM_BYTES];
        for _ in 0..(NUM_BLOCKS_PER_FILE + 1) {
            writer.write(&buf).await.unwrap();
        }
    }
    {
        let directory = Directory::open(tmp_dir.path()).await.unwrap();
        let first_file: &FileNumber = directory.first_file_number();
        assert_eq!(first_file.unroll(&directory.files), &[0, 1]);
    }
}

#[tokio::test]
async fn test_directory_truncate() {
    let tmp_dir = tempfile::tempdir().unwrap();
    let file_0: FileNumber;
    let file_1: FileNumber;
    let file_2: FileNumber;
    let file_3: FileNumber;
    {
        let reader = RollingReader::open(tmp_dir.path()).await.unwrap();
        file_0 = reader.current_file().clone();
        assert!(!file_0.can_be_deleted());
        let mut writer: RollingWriter = reader.into_writer().await.unwrap();
        let buf = vec![1u8; FRAME_NUM_BYTES];
        assert_eq!(&writer.current_file().unroll(&writer.directory.files), &[0]);
        for _ in 0..NUM_BLOCKS_PER_FILE + 1 {
            writer.write(&buf).await.unwrap();
        }
        assert_eq!(&writer.list_file_numbers(), &[0, 1]);
        file_1 = writer.current_file().clone();
        assert_eq!(file_1.file_number(), 1);
        for _ in 0..NUM_BLOCKS_PER_FILE {
            writer.write(&buf).await.unwrap();
        }
        assert_eq!(&writer.list_file_numbers(), &[0, 1, 2]);
        file_2 = writer.current_file().clone();
        assert_eq!(file_2.file_number(), 2);
        for _ in 0..NUM_BLOCKS_PER_FILE {
            writer.write(&buf).await.unwrap();
        }
        file_3 = writer.current_file().clone();
        assert_eq!(&writer.list_file_numbers(), &[0, 1, 2, 3]);
        assert!(!file_0.can_be_deleted());
        drop(file_1);
        writer.directory.gc().await.unwrap();
        assert_eq!(&writer.list_file_numbers(), &[0, 1, 2, 3]);
        drop(file_0);
        writer.directory.gc().await.unwrap();
        assert_eq!(&writer.list_file_numbers(), &[2, 3]);
        drop(file_2);
        writer.directory.gc().await.unwrap();
        assert_eq!(&writer.list_file_numbers(), &[3]);
        drop(file_3);
        writer.directory.gc().await.unwrap();
        assert_eq!(&writer.list_file_numbers(), &[3]);
    }
}