backbone-queue 2.7.35

Backbone Framework Queue Module - Redis, SQS, and RabbitMQ support
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
//! Integration tests for Backbone Queue Module

use backbone_queue::{
    QueueService, QueueMessage, QueuePriority, QueueBackend, MessageStatus, QueueHealth,
    redis::{RedisQueue, RedisQueueBuilder},
    sqs::{SqsQueue, SqsQueueBuilder},
};
use std::collections::HashMap;
use std::time::Duration;
use tokio::time::sleep;
use uuid::Uuid;

/// Test configuration
struct TestConfig {
    redis_url: String,
    sqs_region: String,
    sqs_queue_url: String,
}

impl Default for TestConfig {
    fn default() -> Self {
        Self {
            redis_url: std::env::var("REDIS_TEST_URL")
                .unwrap_or_else(|_| "redis://localhost:6379".to_string()),
            sqs_region: std::env::var("AWS_REGION")
                .unwrap_or_else(|_| "us-east-1".to_string()),
            sqs_queue_url: std::env::var("SQS_QUEUE_URL")
                .unwrap_or_else(|_| "https://sqs.us-east-1.amazonaws.com/123456789012/test-queue".to_string()),
        }
    }
}

/// Create test message with various attributes
fn create_test_message_with_id(id: &str) -> QueueMessage {
    let mut attributes = HashMap::new();
    attributes.insert("test_id".to_string(), id.to_string());
    attributes.insert("source".to_string(), "integration_test".to_string());
    attributes.insert("version".to_string(), "1.0".to_string());

    QueueMessage::builder()
        .id(id.to_string())
        .text_payload(format!("Integration test message {}", id))
        .priority(QueuePriority::Normal)
        .attributes(attributes)
        .visibility_timeout(30)
        .max_receive_count(3)
        .build()
}

/// Create test message with specific priority
fn create_test_message_with_priority(id: &str, priority: QueuePriority) -> QueueMessage {
    QueueMessage::builder()
        .id(id.to_string())
        .text_payload(format!("Test message {} with {:?} priority", id, priority))
        .priority(priority)
        .visibility_timeout(30)
        .max_receive_count(3)
        .build()
}

/// Redis integration tests
#[cfg(test)]
mod redis_integration_tests {
    use super::*;

