uselesskey-core-cache 0.7.1

Identity-keyed typed cache primitives for uselesskey fixture factories.
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
//! Performance and correctness tests for `ArtifactCache`.
//!
//! Focuses on cache-hit efficiency, scalability under load,
//! correct key differentiation across all identity tuple fields,
//! and concurrent access safety.

#![cfg(feature = "std")]

use std::sync::{Arc, Barrier};
use std::thread;
use std::time::Instant;

use uselesskey_core_cache::ArtifactCache;
use uselesskey_core_id::{ArtifactId, DerivationVersion};

fn make_id(domain: &'static str, label: &str, spec: &[u8], variant: &str) -> ArtifactId {
    ArtifactId::new(domain, label, spec, variant, DerivationVersion::V1)
}

fn simple_id(label: &str) -> ArtifactId {
    make_id("domain:test", label, b"spec", "good")
}

// ── 1. Cache hits return the exact same Arc (pointer equality) ──────

#[test]
fn cache_hit_returns_identical_arc_pointer() {
    let cache = ArtifactCache::new();
    let id = simple_id("ptr-eq");

    let original = Arc::new(vec![1u8, 2, 3]);
    let inserted = cache.insert_if_absent_typed(id.clone(), Arc::clone(&original));

    // insert_if_absent returns the same Arc as the first insertion
    assert!(Arc::ptr_eq(&original, &inserted));

    // Subsequent insert with a *different* value still returns the original
    let duplicate = cache.insert_if_absent_typed(id.clone(), Arc::new(vec![9u8, 9, 9]));
    assert!(Arc::ptr_eq(&original, &duplicate));

    // get_typed also returns the same pointer
    let fetched = cache.get_typed::<Vec<u8>>(&id).unwrap();
    assert!(Arc::ptr_eq(&original, &fetched));

    // Repeated get_typed calls all return the same pointer
    for _ in 0..50 {
        let again = cache.get_typed::<Vec<u8>>(&id).unwrap();
        assert!(Arc::ptr_eq(&original, &again));
    }
}

// ── 2. Repeated access is near-zero cost after first generation ─────

#[test]
fn repeated_cache_hits_are_fast() {
    let cache = ArtifactCache::new();
    let id = simple_id("perf-hit");

    // Simulate "first generation" by inserting a heavyweight value
    let big_value = Arc::new(vec![0u8; 64 * 1024]); // 64 KiB
    cache.insert_if_absent_typed(id.clone(), big_value);

    // Now measure 100 consecutive cache hits
    let start = Instant::now();
    for _ in 0..100 {
        let val = cache.get_typed::<Vec<u8>>(&id).unwrap();
        assert_eq!(val.len(), 64 * 1024);
    }
    let elapsed = start.elapsed();

    // 100 lookups should complete well under 50ms on any reasonable hardware.
    // This threshold is deliberately generous to avoid flaky CI.
    assert!(
        elapsed.as_millis() < 50,
        "100 cache hits took {elapsed:?}, expected < 50ms"
    );
}

#[test]
fn insert_if_absent_skips_allocation_on_hit() {
    let cache = ArtifactCache::new();
    let id = simple_id("alloc-skip");

    let first = cache.insert_if_absent_typed(id.clone(), Arc::new(42u64));

    // Measure 100 redundant inserts (all should be no-ops)
    let start = Instant::now();
    for i in 0..100 {
        let winner = cache.insert_if_absent_typed(id.clone(), Arc::new(i as u64));
        assert_eq!(*winner, 42u64);
    }
    let elapsed = start.elapsed();

    assert!(
        elapsed.as_millis() < 50,
        "100 redundant inserts took {elapsed:?}, expected < 50ms"
    );

    // Only one entry in the cache
    assert_eq!(cache.len(), 1);
    assert!(Arc::ptr_eq(&first, &cache.get_typed::<u64>(&id).unwrap()));
}

// ── 3. Many different labels (1000+) doesn't OOM or degrade ─────────

