moqtail 0.13.0

Draft 14-compliant Media-over-QUIC (MoQ) protocol library.
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
// Copyright 2025 The MOQtail Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::{BTreeMap, VecDeque};
use std::time::Duration;

use bytes::{Buf, BufMut, BytesMut};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use tokio::io::AsyncWriteExt;
use tokio::sync::{Mutex, Notify, RwLock};
use tokio::task::yield_now;
use tokio::time::{Instant, sleep_until};
use wtransport::error::StreamReadError;
use wtransport::{RecvStream, SendStream};

use crate::model::control::fetch::Fetch;
use crate::model::control::subscribe::Subscribe;
use crate::model::data::constant::FetchHeaderType;
use crate::model::data::fetch_header::FetchHeader;
use crate::model::data::fetch_object::{FetchObject, FetchObjectContext};
use crate::model::data::object::Object;
use crate::model::data::subgroup_header::SubgroupHeader;
use crate::model::data::subgroup_object::SubgroupObject;
use crate::model::error::ParseError;
use tracing::{debug, error, info, trace};

type ObjectParseResult =
  Result<(Option<u64>, Option<FetchObjectContext>, Option<Object>), ParseError>;

// Timeout for header and subsequent objects
const DATA_STREAM_TIMEOUT: Duration = Duration::from_secs(15);
const MTU_SIZE: usize = 1500; // Standard MTU size

// Stores the context derived from the initial header message
#[derive(Debug, Clone)]
pub enum HeaderInfo {
  Fetch {
    header: FetchHeader,
    fetch_request: Fetch, // Store the original request for context
  },
  Subgroup {
    header: SubgroupHeader,
    // TODO: the following cannot be guaranteed and obtained properly just by track alias
    /*subscribe_request: Subscribe,*/ // Store the original request for context
  },
}

// TODO: Consider merging FetchRequest and SubscribeRequest into a single enum if needed
#[derive(Debug, Clone)]
pub struct FetchRequest {
  pub original_request_id: u64,
  pub requested_by: usize, // client id
  pub fetch_request: Fetch,
  pub track_alias: u64, // Track alias for the fetch request
}

#[derive(Debug, Clone)]
pub struct SubscribeRequest {
  pub original_request_id: u64,
  pub requested_by: usize,                               // connection id
  pub original_subscribe_request: Subscribe, // the subscribe request sent by the subscriber
  pub subscribe_request_to_publisher: Option<Subscribe>, // the subscribe request sent to the publisher (if applicable)
}

impl FetchRequest {
  pub fn new(
    original_request_id: u64,
    requested_by: usize,
    fetch_request: Fetch,
    track_alias: u64,
  ) -> Self {
    Self {
      original_request_id,
      requested_by,
      fetch_request,
      track_alias,
    }
  }
}

impl SubscribeRequest {
  pub fn new(
    original_request_id: u64,
    requested_by: usize,
    original_subscribe_request: Subscribe,
    subscribe_request_to_publisher: Option<Subscribe>,
  ) -> Self {
    Self {
      original_request_id,
      requested_by,
      original_subscribe_request,
      subscribe_request_to_publisher,
    }
  }
}

/// # Pseudocode
/// ```rust
/// open-uni
/// let head = FetchHeader::new(..)
/// let data_Stream = SendDataStream::new(send_stream, head).await?;
/// loop{
/// //get the object
/// let object = Object{..}
/// data_stream.send_object().await
/// }
///
/// ```
pub struct SendDataStream {
  send_stream: Arc<Mutex<SendStream>>,
  header_info: HeaderInfo,
  fetch_prev_ctx: Option<FetchObjectContext>,
}

// TODO: Major issue, can't distinguish from FetchHeader + FetchObject from SubgroupHeader
// Suggestion: SubgroupHeader should start with Request ID and discard track_alias
impl SendDataStream {
  pub async fn new(
    send_stream: Arc<Mutex<SendStream>>,
    header_info: HeaderInfo,
  ) -> Result<Self, ParseError> {
    let mut buf = BytesMut::new();

    match &header_info {
      HeaderInfo::Fetch { header, .. } => {
        buf.extend_from_slice(&header.serialize()?);
      }
      HeaderInfo::Subgroup { header, .. } => {
        buf.extend_from_slice(&header.serialize(None)?);
      }
    }

    send_stream
      .lock()
      .await
      .write_all(&buf)
      .await
      .map_err(|e| ParseError::Other {
        context: "SendDataStream::new(header write)",
        msg: e.to_string(),
      })?;

    Ok(Self {
      send_stream,
      header_info,
      fetch_prev_ctx: None,
    })
  }

