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
mod error;
mod http_range;
mod test_client;

use futures_util::TryStreamExt;
use std::ops::{Range, RangeFrom};
use std::pin::Pin;
use std::task::{Context, Poll};
use tokio::io::{AsyncRead, AsyncReadExt, ReadBuf};
use tokio_util::io::StreamReader;

#[macro_use]
extern crate log;

pub use error::{Error, Result};
pub use http_range::HttpRange;

use async_trait::async_trait;

/// A stream centric HTTP client.
///
/// ```
/// use streaming_http_range_client::HttpClient;
/// use tokio::io::AsyncReadExt;
///
/// use tokio;
/// # tokio_test::block_on(async {
/// let mut new_client = HttpClient::new("https://georust.org");
/// new_client.set_range(2..14).await.unwrap();
///
/// let mut output = String::new();
/// new_client.read_to_string(&mut output).await.unwrap();
///
/// // This `expected_text` may need to be updated someday if someone updates the site.
/// let expected_text = "DOCTYPE html";
/// assert_eq!(expected_text, output)
/// # });
///
/// ```
pub struct HttpClient {
    client: Box<dyn ReaderSource>,
    reader: Reader,
    range: Option<HttpRange>,
    pos: u64,
    stats: ReqStats,
}

impl std::fmt::Debug for HttpClient {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("HttpClient")
            .field("client", &self.client)
            // .field("reader", &self.reader)
            .field("range", &self.range)
            .field("pos", &self.pos)
            .field("stats", &self.stats)
            .finish()
    }
}

#[derive(Debug, Default)]
struct ReqStats {
    wasted_bytes: u64,
    used_bytes: u64,
    req_count: usize,
}

impl HttpClient {
    /// Create a new client. To get data from the client, call [`set_range`] and start reading
    /// from the client.
    pub fn new(url: &str) -> Self {
        Self {
            client: Box::new(ReqwestClient::new(url)),
            reader: empty(),
            pos: 0,
            range: None,
            stats: ReqStats::default(),
        }
    }

    //
    pub async fn set_range(&mut self, range: Range<u64>) -> Result<()> {
        assert!(!range.is_empty());
        self.pos = range.start;
        self.stats.req_count += 1;
        trace!(
            "set_range {range:?}, request #{req_count}",
            req_count = self.stats.req_count
        );
        self.reader = self.client.get_byte_range(range.clone()).await?;
        self.range = Some(HttpRange::Range(range));

        Ok(())
    }

    /// Advance client to `to_pos`, discarding any intermediate data, without fetching further data.
    ///
    /// `to_pos` must be within the current range and must not occur before the current position.
    pub async fn fast_forward(&mut self, to_pos: u64) -> Result<()> {
        assert!(to_pos >= self.pos, "can't rewind");

        let len = to_pos - self.pos;
        if len == 0 {
            return Ok(());
        }
        self.stats.wasted_bytes += len;

        let mut ff_reader = empty();
        std::mem::swap(&mut ff_reader, &mut self.reader);
        let mut ff_reader = ff_reader.take(len);
        tokio::io::copy(&mut ff_reader, &mut tokio::io::sink()).await?;
        let reader = ff_reader.into_inner();
        self.pos += len;
        assert_eq!(self.pos, to_pos);

        self.reader = reader;
        Ok(())
    }

    /// Fast forwards to the beginning of range, fetching additional data if necessary.
    pub async fn seek_to_range(&mut self, range: impl Into<HttpRange>) -> Result<()> {
        let Some(HttpRange::Range(existing_range)) = &mut self.range else {
            // TODO: Is there a reason *not* to support None or Some(HttpRange::RangeFrom)?
            panic!("can only fast forward from double ended range");
        };
        let range = range.into();
        trace!("seek_to_range: {range:?}");
        assert!(range.start() >= self.pos, "can't rewind");
        match range {
            HttpRange::Range(range) => {
                if range.start == self.pos {
                    if range.end <= existing_range.end {
                        trace!("Already at requested byte position and already have the requested data. No new request will be made.");
                        Ok(())
                    } else {
                        self.append_contiguous_range(range).await
                    }
                } else if range.end <= existing_range.end {
                    trace!("Fast forwarding to the requested byte position but already have the requested data. No new request will be made.");
                    self.fast_forward(range.start).await
                } else if range.start > existing_range.end {
                    self.set_range(range).await
                } else {
                    assert!(range.start > self.pos);
                    assert!(
                        range.end > existing_range.end,
                        "failed: {range_end}, > {existing_range_end}",
                        range_end = range.end,
                        existing_range_end = existing_range.end
                    );
                    self.fast_forward(range.start).await?;
                    self.append_contiguous_range(range).await
                }
            }
            HttpRange::RangeFrom(range) => {
                if range.start == self.pos {
                    trace!("nothing to do");
                    Ok(())
                } else {
                    // TODO optimize for skipping over a lot of middle content
                    // e.g. self.set_range(range)
                    self.extend_to_end().await?;
                    self.fast_forward(range.start).await
                }
            }
        }
    }

