cachey 0.10.11

Read-through cache for object storage
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
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
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
mod common;

use std::{ops::Range, sync::Arc, time::Duration};

use bytes::{Bytes, BytesMut};
use cachey::{
    object_store::{BucketMetrics, DownloadError, Downloader, RequestConfig},
    service::{PAGE_SIZE, SlidingThroughput},
    types::{BucketName, BucketNameSet, ObjectKey},
};
use common::setup_rustfs;
use parking_lot::Mutex;

async fn upload_test_object(client: &aws_sdk_s3::Client, bucket: &str, key: &str, data: Bytes) {
    client
        .put_object()
        .bucket(bucket)
        .key(key)
        .body(data.into())
        .send()
        .await
        .expect("Failed to upload object");
}

fn make_downloader(client: aws_sdk_s3::Client, hedge_quantile: f64) -> Downloader {
    let throughput = Arc::new(Mutex::new(SlidingThroughput::default()));
    Downloader::new(client, hedge_quantile, throughput)
}

fn bucket_metrics(downloader: &Downloader, bucket: &BucketName) -> BucketMetrics {
    let mut found = None;
    downloader.observe_bucket_metrics(|name, metrics| {
        if name == bucket {
            found = Some(metrics.clone());
        }
    });
    found.expect("bucket metrics should be recorded")
}

#[tokio::test]
async fn test_download_full_object() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize + 100);
    for (i, byte) in test_data.iter_mut().enumerate() {
        *byte = (i % 256) as u8;
    }
    let test_data = test_data.freeze();
    let object_key = "test-object.txt";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Download a small range from the beginning
    let out = downloader
        .download(
            &buckets,
            key,
            &Range { start: 0, end: 100 },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, test_data.slice(0..100));
    assert_eq!(out.piece.object_size, test_data.len() as u64);
}

#[tokio::test]
async fn test_download_partial_range() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    // Create a large object to work with PAGE_SIZE
    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize + 1000);
    for (i, byte) in test_data.iter_mut().enumerate() {
        *byte = (i % 256) as u8;
    }
    let test_data = test_data.freeze();
    let object_key = "range-test.txt";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Download a partial range
    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 1000,
                end: 2000,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, test_data.slice(1000..2000));
    assert_eq!(out.piece.object_size, test_data.len() as u64);
}

#[tokio::test]
async fn test_download_no_such_key() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new("non-existent-key").unwrap();

    let result = downloader
        .download(
            &buckets,
            key,
            &Range { start: 0, end: 100 },
            &RequestConfig::default(),
        )
        .await;

    match result {
        Err(DownloadError::NoSuchKey) => {}
        other => panic!("Expected NoSuchKey error, got: {other:?}"),
    }
}

#[tokio::test]
async fn test_download_range_not_satisfied() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    // Create a small object
    let test_data = Bytes::from_static(&[42u8; 100]);
    let object_key = "test-short-object";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Try to download beyond the object size
    // This should succeed and return the available data
    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 0,
                end: 1000,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    // Should return the 100 bytes that exist
    assert_eq!(out.piece.data, test_data);
    assert_eq!(out.piece.object_size, 100);
}

#[tokio::test]
async fn test_download_page_sized_range_from_small_object() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    // Create a small object (100 bytes)
    let test_data = Bytes::from_static(&[42u8; 100]);
    let object_key = "small-object";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 0,
                end: PAGE_SIZE,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data.len(), 100);
    assert_eq!(out.piece.data, test_data);
    assert_eq!(out.piece.object_size, 100);
}

