zeppelin-embed 0.8.0

In-process vector, lexical, and hybrid search for macOS and Apple silicon
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
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
#![allow(clippy::expect_used, clippy::indexing_slicing)]

use std::path::{Path, PathBuf};
use std::sync::{Arc, Condvar, Mutex};

use tempfile::tempdir;
use zeppelin_embed::ingest::{
    DeleteBatch, DocId, DocumentVersion, IngestBatch, IngestDocument, IngestError, Revision,
    SearchRequest,
};
use zeppelin_embed::lifecycle::durability::{CommitTier, DurabilityMode, DurabilityPolicy};
use zeppelin_embed::lifecycle::{CancelToken, OpenOptions, QueryControl, Store, StoreError};
use zeppelin_embed::manifest::io::{MANIFEST_FILE, commit_manifest, load_manifest};
use zeppelin_embed::manifest::{Manifest, ManifestError};
use zeppelin_embed::meta::{AliveSet, ColumnStoreBuilder, Schema};
use zeppelin_embed::quant::Bit4Factors;
use zeppelin_embed::scan::ScanOptions;
use zeppelin_embed::segment::SegmentId;
use zeppelin_embed::segment::writer::{SegmentBuild, SegmentFactors, write_segment};
use zeppelin_embed::vfs::{StdVfs, SyncKind, Vfs, VfsFile};

#[cfg(feature = "graph-cypher")]
mod seal {
    use super::*;

    #[test]
    fn refuses_rotation_behind_the_graph_watermark() {
        assert_graph_shortfall_refuses(false);
    }

    #[test]
    fn refuses_rotation_with_op_11_wrapping_op_10() {
        assert_graph_shortfall_refuses(true);
    }

    fn assert_graph_shortfall_refuses(mixed: bool) {
        let directory = tempdir().expect("store directory");
        let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
        store.enable_graph().expect("enable real graph catalog");
        store.close().expect("close writer");

        let mut manifest = load_manifest(&StdVfs, &directory.path().join(MANIFEST_FILE), 1)
            .expect("real v3 manifest");
        assert_eq!(manifest.log_seq, 0);
        assert_eq!(
            manifest
                .graph
                .as_ref()
                .expect("real graph section")
                .graph_absorbed_through,
            0
        );
        // A real op 10 is required for a graph shortfall. Document-only tails
        // are folded by seal. Admit this framing fixture as already absorbed
        // for open, then regress the durable watermark under the live bundle.
        // Seal must refuse that stale authority before any write. Keep the real
        // catalog and inventory throughout.
        use zeppelin_embed::ingest::wal_payload::{
            DELETE_V1, GRAPH_COMMIT_V1, MIXED_BATCH_MEMBER_V1, encode_delete, encode_graph_commit,
            encode_mixed_batch_member,
        };
        use zeppelin_embed::wal::LogSeq;
        use zeppelin_embed::wal::record::{WalRecord, encode_record};
        let mut payload = encode_graph_commit(
            include_bytes!("fixtures/graph-wal/complete-v1.bin")
                .get(64..2105)
                .expect("complete graph envelope"),
        )
        .expect("op 10 payload");
        let op = if mixed {
            payload = encode_mixed_batch_member(0, 2, GRAPH_COMMIT_V1, &payload)
                .expect("op 11 graph member");
            MIXED_BATCH_MEMBER_V1
        } else {
            GRAPH_COMMIT_V1
        };
        let mut wal =
            zeppelin_embed::wal::header::encode_header(LogSeq::new(1)).expect("WAL header");
        wal.extend(
            encode_record(WalRecord {
                seq: LogSeq::new(1),
                op,
                payload: &payload,
            })
            .expect("op 10 record"),
        );
        let folded = if mixed {
            // Complete the mixed batch with an absorbed no-op document delete.
            let delete = encode_delete(&[DocId::new(9)]).expect("delete payload");
            let member =
                encode_mixed_batch_member(1, 2, DELETE_V1, &delete).expect("op 11 document member");
            wal.extend(
                encode_record(WalRecord {
                    seq: LogSeq::new(2),
                    op: MIXED_BATCH_MEMBER_V1,
                    payload: &member,
                })
                .expect("second mixed member"),
            );
            2
        } else {
            1
        };
        std::fs::write(directory.path().join("wal.ze"), wal).expect("write graph WAL record");
        manifest.log_seq = folded;
        manifest
            .graph
            .as_mut()
            .expect("graph section")
            .graph_absorbed_through = folded;
        commit_manifest(
            &StdVfs,
            directory.path(),
            &manifest,
            DurabilityPolicy::new(DurabilityMode::Durable, CommitTier::Ordered).expect("policy"),
        )
        .expect("commit graph fold");
        let store = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");
        store
            .ingest(IngestBatch::new(vec![IngestDocument::new(
                DocumentVersion::new(DocId::new(1), Revision::new(1)),
                vec![1.0, 0.0],
            )]))
            .expect("ingest document after graph record");
        manifest
            .graph
            .as_mut()
            .expect("graph section")
            .graph_absorbed_through = 0;
        commit_manifest(
            &StdVfs,
            directory.path(),
            &manifest,
            DurabilityPolicy::new(DurabilityMode::Durable, CommitTier::Ordered).expect("policy"),
        )
        .expect("place graph shortfall on real manifest");
        let generation = store.snapshot().expect("snapshot").generation();
        let files_before = files(directory.path());
        let manifest_before =
            std::fs::read(directory.path().join(MANIFEST_FILE)).expect("manifest");
        let wal_before = std::fs::read(directory.path().join("wal.ze")).expect("WAL");

        assert!(matches!(
            store.seal(),
            Err(StoreError::Manifest(ManifestError::Decode(detail)))
                if detail == format!("cannot rotate WAL through {}: graph absorbed only through 0", folded + 1)
        ));
        assert_eq!(store.snapshot().expect("snapshot").generation(), generation);
        assert_eq!(files(directory.path()), files_before);
        assert_eq!(
            std::fs::read(directory.path().join(MANIFEST_FILE)).expect("manifest"),
            manifest_before
        );
        assert_eq!(
            std::fs::read(directory.path().join("wal.ze")).expect("WAL"),
            wal_before
        );
        ingest_one(&store, 2);
        store.close().expect("close writer");
    }

