foxtive 0.25.6

Foxtive Framework
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
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
use crate::cache::contract::CacheDriverContract;
use crate::prelude::Redis;
use crate::results::AppResult;
use std::sync::Arc;

#[derive(Clone)]
pub struct RedisCacheDriver {
    redis: Arc<Redis>,
}

impl RedisCacheDriver {
    pub fn new(redis: Arc<Redis>) -> Self {
        Self { redis }
    }
}

#[async_trait::async_trait]
impl CacheDriverContract for RedisCacheDriver {
    async fn keys(&self) -> AppResult<Vec<String>> {
        // Use Redis KEYS command to get all keys
        self.redis.keys().await
    }

    async fn keys_by_pattern(&self, pattern: &str) -> AppResult<Vec<String>> {
        // Use Redis KEYS command with the provided pattern directly
        // Redis patterns use glob-style patterns, which is different from regex
        // but the contract expects regex patterns, so we need to convert
        let redis_pattern = regex_to_redis_pattern(pattern);
        self.redis.keys_by_pattern(&redis_pattern).await
    }

    async fn put_raw(&self, key: &str, value: String) -> AppResult<String> {
        self.redis.set(key, &value).await
    }

    async fn get_raw(&self, key: &str) -> AppResult<Option<String>> {
        self.redis.get::<Option<String>>(key).await
    }

    async fn forget(&self, key: &str) -> AppResult<i32> {
        self.redis.delete(key).await
    }

    async fn forget_by_pattern(&self, key: &str) -> AppResult<i32> {
        self.redis
            .delete_by_pattern(key)
            .await
            .map(|count| count as i32)
    }
}

