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
extern crate futures;
extern crate tokio_core;

use std::prelude::v1::*;
use std::io;
use std::time::Duration;
use std::mem;

use tokio_core::reactor::{Handle, Timeout};
use futures::{Async, Future, Poll};
use futures::stream::{Fuse, Stream};

/// An adaptor that chunks up elements in a vector.
///
/// This adaptor will buffer up a list of items in the stream and pass on the
/// vector used for buffering when a specified capacity has been reached
/// or a predefined timeout was triggered.
///
/// This was taken and adjusted from
/// https://github.com/alexcrichton/futures-rs/blob/master/src/stream/chunks.rs
/// and moved into a separate crate for usability.
#[must_use = "streams do nothing unless polled"]
pub struct Chunks<S>
where
    S: Stream,
{
    handle: Handle,
    clock: Option<Timeout>,
    duration: Duration,
    items: Vec<S::Item>,
    err: Option<S::Error>,
    stream: Fuse<S>,
}

impl<S> Chunks<S>
where
    S: Stream,
{
    pub fn new(s: S, handle: Handle, capacity: usize, duration: Duration) -> Chunks<S> {
        assert!(capacity > 0);

        Chunks {
            handle: handle,
            clock: None,
            duration: duration,
            items: Vec::with_capacity(capacity),
            err: None,
            stream: s.fuse(),
        }
    }

    fn take(&mut self) -> Vec<S::Item> {
        let cap = self.items.capacity();
        mem::replace(&mut self.items, Vec::with_capacity(cap))
    }

    /// Acquires a reference to the underlying stream that this combinator is
    /// pulling from.
    pub fn get_ref(&self) -> &S {
        self.stream.get_ref()
    }

    /// Acquires a mutable reference to the underlying stream that this
    /// combinator is pulling from.
    ///
    /// Note that care must be taken to avoid tampering with the state of the
    /// stream which may otherwise confuse this combinator.
    pub fn get_mut(&mut self) -> &mut S {
        self.stream.get_mut()
    }

    /// Consumes this combinator, returning the underlying stream.
    ///
    /// Note that this may discard intermediate state of this combinator, so
    /// care should be taken to avoid losing resources when this is called.
    pub fn into_inner(self) -> S {
        self.stream.into_inner()
    }

    fn flush(&mut self) -> Poll<Option<Vec<S::Item>>, S::Error> {
        self.clock = None;
        Ok(Some(self.take()).into())
    }
}

impl<S> Stream for Chunks<S>
where
    S: Stream,
    <S as Stream>::Error: From<io::Error>,
{
    type Item = Vec<<S as Stream>::Item>;
    type Error = <S as Stream>::Error;

    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
        if let Some(err) = self.err.take() {
            return Err(err);
        }

        let cap = self.items.capacity();
        loop {
            match self.stream.poll() {
                Ok(Async::NotReady) => {}

                // Push the item into the buffer and check whether it is full.
                // If so, replace our buffer with a new and empty one and return
                // the full one.
                Ok(Async::Ready(Some(item))) => {
                    if self.items.is_empty() {
                        self.clock = Some(Timeout::new(self.duration, &self.handle).unwrap());
                    }
                    self.items.push(item);
                    if self.items.len() >= cap {
                        return self.flush();
                    } else {
                        continue;
                    }
                }

                // Since the underlying stream ran out of values, return what we
                // have buffered, if we have anything.
                Ok(Async::Ready(None)) => {
                    return if !self.items.is_empty() {
                        let full_buf = mem::replace(&mut self.items, Vec::new());
                        Ok(Some(full_buf).into())
                    } else {
                        Ok(Async::Ready(None))
                    };
                }

                // If we've got buffered items be sure to return them first,
                // we'll defer our error for later.
                Err(e) => if self.items.is_empty() {
                    return Err(e);
                } else {
                    self.err = Some(e);
                    return self.flush();
                },
            }

            match self.clock.poll() {
                Ok(Async::Ready(Some(()))) => {
                    return self.flush();
                }
                Ok(Async::Ready(None)) => {
                    assert!(self.items.is_empty(), "no clock but there are items");
                }
                Ok(Async::NotReady) => {}
                Err(e) => if self.items.is_empty() {
                    return Err(From::from(e));
                } else {
                    self.err = Some(From::from(e));
                    return self.flush();
                },
            }

            return Ok(Async::NotReady);
        }
    }
}

#[cfg(test)]
mod tests {
    use tokio_core::reactor::Core;
    use futures::{stream, Stream};
    use std::iter;
    use std::time::{Duration, Instant};
    use super::*;

    #[test]
    fn messages_pass_through() {
        let mut core = Core::new().unwrap();
        let handle = core.handle();

        let iter = iter::once(5);
        let stream = stream::iter_ok::<_, io::Error>(iter);

        let chunk_stream = Chunks::new(stream, handle, 5, Duration::new(10, 0));

        let v = chunk_stream.collect();
        let result = core.run(v).unwrap();
        assert_eq!(vec![vec![5]], result);
    }

    #[test]
    fn message_chunks() {
        let mut core = Core::new().unwrap();
        let handle = core.handle();

        let iter = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9].into_iter();
        let stream = stream::iter_ok::<_, io::Error>(iter);

        let chunk_stream = Chunks::new(stream, handle, 5, Duration::new(10, 0));

        let v = chunk_stream.collect();
        let result = core.run(v).unwrap();
        assert_eq!(vec![vec![0, 1, 2, 3, 4], vec![5, 6, 7, 8, 9]], result);
    }

    #[test]
    fn message_early_exit() {
        let mut core = Core::new().unwrap();
        let handle = core.handle();

        let iter = vec![1, 2, 3, 4].into_iter();
        let stream = stream::iter_ok::<_, io::Error>(iter);

        let chunk_stream = Chunks::new(stream, handle, 5, Duration::new(100, 0));

        let v = chunk_stream.collect();
        let result = core.run(v).unwrap();
        assert_eq!(vec![vec![1, 2, 3, 4]], result);
    }

    #[test]
    fn message_timeout() {
        let mut core = Core::new().unwrap();
        let handle = core.handle();

        let iter = vec![1, 2, 3, 4].into_iter();
        let stream0 = stream::iter_ok::<_, io::Error>(iter);

        let iter = vec![5].into_iter();
        let stream1 = stream::iter_ok::<_, io::Error>(iter).and_then(|n| {
            Timeout::new(Duration::from_millis(300), &handle)
                .unwrap()
                .and_then(move |_| Ok(n))
        });

        let iter = vec![6, 7, 8].into_iter();
        let stream2 = stream::iter_ok::<_, io::Error>(iter);

        let stream = stream0.chain(stream1).chain(stream2);
        let chunk_stream = Chunks::new(stream, handle.clone(), 5, Duration::from_millis(100));

        let now = Instant::now();
        let min_times = [Duration::from_millis(80), Duration::from_millis(150)];
        let max_times = [Duration::from_millis(280), Duration::from_millis(350)];
        let results = vec![vec![1, 2, 3, 4], vec![5, 6, 7, 8]];
        let mut i = 0;

        let v = chunk_stream
            .map(|s| {
                let now2 = Instant::now();
                println!("{:?}", now2 - now);
                assert!((now2 - now) < max_times[i]);
                assert!((now2 - now) > min_times[i]);
                i += 1;
                s
            })
            .collect();

        let result = core.run(v).unwrap();
        assert_eq!(result, results);
    }
}