loonfs-core 0.2.0

Core LoonFS engine: namespace metadata, commits, replay, and maintenance.
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
//! Behavior tests for WAL segment preparation and validated chain loading.

use super::*;
use crate::commit::{
    materialize_commit, wal_payload_from_materialized_commit, CommitFingerprint, CommitIr,
    CommitOp, CommitPlan, MaterializedCommit, PlannedOp, PreparedCommit, ValidatedOp,
};
use bytes::Bytes;
use loonfs_api::wire::control::WalSegmentPointer;
use loonfs_api::wire::wal::{encode_wal_segment_envelope_zstd, WalSegmentEnvelope};
use loonfs_api::{ChangeSeq, CommitId, InodeId, NameKey, NamespaceId, WalSegmentId, WriterEpoch};
use loonfs_objectstore::keys::wal_segment;
use loonfs_objectstore::local_fs_store::LocalFsStore;
use loonfs_objectstore::ObjectStore;
use std::borrow::Cow;
use tempfile::tempdir;

fn test_fingerprint() -> CommitFingerprint {
    CommitFingerprint::new_unchecked("v0:sha256:test".to_owned())
}

#[tokio::test]
async fn build_wal_record_payload_matches_segment_record_payload() {
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let request = CommitIr {
        namespace_id: namespace_id.clone(),
        commit_id: CommitId::parse("c_wal_payload").expect("valid commit id"),
        writer_epoch: WriterEpoch(1),
        ops: vec![PlannedOp::unchecked(CommitOp::CreateDirectory {
            parent_inode_id: InodeId(1),
            display_name: loonfs_api::DisplayName::parse("docs").expect("valid display name"),
        })],
        message: Some("create docs".to_owned()),
    };
    let plan = CommitPlan {
        namespace_id: namespace_id.clone(),
        commit_id: CommitId::parse("c_wal_payload").expect("valid commit id"),
        apply_after_seq: ChangeSeq(0),
        assigned_seq: ChangeSeq(1),
        validated_ops: vec![ValidatedOp::CreateDir {
            op_index: 0,
            parent_inode_id: InodeId(1),
            display_name: loonfs_api::DisplayName::parse("docs").expect("valid display name"),
            name_key: NameKey::parse("docs").expect("valid name key"),
            child_inode_id: InodeId(2),
            create_inode_delta_index: 0,
            bind_delta_index: 1,
        }],
        resulting_next_inode_id: InodeId(3),
    };
    let prepared = PreparedCommit::new(request, plan, test_fingerprint()).expect("prepare commit");
    let record = materialize_commit(prepared, 4_200);

    let segment = prepare_wal_segment(
        namespace_id,
        WriterEpoch(1),
        None,
        std::slice::from_ref(&record),
    )
    .expect("prepare wal segment");
    let payload = wal_payload_from_materialized_commit(&record).expect("build commit payload");

    assert_eq!(payload, segment.envelope.payload.records[0]);
}

#[tokio::test]
async fn prepared_wal_segments_use_unique_segment_ids_and_object_keys() {
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let record = materialized_create_directory(
        &namespace_id,
        "c_wal_unique",
        "docs",
        ChangeSeq(0),
        ChangeSeq(1),
    );

    let first = prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(1),
        None,
        std::slice::from_ref(&record),
    )
    .expect("prepare first wal segment");
    let second = prepare_wal_segment(
        namespace_id,
        WriterEpoch(1),
        None,
        std::slice::from_ref(&record),
    )
    .expect("prepare second wal segment");

    assert_ne!(first.segment_id, second.segment_id);
    assert_ne!(first.object_key, second.object_key);
    WalSegmentId::parse(first.segment_id.as_str()).expect("first segment id shape");
    WalSegmentId::parse(second.segment_id.as_str()).expect("second segment id shape");
}

#[test]
fn wal_segment_namespace_mismatch_names_record_and_segment_values() {
    let record_namespace = NamespaceId::parse("record").expect("valid namespace id");
    let segment_namespace = NamespaceId::parse("segment").expect("valid namespace id");
    let record = materialized_create_directory(
        &record_namespace,
        "c_wal_namespace_mismatch",
        "docs",
        ChangeSeq(0),
        ChangeSeq(1),
    );

    let error = prepare_wal_segment(segment_namespace, WriterEpoch(1), None, &[record])
        .expect_err("namespace mismatch should fail");

    assert_eq!(
        error.to_string(),
        "WAL segment namespace mismatch: record `record`, segment `segment`"
    );
}

