pywatt_sdk 0.5.3

Standardized SDK for building PyWatt modules in Rust
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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
#[cfg(feature = "redis_cache")]
use crate::data::cache::{CacheConfig, CacheError, CacheResult, CacheService, CacheStats, CacheType};
#[cfg(feature = "redis_cache")]
use async_trait::async_trait;
#[cfg(feature = "redis_cache")]
use redis::{AsyncCommands, Client, ErrorKind, RedisError, Script, aio::ConnectionManager};
#[cfg(feature = "redis_cache")]
use std::collections::HashMap;
#[cfg(feature = "redis_cache")]
use std::sync::Arc;
#[cfg(feature = "redis_cache")]
use std::sync::atomic::{AtomicU64, Ordering};
#[cfg(feature = "redis_cache")]
use std::time::Duration;
#[cfg(feature = "redis_cache")]
use uuid::Uuid;

/// Redis cache implementation
#[cfg(feature = "redis_cache")]
pub struct RedisCache {
    /// Redis connection manager
    connection: Arc<ConnectionManager>,
    /// Default TTL for cache entries
    default_ttl: Duration,
    /// Namespace prefix for cache keys
    namespace: Option<String>,
    /// Cache hit counter
    hits: Arc<AtomicU64>,
    /// Cache miss counter
    misses: Arc<AtomicU64>,
}

#[cfg(not(feature = "redis_cache"))]
pub struct RedisCache;

#[cfg(feature = "redis_cache")]
impl RedisCache {
    /// Connect to Redis using the provided configuration
    pub async fn connect(config: &CacheConfig) -> CacheResult<Self> {
        // Build server list
        let server = if config.hosts.is_empty() {
            "127.0.0.1".to_string()
        } else {
            config.hosts[0].clone()
        };

        // Add port if specified
        let server_with_port = if let Some(port) = config.port {
            format!("{}:{}", server, port)
        } else {
            // Default Redis port
            format!("{}:6379", server)
        };

        // Build Redis URL
        let mut redis_url = format!("redis://{}", server_with_port);

        // Add credentials if provided
        if let (Some(username), Some(password)) = (&config.username, &config.password) {
            redis_url = format!("redis://{}:{}@{}", username, password, server_with_port);
        } else if let Some(password) = &config.password {
            redis_url = format!("redis://:{}@{}", password, server_with_port);
        }

        // Create client
        let client = Client::open(redis_url.clone()).map_err(Self::convert_error)?;

        // Create connection manager
        let connection = ConnectionManager::new(client)
            .await
            .map_err(Self::convert_error)?;

        Ok(Self {
            connection: Arc::new(connection),
            default_ttl: config.get_default_ttl(),
            namespace: config.namespace.clone(),
            hits: Arc::new(AtomicU64::new(0)),
            misses: Arc::new(AtomicU64::new(0)),
        })
    }

    /// Add namespace prefix to key if configured
    fn prefix_key(&self, key: &str) -> String {
        if let Some(ns) = &self.namespace {
            format!("{}:{}", ns, key)
        } else {
            key.to_string()
        }
    }

    /// Strip namespace prefix from key if needed
    #[allow(dead_code)]
    fn strip_prefix(&self, key: &str) -> String {
        if let Some(ns) = &self.namespace {
            let prefix = format!("{}:", ns);
            if key.starts_with(&prefix) {
                key[prefix.len()..].to_string()
            } else {
                key.to_string()
            }
        } else {
            key.to_string()
        }
    }

    /// Convert Redis errors to CacheError
    fn convert_error(err: RedisError) -> CacheError {
        match err.kind() {
            ErrorKind::IoError => CacheError::Connection(format!("Redis I/O error: {}", err)),
            ErrorKind::AuthenticationFailed => {
                CacheError::Connection(format!("Redis authentication failed: {}", err))
            }
            ErrorKind::BusyLoadingError => {
                CacheError::Connection(format!("Redis busy loading: {}", err))
            }
            ErrorKind::InvalidClientConfig => {
                CacheError::Configuration(format!("Redis invalid client config: {}", err))
            }
            ErrorKind::ClusterDown => {
                CacheError::Connection(format!("Redis cluster down: {}", err))
            }
            ErrorKind::MasterDown => CacheError::Connection(format!("Redis master down: {}", err)),
            _ => CacheError::Operation(format!("Redis error: {}", err)),
        }
    }
}

