moq-transport 0.16.2

Media over QUIC
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
// SPDX-FileCopyrightText: 2024-2026 Cloudflare Inc., Luke Curley, Mike English and contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

//! A stream is a stream of objects with a header, split into a [Writer] and [Reader] handle.
//!
//! A [Writer] writes an ordered stream of objects.
//! Each object can have a sequence number, allowing the reader to detect gaps objects.
//!
//! A [Reader] reads an ordered stream of objects.
//! The reader can be cloned, in which case each reader receives a copy of each object. (fanout)
//!
//! The stream is closed with [ServeError::Closed] when all writers or readers are dropped.
use std::{cmp, ops::Deref, sync::Arc};

use bytes::Bytes;

use crate::data::ObjectStatus;
use crate::watch::State;

use super::{ServeError, Track};

pub struct Subgroups {
    pub track: Arc<Track>,
}

impl Subgroups {
    pub fn produce(self) -> (SubgroupsWriter, SubgroupsReader) {
        let (writer, reader) = State::default().split();

        let writer = SubgroupsWriter::new(writer, self.track.clone());
        let reader = SubgroupsReader::new(reader, self.track);

        (writer, reader)
    }
}

impl Deref for Subgroups {
    type Target = Track;

    fn deref(&self) -> &Self::Target {
        &self.track
    }
}

// State shared between the writer and reader.
struct SubgroupsState {
    latest_subgroup_reader: Option<SubgroupReader>,
    epoch: u64, // Updated each time latest changes
    closed: Result<(), ServeError>,
}

impl Default for SubgroupsState {
    fn default() -> Self {
        Self {
            latest_subgroup_reader: None,
            epoch: 0,
            closed: Ok(()),
        }
    }
}

pub struct SubgroupsWriter {
    pub info: Arc<Track>,
    state: State<SubgroupsState>,
    next_subgroup_id: u64, // Not in the state to avoid a lock
    next_group_id: u64,    // Not in the state to avoid a lock
    last_group_id: u64,    // Not in the state to avoid a lock
}

impl SubgroupsWriter {
    fn new(state: State<SubgroupsState>, track: Arc<Track>) -> Self {
        Self {
            info: track,
            state,
            next_subgroup_id: 0,
            next_group_id: 0,
            last_group_id: 0,
        }
    }

    // Helper to increment the group by one.
    pub fn append(&mut self, priority: u8) -> Result<SubgroupWriter, ServeError> {
        // TODO: refactor here... For now, every subgroup is mapped to a new group...
        let start_new_group = true;

        let (group_id, subgroup_id) = if start_new_group {
            (self.next_group_id, 0)
        } else {
            (self.last_group_id, self.next_subgroup_id)
        };

        self.create(Subgroup {
            group_id,
            subgroup_id,
            priority,
        })
    }

    /// Create a new subgroup with the given parameters, inserting it into the track.
    pub fn create(&mut self, subgroup: Subgroup) -> Result<SubgroupWriter, ServeError> {
        let subgroup = SubgroupInfo {
            track: self.info.clone(),
            group_id: subgroup.group_id,
            subgroup_id: subgroup.subgroup_id,
            priority: subgroup.priority,
        };
        let (writer, reader) = subgroup.produce();

        let mut state = self.state.lock_mut().ok_or(ServeError::Cancel)?;

        if let Some(latest) = &state.latest_subgroup_reader {
            // TODO: Check this logic again
            if writer.group_id.cmp(&latest.group_id) == cmp::Ordering::Equal {
                match writer.subgroup_id.cmp(&latest.subgroup_id) {
                    cmp::Ordering::Less => return Ok(writer), // dropped immediately, lul
                    cmp::Ordering::Equal => return Err(ServeError::Duplicate),
                    cmp::Ordering::Greater => state.latest_subgroup_reader = Some(reader),
                }
            } else if writer.group_id.cmp(&latest.group_id) == cmp::Ordering::Greater {
                state.latest_subgroup_reader = Some(reader);
            } else {
                return Ok(writer); // drop here as well
            }
        } else {
            state.latest_subgroup_reader = Some(reader);
        }

        self.next_subgroup_id = state.latest_subgroup_reader.as_ref().unwrap().subgroup_id + 1;
        self.next_group_id = state.latest_subgroup_reader.as_ref().unwrap().group_id + 1;
        self.last_group_id = state.latest_subgroup_reader.as_ref().unwrap().group_id;
        state.epoch += 1;

        Ok(writer)
    }