    /// Fetch all the bytes to the end of the file.
    ///
    /// Panics when the current range is:
    ///  - not set (see [`set_range`])
    ///  - an open ended (RangeFrom) range, since it can't be extended
    pub async fn extend_to_end(&mut self) -> Result<()> {
        debug!("extending to end");
        let Some(HttpRange::Range(prev_range)) = &self.range else {
            panic!("must call set_range before you can extendToRange");
        };

        self.stats.req_count += 1;
        trace!(
            "extend_to_end from {prev_range:?}, request #{req_count}",
            req_count = self.stats.req_count
        );
        let reader = self.client.get_byte_range_from(prev_range.end..).await?;

        let mut tmp = empty();
        std::mem::swap(&mut self.reader, &mut tmp);
        self.reader = Box::pin(tmp.chain(reader));

        let new_range = prev_range.start..;
        self.range = Some(HttpRange::RangeFrom(new_range));

        Ok(())
    }

    /// Append a contiguous extension to the current range.
    ///
    /// Panics when the current range is:
    ///  - not set (see [`set_range`])
    ///  - an open ended (RangeFrom) range, since it can't be extended
    ///  - not contiguous with the extension
    pub async fn append_contiguous_range(&mut self, extension: Range<u64>) -> Result<()> {
        let Some(range) = &self.range else {
            panic!("must call set_range before you can extend a range");
        };

        let HttpRange::Range(prev_range) = range else {
            panic!("cannot extend an already open-ended range");
        };

        assert!(
            prev_range.end >= extension.start,
            "new range must be contiguous with old range"
        );

        if prev_range.end >= extension.end {
            debug!(
                "skipping extension {extension:?} which is within existing range: {prev_range:?}"
            );
            return Ok(());
        }

        self.stats.req_count += 1;
        let uncovered_range = prev_range.end..extension.end;
        trace!("append_contiguous_range {extension:?}, previously uncovered_range: {uncovered_range:?}. request #{req_count}", req_count=self.stats.req_count);
        let reader = self.client.get_byte_range(uncovered_range.clone()).await?;

        let mut tmp = empty();
        std::mem::swap(&mut self.reader, &mut tmp);
        self.reader = Box::pin(tmp.chain(reader));
        let new_range = prev_range.start..extension.end;
        self.range = Some(HttpRange::Range(new_range));

        Ok(())
    }

    /// Move all the unread data from this client into a new instance.
    pub fn split_off(&mut self) -> Self {
        let Some(range) = &mut self.range else {
            panic!("must set_range before splitting off");
        };

        let after = range.split(self.pos);
        assert_eq!(range.end(), Some(self.pos));

        let mut old_reader = empty();
        std::mem::swap(&mut self.reader, &mut old_reader);

        Self {
            client: self.client.boxed_clone(),
            reader: old_reader,
            pos: self.pos,
            range: Some(after),
            stats: ReqStats::default(),
        }
    }

    /// Does the client already encompass the given range?
    ///
    /// Caveat: If the client's current Range has an explicit end, we assume any given open ended
    /// `(123..)` Range goes beyond the current Range.
    pub fn contains(&self, range: &HttpRange) -> bool {
        let Some(current_range) = &self.range else {
            return false;
        };
        if current_range.start() >= range.start() {
            warn!("rewinding?");
            return false;
        }
        let Some(current_end) = current_range.end() else {
            return true;
        };

        let Some(range_end) = range.end() else {
            return false;
        };

        current_end >= range_end
    }
}

impl Drop for HttpClient {
    fn drop(&mut self) {
        debug!("Finished using an HTTP client. used_bytes={used_bytes}, wasted_bytes={wasted_bytes}, req_count={req_count}", used_bytes=self.stats.used_bytes, wasted_bytes=self.stats.wasted_bytes, req_count=self.stats.req_count)
    }
}

impl AsyncRead for HttpClient {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
        assert!(
            self.range.is_some(),
            "must call set_range (and await) before attempting read"
        );

        let len_before = buf.filled().len();
        let result = self.reader.as_mut().poll_read(cx, buf);

        let distance = buf.filled().len() - len_before;
        self.pos += distance as u64;
        self.stats.used_bytes += distance as u64;
        trace!("read {distance} bytes. New pos={pos}", pos = self.pos);

        result
    }
}

#[async_trait]
trait ReaderSource: Sync + Send + std::fmt::Debug {
    async fn get_byte_range(&self, range: Range<u64>) -> Result<Reader>;

    async fn get_byte_range_from(&self, range: RangeFrom<u64>) -> Result<Reader>;

    fn boxed_clone(&self) -> Box<dyn ReaderSource>;
}

#[derive(Debug, Clone)]
struct ReqwestClient {
    client: reqwest::Client,
    url: String,
}

impl ReqwestClient {
    fn new(url: &str) -> Self {
        Self {
            client: reqwest::Client::new(),
            url: url.to_string(),
        }
    }