#[tokio::test]
async fn validated_wal_chain_loads_visible_segments_in_ascending_order() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let segment = write_create_directory_segment(
        &store,
        &namespace_id,
        None,
        "c_wal_chain_a",
        "alpha",
        ChangeSeq(0),
        ChangeSeq(1),
    )
    .await;

    let chain = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(1),
            visible_tip: Some(segment.envelope.pointer(segment.object_key.clone())),
            stop_after_seq: None,
            recent_segments: &[],
        },
    )
    .await
    .expect("load valid chain");

    assert_eq!(chain.segments().len(), 1);
    assert_eq!(chain.segments()[0].records()[0].seq, ChangeSeq(1));
}

#[test]
fn canonical_replay_advances_head_and_applies_metadata_rows() {
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let commit = materialized_create_directory(
        &namespace_id,
        "c_wal_replay",
        "docs",
        ChangeSeq(0),
        ChangeSeq(1),
    );
    let segment = prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(1),
        None,
        std::slice::from_ref(&commit),
    )
    .expect("prepare wal segment");
    let mut base_head = loonfs_api::wire::control::HeadState::initial(
        namespace_id.clone(),
        loonfs_api::ContentStoreId::generate(),
    );
    base_head.writer_epoch = WriterEpoch(1);
    let record = segment
        .envelope
        .payload
        .records
        .first()
        .expect("wal record");

    let replayed = replay::replay_wal_records(
        &base_head,
        &crate::metadata::MetadataState::default(),
        Some(WriterEpoch(1)),
        [DecodedWalRecord {
            namespace_id: &namespace_id,
            seq: record.seq,
            writer_epoch: segment.envelope.payload.writer_epoch,
            commit_id: &record.commit_id,
            committed_at_ms: record.committed_at_ms,
            semantic_commit_fingerprint: &record.semantic_commit_fingerprint,
            message: record.message.as_deref(),
            deltas: Cow::Borrowed(&record.deltas),
        }],
    )
    .expect("replay wal records");

    assert_eq!(replayed.resulting_head.seq, ChangeSeq(1));
    assert_eq!(replayed.resulting_head.head_commit_id, record.commit_id);
    assert_eq!(replayed.resulting_head.next_inode_id, InodeId(3));
    assert!(replayed
        .resulting_metadata_state
        .inode_at_head(InodeId(2))
        .is_some());
    assert!(replayed
        .resulting_metadata_state
        .find_commit_receipt(&record.commit_id)
        .is_some());
}

#[test]
fn canonical_replay_rejects_writer_epoch_above_expected_bound() {
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let commit = materialized_create_directory(
        &namespace_id,
        "c_wal_replay_epoch",
        "docs",
        ChangeSeq(0),
        ChangeSeq(1),
    );
    let segment = prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(2),
        None,
        std::slice::from_ref(&commit),
    )
    .expect("prepare wal segment");
    let mut base_head = loonfs_api::wire::control::HeadState::initial(
        namespace_id.clone(),
        loonfs_api::ContentStoreId::generate(),
    );
    base_head.writer_epoch = WriterEpoch(1);
    let record = segment
        .envelope
        .payload
        .records
        .first()
        .expect("wal record");

    let error = replay::replay_wal_records(
        &base_head,
        &crate::metadata::MetadataState::default(),
        Some(WriterEpoch(1)),
        [DecodedWalRecord {
            namespace_id: &namespace_id,
            seq: record.seq,
            writer_epoch: segment.envelope.payload.writer_epoch,
            commit_id: &record.commit_id,
            committed_at_ms: record.committed_at_ms,
            semantic_commit_fingerprint: &record.semantic_commit_fingerprint,
            message: record.message.as_deref(),
            deltas: Cow::Borrowed(&record.deltas),
        }],
    )
    .expect_err("future writer epoch should fail");

    assert_eq!(
        error,
        WalReplayError::WriterEpochMismatch {
            expected_max: WriterEpoch(1),
            actual: WriterEpoch(2),
        }
    );
}