    /// Close the segment with an error.
    pub fn close(self, err: ServeError) -> Result<(), ServeError> {
        let state = self.state.lock();
        state.closed.clone()?;

        let mut state = state.into_mut().ok_or(ServeError::Cancel)?;
        state.closed = Err(err);

        Ok(())
    }
}

impl Deref for SubgroupsWriter {
    type Target = Track;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

#[derive(Clone)]
pub struct SubgroupsReader {
    pub info: Arc<Track>,
    state: State<SubgroupsState>,
    epoch: u64,
}

impl SubgroupsReader {
    fn new(state: State<SubgroupsState>, track_info: Arc<Track>) -> Self {
        Self {
            info: track_info,
            state,
            epoch: 0,
        }
    }

    pub async fn next(&mut self) -> Result<Option<SubgroupReader>, ServeError> {
        loop {
            {
                let state = self.state.lock();

                if self.epoch != state.epoch {
                    self.epoch = state.epoch;
                    return Ok(state.latest_subgroup_reader.clone());
                }

                state.closed.clone()?;
                match state.modified() {
                    Some(notify) => notify,
                    None => return Ok(None),
                }
            }
            .await; // Try again when the state changes
        }
    }

    // Returns the largest group/sequence
    pub fn latest(&self) -> Option<(u64, u64)> {
        let state = self.state.lock();
        state
            .latest_subgroup_reader
            .as_ref()
            .and_then(|group| group.latest().map(|object_id| (group.group_id, object_id)))
    }

    /// Check if the subgroups writer has been closed or dropped.
    pub fn is_closed(&self) -> bool {
        let state = self.state.lock();
        state.closed.is_err() || state.modified().is_none()
    }
}

impl Deref for SubgroupsReader {
    type Target = Track;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

/// Parameters that can be specified by the user
#[derive(Debug, Clone, PartialEq)]
pub struct Subgroup {
    // The sequence number of the group within the track.
    // NOTE: These may be received out of order or with gaps.
    pub group_id: u64,

    // The sequence number of the subgroup within the group.
    // NOTE: These may be received out of order or with gaps.
    pub subgroup_id: u64,

    // The priority of the group within the track.
    pub priority: u8,
}

/// Static information about the group
#[derive(Debug, Clone, PartialEq)]
pub struct SubgroupInfo {
    pub track: Arc<Track>,

    // The sequence number of the group within the track.
    // NOTE: These may be received out of order or with gaps.
    pub group_id: u64,

    // The sequence number of the subgroup within the group.
    // NOTE: These may be received out of order or with gaps.
    pub subgroup_id: u64,

    // The priority of the group within the track.
    pub priority: u8,
}

impl SubgroupInfo {
    pub fn produce(self) -> (SubgroupWriter, SubgroupReader) {
        let (writer, reader) = State::default().split();
        let info = Arc::new(self);

        let writer = SubgroupWriter::new(writer, info.clone());
        let reader = SubgroupReader::new(reader, info);

        (writer, reader)
    }
}

impl Deref for SubgroupInfo {
    type Target = Track;

    fn deref(&self) -> &Self::Target {
        &self.track
    }
}

struct SubgroupState {
    // The data that has been received thus far.
    objects: Vec<SubgroupObjectReader>,

    // Set when the writer or all readers are dropped.
    closed: Result<(), ServeError>,
}

impl Default for SubgroupState {
    fn default() -> Self {
        Self {
            objects: Vec::new(),
            closed: Ok(()),
        }
    }
}

/// Used to write data to a stream and notify readers.
pub struct SubgroupWriter {
    // Mutable stream state.
    state: State<SubgroupState>,

