batpak 0.9.0

Event sourcing with causal graphs and caller-defined gates. Sync API, no async runtime.
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
use super::*;
use crate::coordinate::DagPosition;
use crate::store::index::DiskPos;
use std::io::ErrorKind;
use tempfile::TempDir;

struct FailingRead {
    kind: ErrorKind,
}

impl std::io::Read for FailingRead {
    fn read(&mut self, _buf: &mut [u8]) -> std::io::Result<usize> {
        Err(std::io::Error::from(self.kind))
    }
}

fn test_clock() -> std::sync::Arc<dyn crate::store::Clock> {
    std::sync::Arc::new(crate::store::SystemClock::new())
}

fn test_fs() -> std::sync::Arc<dyn crate::store::platform::fs::StoreFs> {
    std::sync::Arc::new(crate::store::platform::fs::RealFs)
}

fn test_reader() -> (Reader, TempDir) {
    let dir = TempDir::new().expect("create temp dir for reader test");
    let reader = Reader::new(dir.path().to_path_buf(), 4, &test_clock(), test_fs());
    (reader, dir)
}

fn write_segment_bytes(dir: &TempDir, segment_id: u64, bytes: &[u8]) {
    let path = dir.path().join(segment::segment_filename(segment_id));
    std::fs::write(&path, bytes).expect("write segment bytes");
}

#[test]
fn read_frame_header_policy_treats_unexpected_eof_as_clean_end() {
    let mut reader = FailingRead {
        kind: ErrorKind::UnexpectedEof,
    };

    let result = read_frame_header_or_clean_eof(&mut reader).expect("EOF should be non-fatal");

    assert!(
        result.is_none(),
        "PROPERTY: EOF while reading the next frame header is the clean segment terminator"
    );
}

#[test]
fn read_frame_header_policy_surfaces_non_eof_io_errors() {
    let mut reader = FailingRead {
        kind: ErrorKind::PermissionDenied,
    };

    let result = read_frame_header_or_clean_eof(&mut reader);

    assert!(
        matches!(result, Err(error) if error.kind() == ErrorKind::PermissionDenied),
        "PROPERTY: non-EOF frame-header read errors must surface as I/O failures"
    );
}

#[test]
fn frame_decode_error_mapping_preserves_segment_and_offset_context() {
    fn assert_error_trait<E: std::error::Error>() {}

    assert_error_trait::<segment::FrameDecodeError>();

    let crc_error = Reader::frame_decode_error(
        7,
        42,
        segment::FrameDecodeError::CrcMismatch {
            expected: 0xAAAA_AAAA,
            actual: 0xBBBB_BBBB,
        },
    );
    assert!(
        matches!(
            crc_error,
            StoreError::CrcMismatch {
                segment_id: 7,
                offset: 42
            }
        ),
        "PROPERTY: frame CRC failures must retain exact disk position context"
    );

    let truncated_error = Reader::frame_decode_error(
        7,
        42,
        segment::FrameDecodeError::Truncated {
            expected_len: 16,
            available: 12,
        },
    );
    assert!(
        matches!(
            truncated_error,
            StoreError::CorruptSegment { segment_id: 7, ref detail }
            if detail.contains("frame at offset 42")
                && detail.contains("frame truncated: expected 16 bytes, got 12")
        ),
        "PROPERTY: structural frame decode failures must retain segment, offset, and decode reason; got {truncated_error:?}"
    );
}

#[test]
fn acquire_buffer_returns_requested_size() {
    let (reader, _dir) = test_reader();
    let buf = reader.acquire_buffer(256);
    assert_eq!(
        buf.len(),
        256,
        "ACQUIRE BUFFER: expected buffer of size 256, got {}.\n\
         Check: src/store/segment/scan.rs acquire_buffer() vec allocation.",
        buf.len()
    );
    assert!(
        buf.iter().all(|&b| b == 0),
        "ACQUIRE BUFFER: newly allocated buffer should be zero-initialized."
    );
}