#[test]
fn cache_scales_to_many_entries_without_degradation() {
    let cache = ArtifactCache::new();
    let count = 2_000;

    // Insert 2000 entries
    let insert_start = Instant::now();
    for i in 0..count {
        let id = simple_id(&format!("scale-{i}"));
        cache.insert_if_absent_typed(id, Arc::new(i as u64));
    }
    let insert_elapsed = insert_start.elapsed();

    assert_eq!(cache.len(), count);

    // Read all 2000 back and verify correctness
    let read_start = Instant::now();
    for i in 0..count {
        let id = simple_id(&format!("scale-{i}"));
        let val = cache.get_typed::<u64>(&id).expect("entry must exist");
        assert_eq!(*val, i as u64);
    }
    let read_elapsed = read_start.elapsed();

    // Generous bounds: 2000 inserts and 2000 reads should each be < 2s
    assert!(
        insert_elapsed.as_secs() < 2,
        "2000 inserts took {insert_elapsed:?}"
    );
    assert!(
        read_elapsed.as_secs() < 2,
        "2000 reads took {read_elapsed:?}"
    );
}

#[test]
fn cache_with_1000_labels_all_retrievable() {
    let cache = ArtifactCache::new();

    for i in 0..1_000 {
        let id = simple_id(&format!("label-{i}"));
        cache.insert_if_absent_typed(id, Arc::new(format!("value-{i}")));
    }

    assert_eq!(cache.len(), 1_000);

    // Spot-check a selection of entries
    for i in [0, 1, 42, 100, 499, 500, 999] {
        let id = simple_id(&format!("label-{i}"));
        let val = cache.get_typed::<String>(&id).unwrap();
        assert_eq!(*val, format!("value-{i}"));
    }
}

// ── 4. clear_cache properly empties all entries ─────────────────────

#[test]
fn clear_empties_all_entries_and_allows_reuse() {
    let cache = ArtifactCache::new();

    // Populate with diverse entries
    for i in 0..100 {
        let id = simple_id(&format!("clear-{i}"));
        cache.insert_if_absent_typed(id, Arc::new(i as u64));
    }
    assert_eq!(cache.len(), 100);
    assert!(!cache.is_empty());

    // Clear
    cache.clear();
    assert_eq!(cache.len(), 0);
    assert!(cache.is_empty());

    // Every key should now return None
    for i in 0..100 {
        let id = simple_id(&format!("clear-{i}"));
        assert!(
            cache.get_typed::<u64>(&id).is_none(),
            "key clear-{i} should be absent after clear"
        );
    }

    // Re-inserting after clear works and produces fresh entries
    let id = simple_id("clear-0");
    let new_val = cache.insert_if_absent_typed(id.clone(), Arc::new(999u64));
    assert_eq!(*new_val, 999);
    assert_eq!(cache.len(), 1);
}

#[test]
fn clear_then_reinsert_gives_new_arc() {
    let cache = ArtifactCache::new();
    let id = simple_id("clear-arc");

    let first = cache.insert_if_absent_typed(id.clone(), Arc::new(1u32));
    cache.clear();

    let second = cache.insert_if_absent_typed(id.clone(), Arc::new(2u32));

    // After clear, the new insertion produces a different Arc
    assert!(!Arc::ptr_eq(&first, &second));
    assert_eq!(*first, 1);
    assert_eq!(*second, 2);
}

// ── 5. Cache keys differentiated by (domain, label, spec, variant) ──

#[test]
fn keys_differ_by_domain() {
    let cache = ArtifactCache::new();
    let id_rsa = make_id("domain:rsa", "key", b"RS256", "good");
    let id_ec = make_id("domain:ecdsa", "key", b"RS256", "good");

    cache.insert_if_absent_typed(id_rsa.clone(), Arc::new(1u32));
    cache.insert_if_absent_typed(id_ec.clone(), Arc::new(2u32));

    assert_eq!(cache.len(), 2);
    assert_eq!(*cache.get_typed::<u32>(&id_rsa).unwrap(), 1);
    assert_eq!(*cache.get_typed::<u32>(&id_ec).unwrap(), 2);
}