    fn files(directory: &Path) -> Vec<PathBuf> {
        let mut files = StdVfs.list(directory).expect("store files");
        files.sort();
        files
    }
}

#[test]
fn seal_of_an_empty_active_segment_is_an_idempotent_no_op_returning_the_current_generation() {
    let directory = tempdir().expect("store directory");
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");

    assert_eq!(store.seal().expect("seal empty active segment"), 0);
    let empty_snapshot = store.snapshot().expect("empty snapshot");
    assert_eq!(empty_snapshot.generation(), 0);
    assert!(empty_snapshot.segments().is_empty());
    assert!(!directory.path().join(MANIFEST_FILE).exists());
    drop(empty_snapshot);

    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(1), Revision::new(1)),
            vec![1.0, 0.0],
        )]))
        .expect("ingest row");
    let first_generation = store.seal().expect("seal active row");
    assert!(first_generation > 0);

    assert_eq!(
        store.seal().expect("repeat seal of empty active segment"),
        first_generation
    );
    let repeated_snapshot = store.snapshot().expect("snapshot after repeat seal");
    assert_eq!(repeated_snapshot.generation(), first_generation);
    assert_eq!(repeated_snapshot.segments().len(), 1);
}

#[test]
fn seal_retried_after_a_restart_that_already_committed_the_seal_is_a_no_op() {
    let directory = tempdir().expect("store directory");
    let expected = [
        DocumentVersion::new(DocId::new(11), Revision::new(1)),
        DocumentVersion::new(DocId::new(12), Revision::new(2)),
        DocumentVersion::new(DocId::new(13), Revision::new(3)),
    ];
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(expected[0], vec![1.0, 0.0]).with_timestamp(101),
            IngestDocument::new(expected[1], vec![0.0, 1.0]).with_timestamp(102),
            IngestDocument::new(expected[2], vec![-1.0, 0.0]).with_timestamp(103),
        ]))
        .expect("ingest rows");
    let first_generation = store.seal().expect("seal rows");
    store.close().expect("close sealed store");

    let reopened = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");
    let outcome = reopened
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            expected.len(),
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search reopened sealed rows");
    let mut actual = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<Vec<_>>();
    actual.sort_unstable();
    assert_eq!(actual, expected);

    let manifest_before = load_manifest(&StdVfs, &directory.path().join(MANIFEST_FILE), u64::MAX)
        .expect("load manifest before retried seal");
    assert_eq!(
        reopened.seal().expect("retry already committed seal"),
        first_generation
    );
    let snapshot = reopened.snapshot().expect("snapshot after retried seal");
    assert_eq!(snapshot.generation(), first_generation);
    assert_eq!(snapshot.segments().len(), 1);
    let manifest_after = load_manifest(&StdVfs, &directory.path().join(MANIFEST_FILE), u64::MAX)
        .expect("load manifest after retried seal");
    assert_eq!(manifest_after.generation, manifest_before.generation);
    assert_eq!(
        manifest_after.segments.len(),
        manifest_before.segments.len()
    );

    reopened
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(
                DocumentVersion::new(DocId::new(14), Revision::new(1)),
                vec![0.5, 0.5],
            )
            .with_timestamp(104),
        ]))
        .expect("ingest row after retried seal");
    let second_generation = reopened.seal().expect("seal new active row");
    assert!(second_generation > first_generation);
}

#[test]
fn seal_publishes_an_immutable_segment_and_empties_the_active_segment() {
    let directory = tempdir().expect("store directory");
    let existing_id = SegmentId::new(0x0102_0304_0506, [0x11; 10]);
    publish_existing_segment(directory.path(), existing_id);
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    let ack = store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(
                DocumentVersion::new(DocId::new(10), Revision::new(1)),
                vec![1.0, 0.0],
            ),
            IngestDocument::new(
                DocumentVersion::new(DocId::new(11), Revision::new(1)),
                vec![0.0, 1.0],
            ),
        ]))
        .expect("ingest active rows");

    let generation = store.seal().expect("seal active segment");

    let snapshot = store.snapshot().expect("sealed snapshot");
    assert!(generation > ack.generation());
    assert_eq!(snapshot.generation(), generation);
    assert_eq!(snapshot.segments().len(), 2, "seal must append");
    assert_eq!(snapshot.segments()[0].meta().id, existing_id);
    assert_eq!(snapshot.segments()[1].meta().row_count, 2);
    assert_eq!(
        store.stats().expect("post-seal stats").active_segment_bytes,
        0,
        "sealed active rows must release their anonymous buffers"
    );
}

#[test]
fn sealed_rows_survive_close_and_reopen() {
    let directory = tempdir().expect("store directory");
    let expected = [
        DocumentVersion::new(DocId::new(21), Revision::new(1)),
        DocumentVersion::new(DocId::new(22), Revision::new(3)),
        DocumentVersion::new(DocId::new(23), Revision::new(8)),
    ];
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(expected[0], vec![1.0, 0.0]),
            IngestDocument::new(expected[1], vec![0.0, 1.0]),
            IngestDocument::new(expected[2], vec![-1.0, 0.0]),
        ]))
        .expect("ingest rows");
    store.seal().expect("seal rows");
    store.close().expect("close sealed store");

    let reopened = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");
    let outcome = reopened
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            expected.len(),
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("query reopened sealed rows");
    let mut actual = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<Vec<_>>();
    actual.sort_unstable();

    assert_eq!(actual, expected);
}

#[test]
fn reopen_after_seal_does_not_replay_absorbed_wal_records() {
    let directory = tempdir().expect("store directory");
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(
                DocumentVersion::new(DocId::new(31), Revision::new(1)),
                vec![1.0, 0.0],
            ),
            IngestDocument::new(
                DocumentVersion::new(DocId::new(32), Revision::new(1)),
                vec![0.0, 1.0],
            ),
        ]))
        .expect("ingest rows");
    store.seal().expect("seal rows");
    store.close().expect("close sealed store");

    let reopened = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");

    assert_eq!(
        reopened.stats().expect("reopened stats").active_row_count,
        0,
        "absorbed WAL records were rebuilt into the active segment"
    );
}