#[test]
fn released_buffer_is_zero_filled_and_resized_on_next_acquire() {
    let (reader, _dir) = test_reader();

    let mut buf = reader.acquire_buffer(128);
    for byte in buf.iter_mut() {
        *byte = 0xAB;
    }
    reader.release_buffer(buf);

    let buf2 = reader.acquire_buffer(64);
    assert_eq!(
        buf2.len(),
        64,
        "PROPERTY: re-acquired buffer must match the requested size, \
         regardless of whether it came from the pool or a fresh allocation. \
         Investigate: src/store/segment/scan.rs acquire_buffer resize path."
    );
    assert!(
        buf2.iter().all(|&b| b == 0),
        "PROPERTY: re-acquired buffer must be zero-filled. A non-zero byte \
         means the previous user's data leaked into the new acquirer, \
         which is a memory-safety / information-disclosure bug. \
         Investigate: src/store/segment/scan.rs acquire_buffer fill path."
    );
}

#[test]
fn buffer_pool_does_not_grow_unboundedly() {
    let (reader, _dir) = test_reader();

    for _ in 0..100 {
        reader.release_buffer(vec![0u8; 1024]);
    }

    for i in 0..100 {
        let buf = reader.acquire_buffer(1024);
        assert_eq!(
            buf.len(),
            1024,
            "PROPERTY: buffer {i} of 100 must be the requested size."
        );
        assert!(
            buf.iter().all(|&b| b == 0),
            "PROPERTY: buffer {i} of 100 must be zero-filled."
        );
    }
}

#[test]
fn acquire_buffer_satisfies_contract_on_empty_pool() {
    let (reader, _dir) = test_reader();

    let buf = reader.acquire_buffer(512);
    assert_eq!(
        buf.len(),
        512,
        "PROPERTY: acquire_buffer on a fresh reader must return the \
         requested size. Investigate: src/store/segment/scan.rs allocation \
         path when pool is empty."
    );
    assert!(
        buf.iter().all(|&b| b == 0),
        "PROPERTY: a freshly allocated buffer must be zero-filled."
    );
}

#[test]
fn buffer_pool_retains_at_most_sixteen_released_buffers() {
    let (reader, _dir) = test_reader();

    for _ in 0..17 {
        reader.release_buffer(vec![0u8; 32]);
    }

    let retained = reader.buffer_pool.lock().len();
    assert_eq!(
        retained, 16,
        "PROPERTY: release_buffer must cap the internal pool at exactly 16 buffers; \
         retaining a seventeenth buffer weakens the bounded-memory contract"
    );
}

#[test]
fn batch_marker_payload_decode_ignores_marker_payload_bytes() {
    let header = EventHeader::new(
        1,
        1,
        None,
        1,
        DagPosition::root(),
        0,
        EventKind::SYSTEM_BATCH_BEGIN,
    );
    let event = Event {
        header,
        payload: vec![0xC1],
        hash_chain: Some(HashChain::default()),
    };
    let frame = FramePayload {
        event,
        entity: "entity:batch-marker".to_owned(),
        scope: "scope:test".to_owned(),
        receipt_extensions: BTreeMap::new(),
    };
    let encoded = crate::encoding::to_bytes(&frame).expect("encode batch marker frame");

    let decoded = Reader::decode_frame_payload_value(&encoded)
        .expect("batch marker payload bytes are ignored by value decode");

    assert_eq!(
        decoded.event.payload,
        serde_json::Value::Null,
        "PROPERTY: SYSTEM_BATCH_BEGIN/COMMIT markers carry count semantics in the header; \
         value decoding must not deserialize their raw marker payload bytes"
    );
}

#[test]
fn set_active_segment_advances_the_sealed_cutoff() {
    let (reader, _dir) = test_reader();

    reader.set_active_segment(7);

    assert_eq!(reader.active_segment_id(), 7);
    assert!(
        reader.is_sealed(6),
        "PROPERTY: segments older than the configured active segment must be treated as sealed"
    );
    assert!(
        !reader.is_sealed(7),
        "PROPERTY: the configured active segment itself must stay writable/non-sealed"
    );
    assert!(
        !reader.is_sealed(8),
        "PROPERTY: future segment ids must not be treated as sealed before rotation reaches them"
    );
}