    async fn get_byte_range_with_header(&self, range_header: &str) -> Result<Reader> {
        debug!("getting range: {range_header}");

        let response = self
            .client
            .get(&self.url)
            .header(reqwest::header::RANGE, range_header)
            .send()
            .await
            .map_err(|e| Error::External(Box::new(e)))?;

        let status = response.status();
        match response.headers().get("Content-Length") {
            Some(content_length) => debug!("content length: {content_length:?}"),
            None => debug!("Response lacks a content length header"),
        }

        if !status.is_success() {
            return Err(Error::HttpFailed {
                status: status.as_u16(),
            });
        }
        let bytes_stream = response
            .bytes_stream()
            .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e));

        Ok(Box::pin(StreamReader::new(bytes_stream)))
    }
}

#[async_trait]
impl ReaderSource for ReqwestClient {
    async fn get_byte_range(&self, range: Range<u64>) -> Result<Reader> {
        let range_header = format!("bytes={}-{}", range.start, (range.end - 1));
        self.get_byte_range_with_header(&range_header).await
    }

    async fn get_byte_range_from(&self, range: RangeFrom<u64>) -> Result<Reader> {
        let range_header = format!("bytes={}-", range.start);
        self.get_byte_range_with_header(&range_header).await
    }

    fn boxed_clone(&self) -> Box<dyn ReaderSource> {
        Box::new(self.clone())
    }
}

type Reader = Pin<Box<dyn AsyncRead + Sync + Send>>;

pub(crate) fn empty() -> Reader {
    Box::pin(std::io::Cursor::new(vec![]))
}

#[cfg(test)]
mod tests {
    use super::*;
    use tokio::io::AsyncReadExt;

    #[tokio::test]
    async fn single_reader() {
        ensure_logging();

        let input = (0..4).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);
        reader.set_range(0..4).await.unwrap();

        let mut output = vec![];
        reader.read_to_end(&mut output).await.unwrap();
        assert_eq!(output, input);
    }

    #[tokio::test]
    async fn empty_reader() {
        ensure_logging();

        let input = (0..4).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);
        reader.set_range(0..4).await.unwrap();
        let mut output = vec![];
        reader.read_to_end(&mut output).await.unwrap();
        assert_eq!(output, input);

        let mut remainder = Vec::<u8>::new();
        reader.read_to_end(&mut remainder).await.unwrap();
        assert!(remainder.is_empty());
    }

    #[tokio::test]
    async fn extend_range() {
        ensure_logging();

        let input = (0..7).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);
        reader.set_range(0..3).await.unwrap();

        let mut output = vec![];
        reader.read_to_end(&mut output).await.unwrap();
        assert_eq!(output, vec![0, 1, 2]);

        reader.append_contiguous_range(3..6).await.unwrap();
        reader.read_to_end(&mut output).await.unwrap();
        assert_eq!(output, vec![0, 1, 2, 3, 4, 5]);
    }

    #[tokio::test]
    async fn read_le_u3() {
        let input: [u8; 4] = [140, 1, 0, 0];
        let mut reader = HttpClient::test_client(&input);
        reader.set_range(0..4).await.unwrap();
        let result = reader.read_u32_le().await.unwrap();
        assert_eq!(result, 396);
    }

    #[tokio::test]
    async fn split_off() {
        let input = (0..8).collect::<Vec<u8>>();
        let mut parent_reader = HttpClient::test_client(&input);
        parent_reader.set_range(0..7).await.unwrap();

        let mut output = [0; 4];
        parent_reader.read_exact(&mut output).await.unwrap();
        assert_eq!(output, [0, 1, 2, 3]);

        let mut child_reader = parent_reader.split_off();

        let mut remainder = vec![];
        parent_reader.read_to_end(&mut remainder).await.unwrap();
        assert!(remainder.is_empty());

        let mut output = [0; 4];
        child_reader.append_contiguous_range(7..8).await.unwrap();
        child_reader.read_exact(&mut output).await.unwrap();
        assert_eq!(output, [4, 5, 6, 7]);
    }

    #[tokio::test]
    async fn extend_to_end() {
        let input = (0..8).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);

        reader.set_range(4..5).await.unwrap();
        reader.extend_to_end().await.unwrap();

        let mut output = vec![];
        reader.read_to_end(&mut output).await.unwrap();

        assert_eq!(output, [4, 5, 6, 7])
    }

    #[tokio::test]
    async fn fast_forward() {
        let input = (0..8).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);

        reader.set_range(2..7).await.unwrap();
        reader.fast_forward(3).await.unwrap();
        let next = reader.read_u8().await.unwrap();
        assert_eq!(next, 3);
    }

    #[should_panic]
    #[tokio::test]
    async fn fast_forward_too_far() {
        let input = (0..8).collect::<Vec<u8>>();
        let mut reader = HttpClient::test_client(&input);

        reader.set_range(2..7).await.unwrap();
        reader.fast_forward(3).await.unwrap();
        let next = reader.read_u8().await.unwrap();
        assert_eq!(next, 3);

        // panics
        reader.fast_forward(2).await.unwrap();
        reader.fast_forward(3).await.unwrap();
    }

    #[cfg(test)]
    fn ensure_logging() {
        static ONCE: std::sync::Once = std::sync::Once::new();
        ONCE.call_once(|| env_logger::builder().format_timestamp_millis().init());
    }
}