oxcache 0.1.4

A high-performance multi-level cache library for Rust with L1 (memory) and L2 (Redis) caching.
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

// Copyright (c) 2025-2026, Kirky.X
//
// MIT License
//
// 该模块定义了测试的通用工具函数和设置。

pub mod database_test_utils;
pub mod redis_test_utils;

use oxcache::{config::OxcacheConfig as Config, Cache};
use redis_test_utils::{
    is_redis_available_default, wait_for_redis as redis_test_wait_for_redis,
    wait_for_redis_cluster as redis_test_wait_for_redis_cluster,
    wait_for_sentinel as redis_test_wait_for_sentinel,
};
use std::sync::Once;
use tracing_subscriber::fmt::format::FmtSpan;
use tracing_subscriber::EnvFilter;

static INIT: Once = Once::new();

pub fn setup_logging() {
    INIT.call_once(|| {
        tracing_subscriber::fmt()
            .with_span_events(FmtSpan::CLOSE)
            .with_env_filter(EnvFilter::new("debug"))
            .try_init()
            .ok();
    });
}

/// 设置缓存
///
/// 根据提供的配置创建缓存实例
///
/// # 参数
///
/// * `config` - 缓存配置
#[allow(dead_code)]
pub async fn setup_cache(_config: Config) -> Cache<String, Vec<u8>> {
    setup_logging();

    // 使用新的 API 直接创建缓存
    // 配置参数目前未使用，因为新的 Cache API 不接受 OxcacheConfig
    // 这是因为我们已经迁移到独立的 Cache<K, V> 实例模式
    Cache::new()
        .await
        .unwrap_or_else(|e| panic!("Failed to create memory cache: {}", e))
}

/// 检查Redis是否可用 (默认URL)
///
/// 尝试连接到本地Redis实例，检查其是否可用
#[allow(dead_code)]
pub async fn is_redis_available() -> bool {
    is_redis_available_default().await
}

/// 等待Redis可用
///
/// 循环检查Redis是否可用，直到超时
#[allow(dead_code)]
pub async fn wait_for_redis(url: &str) -> bool {
    redis_test_wait_for_redis(url).await
}

/// 等待Redis可用 (别名)
///
/// 循环检查Redis是否可用，直到超时
#[allow(dead_code)]
pub async fn wait_for_redis_url(url: &str) -> bool {
    wait_for_redis(url).await
}

/// 等待Redis集群可用
///
/// 检查所有Redis节点是否可用且集群状态正常
#[allow(dead_code)]
pub async fn wait_for_redis_cluster(urls: &[&str]) -> bool {
    redis_test_wait_for_redis_cluster(urls).await
}

/// 等待Redis Sentinel可用
///
/// 检查所有Sentinel节点是否可用且master已配置
#[allow(dead_code)]
pub async fn wait_for_sentinel() -> bool {
    redis_test_wait_for_sentinel().await
}

/// 生成唯一的服务器名称
///
/// 在基础名称后附加UUID，确保测试之间的隔离
///
/// # 参数
///
/// * `base` - 基础名称
///
/// # 返回值
///
/// 返回唯一的服务器名称
#[allow(dead_code)]
pub fn generate_unique_service_name(base: &str) -> String {
    format!("{}_{}", base, uuid::Uuid::new_v4().simple())
}

/// 清理测试服务资源
///
/// 测试结束后清理WAL数据库文件和缓存数据
///
/// # 参数
///
/// * `service_name` - 服务名称
#[allow(dead_code)]
pub async fn cleanup_service(service_name: &str) {
    tokio::fs::remove_file(format!("{}_wal.db", service_name))
        .await
        .ok();
    tokio::fs::remove_file(format!("{}.db", service_name))
        .await
        .ok();
}