aria2-core 0.3.9

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
//! Tests for BtPeerMessageHandler — per-peer stateful message handler
//!
//! Split from bt_message_handler.rs to keep the main module under 1200 lines.

#[cfg(test)]
pub(crate) mod tests {
    use crate::engine::bt_message_handler::{
        BLOCK_SIZE, BtPeerMessageHandler, DEFAULT_MAX_OUTSTANDING_REQUEST,
        UB_MAX_OUTSTANDING_REQUEST,
    };
    use std::time::{Duration, Instant};

    // ── BtPeerMessageHandler creation tests ─────────────────────────────

    #[test]
    fn test_peer_handler_new_defaults() {
        let handler = BtPeerMessageHandler::new(BLOCK_SIZE);
        assert!(handler.is_peer_choking());
        assert!(!handler.is_peer_snubbing());
        assert!(!handler.has_outstanding_requests());
        assert_eq!(handler.count_outstanding_requests(), 0);
        assert!(handler.can_send_request());
        assert_eq!(
            handler.max_outstanding_requests(),
            DEFAULT_MAX_OUTSTANDING_REQUEST
        );
    }

    #[test]
    fn test_peer_handler_custom_max_outstanding() {
        let handler = BtPeerMessageHandler::with_max_outstanding(BLOCK_SIZE, 10);
        assert_eq!(handler.max_outstanding_requests(), 10);
    }

    // ── Request slot lifecycle tests ────────────────────────────────────

