foxtive-worker 0.1.0

Foxtive Worker - Background worker framework for message processing
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
use async_trait::async_trait;
use std::sync::Arc;
use tokio::sync::Mutex;
use std::time::{Duration, Instant};

use crate::error::{WorkerError, WorkerResult};
use crate::message::ReceivedMessage;
use crate::middleware::{MessageHandler, Middleware};

/// Circuit breaker state.
#[derive(Debug, Clone, PartialEq)]
pub enum CircuitState {
    /// Circuit is closed, requests flow normally
    Closed,
    
    /// Circuit is open, requests are rejected
    Open,
    
    /// Circuit is half-open, testing if service recovered
    HalfOpen,
}

/// Circuit breaker configuration and state.
struct CircuitBreakerState {
    /// Current state of the circuit breaker
    state: CircuitState,
    /// Number of consecutive failures
    failure_count: u32,
    /// Maximum failures before opening circuit
    max_failures: u32,
    /// Time to wait before transitioning from Open to HalfOpen
    timeout: Duration,
    /// When the circuit was opened
    opened_at: Option<Instant>,
    /// Number of successes in HalfOpen state needed to close
    success_threshold: u32,
    /// Current successes in HalfOpen state
    half_open_successes: u32,
    /// Flag to ensure only one request is allowed through in HalfOpen state
    test_request_in_progress: bool,
}

impl CircuitBreakerState {
    fn new(max_failures: u32, timeout: Duration, success_threshold: u32) -> Self {
        Self {
            state: CircuitState::Closed,
            failure_count: 0,
            max_failures,
            timeout,
            opened_at: None,
            success_threshold,
            half_open_successes: 0,
            test_request_in_progress: false, // Initialize the new flag
        }
    }

    fn should_allow_request(&mut self) -> bool {
        match self.state {
            CircuitState::Closed => true,
            CircuitState::Open => {
                // Check if timeout has elapsed
                if let Some(opened_at) = self.opened_at
                    && opened_at.elapsed() >= self.timeout {
                        // Transition to HalfOpen and allow one test request
                        self.state = CircuitState::HalfOpen;
                        self.half_open_successes = 0;
                        self.test_request_in_progress = true; // This request is the test request
                        return true;
                    }
                false // Still in Open state, timeout not elapsed
            }
            CircuitState::HalfOpen => {
                // Only allow one request through in HalfOpen state
                if !self.test_request_in_progress {
                    self.test_request_in_progress = true;
                    true
                } else {
                    false // Another request is already testing
                }
            }
        }
    }

    fn record_success(&mut self) {
        match self.state {
            CircuitState::Closed => {
                // Reset failure count on success
                self.failure_count = 0;
            }
            CircuitState::HalfOpen => {
                // Don't reset test_request_in_progress here - keep blocking additional requests
                self.half_open_successes += 1;
                if self.half_open_successes >= self.success_threshold {
                    // Transition to Closed
                    self.state = CircuitState::Closed;
                    self.failure_count = 0;
                    self.opened_at = None;
                    self.test_request_in_progress = false; // Reset flag when closing circuit
                }
            }
            CircuitState::Open => {
                // Should not happen if `should_allow_request` is respected
            }
        }
    }

    fn record_failure(&mut self) {
        match self.state {
            CircuitState::Closed => {
                self.failure_count += 1;
                if self.failure_count >= self.max_failures {
                    // Open the circuit
                    self.state = CircuitState::Open;
                    self.opened_at = Some(Instant::now());
                }
            }
            CircuitState::HalfOpen => {
                // Any failure in HalfOpen reopens the circuit
                self.test_request_in_progress = false; // Test request completed (with failure)
                self.state = CircuitState::Open;
                self.opened_at = Some(Instant::now());
                self.half_open_successes = 0;
            }
            CircuitState::Open => {
                // Already open, do nothing
            }
        }
    }

    fn current_state(&self) -> &CircuitState {
        &self.state
    }
}

/// Middleware that implements the circuit breaker pattern.
///
/// The circuit breaker protects downstream services from being overwhelmed
/// when they're failing. It has three states:
/// - **Closed**: Normal operation, requests pass through
/// - **Open**: Requests are rejected immediately (fail fast)
/// - **HalfOpen**: Testing if service recovered with limited requests
///
/// # Example
/// ```rust,no_run
/// use foxtive_worker::CircuitBreakerMiddleware;
/// use std::time::Duration;
///
/// // Open circuit after 5 failures, retry after 30 seconds
/// let middleware = CircuitBreakerMiddleware::new(5, Duration::from_secs(30));
/// ```
pub struct CircuitBreakerMiddleware {
    state: Arc<Mutex<CircuitBreakerState>>,
    name: String,
}

