metabase-api-rs 0.1.0-beta.3

A simplified Rust client for the Metabase API (Beta release - feature complete)
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
//! CacheProvider implementation using in-memory LRU cache
//!
//! This module provides a production implementation of the CacheProvider trait
//! using an LRU (Least Recently Used) cache for in-memory storage when the
//! "cache" feature is enabled, and a simple HashMap-based implementation otherwise.

use super::cache_traits::{CacheKey, CacheProvider, CacheStats};
use async_trait::async_trait;
use serde::{de::DeserializeOwned, Serialize};
#[cfg(not(feature = "cache"))]
use std::collections::HashMap;
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};

/// Cache entry with expiration tracking
#[derive(Debug, Clone)]
struct CacheEntry {
    /// Serialized data
    data: Vec<u8>,
    /// Expiration time
    expires_at: Option<Instant>,
}

impl CacheEntry {
    /// Check if the entry is expired
    fn is_expired(&self) -> bool {
        self.expires_at
            .map(|expiry| Instant::now() > expiry)
            .unwrap_or(false)
    }
}

/// In-memory cache provider
///
/// Uses LRU cache when "cache" feature is enabled, otherwise uses a simple HashMap.
pub struct InMemoryCacheProvider {
    /// The actual cache storage
    #[cfg(feature = "cache")]
    cache: Arc<Mutex<lru::LruCache<String, CacheEntry>>>,
    #[cfg(not(feature = "cache"))]
    cache: Arc<Mutex<HashMap<String, CacheEntry>>>,
    /// Maximum cache size (for non-LRU implementation)
    #[cfg(not(feature = "cache"))]
    max_size: usize,
    /// Whether caching is enabled
    enabled: bool,
    /// Cache statistics
    stats: Arc<Mutex<CacheStats>>,
}

impl InMemoryCacheProvider {
    /// Create a new in-memory cache provider with specified capacity
    pub fn new(capacity: usize) -> Self {
        #[cfg(feature = "cache")]
        {
            use std::num::NonZeroUsize;
            let capacity = NonZeroUsize::new(capacity.max(1)).unwrap();
            Self {
                cache: Arc::new(Mutex::new(lru::LruCache::new(capacity))),
                enabled: true,
                stats: Arc::new(Mutex::new(CacheStats::default())),
            }
        }
        #[cfg(not(feature = "cache"))]
        {
            Self {
                cache: Arc::new(Mutex::new(HashMap::new())),
                max_size: capacity,
                enabled: true,
                stats: Arc::new(Mutex::new(CacheStats::default())),
            }
        }
    }

    /// Create a new cache provider with default capacity (1000 items)
    pub fn with_default_capacity() -> Self {
        Self::new(1000)
    }

    /// Update hit statistics
    fn record_hit(&self) {
        if let Ok(mut stats) = self.stats.lock() {
            stats.hits += 1;
        }
    }

    /// Update miss statistics
    fn record_miss(&self) {
        if let Ok(mut stats) = self.stats.lock() {
            stats.misses += 1;
        }
    }

    /// Update cache size statistics
    fn update_size(&self, size: usize) {
        if let Ok(mut stats) = self.stats.lock() {
            stats.size = size;
        }
    }

    /// Clean expired entries (for non-LRU implementation)
    #[cfg(not(feature = "cache"))]
    fn clean_expired(&self, cache: &mut HashMap<String, CacheEntry>) {
        cache.retain(|_, entry| !entry.is_expired());
    }

    /// Enforce size limit (for non-LRU implementation)
    #[cfg(not(feature = "cache"))]
    fn enforce_size_limit(&self, cache: &mut HashMap<String, CacheEntry>) {
        if cache.len() > self.max_size {
            // Simple eviction: remove oldest entries
            // In a real implementation, you'd track access times
            let to_remove = cache.len() - self.max_size;
            let keys: Vec<String> = cache.keys().take(to_remove).cloned().collect();
            for key in keys {
                cache.remove(&key);
            }
        }
    }
}