  pub async fn send_object(
    &mut self,
    object: &Object,
    previous_object_id: Option<u64>,
  ) -> Result<(), ParseError> {
    let mut buf = BytesMut::new();
    let object = object.clone();

    match &self.header_info {
      HeaderInfo::Fetch { .. } => {
        let payload = object.try_into_fetch()?;
        let fetch_obj = FetchObject::Object(payload);
        buf.extend_from_slice(&fetch_obj.serialize(self.fetch_prev_ctx.as_ref())?);
        self.fetch_prev_ctx = fetch_obj.context();
      }
      HeaderInfo::Subgroup { header, .. } => {
        let has_extensions = header.header_type.has_extensions();
        let subgroup_obj = object.try_into_subgroup()?;
        buf.extend_from_slice(&subgroup_obj.serialize(previous_object_id, has_extensions)?);
      }
    }

    self
      .send_stream
      .lock()
      .await
      .write_all(&buf)
      .await
      .map_err(|e| ParseError::Other {
        context: "SendDataStream::send_object",
        msg: e.to_string(),
      })?;

    Ok(())
  }

  pub async fn flush(&mut self) -> Result<(), ParseError> {
    debug!("SendDataStream::flush() called");
    self
      .send_stream
      .lock()
      .await
      .flush()
      .await
      .map_err(|e| ParseError::Other {
        context: "SendDataStream::flush",
        msg: e.to_string(),
      })
  }

  pub async fn finish(&mut self) -> Result<(), ParseError> {
    debug!("SendDataStream::finish() called");
    self
      .send_stream
      .lock()
      .await
      .finish()
      .await
      .map_err(|e| ParseError::Other {
        context: "SendDataStream::finish",
        msg: e.to_string(),
      })
  }
}

#[derive(Debug)]
pub enum RecvDataStreamReadError {
  ParseError(ParseError),
  StreamClosed,
}

/// # Pseudocode
/// ```rust
/// accept-uni
/// let pending_fetches: &mut BTreeMap<u64, Fetch> = Session.fetch_requests;
/// let data_Stream = RecvDataStream::new(head, pending_fetches).await?;
/// loop{
/// //get the object
/// let object = data_stream.next_object().await;
/// }
/// ```
pub struct RecvDataStream {
  recv_stream: Arc<Mutex<RecvStream>>,
  header_info: Arc<Mutex<Option<HeaderInfo>>>,
  pending_fetches: Arc<RwLock<BTreeMap<u64, FetchRequest>>>, // Mutable borrow to potentially remove entry
  objects: Arc<RwLock<VecDeque<Object>>>,                    // Buffer for parsed objects
  is_closed: Arc<AtomicBool>,
  started_read_task: Arc<AtomicBool>,
  notify: Arc<Notify>,
}

impl RecvDataStream {
  pub fn new(
    recv_stream: RecvStream,
    pending_fetches: Arc<RwLock<BTreeMap<u64, FetchRequest>>>, // Mutable borrow to potentially remove entry
  ) -> Self {
    Self {
      recv_stream: Arc::new(Mutex::new(recv_stream)),
      header_info: Arc::new(Mutex::new(None)), // Initially no header info
      pending_fetches,
      objects: Arc::new(RwLock::new(VecDeque::new())), // Initialize the object buffer
      is_closed: Arc::new(AtomicBool::new(false)),
      started_read_task: Arc::new(AtomicBool::new(false)),
      notify: Arc::new(Notify::new()),
    }
  }

  pub async fn get_header_info(&self) -> Option<HeaderInfo> {
    debug!("RecvDataStream::get_header_info() called");
    let header_info = self.header_info.lock().await;
    header_info.clone()
  }