#[test]
fn read_active_frame_into_reads_the_full_requested_slice() {
    let (reader, dir) = test_reader();
    write_segment_bytes(&dir, 0, b"0123456789abcdef");

    let pos = DiskPos::new(0, 3, 5);
    let mut buf = [0u8; 5];
    reader
        .read_active_frame_into(&pos, &mut buf)
        .expect("read active bytes");

    assert_eq!(
        &buf, b"34567",
        "PROPERTY: active-segment reads must advance until the caller's buffer is fully populated"
    );
}

#[test]
fn checked_frame_range_rejects_overflow_and_oversized_lengths() {
    assert!(
        Reader::checked_frame_range(1, u64::MAX, 16, 1024).is_err(),
        "PROPERTY: a frame range that overflows u64 must be rejected"
    );
    assert!(
        Reader::checked_frame_len(1, 4).is_err(),
        "PROPERTY: a frame shorter than the fixed header must be rejected"
    );
    assert!(
        Reader::checked_frame_len(
            1,
            u32::try_from(FRAME_HEADER_BYTES).expect("frame header size fits u32")
        )
        .is_ok(),
        "PROPERTY: a frame length exactly equal to the frame header size is the minimum valid empty-payload frame"
    );
    assert!(Reader::checked_frame_len(
        1,
        u32::try_from(FRAME_HEADER_BYTES + segment::MAX_FRAME_PAYLOAD)
            .expect("max frame length fits u32")
    )
    .is_ok());
    assert!(
        Reader::checked_frame_len(
            1,
            u32::try_from(FRAME_HEADER_BYTES + segment::MAX_FRAME_PAYLOAD + 1)
                .expect("one-past-max frame length fits u32")
        )
        .is_err(),
        "PROPERTY: a frame one byte above MAX_FRAME_PAYLOAD must be rejected"
    );
    assert!(
        Reader::checked_frame_len(1, u32::MAX).is_err(),
        "PROPERTY: a frame length at u32::MAX must be rejected before allocation"
    );
}

#[test]
fn payload_len_exceeds_max_respects_the_exact_boundary() {
    assert!(
        !Reader::payload_len_exceeds_max(segment::MAX_FRAME_PAYLOAD),
        "PROPERTY: a frame exactly at MAX_FRAME_PAYLOAD remains valid"
    );
    assert!(
        Reader::payload_len_exceeds_max(segment::MAX_FRAME_PAYLOAD + 1),
        "PROPERTY: a frame one byte past MAX_FRAME_PAYLOAD must stop scan/recovery before allocation"
    );
}

#[test]
fn checked_header_len_respects_the_exact_boundary() {
    assert_eq!(
        Reader::checked_header_len(7, segment::MAX_SEGMENT_HEADER)
            .expect("a header exactly at MAX_SEGMENT_HEADER remains valid"),
        segment::MAX_SEGMENT_HEADER,
        "PROPERTY: a header exactly at MAX_SEGMENT_HEADER is accepted unchanged"
    );

    let err = Reader::checked_header_len(7, segment::MAX_SEGMENT_HEADER + 1)
        .expect_err("a header one byte past MAX_SEGMENT_HEADER must stop scan before allocation");
    assert!(
        matches!(
            err,
            StoreError::CorruptSegment { segment_id: 7, ref detail }
            if detail.contains("exceeds MAX_SEGMENT_HEADER")
        ),
        "PROPERTY: an oversize header_len must be rejected as CorruptSegment before any vec![0u8; header_len] allocation, got {err:?}"
    );
}