#[async_trait]
impl CacheProvider for InMemoryCacheProvider {
    async fn get<T>(&self, key: &impl CacheKey) -> Option<T>
    where
        T: DeserializeOwned + Send,
    {
        if !self.enabled {
            return None;
        }

        let key_str = key.to_string();

        let mut cache = self.cache.lock().ok()?;

        #[cfg(feature = "cache")]
        {
            // LRU cache implementation
            if let Some(entry) = cache.get(&key_str) {
                if entry.is_expired() {
                    cache.pop(&key_str);
                    self.record_miss();
                    self.update_size(cache.len());
                    return None;
                }

                // Deserialize the data
                if let Ok(value) = serde_json::from_slice(&entry.data) {
                    self.record_hit();
                    return Some(value);
                }
            }
        }

        #[cfg(not(feature = "cache"))]
        {
            // HashMap implementation
            if let Some(entry) = cache.get(&key_str) {
                if entry.is_expired() {
                    cache.remove(&key_str);
                    self.record_miss();
                    self.update_size(cache.len());
                    return None;
                }

                // Deserialize the data
                if let Ok(value) = serde_json::from_slice(&entry.data) {
                    self.record_hit();
                    return Some(value);
                }
            }
        }

        self.record_miss();
        None
    }

    async fn set<T>(&self, key: &impl CacheKey, value: &T, ttl: Option<Duration>) -> bool
    where
        T: Serialize + Send + Sync,
    {
        if !self.enabled {
            return false;
        }

        let key_str = key.to_string();

        // Serialize the value
        let data = match serde_json::to_vec(value) {
            Ok(data) => data,
            Err(_) => return false,
        };

        let expires_at = ttl.map(|duration| Instant::now() + duration);

        let entry = CacheEntry { data, expires_at };

        if let Ok(mut cache) = self.cache.lock() {
            #[cfg(feature = "cache")]
            {
                cache.put(key_str, entry);
                self.update_size(cache.len());
                return true;
            }

            #[cfg(not(feature = "cache"))]
            {
                self.clean_expired(&mut cache);
                cache.insert(key_str, entry);
                self.enforce_size_limit(&mut cache);
                self.update_size(cache.len());
                return true;
            }
        }

        false
    }

    async fn remove(&self, key: &impl CacheKey) -> bool {
        if !self.enabled {
            return false;
        }

        let key_str = key.to_string();

        if let Ok(mut cache) = self.cache.lock() {
            #[cfg(feature = "cache")]
            {
                let removed = cache.pop(&key_str).is_some();
                if removed {
                    self.update_size(cache.len());
                }
                return removed;
            }

            #[cfg(not(feature = "cache"))]
            {
                let removed = cache.remove(&key_str).is_some();
                if removed {
                    self.update_size(cache.len());
                }
                return removed;
            }
        }

        false
    }

    async fn clear(&self) -> bool {
        if let Ok(mut cache) = self.cache.lock() {
            cache.clear();
            self.update_size(0);

            // Reset stats
            if let Ok(mut stats) = self.stats.lock() {
                *stats = CacheStats::default();
            }

            return true;
        }

        false
    }

    async fn exists(&self, key: &impl CacheKey) -> bool {
        if !self.enabled {
            return false;
        }

        let key_str = key.to_string();

        if let Ok(mut cache) = self.cache.lock() {
            #[cfg(feature = "cache")]
            {
                if let Some(entry) = cache.get(&key_str) {
                    if entry.is_expired() {
                        cache.pop(&key_str);
                        self.update_size(cache.len());
                        return false;
                    }
                    return true;
                }
            }

            #[cfg(not(feature = "cache"))]
            {
                if let Some(entry) = cache.get(&key_str) {
                    if entry.is_expired() {
                        cache.remove(&key_str);
                        self.update_size(cache.len());
                        return false;
                    }
                    return true;
                }
            }
        }

        false
    }

    async fn stats(&self) -> CacheStats {
        self.stats.lock().map(|s| s.clone()).unwrap_or_default()
    }