#[test]
fn seal_retires_wal_records_and_wal_bytes_falls() {
    let directory = tempdir().expect("store directory");
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(41), Revision::new(1)),
            vec![1.0, 0.0],
        )]))
        .expect("ingest row");
    let before = store.stats().expect("pre-seal stats").wal_bytes;

    store.seal().expect("seal row");

    let after = store.stats().expect("post-seal stats").wal_bytes;
    assert!(before > 0, "fixture did not retain a WAL record");
    assert!(
        after < before,
        "wal_bytes did not fall: {before} -> {after}"
    );
    assert_eq!(after, 0, "the complete absorbed prefix must be retired");
}

#[test]
fn seal_refuses_a_boundary_ahead_of_the_durable_wal_end() {
    let directory = tempdir().expect("store directory");
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(51), Revision::new(1)),
            vec![1.0, 0.0],
        )]))
        .expect("ingest row");
    store.seal().expect("seal row");
    let mut manifest = load_manifest(&StdVfs, &directory.path().join(MANIFEST_FILE), u64::MAX)
        .expect("load committed manifest");
    manifest.log_seq = 2;
    let policy = DurabilityPolicy::new(DurabilityMode::Derived, CommitTier::Ordered)
        .expect("derived policy");
    commit_manifest(&StdVfs, directory.path(), &manifest, policy)
        .expect("write ahead boundary fixture");
    store.close().expect("close forged store");

    let error = Store::open(directory.path(), OpenOptions::default())
        .err()
        .expect("ahead boundary must refuse open");

    assert!(
        matches!(
            &error,
            zeppelin_embed::lifecycle::StoreError::Manifest(ManifestError::AheadOfLog {
                snapshot: 2,
                durable: 1
            })
        ),
        "wrong ahead-boundary error: {error:?}"
    );
}

#[test]
fn cancelled_seal_leaves_the_store_unchanged() {
    let directory = tempdir().expect("store directory");
    let store = Arc::new(
        Store::open(
            directory.path(),
            OpenOptions::new().with_durability(DurabilityMode::Durable, CommitTier::Durable),
        )
        .expect("open durable store"),
    );
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(61), Revision::new(1)),
            vec![1.0, 0.0],
        )]))
        .expect("ingest row");
    let before_snapshot = store.snapshot().expect("snapshot before seal");
    let before_generation = before_snapshot.generation();
    let before_segments = before_snapshot
        .segments()
        .iter()
        .map(|segment| segment.meta().clone())
        .collect::<Vec<_>>();
    drop(before_snapshot);
    let before_stats = store.stats().expect("stats before seal");
    let before_files = file_names(directory.path());
    let cancel = CancelToken::new();
    let blocking = BlockingVfs::new(StdVfs);
    blocking.block_next_syncs(1).expect("arm segment sync");
    let sealing_store = Arc::clone(&store);
    let sealing_cancel = cancel.clone();
    let sealing_vfs = blocking.clone();
    let seal = std::thread::spawn(move || {
        sealing_store.seal_with_cancel_on_vfs(&sealing_cancel, &sealing_vfs)
    });
    blocking
        .wait_until_blocked(1)
        .expect("seal reached segment data sync");
    cancel.cancel();
    blocking.release_syncs(1).expect("release segment sync");

    let error = seal
        .join()
        .expect("seal thread")
        .expect_err("cancelled seal must fail");

    assert!(matches!(error, StoreError::SealCancelled));
    let after_snapshot = store.snapshot().expect("snapshot after cancellation");
    assert_eq!(after_snapshot.generation(), before_generation);
    assert_eq!(
        after_snapshot
            .segments()
            .iter()
            .map(|segment| segment.meta().clone())
            .collect::<Vec<_>>(),
        before_segments
    );
    let after_stats = store.stats().expect("stats after cancellation");
    assert_eq!(after_stats.active_row_count, before_stats.active_row_count);
    assert_eq!(
        after_stats.active_segment_bytes,
        before_stats.active_segment_bytes
    );
    assert_eq!(after_stats.wal_bytes, before_stats.wal_bytes);
    assert_eq!(file_names(directory.path()), before_files);
}

#[test]
fn tombstoned_active_rows_do_not_become_live_sealed_rows() {
    let directory = tempdir().expect("store directory");
    let deleted = DocumentVersion::new(DocId::new(71), Revision::new(1));
    let retained = DocumentVersion::new(DocId::new(72), Revision::new(1));
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(deleted, vec![1.0, 0.0]),
            IngestDocument::new(retained, vec![0.0, 1.0]),
        ]))
        .expect("ingest rows");
    store
        .delete(DeleteBatch::new(vec![deleted.doc_id()]))
        .expect("tombstone row");

    store.seal().expect("seal rows");

    let snapshot = store.snapshot().expect("sealed snapshot");
    let sealed = snapshot.segments().first().expect("sealed segment");
    let alive = sealed.alive().expect("sealed alive set");
    assert_eq!(alive.live_count(), 1);
    assert_eq!(alive.tombstone_count(), 1);
    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            2,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search sealed rows");
    let versions = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<Vec<_>>();
    assert_eq!(versions, vec![retained]);
}

#[test]
fn delete_after_seal_removes_the_row_from_search() {
    let directory = tempdir().expect("store directory");
    let deleted = DocumentVersion::new(DocId::new(73), Revision::new(1));
    let retained = DocumentVersion::new(DocId::new(74), Revision::new(1));
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(deleted, vec![1.0, 0.0]),
            IngestDocument::new(retained, vec![0.0, 1.0]),
        ]))
        .expect("ingest rows");
    let sealed_generation = store.seal().expect("seal rows");
    let original_id = store.snapshot().expect("original snapshot").segments()[0]
        .meta()
        .id;

    let ack = store
        .delete(DeleteBatch::new(vec![deleted.doc_id()]))
        .expect("delete sealed row");

    let snapshot = store.snapshot().expect("tombstoned snapshot");
    let replacement = snapshot.segments().first().expect("replacement segment");
    assert!(ack.generation() > sealed_generation);
    assert_eq!(snapshot.generation(), ack.generation());
    assert_ne!(replacement.meta().id, original_id);
    assert!(!directory.path().join(original_id.file_name()).exists());
    assert_eq!(
        replacement
            .alive()
            .expect("replacement alive set")
            .live_count(),
        1
    );
    drop(snapshot);
    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            2,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search after sealed delete");
    let versions = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<Vec<_>>();
    assert_eq!(versions, vec![retained]);

    store.close().expect("close tombstoned store");
    let reopened = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");
    let reopened_outcome = reopened
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            2,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search reopened tombstoned store");
    assert_eq!(
        reopened_outcome
            .candidates
            .iter()
            .filter_map(|candidate| candidate.document())
            .collect::<Vec<_>>(),
        vec![retained]
    );
}