    /// Create test Redis queue
    async fn create_test_redis_queue() -> Result<RedisQueue, Box<dyn std::error::Error>> {
        let config = RedisQueueBuilder::new()
            .url(&TestConfig::default().redis_url)
            .queue_name(format!("integration_test_{}", Uuid::new_v4().to_string().replace("-", "")))
            .key_prefix("test_integration")
            .pool_size(2)
            .build()
            .await?;

        // Clear any existing data
        config.purge().await?;

        Ok(config)
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_end_to_end_workflow() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Test basic enqueue/dequeue
        let message = create_test_message_with_id("test-1");
        let message_id = queue.enqueue(message.clone()).await?;
        assert_eq!(message_id, "test-1");

        // Verify queue size
        assert_eq!(queue.size().await?, 1);
        assert!(!queue.is_empty().await?);

        // Dequeue message
        let dequeued = queue.dequeue().await?;
        assert!(dequeued.is_some());

        let received_message = dequeued.unwrap();
        assert_eq!(received_message.id, "test-1");
        assert_eq!(received_message.payload, message.payload);

        // Acknowledge message
        let ack_result = queue.ack(&message_id).await?;
        assert!(ack_result);

        // Queue should be empty now
        sleep(Duration::from_millis(100)).await; // Give time for ack to process
        assert!(queue.is_empty().await?);

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_priority_ordering() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Enqueue messages in random order
        let messages = vec![
            create_test_message_with_priority("low", QueuePriority::Low),
            create_test_message_with_priority("critical", QueuePriority::Critical),
            create_test_message_with_priority("normal", QueuePriority::Normal),
            create_test_message_with_priority("high", QueuePriority::High),
        ];

        // Enqueue messages in different order to test priority-based ordering
        for message in &messages {
            queue.enqueue(message.clone()).await?;
        }

        // Dequeue and verify priority order
        let mut received_priorities = Vec::new();
        for _ in 0..4 {
            if let Some(message) = queue.dequeue().await? {
                received_priorities.push(message.priority);
                queue.ack(&message.id).await?;
            }
        }

        // Should be in priority order: Critical, High, Normal, Low
        assert_eq!(received_priorities, vec![
            QueuePriority::Critical,
            QueuePriority::High,
            QueuePriority::Normal,
            QueuePriority::Low,
        ]);

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_batch_operations() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Create multiple messages
        let mut messages = Vec::new();
        for i in 0..10 {
            messages.push(create_test_message_with_id(&format!("batch-{}", i)));
        }

        // Batch enqueue
        let message_ids = queue.enqueue_batch(messages.clone()).await?;
        assert_eq!(message_ids.len(), 10);

        // Verify queue size
        assert_eq!(queue.size().await?, 10);

        // Batch dequeue
        let batch_result = queue.dequeue_batch(5).await?;
        assert_eq!(batch_result.messages.len(), 5);
        assert_eq!(batch_result.available, 5);
        assert_eq!(batch_result.total_in_queue, 5);

        // Batch acknowledge
        let ack_ids: Vec<String> = batch_result.messages
            .into_iter()
            .map(|m| m.id)
            .collect();

        let ack_count = queue.ack_batch(ack_ids).await?;
        assert_eq!(ack_count, 5);

        // Verify remaining messages
        assert_eq!(queue.size().await?, 5);

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_dead_letter_queue() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Create message with low max receive count
        let message = QueueMessage::builder()
            .id("dead-letter-test")
            .text_payload("Test dead letter")
            .max_receive_count(2)
            .visibility_timeout(1)
            .build();

        queue.enqueue(message).await?;

        // Receive and nack message to exceed max receive count
        for i in 0..3 {
            let dequeued = queue.dequeue().await?;
            assert!(dequeued.is_some(), "Should receive message on attempt {}", i + 1);

            let received_msg = dequeued.unwrap();
            queue.nack(&received_msg.id, None).await?;
        }

        // Message should not be in regular queue anymore
        let final_dequeue = queue.dequeue().await?;
        assert!(final_dequeue.is_none());

        // But should be retrievable from dead letter queue
        let dead_message = queue.get_message("dead-letter-test").await?;
        assert!(dead_message.is_some());
        assert_eq!(dead_message.unwrap().status, MessageStatus::DeadLettered);

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_visibility_timeout() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Create message with short visibility timeout
        let message = QueueMessage::builder()
            .id("visibility-test")
            .text_payload("Test visibility")
            .visibility_timeout(2) // 2 seconds
            .build();

        queue.enqueue(message).await?;

        // Dequeue message
        let dequeued = queue.dequeue().await?;
        assert!(dequeued.is_some());

        // Immediately try to dequeue again (should not be available)
        let immediate_dequeue = queue.dequeue().await?;
        assert!(immediate_dequeue.is_none());

        // Wait for visibility timeout to expire
        sleep(Duration::from_secs(3)).await;

        // Should be available again
        let delayed_dequeue = queue.dequeue().await?;
        assert!(delayed_dequeue.is_some());
        assert_eq!(delayed_dequeue.unwrap().id, "visibility-test");

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires Redis server
    async fn test_redis_statistics_and_health() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_redis_queue().await?;

        // Initial stats
        let initial_stats = queue.get_stats().await?;
        assert_eq!(initial_stats.visible_messages, 0);
        assert_eq!(initial_stats.invisible_messages, 0);

        // Add some messages
        queue.enqueue_batch(vec![
            create_test_message_with_id("stats-1"),
            create_test_message_with_id("stats-2"),
            create_test_message_with_id("stats-3"),
        ]).await?;

        // Check stats after enqueue
        let enqueue_stats = queue.get_stats().await?;
        assert_eq!(enqueue_stats.visible_messages, 3);
        assert_eq!(enqueue_stats.total_messages, 3);

        // Dequeue one message
        queue.dequeue().await?;

        // Check stats after dequeue
        let dequeue_stats = queue.get_stats().await?;
        assert_eq!(dequeue_stats.visible_messages, 2);
        assert_eq!(dequeue_stats.invisible_messages, 1);
        assert_eq!(dequeue_stats.total_messages, 3);

        // Health check
        let health = queue.health_check().await?;
        assert!(matches!(health.status, QueueHealth::Healthy | QueueHealth::Degraded));
        assert_eq!(health.queue_size, 3);

        Ok(())
    }
}

/// SQS integration tests
#[cfg(test)]
mod sqs_integration_tests {
    use super::*;