    // Immutable stream state.
    pub info: Arc<SubgroupInfo>,

    // The next object sequence number to use.
    next_object_id: u64,
}

impl SubgroupWriter {
    fn new(state: State<SubgroupState>, group: Arc<SubgroupInfo>) -> Self {
        Self {
            state,
            info: group,
            next_object_id: 0,
        }
    }

    /// Create the next object ID with the given payload.
    pub fn write(&mut self, payload: bytes::Bytes) -> Result<(), ServeError> {
        let mut object = self.create(payload.len(), None)?;
        object.write(payload)?;
        Ok(())
    }

    /// Write an object over multiple writes.
    ///
    /// BAD STUFF will happen if the size is wrong; this is an advanced feature.
    pub fn create(
        &mut self,
        size: usize,
        extension_headers: Option<crate::data::ExtensionHeaders>,
    ) -> Result<SubgroupObjectWriter, ServeError> {
        let (writer, reader) = SubgroupObject {
            group: self.info.clone(),
            object_id: self.next_object_id,
            status: ObjectStatus::NormalObject,
            size,
            extension_headers: extension_headers.unwrap_or_default(),
        }
        .produce();

        self.next_object_id += 1;

        let mut state = self.state.lock_mut().ok_or(ServeError::Cancel)?;
        state.objects.push(reader);

        Ok(writer)
    }

    /// Close the stream with an error.
    pub fn close(self, err: ServeError) -> Result<(), ServeError> {
        let state = self.state.lock();
        state.closed.clone()?;

        let mut state = state.into_mut().ok_or(ServeError::Cancel)?;
        state.closed = Err(err);
        Ok(())
    }

    pub fn len(&self) -> usize {
        self.state.lock().objects.len()
    }

    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

impl Deref for SubgroupWriter {
    type Target = SubgroupInfo;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

/// Notified when a stream has new data available.
#[derive(Clone)]
pub struct SubgroupReader {
    // Modify the stream state.
    state: State<SubgroupState>,

    // Immutable stream state.
    pub info: Arc<SubgroupInfo>,

    // The number of chunks that we've read.
    // NOTE: Cloned readers inherit this index, but then run in parallel.
    read_index: usize,
}

impl SubgroupReader {
    fn new(state: State<SubgroupState>, subgroup: Arc<SubgroupInfo>) -> Self {
        Self {
            state,
            info: subgroup,
            read_index: 0,
        }
    }

    pub fn latest(&self) -> Option<u64> {
        let state = self.state.lock();
        state.objects.last().map(|o| o.object_id)
    }

    pub async fn read_next(&mut self) -> Result<Option<Bytes>, ServeError> {
        let object = self.next().await?;
        match object {
            Some(mut object) => Ok(Some(object.read_all().await?)),
            None => Ok(None),
        }
    }

    pub async fn next(&mut self) -> Result<Option<SubgroupObjectReader>, ServeError> {
        loop {
            {
                let state = self.state.lock();

                if self.read_index < state.objects.len() {
                    let object = state.objects[self.read_index].clone();
                    self.read_index += 1;
                    return Ok(Some(object));
                }

                state.closed.clone()?;
                match state.modified() {
                    Some(notify) => notify,
                    None => return Ok(None),
                }
            }
            .await; // Try again when the state changes
        }
    }

    pub fn pos(&self) -> usize {
        self.read_index
    }

    pub fn len(&self) -> usize {
        self.state.lock().objects.len()
    }

    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

impl Deref for SubgroupReader {
    type Target = SubgroupInfo;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

/// A subset of Object, since we use the group's info.
#[derive(Clone, PartialEq, Debug)]
pub struct SubgroupObject {
    pub group: Arc<SubgroupInfo>,

    pub object_id: u64,

    // The size of the object.
    pub size: usize,

    // Object status
    pub status: ObjectStatus,