#[tokio::test]
async fn validated_wal_chain_can_load_cursor_suffix_without_full_base() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let first = write_create_directory_segment(
        &store,
        &namespace_id,
        None,
        "c_wal_suffix_a",
        "alpha",
        ChangeSeq(0),
        ChangeSeq(1),
    )
    .await;
    let second = write_create_directory_segment(
        &store,
        &namespace_id,
        Some(first.envelope.pointer(first.object_key.clone())),
        "c_wal_suffix_b",
        "beta",
        ChangeSeq(1),
        ChangeSeq(2),
    )
    .await;

    let chain = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(second.envelope.pointer(second.object_key.clone())),
            stop_after_seq: Some(ChangeSeq(1)),
            recent_segments: &[],
        },
    )
    .await
    .expect("load suffix chain");

    assert_eq!(chain.segments().len(), 1);
    assert_eq!(chain.segments()[0].records()[0].seq, ChangeSeq(2));
}

#[tokio::test]
async fn validated_wal_chain_reports_missing_previous_link_truthfully() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let segment = write_create_directory_segment(
        &store,
        &namespace_id,
        None,
        "c_wal_broken_link",
        "docs",
        ChangeSeq(1),
        ChangeSeq(2),
    )
    .await;

    let error = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(segment.envelope.pointer(segment.object_key.clone())),
            stop_after_seq: None,
            recent_segments: &[],
        },
    )
    .await
    .expect_err("missing previous segment link should fail");

    assert_eq!(
        error.to_string(),
        format!(
            "wal replay validation failed: WAL segment `{}` is missing its previous visible segment link before seq `0`",
            segment.object_key
        )
    );
}