#[tokio::test]
async fn test_download_with_fallback_bucket() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    // Create a second bucket for fallback
    let fallback_bucket_name = "fallback-bucket";
    ctx.client
        .create_bucket()
        .bucket(fallback_bucket_name)
        .send()
        .await
        .expect("Failed to create fallback bucket");

    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize + 200);
    test_data.fill(99u8);
    let test_data = test_data.freeze();
    let object_key = "fallback-object.txt";

    // Upload object only to fallback bucket
    upload_test_object(
        &ctx.client,
        fallback_bucket_name,
        object_key,
        test_data.clone(),
    )
    .await;

    let primary_bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let fallback_bucket = BucketName::new(fallback_bucket_name).unwrap();
    let buckets =
        BucketNameSet::new([primary_bucket.clone(), fallback_bucket.clone()].into_iter()).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Should fail on primary bucket and succeed on fallback
    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 0,
                end: test_data.len() as u64,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, test_data);
    assert_eq!(out.used_bucket_idx, 1);
}

#[tokio::test]
async fn test_fallback_bucket_circuit_breaker_recovers_for_new_primary_failures() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let fallback_bucket_name = "recovery-fallback-bucket";
    ctx.client
        .create_bucket()
        .bucket(fallback_bucket_name)
        .send()
        .await
        .expect("Failed to create fallback bucket");

    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize + 200);
    test_data.fill(17u8);
    let test_data = test_data.freeze();
    let object_key = "recovery-fallback-object.txt";
    upload_test_object(
        &ctx.client,
        fallback_bucket_name,
        object_key,
        test_data.clone(),
    )
    .await;

    let primary_bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let fallback_bucket = BucketName::new(fallback_bucket_name).unwrap();
    let all_buckets =
        BucketNameSet::new([primary_bucket.clone(), fallback_bucket.clone()].into_iter()).unwrap();
    let primary_only = BucketNameSet::new(std::iter::once(primary_bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();
    let range = Range {
        start: 0,
        end: test_data.len() as u64,
    };

    let mut circuit_breaker_open = false;
    for _ in 0..10 {
        let result = downloader
            .download(
                &primary_only,
                key.clone(),
                &range,
                &RequestConfig::default(),
            )
            .await;
        assert!(matches!(result, Err(DownloadError::NoSuchKey)));
        if bucket_metrics(&downloader, &primary_bucket).circuit_breaker_open {
            circuit_breaker_open = true;
            break;
        }
    }
    assert!(
        circuit_breaker_open,
        "primary bucket circuit breaker should open after repeated failures"
    );

    let open_order = downloader
        .download(&all_buckets, key.clone(), &range, &RequestConfig::default())
        .await
        .unwrap();
    assert_eq!(open_order.primary_bucket_idx, 1);
    assert_eq!(open_order.secondary_bucket_idx, Some(0));
    assert_eq!(open_order.used_bucket_idx, 1);

    tokio::time::pause();
    tokio::time::advance(Duration::from_secs(31)).await;

    let recovered_metrics = bucket_metrics(&downloader, &primary_bucket);
    assert!(!recovered_metrics.circuit_breaker_open);
    assert_eq!(recovered_metrics.consecutive_failures, 0);

    let primary_only_result = downloader
        .download(&primary_only, key, &range, &RequestConfig::default())
        .await;
    assert!(matches!(primary_only_result, Err(DownloadError::NoSuchKey)));

    let post_recovery_metrics = bucket_metrics(&downloader, &primary_bucket);
    assert_eq!(post_recovery_metrics.consecutive_failures, 1);
    assert!(!post_recovery_metrics.circuit_breaker_open);
}

#[tokio::test]
async fn test_download_multiple_ranges_same_object() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize);
    test_data.fill(123u8);
    let test_data = test_data.freeze();
    let object_key = "multi-range-object.txt";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Download multiple non-overlapping ranges
    let ranges = vec![
        Range { start: 0, end: 100 },
        Range {
            start: 100,
            end: 200,
        },
        Range {
            start: 500,
            end: 600,
        },
    ];

    for range in ranges {
        let out = downloader
            .download(&buckets, key.clone(), &range, &RequestConfig::default())
            .await
            .unwrap();

        let expected_data = test_data.slice(range.start as usize..range.end as usize);
        assert_eq!(out.piece.data, expected_data);
        assert_eq!(out.piece.object_size, test_data.len() as u64);
    }
}