  async fn read(
    recv_stream: Arc<Mutex<RecvStream>>,
    is_closed: Arc<AtomicBool>,
    the_header_info: Arc<Mutex<Option<HeaderInfo>>>,
    pending_fetches: Arc<RwLock<BTreeMap<u64, FetchRequest>>>,
    objects: Arc<RwLock<VecDeque<Object>>>,
    notify: Arc<Notify>,
  ) -> Result<(), RecvDataStreamReadError> {
    let mut header_info = None;
    let mut recv_buf = Box::new([0u8; MTU_SIZE]);
    let mut recv_bytes = BytesMut::new();
    let mut timeout_at = Instant::now() + DATA_STREAM_TIMEOUT;

    let mut previous_object_id: Option<u64> = None;
    let mut fetch_prev_ctx: Option<FetchObjectContext> = None;

    loop {
      let bytes_cursor = recv_bytes.clone().freeze();
      if !recv_bytes.is_empty() && header_info.is_none() {
        let is_fetch = recv_bytes[0] == FetchHeaderType::Type0x05 as u8;
        header_info = Self::read_header(
          bytes_cursor,
          is_fetch,
          is_closed.clone(),
          pending_fetches.clone(),
        )
        .await
        .map_err(|e| {
          error!("Failed to parse header: {:?}", e);
          RecvDataStreamReadError::ParseError(e)
        })?;
        let consumed = if let Some((consumed, _)) = header_info.clone() {
          consumed
        } else {
          0
        };
        recv_bytes.advance(consumed);
        *the_header_info.lock().await = Some(header_info.clone().unwrap().1.clone());
      }

      loop {
        let bytes_cursor = recv_bytes.clone().freeze();
        let mut consumed = 0;
        if !recv_bytes.is_empty() {
          let header_info = header_info.clone().unwrap().1;
          let (c, object_id, new_fetch_ctx) = Self::read_object(
            bytes_cursor,
            &header_info,
            is_closed.clone(),
            objects.clone(),
            &previous_object_id,
            &fetch_prev_ctx,
          )
          .await
          .map_err(|e| {
            error!("Failed to parse object: {:?}", e);
            RecvDataStreamReadError::ParseError(e)
          })?;

          // if consumed bytes is more than 0, it means we have a valid object
          if c > 0 {
            previous_object_id = object_id;
            if new_fetch_ctx.is_some() {
              fetch_prev_ctx = new_fetch_ctx;
            }
            notify.notify_waiters();
            recv_bytes.advance(c);
          }

          consumed = c;

          trace!(
            "previous_object_id: {:?} object_id: {:?} consumed: {}",
            previous_object_id, &object_id, consumed
          );
        }
        if consumed > 0 {
          // We may have more data to parse, so continue reading objects
          continue;
        } else {
          break;
        }
      }

      // Check if the stream is closed
      // If it is closed, notify waiters and return
      if is_closed.load(Ordering::Relaxed) {
        notify.notify_waiters();
        return Ok(());
      }

      let stream = recv_stream.clone();
      let mut stream = stream.lock().await;

      tokio::select! {
          biased;

          _ = sleep_until(timeout_at) => {
            info!("Timeout while waiting for data");
            is_closed.store(true, Ordering::Relaxed);
            return Err(RecvDataStreamReadError::ParseError(ParseError::Timeout { context: "RecvDataStream::new(header_read)" }));
          }

          read_result = stream.read(&mut recv_buf[..]) => {
            match read_result {
              Ok(Some(n)) => {
                if n > 0 {
                  // debug!("RecvDataStream::read Read {} bytes", n);
                  recv_bytes.put_slice(&recv_buf[..n]);
                  timeout_at = Instant::now() + DATA_STREAM_TIMEOUT;
                } else {
                  // Spurious read, loop again
                  // debug!("RecvDataStream::read Read 0 bytes, spurious read");
                }
              }
              Ok(None) => {
                // If the stream is closed and no more data is available, break or return error
                // otherwise, handle the remaining bytes in the next iteration
                // debug!("RecvDataStream::read Read None (EOF or stream closed)");
                is_closed.store(true, Ordering::Relaxed);
              }
              Err(e) => {
                debug!("RecvDataStream::read() Read error: {:?}", e);
                is_closed.store(true, Ordering::Relaxed);
                if e == StreamReadError::NotConnected {
                  return Err(RecvDataStreamReadError::StreamClosed);
                }
                return Err(RecvDataStreamReadError::ParseError(ParseError::Other { context: "RecvDataStream::new(header_read)", msg:e.to_string() }));
              }
            }
          }
      }
    }
  }