    fn set_enabled(&mut self, enabled: bool) {
        self.enabled = enabled;
        if !enabled {
            // Clear cache when disabled
            if let Ok(mut cache) = self.cache.lock() {
                cache.clear();
            }
        }
    }

    fn is_enabled(&self) -> bool {
        self.enabled
    }
}

/// Builder for InMemoryCacheProvider
pub struct InMemoryCacheProviderBuilder {
    capacity: usize,
    enabled: bool,
}

impl Default for InMemoryCacheProviderBuilder {
    fn default() -> Self {
        Self {
            capacity: 1000,
            enabled: true,
        }
    }
}

impl InMemoryCacheProviderBuilder {
    /// Create a new builder
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the cache capacity
    pub fn capacity(mut self, capacity: usize) -> Self {
        self.capacity = capacity;
        self
    }

    /// Set whether the cache is initially enabled
    pub fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    /// Build the cache provider
    pub fn build(self) -> InMemoryCacheProvider {
        let mut provider = InMemoryCacheProvider::new(self.capacity);
        provider.enabled = self.enabled;
        provider
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_cache_basic_operations() {
        let provider = InMemoryCacheProvider::new(10);

        // Test set and get
        let key = "test_key".to_string();
        let value = "test_value".to_string();

        assert!(provider.set(&key, &value, None).await);
        assert_eq!(provider.get::<String>(&key).await, Some(value.clone()));

        // Test exists
        assert!(provider.exists(&key).await);

        // Test remove
        assert!(provider.remove(&key).await);
        assert!(!provider.exists(&key).await);
        assert_eq!(provider.get::<String>(&key).await, None);
    }

    #[tokio::test]
    async fn test_cache_expiration() {
        let provider = InMemoryCacheProvider::new(10);

        let key = "expiring_key".to_string();
        let value = "expiring_value".to_string();

        // Set with very short TTL
        assert!(
            provider
                .set(&key, &value, Some(Duration::from_millis(10)))
                .await
        );

        // Should exist immediately
        assert!(provider.exists(&key).await);

        // Wait for expiration
        tokio::time::sleep(Duration::from_millis(20)).await;

        // Should be expired
        assert!(!provider.exists(&key).await);
        assert_eq!(provider.get::<String>(&key).await, None);
    }

    #[tokio::test]
    async fn test_cache_clear() {
        let provider = InMemoryCacheProvider::new(10);

        // Add multiple items
        for i in 0..5 {
            let key = format!("key_{}", i);
            let value = format!("value_{}", i);
            assert!(provider.set(&key, &value, None).await);
        }

        // Clear cache
        assert!(provider.clear().await);

        // All items should be gone
        for i in 0..5 {
            let key = format!("key_{}", i);
            assert!(!provider.exists(&key).await);
        }
    }

    #[tokio::test]
    async fn test_cache_disabled() {
        let mut provider = InMemoryCacheProvider::new(10);

        let key = "test_key".to_string();
        let value = "test_value".to_string();

        // Disable cache
        provider.set_enabled(false);
        assert!(!provider.is_enabled());

        // Operations should fail or return None
        assert!(!provider.set(&key, &value, None).await);
        assert_eq!(provider.get::<String>(&key).await, None);
        assert!(!provider.exists(&key).await);
        assert!(!provider.remove(&key).await);
    }

    #[tokio::test]
    async fn test_cache_stats() {
        let provider = InMemoryCacheProvider::new(10);

        let key1 = "key1".to_string();
        let key2 = "key2".to_string();
        let value = "value".to_string();

        // Set some values
        provider.set(&key1, &value, None).await;
        provider.set(&key2, &value, None).await;

        // Get existing (hit)
        provider.get::<String>(&key1).await;

        // Get non-existing (miss)
        provider.get::<String>(&"nonexistent".to_string()).await;

        let stats = provider.stats().await;
        assert_eq!(stats.hits, 1);
        assert_eq!(stats.misses, 1);
        assert_eq!(stats.size, 2);
    }
}