aria2-core 0.3.13

aria2-rust core download engine: multi-protocol segmented downloads, rate limiting, configuration, session persistence, and BitTorrent seeding
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
use super::*;

#[cfg(test)]
mod http_status_tests {
    use super::*;
    use crate::request::request_group::DownloadOptions;

    #[test]
    fn classifies_5xx_as_retryable_server_errors() {
        assert!(matches!(
            classify_metalink_http_status(503),
            Aria2Error::Recoverable(RecoverableError::ServerError { code: 503 })
        ));
    }

    #[test]
    fn classifies_configured_4xx_transients_as_retryable_server_errors() {
        for status_code in [408, 429] {
            assert!(matches!(
                classify_metalink_http_status(status_code),
                Aria2Error::Recoverable(RecoverableError::ServerError { code })
                    if code == status_code
            ));
        }
    }

    #[test]
    fn classifies_not_found_as_resource_not_found() {
        assert!(matches!(
            classify_metalink_http_status(404),
            Aria2Error::Recoverable(RecoverableError::ResourceNotFound)
        ));
    }

    #[test]
    fn classifies_authentication_statuses_as_http_auth_failures() {
        for status_code in [401, 407] {
            assert!(matches!(
                classify_metalink_http_status(status_code),
                Aria2Error::Recoverable(RecoverableError::HttpAuthFailed { message })
                    if message == format!("authentication failed: HTTP {status_code}")
            ));
        }
    }

    #[tokio::test]
    async fn mirror_not_found_respects_request_group_limit() {
        use std::sync::{
            Arc,
            atomic::{AtomicUsize, Ordering},
        };
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("404 fixture should bind");
        let base_url = format!("http://{}", listener.local_addr().unwrap());
        let request_count = Arc::new(AtomicUsize::new(0));
        let server_count = Arc::clone(&request_count);
        let server = tokio::spawn(async move {
            for _ in 0..2 {
                let (mut stream, _) = listener.accept().await.expect("404 request");
                let mut request = [0u8; 2048];
                let _ = stream.read(&mut request).await.expect("read 404 request");
                server_count.fetch_add(1, Ordering::SeqCst);
                stream
                    .write_all(
                        b"HTTP/1.1 404 Not Found\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
                    )
                    .await
                    .expect("write 404 response");
            }
        });

        let output_dir = tempfile::tempdir().expect("output directory");
        let xml = format!(
            r#"<?xml version="1.0" encoding="UTF-8"?>
<metalink xmlns="urn:ietf:params:xml:ns:metalink">
  <file name="payload.bin">
    <size>1</size>
    <url>{base_url}/first</url>
    <url>{base_url}/second</url>
  </file>
</metalink>"#
        );
        let options = DownloadOptions {
            dir: Some(output_dir.path().to_string_lossy().into_owned()),
            ..DownloadOptions::default()
        };
        let mut command =
            MetalinkDownloadCommand::new(GroupId::new(401), xml.as_bytes(), &options, None)
                .expect("Metalink command should construct");
        command
            .group
            .recover_mut()
            .set_option_snapshot(std::collections::HashMap::from([(
                "max-file-not-found".to_string(),
                serde_json::json!("2"),
            )]));

        let error = command
            .execute()
            .await
            .expect_err("second 404 must stop the group");
        assert!(matches!(
            error,
            Aria2Error::Recoverable(RecoverableError::MaxFileNotFound)
        ));
        assert_eq!(request_count.load(Ordering::SeqCst), 2);
        server.await.expect("404 fixture should finish");
    }