    #[test]
    fn test_send_request_adds_slot_and_queue() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        let result = handler.send_request(5, 0, BLOCK_SIZE, vec![0u8; 17]);
        assert!(result);
        assert_eq!(handler.count_outstanding_requests(), 1);
        assert!(handler.is_outstanding_request(5, 0));
        assert!(handler.has_pending_messages());
    }

    #[test]
    fn test_send_request_respects_max_outstanding() {
        let mut handler = BtPeerMessageHandler::with_max_outstanding(BLOCK_SIZE, 2);

        // Fill up to max
        assert!(handler.send_request(1, 0, BLOCK_SIZE, vec![1]));
        assert!(handler.send_request(2, 0, BLOCK_SIZE, vec![2]));
        assert_eq!(handler.count_outstanding_requests(), 2);

        // Third request should be rejected
        assert!(!handler.send_request(3, 0, BLOCK_SIZE, vec![3]));
        assert!(!handler.can_send_request());
    }

    #[test]
    fn test_on_piece_received_removes_slot() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.send_request(5, 0, BLOCK_SIZE, vec![0u8; 17]);
        assert_eq!(handler.count_outstanding_requests(), 1);

        let slot = handler.on_piece_received(5, 0, BLOCK_SIZE);
        assert!(slot.is_some());
        assert_eq!(handler.count_outstanding_requests(), 0);

        let slot = slot.unwrap();
        assert_eq!(slot.index, 5);
        assert_eq!(slot.begin, 0);
        assert_eq!(slot.length, BLOCK_SIZE);
    }

    #[test]
    fn test_on_piece_received_unsolicited() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        // No outstanding request for this piece
        let slot = handler.on_piece_received(99, 0, BLOCK_SIZE);
        assert!(slot.is_none());
    }

    #[test]
    fn test_request_slot_full_lifecycle() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        // Send multiple requests
        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        handler.send_request(5, BLOCK_SIZE, BLOCK_SIZE, vec![2]);
        handler.send_request(6, 0, BLOCK_SIZE, vec![3]);
        assert_eq!(handler.count_outstanding_requests(), 3);

        // Receive pieces out of order
        let slot = handler.on_piece_received(6, 0, BLOCK_SIZE);
        assert!(slot.is_some());
        assert_eq!(handler.count_outstanding_requests(), 2);

        let slot = handler.on_piece_received(5, 0, BLOCK_SIZE);
        assert!(slot.is_some());
        assert_eq!(handler.count_outstanding_requests(), 1);

        let slot = handler.on_piece_received(5, BLOCK_SIZE, BLOCK_SIZE);
        assert!(slot.is_some());
        assert_eq!(handler.count_outstanding_requests(), 0);
    }

    // ── Event-driven action tests ───────────────────────────────────────

    #[test]
    fn test_on_choke_received_removes_non_fast_slots() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);
        handler.peer_choking = false; // Start unchoked

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        handler.send_request(6, 0, BLOCK_SIZE, vec![2]);
        handler.send_request(7, 0, BLOCK_SIZE, vec![3]);

        // Piece 6 is in allowed-fast set
        let removed = handler.on_choke_received(|idx| idx == 6);
        assert_eq!(removed.len(), 2); // pieces 5 and 7 removed
        assert!(handler.is_peer_choking());
        assert_eq!(handler.count_outstanding_requests(), 1); // piece 6 kept
        assert!(handler.is_outstanding_request(6, 0));
    }

    #[test]
    fn test_on_choke_received_keeps_all_if_all_fast() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);
        handler.peer_choking = false;

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        handler.send_request(6, 0, BLOCK_SIZE, vec![2]);

        // All pieces are in allowed-fast set
        let removed = handler.on_choke_received(|_| true);
        assert!(removed.is_empty());
        assert_eq!(handler.count_outstanding_requests(), 2);
    }

    #[test]
    fn test_on_unchoke_received() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);
        assert!(handler.is_peer_choking());

        handler.on_unchoke_received();
        assert!(!handler.is_peer_choking());
    }

    #[test]
    fn test_on_choke_sent_invalidates_uploads() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.queue_control_message(vec![1]); // Choke
        handler.queue_upload_message(vec![2], 5, 0, BLOCK_SIZE); // Piece
        handler.queue_upload_message(vec![3], 6, 0, BLOCK_SIZE); // Piece

        handler.on_choke_sent();

        // Only non-upload messages should remain sendable
        let sendable = handler.drain_sendable_messages();
        assert_eq!(sendable.len(), 1); // Only the control message
    }

    #[test]
    fn test_on_cancel_received_invalidates_matching_piece() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.queue_upload_message(vec![1], 5, 0, BLOCK_SIZE);
        handler.queue_upload_message(vec![2], 5, BLOCK_SIZE, BLOCK_SIZE);
        handler.queue_upload_message(vec![3], 6, 0, BLOCK_SIZE);

        handler.on_cancel_received(5, 0, BLOCK_SIZE);

        // Only piece 5@BLOCK_SIZE and 6@0 should remain
        let sendable = handler.drain_sendable_messages();
        assert_eq!(sendable.len(), 2);
    }

    #[test]
    fn test_on_keepalive_received_increments_counter() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.on_keepalive_received();
        handler.on_keepalive_received();

        // Not yet flooding (check interval hasn't elapsed)
        assert!(!handler.detect_flooding());
    }

    // ── Abort piece requests tests ──────────────────────────────────────

    #[test]
    fn test_abort_piece_requests() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        handler.send_request(5, BLOCK_SIZE, BLOCK_SIZE, vec![2]);
        handler.send_request(6, 0, BLOCK_SIZE, vec![3]);

        let removed = handler.abort_piece_requests(5);
        assert_eq!(removed.len(), 2);
        assert_eq!(handler.count_outstanding_requests(), 1); // piece 6 remains
    }

    // ── Flooding detection tests ────────────────────────────────────────

    #[test]
    fn test_flooding_detected_via_choke_unchoke() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        // Simulate rapid choke/unchoke transitions
        handler.on_choke_received(|_| false);
        handler.on_unchoke_received();
        // Now 2 choke/unchoke transitions

        // Force the check interval to have elapsed
        handler.flooding_stat.last_reset = Instant::now() - Duration::from_secs(6);

        assert!(handler.detect_flooding());
    }

    #[test]
    fn test_flooding_detected_via_keepalive() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.on_keepalive_received();
        handler.on_keepalive_received();
        // 2 keepalive messages

        handler.flooding_stat.last_reset = Instant::now() - Duration::from_secs(6);

        assert!(handler.detect_flooding());
    }

    #[test]
    fn test_no_flooding_under_normal_traffic() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        // Only 1 transition — not flooding
        handler.on_unchoke_received();
        assert!(!handler.detect_flooding());
    }

    // ── Timeout detection tests ─────────────────────────────────────────

    #[test]
    fn test_check_request_slots_timeout_marks_snubbing() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        assert!(!handler.is_peer_snubbing());

        // Manually set the slot's dispatched time to the past
        if let Some(slot) = handler.dispatcher_mut().request_slots.first_mut() {
            slot.dispatched_at = Instant::now() - Duration::from_secs(120);
        }

        let result = handler.check_request_slots(|_, _| false);
        assert!(result.timed_out);
        assert!(handler.is_peer_snubbing());
        assert_eq!(handler.count_outstanding_requests(), 0);
    }

    #[test]
    fn test_check_request_slots_acquired_block() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]); // block_index = 0
        handler.send_request(5, BLOCK_SIZE, BLOCK_SIZE, vec![2]); // block_index = 1

        // Block 0 of piece 5 was acquired from another peer
        let result = handler.check_request_slots(|piece, block| piece == 5 && block == 0);
        assert!(!result.timed_out);
        assert_eq!(result.cancelled_blocks.len(), 1);
        assert_eq!(result.cancelled_blocks[0], (5, 0, BLOCK_SIZE));
        assert_eq!(handler.count_outstanding_requests(), 1); // block 1 still there
    }

    // ── Outstanding request scaling tests ───────────────────────────────

    #[test]
    fn test_scale_max_outstanding_requests_up() {
        let mut handler = BtPeerMessageHandler::with_max_outstanding(BLOCK_SIZE, 10);

        // Fill up 8 slots (80% of max)
        for i in 0..8 {
            handler.send_request(i, 0, BLOCK_SIZE, vec![1]);
        }
        assert_eq!(handler.count_outstanding_requests(), 8);

        // Simulate 3 slots being satisfied (3 * 4 = 12 >= 10)
        // This should trigger scaling
        let old = handler.count_outstanding_requests();
        for i in 0..3 {
            handler.on_piece_received(i, 0, BLOCK_SIZE);
        }
        handler.scale_max_outstanding_requests(old);
        assert_eq!(handler.max_outstanding_requests(), 20); // doubled
    }

    #[test]
    fn test_scale_max_outstanding_requests_capped() {
        let mut handler = BtPeerMessageHandler::with_max_outstanding(BLOCK_SIZE, 300);

        // Even if doubled, it should cap at UB_MAX_OUTSTANDING_REQUEST
        for i in 0..200 {
            handler.send_request(i, 0, BLOCK_SIZE, vec![1]);
        }
        let old = handler.count_outstanding_requests();
        for i in 0..200 {
            handler.on_piece_received(i, 0, BLOCK_SIZE);
        }
        handler.scale_max_outstanding_requests(old);
        assert_eq!(
            handler.max_outstanding_requests(),
            UB_MAX_OUTSTANDING_REQUEST
        );
    }

    #[test]
    fn test_no_scaling_when_few_satisfied() {
        let mut handler = BtPeerMessageHandler::with_max_outstanding(BLOCK_SIZE, 100);

        handler.send_request(1, 0, BLOCK_SIZE, vec![1]);
        handler.send_request(2, 0, BLOCK_SIZE, vec![2]);

        // Only 1 satisfied (1 * 4 = 4 < 100), no scaling
        let old = handler.count_outstanding_requests();
        handler.on_piece_received(1, 0, BLOCK_SIZE);
        handler.scale_max_outstanding_requests(old);
        assert_eq!(handler.max_outstanding_requests(), 100); // unchanged
    }

    // ── Message queue operations tests ──────────────────────────────────

    #[test]
    fn test_queue_and_drain_messages() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.queue_control_message(vec![0, 0, 0, 0]); // Choke
        handler.queue_control_message(vec![0, 0, 0, 1]); // Unchoke
        assert!(handler.has_pending_messages());
        assert_eq!(handler.count_pending_messages(), 2);

        let sent = handler.drain_sendable_messages();
        assert_eq!(sent.len(), 2);
        assert!(!handler.has_pending_messages());
    }

    #[test]
    fn test_upload_deferral_via_speed_limit() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.queue_control_message(vec![1]);
        handler.queue_upload_message(vec![2], 0, 0, BLOCK_SIZE);
        handler.set_upload_speed_exceeded(true);

        let sent = handler.drain_sendable_messages();
        assert_eq!(sent.len(), 1); // Only control message sent
        assert!(handler.has_pending_messages()); // Upload still queued

        handler.set_upload_speed_exceeded(false);
        let sent = handler.drain_sendable_messages();
        assert_eq!(sent.len(), 1); // The deferred upload message
    }

    // ── Cleanup tests ───────────────────────────────────────────────────

    #[test]
    fn test_clear_resets_state() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        handler.send_request(5, 0, BLOCK_SIZE, vec![1]);
        handler.queue_control_message(vec![2]);
        handler.on_unchoke_received();
        handler.peer_snubbing = true;

        assert!(handler.has_outstanding_requests());
        assert!(handler.has_pending_messages());

        handler.clear();

        assert!(!handler.has_outstanding_requests());
        assert!(!handler.has_pending_messages());
        assert!(!handler.is_peer_snubbing());
    }

    // ── Dispatcher access tests ─────────────────────────────────────────

    #[test]
    fn test_dispatcher_access() {
        let mut handler = BtPeerMessageHandler::new(BLOCK_SIZE);

        // Read-only access
        assert_eq!(handler.dispatcher().count_request_slots(), 0);

        // Mutable access
        handler.dispatcher_mut().add_request_slot(5, 0, BLOCK_SIZE);
        assert_eq!(handler.count_outstanding_requests(), 1);
    }

    // ── Default max outstanding constant test ───────────────────────────

    #[test]
    fn test_default_max_outstanding_matches_cpp() {
        // C++ BtConstants.h: DEFAULT_MAX_OUTSTANDING_REQUEST = 6, UB = 256
        assert_eq!(DEFAULT_MAX_OUTSTANDING_REQUEST, 6);
        assert_eq!(UB_MAX_OUTSTANDING_REQUEST, 256);
    }
}