  async fn read_header(
    mut bytes_cursor: bytes::Bytes,
    is_fetch: bool,
    is_closed: Arc<AtomicBool>,
    pending_fetches: Arc<RwLock<BTreeMap<u64, FetchRequest>>>,
  ) -> Result<Option<(usize, HeaderInfo)>, ParseError> {
    debug!("RecvDataStream::read_header() called");
    let original_remaining = bytes_cursor.remaining();
    if is_fetch {
      match FetchHeader::deserialize(&mut bytes_cursor) {
        Ok(fetch_header) => {
          let pending_fetches = pending_fetches.read().await;
          if let Some(fetch_request) = pending_fetches.get(&fetch_header.request_id) {
            let consumed = original_remaining - bytes_cursor.remaining();

            let header_info = HeaderInfo::Fetch {
              header: fetch_header,
              fetch_request: fetch_request.fetch_request.clone(),
            };
            debug!(
              "RecvDataStream::read_header() Parsed FetchHeader: {:?}",
              header_info
            );
            Ok(Some((consumed, header_info)))
          } else {
            // Drop the immutable borrow before calling the async method
            drop(pending_fetches);
            // self.close_stream().await;
            is_closed.store(true, Ordering::Relaxed);
            Err(ParseError::ProtocolViolation {
              context: "RecvDataStream::new(FetchHeader validation)",
              details: format!(
                "Received FetchHeader for unknown request_id: {}",
                fetch_header.request_id
              ),
            })
          }
        }
        Err(ParseError::NotEnoughBytes { .. }) => {
          Ok(None) // Not enough bytes to parse the header, wait for more data
        }
        Err(e) => {
          is_closed.store(true, Ordering::Relaxed);
          Err(ParseError::ProtocolViolation {
            context: "RecvDataStream::new(FetchHeader validation)",
            details: e.to_string(),
          })
        }
      }
    } else {
      match SubgroupHeader::deserialize(&mut bytes_cursor) {
        Ok(subgroup_header) => {
          let consumed = original_remaining - bytes_cursor.remaining();
          let header_info = HeaderInfo::Subgroup {
            header: subgroup_header,
            // subscribe_request: subscribe_request.clone().subscribe_request,
          };
          Ok(Some((consumed, header_info)))
        }
        Err(ParseError::NotEnoughBytes { .. }) => {
          Ok(None) // Not enough bytes to parse the header, wait for more data
        }
        Err(e) => {
          is_closed.store(true, Ordering::Relaxed);
          Err(ParseError::ProtocolViolation {
            context: "RecvDataStream::new(SubgroupHeader validation)",
            details: e.to_string(),
          })
        }
      }
    }
  }

  async fn read_object(
    mut bytes_cursor: bytes::Bytes,
    header_info: &HeaderInfo,
    is_closed: Arc<AtomicBool>,
    objects: Arc<RwLock<VecDeque<Object>>>,
    previous_object_id: &Option<u64>,
    fetch_prev_ctx: &Option<FetchObjectContext>,
  ) -> Result<(usize, Option<u64>, Option<FetchObjectContext>), ParseError> {
    if !bytes_cursor.is_empty() {
      let original_remaining = bytes_cursor.remaining();

      let parse_result: ObjectParseResult = match header_info {
        HeaderInfo::Fetch { .. } => {
          FetchObject::deserialize(&mut bytes_cursor, fetch_prev_ctx.as_ref()).and_then(
            |fetch_obj| {
              let new_ctx = fetch_obj.context();
              match fetch_obj {
                FetchObject::Object(payload) => {
                  // TODO: Get track alias from fetch_request
                  let object = Object::try_from_fetch(payload, 0)?;
                  Ok((None, new_ctx, Some(object)))
                }
                FetchObject::EndOfRange { .. } => {
                  // Range markers advance the stream but do not enqueue an object.
                  debug!("FetchObject::EndOfRange received, skipping");
                  Ok((None, None, None))
                }
              }
            },
          )
        }
        HeaderInfo::Subgroup { header, .. } => {
          let has_extensions = header.header_type.has_extensions();
          SubgroupObject::deserialize(&mut bytes_cursor, previous_object_id, has_extensions)
            .and_then(|subgroup_obj| {
              let object_id = subgroup_obj.object_id;
              let object = Object::try_from_subgroup(
                subgroup_obj,
                header.track_alias,
                header.group_id,
                header.subgroup_id,
                header.publisher_priority,
              )?;
              Ok((Some(object_id), None, Some(object)))
            })
        }
      };

      match parse_result {
        Ok((object_id, new_ctx, maybe_object)) => {
          let consumed = original_remaining - bytes_cursor.remaining();
          debug!(
            "consumed: {} Parsed payload object: {:?}",
            consumed, maybe_object
          );
          if let Some(object) = maybe_object {
            let mut objects = objects.write().await;
            objects.push_back(object);
          }
          Ok((consumed, object_id, new_ctx))
        }
        Err(ParseError::NotEnoughBytes { .. }) => {
          trace!("Not enough bytes to parse the object, continuing to read...");
          Ok((0, None, None))
        }
        Err(e) => {
          is_closed.store(true, Ordering::Relaxed);
          Err(ParseError::ProtocolViolation {
            context: "RecvDataStream::next_object(parse_result)",
            details: e.to_string(),
          })
        }
      }
    } else {
      debug!("No bytes available to parse an object");
      Ok((0, None, None))
    }
  }