// Helper function to convert regex patterns to Redis glob patterns
fn regex_to_redis_pattern(pattern: &str) -> String {
    // Handle some common regex patterns and convert them to Redis patterns
    let mut redis_pattern = pattern.to_string();

    // Replace regex start/end markers
    redis_pattern = redis_pattern.replace("^", "");
    redis_pattern = redis_pattern.replace("$", "");

    // Replace regex .* with Redis *
    redis_pattern = redis_pattern.replace(".*", "*");

    // Replace regex dot with Redis ?
    redis_pattern = redis_pattern.replace(".", "?");

    // Handle case-insensitive flag by removing it (Redis KEYS is case-sensitive)
    redis_pattern = redis_pattern.replace("(?i)", "");

    // Escape special Redis pattern characters that might be in the regex
    redis_pattern = redis_pattern.replace("[", "\\[");
    redis_pattern = redis_pattern.replace("]", "\\]");

    redis_pattern
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::prelude::Redis;
    use deadpool_redis::{Config, Runtime};
    use std::env;
    use std::sync::Arc;
    use std::time::Duration;

    async fn setup_test_driver() -> Option<RedisCacheDriver> {
        // Try to get Redis URL from environment, fall back to default if not set
        let redis_url = env::var("TEST_REDIS_DSN")
            .or_else(|_| env::var("REDIS_DSN"))
            .unwrap_or_else(|_| "redis://127.0.0.1:6379".to_string());

        eprintln!("Connecting to Redis at {redis_url}");

        // Create Redis configuration
        let cfg = Config::from_url(redis_url);

        // Attempt to create the pool
        match cfg.create_pool(Some(Runtime::Tokio1)) {
            Ok(pool) => {
                let redis = Arc::new(Redis::new(pool));
                let driver = RedisCacheDriver::new(redis);

                // Test connection and flush DB
                match driver.redis.flush_db().await {
                    Ok(_) => Some(driver),
                    Err(e) => {
                        eprintln!("Error: {e}");
                        None
                    }
                }
            }
            Err(e) => {
                eprintln!("Error: {e}");
                None
            }
        }
    }

    #[tokio::test]
    async fn test_basic_operations() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Verify connection is working
        match driver.redis.flush_db().await {
            Ok(_) => eprintln!("Successfully connected to Redis and flushed DB"),
            Err(e) => {
                eprintln!("Failed to flush Redis DB: {e}",);
                return;
            }
        }

        // Test put_raw and get_raw
        let key = "_____test_key";
        let value = "test_value".to_string();

        assert!(driver.put_raw(key, value.clone()).await.is_ok());
        let get_result = driver.get_raw(key).await.unwrap();
        assert_eq!(get_result, Some(value));

        // Test forget
        assert_eq!(driver.forget(key).await.unwrap(), 1);
        assert_eq!(driver.get_raw(key).await.unwrap(), None);

        // Test forgetting non-existent key
        assert_eq!(driver.forget("nonexistent").await.unwrap(), 0);
    }

    #[tokio::test]
    async fn test_forget_by_pattern_comprehensive() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Verify connection is working
        match driver.redis.flush_db().await {
            Ok(_) => eprintln!("Successfully connected to Redis and flushed DB"),
            Err(e) => {
                eprintln!("Failed to flush Redis DB: {e}");
                return;
            }
        }

        // Set up test data with various patterns
        let test_data = [
            ("user:123", "data1"),
            ("user:456", "data2"),
            ("cache:temp:1", "temp1"),
            ("cache:temp:2", "temp2"),
            ("session:abc", "session1"),
            ("SESSION:xyz", "session2"),
            ("test.key", "value"),
            ("test-key", "value"),
            ("special*char", "special"),
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        // Test case 1: Exact prefix match
        let removed = driver.forget_by_pattern("user:*").await.unwrap();
        assert_eq!(removed, 2);
        assert_eq!(driver.get_raw("user:123").await.unwrap(), None);
        assert_eq!(driver.get_raw("user:456").await.unwrap(), None);
        assert!(driver.get_raw("cache:temp:1").await.unwrap().is_some());

        // Test case 2: Match with multiple segments
        let removed = driver.forget_by_pattern("cache:temp:*").await.unwrap();
        assert_eq!(removed, 2);
        assert_eq!(driver.get_raw("cache:temp:1").await.unwrap(), None);
        assert_eq!(driver.get_raw("cache:temp:2").await.unwrap(), None);

        // Test case 3: Pattern with special characters
        let removed = driver.forget_by_pattern("test?key").await.unwrap();
        assert_eq!(removed, 2);
        assert_eq!(driver.get_raw("test.key").await.unwrap(), None);
        assert_eq!(driver.get_raw("test-key").await.unwrap(), None);

        // Test case 4: Pattern with escaped special characters
        let removed = driver.forget_by_pattern("special\\*char").await.unwrap();
        assert_eq!(removed, 1);
        assert_eq!(driver.get_raw("special*char").await.unwrap(), None);
    }

    #[tokio::test]
    async fn test_concurrent_operations() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Verify connection is working
        match driver.redis.flush_db().await {
            Ok(_) => eprintln!("Successfully connected to Redis and flushed DB"),
            Err(e) => {
                eprintln!("Failed to flush Redis DB: {e}");
                return;
            }
        }

        // Allow pool to initialize fully
        tokio::time::sleep(Duration::from_millis(100)).await;

        let driver_clone = driver.clone();

        // Add initial data with verification
        for i in 0..100 {
            let key = format!("test:{i}");
            let value = format!("value{i}");

            match driver.put_raw(&key, value.clone()).await {
                Ok(_) => {
                    // Verify each write immediately
                    match driver.get_raw(&key).await {
                        Ok(Some(v)) if v == value => continue,
                        Ok(Some(v)) => {
                            eprintln!(
                                "Value mismatch for key {key}: expected '{value}', got '{v}'"
                            );
                            return;
                        }
                        Ok(None) => {
                            eprintln!("Key {key} was written but returned None on read");
                            return;
                        }
                        Err(e) => {
                            eprintln!("Error reading back key {key}: {e}");
                            return;
                        }
                    }
                }
                Err(e) => {
                    eprintln!("Failed to write key {key}: {e}");
                    return;
                }
            }
        }

        eprintln!("Initial data written successfully");

        // Sequential verification of all data before concurrent operations
        for i in 0..100 {
            let key = format!("test:{i}");
            let expected = format!("value{i}");
            match driver.get_raw(&key).await {
                Ok(Some(v)) if v == expected => continue,
                Ok(Some(v)) => {
                    eprintln!(
                        "Pre-concurrent check: Value mismatch for key {key}: expected '{expected}', got '{v}'"
                    );
                    return;
                }
                Ok(None) => {
                    eprintln!("Pre-concurrent check: Key {key} unexpectedly returned None");
                    return;
                }
                Err(e) => {
                    eprintln!("Pre-concurrent check: Error reading key {key}: {e}");
                    return;
                }
            }
        }

        eprintln!("Initial verification completed successfully");

        // Proceed with concurrent operations
        let barrier = Arc::new(tokio::sync::Barrier::new(2));
        let barrier_write = barrier.clone();
        let barrier_read = barrier.clone();

        let write_handle = tokio::spawn({
            let driver = driver_clone.clone();
            async move {
                barrier_write.wait().await;
                for i in 100..200 {
                    if let Err(e) = driver
                        .put_raw(&format!("test:{i}"), format!("value{i}"))
                        .await
                    {
                        eprintln!("Write task error: {e}");
                        return;
                    }
                }
            }
        });

        let read_handle = tokio::spawn({
            let driver = driver_clone.clone();
            async move {
                barrier_read.wait().await;
                for i in 0..100 {
                    match driver.get_raw(&format!("test:{i}")).await {
                        Ok(Some(v)) => {
                            let expected = format!("value{i}");
                            if v != expected {
                                eprintln!(
                                    "Read task: Value mismatch for key test:{i}: expected '{expected}', got '{v}'"
                                );
                            }
                        }
                        Ok(None) => eprintln!("Read task: Unexpected None for key test:{i}"),
                        Err(e) => eprintln!("Read task error for key test:{i}: {e}"),
                    }
                }
            }
        });

        // Wait for operations to complete
        let _ = tokio::join!(write_handle, read_handle);

        // Clean up
        let removed = driver.forget_by_pattern("test:*").await.unwrap();
        assert_eq!(removed, 200);
    }

    #[tokio::test]
    async fn test_error_handling() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Verify connection is working
        match driver.redis.flush_db().await {
            Ok(_) => eprintln!("Successfully connected to Redis and flushed DB"),
            Err(e) => {
                eprintln!("Failed to flush Redis DB: {e}");
                return;
            }
        }

        // Test handling of special characters in keys
        let special_chars = vec!["key with spaces", "key\nwith\nnewlines", "key:with:colons"];
        for key in special_chars {
            let result = driver.put_raw(key, "test".to_string()).await;
            assert!(result.is_ok(), "Should handle special characters in keys");
        }
    }

    #[tokio::test]
    async fn test_expiration_behavior() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Verify connection is working
        match driver.redis.flush_db().await {
            Ok(_) => eprintln!("Successfully connected to Redis and flushed DB"),
            Err(e) => {
                eprintln!("Failed to flush Redis DB: {e}");
                return;
            }
        }

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

        // Store a value
        driver.put_raw(key, value).await.unwrap();

        let result = driver.get_raw(key).await.unwrap();
        assert!(result.is_some(), "Value should still exist after 1 second");
    }

    #[tokio::test]
    async fn test_keys_empty_db() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        // Ensure DB is empty
        driver.redis.flush_db().await.unwrap();

        let keys = driver.keys().await.unwrap();
        assert!(keys.is_empty(), "Empty database should return no keys");
    }

    #[tokio::test]
    async fn test_keys_with_data() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Set up test data
        let test_data = [
            ("key1", "value1"),
            ("key2", "value2"),
            ("prefix:key3", "value3"),
            ("", "empty_value"), // Test empty key
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        let mut keys = driver.keys().await.unwrap();
        keys.sort();

        let mut expected: Vec<String> = test_data.iter().map(|(k, _)| k.to_string()).collect();
        expected.sort();

        assert_eq!(keys, expected, "Retrieved keys should match inserted keys");
    }

    #[tokio::test]
    async fn test_keys_after_deletion() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Insert test data
        let test_data = [
            ("test1", "value1"),
            ("test2", "value2"),
            ("test3", "value3"),
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        // Delete one key
        driver.forget("test2").await.unwrap();

        let mut keys = driver.keys().await.unwrap();
        keys.sort();

        let expected = vec!["test1".to_string(), "test3".to_string()];
        assert_eq!(keys, expected, "Keys should not include deleted key");
    }

    #[tokio::test]
    async fn test_keys_by_pattern_basic() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Set up test data with different patterns
        let test_data = [
            ("user:1", "value1"),
            ("user:2", "value2"),
            ("profile:1", "value3"),
            ("other", "value4"),
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        // Test prefix match (regex pattern will be converted to Redis pattern)
        let mut keys = driver.keys_by_pattern("^user:.*").await.unwrap();
        keys.sort();
        assert_eq!(
            keys,
            vec!["user:1".to_string(), "user:2".to_string()],
            "Should match user: prefix"
        );

        // Test exact match
        let keys = driver.keys_by_pattern("^other$").await.unwrap();
        assert_eq!(
            keys,
            vec!["other".to_string()],
            "Should match exact pattern"
        );
    }

    #[tokio::test]
    async fn test_keys_by_pattern_wildcards() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Set up test data for wildcard matching
        let test_data = [
            ("test1", "value1"),
            ("test2", "value2"),
            ("test11", "value3"),
            ("atest1", "value4"),
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        // Test single character wildcard (. in regex becomes ? in Redis)
        let mut keys = driver.keys_by_pattern("test.").await.unwrap();
        keys.sort();
        assert_eq!(
            keys,
            vec!["test1".to_string(), "test2".to_string()],
            "Should match single character wildcard"
        );

        // Test multi-character wildcard (.* in regex becomes * in Redis)
        let mut keys = driver.keys_by_pattern("test.*").await.unwrap();
        keys.sort();
        assert_eq!(
            keys,
            vec![
                "test1".to_string(),
                "test11".to_string(),
                "test2".to_string()
            ],
            "Should match multi-character wildcard"
        );
    }

    #[tokio::test]
    async fn test_keys_by_pattern_special_chars() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Set up test data with special characters
        let test_data = [
            ("test[1]", "value1"),
            ("test[2]", "value2"),
            ("test{3}", "value3"),
        ];

        for (key, value) in test_data {
            driver.put_raw(key, value.to_string()).await.unwrap();
        }

        // Test pattern with escaped special characters
        let mut keys = driver.keys_by_pattern("test\\[.*\\]").await.unwrap();
        keys.sort();
        assert_eq!(
            keys,
            vec!["test[1]".to_string(), "test[2]".to_string()],
            "Should match escaped special characters"
        );
    }

    #[tokio::test]
    async fn test_keys_by_pattern_empty() {
        let driver = match setup_test_driver().await {
            Some(driver) => driver,
            None => {
                eprintln!("Skipping Redis tests - no connection available");
                return;
            }
        };

        driver.redis.flush_db().await.unwrap();

        // Add some test data
        driver.put_raw("test1", "value1".to_string()).await.unwrap();
        driver.put_raw("test2", "value2".to_string()).await.unwrap();

        let keys = driver.keys_by_pattern("").await.unwrap();
        assert!(keys.is_empty(), "Empty pattern should return no matches");
    }
}