    /// Create test SQS queue
    async fn create_test_sqs_queue() -> Result<SqsQueue, Box<dyn std::error::Error>> {
        let config = SqsQueueBuilder::new()
            .queue_url(&TestConfig::default().sqs_queue_url)
            .region(&TestConfig::default().sqs_region)
            .visibility_timeout(30)
            .wait_time_seconds(5)
            .build()
            .await?;

        Ok(config)
    }

    #[tokio::test]
    #[ignore] // Requires AWS credentials and SQS queue
    async fn test_sqs_queue_creation() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_sqs_queue().await?;

        // Verify backend type
        assert_eq!(queue.backend_type(), QueueBackend::Sqs);

        // Test validation
        let validation_result = queue.validate_config().await?;
        // Note: This might fail without proper AWS credentials, which is expected
        println!("SQS queue validation result: {:?}", validation_result);

        // Test health check
        let health = queue.health_check().await?;
        assert!(matches!(health.status, QueueHealth::Healthy | QueueHealth::Degraded | QueueHealth::Unhealthy));

        Ok(())
    }

    #[tokio::test]
    #[ignore] // Requires AWS credentials and SQS queue
    async fn test_sqs_queue_stats() -> Result<(), Box<dyn std::error::Error>> {
        let queue = create_test_sqs_queue().await?;

        // Test statistics retrieval
        let stats = queue.get_stats().await?;
        println!("SQS queue stats: {:?}", stats);

        // Test queue size
        let size = queue.size().await?;
        println!("SQS queue size: {}", size);

        // Test empty check
        let is_empty = queue.is_empty().await?;
        println!("SQS queue is empty: {}", is_empty);

        Ok(())
    }
}

/// Cross-backend compatibility tests
#[cfg(test)]
mod compatibility_tests {
    use super::*;

    #[tokio::test]
    async fn test_message_builder_compatibility() -> Result<(), Box<dyn std::error::Error>> {
        // Test that message building works consistently across backends

        // Create comprehensive message
        let mut attributes = HashMap::new();
        attributes.insert("source".to_string(), "compatibility_test".to_string());
        attributes.insert("environment".to_string(), "test".to_string());

        let message = QueueMessage::builder()
            .id("compatibility-test")
            .text_payload("Compatibility test message")
            .priority(QueuePriority::High)
            .max_receive_count(5)
            .visibility_timeout(120)
            .delay(10)
            .expires_in(3600)
            .attributes(attributes)
            .message_group_id("compat-group".to_string())
            .message_deduplication_id("compat-dedup".to_string())
            .compress(true)
            .build();

        // Verify all properties are set correctly
        assert_eq!(message.id, "compatibility-test");
        assert_eq!(message.priority, QueuePriority::High);
        assert_eq!(message.max_receive_count, 5);
        assert_eq!(message.visibility_timeout, 120);
        assert_eq!(message.delay_seconds, Some(10));
        assert!(message.expires_at.is_some());
        assert_eq!(message.message_group_id, Some("compat-group".to_string()));
        assert_eq!(message.message_deduplication_id, Some("compat-dedup".to_string()));
        assert!(message.compressed);
        assert!(message.attributes.contains_key("source"));

        // Test message validation
        assert!(message.validate().is_ok());

        // Test message size calculation
        let size = message.size_bytes()?;
        assert!(size > 0);

        Ok(())
    }

    #[tokio::test]
    async fn test_priority_level_consistency() -> Result<(), Box<dyn std::error::Error>> {
        // Test that priority levels are consistent across backends
        let priorities = vec![
            (QueuePriority::Low, 1, "Low"),
            (QueuePriority::Normal, 5, "Normal"),
            (QueuePriority::High, 10, "High"),
            (QueuePriority::Critical, 20, "Critical"),
        ];

        for (priority, expected_value, expected_display) in priorities {
            // Test numeric conversion
            assert_eq!(priority as i32, expected_value);

            // Test from i32 conversion
            let converted = QueuePriority::from(expected_value);
            assert_eq!(converted, priority);

            // Test display format
            let display = priority.to_string();
            assert_eq!(display, expected_display);

            // Test comparison operations
            assert!(priority >= QueuePriority::Low);
            assert!(priority <= QueuePriority::Critical);
        }

        Ok(())
    }