  pub async fn next_object(&self) -> (&Self, Option<Object>) {
    // Start the read task only once
    if self
      .started_read_task
      .compare_exchange(false, true, Ordering::Relaxed, Ordering::Relaxed)
      .is_ok()
    {
      let recv_stream = self.recv_stream.clone();
      let is_closed = self.is_closed.clone();
      let pending_fetches = self.pending_fetches.clone();
      let objects = self.objects.clone();
      let header_info = self.header_info.clone();
      let notify = self.notify.clone();

      // Spawn the read task that will continuously read from the stream
      // and insert parsed objects into the objects vector
      tokio::spawn(async move {
        match Self::read(
          recv_stream,
          is_closed,
          header_info,
          pending_fetches,
          objects,
          notify,
        )
        .await
        {
          Ok(_) => debug!("RecvDataStream read task completed successfully"),
          Err(e) => {
            error!("RecvDataStream read task encountered an error: {:?}", e);
            // if not connected error, do nothing and return, let the caller handle it
            if matches!(e, RecvDataStreamReadError::StreamClosed) {
              debug!("Stream is closed, returning EOF");
            } else {
              error!("RecvDataStream read task encountered an error: {:?}", e);
            }
          }
        }
      });
    }

    loop {
      // First, check if there are any objects available
      {
        let mut objects = self.objects.write().await;
        if let Some(object) = objects.pop_front() {
          return (self, Some(object));
        }
      }

      if self.is_closed.load(Ordering::Relaxed) {
        if self.objects.read().await.is_empty() {
          debug!("Stream is closed, returning EOF");
          return (self, None);
        } else {
          debug!("Stream is closed, but has objects still");
          yield_now().await
        }
      } else {
        // Wait for notification that a new object may be available or the stream is closed.
        self.notify.notified().await;
      }
    }
  }
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::model::common::location::Location;
  use crate::model::common::pair::KeyValuePair;
  use crate::model::common::tuple::{Tuple, TupleField};
  use crate::model::control::constant::{FetchType, GroupOrder};
  use crate::model::control::fetch::JoiningFetchProps;
  use crate::model::control::{fetch::Fetch, subscribe::Subscribe};
  use crate::model::data::constant::SubgroupHeaderType;
  use crate::model::extension_header::object_extension::ObjectExtension;
  use crate::model::parameter::authorization_token::AuthorizationToken;
  use crate::model::parameter::message_parameter::MessageParameter;
  use bytes::Bytes;
  use std::error::Error;
  use std::sync::Arc;
  use tokio::sync::Mutex;
  use tokio::time::{Duration, sleep};
  use wtransport::endpoint::IntoConnectOptions;
  use wtransport::{ClientConfig, Connection, Endpoint, Identity, RecvStream, SendStream};

  fn make_fetch_header_and_request() -> (FetchHeader, Fetch) {
    let fetch = Fetch {
      request_id: 161803,
      fetch_type: FetchType::AbsoluteFetch,
      standalone_fetch_props: None,
      joining_fetch_props: Some(JoiningFetchProps {
        joining_request_id: 119,
        joining_start: 73,
      }),
      parameters: vec![
        MessageParameter::new_authorization_token(AuthorizationToken::new_use_value(
          0,
          Bytes::from_static(b"test-token"),
        )),
        MessageParameter::new_subscriber_priority(42),
        MessageParameter::new_group_order(GroupOrder::Ascending),
      ],
    };
    (FetchHeader { request_id: 161803 }, fetch)
  }