#[test]
fn keys_differ_by_label() {
    let cache = ArtifactCache::new();
    let id_alice = make_id("domain:rsa", "alice", b"RS256", "good");
    let id_bob = make_id("domain:rsa", "bob", b"RS256", "good");

    cache.insert_if_absent_typed(id_alice.clone(), Arc::new(10u32));
    cache.insert_if_absent_typed(id_bob.clone(), Arc::new(20u32));

    assert_eq!(cache.len(), 2);
    assert_eq!(*cache.get_typed::<u32>(&id_alice).unwrap(), 10);
    assert_eq!(*cache.get_typed::<u32>(&id_bob).unwrap(), 20);
}

#[test]
fn keys_differ_by_spec() {
    let cache = ArtifactCache::new();
    let id_256 = make_id("domain:rsa", "issuer", b"RS256", "good");
    let id_384 = make_id("domain:rsa", "issuer", b"RS384", "good");

    cache.insert_if_absent_typed(id_256.clone(), Arc::new(100u32));
    cache.insert_if_absent_typed(id_384.clone(), Arc::new(200u32));

    assert_eq!(cache.len(), 2);
    assert_eq!(*cache.get_typed::<u32>(&id_256).unwrap(), 100);
    assert_eq!(*cache.get_typed::<u32>(&id_384).unwrap(), 200);
}

#[test]
fn keys_differ_by_variant() {
    let cache = ArtifactCache::new();
    let id_good = make_id("domain:rsa", "issuer", b"RS256", "good");
    let id_corrupt = make_id("domain:rsa", "issuer", b"RS256", "corrupt:v1");
    let id_mismatch = make_id("domain:rsa", "issuer", b"RS256", "mismatch");

    cache.insert_if_absent_typed(id_good.clone(), Arc::new(1u32));
    cache.insert_if_absent_typed(id_corrupt.clone(), Arc::new(2u32));
    cache.insert_if_absent_typed(id_mismatch.clone(), Arc::new(3u32));

    assert_eq!(cache.len(), 3);
    assert_eq!(*cache.get_typed::<u32>(&id_good).unwrap(), 1);
    assert_eq!(*cache.get_typed::<u32>(&id_corrupt).unwrap(), 2);
    assert_eq!(*cache.get_typed::<u32>(&id_mismatch).unwrap(), 3);
}

#[test]
fn keys_differ_by_derivation_version() {
    let cache = ArtifactCache::new();
    let id_v1 = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"RS256",
        "good",
        DerivationVersion::V1,
    );
    let id_v2 = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"RS256",
        "good",
        DerivationVersion(2),
    );

    cache.insert_if_absent_typed(id_v1.clone(), Arc::new(10u32));
    cache.insert_if_absent_typed(id_v2.clone(), Arc::new(20u32));

    assert_eq!(cache.len(), 2);
    assert_eq!(*cache.get_typed::<u32>(&id_v1).unwrap(), 10);
    assert_eq!(*cache.get_typed::<u32>(&id_v2).unwrap(), 20);
}

#[test]
fn identical_tuple_maps_to_same_entry() {
    let cache = ArtifactCache::new();

    // Two independently constructed IDs with the same tuple
    let id1 = make_id("domain:rsa", "issuer", b"RS256", "good");
    let id2 = make_id("domain:rsa", "issuer", b"RS256", "good");

    let first = cache.insert_if_absent_typed(id1, Arc::new(42u32));
    let second = cache.insert_if_absent_typed(id2, Arc::new(99u32));

    assert!(Arc::ptr_eq(&first, &second));
    assert_eq!(*second, 42);
    assert_eq!(cache.len(), 1);
}

#[test]
fn all_five_fields_contribute_to_key_identity() {
    let cache = ArtifactCache::new();

    // Base ID
    let base = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"RS256",
        "good",
        DerivationVersion::V1,
    );
    cache.insert_if_absent_typed(base.clone(), Arc::new(0u32));

    // Vary each field independently; each must produce a separate cache entry
    let vary_domain = ArtifactId::new(
        "domain:ec",
        "issuer",
        b"RS256",
        "good",
        DerivationVersion::V1,
    );
    let vary_label = ArtifactId::new(
        "domain:rsa",
        "other",
        b"RS256",
        "good",
        DerivationVersion::V1,
    );
    let vary_spec = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"ES256",
        "good",
        DerivationVersion::V1,
    );
    let vary_variant = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"RS256",
        "bad",
        DerivationVersion::V1,
    );
    let vary_version = ArtifactId::new(
        "domain:rsa",
        "issuer",
        b"RS256",
        "good",
        DerivationVersion(2),
    );

    for (i, id) in [
        vary_domain,
        vary_label,
        vary_spec,
        vary_variant,
        vary_version,
    ]
    .into_iter()
    .enumerate()
    {
        cache.insert_if_absent_typed(id, Arc::new((i as u32) + 1));
    }

    // base + 5 variations = 6 entries
    assert_eq!(cache.len(), 6);

    // Verify each has its own value
    assert_eq!(*cache.get_typed::<u32>(&base).unwrap(), 0);
}

