celers-protocol 0.2.0

Celery Protocol v2/v5 implementation for CeleRS
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
//! Message transformation middleware
//!
//! This module provides a middleware pattern for transforming messages through
//! a pipeline of transformations (validation, signing, encryption, etc.).
//!
//! # Example
//!
//! ```
//! use celers_protocol::middleware::{MessagePipeline, ValidationMiddleware};
//! use celers_protocol::{Message, TaskArgs};
//! use uuid::Uuid;
//!
//! let task_id = Uuid::new_v4();
//! let body = serde_json::to_vec(&TaskArgs::new()).unwrap();
//! let msg = Message::new("tasks.add".to_string(), task_id, body);
//!
//! let mut pipeline = MessagePipeline::new();
//! pipeline.add(Box::new(ValidationMiddleware));
//!
//! let result = pipeline.process(msg);
//! assert!(result.is_ok());
//! ```

use crate::Message;
use std::fmt;

/// Middleware error
#[derive(Debug, Clone)]
pub enum MiddlewareError {
    /// Validation failed
    Validation(String),
    /// Transformation failed
    Transformation(String),
    /// Processing error
    Processing(String),
}

impl fmt::Display for MiddlewareError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            MiddlewareError::Validation(msg) => write!(f, "Validation error: {}", msg),
            MiddlewareError::Transformation(msg) => write!(f, "Transformation error: {}", msg),
            MiddlewareError::Processing(msg) => write!(f, "Processing error: {}", msg),
        }
    }
}

impl From<crate::ValidationError> for MiddlewareError {
    fn from(err: crate::ValidationError) -> Self {
        MiddlewareError::Validation(err.to_string())
    }
}

impl std::error::Error for MiddlewareError {}

/// Middleware trait for message processing
pub trait Middleware: Send + Sync {
    /// Process a message
    fn process(&self, message: Message) -> Result<Message, MiddlewareError>;

    /// Get the name of this middleware
    fn name(&self) -> &'static str;

    /// Check if this middleware should be skipped for a message
    fn should_skip(&self, _message: &Message) -> bool {
        false
    }
}

/// Message processing pipeline
pub struct MessagePipeline {
    middlewares: Vec<Box<dyn Middleware>>,
}

impl MessagePipeline {
    /// Create a new empty pipeline
    pub fn new() -> Self {
        Self {
            middlewares: Vec::new(),
        }
    }

    /// Add a middleware to the pipeline
    pub fn add(&mut self, middleware: Box<dyn Middleware>) {
        self.middlewares.push(middleware);
    }

    /// Process a message through the pipeline
    pub fn process(&self, mut message: Message) -> Result<Message, MiddlewareError> {
        for middleware in &self.middlewares {
            if !middleware.should_skip(&message) {
                message = middleware.process(message)?;
            }
        }
        Ok(message)
    }

    /// Get the number of middlewares in the pipeline
    #[inline]
    pub fn len(&self) -> usize {
        self.middlewares.len()
    }

    /// Check if the pipeline is empty
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.middlewares.is_empty()
    }

    /// Clear all middlewares
    pub fn clear(&mut self) {
        self.middlewares.clear();
    }
}

impl Default for MessagePipeline {
    fn default() -> Self {
        Self::new()
    }
}

/// Validation middleware
pub struct ValidationMiddleware;

impl Middleware for ValidationMiddleware {
    fn process(&self, message: Message) -> Result<Message, MiddlewareError> {
        message.validate().map_err(MiddlewareError::from)?;
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "validation"
    }
}

/// Size limit middleware
pub struct SizeLimitMiddleware {
    max_size: usize,
}

impl SizeLimitMiddleware {
    /// Create a new size limit middleware
    pub fn new(max_size: usize) -> Self {
        Self { max_size }
    }
}

impl Middleware for SizeLimitMiddleware {
    fn process(&self, message: Message) -> Result<Message, MiddlewareError> {
        if message.body.len() > self.max_size {
            return Err(MiddlewareError::Validation(format!(
                "Message body too large: {} bytes (max {})",
                message.body.len(),
                self.max_size
            )));
        }
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "size_limit"
    }
}

