rediq 0.2.4

A distributed task queue framework for Rust based on Redis
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
//! Server module
//!
//! Provides the Rediq server for processing tasks from Redis queues.

pub mod config;
pub mod worker;
pub mod scheduler;
pub mod janitor;

pub use config::{ServerBuilder, ServerConfig, ServerState};
pub use worker::{Worker, WorkerMetadata};
pub use scheduler::Scheduler;
pub use janitor::{Janitor, JanitorConfig};

use crate::{Error, Result};
use crate::processor::Mux;
use crate::observability::RediqMetrics;
use std::net::SocketAddr;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::Mutex;
use tokio::task::JoinSet;

/// Server - manages workers and processes tasks
///
/// The server is responsible for:
/// - Managing multiple workers that process tasks concurrently
/// - Starting the scheduler for delayed/retry tasks
/// - Graceful shutdown handling
///
/// # Example
///
/// ```rust
/// use rediq::server::{Server, ServerBuilder};
/// use rediq::processor::{Handler, Mux};
/// use async_trait::async_trait;
///
/// # struct MyHandler;
/// # #[async_trait]
/// # impl Handler for MyHandler {
/// #     async fn handle(&self, task: &rediq::Task) -> rediq::Result<()> {
/// #         Ok(())
/// #     }
/// # }
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// // Build server
/// let state = ServerBuilder::new()
///     .redis_url("redis://localhost:6379")
///     .queues(&["default", "critical"])
///     .concurrency(10)
///     .build()
///     .await?;
///
/// let server = Server::from(state);
///
/// // Register handlers
/// let mut mux = Mux::new();
/// mux.handle("email:send", MyHandler);
/// mux.handle("email:welcome", MyHandler);
///
/// // Run server (this will block until Ctrl+C)
/// server.run(mux).await?;
/// # Ok(())
/// # }
/// ```
pub struct Server {
    /// Shared state
    state: Arc<ServerState>,

    /// Shutdown flag
    shutdown: Arc<AtomicBool>,

    /// Active worker count
    worker_count: Arc<AtomicUsize>,

    /// Metrics collector
    metrics: Option<Arc<RediqMetrics>>,

    /// Metrics HTTP bind address
    metrics_bind_address: Option<SocketAddr>,
}

impl Server {
    /// Create a new server from state
    fn new(state: ServerState) -> Self {
        Self {
            state: Arc::new(state),
            shutdown: Arc::new(AtomicBool::new(false)),
            worker_count: Arc::new(AtomicUsize::new(0)),
            metrics: None,
            metrics_bind_address: None,
        }
    }