#[test]
fn reingest_after_seal_replaces_rather_than_duplicating() {
    let directory = tempdir().expect("store directory");
    let doc_id = DocId::new(75);
    let old = DocumentVersion::new(doc_id, Revision::new(1));
    let replacement = DocumentVersion::new(doc_id, Revision::new(2));
    let other = DocumentVersion::new(DocId::new(76), Revision::new(1));
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![
            IngestDocument::new(old, vec![1.0, 0.0]),
            IngestDocument::new(other, vec![-1.0, 0.0]),
        ]))
        .expect("ingest rows");
    let sealed_generation = store.seal().expect("seal rows");

    let ack = store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            replacement,
            vec![0.0, 1.0],
        )]))
        .expect("replace sealed revision");

    assert!(ack.generation() > sealed_generation);
    assert_eq!(
        store.snapshot().expect("replacement snapshot").generation(),
        ack.generation()
    );
    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 1.0]),
            3,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search replacement");
    let versions = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<std::collections::BTreeSet<_>>();
    assert_eq!(
        versions,
        std::collections::BTreeSet::from([replacement, other])
    );
    assert!(!versions.contains(&old));

    store.close().expect("close replacement store");
    let reopened = Store::open(directory.path(), OpenOptions::default()).expect("reopen store");
    let reopened_outcome = reopened
        .search(
            SearchRequest::new(&[1.0, 1.0]),
            3,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search reopened replacement");
    assert_eq!(
        reopened_outcome
            .candidates
            .iter()
            .filter_map(|candidate| candidate.document())
            .collect::<std::collections::BTreeSet<_>>(),
        std::collections::BTreeSet::from([replacement, other])
    );
}

#[test]
fn stale_revision_after_seal_is_rejected() {
    let directory = tempdir().expect("store directory");
    let doc_id = DocId::new(77);
    let current = DocumentVersion::new(doc_id, Revision::new(5));
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            current,
            vec![1.0, 0.0],
        )]))
        .expect("ingest current revision");
    let sealed_generation = store.seal().expect("seal current revision");

    let error = store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(doc_id, Revision::new(4)),
            vec![0.0, 1.0],
        )]))
        .expect_err("stale sealed revision must fail");

    assert!(matches!(
        error,
        IngestError::StaleRevision {
            doc_id: rejected,
            current: current_revision,
            attempted,
        } if rejected == doc_id
            && current_revision == Revision::new(5)
            && attempted == Revision::new(4)
    ));
    assert_eq!(
        store.snapshot().expect("unchanged snapshot").generation(),
        sealed_generation
    );
    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            2,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search unchanged sealed revision");
    assert_eq!(outcome.candidates.len(), 1);
    assert_eq!(outcome.candidates[0].document(), Some(current));
}

#[test]
fn sealed_segment_is_searchable_through_store_search() {
    let directory = tempdir().expect("store directory");
    let version = DocumentVersion::new(DocId::new(81), Revision::new(4));
    let store = Store::open(directory.path(), OpenOptions::default()).expect("open store");
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            version,
            vec![1.0, 0.0],
        )]))
        .expect("ingest row");
    store.seal().expect("seal row");

    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 0.0]),
            1,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search store");

    assert_eq!(outcome.candidates.len(), 1);
    assert_eq!(outcome.candidates[0].document(), Some(version));
    assert!(matches!(
        outcome.candidates[0].row_id().source(),
        zeppelin_embed::ingest::RowSource::Sealed(_)
    ));
}

fn file_names(directory: &std::path::Path) -> Vec<std::ffi::OsString> {
    let mut names = std::fs::read_dir(directory)
        .expect("read store directory")
        .map(|entry| entry.expect("directory entry").file_name())
        .collect::<Vec<_>>();
    names.sort_unstable();
    names
}

#[derive(Clone, Default)]
struct BlockingVfs {
    state: Arc<(Mutex<BlockState>, Condvar)>,
}

#[derive(Default)]
struct BlockState {
    armed: bool,
    blocked: bool,
    released: bool,
}

impl BlockingVfs {
    fn new(_: StdVfs) -> Self {
        Self::default()
    }

    fn block_next_syncs(&self, count: usize) -> std::io::Result<()> {
        if count != 1 {
            return Err(std::io::Error::new(
                std::io::ErrorKind::InvalidInput,
                "fixture supports exactly one blocked sync",
            ));
        }
        let mut state = self
            .state
            .0
            .lock()
            .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        state.armed = true;
        state.blocked = false;
        state.released = false;
        Ok(())
    }

    fn wait_until_blocked(&self, count: usize) -> std::io::Result<()> {
        if count != 1 {
            return Err(std::io::Error::new(
                std::io::ErrorKind::InvalidInput,
                "fixture supports exactly one blocked sync",
            ));
        }
        let mut state = self
            .state
            .0
            .lock()
            .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        while !state.blocked {
            state = self
                .state
                .1
                .wait(state)
                .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        }
        Ok(())
    }

    fn release_syncs(&self, count: usize) -> std::io::Result<()> {
        if count != 1 {
            return Err(std::io::Error::new(
                std::io::ErrorKind::InvalidInput,
                "fixture supports exactly one blocked sync",
            ));
        }
        let mut state = self
            .state
            .0
            .lock()
            .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        state.released = true;
        self.state.1.notify_all();
        Ok(())
    }

    fn block_sync(&self) -> std::io::Result<()> {
        let mut state = self
            .state
            .0
            .lock()
            .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        if !state.armed {
            return Ok(());
        }
        state.armed = false;
        state.blocked = true;
        self.state.1.notify_all();
        while !state.released {
            state = self
                .state
                .1
                .wait(state)
                .map_err(|_| std::io::Error::other("blocking VFS mutex poisoned"))?;
        }
        Ok(())
    }
}