#[cfg(not(feature = "redis_cache"))]
impl RedisCache {
    /// Connect to Redis using the provided configuration
    pub async fn connect(_config: &crate::data::cache::CacheConfig) -> crate::data::cache::CacheResult<Self> {
        Err(crate::data::cache::CacheError::Connection(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }
}

#[cfg(feature = "redis_cache")]
#[async_trait]
impl CacheService for RedisCache {
    async fn get(&self, key: &str) -> CacheResult<Option<Vec<u8>>> {
        let prefixed_key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();

        // Execute Redis GET command
        match conn_mgr.get::<_, Option<Vec<u8>>>(&prefixed_key).await {
            Ok(value) => {
                if value.is_some() {
                    self.hits.fetch_add(1, Ordering::Relaxed);
                } else {
                    self.misses.fetch_add(1, Ordering::Relaxed);
                }
                Ok(value)
            }
            Err(e) => {
                // Handle nil responses gracefully
                if e.kind() == ErrorKind::TypeError || e.to_string().contains("nil") {
                    self.misses.fetch_add(1, Ordering::Relaxed);
                    Ok(None)
                } else {
                    Err(Self::convert_error(e))
                }
            }
        }
    }

    async fn set(&self, key: &str, value: &[u8], ttl: Option<Duration>) -> CacheResult<()> {
        let prefixed_key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        let expiry = ttl.unwrap_or(self.default_ttl);

        let _: String = conn_mgr
            .set_ex(&prefixed_key, value, expiry.as_secs())
            .await
            .map_err(Self::convert_error)?;

        Ok(())
    }

    async fn delete(&self, key: &str) -> CacheResult<bool> {
        let key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        let count: i64 = conn_mgr.del(&key).await.map_err(Self::convert_error)?;
        Ok(count > 0)
    }

    async fn exists(&self, key: &str) -> CacheResult<bool> {
        let key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        let count: i64 = conn_mgr.exists(&key).await.map_err(Self::convert_error)?;
        Ok(count > 0)
    }

    async fn set_nx(&self, key: &str, value: &[u8], ttl: Option<Duration>) -> CacheResult<bool> {
        let key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        let acquired: bool = conn_mgr
            .set_nx(&key, value)
            .await
            .map_err(Self::convert_error)?;

        if acquired && ttl.is_some() {
            let _: String = conn_mgr
                .expire(&key, ttl.unwrap().as_secs() as i64)
                .await
                .map_err(Self::convert_error)?;
        }

        Ok(acquired)
    }

    async fn get_set(&self, key: &str, value: &[u8]) -> CacheResult<Option<Vec<u8>>> {
        let key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        // Corrected to use getset and handle potential nil response for old_value
        match conn_mgr
            .getset::<&str, &[u8], Option<Vec<u8>>>(&key, value)
            .await
        {
            Ok(old_value) => Ok(old_value),
            Err(e) => {
                if e.kind() == ErrorKind::TypeError || e.to_string().contains("nil") {
                    Ok(None) // Key didn't exist, so no old value
                } else {
                    Err(Self::convert_error(e))
                }
            }
        }
    }

    async fn increment(&self, key: &str, delta: i64) -> CacheResult<i64> {
        let key = self.prefix_key(key);
        let mut conn_mgr = self.connection.as_ref().clone();
        let result: i64 = if delta >= 0 {
            conn_mgr.incr(&key, delta).await
        } else {
            conn_mgr.decr(&key, -delta).await
        }
        .map_err(Self::convert_error)?;
        Ok(result)
    }

    async fn set_many(
        &self,
        items: &HashMap<String, Vec<u8>>,
        ttl: Option<Duration>,
    ) -> CacheResult<()> {
        if items.is_empty() {
            return Ok(());
        }

        let mut conn_mgr = self.connection.as_ref().clone();
        let mut pipe = redis::pipe();

        for (key, value) in items {
            let prefixed_key = self.prefix_key(key);
            if let Some(t) = ttl {
                pipe.add_command(
                    redis::cmd("SET")
                        .arg(&prefixed_key)
                        .arg(value.as_slice())
                        .arg("EX")
                        .arg(t.as_secs())
                        .clone(),
                );
            } else {
                pipe.add_command(
                    redis::cmd("SET")
                        .arg(&prefixed_key)
                        .arg(value.as_slice())
                        .clone(),
                );
            }
        }

        let _: () = pipe
            .query_async(&mut conn_mgr)
            .await
            .map_err(Self::convert_error)?;
        Ok(())
    }

    async fn get_many(&self, keys: &[String]) -> CacheResult<HashMap<String, Vec<u8>>> {
        if keys.is_empty() {
            return Ok(HashMap::new());
        }

        let prefixed_keys: Vec<String> = keys.iter().map(|k| self.prefix_key(k)).collect();

        let mut conn_mgr = self.connection.as_ref().clone();
        // MGET returns Vec<Option<Vec<u8>>>
        let values: Vec<Option<Vec<u8>>> = conn_mgr
            .get(prefixed_keys.as_slice()) // .get on a slice of keys performs MGET
            .await
            .map_err(Self::convert_error)?;

        let mut result = HashMap::new();
        for (i, value_opt) in values.into_iter().enumerate() {
            if let Some(data) = value_opt {
                if let Some(original_key) = keys.get(i) {
                    // Safely get original key
                    result.insert(original_key.clone(), data);
                }
            }
        }

        Ok(result)
    }

    async fn delete_many(&self, keys: &[String]) -> CacheResult<u64> {
        if keys.is_empty() {
            return Ok(0);
        }

        let prefixed_keys: Vec<String> = keys.iter().map(|k| self.prefix_key(k)).collect();

        let mut conn_mgr = self.connection.as_ref().clone();
        let count: i64 = conn_mgr
            .del(prefixed_keys.as_slice())
            .await
            .map_err(Self::convert_error)?;

        Ok(count as u64)
    }

    async fn clear(&self, namespace: Option<&str>) -> CacheResult<()> {
        let mut conn_mgr = self.connection.as_ref().clone();

        let target_namespace = namespace.or(self.namespace.as_deref());

        let pattern = if let Some(ns) = target_namespace {
            format!("{}:*", ns)
        } else {
            "*".to_string()
        };

        let keys_to_delete: Vec<String> =
            conn_mgr.keys(&pattern).await.map_err(Self::convert_error)?;

        if !keys_to_delete.is_empty() {
            let _: i64 = conn_mgr
                .del(keys_to_delete.as_slice())
                .await
                .map_err(Self::convert_error)?;
        }

        Ok(())
    }

    async fn lock(&self, key: &str, ttl: Duration) -> CacheResult<Option<String>> {
        let lock_key = self.prefix_key(&format!("lock:{}", key));
        let token = Uuid::new_v4().to_string();
        let mut conn_mgr = self.connection.as_ref().clone();

        let acquired: bool = conn_mgr
            .set_nx(&lock_key, token.as_bytes())
            .await
            .map_err(Self::convert_error)?;

        if acquired {
            let _: String = conn_mgr
                .expire(&lock_key, ttl.as_secs() as i64)
                .await
                .map_err(Self::convert_error)?;
            Ok(Some(token))
        } else {
            Ok(None)
        }
    }

    async fn unlock(&self, key: &str, lock_token: &str) -> CacheResult<bool> {
        let lock_key = self.prefix_key(&format!("lock:{}", key));
        let mut conn_mgr = self.connection.as_ref().clone();

        let script_body = r#"
            if redis.call('get', KEYS[1]) == ARGV[1] then
                return redis.call('del', KEYS[1])
            else
                return 0
            end
        "#;

        let result: i64 = Script::new(script_body)
            .key(&lock_key)
            .arg(lock_token.as_bytes())
            .invoke_async(&mut conn_mgr)
            .await
            .map_err(Self::convert_error)?;

        Ok(result > 0)
    }

    fn get_cache_type(&self) -> CacheType {
        CacheType::Redis
    }

    async fn ping(&self) -> CacheResult<()> {
        let mut conn_mgr = self.connection.as_ref().clone();
        let result: String = conn_mgr.ping().await.map_err(Self::convert_error)?;

        if result == "PONG" {
            Ok(())
        } else {
            Err(CacheError::Connection(format!(
                "Unexpected ping response: {}",
                result
            )))
        }
    }

    async fn close(&self) -> CacheResult<()> {
        Ok(())
    }

    fn get_default_ttl(&self) -> Duration {
        self.default_ttl
    }

    async fn stats(&self) -> CacheResult<CacheStats> {
        let mut conn_mgr = self.connection.as_ref().clone();
        let info_str: String = redis::cmd("INFO")
            .query_async(&mut conn_mgr)
            .await
            .map_err(Self::convert_error)?;

        let mut stats = CacheStats {
            hits: Some(self.hits.load(Ordering::Relaxed)),
            misses: Some(self.misses.load(Ordering::Relaxed)),
            ..Default::default()
        };

        for line in info_str.lines() {
            let line_trimmed = line.trim();
            if line_trimmed.starts_with('#') || line_trimmed.is_empty() {
                continue;
            }

            if let Some(pos) = line_trimmed.find(':') {
                let stat_key = &line_trimmed[0..pos];
                let stat_value = &line_trimmed[pos + 1..];

                match stat_key {
                    "used_memory" => {
                        if let Ok(val) = stat_value.parse::<u64>() {
                            stats.memory_used_bytes = Some(val);
                        }
                    }
                    "db0" => {
                        stat_value.split(',').for_each(|part| {
                            if let Some(kv_pair) = part.split_once('=') {
                                if kv_pair.0 == "keys" {
                                    if let Ok(val) = kv_pair.1.parse::<u64>() {
                                        stats.item_count = Some(val);
                                    }
                                }
                            }
                        });
                    }
                    _ => {
                        stats
                            .additional_metrics
                            .insert(stat_key.to_string(), stat_value.to_string());
                    }
                }
            }
        }

        Ok(stats)
    }

    async fn flush(&self) -> CacheResult<()> {
        let mut conn_mgr = self.connection.as_ref().clone();
        // flushdb returns "OK" which can be mapped to String
        let _: String = conn_mgr.flushdb().await.map_err(Self::convert_error)?;
        Ok(())
    }
}

#[cfg(not(feature = "redis_cache"))]
#[async_trait::async_trait]
impl crate::data::cache::CacheService for RedisCache {
    async fn get(&self, _key: &str) -> crate::data::cache::CacheResult<Option<Vec<u8>>> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn set(
        &self,
        _key: &str,
        _value: &[u8],
        _ttl: Option<std::time::Duration>,
    ) -> crate::data::cache::CacheResult<()> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn delete(&self, _key: &str) -> crate::data::cache::CacheResult<bool> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn exists(&self, _key: &str) -> crate::data::cache::CacheResult<bool> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn set_nx(
        &self,
        _key: &str,
        _value: &[u8],
        _ttl: Option<std::time::Duration>,
    ) -> crate::data::cache::CacheResult<bool> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn get_set(
        &self,
        _key: &str,
        _value: &[u8],
    ) -> crate::data::cache::CacheResult<Option<Vec<u8>>> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn increment(&self, _key: &str, _delta: i64) -> crate::data::cache::CacheResult<i64> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn set_many(
        &self,
        _items: &std::collections::HashMap<String, Vec<u8>>,
        _ttl: Option<std::time::Duration>,
    ) -> crate::data::cache::CacheResult<()> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn get_many(
        &self,
        _keys: &[String],
    ) -> crate::data::cache::CacheResult<std::collections::HashMap<String, Vec<u8>>> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn delete_many(&self, _keys: &[String]) -> crate::data::cache::CacheResult<u64> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn clear(&self, _namespace: Option<&str>) -> crate::data::cache::CacheResult<()> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn lock(
        &self,
        _key: &str,
        _ttl: std::time::Duration,
    ) -> crate::data::cache::CacheResult<Option<String>> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn unlock(&self, _key: &str, _lock_token: &str) -> crate::data::cache::CacheResult<bool> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    fn get_cache_type(&self) -> crate::data::cache::CacheType {
        crate::data::cache::CacheType::Redis
    }

    async fn ping(&self) -> crate::data::cache::CacheResult<()> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn close(&self) -> crate::data::cache::CacheResult<()> {
        Ok(())
    }

    fn get_default_ttl(&self) -> std::time::Duration {
        std::time::Duration::from_secs(300)
    }

    async fn stats(&self) -> crate::data::cache::CacheResult<crate::data::cache::CacheStats> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }

    async fn flush(&self) -> crate::data::cache::CacheResult<()> {
        Err(crate::data::cache::CacheError::Operation(
            "Redis support is not enabled. Recompile with the 'redis_cache' feature.".to_string(),
        ))
    }
}