/// Retry count middleware
pub struct RetryLimitMiddleware {
    max_retries: u32,
}

impl RetryLimitMiddleware {
    /// Create a new retry limit middleware
    pub fn new(max_retries: u32) -> Self {
        Self { max_retries }
    }
}

impl Middleware for RetryLimitMiddleware {
    fn process(&self, message: Message) -> Result<Message, MiddlewareError> {
        if let Some(retries) = message.headers.retries {
            if retries > self.max_retries {
                return Err(MiddlewareError::Validation(format!(
                    "Too many retries: {} (max {})",
                    retries, self.max_retries
                )));
            }
        }
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "retry_limit"
    }
}

/// Content type validation middleware
pub struct ContentTypeMiddleware {
    allowed_types: Vec<String>,
}

impl ContentTypeMiddleware {
    /// Create a new content type middleware
    pub fn new(allowed_types: Vec<String>) -> Self {
        Self { allowed_types }
    }

    /// Create middleware that only allows JSON
    pub fn json_only() -> Self {
        Self {
            allowed_types: vec!["application/json".to_string()],
        }
    }
}

impl Middleware for ContentTypeMiddleware {
    fn process(&self, message: Message) -> Result<Message, MiddlewareError> {
        if !self.allowed_types.contains(&message.content_type) {
            return Err(MiddlewareError::Validation(format!(
                "Content type '{}' not allowed. Allowed types: {:?}",
                message.content_type, self.allowed_types
            )));
        }
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "content_type"
    }
}

/// Task name filter middleware
pub struct TaskNameFilterMiddleware {
    allowed_patterns: Vec<String>,
}

impl TaskNameFilterMiddleware {
    /// Create a new task name filter middleware
    pub fn new(allowed_patterns: Vec<String>) -> Self {
        Self { allowed_patterns }
    }

    /// Check if a task name matches any allowed pattern
    fn is_allowed(&self, task_name: &str) -> bool {
        self.allowed_patterns.iter().any(|pattern| {
            if pattern.ends_with('*') {
                task_name.starts_with(&pattern[..pattern.len() - 1])
            } else {
                task_name == pattern
            }
        })
    }
}

impl Middleware for TaskNameFilterMiddleware {
    fn process(&self, message: Message) -> Result<Message, MiddlewareError> {
        if !self.is_allowed(&message.headers.task) {
            return Err(MiddlewareError::Validation(format!(
                "Task '{}' not allowed by filter",
                message.headers.task
            )));
        }
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "task_name_filter"
    }
}

/// Priority enforcement middleware
pub struct PriorityMiddleware {
    default_priority: u8,
    enforce_limits: bool,
}

impl PriorityMiddleware {
    /// Create a new priority middleware
    pub fn new(default_priority: u8, enforce_limits: bool) -> Self {
        Self {
            default_priority,
            enforce_limits,
        }
    }
}

impl Middleware for PriorityMiddleware {
    fn process(&self, mut message: Message) -> Result<Message, MiddlewareError> {
        if message.properties.priority.is_none() {
            message.properties.priority = Some(self.default_priority);
        } else if self.enforce_limits {
            if let Some(priority) = message.properties.priority {
                if priority > 9 {
                    return Err(MiddlewareError::Validation(format!(
                        "Priority {} exceeds maximum of 9",
                        priority
                    )));
                }
            }
        }
        Ok(message)
    }

    fn name(&self) -> &'static str {
        "priority"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::TaskArgs;
    use uuid::Uuid;

    #[test]
    fn test_pipeline_new() {
        let pipeline = MessagePipeline::new();
        assert_eq!(pipeline.len(), 0);
        assert!(pipeline.is_empty());
    }

    #[test]
    fn test_pipeline_add() {
        let mut pipeline = MessagePipeline::new();
        pipeline.add(Box::new(ValidationMiddleware));
        assert_eq!(pipeline.len(), 1);
        assert!(!pipeline.is_empty());
    }

    #[test]
    fn test_pipeline_clear() {
        let mut pipeline = MessagePipeline::new();
        pipeline.add(Box::new(ValidationMiddleware));
        pipeline.clear();
        assert_eq!(pipeline.len(), 0);
    }