    #[tokio::test]
    async fn test_queue_service_trait_compatibility() -> Result<(), Box<dyn std::error::Error>> {
        // Test that both Redis and SQS implement the same trait interface

        let config = TestConfig::default();

        // Test Redis queue (if Redis is available)
        if let Ok(redis_queue) = RedisQueueBuilder::new()
            .url(&config.redis_url)
            .queue_name("trait-test")
            .build()
            .await
        {
            // Test trait methods exist and return expected types
            assert_eq!(redis_queue.backend_type(), QueueBackend::Redis);

            let stats = redis_queue.get_stats().await?;
            assert_eq!(stats.visible_messages, 0); // Should be empty for new queue

            let health = redis_queue.health_check().await?;
            assert!(matches!(health.status, QueueHealth::Healthy | QueueHealth::Degraded | QueueHealth::Unhealthy));
        }

        // Test SQS queue (if AWS credentials and a real SQS endpoint are
        // reachable). `build()` is lazy: a follow-up dispatch error means
        // we're offline and should skip rather than fail the trait check.
        if let Ok(sqs_queue) = SqsQueueBuilder::new()
            .queue_url(&config.sqs_queue_url)
            .region(&config.sqs_region)
            .build()
            .await
        {
            assert_eq!(sqs_queue.backend_type(), QueueBackend::Sqs);
            if let Ok(health) = sqs_queue.health_check().await {
                assert!(matches!(
                    health.status,
                    QueueHealth::Healthy | QueueHealth::Degraded | QueueHealth::Unhealthy
                ));
            }
        }

        Ok(())
    }

    #[tokio::test]
    async fn test_error_handling_consistency() -> Result<(), Box<dyn std::error::Error>> {
        // Test that error handling is consistent across backends

        // Create message that will fail validation
        let invalid_message = QueueMessage::builder()
            .id("") // Empty ID should fail validation
            .text_payload("Invalid message")
            .visibility_timeout(0) // Zero timeout should fail validation
            .build();

        // Test validation fails consistently
        let validation_result = invalid_message.validate();
        assert!(validation_result.is_err());

        // Test that queue services handle invalid messages gracefully
        let config = TestConfig::default();

        // Test with Redis if available
        if let Ok(redis_queue) = RedisQueueBuilder::new()
            .url(&config.redis_url)
            .queue_name("error-test")
            .build()
            .await
        {
            let result = redis_queue.enqueue(invalid_message.clone()).await;
            // Should return error due to validation
            assert!(result.is_err());
        }

        Ok(())
    }
}

/// Performance and stress tests
#[cfg(test)]
mod performance_tests {
    use super::*;
    use std::time::Instant;

    #[tokio::test]
    #[ignore] // Performance test - run manually
    async fn test_redis_performance() -> Result<(), Box<dyn std::error::Error>> {
        let queue = RedisQueueBuilder::new()
            .url(&TestConfig::default().redis_url)
            .queue_name("performance-test")
            .build()
            .await?;

        let num_messages = 1000;
        let mut messages = Vec::new();

        // Create test messages
        for i in 0..num_messages {
            messages.push(create_test_message_with_id(&format!("perf-{}", i)));
        }

        // Test enqueue performance
        let start = Instant::now();
        let message_ids = queue.enqueue_batch(messages).await?;
        let enqueue_duration = start.elapsed();

        println!("Enqueued {} messages in {:?}", num_messages, enqueue_duration);
        println!("Enqueue rate: {:.2} messages/sec", num_messages as f64 / enqueue_duration.as_secs_f64());

        assert_eq!(message_ids.len(), num_messages);

        // Test dequeue performance
        let start = Instant::now();
        let mut dequeued_count = 0;
        let batch_size = 100;

        while dequeued_count < num_messages {
            let batch_result = queue.dequeue_batch(batch_size).await?;
            dequeued_count += batch_result.messages.len();

            // Acknowledge the batch
            let ack_ids: Vec<String> = batch_result.messages
                .into_iter()
                .map(|m| m.id)
                .collect();

            queue.ack_batch(ack_ids).await?;
        }

        let dequeue_duration = start.elapsed();
        println!("Dequeued {} messages in {:?}", dequeued_count, dequeue_duration);
        println!("Dequeue rate: {:.2} messages/sec", dequeued_count as f64 / dequeue_duration.as_secs_f64());

        // Cleanup
        queue.purge().await?;

        Ok(())
    }
}