#[test]
fn checked_batch_count_rejects_vacuous_or_implausible_counts() {
    assert!(
        Reader::checked_batch_count(1, 0, 0).is_err(),
        "PROPERTY: a batch count of zero is malformed and must be rejected"
    );
    assert!(
        Reader::checked_batch_count(1, 0, MAX_BATCH_RECOVERY_ITEMS + 1).is_err(),
        "PROPERTY: a batch count above MAX_BATCH_RECOVERY_ITEMS is refused before allocation"
    );
    assert_eq!(
        Reader::checked_batch_count(1, 0, MAX_BATCH_RECOVERY_ITEMS)
            .expect("max batch count remains valid"),
        MAX_BATCH_RECOVERY_ITEMS,
        "PROPERTY: the exact MAX_BATCH_RECOVERY_ITEMS boundary is allowed"
    );
    assert_eq!(
        Reader::checked_batch_count(1, 0, 3).expect("valid batch count"),
        3
    );
}

#[test]
fn scan_oom_posture_is_input_bounded_fail_closed() {
    use crate::store::segment;

    assert_eq!(
        segment::MAX_FRAME_PAYLOAD,
        256 * 1024 * 1024,
        "PROPERTY: frame payload cap is fixed before vec allocation"
    );
    assert_eq!(
        segment::MAX_SEGMENT_HEADER,
        64 * 1024,
        "PROPERTY: segment header cap is fixed before vec allocation"
    );
    assert!(
        Reader::payload_len_exceeds_max(segment::MAX_FRAME_PAYLOAD + 1),
        "PROPERTY: oversize frame claims are refused before allocation (no try_reserve path)"
    );
    assert!(
        Reader::checked_batch_count(1, 0, MAX_BATCH_RECOVERY_ITEMS + 1).is_err(),
        "PROPERTY: oversize recovery batch counts are refused before allocation"
    );
}

/// Build a valid single-frame sealed segment on disk via the real `Segment`
/// writer (which routes all file contact through `crate::store::platform`),
/// returning the `DiskPos` of the written frame and its expected event payload.
/// The segment is sealed by closing its file handle; callers then point the
/// reader's active-segment cutoff past `segment_id` to treat it as sealed.
fn write_valid_sealed_segment(
    dir: &TempDir,
    segment_id: u64,
    entity: &str,
    scope: &str,
    payload: &serde_json::Value,
) -> DiskPos {
    // Mirror the writer: the frame stores the event payload as pre-encoded
    // MessagePack bytes (Event<Vec<u8>>), not an inline serde_json::Value.
    let payload_bytes = crate::encoding::to_bytes(payload).expect("encode payload bytes");
    let event = Event {
        header: EventHeader::new(1, 1, None, 1, DagPosition::root(), 0, EventKind::DATA),
        payload: payload_bytes,
        hash_chain: Some(HashChain::default()),
    };
    let frame = segment::FramePayloadRef {
        event: &event,
        entity,
        scope,
        receipt_extensions: &BTreeMap::new(),
    };
    let frame_bytes = segment::frame_encode(&frame).expect("encode frame");

    let fs: std::sync::Arc<dyn crate::store::platform::fs::StoreFs> =
        std::sync::Arc::new(crate::store::platform::fs::RealFs);
    let mut active = segment::Segment::<segment::Active>::create_with_created_ns_on(
        dir.path(),
        segment_id,
        0,
        &fs,
    )
    .expect("create segment");
    let offset = active.write_frame(&frame_bytes).expect("write frame");
    active
        .sync_with_mode(&crate::store::SyncMode::SyncAll)
        .expect("sync segment");
    let _sealed = active.seal();

    DiskPos::new(
        segment_id,
        offset,
        u32::try_from(frame_bytes.len()).expect("frame length fits u32"),
    )
}