    /// Enable metrics collection with HTTP endpoint
    ///
    /// This enables Prometheus metrics collection and starts an HTTP server
    /// on the specified address for the `/metrics` endpoint.
    ///
    /// # Arguments
    /// * `bind_address` - Address to bind the metrics server (e.g., "0.0.0.0:9090")
    ///
    /// # Example
    ///
    /// ```rust
    /// use rediq::server::{Server, ServerBuilder};
    ///
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let state = ServerBuilder::new()
    ///     .redis_url("redis://localhost:6379")
    ///     .queues(&["default"])
    ///     .build()
    ///     .await?;
    ///
    /// let mut server = Server::from(state);
    /// server.enable_metrics_on("0.0.0.0:9090")?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn enable_metrics(&mut self, bind_address: impl Into<SocketAddr>) -> Result<()> {
        let metrics = RediqMetrics::new()
            .map_err(|e| Error::Metrics(e.to_string()))?;
        self.metrics = Some(Arc::new(metrics));
        let addr = bind_address.into();
        self.metrics_bind_address = Some(addr);
        tracing::info!("Metrics enabled on http://{}", addr);
        tracing::info!("Metrics endpoint: http://{}/metrics", addr);
        Ok(())
    }

    /// Enable metrics collection with HTTP endpoint (accepts string address)
    ///
    /// This is a convenience method that accepts a string address and parses it internally.
    ///
    /// # Arguments
    /// * `bind_address` - Address string to bind the metrics server (e.g., "0.0.0.0:9090")
    ///
    /// # Example
    ///
    /// ```rust
    /// use rediq::server::{Server, ServerBuilder};
    ///
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let state = ServerBuilder::new()
    ///     .redis_url("redis://localhost:6379")
    ///     .queues(&["default"])
    ///     .build()
    ///     .await?;
    ///
    /// let mut server = Server::from(state);
    /// server.enable_metrics_on("0.0.0.0:9090")?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn enable_metrics_on(&mut self, bind_address: impl Into<String>) -> Result<()> {
        let addr_str = bind_address.into();
        let addr = addr_str.parse::<SocketAddr>()
            .map_err(|e| Error::Config(format!("Invalid metrics address '{}': {}", addr_str, e)))?;
        self.enable_metrics(addr)
    }

    /// Run the server
    ///
    /// This method:
    /// 1. Starts the scheduler (if enabled)
    /// 2. Creates and starts the configured number of workers
    /// 3. Waits for Ctrl+C signal
    /// 4. Initiates graceful shutdown
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - Worker initialization fails
    /// - Scheduler fails to start
    pub async fn run(self, mux: Mux) -> Result<()> {
        tracing::info!("Starting Rediq Server: {}", self.state.config.server_name);
        tracing::info!("Queues: {:?}", self.state.config.queues);
        tracing::info!("Concurrency: {}", self.state.config.concurrency);

        let mux = Arc::new(tokio::sync::Mutex::new(mux));
        let mut join_set = JoinSet::new();

        // Start metrics HTTP server if enabled
        #[cfg(feature = "metrics-http")]
        if let (Some(metrics), Some(bind_address)) = (self.metrics.clone(), self.metrics_bind_address) {
            use crate::observability::http_server::MetricsServer;
            let metrics_server = MetricsServer::new(metrics, bind_address);
            let metrics_server_shutdown = self.shutdown.clone();

            join_set.spawn(async move {
                let result = metrics_server.run().await;
                // Signal shutdown if metrics server exits
                metrics_server_shutdown.store(true, Ordering::SeqCst);
                result
            });

            tracing::info!("Metrics HTTP server started on http://{}", bind_address);
        }

        // Start scheduler if enabled
        if self.state.config.enable_scheduler {
            let scheduler = Scheduler::new(
                self.state.redis.clone(),
                self.state.config.queues.clone(),
            );

            let scheduler_shutdown = self.shutdown.clone();
            tokio::spawn(async move {
                let result = scheduler.run().await;
                // Signal shutdown on scheduler exit
                scheduler_shutdown.store(true, Ordering::SeqCst);
                result
            });

            // Track scheduler for graceful shutdown
            // Note: We don't add scheduler to join_set as it manages its own lifecycle
            tracing::info!("Scheduler started");
        }

        // Start janitor if configured
        if let Some(janitor_config) = &self.state.config.janitor_config {
            let janitor = Janitor::new(self.state.redis.clone(), janitor_config.clone());
            let janitor_shutdown = janitor.shutdown_handle();
            let _shutdown = self.shutdown.clone();

            tokio::spawn(async move {
                janitor.run().await;
                // Signal shutdown if janitor exits unexpectedly
                _shutdown.store(true, Ordering::SeqCst);
            });

            // Store janitor handle for graceful shutdown
            tokio::spawn(async move {
                tokio::signal::ctrl_c().await.ok();
                janitor_shutdown.store(true, Ordering::SeqCst);
            });

            tracing::info!("Janitor started (interval: {:?})", janitor_config.interval);
        }

        // Create and start workers
        for i in 0..self.state.config.concurrency {
            let worker = self.create_worker(i, mux.clone())?;
            let _shutdown = self.shutdown.clone();
            let count = self.worker_count.clone();

            count.fetch_add(1, Ordering::Relaxed);

            join_set.spawn(async move {
                let result = worker.run().await;
                count.fetch_sub(1, Ordering::Relaxed);
                result
            });
        }

        tracing::info!("Started {} workers", self.state.config.concurrency);

        // Wait for shutdown signal
        tokio::select! {
            _ = tokio::signal::ctrl_c() => {
                tracing::info!("Received shutdown signal");
                self.shutdown.store(true, Ordering::SeqCst);
            }
        }

        // Graceful shutdown
        self.graceful_shutdown(&mut join_set).await?;

        tracing::info!("Server stopped");
        Ok(())
    }

    /// Create a new worker
    fn create_worker(&self, index: usize, mux: Arc<Mutex<Mux>>) -> Result<Worker> {
        let worker_id = format!(
            "{}-worker-{}",
            self.state.config.server_name,
            index
        );

        Ok(Worker::new(
            worker_id,
            self.state.clone(),
            self.shutdown.clone(),
            mux,
        ))
    }

    /// Graceful shutdown
    ///
    /// Waits for workers to finish their current tasks or timeout.
    async fn graceful_shutdown(&self, join_set: &mut JoinSet<Result<()>>) -> Result<()> {
        tracing::info!("Initiating graceful shutdown");

        let timeout = Duration::from_secs(30);
        let start = std::time::Instant::now();
        let initial_count = self.worker_count.load(Ordering::Relaxed);

        while initial_count > 0 && start.elapsed() < timeout {
            if let Some(result) = join_set.join_next().await {
                if let Err(e) = result {
                    tracing::error!("Worker error during shutdown: {}", e);
                }
            } else {
                break;
            }
        }

        // Force shutdown remaining workers
        let remaining = self.worker_count.load(Ordering::Relaxed);
        if remaining > 0 {
            tracing::warn!("Force shutting down {} workers", remaining);
        }

        while let Some(result) = join_set.join_next().await {
            if let Err(e) = result {
                tracing::error!("Worker error: {}", e);
            }
        }

        Ok(())
    }

    /// Get server statistics
    pub fn stats(&self) -> ServerStats {
        ServerStats {
            server_name: self.state.config.server_name.clone(),
            active_workers: self.worker_count.load(Ordering::Relaxed),
            queues: self.state.config.queues.clone(),
        }
    }
}

