autocache 0.4.0

automatic cache management
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

use std::collections::BTreeSet;

use tracing::warn;

use crate::{cache::Cache, entry::EntryTrait};

pub struct TwoLevelCache<K, V, L1, L2> {
    local_cache: L1,
    redis_cache: L2,

    _m1: std::marker::PhantomData<K>,
    _m2: std::marker::PhantomData<V>,
}

impl<K, V, L1, L2> TwoLevelCache<K, V, L1, L2> {
    pub fn new(l1: L1, l2: L2) -> Self {
        Self {
            local_cache: l1,
            redis_cache: l2,

            _m1: std::marker::PhantomData,
            _m2: std::marker::PhantomData,
        }
    }
}

impl<K, V, L1, L2> Cache for TwoLevelCache<K, V, L1, L2>
where
    K: Clone + Ord + Send + Sync,
    V: Clone + Send + Sync + EntryTrait<K>,
    L1: Cache<Key = K, Value = V> + Sync,
    L2: Cache<Key = K, Value = V> + Sync,
{
    type Key = K;
    type Value = V;

    async fn mget(&self, keys: &[Self::Key]) -> anyhow::Result<Vec<Self::Value>> {
        let mut l1_entries = self.local_cache.mget(keys).await?;
        let l1_hit_keys = l1_entries
            .iter()
            .filter(|entry| !entry.is_expired())
            .map(EntryTrait::get_key)
            .collect::<BTreeSet<_>>();
        let l1_missed_keys = keys
            .iter()
            .filter(|key| !l1_hit_keys.contains(*key))
            .cloned()
            .collect::<Vec<_>>();

        if l1_missed_keys.is_empty() {
            l1_entries.retain(|entry| !entry.is_expired());
            return Ok(l1_entries);
        }

        let mut l2_entries = match self.redis_cache.mget(&l1_missed_keys).await {
            Ok(entries) => entries,
            Err(error) => {
                warn!(
                    cache = self.redis_cache.name(),
                    missed_key_count = l1_missed_keys.len(),
                    error = %error,
                    "autocache: L2 cache read failed; falling back to available L1 entries"
                );
                return Ok(l1_entries);
            }
        };
        let fresh_l2_entries = l2_entries
            .iter()
            .filter(|entry| !entry.is_expired())
            .cloned()
            .map(|entry| (entry.get_key(), entry))
            .collect::<Vec<_>>();
        if !fresh_l2_entries.is_empty() {
            let _ = self
                .local_cache
                .mset(&fresh_l2_entries)
                .await
                .inspect_err(|error| {
                    warn!(
                        cache = self.local_cache.name(),
                        entry_count = fresh_l2_entries.len(),
                        error = %error,
                        "autocache: failed to warm L1 cache with L2 entries"
                    );
                });
        }

        let l2_hit_keys = l2_entries
            .iter()
            .map(EntryTrait::get_key)
            .collect::<BTreeSet<_>>();
        l1_entries.retain(|entry| !entry.is_expired() || !l2_hit_keys.contains(&entry.get_key()));

        l1_entries.append(&mut l2_entries);

        Ok(l1_entries)
    }

    async fn mset(&self, kvs: &[(Self::Key, Self::Value)]) -> anyhow::Result<()> {
        self.redis_cache.mset(kvs).await?;
        self.local_cache.mset(kvs).await?;

        Ok(())
    }

    async fn mdel(&self, keys: &[Self::Key]) -> anyhow::Result<()> {
        let l1_result = self.local_cache.mdel(keys).await;
        let l2_result = self.redis_cache.mdel(keys).await;

        l1_result?;
        l2_result?;

        Ok(())
    }

    fn name(&self) -> &'static str {
        "twolevelcache"
    }

    fn set_ns(&self, ns: String) {
        self.redis_cache.set_ns(ns);
    }
}