    // Extension headers (for draft-14 compliance, particularly immutable extensions)
    pub extension_headers: crate::data::ExtensionHeaders,
}

impl SubgroupObject {
    pub fn produce(self) -> (SubgroupObjectWriter, SubgroupObjectReader) {
        let (writer, reader) = State::default().split();
        let info = Arc::new(self);

        let writer = SubgroupObjectWriter::new(writer, info.clone());
        let reader = SubgroupObjectReader::new(reader, info);

        (writer, reader)
    }
}

impl Deref for SubgroupObject {
    type Target = SubgroupInfo;

    fn deref(&self) -> &Self::Target {
        &self.group
    }
}

struct SubgroupObjectState {
    // The data that has been received thus far.
    chunks: Vec<Bytes>,

    // Set when the writer is dropped.
    closed: Result<(), ServeError>,
}

impl Default for SubgroupObjectState {
    fn default() -> Self {
        Self {
            chunks: Vec::new(),
            closed: Ok(()),
        }
    }
}

/// Used to write data to a segment and notify readers.
pub struct SubgroupObjectWriter {
    // Mutable segment state.
    state: State<SubgroupObjectState>,

    // Immutable segment state.
    pub info: Arc<SubgroupObject>,

    // The amount of promised data that has yet to be written.
    remain: usize,
}

impl SubgroupObjectWriter {
    /// Create a new segment with the given info.
    fn new(state: State<SubgroupObjectState>, object: Arc<SubgroupObject>) -> Self {
        Self {
            state,
            remain: object.size,
            info: object,
        }
    }

    /// Write a new chunk of bytes.
    pub fn write(&mut self, chunk: Bytes) -> Result<(), ServeError> {
        if chunk.len() > self.remain {
            return Err(ServeError::Size);
        }
        self.remain -= chunk.len();

        let mut state = self.state.lock_mut().ok_or(ServeError::Cancel)?;
        state.chunks.push(chunk);

        Ok(())
    }

    /// Close the segment with an error.
    pub fn close(self, err: ServeError) -> Result<(), ServeError> {
        if self.remain != 0 {
            return Err(ServeError::Size);
        }

        let state = self.state.lock();
        state.closed.clone()?;

        let mut state = state.into_mut().ok_or(ServeError::Cancel)?;
        state.closed = Err(err);

        Ok(())
    }
}

impl Drop for SubgroupObjectWriter {
    fn drop(&mut self) {
        if self.remain == 0 {
            return;
        }

        if let Some(mut state) = self.state.lock_mut() {
            state.closed = Err(ServeError::Size);
        }
    }
}

impl Deref for SubgroupObjectWriter {
    type Target = SubgroupObject;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

/// Notified when a segment has new data available.
#[derive(Clone)]
pub struct SubgroupObjectReader {
    // Modify the segment state.
    state: State<SubgroupObjectState>,

    // Immutable segment state.
    pub info: Arc<SubgroupObject>,

    // The number of chunks that we've read.
    // NOTE: Cloned readers inherit this index, but then run in parallel.
    index: usize,
}

impl SubgroupObjectReader {
    fn new(state: State<SubgroupObjectState>, object: Arc<SubgroupObject>) -> Self {
        Self {
            state,
            info: object,
            index: 0,
        }
    }

    /// Block until the next chunk of bytes is available.
    pub async fn read(&mut self) -> Result<Option<Bytes>, ServeError> {
        loop {
            {
                let state = self.state.lock();

                if self.index < state.chunks.len() {
                    let chunk = state.chunks[self.index].clone();
                    self.index += 1;
                    return Ok(Some(chunk));
                }

                state.closed.clone()?;
                match state.modified() {
                    Some(notify) => notify,
                    None => return Ok(None), // No more changes will come
                }
            }
            .await; // Try again when the state changes
        }
    }

    pub async fn read_all(&mut self) -> Result<Bytes, ServeError> {
        let mut chunks = Vec::new();
        while let Some(chunk) = self.read().await? {
            chunks.push(chunk);
        }

        Ok(Bytes::from(chunks.concat()))
    }
}

impl Deref for SubgroupObjectReader {
    type Target = SubgroupObject;

    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::coding::TrackNamespace;