impl Vfs for BlockingVfs {
    fn ensure_directory(&self, path: &Path, create: bool) -> std::io::Result<bool> {
        StdVfs.ensure_directory(path, create)
    }

    fn open(&self, path: &Path) -> std::io::Result<u64> {
        StdVfs.open(path)
    }

    fn open_for_map(&self, path: &Path) -> std::io::Result<std::fs::File> {
        StdVfs.open_for_map(path)
    }

    fn read(&self, path: &Path) -> std::io::Result<Vec<u8>> {
        StdVfs.read(path)
    }

    fn read_range(&self, path: &Path, offset: u64, length: usize) -> std::io::Result<Vec<u8>> {
        StdVfs.read_range(path, offset, length)
    }

    fn write(&self, path: &Path, bytes: &[u8]) -> std::io::Result<()> {
        StdVfs.write(path, bytes)
    }

    fn open_append(&self, path: &Path) -> std::io::Result<Box<dyn VfsFile>> {
        StdVfs.open_append(path)
    }

    fn rename(&self, from: &Path, to: &Path) -> std::io::Result<()> {
        StdVfs.rename(from, to)
    }

    fn sync(&self, path: &Path, kind: SyncKind) -> std::io::Result<()> {
        self.block_sync()?;
        StdVfs.sync(path, kind)
    }

    fn list(&self, directory: &Path) -> std::io::Result<Vec<PathBuf>> {
        StdVfs.list(directory)
    }

    fn for_each_direct_child(
        &self,
        directory: &Path,
        visitor: &mut dyn FnMut(&Path) -> std::io::Result<()>,
    ) -> std::io::Result<()> {
        StdVfs.for_each_direct_child(directory, visitor)
    }

    fn delete(&self, path: &Path) -> std::io::Result<()> {
        StdVfs.delete(path)
    }
}

fn publish_existing_segment(directory: &std::path::Path, id: SegmentId) {
    let schema = Schema::new(Vec::new()).expect("timestamp-only schema");
    let mut builder = ColumnStoreBuilder::new(schema.clone());
    builder.push_row(0, &[]).expect("fixture row");
    let columns = builder.finish().expect("fixture columns");
    let policy = DurabilityPolicy::new(DurabilityMode::Derived, CommitTier::Ordered)
        .expect("derived policy");
    let meta = write_segment(
        &StdVfs,
        directory,
        SegmentBuild {
            id,
            scheme: 4,
            dims: 2,
            codes: &[0x88],
            factors: SegmentFactors::Bit4(&[Bit4Factors::from_persisted(1.0, 1.0, 1.0)]),
            rescore: &[0.0, 0.0],
            columns: &columns,
            alive: &AliveSet::new(1),
        },
        policy,
    )
    .expect("write existing segment");
    commit_manifest(
        &StdVfs,
        directory,
        &Manifest {
            #[cfg(feature = "graph-cypher")]
            graph: None,
            generation: 1,
            log_seq: 0,
            segments: vec![meta],
            epochs: Vec::new(),
            epoch_alias: None,
            schema,
        },
        policy,
    )
    .expect("publish existing segment");
}

// ZE-233: seal truncates wal.ze to a header that continues the sequence.

fn durable_options() -> OpenOptions {
    OpenOptions::new().with_durability(DurabilityMode::Durable, CommitTier::Ordered)
}

/// Writes one replacement and one delete, so a double-applied WAL record
/// would surface as a stale revision, a duplicate or a resurrected row.
fn seed_truncation_store(directory: &Path) -> (Store, Vec<DocumentVersion>) {
    let store = Store::open(directory, durable_options()).expect("open store");
    let first = |id| DocumentVersion::new(DocId::new(id), Revision::new(1));
    store
        .ingest(IngestBatch::new(
            (1..=4_u32)
                .map(|id| IngestDocument::new(first(u128::from(id)), vec![id as f32, 1.0]))
                .collect(),
        ))
        .expect("ingest rows");
    let replaced = DocumentVersion::new(DocId::new(2), Revision::new(2));
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            replaced,
            vec![0.0, 2.0],
        )]))
        .expect("replace row");
    store
        .delete(DeleteBatch::new(vec![DocId::new(3)]))
        .expect("delete row");
    (store, vec![first(1), replaced, first(4)])
}

fn live_versions(store: &Store) -> Vec<DocumentVersion> {
    let outcome = store
        .search(
            SearchRequest::new(&[1.0, 1.0]),
            1000,
            ScanOptions { thread_budget: 1 },
            QueryControl::Cancel(CancelToken::new()),
        )
        .expect("search live rows");
    let mut versions = outcome
        .candidates
        .iter()
        .filter_map(|candidate| candidate.document())
        .collect::<Vec<_>>();
    versions.sort_unstable();
    versions
}

/// Copies the store files as they are at this instant: the disk image a
/// process killed here would leave behind.
fn copy_store(source: &Path) -> tempfile::TempDir {
    let copy = tempdir().expect("crash image directory");
    for entry in std::fs::read_dir(source).expect("list store") {
        let path = entry.expect("store entry").path();
        if path.is_file() {
            std::fs::copy(&path, copy.path().join(path.file_name().expect("name")))
                .expect("copy store file");
        }
    }
    copy
}

fn wal_length(directory: &Path) -> u64 {
    std::fs::metadata(directory.join("wal.ze"))
        .expect("wal metadata")
        .len()
}

fn ingest_one(store: &Store, id: u128) -> DocumentVersion {
    let version = DocumentVersion::new(DocId::new(id), Revision::new(1));
    store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            version,
            vec![id as f32, 1.0],
        )]))
        .expect("ingest one row");
    version
}

#[test]
fn seal_truncates_the_wal_to_a_header_and_reopen_continues_its_sequence() {
    let directory = tempdir().expect("store directory");
    let (store, mut expected) = seed_truncation_store(directory.path());
    assert!(wal_length(directory.path()) > 40);

    store.seal().expect("seal rows");

    assert_eq!(
        wal_length(directory.path()),
        40,
        "only the WAL header remains"
    );
    expected.push(ingest_one(&store, 5));
    expected.sort_unstable();
    store.close().expect("close store");
    let reopened = Store::open(directory.path(), durable_options()).expect("reopen");
    assert_eq!(live_versions(&reopened), expected);
    assert_eq!(reopened.stats().expect("stats").active_row_count, 1);
}