    #[tokio::test]
    async fn mirror_not_found_zero_does_not_fail_over_to_next_mirror() {
        use std::sync::{
            Arc,
            atomic::{AtomicUsize, Ordering},
        };
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("404 fixture should bind");
        let base_url = format!("http://{}", listener.local_addr().unwrap());
        let request_count = Arc::new(AtomicUsize::new(0));
        let server_count = Arc::clone(&request_count);
        let server = tokio::spawn(async move {
            let (mut stream, _) = listener.accept().await.expect("first 404 request");
            let mut request = [0u8; 2048];
            let _ = stream.read(&mut request).await.expect("read first request");
            server_count.fetch_add(1, Ordering::SeqCst);
            stream
                .write_all(
                    b"HTTP/1.1 404 Not Found\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
                )
                .await
                .expect("write first 404 response");

            if let Ok(Ok((mut stream, _))) =
                tokio::time::timeout(std::time::Duration::from_millis(500), listener.accept()).await
            {
                let _ = stream
                    .read(&mut request)
                    .await
                    .expect("read second request");
                server_count.fetch_add(1, Ordering::SeqCst);
                stream
                    .write_all(
                        b"HTTP/1.1 200 OK\r\nContent-Length: 1\r\nConnection: close\r\n\r\nx",
                    )
                    .await
                    .expect("write second response");
            }
        });

        let output_dir = tempfile::tempdir().expect("output directory");
        let xml = format!(
            r#"<?xml version="1.0" encoding="UTF-8"?>
<metalink xmlns="urn:ietf:params:xml:ns:metalink">
  <file name="payload.bin">
    <size>1</size>
    <url>{base_url}/first</url>
    <url>{base_url}/second</url>
  </file>
</metalink>"#
        );
        let options = DownloadOptions {
            dir: Some(output_dir.path().to_string_lossy().into_owned()),
            ..DownloadOptions::default()
        };
        let mut command =
            MetalinkDownloadCommand::new(GroupId::new(402), xml.as_bytes(), &options, None)
                .expect("Metalink command should construct");
        command
            .group
            .recover_mut()
            .set_option_snapshot(std::collections::HashMap::from([(
                "max-file-not-found".to_string(),
                serde_json::json!("0"),
            )]));

        let output_path = command.output_path.clone();
        let error = command
            .execute()
            .await
            .expect_err("max-file-not-found=0 must stop after the first 404");
        assert!(matches!(
            error,
            Aria2Error::Recoverable(RecoverableError::ResourceNotFound)
        ));
        assert_eq!(request_count.load(Ordering::SeqCst), 1);
        assert!(!output_path.exists());
        tokio::time::timeout(std::time::Duration::from_secs(2), server)
            .await
            .expect("404 fixture should finish")
            .expect("404 fixture task should succeed");
    }

    #[tokio::test]
    async fn mirror_504_retries_before_completing() {
        use std::sync::{
            Arc,
            atomic::{AtomicUsize, Ordering},
        };
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("504 fixture should bind");
        let url = format!("http://{}/payload", listener.local_addr().unwrap());
        let request_count = Arc::new(AtomicUsize::new(0));
        let server_count = Arc::clone(&request_count);
        let server = tokio::spawn(async move {
            for attempt in 0..2 {
                let (mut stream, _) = listener.accept().await.expect("mirror request");
                let mut request = [0u8; 2048];
                let _ = stream
                    .read(&mut request)
                    .await
                    .expect("read mirror request");
                server_count.fetch_add(1, Ordering::SeqCst);
                if attempt == 0 {
                    stream
                        .write_all(
                            b"HTTP/1.1 504 Gateway Timeout\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
                        )
                        .await
                        .expect("write 504 response");
                } else {
                    stream
                        .write_all(
                            b"HTTP/1.1 200 OK\r\nContent-Length: 1\r\nConnection: close\r\n\r\nx",
                        )
                        .await
                        .expect("write success response");
                }
            }
        });

        let output_dir = tempfile::tempdir_in("../target").expect("output directory");
        let xml = format!(
            r#"<?xml version="1.0"?>
<metalink xmlns="urn:ietf:params:xml:ns:metalink">
  <file name="payload.bin">
    <size>1</size>
    <url>{url}</url>
  </file>
</metalink>"#
        );
        let options = DownloadOptions {
            dir: Some(output_dir.path().to_string_lossy().into_owned()),
            max_retries: 2,
            retry_wait: 0,
            ..DownloadOptions::default()
        };
        let mut command =
            MetalinkDownloadCommand::new(GroupId::new(403), xml.as_bytes(), &options, None)
                .expect("Metalink command should construct");

        command.execute().await.expect("504 retry should complete");

        assert_eq!(request_count.load(Ordering::SeqCst), 2);
        assert_eq!(tokio::fs::read(command.output_path()).await.unwrap(), b"x");
        server.await.expect("504 fixture should finish");
    }

    #[tokio::test]
    async fn ftp_mirror_uses_the_ftp_protocol_adapter() {
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("FTP proxy fixture should bind");
        let proxy_address = listener.local_addr().expect("FTP proxy address");
        let server = tokio::spawn(async move {
            let (mut stream, _) = listener.accept().await.expect("FTP mirror request");
            let mut request = [0u8; 4096];
            let length = stream.read(&mut request).await.expect("read proxy request");
            let request = String::from_utf8_lossy(&request[..length]).into_owned();
            stream
                .write_all(
                    b"HTTP/1.1 200 OK\r\nContent-Length: 7\r\nConnection: close\r\n\r\npayload",
                )
                .await
                .expect("write FTP proxy payload");
            request
        });

        let output_dir = tempfile::tempdir_in("../target").expect("output directory");
        let xml = br#"<?xml version="1.0"?>
<metalink xmlns="urn:ietf:params:xml:ns:metalink">
  <file name="payload.bin"><size>7</size><url>ftp://127.0.0.1:21/payload.bin</url></file>
</metalink>"#;
        let options = DownloadOptions {
            dir: Some(output_dir.path().to_string_lossy().into_owned()),
            ftp_proxy: Some(format!("http://{proxy_address}")),
            proxy_method: "get".to_string(),
            max_retries: 1,
            ..DownloadOptions::default()
        };
        let mut command = MetalinkDownloadCommand::new(GroupId::new(404), xml, &options, None)
            .expect("Metalink command should construct");

        command
            .execute()
            .await
            .expect("FTP mirror should download through the FTP adapter");
        assert_eq!(
            tokio::fs::read(command.output_path()).await.unwrap(),
            b"payload"
        );
        let request = server.await.expect("FTP proxy fixture should finish");
        assert!(
            request.starts_with("GET ftp://anonymous@127.0.0.1/payload.bin "),
            "unexpected FTP proxy request: {request:?}"
        );
    }