  fn make_fetch_object() -> crate::model::data::fetch_object::FetchObjectPayload {
    use crate::model::data::constant::ObjectForwardingPreference;
    use crate::model::data::fetch_object::FetchObjectPayload;
    FetchObjectPayload {
      group_id: 9,
      subgroup_id: 144,
      object_id: 10,
      publisher_priority: 255,
      forwarding_preference: ObjectForwardingPreference::Subgroup,
      extension_headers: Some(vec![
        ObjectExtension::Unknown {
          kvp: KeyValuePair::try_new_varint(0, 10).unwrap(),
        },
        ObjectExtension::Unknown {
          kvp: KeyValuePair::try_new_bytes(1, Bytes::from_static(b"wololoo")).unwrap(),
        },
      ]),
      payload: Bytes::from_static(
        b"01239gjawkk92837aljwdnjwandjnanwdjnajwndkjawndjkanwdkjnawkjddmi",
      ),
    }
  }

  fn make_object_from_fetch(
    fetch_obj: &crate::model::data::fetch_object::FetchObjectPayload,
  ) -> Object {
    Object::try_from_fetch(fetch_obj.clone(), 0).unwrap()
  }

  #[allow(dead_code)]
  fn make_subgroup_header_and_request() -> (SubgroupHeader, Subscribe) {
    let request_id = 128242;
    let track_namespace = Tuple::from_utf8_path("nein/nein/nein");
    let track_name = TupleField::from_utf8("track_42");
    let start_location = Location {
      group: 81,
      object: 81,
    };
    let subscribe = Subscribe::new_absolute_range(
      request_id,
      track_namespace,
      track_name,
      start_location,
      25,
      vec![
        MessageParameter::new_subscriber_priority(31),
        MessageParameter::new_group_order(GroupOrder::Original),
        MessageParameter::new_forward(true),
      ],
    );
    let header_type = SubgroupHeaderType::try_new(0x15).unwrap();
    let track_alias = 999;
    let group_id = 9;
    let subgroup_id = Some(11);
    let publisher_priority = Some(255);
    let subgroup_header = SubgroupHeader {
      header_type,
      track_alias,
      group_id,
      subgroup_id,
      publisher_priority,
    };
    (subgroup_header, subscribe)
  }

  #[allow(dead_code)]
  fn make_subgroup_object() -> SubgroupObject {
    let object_id: u64 = 10;
    let extension_headers = Some(vec![
      ObjectExtension::Unknown {
        kvp: KeyValuePair::try_new_varint(0, 10).unwrap(),
      },
      ObjectExtension::Unknown {
        kvp: KeyValuePair::try_new_bytes(1, Bytes::from_static(b"wololoo")).unwrap(),
      },
    ]);
    let object_status = None;
    let payload = Some(Bytes::from_static(b"01239gjawkk92837aldmi"));

    SubgroupObject {
      object_id,
      extension_headers,
      payload,
      object_status,
    }
  }

  #[allow(dead_code)]
  fn make_object_from_subgroup(subgroup_obj: &SubgroupObject, header: &SubgroupHeader) -> Object {
    Object::try_from_subgroup(
      subgroup_obj.clone(),
      header.track_alias,
      header.group_id,
      header.subgroup_id,
      header.publisher_priority,
    )
    .unwrap()
  }

  struct TestSetup {
    client: Connection,
    server: Connection,
  }