#[test]
fn a_kill_at_every_seal_step_reopens_with_every_write_exactly_once() {
    let mut kill_after = 0;
    loop {
        let directory = tempdir().expect("store directory");
        let (store, expected) = seed_truncation_store(directory.path());
        let vfs = StepFaultVfs::new(StepFault::DieAfter(kill_after));
        let result = store.seal_with_cancel_on_vfs(&CancelToken::new(), &vfs);
        let steps = vfs.steps();
        if result.is_ok() {
            // Segment and manifest publication, then the WAL rotation.
            let tail = steps.get(steps.len().saturating_sub(5)..).expect("tail");
            assert_eq!(
                tail,
                [
                    "write .wal.ze.purge.tmp",
                    "sync .wal.ze.purge.tmp",
                    "rename .wal.ze.purge.tmp wal.ze",
                    "open_append wal.ze",
                    "sync .",
                ],
                "steps: {steps:?}"
            );
            assert_eq!(wal_length(directory.path()), 40);
            break;
        }
        // The killed step and any cleanup after it failed without effect.
        let killed = steps.get(kill_after).expect("killed step").clone();
        let steps = format!("#{kill_after} {killed}");
        let image = copy_store(directory.path());
        drop(store);

        let reopened = Store::open(image.path(), durable_options())
            .unwrap_or_else(|error| panic!("killed at {steps:?}: reopen failed: {error}"));
        assert_eq!(live_versions(&reopened), expected, "killed at {steps:?}");
        let mut with_later = expected.clone();
        with_later.push(ingest_one(&reopened, 9));
        with_later.sort_unstable();
        reopened.seal().expect("seal after recovery");
        with_later.push(ingest_one(&reopened, 10));
        with_later.sort_unstable();
        reopened.close().expect("close recovered store");
        let again = Store::open(image.path(), durable_options()).expect("second reopen");
        assert_eq!(live_versions(&again), with_later, "killed at {steps:?}");
        kill_after += 1;
    }
    assert!(kill_after >= 13, "seal ran only {kill_after} steps");
}

/// Index of `label` in the steps of one clean seal of the seeded store.
fn seal_step_index(label: &str) -> usize {
    let directory = tempdir().expect("probe directory");
    let (probe, _) = seed_truncation_store(directory.path());
    let vfs = StepFaultVfs::new(StepFault::DieAfter(usize::MAX));
    probe
        .seal_with_cancel_on_vfs(&CancelToken::new(), &vfs)
        .expect("probe seal");
    let steps = vfs.steps();
    let index = steps.iter().rposition(|step| step == label);
    index.unwrap_or_else(|| panic!("no {label:?} in {steps:?}"))
}

#[test]
fn a_failed_directory_sync_after_the_wal_rename_keeps_later_writes_durable() {
    let directory = tempdir().expect("store directory");
    let (store, mut expected) = seed_truncation_store(directory.path());
    let vfs = StepFaultVfs::new(StepFault::FailOnly(seal_step_index("sync .")));
    store
        .seal_with_cancel_on_vfs(&CancelToken::new(), &vfs)
        .expect_err("the directory sync failure is reported");
    let refused = store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(7), Revision::new(1)),
            vec![7.0, 1.0],
        )]))
        .expect_err("directory sync failure must fence later writes");
    assert!(matches!(
        refused,
        IngestError::Store(StoreError::WalWrite(
            zeppelin_embed::wal::WalWriteError::Failed { ref detail, .. }
        )) if detail.as_ref() == "writer publication did not complete"
    ));
    store.close().expect("close store");

    let reopened = Store::open(directory.path(), durable_options()).expect("reopen");
    assert_eq!(live_versions(&reopened), expected);
    // Only recovery may admit writes after this uncertain publication.
    expected.push(ingest_one(&reopened, 7));
    expected.sort_unstable();
    reopened.close().expect("close recovered writer");
    let again = Store::open(directory.path(), durable_options()).expect("second reopen");
    assert_eq!(live_versions(&again), expected);
}

#[test]
fn a_failed_wal_reopen_after_the_rename_refuses_later_writes() {
    let directory = tempdir().expect("store directory");
    let (store, expected) = seed_truncation_store(directory.path());
    let reopen = seal_step_index("open_append wal.ze");
    let vfs = StepFaultVfs::new(StepFault::FailOnly(reopen));
    store
        .seal_with_cancel_on_vfs(&CancelToken::new(), &vfs)
        .expect_err("the reopen failure is reported");
    let later = DocumentVersion::new(DocId::new(8), Revision::new(1));
    let error = store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            later,
            vec![8.0, 1.0],
        )]))
        .expect_err("a write must not reach the replaced log");
    assert!(
        matches!(
            error,
            IngestError::Store(StoreError::WalWrite(
                zeppelin_embed::wal::WalWriteError::Failed { .. }
            ))
        ),
        "{error:?}"
    );
    drop(store);

    let reopened = Store::open(directory.path(), durable_options()).expect("reopen");
    assert_eq!(live_versions(&reopened), expected);
}

#[derive(Clone, Copy)]
enum StepFault {
    /// Every step after this many fails without touching the disk.
    DieAfter(usize),
    /// Only the step with this index fails; later steps run.
    FailOnly(usize),
}

/// Records every mutating filesystem step and fails the planned ones.
#[derive(Clone)]
struct StepFaultVfs {
    fault: StepFault,
    steps: Arc<Mutex<Vec<String>>>,
}

impl StepFaultVfs {
    fn new(fault: StepFault) -> Self {
        Self {
            fault,
            steps: Arc::new(Mutex::new(Vec::new())),
        }
    }

    fn steps(&self) -> Vec<String> {
        self.steps.lock().expect("steps").clone()
    }

    fn step(&self, label: String) -> std::io::Result<()> {
        let mut steps = self.steps.lock().expect("steps");
        let index = steps.len();
        steps.push(label);
        let fails = match self.fault {
            StepFault::DieAfter(count) => index >= count,
            StepFault::FailOnly(target) => index == target,
        };
        if fails {
            Err(std::io::Error::other("planned step fault"))
        } else {
            Ok(())
        }
    }
}

