xet-data 1.5.2

Data processing pipeline for chunking, deduplication, and file reconstruction; used in the Hugging Face Xet client tools. Intended to be used through the API in the hf-xet package.
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
#[cfg(test)]
mod tests {
    use std::fs;
    use std::sync::Arc;
    use std::time::Duration;

    use xet_data::processing::test_utils::TestEnvironment;
    use xet_data::processing::{FileDownloadSession, FileUploadSession, Sha256Policy, XetFileInfo};

    async fn upload_bytes(upload_session: &Arc<FileUploadSession>, name: &str, data: &[u8]) -> XetFileInfo {
        let (_id, mut cleaner) = upload_session
            .start_clean(Some(name.into()), Some(data.len() as u64), Sha256Policy::Compute)
            .unwrap();
        cleaner.add_data(data).await.unwrap();
        let (xfi, _metrics) = cleaner.finish().await.unwrap();
        xfi
    }

    fn reassemble(chunks: Vec<(u64, bytes::Bytes)>, expected_len: usize) -> Vec<u8> {
        let mut buf = vec![0u8; expected_len];
        for (offset, data) in chunks {
            buf[offset as usize..offset as usize + data.len()].copy_from_slice(&data);
        }
        buf
    }

    /// Helper: uploads all test cases in one session, finalizes, then returns (env, download_session, xfis).
    async fn setup_various_sizes()
    -> (TestEnvironment, Arc<FileDownloadSession>, Vec<(&'static str, Vec<u8>, XetFileInfo)>) {
        let env = TestEnvironment::new().await;

        let test_cases: Vec<(&str, Vec<u8>)> = vec![
            ("one_byte", vec![0x42]),
            ("small", b"hello world".to_vec()),
            ("medium", vec![0xAB; 4096]),
            ("larger", vec![0xCD; 64 * 1024]),
        ];

        let upload_session = FileUploadSession::new(env.config.clone()).await.unwrap();
        let mut xfis = Vec::new();
        for (name, data) in test_cases {
            let xfi = upload_bytes(&upload_session, name, &data).await;
            xfis.push((name, data, xfi));
        }
        upload_session.finalize().await.unwrap();

        let download_session = FileDownloadSession::new(env.config.clone(), None).await.unwrap();
        (env, download_session, xfis)
    }

    /// Helper: uploads a single payload, finalizes, returns (env, download_session, xfi).
    async fn setup_single(name: &str, data: &[u8]) -> (TestEnvironment, Arc<FileDownloadSession>, XetFileInfo) {
        let env = TestEnvironment::new().await;
        let upload_session = FileUploadSession::new(env.config.clone()).await.unwrap();
        let xfi = upload_bytes(&upload_session, name, data).await;
        upload_session.finalize().await.unwrap();
        let download_session = FileDownloadSession::new(env.config.clone(), None).await.unwrap();
        (env, download_session, xfi)
    }

    /// Helper: uploads two payloads, finalizes, returns (env, download_session, xfi_a, xfi_b).
    async fn setup_two(
        name_a: &str,
        data_a: &[u8],
        name_b: &str,
        data_b: &[u8],
    ) -> (TestEnvironment, Arc<FileDownloadSession>, XetFileInfo, XetFileInfo) {
        let env = TestEnvironment::new().await;
        let upload_session = FileUploadSession::new(env.config.clone()).await.unwrap();
        let xfi_a = upload_bytes(&upload_session, name_a, data_a).await;
        let xfi_b = upload_bytes(&upload_session, name_b, data_b).await;
        upload_session.finalize().await.unwrap();
        let download_session = FileDownloadSession::new(env.config.clone(), None).await.unwrap();
        (env, download_session, xfi_a, xfi_b)
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_async_various_sizes() {
        let (_env, download_session, xfis) = setup_various_sizes().await;

        for (name, data, xfi) in &xfis {
            let (_id, mut stream) = download_session.download_unordered_stream(xfi, None).await.unwrap();

            let mut chunks = Vec::new();
            while let Some((offset, chunk)) = stream.next().await.unwrap() {
                chunks.push((offset, chunk));
            }

            let assembled = reassemble(chunks, data.len());
            assert_eq!(assembled, *data, "content mismatch for {name}");
            assert!(stream.is_complete());
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_blocking_various_sizes() {
        let (_env, download_session, xfis) = setup_various_sizes().await;

        for (name, data, xfi) in &xfis {
            let (_id, stream) = download_session.download_unordered_stream(xfi, None).await.unwrap();

            let expected_data = data.clone();
            let collected = tokio::task::spawn_blocking(move || {
                let mut stream = stream;
                let mut chunks = Vec::new();
                while let Some((offset, chunk)) = stream.blocking_next().unwrap() {
                    chunks.push((offset, chunk));
                }
                reassemble(chunks, expected_data.len())
            })
            .await
            .unwrap();

            assert_eq!(collected, *data, "content mismatch for {name}");
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_reassemble_to_file() {
        let (env, download_session, xfi) = setup_single("file_to_disk", &vec![0xEF; 64 * 1024]).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        let mut chunks = Vec::new();
        while let Some((offset, chunk)) = stream.next().await.unwrap() {
            chunks.push((offset, chunk));
        }

        let original_data = vec![0xEF; 64 * 1024];
        let assembled = reassemble(chunks, original_data.len());
        let out_path = env.base_dir.join("reassembled.bin");
        fs::write(&out_path, &assembled).unwrap();
        assert_eq!(fs::read(&out_path).unwrap(), original_data);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_total_bytes_expected() {
        let original_data = b"total bytes tracking test";
        let (_env, download_session, xfi) = setup_single("tracking", original_data).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        assert_eq!(stream.total_bytes_expected(), original_data.len() as u64);

        while stream.next().await.unwrap().is_some() {}

        assert!(stream.is_complete());
        assert_eq!(stream.bytes_completed(), original_data.len() as u64);
        assert_eq!(stream.bytes_in_progress(), 0);
        assert_eq!(stream.terms_in_progress(), 0);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_is_complete_loop_drains_all_data() {
        let original_data: Vec<u8> = (0..131072u32).map(|i| (i % 251) as u8).collect();
        let (_env, download_session, xfi) = setup_single("is_complete_loop", &original_data).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        let mut chunks = Vec::new();
        while !stream.is_complete() {
            if let Some((offset, chunk)) = stream.next().await.unwrap() {
                chunks.push((offset, chunk));
                tokio::time::sleep(Duration::from_millis(1)).await;
            }
        }

        let assembled = reassemble(chunks, original_data.len());
        assert_eq!(assembled, original_data);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_next_returns_none_after_complete() {
        let original_data = b"extra none calls";
        let (_env, download_session, xfi) = setup_single("none_test", original_data).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        while stream.next().await.unwrap().is_some() {}

        assert!(stream.next().await.unwrap().is_none());
        assert!(stream.next().await.unwrap().is_none());
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_cancel_before_start() {
        let original_data = b"cancel before start";
        let (_env, download_session, xfi) = setup_single("cancel_pre", original_data).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        stream.cancel();
        assert!(stream.next().await.unwrap().is_none());
        assert!(stream.next().await.unwrap().is_none());
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_cancel_after_partial_read() {
        let original_data = b"cancel after partial read test data";
        let (_env, download_session, xfi) = setup_single("cancel_mid", original_data).await;

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();

        let _ = stream.next().await.unwrap();
        stream.cancel();
        assert!(stream.next().await.unwrap().is_none());

        let (_id2, mut stream2) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
        let mut chunks = Vec::new();
        while let Some((offset, chunk)) = stream2.next().await.unwrap() {
            chunks.push((offset, chunk));
        }
        let assembled = reassemble(chunks, original_data.len());
        assert_eq!(assembled, original_data);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_multiple_concurrent() {
        let data_a = b"Unordered stream A for concurrent download";
        let data_b = b"Unordered stream B for concurrent download - different content";
        let (_env, download_session, xfi_a, xfi_b) = setup_two("concurrent_a", data_a, "concurrent_b", data_b).await;

        let (_id_a, mut stream_a) = download_session.download_unordered_stream(&xfi_a, None).await.unwrap();
        let (_id_b, mut stream_b) = download_session.download_unordered_stream(&xfi_b, None).await.unwrap();

        let len_a = data_a.len();
        let task_a = tokio::spawn(async move {
            let mut chunks = Vec::new();
            while let Some((offset, chunk)) = stream_a.next().await.unwrap() {
                chunks.push((offset, chunk));
            }
            reassemble(chunks, len_a)
        });

        let len_b = data_b.len();
        let task_b = tokio::spawn(async move {
            let mut chunks = Vec::new();
            while let Some((offset, chunk)) = stream_b.next().await.unwrap() {
                chunks.push((offset, chunk));
            }
            reassemble(chunks, len_b)
        });

        let result_a = task_a.await.unwrap();
        let result_b = task_b.await.unwrap();

        assert_eq!(result_a, data_a);
        assert_eq!(result_b, data_b);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_drop_without_reading() {
        let original_data = b"drop without reading cleanup test";
        let (env, download_session, xfi) = setup_single("drop_test", original_data).await;

        let (_id, stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
        drop(stream);
        tokio::task::yield_now().await;

        let out_path = env.base_dir.join("after_drop.txt");
        let (_id2, n_bytes) = download_session.download_file(&xfi, &out_path).await.unwrap();
        assert_eq!(n_bytes, original_data.len() as u64);
        assert_eq!(fs::read(&out_path).unwrap(), original_data);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn test_unordered_stream_matches_sequential_download() {
        let original_data: Vec<u8> = (0..=255u8).cycle().take(32 * 1024).collect();
        let (env, download_session, xfi) = setup_single("compare_test", &original_data).await;

        let out_path = env.base_dir.join("sequential.bin");
        let (_id, _) = download_session.download_file(&xfi, &out_path).await.unwrap();
        let sequential_result = fs::read(&out_path).unwrap();

        let (_id2, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
        let mut chunks = Vec::new();
        while let Some((offset, chunk)) = stream.next().await.unwrap() {
            chunks.push((offset, chunk));
        }
        let unordered_result = reassemble(chunks, original_data.len());

        assert_eq!(sequential_result, unordered_result);
        assert_eq!(sequential_result, original_data);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_repeated_blocking_downloads() {
        let original_data: Vec<u8> = (0..65536u32).map(|i| (i % 251) as u8).collect();
        let (_env, download_session, xfi) = setup_single("stress_blocking", &original_data).await;

        for _ in 0..30 {
            let (_id, stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let expected_len = original_data.len();
            let result = tokio::task::spawn_blocking(move || {
                let mut stream = stream;
                let mut chunks = Vec::new();
                while let Some((offset, chunk)) = stream.blocking_next().unwrap() {
                    chunks.push((offset, chunk));
                }
                reassemble(chunks, expected_len)
            })
            .await
            .unwrap();
            assert_eq!(result, original_data);
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_repeated_async_downloads() {
        let original_data: Vec<u8> = (0..65536u32).map(|i| (i % 251) as u8).collect();
        let (_env, download_session, xfi) = setup_single("stress_async", &original_data).await;

        for _ in 0..30 {
            let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let mut chunks = Vec::new();
            while let Some((offset, chunk)) = stream.next().await.unwrap() {
                chunks.push((offset, chunk));
            }
            let result = reassemble(chunks, original_data.len());
            assert_eq!(result, original_data);
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_concurrent_blocking_downloads() {
        let original_data: Vec<u8> = (0..65536u32).map(|i| (i % 251) as u8).collect();
        let (_env, download_session, xfi) = setup_single("stress_concurrent", &original_data).await;

        let mut handles = Vec::new();
        for _ in 0..8 {
            let (_id, stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let expected_len = original_data.len();
            handles.push(tokio::task::spawn_blocking(move || {
                let mut stream = stream;
                let mut chunks = Vec::new();
                while let Some((offset, chunk)) = stream.blocking_next().unwrap() {
                    chunks.push((offset, chunk));
                }
                reassemble(chunks, expected_len)
            }));
        }

        for handle in handles {
            let result = handle.await.unwrap();
            assert_eq!(result, original_data);
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_large_file_download() {
        let original_data: Vec<u8> = (0..262144u32)
            .map(|i| ((i.wrapping_mul(7919) ^ (i >> 3)) % 256) as u8)
            .collect();
        let (_env, download_session, xfi) = setup_single("stress_large", &original_data).await;

        {
            let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let mut chunks = Vec::new();
            while let Some((offset, chunk)) = stream.next().await.unwrap() {
                chunks.push((offset, chunk));
            }
            assert_eq!(reassemble(chunks, original_data.len()), original_data);
        }

        {
            let (_id, stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let expected_len = original_data.len();
            let expected_data = original_data.clone();
            let result = tokio::task::spawn_blocking(move || {
                let mut stream = stream;
                let mut chunks = Vec::new();
                while let Some((offset, chunk)) = stream.blocking_next().unwrap() {
                    chunks.push((offset, chunk));
                }
                reassemble(chunks, expected_len)
            })
            .await
            .unwrap();
            assert_eq!(result, expected_data);
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_mixed_concurrent_async_and_blocking() {
        let original_data: Vec<u8> = (0..65536u32).map(|i| (i % 251) as u8).collect();
        let (_env, download_session, xfi) = setup_single("stress_mixed", &original_data).await;

        let mut handles: Vec<tokio::task::JoinHandle<Vec<u8>>> = Vec::new();

        for i in 0..8 {
            if i % 2 == 0 {
                let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
                let expected_len = original_data.len();
                handles.push(tokio::spawn(async move {
                    let mut chunks = Vec::new();
                    while let Some((offset, chunk)) = stream.next().await.unwrap() {
                        chunks.push((offset, chunk));
                    }
                    reassemble(chunks, expected_len)
                }));
            } else {
                let (_id, stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
                let expected_len = original_data.len();
                handles.push(tokio::task::spawn_blocking(move || {
                    let mut stream = stream;
                    let mut chunks = Vec::new();
                    while let Some((offset, chunk)) = stream.blocking_next().unwrap() {
                        chunks.push((offset, chunk));
                    }
                    reassemble(chunks, expected_len)
                }));
            }
        }

        for handle in handles {
            let result = handle.await.unwrap();
            assert_eq!(result, original_data);
        }
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
    async fn stress_test_rapid_create_and_drop() {
        let original_data: Vec<u8> = (0..32768u32).map(|i| (i % 199) as u8).collect();
        let (_env, download_session, xfi) = setup_single("stress_drop", &original_data).await;

        for _ in 0..20 {
            let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
            let _ = stream.next().await;
            drop(stream);
        }

        let (_id, mut stream) = download_session.download_unordered_stream(&xfi, None).await.unwrap();
        let mut chunks = Vec::new();
        while let Some((offset, chunk)) = stream.next().await.unwrap() {
            chunks.push((offset, chunk));
        }
        assert_eq!(reassemble(chunks, original_data.len()), original_data);
    }
}