eventfold 0.2.0

Lightweight, append-only event log with derived views — your application state is a fold over an event 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
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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
mod common;

use common::{append_n, dummy_event};
use eventfold::{line_hash, Event, EventLog};
use serde_json::json;
use std::io::Write;
use tempfile::tempdir;

#[test]
fn test_open_creates_directory() {
    let dir = tempdir().unwrap();
    let data_dir = dir.path().join("mydata");

    let _log = EventLog::open(&data_dir).unwrap();

    assert!(data_dir.exists(), "data directory should be created");
    assert!(data_dir.join("views").exists(), "views/ should be created");
    assert!(
        data_dir.join("app.jsonl").exists(),
        "app.jsonl should be created"
    );
}

#[test]
fn test_open_existing_directory() {
    let dir = tempdir().unwrap();
    let data_dir = dir.path().join("data");

    {
        let _log1 = EventLog::open(&data_dir).unwrap();
        // log1 dropped here, releasing the lock
    }
    let _log2 = EventLog::open(&data_dir).unwrap();
    // No error on second open after first is dropped
}

#[test]
fn test_append_single_event() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let event = dummy_event("test_event");
    log.append(&event).unwrap();

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(events[0].0.event_type, "test_event");
    assert_eq!(events[0].0.data, json!({"key": "value"}));
    assert_eq!(events[0].0.ts, 1000);
}

#[test]
fn test_append_multiple_events() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    append_n(&mut log, 10);

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 10);
    for (i, (event, _, _)) in events.iter().enumerate() {
        assert_eq!(event.event_type, format!("event_{i}"));
    }
}

#[test]
fn test_read_from_zero() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    append_n(&mut log, 5);

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 5);
    assert_eq!(events[0].0.event_type, "event_0");
    assert_eq!(events[4].0.event_type, "event_4");
}

#[test]
fn test_read_from_offset() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let mut offsets = Vec::new();
    for i in 0..5 {
        let event = dummy_event(&format!("event_{i}"));
        let result = log.append(&event).unwrap();
        offsets.push(result.start_offset);
    }

    // Read from the offset of the 3rd event (index 2)
    let events: Vec<_> = log
        .read_from(offsets[2])
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 3);
    assert_eq!(events[0].0.event_type, "event_2");
    assert_eq!(events[1].0.event_type, "event_3");
    assert_eq!(events[2].0.event_type, "event_4");
}

#[test]
fn test_byte_offset_correctness() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let mut offsets = Vec::new();
    for i in 0..5 {
        let event = dummy_event(&format!("event_{i}"));
        let result = log.append(&event).unwrap();
        offsets.push(result.start_offset);
    }

    // Each offset should seek to exactly that event
    for (i, &offset) in offsets.iter().enumerate() {
        let events: Vec<_> = log
            .read_from(offset)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();

        assert!(
            !events.is_empty(),
            "read_from offset {offset} should return events"
        );
        assert_eq!(
            events[0].0.event_type,
            format!("event_{i}"),
            "offset {offset} should point to event_{i}"
        );
    }
}

#[test]
fn test_offset_chaining() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    append_n(&mut log, 5);

    // Read first event, get its next_offset
    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    let (_, next_offset, _) = &events[0];

    // Use next_offset to skip past first event
    let remaining: Vec<_> = log
        .read_from(*next_offset)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(remaining.len(), 4);
    assert_eq!(remaining[0].0.event_type, "event_1");
}

#[test]
fn test_empty_log() {
    let dir = tempdir().unwrap();
    let log = EventLog::open(dir.path()).unwrap();

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert!(events.is_empty());
}

#[test]
fn test_hash_determinism() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    // Append two identical events (same content, same ts)
    let mut event = Event::new("same", json!({"x": 1}));
    event.ts = 5000;
    log.append(&event).unwrap();
    log.append(&event).unwrap();

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 2);
    assert_eq!(
        events[0].2, events[1].2,
        "identical event lines should produce identical hashes"
    );
}

#[test]
fn test_hash_differs_for_different_events() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let event_a = dummy_event("type_a");
    let event_b = dummy_event("type_b");
    log.append(&event_a).unwrap();
    log.append(&event_b).unwrap();

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 2);
    assert_ne!(
        events[0].2, events[1].2,
        "different event lines should produce different hashes"
    );
}

#[test]
fn test_line_hash_function() {
    let hash1 = line_hash(b"hello world");
    let hash2 = line_hash(b"hello world");
    let hash3 = line_hash(b"different");

    assert_eq!(hash1, hash2);
    assert_ne!(hash1, hash3);
    assert_eq!(hash1.len(), 16, "hex hash should be 16 characters");
}