    /// Helper: create a SubgroupsWriter/Reader pair with a dummy track.
    fn make_subgroups() -> (SubgroupsWriter, SubgroupsReader) {
        let track = Arc::new(Track::new(
            TrackNamespace::from_utf8_path("test/ns"),
            "test-track".to_string(),
        ));
        Subgroups { track }.produce()
    }

    /// Helper: deterministic payload for (group_id, object_id).
    fn payload(group_id: u64, object_id: u64) -> Bytes {
        Bytes::from(format!("g{}-o{}", group_id, object_id))
    }

    // ---------------------------------------------------------------
    // U1: Single group, single object
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn single_group_single_object() {
        let (mut writer, mut reader) = make_subgroups();

        let mut sg = writer.append(0).unwrap();
        let group_id = sg.group_id;
        sg.write(payload(group_id, 0)).unwrap();
        drop(sg); // close the subgroup

        let sub = reader.next().await.unwrap().expect("expected a subgroup");
        assert_eq!(sub.group_id, group_id);

        let mut obj = sub.clone();
        let data = obj.read_next().await.unwrap().expect("expected an object");
        assert_eq!(data, payload(group_id, 0));

        // No more objects
        assert!(obj.read_next().await.unwrap().is_none());
    }

    // ---------------------------------------------------------------
    // U2: Single group, multiple objects
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn single_group_multiple_objects() {
        let (mut writer, mut reader) = make_subgroups();

        let mut sg = writer.append(0).unwrap();
        let gid = sg.group_id;
        for oid in 0..5u64 {
            sg.write(payload(gid, oid)).unwrap();
        }
        drop(sg);

        let mut sub = reader.next().await.unwrap().unwrap();
        for oid in 0..5u64 {
            let obj = sub.next().await.unwrap().expect("expected object");
            assert_eq!(obj.object_id, oid);
            let mut obj = obj;
            let data = obj.read_all().await.unwrap();
            assert_eq!(data, payload(gid, oid));
        }
        assert!(sub.next().await.unwrap().is_none());
    }

    // ---------------------------------------------------------------
    // U3: Multiple groups, multiple objects
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn multiple_groups_multiple_objects() {
        let (mut writer, mut reader) = make_subgroups();

        let num_groups = 3u64;
        let objects_per_group = 4u64;

        for _ in 0..num_groups {
            let mut sg = writer.append(0).unwrap();
            let gid = sg.group_id;
            for oid in 0..objects_per_group {
                let p = payload(gid, oid);
                sg.write(p).unwrap();
            }
            drop(sg);
        }
        drop(writer); // close the subgroups writer

        // Reader sees each group as the latest when epoch bumps.
        // Because latest-only, we collect what we can.
        let mut received: Vec<(u64, u64, Bytes)> = Vec::new();
        while let Ok(Some(mut sub)) = reader.next().await {
            let gid = sub.group_id;
            while let Ok(Some(mut obj)) = sub.next().await {
                let oid = obj.object_id;
                let data = obj.read_all().await.unwrap();
                received.push((gid, oid, data));
            }
        }

        // Every received tuple must match what was published.
        for (gid, oid, data) in &received {
            assert_eq!(data, &payload(*gid, *oid));
        }

        // At minimum the last group must be received with all its objects.
        let last_group_id = num_groups - 1;
        let last_group_objects: Vec<_> = received
            .iter()
            .filter(|(g, _, _)| *g == last_group_id)
            .collect();
        assert_eq!(
            last_group_objects.len(),
            objects_per_group as usize,
            "last group must be received with all {} objects",
            objects_per_group
        );
    }

