hydracache 0.21.0

User-facing HydraCache runtime crate.
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

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::Duration;

use hydracache_core::CacheOptions;
use tokio::sync::oneshot;

use crate::tests::common::{user, LoaderError, User};
use crate::HydraCache;

#[tokio::test]
async fn invalidating_tag_during_load_discards_stale_store() {
    let cache = HydraCache::local().build();
    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let load_cache = cache.clone();

    let task = tokio::spawn(async move {
        load_cache
            .get_or_load(
                "user:stale",
                CacheOptions::new().tag("users"),
                move || async move {
                    started_tx.send(()).unwrap();
                    release_rx.await.unwrap();
                    Ok::<_, LoaderError>(user(1))
                },
            )
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    assert_eq!(cache.invalidate_tag("users").await.unwrap(), 0);
    release_tx.send(()).unwrap();

    assert_eq!(task.await.unwrap(), user(1));
    let cached: Option<User> = cache.get("user:stale").await.unwrap();
    assert_eq!(cached, None);
    assert_eq!(cache.stats().stale_load_discards, 1);
}

#[tokio::test]
async fn post_invalidation_caller_starts_fresh_load() {
    let cache = HydraCache::local().build();
    let calls = Arc::new(AtomicUsize::new(0));
    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let stale_cache = cache.clone();
    let stale_calls = calls.clone();

    let stale_task = tokio::spawn(async move {
        stale_cache
            .get_or_load(
                "user:race",
                CacheOptions::new().tag("users"),
                move || async move {
                    stale_calls.fetch_add(1, Ordering::SeqCst);
                    started_tx.send(()).unwrap();
                    release_rx.await.unwrap();
                    Ok::<_, LoaderError>(user(1))
                },
            )
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    assert_eq!(cache.invalidate_tag("users").await.unwrap(), 0);

    let fresh_calls = calls.clone();
    let fresh = cache
        .get_or_load(
            "user:race",
            CacheOptions::new().tag("users"),
            move || async move {
                fresh_calls.fetch_add(1, Ordering::SeqCst);
                Ok::<_, LoaderError>(user(2))
            },
        )
        .await
        .unwrap();

    release_tx.send(()).unwrap();

    assert_eq!(fresh, user(2));
    assert_eq!(stale_task.await.unwrap(), user(1));
    assert_eq!(calls.load(Ordering::SeqCst), 2);
    let cached: Option<User> = cache.get("user:race").await.unwrap();
    assert_eq!(cached, Some(user(2)));
}

#[tokio::test]
async fn flush_and_multi_tag_invalidation_discard_stale_loads() {
    let cache = HydraCache::local().build();
    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let load_cache = cache.clone();

    let task = tokio::spawn(async move {
        load_cache
            .get_or_load(
                "user:multi-tag",
                CacheOptions::new().tags(["users", "tenant:1"]),
                move || async move {
                    started_tx.send(()).unwrap();
                    release_rx.await.unwrap();
                    Ok::<_, LoaderError>(user(1))
                },
            )
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    assert_eq!(cache.invalidate_tag("tenant:1").await.unwrap(), 0);
    release_tx.send(()).unwrap();
    assert_eq!(task.await.unwrap(), user(1));

    let cached: Option<User> = cache.get("user:multi-tag").await.unwrap();
    assert_eq!(cached, None);

    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let flush_cache = cache.clone();
    let flush_task = tokio::spawn(async move {
        flush_cache
            .get_or_load(
                "user:flush",
                CacheOptions::new().tag("users"),
                move || async move {
                    started_tx.send(()).unwrap();
                    release_rx.await.unwrap();
                    Ok::<_, LoaderError>(user(2))
                },
            )
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    cache.flush().await.unwrap();
    release_tx.send(()).unwrap();
    assert_eq!(flush_task.await.unwrap(), user(2));
    let cached: Option<User> = cache.get("user:flush").await.unwrap();
    assert_eq!(cached, None);
}

#[tokio::test]
async fn untagged_load_is_not_guarded_by_tag_generation() {
    let cache = HydraCache::local().build();
    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let load_cache = cache.clone();

    let task = tokio::spawn(async move {
        load_cache
            .get_or_load("user:untagged", CacheOptions::new(), move || async move {
                started_tx.send(()).unwrap();
                release_rx.await.unwrap();
                Ok::<_, LoaderError>(user(1))
            })
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    assert_eq!(cache.invalidate_tag("users").await.unwrap(), 0);
    release_tx.send(()).unwrap();

    assert_eq!(task.await.unwrap(), user(1));
    let cached: Option<User> = cache.get("user:untagged").await.unwrap();
    assert_eq!(cached, Some(user(1)));
}

#[tokio::test]
async fn stale_load_does_not_overwrite_fresh_value() {
    let cache = HydraCache::local().build();
    let (started_tx, started_rx) = oneshot::channel();
    let (release_tx, release_rx) = oneshot::channel();
    let stale_cache = cache.clone();

    let stale_task = tokio::spawn(async move {
        stale_cache
            .get_or_load(
                "user:overwrite",
                CacheOptions::new().tag("users"),
                move || async move {
                    started_tx.send(()).unwrap();
                    release_rx.await.unwrap();
                    Ok::<_, LoaderError>(user(1))
                },
            )
            .await
            .unwrap()
    });

    started_rx.await.unwrap();
    assert_eq!(cache.invalidate_tag("users").await.unwrap(), 0);

    let fresh = cache
        .get_or_load(
            "user:overwrite",
            CacheOptions::new().tag("users"),
            || async { Ok::<_, LoaderError>(user(2)) },
        )
        .await
        .unwrap();

    release_tx.send(()).unwrap();
    assert_eq!(fresh, user(2));
    assert_eq!(stale_task.await.unwrap(), user(1));

    let cached: Option<User> = cache.get("user:overwrite").await.unwrap();
    assert_eq!(cached, Some(user(2)));
}

#[tokio::test]
async fn invalidation_without_in_flight_loader_does_not_increment_stale_discards() {
    let cache = HydraCache::local().build();

    cache
        .put("user:stats", user(1), CacheOptions::new().tag("users"))
        .await
        .unwrap();

    assert_eq!(cache.invalidate_tag("users").await.unwrap(), 1);

    let stats = cache.stats();
    assert_eq!(stats.invalidations, 1);
    assert_eq!(stats.stale_load_discards, 0);
}

#[tokio::test]
async fn per_entry_ttl_overrides_default_ttl() {
    let cache = HydraCache::local()
        .default_ttl(Duration::from_millis(20))
        .build();

    cache
        .put(
            "user:1",
            user(1),
            CacheOptions::new().ttl(Duration::from_millis(120)),
        )
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(50)).await;
    assert!(cache.contains_key("user:1").await);
}