impl std::fmt::Debug for CircuitBreakerMiddleware {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("CircuitBreakerMiddleware")
            .field("name", &self.name)
            .finish()
    }
}

impl CircuitBreakerMiddleware {
    /// Create a new circuit breaker middleware.
    ///
    /// # Arguments
    /// * `max_failures` - Number of consecutive failures before opening circuit
    /// * `timeout` - Time to wait before transitioning from Open to HalfOpen
    pub fn new(max_failures: u32, timeout: Duration) -> Self {
        Self {
            state: Arc::new(Mutex::new(CircuitBreakerState::new(
                max_failures,
                timeout,
                1, // Default: 1 success to close
            ))),
            name: format!("circuit-breaker-{}failures", max_failures),
        }
    }

    /// Create a circuit breaker with custom success threshold.
    pub fn with_threshold(max_failures: u32, timeout: Duration, success_threshold: u32) -> Self {
        Self {
            state: Arc::new(Mutex::new(CircuitBreakerState::new(
                max_failures,
                timeout,
                success_threshold,
            ))),
            name: format!("circuit-breaker-{}failures", max_failures),
        }
    }

    /// Get the current circuit state.
    pub async fn get_state(&self) -> CircuitState {
        let mut state = self.state.lock().await;
        // Check if Open state should transition to HalfOpen
        if state.current_state() == &CircuitState::Open
            && let Some(opened_at) = state.opened_at
                && opened_at.elapsed() >= state.timeout {
                    state.state = CircuitState::HalfOpen;
                    state.half_open_successes = 0;
                    // Don't reset test_request_in_progress here - it will be set by should_allow_request
                }
        state.current_state().clone()
    }
}

#[async_trait]
impl Middleware for CircuitBreakerMiddleware {
    fn name(&self) -> &str {
        &self.name
    }