  impl TestSetup {
    async fn new() -> Result<Self, Box<dyn Error>> {
      let server_identity = Identity::self_signed(std::iter::once("localhost"))
        .map_err(|e| format!("Failed to create server identity: {e}"))?;
      let server_cert_hash = server_identity.certificate_chain().as_slice()[0].hash();
      let server_config = wtransport::ServerConfig::builder()
        .with_bind_address(
          "127.0.0.1:0"
            .parse()
            .map_err(|e| format!("Failed to parse bind address: {e}"))?,
        )
        .with_identity(server_identity)
        .build();
      let server_endpoint = Endpoint::server(server_config)
        .map_err(|e| format!("Failed to create server endpoint: {e}"))?;
      let server_addr = server_endpoint
        .local_addr()
        .map_err(|e| format!("Failed to get server local address: {e}"))?;

      // Create a channel to get the server connection from the spawned task
      let (tx, rx) = tokio::sync::oneshot::channel();

      // Spawn a task to handle the server connection acceptance
      tokio::spawn(async move {
        let result = async {
          let incoming = server_endpoint.accept().await;
          let session_request = incoming
            .await
            .map_err(|e| format!("Failed to await session request: {e}"))
            .unwrap();
          let server = session_request.accept().await.unwrap();
          Ok::<_, Box<dyn Error + Send>>(server)
        }
        .await;

        if tx.send(result).is_err() {
          eprintln!("Failed to send server connection result back through the channel");
        }
      });

      // Create client configuration with server's certificate hash for verification
      let client_config = ClientConfig::builder()
        .with_bind_default()
        .with_server_certificate_hashes(vec![server_cert_hash])
        .build();

      let client_endpoint = Endpoint::client(client_config)
        .map_err(|e| format!("Failed to create client endpoint: {e}"))?;

      // Start client connection concurrently while server is accepting
      let client = client_endpoint
        .connect(
          format!("https://{}:{}", server_addr.ip(), server_addr.port())
            .as_str()
            .into_options(),
        )
        .await
        .map_err(|e| format!("Client connection failed: {e}"))?;

      // Wait for the server connection from the spawned task
      let server = rx
        .await
        .map_err(|_| "Server task failed to send connection back")?
        .map_err(|e| format!("Server connection error: {e}"))?;

      Ok(Self { client, server })
    }

    async fn create_data_stream_pair(&self) -> Result<(SendStream, RecvStream), Box<dyn Error>> {
      // Client opens a unidirectional stream (SendStream) in a spawned task
      let client = self.client.clone();
      let send_fut = tokio::spawn(async move {
        // The first await returns Result<SendUni, StreamOpeningError>
        // The second await returns Result<SendStream, StreamOpeningError>
        let send_uni = client.open_uni().await.unwrap();
        send_uni.await
      });

      // Server accepts the unidirectional stream (RecvStream) in a spawned task
      let server = self.server.clone();
      let recv_fut = tokio::spawn(async move {
        server
          .accept_uni()
          .await
          .map_err(|e| format!("Failed to accept server uni stream: {e}"))
      });

      // Await both concurrently
      let (send_res, recv_res) = tokio::try_join!(send_fut, recv_fut)?;

      let send = send_res.map_err(|e| format!("Failed to open client uni stream: {e}"))?;
      let recv = recv_res.map_err(|e| format!("Failed to accept server uni stream: {e}"))?;

      Ok((send, recv))
    }
  }

  async fn setup_stream_pair() -> (SendStream, RecvStream) {
    let setup = TestSetup::new()
      .await
      .expect("Failed to setup test transport");
    setup
      .create_data_stream_pair()
      .await
      .expect("Failed to create data stream pair")
  }

  /* TODO: rewrite this test
  #[tokio::test]
  async fn test_send_recv_fetch_object_success() {
    let (send, recv) = setup_stream_pair().await;
    let (fetch_header, fetch_req) = make_fetch_header_and_request();
    let mut pending_fetches: BTreeMap<u64, FetchRequest> = BTreeMap::new();
    pending_fetches.insert(
      fetch_req.request_id,
      FetchRequest {
        original_request_id: fetch_req.request_id,
        requested_by: 1,
        fetch_request: fetch_req.clone(),
        track_alias: 1,
      },
    );

    // Sender
    let mut sender = SendDataStream::new(
      Arc::new(Mutex::new(send)),
      HeaderInfo::Fetch {
        header: fetch_header,
        fetch_request: fetch_req.clone(),
      },
    )
    .await
    .unwrap();

    let fetch_obj = make_fetch_object();
    let object = make_object_from_fetch(&fetch_obj);

    let pending_fetches = Arc::new(RwLock::new(pending_fetches));

    // Receiver
    let receiver = RecvDataStream::new(Arc::new(Mutex::new(recv)), pending_fetches.clone());

    sender.send_object(&object).await.unwrap();
    let received = receiver.next_object().await.1.unwrap();

    assert_eq!(object, received);
  }
  */