#[tokio::test]
async fn test_download_with_hedged_requests() {
    let ctx = setup_rustfs().await;

    // Lower quantile for more aggressive hedging
    let downloader = make_downloader(ctx.client.clone(), 0.5);

    let mut test_data = BytesMut::zeroed(PAGE_SIZE as usize);
    test_data.fill(77u8);
    let test_data = test_data.freeze();
    let object_key = "hedge-test-object.txt";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Make multiple requests to build up latency statistics
    for _ in 0..10 {
        let out = downloader
            .download(
                &buckets,
                key.clone(),
                &Range {
                    start: 0,
                    end: test_data.len() as u64,
                },
                &RequestConfig::default(),
            )
            .await
            .unwrap();

        assert_eq!(out.piece.data, test_data.clone());
    }
}

#[tokio::test]
#[should_panic(expected = "assertion failed")]
async fn test_download_empty_range() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new("any-key").unwrap();

    let _ = downloader
        .download(
            &buckets,
            key,
            &Range { start: 10, end: 10 },
            &RequestConfig::default(),
        )
        .await;
}

#[tokio::test]
async fn test_download_last_byte() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let mut test_data = BytesMut::zeroed(1024);
    test_data.fill(88u8);
    let test_data = test_data.freeze();
    let object_key = "last-byte-object.bin";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    // Download just the last byte
    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 1023,
                end: 1024,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, Bytes::from_static(&[88u8]));
    assert_eq!(out.piece.object_size, 1024);
}

#[tokio::test]
async fn test_small_object_full_range() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let test_data = b"Hello, this is a small test object!";
    let object_key = "small-object.txt";
    upload_test_object(
        &ctx.client,
        &ctx.bucket_name,
        object_key,
        Bytes::from_static(test_data),
    )
    .await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 0,
                end: test_data.len() as u64,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, Bytes::from_static(test_data));
    assert_eq!(out.piece.object_size, test_data.len() as u64);
}

#[tokio::test]
async fn test_small_object_partial_range() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let test_data = b"0123456789abcdefghijklmnopqrstuvwxyz";
    let object_key = "small-range-object.txt";
    upload_test_object(
        &ctx.client,
        &ctx.bucket_name,
        object_key,
        Bytes::from_static(test_data),
    )
    .await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    let out = downloader
        .download(
            &buckets,
            key,
            &Range { start: 10, end: 20 },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data, Bytes::from(&test_data[10..20]));
    assert_eq!(out.piece.object_size, test_data.len() as u64);
}

#[tokio::test]
async fn test_1kb_object() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let mut test_data = BytesMut::zeroed(1024);
    test_data.fill(42u8);
    let test_data = test_data.freeze();
    let object_key = "1kb-object.bin";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 0,
                end: test_data.len() as u64,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data.len(), test_data.len());
    assert_eq!(out.piece.data, test_data);
    assert_eq!(out.piece.object_size, 1024);
}

#[tokio::test]
async fn test_100kb_object_partial_range() {
    let ctx = setup_rustfs().await;
    let downloader = make_downloader(ctx.client.clone(), 0.9);

    let mut test_data = BytesMut::zeroed(100 * 1024);
    test_data.fill(99u8);
    let test_data = test_data.freeze();
    let object_key = "100kb-object.bin";
    upload_test_object(&ctx.client, &ctx.bucket_name, object_key, test_data.clone()).await;

    let bucket = BucketName::new(&ctx.bucket_name).unwrap();
    let buckets = BucketNameSet::new(std::iter::once(bucket.clone())).unwrap();
    let key = ObjectKey::new(object_key).unwrap();

    let out = downloader
        .download(
            &buckets,
            key,
            &Range {
                start: 50000,
                end: 60000,
            },
            &RequestConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(out.piece.data.len(), 10000);
    assert_eq!(out.piece.data, test_data.slice(50000..60000));
    assert_eq!(out.piece.object_size, test_data.len() as u64);
}