asupersync 0.3.1

Spec-first, cancel-correct, capability-secure async runtime for Rust.
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
//! Merge combinator for streams.
//!
//! The `Merge` combinator interleaves items from multiple streams, polling
//! them in round-robin order.

use super::Stream;
use std::collections::VecDeque;
use std::pin::Pin;
use std::task::{Context, Poll};

/// Cooperative budget for child-stream scans in a single poll.
///
/// Without this bound, a large merge set can monopolize one executor turn
/// while `Merge` walks every child looking for a ready item.
const MERGE_COOPERATIVE_POLL_BUDGET: usize = 64;

/// A stream that merges multiple streams.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct Merge<S> {
    streams: VecDeque<S>,
    /// Round-robin cursor for fair polling without moving elements.
    next_index: usize,
}

impl<S> Merge<S> {
    /// Creates a new `Merge` from the given streams.
    #[inline]
    pub(crate) fn new(streams: impl IntoIterator<Item = S>) -> Self {
        Self {
            streams: streams.into_iter().collect(),
            next_index: 0,
        }
    }

    /// Returns the number of active streams.
    #[inline]
    #[must_use]
    pub fn len(&self) -> usize {
        self.streams.len()
    }

    /// Returns true if there are no active streams.
    #[inline]
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.streams.is_empty()
    }

    /// Returns a reference to the active streams.
    #[inline]
    #[must_use]
    pub fn get_ref(&self) -> &VecDeque<S> {
        &self.streams
    }

    /// Returns a mutable reference to the active streams.
    #[inline]
    pub fn get_mut(&mut self) -> &mut VecDeque<S> {
        &mut self.streams
    }

    /// Consumes the combinator, returning the remaining streams.
    #[inline]
    #[must_use]
    pub fn into_inner(self) -> VecDeque<S> {
        self.streams
    }
}

impl<S: Unpin> Unpin for Merge<S> {}

impl<S> Stream for Merge<S>
where
    S: Stream + Unpin,
{
    type Item = S::Item;

    #[inline]
    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let initial_len = self.streams.len();
        if initial_len == 0 {
            return Poll::Ready(None);
        }

        let start = self.next_index.min(initial_len.saturating_sub(1));
        // Track how many original streams we've visited (removals don't reduce the budget).
        let mut remaining = initial_len;
        let mut i = start;
        let mut scanned_this_poll = 0usize;

        while remaining > 0 {
            let len = self.streams.len();
            if len == 0 {
                return Poll::Ready(None);
            }
            if i >= len {
                i = 0;
            }

            match Pin::new(&mut self.streams[i]).poll_next(cx) {
                Poll::Ready(Some(item)) => {
                    let new_len = self.streams.len();
                    self.next_index = if i + 1 >= new_len { 0 } else { i + 1 };
                    return Poll::Ready(Some(item));
                }
                Poll::Ready(None) => {
                    // Stream exhausted; remove it.
                    self.streams.remove(i);
                    remaining -= 1;
                    scanned_this_poll += 1;
                    if scanned_this_poll >= MERGE_COOPERATIVE_POLL_BUDGET && remaining > 0 {
                        self.next_index = if self.streams.is_empty() {
                            0
                        } else {
                            i % self.streams.len()
                        };
                        cx.waker().wake_by_ref();
                        return Poll::Pending;
                    }
                    // i now points at the next element (shifted into this slot), don't advance.
                    continue;
                }
                Poll::Pending => {}
            }
            remaining -= 1;
            scanned_this_poll += 1;
            if scanned_this_poll >= MERGE_COOPERATIVE_POLL_BUDGET && remaining > 0 {
                self.next_index = if self.streams.is_empty() {
                    0
                } else {
                    (i + 1) % self.streams.len()
                };
                cx.waker().wake_by_ref();
                return Poll::Pending;
            }
            i += 1;
        }

        self.next_index = if self.streams.is_empty() {
            0
        } else {
            i % self.streams.len()
        };
        if self.streams.is_empty() {
            Poll::Ready(None)
        } else {
            Poll::Pending
        }
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let mut lower = 0usize;
        let mut upper = Some(0usize);

        for stream in &self.streams {
            let (l, u) = stream.size_hint();
            lower = lower.saturating_add(l);
            upper = match (upper, u) {
                (Some(total), Some(v)) => total.checked_add(v),
                _ => None,
            };
        }

        (lower, upper)
    }
}

