sockudo 2.6.1

A simple, fast, and secure WebSocket server for real-time applications.
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

#![allow(dead_code)]
#![allow(unused_variables)]

use crate::error::Result;
use crate::rate_limiter::RateLimiter;
use std::sync::Arc;
use tracing::{error, info, warn};

use crate::options::{CacheDriver, RateLimiterConfig, RedisConnection};
use crate::rate_limiter::memory_limiter::MemoryRateLimiter;
use crate::rate_limiter::redis_cluster_limiter::RedisClusterRateLimiter;
use crate::rate_limiter::redis_limiter::RedisRateLimiter;

pub struct RateLimiterFactory;

impl RateLimiterFactory {
    pub async fn create(
        config: &RateLimiterConfig,
        global_redis_conn_details: &RedisConnection,
    ) -> Result<Arc<dyn RateLimiter + Send + Sync>> {
        if !config.enabled {
            info!("HTTP API Rate limiting is globally disabled. Returning a permissive limiter.");
            return Ok(Arc::new(MemoryRateLimiter::new(u32::MAX, 1))); // Allows all
        }

        info!(
            "Initializing HTTP API RateLimiter with driver: {:?}",
            config.driver
        );

        match config.driver {
            CacheDriver::Redis => {
                Self::create_redis_limiter(config, global_redis_conn_details).await
            }
            CacheDriver::RedisCluster => {
                Self::create_redis_cluster_limiter(config, global_redis_conn_details).await
            }
            CacheDriver::Memory => Self::create_memory_limiter(config),
            CacheDriver::None => {
                warn!("Rate limiter driver set to 'None'. Using memory limiter as fallback.");
                Ok(Arc::new(MemoryRateLimiter::new(
                    config.api_rate_limit.max_requests,
                    config.api_rate_limit.window_seconds,
                )))
            }
        }
    }

    async fn create_redis_limiter(
        config: &RateLimiterConfig,
        global_redis_conn_details: &RedisConnection,
    ) -> Result<Arc<dyn RateLimiter + Send + Sync>> {
        info!("RateLimiter: Using standalone Redis backend.");

        let redis_url = config.redis.url_override.clone().unwrap_or_else(|| {
            format!(
                "redis://{}:{}",
                global_redis_conn_details.host, global_redis_conn_details.port
            )
        });

        let prefix = config
            .redis
            .prefix
            .clone()
            .unwrap_or_else(|| global_redis_conn_details.key_prefix.clone() + "rl_http:");

        let client = redis::Client::open(redis_url.as_str()).map_err(|e| {
            crate::error::Error::Redis(format!(
                "Failed to create Redis client for rate limiter: {e}"
            ))
        })?;

        let limiter = RedisRateLimiter::new(
            client,
            prefix,
            config.api_rate_limit.max_requests,
            config.api_rate_limit.window_seconds,
        )
        .await?;

        Ok(Arc::new(limiter))
    }

    async fn create_redis_cluster_limiter(
        config: &RateLimiterConfig,
        global_redis_conn_details: &RedisConnection,
    ) -> Result<Arc<dyn RateLimiter + Send + Sync>> {
        info!("RateLimiter: Using Redis Cluster backend.");

        if global_redis_conn_details.cluster_nodes.is_empty() {
            error!("RateLimiter: Redis cluster driver selected, but no cluster_nodes configured.");
            return Err(crate::error::Error::Configuration(
                "RateLimiter: Redis cluster nodes not configured.".to_string(),
            ));
        }

        let nodes: Vec<String> = global_redis_conn_details
            .cluster_nodes
            .iter()
            .map(|node| format!("redis://{}:{}", node.host, node.port))
            .collect();

        let prefix = config
            .redis
            .prefix
            .clone()
            .unwrap_or_else(|| global_redis_conn_details.key_prefix.clone() + "rl_http:");

        let client = redis::cluster::ClusterClient::new(nodes).map_err(|e| {
            crate::error::Error::Redis(format!(
                "Failed to create Redis cluster client for rate limiter: {e}"
            ))
        })?;

        let limiter = RedisClusterRateLimiter::new(
            client,
            prefix,
            config.api_rate_limit.max_requests,
            config.api_rate_limit.window_seconds,
        )
        .await?;

        Ok(Arc::new(limiter))
    }

    fn create_memory_limiter(
        config: &RateLimiterConfig,
    ) -> Result<Arc<dyn RateLimiter + Send + Sync>> {
        info!("Using memory rate limiter for HTTP API.");
        let limiter = MemoryRateLimiter::new(
            config.api_rate_limit.max_requests,
            config.api_rate_limit.window_seconds,
        );
        Ok(Arc::new(limiter))
    }
}