#[tokio::test]
async fn validated_wal_chain_rejects_corrupt_visible_segments() {
    assert_wal_chain_corruption_rejected(|object_key, _envelope, pointer| {
        *object_key = wal_segment("other", "seg_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
        pointer.object_key = object_key.clone();
    })
    .await;
    assert_wal_chain_corruption_rejected(|object_key, envelope, pointer| {
        envelope.payload.namespace_id = NamespaceId::parse("other").expect("valid namespace id");
        rewrap_envelope(envelope);
        *object_key = wal_segment(
            envelope.payload.namespace_id.as_str(),
            envelope.payload.segment_id.as_str(),
        );
        *pointer = envelope.pointer(object_key.clone());
    })
    .await;
    assert_wal_chain_corruption_rejected(|_object_key, envelope, _pointer| {
        envelope.payload.segment_id =
            WalSegmentId::parse("00000000000000000001-bbbbbbbbbbbbbbbb").expect("valid segment id");
        rewrap_envelope(envelope);
    })
    .await;
    assert_wal_chain_corruption_rejected(|_object_key, _envelope, pointer| {
        pointer.payload_checksum = "sha256:not-the-payload".to_owned();
    })
    .await;
    assert_wal_chain_corruption_rejected(|object_key, envelope, pointer| {
        envelope.payload.records.clear();
        rewrap_envelope(envelope);
        *pointer = envelope.pointer(object_key.clone());
    })
    .await;
    assert_wal_chain_corruption_rejected(|object_key, envelope, pointer| {
        envelope.payload.end_seq = ChangeSeq(2);
        rewrap_envelope(envelope);
        *object_key = wal_segment(
            envelope.payload.namespace_id.as_str(),
            envelope.payload.segment_id.as_str(),
        );
        *pointer = envelope.pointer(object_key.clone());
    })
    .await;
    assert_wal_chain_corruption_rejected(|object_key, envelope, pointer| {
        let mut skipped = envelope.payload.records[0].clone();
        skipped.seq = ChangeSeq(3);
        envelope.payload.records.push(skipped);
        envelope.payload.end_seq = ChangeSeq(3);
        rewrap_envelope(envelope);
        *object_key = wal_segment(
            envelope.payload.namespace_id.as_str(),
            envelope.payload.segment_id.as_str(),
        );
        *pointer = envelope.pointer(object_key.clone());
    })
    .await;
    assert_wal_chain_corruption_rejected(|object_key, envelope, pointer| {
        envelope.payload.base_head_seq = ChangeSeq(1);
        envelope.payload.start_seq = ChangeSeq(2);
        envelope.payload.end_seq = ChangeSeq(2);
        envelope.payload.records[0].seq = ChangeSeq(2);
        rewrap_envelope(envelope);
        *object_key = wal_segment(
            envelope.payload.namespace_id.as_str(),
            envelope.payload.segment_id.as_str(),
        );
        *pointer = envelope.pointer(object_key.clone());
    })
    .await;
}

fn materialized_create_directory(
    namespace_id: &NamespaceId,
    commit_id: &str,
    display_name: &str,
    apply_after_seq: ChangeSeq,
    assigned_seq: ChangeSeq,
) -> MaterializedCommit {
    let request = CommitIr {
        namespace_id: namespace_id.clone(),
        commit_id: CommitId::parse(commit_id).expect("valid commit id"),
        writer_epoch: WriterEpoch(1),
        ops: vec![PlannedOp::unchecked(CommitOp::CreateDirectory {
            parent_inode_id: InodeId(1),
            display_name: loonfs_api::DisplayName::parse(display_name).expect("valid display name"),
        })],
        message: None,
    };
    let plan = CommitPlan {
        namespace_id: namespace_id.clone(),
        commit_id: CommitId::parse(commit_id).expect("valid commit id"),
        apply_after_seq,
        assigned_seq,
        validated_ops: vec![ValidatedOp::CreateDir {
            op_index: 0,
            parent_inode_id: InodeId(1),
            display_name: loonfs_api::DisplayName::parse(display_name).expect("valid display name"),
            name_key: NameKey::parse(loonfs_api::name_key_for_display_name(display_name))
                .expect("derived name key"),
            child_inode_id: InodeId(2),
            create_inode_delta_index: 0,
            bind_delta_index: 1,
        }],
        resulting_next_inode_id: InodeId(3),
    };
    let prepared = PreparedCommit::new(request, plan, test_fingerprint()).expect("prepare commit");
    materialize_commit(prepared, 4_200)
}

async fn assert_wal_chain_corruption_rejected(
    corrupt: impl FnOnce(&mut String, &mut WalSegmentEnvelope, &mut WalSegmentPointer),
) {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let segment = prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(1),
        None,
        &[materialized_create_directory(
            &namespace_id,
            "c_wal_corrupt",
            "docs",
            ChangeSeq(0),
            ChangeSeq(1),
        )],
    )
    .expect("prepare wal segment");
    let mut object_key = segment.object_key;
    let mut envelope = segment.envelope;
    let mut pointer = envelope.pointer(object_key.clone());

    corrupt(&mut object_key, &mut envelope, &mut pointer);

    let encoded = encode_wal_segment_envelope_zstd(&envelope).expect("encode corrupted envelope");
    store
        .put_if_absent(&object_key, Bytes::from(encoded))
        .await
        .expect("write corrupted wal segment");

    load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: pointer.end_seq,
            visible_tip: Some(pointer),
            stop_after_seq: None,
            recent_segments: &[],
        },
    )
    .await
    .expect_err("corrupted WAL chain should be rejected");
}

#[tokio::test]
async fn chain_load_with_recent_segment_hints_matches_the_unhinted_chain() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let first = write_create_directory_segment(
        &store,
        &namespace_id,
        None,
        "c_wal_hint_a",
        "alpha",
        ChangeSeq(0),
        ChangeSeq(1),
    )
    .await;
    let second = write_create_directory_segment(
        &store,
        &namespace_id,
        Some(first.envelope.pointer(first.object_key.clone())),
        "c_wal_hint_b",
        "beta",
        ChangeSeq(1),
        ChangeSeq(2),
    )
    .await;
    let unhinted = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(second.envelope.pointer(second.object_key.clone())),
            stop_after_seq: None,
            recent_segments: &[],
        },
    )
    .await
    .expect("unhinted chain");

    // Accurate hints (newest first, tip included) prefetch the gap.
    let accurate = [
        second.envelope.pointer(second.object_key.clone()),
        first.envelope.pointer(first.object_key.clone()),
    ];
    let hinted = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(second.envelope.pointer(second.object_key.clone())),
            stop_after_seq: None,
            recent_segments: &accurate,
        },
    )
    .await
    .expect("hinted chain");
    assert_eq!(hinted.segments(), unhinted.segments());

    // Garbage hints (missing objects, lying seq ranges) cost fallback
    // fetches, never correctness: chain links stay the authority.
    let mut lying_tip = second.envelope.pointer(second.object_key.clone());
    lying_tip.end_seq = ChangeSeq(999);
    let missing_segment_id =
        WalSegmentId::parse("00000000000000000001-00000000deadbeef").expect("valid segment id");
    let garbage = [
        WalSegmentPointer {
            object_key: wal_segment(namespace_id.as_str(), missing_segment_id.as_str()),
            segment_id: missing_segment_id,
            start_seq: ChangeSeq(1),
            end_seq: ChangeSeq(1),
            payload_checksum: "sha256:absent".to_owned(),
        },
        lying_tip,
    ];
    let survived = load_validated_wal_chain(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(second.envelope.pointer(second.object_key.clone())),
            stop_after_seq: None,
            recent_segments: &garbage,
        },
    )
    .await
    .expect("chain despite garbage hints");
    assert_eq!(survived.segments(), unhinted.segments());
}