#[test]
fn sealed_read_falls_back_to_fd_when_mmap_admission_is_absent() {
    let (mut reader, dir) = test_reader();
    // Force the no-mmap-admission state (as would happen on a host where the
    // one-time probe could not run, e.g. a read-only data dir).
    reader.disable_sealed_mmap_for_test();
    assert!(
        !reader.sealed_mmap_admitted_for_test(),
        "PRECONDITION: the test must exercise the FD fallback, so mmap admission must be absent"
    );

    let payload = serde_json::json!({"v": "sealed-fd-fallback", "n": 7});
    let pos = write_valid_sealed_segment(&dir, 0, "entity:fd", "scope:fallback", &payload);
    // Mark segment 0 as sealed by advancing the active cutoff past it.
    reader.set_active_segment(1);
    assert!(
        reader.is_sealed(pos.segment_id),
        "PRECONDITION: segment 0 must be sealed once the active cutoff is 1"
    );

    let stored = reader
        .read_entry(&pos)
        .expect("FD fallback must read a valid sealed frame when mmap is not admitted");
    assert_eq!(
        stored.event.payload, payload,
        "PROPERTY: the FD/pread fallback must decode the sealed frame byte-identically to the mmap path"
    );

    let event_only = reader
        .read_event_only(&pos)
        .expect("read_event_only must also fall back to FD on a sealed segment");
    assert_eq!(
        event_only.payload, payload,
        "PROPERTY: read_event_only's FD fallback must return the same event payload"
    );

    // No mmap mapping should have been created on the no-admission path.
    assert!(
        reader.sealed_maps.get(&pos.segment_id).is_none(),
        "PROPERTY: with mmap admission absent, sealed reads must not create any memory mapping"
    );
}

#[test]
fn sealed_mmap_and_fd_paths_return_identical_bytes() {
    // Reader A keeps mmap admission (default); reader B is forced to FD fallback.
    let (reader_mmap, dir) = test_reader();
    let payload = serde_json::json!({"v": "parity", "items": [1, 2, 3], "nested": {"k": "x"}});
    let pos = write_valid_sealed_segment(&dir, 0, "entity:parity", "scope:p", &payload);
    reader_mmap.set_active_segment(1);

    // Build a second reader over the SAME data dir and disable mmap on it.
    let mut reader_fd = Reader::new(dir.path().to_path_buf(), 4, &test_clock(), test_fs());
    reader_fd.disable_sealed_mmap_for_test();
    reader_fd.set_active_segment(1);

    let via_mmap = reader_mmap.read_event_raw_only(&pos).expect("mmap read");
    let via_fd = reader_fd.read_event_raw_only(&pos).expect("fd read");
    assert_eq!(
        via_mmap.payload, via_fd.payload,
        "PROPERTY: mmap and FD reads of the same valid sealed frame must yield identical raw bytes \
         (no silent data divergence between the two read paths)"
    );

    let coord_mmap = reader_mmap.read_entry(&pos).expect("mmap entry");
    let coord_fd = reader_fd.read_entry(&pos).expect("fd entry");
    assert_eq!(
        coord_mmap.event.payload, coord_fd.event.payload,
        "PROPERTY: decoded event payloads must match across mmap and FD paths"
    );
}