  /* TODO: rewrite this test
  #[tokio::test]
  async fn test_send_recv_subgroup_object_success() {
    let (send, recv) = setup_stream_pair().await;
    let (subgroup_header, _) = make_subgroup_header_and_request();
    let pending_fetches = BTreeMap::new();

    let mut sender = SendDataStream::new(
      Arc::new(Mutex::new(send)),
      HeaderInfo::Subgroup {
        header: subgroup_header,
        /* subscribe_request: subscribe_req.clone(), */
      },
    )
    .await
    .unwrap();

    let subgroup_obj = make_subgroup_object();
    let object = make_object_from_subgroup(&subgroup_obj, &subgroup_header);

    let pending_fetches = Arc::new(RwLock::new(pending_fetches));

    let receiver = RecvDataStream::new(Arc::new(Mutex::new(recv)), pending_fetches.clone());

    sender.send_object(&object).await.unwrap();
    let received = receiver.next_object().await.1.unwrap();

    assert_eq!(object, received);
  }
  */

  /* TODO: rewrite this test
  #[tokio::test]
  async fn test_timeout_on_header() {
    let (_send, recv) = setup_stream_pair().await;
    let mut pending_fetches = Arc::new(RwLock::new(BTreeMap::new()));
    let mut pending_subscribes = Arc::new(RwLock::new(BTreeMap::new()));
    // Don't send any header, just wait for timeout
    let result = RecvDataStream::new(
      Arc::new(Mutex::new(recv)),
      pending_fetches,
      pending_subscribes,
    );
    match result {
      Err(ParseError::Timeout { .. }) => {}
      _ => panic!("Should timeout"),
    }
  }
  */

  /*
  #[tokio::test]
  async fn test_partial_object_timeout() {
    let (send, recv) = setup_stream_pair().await;
    let (fetch_header, fetch_req) = make_fetch_header_and_request();
    let mut pending_fetches = BTreeMap::new();
    pending_fetches.insert(
      fetch_req.request_id,
      FetchRequest {
        request_id: fetch_req.request_id,
        requested_by: 1,
        fetch_request: fetch_req.clone(),
        track_alias: 1,
      },
    );
    let mut pending_subscribes = BTreeMap::new();
    // Send only the header, not the object
    let mut _sender = SendDataStream::new(
      Arc::new(Mutex::new(send)),
      HeaderInfo::Fetch {
        header: fetch_header.clone(),
        fetch_request: fetch_req.clone(),
      },
    )
    .await
    .unwrap();
    let pending_fetches = Arc::new(RwLock::new(pending_fetches));
    let pending_subscribes = Arc::new(RwLock::new(pending_subscribes));
    let mut receiver = RecvDataStream::new(
      Arc::new(Mutex::new(recv)),
      pending_fetches,
      pending_subscribes,
    );
    // Don't send any object, just wait for timeout
    let result = receiver.next_object().await;
    match result {
      Err(ParseError::Timeout { .. }) => {}
      other => panic!("Expected timeout, got {:?}", other),
    }
  }
  */
  #[tokio::test]
  async fn test_partial_object_completion() {
    let (send, recv) = setup_stream_pair().await;
    let (fetch_header, fetch_req) = make_fetch_header_and_request();
    let mut pending_fetches = BTreeMap::new();
    pending_fetches.insert(
      fetch_req.request_id,
      FetchRequest {
        original_request_id: fetch_req.request_id,
        requested_by: 1,
        fetch_request: fetch_req.clone(),
        track_alias: 1,
      },
    );

    let sender = SendDataStream::new(
      Arc::new(Mutex::new(send)),
      HeaderInfo::Fetch {
        header: fetch_header,
        fetch_request: fetch_req.clone(),
      },
    )
    .await
    .unwrap();

    let fetch_obj = make_fetch_object();
    let object = make_object_from_fetch(&fetch_obj);

    let pending_fetches = Arc::new(RwLock::new(pending_fetches));

    let receiver = RecvDataStream::new(recv, pending_fetches);

    // Serialize object and send in two parts
    let bytes = FetchObject::Object(fetch_obj.clone())
      .serialize(None)
      .unwrap();
    let half = bytes.len() / 2;
    let first_half = &bytes[..half];
    let second_half = &bytes[half..];

    // Send first half
    sender
      .send_stream
      .lock()
      .await
      .write_all(first_half)
      .await
      .unwrap();

    // Spawn a task to send the second half after a delay
    let second_half = second_half.to_vec();
    tokio::spawn({
      let send_stream = sender.send_stream.clone();
      async move {
        sleep(Duration::from_millis(100)).await;
        let mut s = send_stream.lock().await;
        s.write_all(&second_half).await.unwrap();
      }
    });

    let received = receiver.next_object().await.1.unwrap();
    assert_eq!(object, received);
  }
}