fn step_name(path: &Path) -> String {
    if path.is_dir() {
        return ".".to_owned();
    }
    path.file_name().map_or_else(
        || ".".to_owned(),
        |name| name.to_string_lossy().into_owned(),
    )
}

struct StepFaultFile {
    inner: Box<dyn VfsFile>,
    name: String,
    vfs: StepFaultVfs,
}

impl VfsFile for StepFaultFile {
    fn append(&mut self, bytes: &[u8]) -> std::io::Result<()> {
        self.vfs.step(format!("append {}", self.name))?;
        self.inner.append(bytes)
    }

    fn sync(&self, kind: SyncKind) -> std::io::Result<()> {
        self.vfs.step(format!("sync-file {}", self.name))?;
        self.inner.sync(kind)
    }
}

impl Vfs for StepFaultVfs {
    fn ensure_directory(&self, path: &Path, create: bool) -> std::io::Result<bool> {
        StdVfs.ensure_directory(path, create)
    }

    fn open(&self, path: &Path) -> std::io::Result<u64> {
        StdVfs.open(path)
    }

    fn open_for_map(&self, path: &Path) -> std::io::Result<std::fs::File> {
        StdVfs.open_for_map(path)
    }

    fn read(&self, path: &Path) -> std::io::Result<Vec<u8>> {
        StdVfs.read(path)
    }

    fn read_range(&self, path: &Path, offset: u64, length: usize) -> std::io::Result<Vec<u8>> {
        StdVfs.read_range(path, offset, length)
    }

    fn write(&self, path: &Path, bytes: &[u8]) -> std::io::Result<()> {
        self.step(format!("write {}", step_name(path)))?;
        StdVfs.write(path, bytes)
    }

    fn create_new(&self, path: &Path, bytes: &[u8]) -> std::io::Result<()> {
        self.step(format!("create_new {}", step_name(path)))?;
        StdVfs.create_new(path, bytes)
    }

    fn open_append(&self, path: &Path) -> std::io::Result<Box<dyn VfsFile>> {
        self.step(format!("open_append {}", step_name(path)))?;
        Ok(Box::new(StepFaultFile {
            inner: StdVfs.open_append(path)?,
            name: step_name(path),
            vfs: self.clone(),
        }))
    }

    fn rename(&self, from: &Path, to: &Path) -> std::io::Result<()> {
        self.step(format!("rename {} {}", step_name(from), step_name(to)))?;
        StdVfs.rename(from, to)
    }

    fn sync(&self, path: &Path, kind: SyncKind) -> std::io::Result<()> {
        self.step(format!("sync {}", step_name(path)))?;
        StdVfs.sync(path, kind)
    }

    fn list(&self, directory: &Path) -> std::io::Result<Vec<PathBuf>> {
        StdVfs.list(directory)
    }

    fn for_each_direct_child(
        &self,
        directory: &Path,
        visitor: &mut dyn FnMut(&Path) -> std::io::Result<()>,
    ) -> std::io::Result<()> {
        StdVfs.for_each_direct_child(directory, visitor)
    }

    fn delete(&self, path: &Path) -> std::io::Result<()> {
        self.step(format!("delete {}", step_name(path)))?;
        StdVfs.delete(path)
    }
}

#[test]
fn idle_merge_bounds_segments_across_1000_seals_and_reopens() {
    let directory = tempdir().expect("directory");
    let mut store = Store::open(directory.path(), durable_options()).expect("open");
    let mut seen = std::collections::HashSet::new();
    let mut previous = std::collections::HashSet::new();
    let mut observe_ids = |store: &Store| {
        let snapshot = store.snapshot().expect("snapshot");
        let current = snapshot
            .segments()
            .iter()
            .map(|s| s.meta().id)
            .collect::<std::collections::HashSet<_>>();
        for id in current.difference(&previous) {
            assert!(seen.insert(*id), "reused live or retired segment {id}");
        }
        previous = current;
    };
    for id in 1..=1000 {
        ingest_one(&store, id);
        store.seal().expect("seal");
        observe_ids(&store);
        // An idle interval every eight seals, including the final interval.
        if id % 8 == 0 {
            store.merge_sealed().expect("idle merge");
        }
        observe_ids(&store);
        let count = store.snapshot().expect("snapshot").segments().len();
        assert!(count <= 8, "small seals accumulated: {count}");
        if id % 100 == 0 {
            store.close().expect("close");
            store = Store::open(directory.path(), durable_options()).expect("reopen");
            assert_eq!(live_versions(&store).len(), id as usize);
        }
    }
    assert_eq!(store.snapshot().expect("snapshot").segments().len(), 1);
}

#[test]
fn idle_merge_preserves_wal_and_purge() {
    let directory = tempdir().expect("directory");
    let store = Store::open(directory.path(), durable_options()).expect("open");
    for id in 1..=4 {
        ingest_one(&store, id);
        store.seal().expect("seal");
    }
    ingest_one(&store, 5);
    let wal = std::fs::read(directory.path().join("wal.ze")).expect("WAL");
    store.merge_sealed().expect("merge");
    assert_eq!(store.snapshot().expect("snapshot").segments().len(), 1);
    assert_eq!(
        std::fs::read(directory.path().join("wal.ze")).expect("WAL"),
        wal
    );
    let token = store.purge(&[DocId::new(2)]).expect("purge");
    store.await_physical_purge(token).expect("purge completes");
    store.close().expect("close");
    let store = Store::open(directory.path(), durable_options()).expect("reopen");
    let ids = live_versions(&store)
        .iter()
        .map(|v| v.doc_id().get())
        .collect::<Vec<_>>();
    assert_eq!(ids, vec![1, 3, 4, 5]);
    store.seal().expect("seal WAL tail");
    store.merge_sealed().expect("merge purge output");
    assert_eq!(store.snapshot().expect("snapshot").segments().len(), 1);
}