    // ---------------------------------------------------------------
    // U4: Variable payload sizes
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn variable_payload_sizes() {
        let (mut writer, mut reader) = make_subgroups();

        let payloads: Vec<Bytes> = vec![
            Bytes::new(),                  // 0-byte
            Bytes::from_static(b"x"),      // 1-byte
            Bytes::from(vec![0xAB; 1024]), // 1 KB
            Bytes::from(vec![0xCD; 4096]), // 4 KB
        ];

        let mut sg = writer.append(0).unwrap();
        for p in &payloads {
            sg.write(p.clone()).unwrap();
        }
        drop(sg);

        let mut sub = reader.next().await.unwrap().unwrap();
        for expected in &payloads {
            let mut obj = sub.next().await.unwrap().unwrap();
            let data = obj.read_all().await.unwrap();
            assert_eq!(data, *expected);
        }
        assert!(sub.next().await.unwrap().is_none());
    }

    // ---------------------------------------------------------------
    // U5: Multi-chunk writes
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn multi_chunk_writes() {
        let (mut writer, mut reader) = make_subgroups();

        let chunk1 = Bytes::from_static(b"hello ");
        let chunk2 = Bytes::from_static(b"world");
        let full = Bytes::from_static(b"hello world");

        let mut sg = writer.append(0).unwrap();
        let mut obj_writer = sg.create(full.len(), None).unwrap();
        obj_writer.write(chunk1).unwrap();
        obj_writer.write(chunk2).unwrap();
        drop(obj_writer);
        drop(sg);

        let mut sub = reader.next().await.unwrap().unwrap();
        let mut obj = sub.next().await.unwrap().unwrap();
        let data = obj.read_all().await.unwrap();
        assert_eq!(data, full);
    }

    // ---------------------------------------------------------------
    // U6: Latest-only semantics
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn latest_only_semantics() {
        let (mut writer, reader) = make_subgroups();

        // Write group 0
        let mut sg0 = writer.append(0).unwrap();
        sg0.write(payload(sg0.group_id, 0)).unwrap();
        drop(sg0);

        // Write group 1
        let mut sg1 = writer.append(0).unwrap();
        let gid1 = sg1.group_id;
        sg1.write(payload(gid1, 0)).unwrap();
        drop(sg1);

        // A fresh clone of reader should only see group 1 (the latest).
        let mut fresh = reader.clone();
        let sub = fresh.next().await.unwrap().unwrap();
        assert_eq!(sub.group_id, gid1);
    }

    // ---------------------------------------------------------------
    // U7: Older group silently dropped
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn older_group_silently_dropped() {
        let (mut writer, mut reader) = make_subgroups();

        // Write group 5 via create()
        let sg5 = writer
            .create(Subgroup {
                group_id: 5,
                subgroup_id: 0,
                priority: 0,
            })
            .unwrap();
        drop(sg5);

        // Write group 3 (older) -- should not become latest
        let sg3 = writer
            .create(Subgroup {
                group_id: 3,
                subgroup_id: 0,
                priority: 0,
            })
            .unwrap();
        drop(sg3);

        // Reader should see group 5 as latest (epoch bumped once for group 5).
        let sub = reader.next().await.unwrap().unwrap();
        assert_eq!(sub.group_id, 5);
    }

    // ---------------------------------------------------------------
    // U8: Duplicate group_id + subgroup_id rejected
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn duplicate_rejected() {
        let (mut writer, _reader) = make_subgroups();

        let _sg = writer
            .create(Subgroup {
                group_id: 5,
                subgroup_id: 0,
                priority: 0,
            })
            .unwrap();

        let result = writer.create(Subgroup {
            group_id: 5,
            subgroup_id: 0,
            priority: 0,
        });

        match result {
            Err(ServeError::Duplicate) => {} // expected
            Err(e) => panic!("expected Duplicate, got {:?}", e),
            Ok(_) => panic!("expected Duplicate error, got Ok"),
        }
    }