async fn write_create_directory_segment(
    store: &LocalFsStore,
    namespace_id: &NamespaceId,
    prev_visible_segment: Option<WalSegmentPointer>,
    commit_id: &str,
    display_name: &str,
    apply_after_seq: ChangeSeq,
    assigned_seq: ChangeSeq,
) -> PreparedWalSegment {
    let segment = prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(1),
        prev_visible_segment,
        &[materialized_create_directory(
            namespace_id,
            commit_id,
            display_name,
            apply_after_seq,
            assigned_seq,
        )],
    )
    .expect("prepare wal segment");
    store
        .put_if_absent(
            &segment.object_key,
            Bytes::copy_from_slice(&segment.encoded_bytes),
        )
        .await
        .expect("write wal segment");
    segment
}

fn rewrap_envelope(envelope: &mut WalSegmentEnvelope) {
    *envelope =
        WalSegmentEnvelope::from_payload(envelope.payload.clone()).expect("rewrap wal envelope");
}

fn prepared_create_directory_segment(
    namespace_id: &NamespaceId,
    prev_visible_segment: Option<WalSegmentPointer>,
    commit_id: &str,
    display_name: &str,
    apply_after_seq: ChangeSeq,
    assigned_seq: ChangeSeq,
) -> PreparedWalSegment {
    prepare_wal_segment(
        namespace_id.clone(),
        WriterEpoch(1),
        prev_visible_segment,
        &[materialized_create_directory(
            namespace_id,
            commit_id,
            display_name,
            apply_after_seq,
            assigned_seq,
        )],
    )
    .expect("prepare wal segment")
}

/// Prepares a linked chain of `len` single-commit segments covering seqs
/// `1..=len`, without writing any of them to a store.
fn prepared_unstored_chain(namespace_id: &NamespaceId, len: u64) -> Vec<PreparedWalSegment> {
    let mut chain: Vec<PreparedWalSegment> = Vec::new();
    for seq in 1..=len {
        let prev = chain
            .last()
            .map(|segment| segment.envelope.pointer(segment.object_key.clone()));
        chain.push(prepared_create_directory_segment(
            namespace_id,
            prev,
            &format!("c_count_{seq}"),
            &format!("dir-{seq}"),
            ChangeSeq(seq - 1),
            ChangeSeq(seq),
        ));
    }
    chain
}

fn newest_first_pointers(chain: &[PreparedWalSegment]) -> Vec<WalSegmentPointer> {
    chain
        .iter()
        .rev()
        .map(|segment| segment.envelope.pointer(segment.object_key.clone()))
        .collect()
}

#[tokio::test]
async fn tail_count_from_contiguous_hints_reads_no_bodies() {
    // The store stays empty on purpose: any body fetch would fail with
    // `MissingWalObject`, so a successful count came from pointers alone.
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let chain = prepared_unstored_chain(&namespace_id, 3);
    let hints = newest_first_pointers(&chain);

    let count = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(3),
            visible_tip: Some(hints[0].clone()),
            stop_after_seq: None,
            recent_segments: &hints,
        },
    )
    .await
    .expect("count from pointers");
    assert_eq!(count, 3);

    // A manifest boundary inside the hinted window is honored: only the
    // segments above it are tail.
    let count = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(2),
            head_seq: ChangeSeq(3),
            visible_tip: Some(hints[0].clone()),
            stop_after_seq: None,
            recent_segments: &hints,
        },
    )
    .await
    .expect("count above interior boundary");
    assert_eq!(count, 1);

    // An empty tail costs nothing and consults nothing.
    let count = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(3),
            head_seq: ChangeSeq(3),
            visible_tip: Some(hints[0].clone()),
            stop_after_seq: None,
            recent_segments: &hints,
        },
    )
    .await
    .expect("count of empty tail");
    assert_eq!(count, 0);
}