#[test]
fn corrupt_sealed_frame_surfaces_same_error_class_on_both_paths() {
    let dir = TempDir::new().expect("tmpdir");
    // Build a valid frame, then flip a payload byte so the CRC fails on decode.
    let payload = serde_json::json!({"v": "corruptible"});
    let pos = write_valid_sealed_segment(&dir, 0, "entity:corrupt", "scope:c", &payload);

    // Corrupt one msgpack byte in the frame. The frame layout is
    // [len:u32 BE][crc:u32 BE][msgpack...]; flipping a payload byte leaves the
    // stored CRC stale, so frame_decode must report CrcMismatch on BOTH paths.
    // All file contact routes through the platform layer (read + atomic write).
    let frame_path = dir.path().join(segment::segment_filename(0));
    let mut segment_bytes =
        crate::store::platform::fs::read(&frame_path).expect("read full segment");
    let payload_byte =
        usize::try_from(pos.offset).expect("offset fits usize") + 8 /* frame header */;
    segment_bytes[payload_byte] ^= 0xFF;
    crate::store::platform::fs::write_derivative_file_atomically(
        dir.path(),
        &frame_path,
        "corrupt-sealed-frame-test",
        &segment_bytes,
    )
    .expect("rewrite corrupted segment");

    // mmap path
    let reader_mmap = Reader::new(dir.path().to_path_buf(), 4, &test_clock(), test_fs());
    reader_mmap.set_active_segment(1);
    let err_mmap = reader_mmap
        .read_entry(&pos)
        .expect_err("a corrupt sealed frame must fail to decode on the mmap path");

    // FD path
    let mut reader_fd = Reader::new(dir.path().to_path_buf(), 4, &test_clock(), test_fs());
    reader_fd.disable_sealed_mmap_for_test();
    reader_fd.set_active_segment(1);
    let err_fd = reader_fd
        .read_entry(&pos)
        .expect_err("a corrupt sealed frame must fail to decode on the FD fallback path");

    assert!(
        matches!(err_mmap, StoreError::CrcMismatch { .. }),
        "PROPERTY: the mmap path must surface CrcMismatch on a corrupt frame, got {err_mmap:?}"
    );
    assert!(
        matches!(err_fd, StoreError::CrcMismatch { .. }),
        "PROPERTY: the FD fallback must surface the SAME error class (CrcMismatch), \
         not swallow or remap corruption differently, got {err_fd:?}"
    );
    assert_eq!(
        std::mem::discriminant(&err_mmap),
        std::mem::discriminant(&err_fd),
        "PROPERTY: corrupt-frame error class must be identical across mmap and FD read paths"
    );
}

#[test]
fn sealed_mmap_probe_runs_at_construction_not_per_read() {
    // A reader constructed on a normal (writable) dir admits mmap exactly once
    // at construction; subsequent sealed reads must not re-probe or re-temp-file.
    let (reader, dir) = test_reader();
    assert!(
        reader.sealed_mmap_admitted_for_test(),
        "PROPERTY: on a writable data dir the one-time construction probe must admit mmap"
    );

    // Perform several sealed reads of distinct segment ids; none of these may
    // re-run the probe (which would write a temp file into the data dir).
    let active_cutoff = 4u64;
    for sid in 0..active_cutoff {
        let pos = write_valid_sealed_segment(
            &dir,
            sid,
            "entity:probe",
            "scope:once",
            &serde_json::json!({"sid": sid}),
        );
        reader.set_active_segment(active_cutoff);
        let stored = reader.read_entry(&pos).expect("read sealed frame via mmap");
        assert_eq!(stored.event.payload, serde_json::json!({"sid": sid}));
    }

    // The cached admission token is the sole probe artifact; it stays stable.
    assert!(
        reader.sealed_mmap_admitted_for_test(),
        "PROPERTY: the cached admission token persists for the reader's lifetime"
    );
}

#[test]
fn required_index_hash_chain_rejects_missing_chain_for_data_event() {
    let event = IndexScanEvent {
        header: EventHeader::new(
            1,
            1,
            None,
            1,
            crate::coordinate::DagPosition::root(),
            0,
            EventKind::DATA,
        ),
        _payload: serde::de::IgnoredAny,
        hash_chain: None,
    };

    let err = Reader::required_index_hash_chain(&event, 7, 99).expect_err("missing hash chain");
    assert!(
        matches!(
            err,
            StoreError::CorruptSegment { segment_id: 7, ref detail }
            if detail.contains("missing hash_chain")
        ),
        "PROPERTY: missing hash_chain must surface as CorruptSegment with the expected detail, got {err:?}"
    );
}