    #[cfg(feature = "bittorrent")]
    #[tokio::test]
    async fn torrent_metaurl_504_retries_before_returning_metadata() {
        use std::sync::{
            Arc,
            atomic::{AtomicUsize, Ordering},
        };
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("torrent metaurl fixture should bind");
        let url = format!("http://{}/payload.torrent", listener.local_addr().unwrap());
        let request_count = Arc::new(AtomicUsize::new(0));
        let server_count = Arc::clone(&request_count);
        let server = tokio::spawn(async move {
            for attempt in 0..2 {
                let (mut stream, _) = listener.accept().await.expect("metadata request");
                let mut request = [0u8; 2048];
                let _ = stream
                    .read(&mut request)
                    .await
                    .expect("read metadata request");
                server_count.fetch_add(1, Ordering::SeqCst);
                if attempt == 0 {
                    stream
                        .write_all(
                            b"HTTP/1.1 504 Gateway Timeout\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
                        )
                        .await
                        .expect("write 504 response");
                } else {
                    stream
                        .write_all(
                            b"HTTP/1.1 200 OK\r\nContent-Length: 1\r\nConnection: close\r\n\r\nx",
                        )
                        .await
                        .expect("write metadata response");
                }
            }
        });

        let options = DownloadOptions {
            max_retries: 2,
            retry_wait: 0,
            ..DownloadOptions::default()
        };
        let mut command = MetalinkDownloadCommand::new(
            GroupId::new(404),
            br#"<?xml version="1.0"?><metalink xmlns="urn:ietf:params:xml:ns:metalink"><file name="payload.bin"><url>http://127.0.0.1/unused</url></file></metalink>"#,
            &options,
            None,
        )
        .expect("Metalink command should construct");

        let metadata = command
            .download_metadata_url_with_retry(&url)
            .await
            .expect("504 retry should return metadata");

        assert_eq!(metadata, b"x");
        assert_eq!(request_count.load(Ordering::SeqCst), 2);
        server.await.expect("torrent metaurl fixture should finish");
    }

    #[cfg(feature = "bittorrent")]
    #[tokio::test]
    async fn slow_torrent_metadata_read_observes_pause() {
        use std::sync::Arc;
        use tokio::io::{AsyncReadExt, AsyncWriteExt};
        use tokio::net::TcpListener;
        use tokio::sync::oneshot;

        let listener = TcpListener::bind("127.0.0.1:0")
            .await
            .expect("metadata fixture should bind");
        let url = format!("http://{}/payload.torrent", listener.local_addr().unwrap());
        let (headers_tx, headers_rx) = oneshot::channel();
        let server = tokio::spawn(async move {
            let (mut stream, _) = listener.accept().await.expect("metadata request");
            let mut request = [0u8; 2048];
            let _ = stream
                .read(&mut request)
                .await
                .expect("read metadata request");
            stream
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\nConnection: close\r\n\r\n")
                .await
                .expect("write metadata headers");
            let _ = headers_tx.send(());
            tokio::time::sleep(Duration::from_secs(2)).await;
        });

        let options = DownloadOptions::default();
        let command = MetalinkDownloadCommand::new(
            GroupId::new(402),
            br#"<?xml version="1.0"?><metalink xmlns="urn:ietf:params:xml:ns:metalink"><file name="payload.bin"><size>4</size><url>http://127.0.0.1/unused</url></file></metalink>"#,
            &options,
            None,
        )
        .expect("Metalink command should construct");
        let group = Arc::clone(&command.group);
        let command_task = tokio::spawn(async move { command.download_metadata_url(&url).await });

        headers_rx.await.expect("metadata headers should be sent");
        group.recover_mut().pause().expect("pause should succeed");

        let result = tokio::time::timeout(Duration::from_secs(1), command_task)
            .await
            .expect("metadata read should stop promptly after pause")
            .expect("metadata task should not panic")
            .expect_err("paused metadata read must return an error");
        assert!(matches!(
            result,
            Aria2Error::DownloadFailed(message) if message == "Download paused"
        ));
        server.abort();
    }
}