#[test]
fn interrupted_idle_merge_reopens_with_all_documents() {
    fn seed(path: &Path) -> Store {
        let store = Store::open(path, durable_options()).expect("open");
        for id in 1..=3 {
            ingest_one(&store, id);
            store.seal().expect("seal");
        }
        store
    }
    let directory = tempdir().expect("directory");
    let store = seed(directory.path());
    let trace = StepFaultVfs::new(StepFault::DieAfter(usize::MAX));
    store
        .merge_sealed_with_cancel_on_vfs(&CancelToken::new(), &trace)
        .expect("trace merge");
    let steps = trace.steps();
    assert!(!steps.is_empty(), "merge must publish a replacement");
    for (cut, step) in steps.iter().enumerate() {
        let directory = tempdir().expect("crash directory");
        let store = seed(directory.path());
        let fault = StepFaultVfs::new(StepFault::DieAfter(cut));
        store
            .merge_sealed_with_cancel_on_vfs(&CancelToken::new(), &fault)
            .expect_err("injected interruption");
        drop(store);
        let store = Store::open(directory.path(), durable_options()).expect("recover");
        assert_eq!(live_versions(&store).len(), 3, "cut {cut}: {step}");
        store.merge_sealed().expect("retry merge");
        assert_eq!(store.snapshot().expect("snapshot").segments().len(), 1);
    }
}

#[test]
fn idle_merge_refuses_batches_over_the_input_byte_bound() {
    let directory = tempdir().expect("directory");
    let store = Store::open(directory.path(), durable_options()).expect("open");
    for id in 1..=20 {
        store
            .ingest(IngestBatch::new(vec![
                IngestDocument::new(
                    DocumentVersion::new(DocId::new(id), Revision::new(1)),
                    vec![1.0, 0.0],
                )
                .with_metadata(vec![7; 512 * 1024]),
            ]))
            .expect("large payload");
        if id % 10 == 0 {
            store.seal().expect("seal");
        }
    }
    let before = store.snapshot().expect("snapshot");
    assert_eq!(
        store.merge_sealed().expect("bounded no-op"),
        before.generation()
    );
    assert_eq!(store.snapshot().expect("snapshot").segments().len(), 2);
}

#[test]
fn idle_merge_respects_cancellation_read_only_and_closed_handles() {
    let directory = tempdir().expect("directory");
    let store = Store::open(directory.path(), durable_options()).expect("open");
    ingest_one(&store, 1);
    store.seal().expect("seal");
    let cancel = CancelToken::new();
    cancel.cancel();
    assert!(matches!(
        store.merge_sealed_with_cancel(&cancel),
        Err(StoreError::SealCancelled)
    ));
    store.close().expect("close");
    assert!(matches!(store.merge_sealed(), Err(StoreError::Closed)));
    let reader = Store::open(directory.path(), OpenOptions::read_only()).expect("reader");
    assert!(matches!(reader.merge_sealed(), Err(StoreError::ReadOnly)));
}

#[test]
fn snapshot_cursor_survives_idle_merge_and_reopen() {
    use zeppelin_embed::lifecycle::{DocumentFields, DocumentScanRequest};
    let directory = tempdir().expect("snapshot merge directory");
    let store = Store::open(directory.path(), durable_options()).expect("open");
    for id in 1..=2 {
        ingest_one(&store, id);
        store.seal().expect("seal initial row");
    }
    let files = store
        .snapshot()
        .expect("published")
        .segments()
        .iter()
        .map(|segment| directory.path().join(segment.meta().id.file_name()))
        .collect::<Vec<_>>();
    ingest_one(&store, 3);
    let view = store.open_snapshot().expect("pin active and sealed rows");
    let request = || {
        DocumentScanRequest::new(
            1,
            DocumentFields::NONE,
            QueryControl::Cancel(CancelToken::new()),
        )
    };
    let first = view.scan_documents(request()).expect("first page");
    store.seal().expect("seal pinned active rows");
    ingest_one(&store, 4);
    store.seal().expect("seal later row");
    store.merge_sealed().expect("merge proceeds while pinned");
    assert_eq!(store.snapshot().expect("merged").segments().len(), 1);
    for path in &files {
        assert!(
            path.exists(),
            "idle merge unlinked pinned input: {}",
            path.display()
        );
    }
    store.close().expect("close source");
    let reader = Store::open(directory.path(), OpenOptions::read_only()).expect("reopen reader");
    assert_eq!(live_versions(&reader).len(), 4);
    let mut ids = first
        .documents
        .iter()
        .map(|row| row.doc_id.get())
        .collect::<Vec<_>>();
    let mut cursor = first.continuation;
    while let Some(next) = cursor {
        let page = view
            .scan_documents(request().with_cursor(next))
            .expect("resume after reopen");
        assert_eq!(page.generation, first.generation);
        ids.extend(page.documents.iter().map(|row| row.doc_id.get()));
        cursor = page.continuation;
    }
    ids.sort_unstable();
    assert_eq!(ids, vec![1, 2, 3]);
    reader.close().expect("close reader");
    view.close().expect("release pin");
    let reopened = Store::open(directory.path(), durable_options()).expect("reopen writer");
    assert_eq!(live_versions(&reopened).len(), 4);
    for path in files {
        assert!(!path.exists(), "retired input not reclaimed");
    }
    reopened.close().expect("close reopened writer");
}

#[test]
fn a_segment_write_failure_fences_the_writer_before_manifest_publication() {
    let directory = tempdir().expect("directory");
    let (store, _) = seed_truncation_store(directory.path());
    let trace = StepFaultVfs::new(StepFault::DieAfter(usize::MAX));
    let probe_directory = tempdir().expect("probe directory");
    let (probe, _) = seed_truncation_store(probe_directory.path());
    probe
        .seal_with_cancel_on_vfs(&CancelToken::new(), &trace)
        .expect("probe seal");
    let segment_rename = trace
        .steps()
        .iter()
        .position(|step| step.starts_with("rename .segment-"))
        .expect("segment rename");
    let fault = StepFaultVfs::new(StepFault::FailOnly(segment_rename));
    store
        .seal_with_cancel_on_vfs(&CancelToken::new(), &fault)
        .expect_err("segment rename fails");
    let error = store
        .ingest(IngestBatch::new(vec![IngestDocument::new(
            DocumentVersion::new(DocId::new(9), Revision::new(1)),
            vec![1.0, 0.0],
        )]))
        .expect_err("segment publication failure must fence the shared writer");
    assert!(matches!(
        error,
        IngestError::Store(StoreError::WalWrite(
            zeppelin_embed::wal::WalWriteError::Failed { .. }
        ))
    ));
}