mx-cache 0.1.0

Shared cache utilities (local + Redis) for MultiversX Rust services.
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

/// Minimal Redis set helper with TTL and basic bounding.
#[derive(Clone)]
pub struct RedisSet {
    manager: redis::aio::ConnectionManager,
    key: String,
    ttl_seconds: usize,
}

impl RedisSet {
    pub async fn new(url: &str, key: &str, ttl_seconds: u64) -> anyhow::Result<Self> {
        Self::new_with_name(url, key, ttl_seconds, None).await
    }

    pub async fn new_with_name(
        url: &str,
        key: &str,
        ttl_seconds: u64,
        connection_name: Option<&str>,
    ) -> anyhow::Result<Self> {
        let client = redis::Client::open(url)?;
        let mut manager = client.get_connection_manager().await?;

        // Set connection name if provided
        if let Some(name) = connection_name {
            redis::cmd("CLIENT")
                .arg("SETNAME")
                .arg(name)
                .query_async::<()>(&mut manager)
                .await?;
        }

        Ok(Self {
            manager,
            key: key.to_owned(),
            ttl_seconds: ttl_seconds as usize,
        })
    }

    /// Creates a new `RedisSet` connected via Sentinel.
    pub async fn new_sentinel(
        sentinel_urls: &[&str],
        master_name: &str,
        key: &str,
        ttl_seconds: u64,
        connection_name: Option<&str>,
    ) -> anyhow::Result<Self> {
        use redis::sentinel::Sentinel;

        let mut sentinel = Sentinel::build(sentinel_urls.to_vec())?;
        let client = sentinel.async_master_for(master_name, None).await?;
        let mut manager = client.get_connection_manager().await?;

        if let Some(name) = connection_name {
            redis::cmd("CLIENT")
                .arg("SETNAME")
                .arg(name)
                .query_async::<()>(&mut manager)
                .await?;
        }

        Ok(Self {
            manager,
            key: key.to_owned(),
            ttl_seconds: ttl_seconds as usize,
        })
    }

    /// Adds items to the set and refreshes TTL.
    pub async fn add_items(&self, items: &[String]) -> anyhow::Result<()> {
        if items.is_empty() {
            return Ok(());
        }
        let mut conn = self.manager.clone();
        let mut pipe = redis::pipe();
        for item in items {
            pipe.cmd("SADD").arg(&self.key).arg(item);
        }
        pipe.cmd("EXPIRE").arg(&self.key).arg(self.ttl_seconds);
        pipe.query_async::<()>(&mut conn).await?;
        Ok(())
    }

    /// Removes items from the set.
    pub async fn remove_items(&self, items: &[String]) -> anyhow::Result<()> {
        if items.is_empty() {
            return Ok(());
        }
        let mut conn = self.manager.clone();
        let mut pipe = redis::pipe();
        for item in items {
            pipe.cmd("SREM").arg(&self.key).arg(item);
        }
        pipe.query_async::<()>(&mut conn).await?;
        Ok(())
    }

    /// Single item add.
    pub async fn add_item(&self, item: &str) -> anyhow::Result<()> {
        self.add_items(&[item.to_owned()]).await
    }

    /// Single item remove.
    pub async fn remove_item(&self, item: &str) -> anyhow::Result<()> {
        self.remove_items(&[item.to_owned()]).await
    }

    /// Returns all items in the set.
    pub async fn load_items(&self) -> anyhow::Result<Vec<String>> {
        let mut conn = self.manager.clone();
        let entries: Vec<String> = redis::cmd("SMEMBERS")
            .arg(&self.key)
            .query_async(&mut conn)
            .await?;
        Ok(entries)
    }

    /// Trims the set down to `max_entries` by popping arbitrary entries when necessary.
    pub async fn trim_to(&self, max_entries: usize) -> anyhow::Result<()> {
        if max_entries == 0 {
            return Ok(());
        }
        let mut conn = self.manager.clone();
        let count: usize = redis::cmd("SCARD")
            .arg(&self.key)
            .query_async(&mut conn)
            .await?;
        if count > max_entries {
            let excess = count - max_entries;
            let _: () = redis::cmd("SPOP")
                .arg(&self.key)
                .arg(excess)
                .query_async(&mut conn)
                .await?;
        }
        Ok(())
    }
}