#[test]
fn test_reopen_persistence() {
    let dir = tempdir().unwrap();

    // Open, append 3, close
    {
        let mut log = EventLog::open(dir.path()).unwrap();
        append_n(&mut log, 3);
    }

    // Reopen, verify 3 events exist, append 2 more
    {
        let mut log = EventLog::open(dir.path()).unwrap();

        let events: Vec<_> = log
            .read_from(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();
        assert_eq!(events.len(), 3);

        let event3 = dummy_event("event_3");
        let event4 = dummy_event("event_4");
        log.append(&event3).unwrap();
        log.append(&event4).unwrap();

        let all_events: Vec<_> = log
            .read_from(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();
        assert_eq!(all_events.len(), 5);
        assert_eq!(all_events[0].0.event_type, "event_0");
        assert_eq!(all_events[4].0.event_type, "event_4");
    }
}

#[test]
fn test_special_characters() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let mut event = Event::new("special", json!({
        "emoji": "Hello 🌍🦀",
        "newline": "line1\nline2",
        "quote": "He said \"hi\"",
        "unicode": "日本語",
        "backslash": "path\\to\\file"
    }));
    event.ts = 2000;
    log.append(&event).unwrap();

    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    let read_event = &events[0].0;
    assert_eq!(read_event.data["emoji"], "Hello 🌍🦀");
    assert_eq!(read_event.data["newline"], "line1\nline2");
    assert_eq!(read_event.data["quote"], "He said \"hi\"");
    assert_eq!(read_event.data["unicode"], "日本語");
    assert_eq!(read_event.data["backslash"], "path\\to\\file");
}

#[test]
fn test_partial_line_skipped() {
    let dir = tempdir().unwrap();

    // Append some valid events
    {
        let mut log = EventLog::open(dir.path()).unwrap();
        append_n(&mut log, 3);
    }

    // Manually write a partial line (no trailing newline)
    {
        let mut file = std::fs::OpenOptions::new()
            .append(true)
            .open(dir.path().join("app.jsonl"))
            .unwrap();
        write!(file, r#"{{"type":"partial","data":{{}},"ts":99"#).unwrap();
        // No trailing newline — simulates crash mid-write
    }

    // Reopen and read — partial line should be skipped
    let log = EventLog::open(dir.path()).unwrap();
    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(
        events.len(),
        3,
        "should read 3 complete events, skipping partial line"
    );
}

#[test]
fn test_read_from_end_of_file() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    append_n(&mut log, 5);

    // Get the offset past the last event
    let events: Vec<_> = log
        .read_from(0)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();
    let eof_offset = events.last().unwrap().1;

    // Read from EOF — should return nothing
    let events: Vec<_> = log
        .read_from(eof_offset)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert!(events.is_empty(), "reading from EOF should return nothing");
}

#[test]
fn test_append_returns_incrementing_offsets() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let r0 = log.append(&dummy_event("a")).unwrap();
    let r1 = log.append(&dummy_event("b")).unwrap();
    let r2 = log.append(&dummy_event("c")).unwrap();

    assert_eq!(r0.start_offset, 0, "first event should start at offset 0");
    assert!(
        r1.start_offset > r0.start_offset,
        "second offset should be greater than first"
    );
    assert!(
        r2.start_offset > r1.start_offset,
        "third offset should be greater than second"
    );
}

#[test]
fn test_append_result_start_offset() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let result = log.append(&dummy_event("first")).unwrap();
    assert_eq!(result.start_offset, 0, "first append to empty log has start_offset == 0");
}

#[test]
fn test_append_result_end_offset() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let event = dummy_event("test");
    let json = serde_json::to_string(&event).unwrap();
    let expected_end = json.len() as u64 + 1; // +1 for '\n'

    let result = log.append(&event).unwrap();
    assert_eq!(result.start_offset, 0);
    assert_eq!(result.end_offset, expected_end);
}

#[test]
fn test_append_result_consecutive() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let r1 = log.append(&dummy_event("a")).unwrap();
    let r2 = log.append(&dummy_event("b")).unwrap();

    assert_eq!(
        r2.start_offset, r1.end_offset,
        "second append's start_offset should equal first's end_offset"
    );
}

#[test]
fn test_append_result_hash_matches_read() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let result = log.append(&dummy_event("test")).unwrap();

    let events: Vec<_> = log
        .read_from(result.start_offset)
        .unwrap()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(
        events[0].2, result.line_hash,
        "hash from AppendResult should match hash from read_from"
    );
}

#[test]
fn test_append_result_hash_deterministic() {
    let dir = tempdir().unwrap();
    let mut log = EventLog::open(dir.path()).unwrap();

    let event = dummy_event("same");
    let r1 = log.append(&event).unwrap();
    let r2 = log.append(&event).unwrap();

    assert_eq!(
        r1.line_hash, r2.line_hash,
        "same event appended twice should produce same hash"
    );
}

#[test]
fn test_paths_correct() {
    let dir = tempdir().unwrap();
    let log = EventLog::open(dir.path()).unwrap();

    assert_eq!(log.dir(), dir.path());
    assert_eq!(log.log_path(), dir.path().join("app.jsonl"));
    assert_eq!(log.archive_path(), dir.path().join("archive.jsonl.zst"));
    assert_eq!(log.views_dir(), dir.path().join("views"));
}