#[test]
fn plaintext_value_from_bytes_maps_batch_markers_to_null_without_decoding() {
    // Batch BEGIN/COMMIT marker frames are written with an EMPTY payload
    // (`Event::new(header, Vec::new())` in the batch writer) — zero bytes is
    // NOT valid msgpack. The marker arm must return Null WITHOUT consulting
    // the msgpack decoder; deleting that match arm routes the empty slice to
    // `encoding::from_bytes`, which errors. This convicts at the unit seam in
    // microseconds — no store, no scan loop, nothing that can hang.
    let begin = Reader::plaintext_value_from_bytes(EventKind::SYSTEM_BATCH_BEGIN, &[]);
    assert!(
        matches!(begin, Ok(serde_json::Value::Null)),
        "SYSTEM_BATCH_BEGIN with the writer's empty payload must decode to Null, got {begin:?}"
    );
    let commit = Reader::plaintext_value_from_bytes(EventKind::SYSTEM_BATCH_COMMIT, &[]);
    assert!(
        matches!(commit, Ok(serde_json::Value::Null)),
        "SYSTEM_BATCH_COMMIT with the writer's empty payload must decode to Null, got {commit:?}"
    );

    // The carve-out is KIND-keyed, not bytes-keyed: even garbage bytes under a
    // marker kind yield Null rather than a decode attempt (0xC1 is the one
    // permanently-invalid msgpack byte, so a decode attempt cannot succeed).
    let garbage = Reader::plaintext_value_from_bytes(EventKind::SYSTEM_BATCH_COMMIT, &[0xC1]);
    assert!(
        matches!(garbage, Ok(serde_json::Value::Null)),
        "marker payload bytes are never decoded, got {garbage:?}"
    );

    // A non-marker kind takes the default arm: real msgpack decodes to its value.
    let bytes = crate::encoding::to_bytes(&serde_json::json!(42)).expect("encode msgpack");
    let user = Reader::plaintext_value_from_bytes(EventKind::DATA, &bytes)
        .expect("plaintext user payload decodes through the default arm");
    assert_eq!(user, serde_json::json!(42));
}

#[test]
fn get_or_map_sealed_maps_an_admitted_segment_then_evict_drops_the_mapping() {
    let (reader, dir) = test_reader();
    assert!(
        reader.sealed_mmap_admitted_for_test(),
        "PRECONDITION: a writable data dir admits sealed-segment mmap at construction"
    );
    let payload = serde_json::json!({"v": "map-me"});
    let pos = write_valid_sealed_segment(&dir, 0, "entity:map", "scope:map", &payload);
    reader.set_active_segment(1);

    // get_or_map_sealed maps the sealed segment and returns Some when mmap is
    // admitted; the `-> Ok(None)` mutant would always signal "not mapped".
    {
        let mapped = reader
            .get_or_map_sealed(pos.segment_id)
            .expect("mapping a valid sealed segment must not error");
        assert!(
            mapped.is_some(),
            "with mmap admitted, get_or_map_sealed must return a live mapping, not None"
        );
    } // drop the Ref before evict — evict takes a write lock on the same DashMap shard

    assert!(
        reader.sealed_maps.get(&pos.segment_id).is_some(),
        "the successful mapping must be cached in sealed_maps"
    );

    // evict_segment drops the cached mapping; the `-> ()` (no-op) mutant leaves it.
    reader.evict_segment(pos.segment_id);
    assert!(
        reader.sealed_maps.get(&pos.segment_id).is_none(),
        "evict_segment must drop the sealed mmap from the cache"
    );
}

#[test]
fn evict_segment_removes_the_target_fd_and_preserves_the_others_in_order() {
    let (reader, dir) = test_reader(); // budget 4 — room for three fds
    for id in 0..3u64 {
        write_segment_bytes(&dir, id, b"0123456789abcdef");
        reader
            .read_active_frame_into(&DiskPos::new(id, 0, 4), &mut [0u8; 4])
            .expect("prime the fd cache for this segment");
    }
    assert_eq!(
        reader.fd_cache.lock().order,
        vec![0, 1, 2],
        "FIXTURE: three fds cached in LRU order"
    );

    reader.evict_segment(1);

    assert_eq!(
        reader.fd_cache.lock().order,
        vec![0, 2],
        "evict_segment must drop ONLY the target's fd and keep the rest in order: the `-> ()` \
         no-op mutant leaves [0,1,2] and the retain `!=`→`==` mutant leaves [1]"
    );
    let cache = reader.fd_cache.lock();
    assert!(
        !cache.fds.contains_key(&1),
        "the evicted segment's fd must be gone"
    );
    assert!(
        cache.fds.contains_key(&0) && cache.fds.contains_key(&2),
        "the non-evicted segments' fds must survive"
    );
}