#[tokio::test]
async fn tail_count_walks_only_past_the_hinted_window() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let chain = prepared_unstored_chain(&namespace_id, 3);
    // Store only the middle segment: the tip is hint-covered and the
    // oldest is resolved through the middle segment's chain link, so
    // neither body may be touched.
    store
        .put_if_absent(
            &chain[1].object_key,
            Bytes::copy_from_slice(&chain[1].encoded_bytes),
        )
        .await
        .expect("write middle wal segment");
    let pointers = newest_first_pointers(&chain);
    let short_window = &pointers[..2];

    let count = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(3),
            visible_tip: Some(pointers[0].clone()),
            stop_after_seq: None,
            recent_segments: short_window,
        },
    )
    .await
    .expect("count past hinted window");
    assert_eq!(count, 3);
}

#[tokio::test]
async fn tail_count_matches_loaded_chain_length() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let chain = prepared_unstored_chain(&namespace_id, 3);
    for segment in &chain {
        store
            .put_if_absent(
                &segment.object_key,
                Bytes::copy_from_slice(&segment.encoded_bytes),
            )
            .await
            .expect("write wal segment");
    }
    let pointers = newest_first_pointers(&chain);

    for hints in [&pointers[..], &[]] {
        let request = WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(3),
            visible_tip: Some(pointers[0].clone()),
            stop_after_seq: None,
            recent_segments: hints,
        };
        let count = count_visible_wal_tail_segments(&store, request.clone())
            .await
            .expect("count tail");
        let loaded = load_validated_wal_chain(&store, request)
            .await
            .expect("load chain");
        assert_eq!(count as usize, loaded.segments().len());
        assert_eq!(count, 3);
    }
}

#[tokio::test]
async fn tail_count_ignores_hints_that_do_not_start_at_the_tip() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    let chain = prepared_unstored_chain(&namespace_id, 2);
    for segment in &chain {
        store
            .put_if_absent(
                &segment.object_key,
                Bytes::copy_from_slice(&segment.encoded_bytes),
            )
            .await
            .expect("write wal segment");
    }
    let pointers = newest_first_pointers(&chain);
    let mut lying_tip = pointers[0].clone();
    lying_tip.end_seq = ChangeSeq(999);
    let garbage = [lying_tip, pointers[1].clone()];

    let count = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(pointers[0].clone()),
            stop_after_seq: None,
            recent_segments: &garbage,
        },
    )
    .await
    .expect("count despite garbage hints");
    assert_eq!(count, 2);
}

#[tokio::test]
async fn tail_count_reports_broken_chains_truthfully() {
    let temp_dir = tempdir().expect("tempdir");
    let store = LocalFsStore::new(temp_dir.path()).expect("store");
    let namespace_id = NamespaceId::parse("demo").expect("valid namespace id");
    // A segment claiming seqs (1, 2] with no predecessor link cannot reach
    // a chain base of 0.
    let orphan = prepared_create_directory_segment(
        &namespace_id,
        None,
        "c_count_orphan",
        "orphan",
        ChangeSeq(1),
        ChangeSeq(2),
    );
    store
        .put_if_absent(
            &orphan.object_key,
            Bytes::copy_from_slice(&orphan.encoded_bytes),
        )
        .await
        .expect("write wal segment");
    let tip = orphan.envelope.pointer(orphan.object_key.clone());

    let error = count_visible_wal_tail_segments(
        &store,
        WalChainLoadRequest {
            namespace_id: &namespace_id,
            chain_base_seq: ChangeSeq(0),
            head_seq: ChangeSeq(2),
            visible_tip: Some(tip),
            stop_after_seq: None,
            recent_segments: &[],
        },
    )
    .await
    .expect_err("broken chain must not count");
    assert!(matches!(
        error,
        WalChainLoadError::Replay(WalReplayError::BrokenChainLink { .. })
    ));
}