    // ---------------------------------------------------------------
    // U9: Higher subgroup_id within same group
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn higher_subgroup_id_updates_latest() {
        let (mut writer, mut reader) = make_subgroups();

        let _sg0 = writer
            .create(Subgroup {
                group_id: 1,
                subgroup_id: 0,
                priority: 0,
            })
            .unwrap();

        let _sg1 = writer
            .create(Subgroup {
                group_id: 1,
                subgroup_id: 1,
                priority: 0,
            })
            .unwrap();

        // Reader should see subgroup_id=1 as latest (two epoch bumps).
        // Drain to the latest with a timeout guard to prevent indefinite hang.
        let result = tokio::time::timeout(std::time::Duration::from_secs(5), async {
            let mut latest_sub = None;
            // Read available updates (non-blocking after writer is done).
            // We'll read what we can and the last one should be subgroup_id=1.
            loop {
                let sub = reader.next().await.unwrap();
                match sub {
                    Some(s) => latest_sub = Some(s),
                    None => break,
                }
                // Break after we've seen subgroup_id=1 to avoid blocking forever
                // since writer is still alive.
                if latest_sub.as_ref().map(|s| s.subgroup_id) == Some(1) {
                    break;
                }
            }
            latest_sub
        })
        .await;

        let latest_sub =
            result.expect("higher_subgroup_id_updates_latest timed out after 5 seconds");
        assert_eq!(latest_sub.unwrap().subgroup_id, 1);
    }

    // ---------------------------------------------------------------
    // U10: Writer close propagates
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn writer_close_propagates() {
        let (mut writer, mut reader) = make_subgroups();

        let mut sg = writer.append(0).unwrap();
        sg.write(Bytes::from_static(b"data")).unwrap();
        drop(sg);

        writer.close(ServeError::Done).unwrap();

        // Reader should get the subgroup, then Done error.
        let _sub = reader.next().await.unwrap().unwrap();
        let result = reader.next().await;
        match result {
            Err(ServeError::Done) => {} // expected
            Err(e) => panic!("expected Done, got {:?}", e),
            Ok(_) => panic!("expected Done error, got Ok"),
        }
    }

    // ---------------------------------------------------------------
    // U11: Object size mismatch
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn object_size_mismatch() {
        let (mut writer, mut reader) = make_subgroups();

        let mut sg = writer.append(0).unwrap();

        // Declare size=10, write only 5 bytes, then drop writer
        let mut obj_writer = sg.create(10, None).unwrap();
        obj_writer.write(Bytes::from(vec![0u8; 5])).unwrap();
        drop(obj_writer); // Drop triggers Size error because remain != 0

        drop(sg);

        let mut sub = reader.next().await.unwrap().unwrap();
        let mut obj = sub.next().await.unwrap().unwrap();

        // Read the 5 bytes that were written
        let chunk = obj.read().await.unwrap();
        assert!(chunk.is_some());

        // Next read should get the Size error
        let result = obj.read().await;
        assert_eq!(result.unwrap_err(), ServeError::Size);
    }

    // ---------------------------------------------------------------
    // U12: Concurrent readers (fan-out)
    // ---------------------------------------------------------------
    #[tokio::test]
    async fn concurrent_readers_fanout() {
        let (mut writer, mut reader1) = make_subgroups();
        let mut reader2 = reader1.clone();

        let mut sg = writer.append(0).unwrap();
        let gid = sg.group_id;
        for oid in 0..3u64 {
            sg.write(payload(gid, oid)).unwrap();
        }
        drop(sg);
        drop(writer);

        // Both readers should see the same subgroup.
        let mut sub1 = reader1.next().await.unwrap().unwrap();
        let mut sub2 = reader2.next().await.unwrap().unwrap();

        assert_eq!(sub1.group_id, sub2.group_id);

        // Read all objects from both and compare.
        let mut data1 = Vec::new();
        while let Ok(Some(mut obj)) = sub1.next().await {
            data1.push((obj.object_id, obj.read_all().await.unwrap()));
        }

        let mut data2 = Vec::new();
        while let Ok(Some(mut obj)) = sub2.next().await {
            data2.push((obj.object_id, obj.read_all().await.unwrap()));
        }

        assert_eq!(data1, data2);
        assert_eq!(data1.len(), 3);
    }
}