#[test]
fn read_active_frame_into_distinguishes_zero_and_partial_short_reads() {
    let (reader, dir) = test_reader();
    write_segment_bytes(&dir, 0, &[0u8; 16]);

    // bytes_read == 0 (the read starts AT eof): real maps to corrupt_eof, whose
    // detail is exactly "unexpected EOF during read".
    let at_eof = reader
        .read_active_frame_into(&DiskPos::new(0, 16, 4), &mut [0u8; 4])
        .expect_err("a read starting at EOF must fail");
    assert!(
        matches!(
            &at_eof,
            StoreError::CorruptSegment { segment_id: 0, detail }
            if detail == "unexpected EOF during read"
        ),
        "a zero-byte short read is EOF; the `bytes_read == 0`→`!= 0` mutant misroutes it to the \
         partial-read detail, got {at_eof:?}"
    );

    // bytes_read > 0 (offset before eof, buffer overruns): real maps to the
    // "ended before requested length" truncation detail.
    let partial = reader
        .read_active_frame_into(&DiskPos::new(0, 14, 8), &mut [0u8; 8])
        .expect_err("a read overrunning EOF must fail");
    assert!(
        matches!(
            &partial,
            StoreError::CorruptSegment { segment_id: 0, detail }
            if detail.contains("ended before requested length")
        ),
        "a partial short read is truncation, not EOF; the `bytes_read == 0`→`!= 0` mutant misroutes \
         it to the EOF detail, got {partial:?}"
    );
}

#[test]
fn with_fd_evicts_the_oldest_when_the_cache_is_at_budget() {
    let dir = TempDir::new().expect("create temp dir for fd-budget test");
    // Budget of ONE fd: opening a second segment must evict the first.
    let reader = Reader::new(dir.path().to_path_buf(), 1, &test_clock(), test_fs());
    for id in 0..2u64 {
        write_segment_bytes(&dir, id, b"0123456789abcdef");
        reader
            .read_active_frame_into(&DiskPos::new(id, 0, 4), &mut [0u8; 4])
            .expect("prime the fd cache for this segment");
    }

    let cache = reader.fd_cache.lock();
    assert_eq!(
        cache.fds.len(),
        1,
        "a budget-1 fd cache must evict on the second insert; the `>=`→`<` mutant skips eviction \
         and holds two fds"
    );
    assert_eq!(
        cache.order,
        vec![1],
        "only the most-recently opened segment fd survives when the budget is 1"
    );
}

#[test]
fn required_index_hash_chain_rejects_a_batch_marker_reaching_validation() {
    // A batch BEGIN/COMMIT marker carries no hash_chain, but it must NOT be treated
    // as a generic missing-chain data event — it should never reach hash-chain
    // validation, so it gets its OWN distinct error. The match-guard
    // `matches!(...)`→`false` mutant drops that arm and misroutes the marker to the
    // generic missing-chain arm.
    let event = IndexScanEvent {
        header: EventHeader::new(
            1,
            1,
            None,
            1,
            crate::coordinate::DagPosition::root(),
            0,
            EventKind::SYSTEM_BATCH_BEGIN,
        ),
        _payload: serde::de::IgnoredAny,
        hash_chain: None,
    };

    let err = Reader::required_index_hash_chain(&event, 7, 99)
        .expect_err("a chainless batch marker must error");
    assert!(
        matches!(
            err,
            StoreError::CorruptSegment { segment_id: 7, ref detail }
            if detail.contains("should not reach hash-chain validation")
        ),
        "a batch marker must surface the 'should not reach hash-chain validation' detail, not the \
         generic missing-hash_chain detail; got {err:?}"
    );
}