// ── 6. Concurrent access from 8+ threads ────────────────────────────

#[test]
fn concurrent_writes_from_many_threads_all_succeed() {
    let cache = Arc::new(ArtifactCache::new());
    let num_threads = 16;
    let keys_per_thread = 50;
    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|t| {
            let cache = Arc::clone(&cache);
            let barrier = Arc::clone(&barrier);
            thread::spawn(move || {
                barrier.wait();
                for k in 0..keys_per_thread {
                    let id = simple_id(&format!("t{t}-k{k}"));
                    let val =
                        cache.insert_if_absent_typed(id.clone(), Arc::new((t * 100 + k) as u64));
                    assert_eq!(*val, (t * 100 + k) as u64);
                }
            })
        })
        .collect();

    for h in handles {
        h.join().expect("thread panicked");
    }

    assert_eq!(cache.len(), num_threads * keys_per_thread);
}

#[test]
fn concurrent_mixed_reads_and_writes_no_panic() {
    let cache = Arc::new(ArtifactCache::new());
    let barrier = Arc::new(Barrier::new(12));

    // Pre-populate some shared keys
    for i in 0..20 {
        let id = simple_id(&format!("shared-{i}"));
        cache.insert_if_absent_typed(id, Arc::new(i as u64));
    }

    let handles: Vec<_> = (0..12)
        .map(|t| {
            let cache = Arc::clone(&cache);
            let barrier = Arc::clone(&barrier);
            thread::spawn(move || {
                barrier.wait();
                for round in 0..100 {
                    if t % 3 == 0 {
                        // Reader of shared keys
                        let id = simple_id(&format!("shared-{}", round % 20));
                        let val = cache.get_typed::<u64>(&id);
                        assert!(val.is_some());
                    } else if t % 3 == 1 {
                        // Writer of new keys
                        let id = simple_id(&format!("new-t{t}-r{round}"));
                        cache.insert_if_absent_typed(id, Arc::new(round as u64));
                    } else {
                        // Re-inserter of shared keys (tests insert_if_absent idempotency)
                        let id = simple_id(&format!("shared-{}", round % 20));
                        let val = cache.insert_if_absent_typed(id, Arc::new(999u64));
                        assert_eq!(*val, (round % 20) as u64);
                    }
                }
            })
        })
        .collect();

    for h in handles {
        h.join().expect("thread panicked");
    }

    // All shared keys still present
    for i in 0..20 {
        let id = simple_id(&format!("shared-{i}"));
        assert_eq!(*cache.get_typed::<u64>(&id).unwrap(), i as u64);
    }
}

#[test]
fn concurrent_insert_same_key_all_get_same_arc() {
    let cache = Arc::new(ArtifactCache::new());
    let id = simple_id("race-target");
    let barrier = Arc::new(Barrier::new(8));

    let handles: Vec<_> = (0..8)
        .map(|i| {
            let cache = Arc::clone(&cache);
            let id = id.clone();
            let barrier = Arc::clone(&barrier);
            thread::spawn(move || {
                barrier.wait();
                cache.insert_if_absent_typed(id, Arc::new(i as u64))
            })
        })
        .collect();

    let results: Vec<Arc<u64>> = handles.into_iter().map(|h| h.join().unwrap()).collect();

    // All threads must see the same Arc (pointer equality)
    for pair in results.windows(2) {
        assert!(Arc::ptr_eq(&pair[0], &pair[1]));
    }

    assert_eq!(cache.len(), 1);
}