    #[test]
    fn test_validation_middleware() {
        let task_id = Uuid::new_v4();
        let body = serde_json::to_vec(&TaskArgs::new()).unwrap();
        let msg = Message::new("tasks.add".to_string(), task_id, body);

        let middleware = ValidationMiddleware;
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_size_limit_middleware_ok() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.test".to_string(), task_id, body);

        let middleware = SizeLimitMiddleware::new(1000);
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_size_limit_middleware_exceeded() {
        let task_id = Uuid::new_v4();
        let body = vec![0u8; 1000];
        let msg = Message::new("tasks.test".to_string(), task_id, body);

        let middleware = SizeLimitMiddleware::new(100);
        let result = middleware.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_retry_limit_middleware_ok() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let mut msg = Message::new("tasks.test".to_string(), task_id, body);
        msg.headers.retries = Some(5);

        let middleware = RetryLimitMiddleware::new(10);
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_retry_limit_middleware_exceeded() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let mut msg = Message::new("tasks.test".to_string(), task_id, body);
        msg.headers.retries = Some(15);

        let middleware = RetryLimitMiddleware::new(10);
        let result = middleware.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_content_type_middleware_allowed() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.test".to_string(), task_id, body);

        let middleware = ContentTypeMiddleware::json_only();
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_content_type_middleware_blocked() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let mut msg = Message::new("tasks.test".to_string(), task_id, body);
        msg.content_type = "application/pickle".to_string();

        let middleware = ContentTypeMiddleware::json_only();
        let result = middleware.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_task_name_filter_exact_match() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.allowed".to_string(), task_id, body);

        let middleware = TaskNameFilterMiddleware::new(vec!["tasks.allowed".to_string()]);
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_task_name_filter_wildcard() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.something.add".to_string(), task_id, body);

        let middleware = TaskNameFilterMiddleware::new(vec!["tasks.*".to_string()]);
        let result = middleware.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_task_name_filter_blocked() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("forbidden.task".to_string(), task_id, body);

        let middleware = TaskNameFilterMiddleware::new(vec!["tasks.*".to_string()]);
        let result = middleware.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_priority_middleware_default() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.test".to_string(), task_id, body);

        let middleware = PriorityMiddleware::new(5, false);
        let result = middleware.process(msg).unwrap();
        assert_eq!(result.properties.priority, Some(5));
    }

    #[test]
    fn test_priority_middleware_enforce_limits() {
        let task_id = Uuid::new_v4();
        let body = vec![1, 2, 3];
        let msg = Message::new("tasks.test".to_string(), task_id, body).with_priority(15);

        let middleware = PriorityMiddleware::new(5, true);
        let result = middleware.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_pipeline_process() {
        let task_id = Uuid::new_v4();
        let body = serde_json::to_vec(&TaskArgs::new()).unwrap();
        let msg = Message::new("tasks.add".to_string(), task_id, body);

        let mut pipeline = MessagePipeline::new();
        pipeline.add(Box::new(ValidationMiddleware));
        pipeline.add(Box::new(SizeLimitMiddleware::new(10000)));

        let result = pipeline.process(msg);
        assert!(result.is_ok());
    }

    #[test]
    fn test_pipeline_process_failure() {
        let task_id = Uuid::new_v4();
        let body = vec![0u8; 1000];
        let msg = Message::new("tasks.test".to_string(), task_id, body);

        let mut pipeline = MessagePipeline::new();
        pipeline.add(Box::new(ValidationMiddleware));
        pipeline.add(Box::new(SizeLimitMiddleware::new(100)));

        let result = pipeline.process(msg);
        assert!(result.is_err());
    }

    #[test]
    fn test_middleware_error_display() {
        let err = MiddlewareError::Validation("test error".to_string());
        assert_eq!(err.to_string(), "Validation error: test error");

        let err = MiddlewareError::Transformation("transform failed".to_string());
        assert_eq!(err.to_string(), "Transformation error: transform failed");

        let err = MiddlewareError::Processing("process error".to_string());
        assert_eq!(err.to_string(), "Processing error: process error");
    }
}