    async fn handle(
        &self,
        message: ReceivedMessage<serde_json::Value>,
        next: Box<dyn MessageHandler>,
    ) -> WorkerResult<()> {
        // Check if request should be allowed
        {
            let mut state = self.state.lock().await;
            if !state.should_allow_request() {
                return Err(WorkerError::ProcessingFailed(format!(
                    "Circuit breaker '{}' is open, rejecting request",
                    self.name
                )));
            }
        }

        // Process the message
        let result = next.handle(message).await;

        // Record success or failure
        {
            let mut state = self.state.lock().await;
            match result {
                Ok(_) => state.record_success(),
                Err(_) => state.record_failure(),
            }
        }

        result
    }
}

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

    struct SuccessHandler;

    #[async_trait]
    impl MessageHandler for SuccessHandler {
        async fn handle(&self, _message: ReceivedMessage<serde_json::Value>) -> WorkerResult<()> {
            Ok(())
        }
    }

    struct FailureHandler;

    #[async_trait]
    impl MessageHandler for FailureHandler {
        async fn handle(&self, _message: ReceivedMessage<serde_json::Value>) -> WorkerResult<()> {
            Err(WorkerError::ProcessingFailed("test failure".to_string()))
        }
    }

    fn create_test_message() -> ReceivedMessage<serde_json::Value> {
        use crate::message::{Message, MessageMetadata, AckHandle};

        #[derive(Debug)]
        struct MockAckHandle;

        #[async_trait]
        impl AckHandle for MockAckHandle {
            async fn ack(&self) -> WorkerResult<()> {
                Ok(())
            }

            async fn nack(&self, _requeue: bool) -> WorkerResult<()> {
                Ok(())
            }
        }

        let message = Message {
            id: "test-1".to_string(),
            payload: serde_json::json!({"test": "data"}),
            metadata: MessageMetadata::new("test-queue"),
        };
        ReceivedMessage::new(message, Arc::new(MockAckHandle))
    }

    #[tokio::test]
    async fn test_circuit_closed_initially() {
        let middleware = CircuitBreakerMiddleware::new(3, Duration::from_secs(1));
        assert_eq!(middleware.get_state().await, CircuitState::Closed);
    }

    #[tokio::test]
    async fn test_circuit_opens_after_max_failures() {
        let middleware = CircuitBreakerMiddleware::new(3, Duration::from_secs(1));

        // Cause 3 failures
        for _ in 0..3 {
            let message = create_test_message();
            let _ = middleware.handle(message, Box::new(FailureHandler)).await;
        }

        assert_eq!(middleware.get_state().await, CircuitState::Open);
    }

    #[tokio::test]
    async fn test_circuit_rejects_when_open() {
        let middleware = CircuitBreakerMiddleware::new(2, Duration::from_secs(1));

        // Open the circuit
        for _ in 0..2 {
            let message = create_test_message();
            let _ = middleware.handle(message, Box::new(FailureHandler)).await;
        }

        // Next request should be rejected
        let message = create_test_message();
        let result = middleware.handle(message, Box::new(SuccessHandler)).await;
        assert!(result.is_err());
        assert!(matches!(result, Err(WorkerError::ProcessingFailed(_))));
    }

    #[tokio::test]
    async fn test_circuit_transitions_to_half_open_and_allows_one_request() {
        let middleware = CircuitBreakerMiddleware::new(2, Duration::from_millis(100));

        // Open the circuit
        for _ in 0..2 {
            let message = create_test_message();
            let _ = middleware.handle(message, Box::new(FailureHandler)).await;
        }

        assert_eq!(middleware.get_state().await, CircuitState::Open);

        // Wait for timeout
        time::sleep(Duration::from_millis(150)).await;

        // Should transition to HalfOpen and allow the first request
        let message1 = create_test_message();
        let result1 = middleware.handle(message1, Box::new(SuccessHandler)).await;
        assert!(result1.is_ok());
        assert_eq!(middleware.get_state().await, CircuitState::Closed); // Should close after 1 success with default threshold

        // If it were still HalfOpen, a second request should be rejected
        let middleware_half_open_test = CircuitBreakerMiddleware::with_threshold(2, Duration::from_millis(100), 2); // Need 2 successes to close
        for _ in 0..2 {
            let message = create_test_message();
            let _ = middleware_half_open_test.handle(message, Box::new(FailureHandler)).await;
        }
        time::sleep(Duration::from_millis(150)).await;
        assert_eq!(middleware_half_open_test.get_state().await, CircuitState::HalfOpen);

        let message_test_1 = create_test_message();
        assert!(middleware_half_open_test.handle(message_test_1, Box::new(SuccessHandler)).await.is_ok());
        assert_eq!(middleware_half_open_test.get_state().await, CircuitState::HalfOpen); // Still HalfOpen, 1 success recorded

        let message_test_2 = create_test_message();
        let result_test_2 = middleware_half_open_test.handle(message_test_2, Box::new(SuccessHandler)).await;
        assert!(result_test_2.is_err()); // Second request should be rejected
        assert!(matches!(result_test_2, Err(WorkerError::ProcessingFailed(_))));
        assert_eq!(middleware_half_open_test.get_state().await, CircuitState::HalfOpen); // Still HalfOpen
    }

    #[tokio::test]
    async fn test_circuit_closes_after_success_in_half_open() {
        let middleware = CircuitBreakerMiddleware::new(2, Duration::from_millis(100));

        // Open the circuit
        for _ in 0..2 {
            let message = create_test_message();
            let _ = middleware.handle(message, Box::new(FailureHandler)).await;
        }

        // Wait for timeout
        time::sleep(Duration::from_millis(150)).await;

        // Success in HalfOpen should close circuit (with default success_threshold = 1)
        let message = create_test_message();
        middleware.handle(message, Box::new(SuccessHandler)).await.unwrap();

        assert_eq!(middleware.get_state().await, CircuitState::Closed);
    }

    #[tokio::test]
    async fn test_circuit_reopens_on_failure_in_half_open() {
        let middleware = CircuitBreakerMiddleware::new(2, Duration::from_millis(100));

        // Open the circuit
        for _ in 0..2 {
            let message = create_test_message();
            let _ = middleware.handle(message, Box::new(FailureHandler)).await;
        }

        // Wait for timeout
        time::sleep(Duration::from_millis(150)).await;

        // Failure in HalfOpen should reopen circuit
        let message = create_test_message();
        let _ = middleware.handle(message, Box::new(FailureHandler)).await;

        assert_eq!(middleware.get_state().await, CircuitState::Open);
    }
}