/// Merge multiple streams into a single stream.
#[inline]
pub fn merge<S>(streams: impl IntoIterator<Item = S>) -> Merge<S>
where
    S: Stream,
{
    Merge::new(streams)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::stream::{StreamExt, iter};
    use std::sync::Arc;
    use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
    use std::task::{Context, Poll, Waker};

    fn noop_waker() -> Waker {
        std::task::Waker::noop().clone()
    }

    struct TrackWaker(Arc<AtomicBool>);

    use std::task::Wake;
    impl Wake for TrackWaker {
        fn wake(self: Arc<Self>) {
            self.0.store(true, Ordering::SeqCst);
        }

        fn wake_by_ref(self: &Arc<Self>) {
            self.0.store(true, Ordering::SeqCst);
        }
    }

    fn init_test(name: &str) {
        crate::test_utils::init_test_logging();
        crate::test_phase!(name);
    }

    #[derive(Debug)]
    struct PendingEveryOther {
        items: Vec<i32>,
        index: usize,
        pending_next: bool,
    }

    impl PendingEveryOther {
        fn new(items: Vec<i32>) -> Self {
            Self {
                items,
                index: 0,
                pending_next: true,
            }
        }
    }

    impl Stream for PendingEveryOther {
        type Item = i32;

        fn poll_next(mut self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<i32>> {
            if self.pending_next {
                self.pending_next = false;
                return Poll::Pending;
            }

            if self.index >= self.items.len() {
                return Poll::Ready(None);
            }

            let item = self.items[self.index];
            self.index += 1;
            self.pending_next = true;
            Poll::Ready(Some(item))
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            let remaining = self.items.len().saturating_sub(self.index);
            (remaining, Some(remaining))
        }
    }

    #[derive(Debug)]
    struct UnknownUpper {
        remaining: usize,
    }

    impl UnknownUpper {
        fn new(remaining: usize) -> Self {
            Self { remaining }
        }
    }

    impl Stream for UnknownUpper {
        type Item = usize;

        fn poll_next(mut self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<usize>> {
            if self.remaining == 0 {
                return Poll::Ready(None);
            }
            self.remaining -= 1;
            Poll::Ready(Some(self.remaining))
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            (0, None)
        }
    }

    #[derive(Debug)]
    struct LaggyStream {
        source: usize,
        items: Vec<i32>,
        index: usize,
        pending_budget: usize,
        pending_left: usize,
    }

    impl LaggyStream {
        fn new(source: usize, items: Vec<i32>, pending_budget: usize) -> Self {
            Self {
                source,
                items,
                index: 0,
                pending_budget,
                pending_left: pending_budget,
            }
        }
    }

    impl Stream for LaggyStream {
        type Item = (usize, i32);

        fn poll_next(mut self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
            if self.index >= self.items.len() {
                return Poll::Ready(None);
            }

            if self.pending_left > 0 {
                self.pending_left -= 1;
                return Poll::Pending;
            }

            let item = self.items[self.index];
            self.index += 1;
            self.pending_left = self.pending_budget;
            Poll::Ready(Some((self.source, item)))
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            let remaining = self.items.len().saturating_sub(self.index);
            (remaining, Some(remaining))
        }
    }

    #[derive(Debug)]
    struct DropStream {
        source: usize,
        dropped: Arc<AtomicUsize>,
    }

    impl DropStream {
        fn new(source: usize, dropped: Arc<AtomicUsize>) -> Self {
            Self { source, dropped }
        }
    }

    impl Drop for DropStream {
        fn drop(&mut self) {
            let count = self.dropped.fetch_add(1, Ordering::Relaxed) + 1;
            tracing::info!(
                source = self.source,
                dropped = count,
                "merge stream dropped"
            );
        }
    }

    impl Stream for DropStream {
        type Item = (usize, i32);

        fn poll_next(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
            Poll::Pending
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            (0, None)
        }
    }

    #[derive(Debug, Default)]
    struct AlwaysPending;

    impl Stream for AlwaysPending {
        type Item = usize;

        fn poll_next(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
            Poll::Pending
        }
    }

    type BoxedStream<T> = Box<dyn Stream<Item = T> + Unpin>;

    fn boxed_stream<T, S>(stream: S) -> BoxedStream<T>
    where
        S: Stream<Item = T> + Unpin + 'static,
    {
        Box::new(stream)
    }

    #[test]
    fn merge_yields_all_items() {
        init_test("merge_yields_all_items");
        let mut stream = merge([iter(vec![1, 3, 5]), iter(vec![2, 4, 6])]);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => items.push(item),
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        items.sort_unstable();
        let ok = items == vec![1, 2, 3, 4, 5, 6];
        crate::assert_with_log!(ok, "merged items", vec![1, 2, 3, 4, 5, 6], items);
        crate::test_complete!("merge_yields_all_items");
    }

    #[test]
    fn merge_round_robin_order() {
        init_test("merge_round_robin_order");
        let mut stream = merge([iter(vec![1, 3, 5]), iter(vec![2, 4, 6])]);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => items.push(item),
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let ok = items == vec![1, 2, 3, 4, 5, 6];
        crate::assert_with_log!(ok, "round robin order", vec![1, 2, 3, 4, 5, 6], items);
        crate::test_complete!("merge_round_robin_order");
    }

    #[test]
    fn merge_drops_exhausted_streams() {
        init_test("merge_drops_exhausted_streams");
        let mut stream = merge([iter(vec![10]), iter(vec![1, 2])]);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => items.push(item),
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let ok = items == vec![10, 1, 2];
        crate::assert_with_log!(ok, "exhausted drop", vec![10, 1, 2], items);
        crate::test_complete!("merge_drops_exhausted_streams");
    }

    #[test]
    fn merge_pending_streams_make_progress() {
        init_test("merge_pending_streams_make_progress");
        let streams: Vec<Box<dyn Stream<Item = i32> + Unpin>> = vec![
            Box::new(PendingEveryOther::new(vec![1, 3, 5])),
            Box::new(iter(vec![2, 4, 6])),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        let mut pending_count = 0usize;
        let mut polls = 0usize;
        loop {
            polls += 1;
            if polls > 64 {
                break;
            }
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => items.push(item),
                Poll::Ready(None) => break,
                Poll::Pending => pending_count += 1,
            }
        }

        items.sort_unstable();
        let ok = items == vec![1, 2, 3, 4, 5, 6];
        crate::assert_with_log!(ok, "merged items", vec![1, 2, 3, 4, 5, 6], items);
        crate::assert_with_log!(pending_count > 0, "pending seen", true, pending_count > 0);
        crate::test_complete!("merge_pending_streams_make_progress");
    }

    #[test]
    fn merge_size_hint_unknown_upper() {
        init_test("merge_size_hint_unknown_upper");
        let streams: Vec<Box<dyn Stream<Item = usize> + Unpin>> = vec![
            Box::new(UnknownUpper::new(3)),
            Box::new(iter(vec![1usize, 2])),
        ];
        let stream = merge(streams);
        let hint = stream.size_hint();
        let ok = hint == (2, None);
        crate::assert_with_log!(ok, "size hint", (2, None::<usize>), hint);
        crate::test_complete!("merge_size_hint_unknown_upper");
    }

    #[test]
    fn merge_empty() {
        init_test("merge_empty");
        let mut stream: Merge<crate::stream::Iter<std::vec::IntoIter<i32>>> = merge([]);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let poll = Pin::new(&mut stream).poll_next(&mut cx);
        let ok = matches!(poll, Poll::Ready(None));
        crate::assert_with_log!(ok, "poll empty", "Poll::Ready(None)", poll);
        crate::test_complete!("merge_empty");
    }

    #[test]
    fn merge_three_streams_all_items_once() {
        init_test("merge_three_streams_all_items_once");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(iter(vec![1, 2]).map(|v| (0usize, v))),
            boxed_stream(iter(vec![10, 20]).map(|v| (1usize, v))),
            boxed_stream(iter(vec![100, 200]).map(|v| (2usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        items.sort_unstable();
        let expected = vec![(0, 1), (0, 2), (1, 10), (1, 20), (2, 100), (2, 200)];
        let ok = items == expected;
        tracing::info!(total = items.len(), "merge total");
        crate::assert_with_log!(ok, "all items once", expected, items);
        crate::test_complete!("merge_three_streams_all_items_once");
    }

    #[test]
    fn merge_empty_stream_passes_through_other() {
        init_test("merge_empty_stream_passes_through_other");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(iter(Vec::<i32>::new()).map(|v| (0usize, v))),
            boxed_stream(iter(vec![1, 2, 3]).map(|v| (1usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let expected = vec![(1, 1), (1, 2), (1, 3)];
        let ok = items == expected;
        tracing::info!(total = items.len(), "merge total");
        crate::assert_with_log!(ok, "pass through", expected, items);
        crate::test_complete!("merge_empty_stream_passes_through_other");
    }

    #[test]
    fn merge_both_streams_empty() {
        init_test("merge_both_streams_empty");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(iter(Vec::<i32>::new()).map(|v| (0usize, v))),
            boxed_stream(iter(Vec::<i32>::new()).map(|v| (1usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let poll = Pin::new(&mut stream).poll_next(&mut cx);
        let ok = matches!(poll, Poll::Ready(None));
        crate::assert_with_log!(ok, "both empty", "Poll::Ready(None)", poll);
        crate::test_complete!("merge_both_streams_empty");
    }

    #[test]
    fn merge_error_item_propagates() {
        init_test("merge_error_item_propagates");
        let streams: Vec<BoxedStream<(usize, Result<i32, &'static str>)>> = vec![
            boxed_stream(iter(vec![Ok(1), Err("boom"), Ok(2)]).map(|v| (0usize, v))),
            boxed_stream(iter(vec![Ok(10)]).map(|v| (1usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = ?item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let has_error = items.iter().any(|(_, v)| v.is_err());
        let ok_count = items.iter().filter(|(_, v)| v.is_ok()).count();
        tracing::info!(total = items.len(), ok_count, has_error, "merge totals");
        crate::assert_with_log!(has_error, "error observed", true, has_error);
        crate::assert_with_log!(ok_count == 3, "ok count", 3usize, ok_count);
        crate::test_complete!("merge_error_item_propagates");
    }

    #[test]
    fn merge_size_hint_sum() {
        init_test("merge_size_hint_sum");
        let stream = merge([iter(vec![1, 2, 3]), iter(vec![4, 5])]);
        let hint = stream.size_hint();
        let ok = hint == (5, Some(5));
        crate::assert_with_log!(ok, "size hint sum", (5, Some(5)), hint);
        crate::test_complete!("merge_size_hint_sum");
    }

    #[test]
    fn merge_drop_cancels_streams() {
        init_test("merge_drop_cancels_streams");
        let dropped = Arc::new(AtomicUsize::new(0));
        let streams = vec![
            DropStream::new(0, dropped.clone()),
            DropStream::new(1, dropped.clone()),
        ];
        let stream = merge(streams);
        drop(stream);
        let count = dropped.load(Ordering::Relaxed);
        crate::assert_with_log!(count == 2, "drop count", 2usize, count);
        crate::test_complete!("merge_drop_cancels_streams");
    }

    #[test]
    fn merge_fairness_fast_slow() {
        init_test("merge_fairness_fast_slow");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(iter(vec![1, 2, 3, 4, 5]).map(|v| (0usize, v))),
            boxed_stream(LaggyStream::new(1, vec![10, 20], 3)),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        let mut polls = 0usize;
        while polls < 128 {
            polls += 1;
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let fast_count = items.iter().filter(|(s, _)| *s == 0).count();
        let slow_count = items.iter().filter(|(s, _)| *s == 1).count();
        let first_slow = items.iter().position(|(s, _)| *s == 1);
        tracing::info!(fast_count, slow_count, "merge totals");
        crate::assert_with_log!(fast_count == 5, "fast count", 5usize, fast_count);
        crate::assert_with_log!(slow_count == 2, "slow count", 2usize, slow_count);
        let ok = first_slow.is_some() && first_slow.unwrap_or(0) < items.len().saturating_sub(1);
        crate::assert_with_log!(ok, "slow not starved", true, ok);
        crate::test_complete!("merge_fairness_fast_slow");
    }

    #[test]
    fn merge_interleaving_pending_alternates() {
        init_test("merge_interleaving_pending_alternates");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(PendingEveryOther::new(vec![1, 3, 5]).map(|v| (0usize, v))),
            boxed_stream(PendingEveryOther::new(vec![2, 4, 6]).map(|v| (1usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        let mut polls = 0usize;
        while polls < 128 {
            polls += 1;
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        let transitions = items.windows(2).filter(|w| w[0].0 != w[1].0).count();
        let total = items.len();
        tracing::info!(total, transitions, "merge totals");
        crate::assert_with_log!(total == 6, "total items", 6usize, total);
        crate::assert_with_log!(transitions > 0, "has interleaving", true, transitions > 0);
        crate::test_complete!("merge_interleaving_pending_alternates");
    }

    #[test]
    fn merge_backpressure_resume_no_loss() {
        init_test("merge_backpressure_resume_no_loss");
        let streams: Vec<BoxedStream<(usize, i32)>> = vec![
            boxed_stream(iter(vec![1, 3, 5]).map(|v| (0usize, v))),
            boxed_stream(iter(vec![2, 4, 6]).map(|v| (1usize, v))),
        ];
        let mut stream = merge(streams);
        let waker = noop_waker();
        let mut cx = Context::from_waker(&waker);

        let mut items = Vec::new();
        for _ in 0..2 {
            if let Poll::Ready(Some(item)) = Pin::new(&mut stream).poll_next(&mut cx) {
                tracing::info!(source = item.0, value = item.1, "merge item");
                items.push(item);
            }
        }

        loop {
            match Pin::new(&mut stream).poll_next(&mut cx) {
                Poll::Ready(Some(item)) => {
                    tracing::info!(source = item.0, value = item.1, "merge item");
                    items.push(item);
                }
                Poll::Ready(None) => break,
                Poll::Pending => {}
            }
        }

        items.sort_unstable();
        let expected = vec![(0, 1), (0, 3), (0, 5), (1, 2), (1, 4), (1, 6)];
        tracing::info!(total = items.len(), "merge total");
        crate::assert_with_log!(items == expected, "no loss", expected, items);
        crate::test_complete!("merge_backpressure_resume_no_loss");
    }

    #[test]
    fn merge_yields_cooperatively_when_scan_budget_is_exhausted() {
        init_test("merge_yields_cooperatively_when_scan_budget_is_exhausted");
        let stream_count = MERGE_COOPERATIVE_POLL_BUDGET + 5;
        let streams: Vec<BoxedStream<usize>> = (0..stream_count)
            .map(|_| boxed_stream(AlwaysPending))
            .collect();
        let mut stream = merge(streams);
        let woke = Arc::new(AtomicBool::new(false));
        let waker = Waker::from(Arc::new(TrackWaker(woke.clone())));
        let mut cx = Context::from_waker(&waker);

        let first = Pin::new(&mut stream).poll_next(&mut cx);
        crate::assert_with_log!(
            matches!(first, Poll::Pending),
            "first poll yields cooperatively",
            "Poll::Pending",
            first
        );
        crate::assert_with_log!(
            woke.load(Ordering::SeqCst),
            "self-wake requested",
            true,
            woke.load(Ordering::SeqCst)
        );
        crate::assert_with_log!(
            stream.next_index == MERGE_COOPERATIVE_POLL_BUDGET,
            "resume cursor advanced to budget boundary",
            MERGE_COOPERATIVE_POLL_BUDGET,
            stream.next_index
        );

        woke.store(false, Ordering::SeqCst);
        let second = Pin::new(&mut stream).poll_next(&mut cx);
        crate::assert_with_log!(
            matches!(second, Poll::Pending),
            "second poll also yields cooperatively",
            "Poll::Pending",
            second
        );
        crate::assert_with_log!(
            woke.load(Ordering::SeqCst),
            "second self-wake requested",
            true,
            woke.load(Ordering::SeqCst)
        );
        crate::assert_with_log!(
            stream.next_index == (MERGE_COOPERATIVE_POLL_BUDGET * 2) % stream_count,
            "resume cursor keeps rotating across polls",
            (MERGE_COOPERATIVE_POLL_BUDGET * 2) % stream_count,
            stream.next_index
        );
        crate::test_complete!("merge_yields_cooperatively_when_scan_budget_is_exhausted");
    }
}