/// Server statistics
#[derive(Debug, Clone)]
pub struct ServerStats {
    /// Server name
    pub server_name: String,

    /// Number of active workers
    pub active_workers: usize,

    /// Queues being processed
    pub queues: Vec<String>,
}

impl From<ServerState> for Server {
    fn from(state: ServerState) -> Self {
        Self::new(state)
    }
}

/// Convenience function to create and run a server
///
/// # Example
///
/// ```rust
/// use rediq::server::run_server;
/// use rediq::processor::{Handler, Mux};
/// use async_trait::async_trait;
///
/// # struct MyHandler;
/// # #[async_trait]
/// # impl Handler for MyHandler {
/// #     async fn handle(&self, task: &rediq::Task) -> rediq::Result<()> {
/// #         Ok(())
/// #     }
/// # }
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let mut mux = Mux::new();
/// mux.handle("test", MyHandler);
///
/// run_server(
///     "redis://localhost:6379",
///     &["default"],
///     mux,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn run_server(
    redis_url: impl Into<String>,
    queues: &[&str],
    mux: Mux,
) -> Result<()> {
    let state = ServerBuilder::new()
        .redis_url(redis_url)
        .queues(queues)
        .build()
        .await?;

    let server = Server::from(state);
    server.run(mux).await
}

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

    #[tokio::test]
    #[ignore = "Requires Redis server"]
    async fn test_server_creation() {
        let redis_url = std::env::var("REDIS_URL")
            .unwrap_or_else(|_| "redis://localhost:6379".to_string());
        let state = ServerBuilder::new()
            .redis_url(&redis_url)
            .queues(&["default"])
            .concurrency(5)
            .build()
            .await
            .unwrap();

        let server = Server::new(state);
        let stats = server.stats();

        assert_eq!(stats.queues, vec!["default"]);
    }
}