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
//! FIFO Queue Demo
//!
//! This example demonstrates how to use FIFO (First-In-First-Out) queues
//! with message ordering, deduplication, and group-based processing.

use backbone_queue::{
    QueueService,
    redis::RedisQueueBuilder,
    fifo::{FifoQueueService, FifoQueueServiceWrapper, FifoQueueConfig, MessageVolume},
    types::{QueueMessage, QueuePriority}
};
use std::collections::HashMap;
use std::sync::Arc;
use std::time::{Duration, Instant};
use serde_json::json;

/// Create FIFO message with proper attributes
fn create_fifo_message(
    id: &str,
    group_id: &str,
    deduplication_id: &str,
    payload: serde_json::Value,
    priority: QueuePriority,
) -> QueueMessage {
    QueueMessage {
        id: id.to_string(),
        payload,
        priority,
        receive_count: 0,
        max_receive_count: 3,
        enqueued_at: chrono::Utc::now(),
        visible_at: chrono::Utc::now(),
        expires_at: None,
        visibility_timeout: 30,
        status: backbone_queue::MessageStatus::Pending,
        delay_seconds: None,
        attributes: std::collections::HashMap::new(),
        message_group_id: Some(group_id.to_string()),
        message_deduplication_id: Some(deduplication_id.to_string()),
        compressed: false,
        original_size: None,
    }
}

/// Create order processing message
fn create_order_message(order_id: &str, action: &str) -> QueueMessage {
    create_fifo_message(
        &format!("order-{}", order_id),
        format!("order-{}", order_id), // One group per order
        format!("order-{}-{}", order_id, action), // Unique deduplication ID per action
        json!({
            "order_id": order_id,
            "action": action,
            "timestamp": chrono::Utc::now(),
            "data": {
                "customer_id": format!("customer-{}", order_id),
                "amount": (order_id.parse::<i64>().unwrap_or(0) * 100),
                "items": vec![
                    {"product": "widget-{}".format!(order_id), "quantity": order_id.parse::<i64>().unwrap_or(1) % 10 + 1)},
                    {"product": "gadget-{}",format!(order_id), "quantity": order_id.parse::<i64>().unwrap_or(1) % 5 + 1)}
                ]
            }
        }),
        QueuePriority::Normal,
    )
}

/// Create user activity message
fn create_activity_message(user_id: &str, activity: &str) -> QueueMessage {
    create_fifo_message(
        &format!("activity-{}", user_id),
        format!("user-{}", user_id), // One group per user
        format!("activity-{}-{}", user_id, chrono::Utc::now().timestamp()),
        json!({
            "user_id": user_id,
            "activity": activity,
            "timestamp": chrono::Utc::now(),
            "metadata": {
                "source": "mobile_app",
                "version": "1.0.0"
            }
        }),
        QueuePriority::Low,
    )
}

/// Demonstrate basic FIFO queue operations
async fn demo_basic_fifo_operations() -> Result<(), Box<dyn std::error::Error>> {
    println!("๐Ÿ“‹ Basic FIFO Queue Operations");
    println!("=============================");

    // Create Redis queue
    let queue = RedisQueueBuilder::new()
        .url("redis://localhost:6379")
        .queue_name("fifo_test_queue")
        .key_prefix("fifo")
        .build()
        .await?;

    // Test connection
    if !queue.test_connection().await? {
        println!("โŒ Failed to connect to Redis, skipping demo");
        return Ok(());
    }

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

    // Create FIFO service with recommended configuration
    let config = backbone_queue::fifo::utils::get_recommended_config(MessageVolume::Medium);
    let fifo_service = FifoQueueServiceWrapper::new(
        Arc::new(queue),
        config,
    );

    // Enqueue FIFO messages
    println!("\n๐Ÿ“ค Enqueuing FIFO messages...");

    let messages = vec![
        create_order_message("1001", "created"),
        create_order_message("1002", "created"),
        create_order_message("1003", "created"),
        create_order_message("1001", "updated"),
        create_order_message("1002", "updated"),
    ];

    for (i, message) in messages.iter().enumerate() {
        match fifo_service.enqueue_fifo(message.clone()).await {
            Ok(id) => {
                println!("  โœ… Message {} enqueued: {} (Group: {})",
                    i + 1,
                    message.message_deduplication_id.as_ref().unwrap(),
                    message.message_group_id.as_ref().unwrap()
                );
            }
            Err(e) => {
                println!("  โŒ Failed to enqueue message {}: {}", i + 1, e);
            }
        }

    // Show FIFO statistics
    let stats = fifo_service.get_fifo_stats().await?;
    println!("\n๐Ÿ“Š FIFO Queue Statistics:");
    println!("  Total groups: {}", stats.total_groups);
    println!("  Active groups: {}", stats.active_groups);
    println!("  Deduplicated messages: {}", stats.deduplicated_messages);
    println!("  Deduplication cache size: {}", stats.deduplication_cache.len());

    Ok(())
}

/// Demonstrate message deduplication
async fn demo_message_deduplication() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n๐Ÿšซ Message Deduplication Demo");
    println!("=============================");

    // Create Redis queue
    let queue = RedisQueueBuilder::new()
        .url("redis://localhost:6379")
        .queue_name("dedup_test_queue")
        .key_prefix("dedup")
        .build()
        .await?;

    // Test connection
    if !queue.test_connection().await? {
        println!("โŒ Failed to connect to Redis, skipping demo");
        return Ok(());
    }

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

    // Create FIFO service with content deduplication enabled
    let config = FifoQueueConfig {
        enabled: true,
        deduplication_window_seconds: 300, // 5 minutes
        max_message_groups: 1000,
        enable_content_deduplication: true, // Enable content deduplication
        content_deduplication_window_seconds: 60, // 1 minute
        max_deduplicated_messages: 10000,
    };

    let fifo_service = FifoQueueServiceWrapper::new(
        Arc::new(queue),
        config,
    );

    println!("\n๐Ÿ“ Testing deduplication IDs...");

    // Same deduplication ID should be rejected
    let message1 = create_fifo_message(
        "test-1",
        "group-1",
        "same-dedup-id",
        json!({"action": "update", "data": "value1"}),
        QueuePriority::Normal,
    );

    let message2 = create_fifo_message(
        "test-2",
        "group-1",
        "same-dedup-id", // Same deduplication ID
        json!({"action": "update", "data": "value2"}),
        QueuePriority::Normal,
    );

    match fifo_service.enqueue_fifo(message1).await {
        Ok(id) => println!("  โœ… First message enqueued: {}", id),
        Err(e) => println!("  โŒ Failed to enqueue first message: {}", e),
    }

    match fifo_service.enqueue_fifo(message2).await {
        Ok(_) => println!("  โš ๏ธ  Second message unexpectedly enqueued"),
        Err(e) => println!("  โœ… Second message correctly rejected: {}", e),
    }

    println!("\n๐Ÿ”„ Testing content deduplication...");

    // Same content should be rejected
    let content = json!({
        "order_id": "1234",
        "amount": 99.99,
        "items": ["item1", "item2"]
    });

    let message3 = create_fifo_message(
        "test-3",
        "group-2",
        "content-dedup-1",
        content.clone(),
        QueuePriority::Normal,
    );

    let message4 = create_fifo_message(
        "test-4",
        "group-2",
        "content-dedup-2", // Different deduplication ID
        content, // Same content
        QueuePriority::Normal,
    );

    match fifo_service.enqueue_fifo(message3).await {
        Ok(id) => println!("  โœ… First content message enqueued: {}", id),
        Err(e) => println!("  โŒ Failed to enqueue first content message: {}", e),
    }

    match fifo_service.enqueue_fifo(message4).await {
        Ok(_) => println!("  โš ๏ธ  Second content message unexpectedly enqueued"),
        Err(e) => println!("  โœ… Second content message correctly rejected: {}", e),
    }

    // Show deduplication statistics
    let stats = fifo_service.get_fifo_stats().await?;
    println!("\n๐Ÿ“ˆ Deduplication Statistics:");
    println!("  Message deduplication cache: {} entries", stats.deduplication_cache.len());
    println!("  Content deduplication cache: {} entries", stats.content_deduplication_cache.len());

    Ok(())
}

/// Demonstrate message group statistics
async fn demo_group_statistics() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n๐Ÿ“Š Message Group Statistics Demo");
    println!("===============================");

    // Create Redis queue
    let queue = RedisQueueBuilder::new()
        .url("redis://localhost:6379")
        .queue_name("stats_test_queue")
        .key_prefix("stats")
        .build()
        .await?;

    // Test connection
    if !queue.test_connection().await? {
        println!("โŒ Failed to connect to Redis, skipping demo");
        return Ok(());
    }

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

    let fifo_service = FifoQueueServiceWrapper::new(
        Arc::new(queue),
        FifoQueueConfig::default(),
    );

    // Create messages for different groups
    println!("\n๐Ÿ“ค Creating messages for different groups...");

    let groups = vec![
        ("payments", 3),
        ("notifications", 5),
        ("analytics", 2),
        ("backup", 1),
    ];

    for (group_name, count) in groups {
        println!("  ๐Ÿ“ฆ Group '{}': {} messages", group_name, count);

        for i in 1..=count {
            let message = create_fifo_message(
                &format!("{}-{}", group_name, i),
                group_name,
                &format!("{}-{}-{}", group_name, i, chrono::Utc::now().timestamp()),
                json!({
                    "group": group_name,
                    "index": i,
                    "data": "test data for group processing"
                }),
                QueuePriority::Normal,
            );

            match fifo_service.enqueue_fifo(message).await {
                Ok(_) => {}, // Success
                Err(e) => println!("    โŒ Failed: {}", e),
            }
        }
    }

    // Simulate processing to update group statistics
    println!("\nโš™๏ธ  Simulating message processing...");
    let group_ids: Vec<String> = groups.iter().map(|(name, _)| name.to_string()).collect();

    for group_id in group_ids {
        let mut group_stats = fifo_service.get_group_stats(&group_id).await?.unwrap_or_default();

        // Simulate some processing
        for _ in 0..group_stats.message_count / 2 {
            // Simulate successful processing
            {
                let mut stats = fifo_service.stats.write().await;
                stats.update_group(&group_id, true, 100 + (rand::random::<u64>() % 200));
            }
        }

        // Simulate some failures
        for _ in 0..group_stats.message_count / 4 {
            // Simulate failed processing
            {
                let mut stats = fifo_service.stats.write().await;
                stats.update_group(&group_id, false, 300 + (rand::random::<u64>() % 200));
            }
        }
    }

    // Display group statistics
    println!("\n๐Ÿ“ˆ Message Group Statistics:");
    let all_stats = fifo_service.get_all_group_stats().await?;

    for (group_id, stats) in all_stats {
        println!("  ๐Ÿ“‚ {}: {} messages, {:.1}% success rate, {:.1}ms avg processing time",
            group_id,
            stats.message_count,
            stats.success_rate(),
            stats.avg_processing_time_ms
        );
    }

    Ok(())
}

/// Demonstrate cleanup operations
async fn demo_cleanup_operations() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n๐Ÿงน Cleanup Operations Demo");
    println!("==========================");

    // Create Redis queue
    let queue = RedisQueueBuilder::new()
        .url("redis://localhost:6379")
        .queue_name("cleanup_test_queue")
        .key_prefix("cleanup")
        .build()
        .await?;

    // Test connection
    if !queue.test_connection().await? {
        println!("โŒ Failed to connect to Redis, skipping demo");
        return Ok(());
    }

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

    let fifo_service = FifoQueueServiceWrapper::new(
        Arc::new(queue),
        FifoQueueConfig {
            enabled: true,
            deduplication_window_seconds: 2, // Very short window for demo
            max_message_groups: 100,
            enable_content_deduplication: true,
            content_deduplication_window_seconds: 2,
            max_deduplicated_messages: 100,
        },
    );

    println!("\n๐Ÿ“ Adding entries that will expire...");

    // Add expired entries
    {
        let mut stats = fifo_service.stats.write().await;
        let past_time = chrono::Utc::now() - chrono::Duration::seconds(10);

        // Add expired deduplication entries
        for i in 0..5 {
            stats.deduplication_cache.insert(
                format!("expired-dedup-{}", i),
                past_time,
            );
        }

        // Add expired content deduplication entries
        for i in 0..3 {
            stats.content_deduplication_cache.insert(
                format!("expired-content-{}", i),
                past_time,
            );
        }

        println!("  ๐Ÿ—‘๏ธ  Added 5 expired message deduplication entries");
        println!("  ๐Ÿ—‘๏ธ  Added 3 expired content deduplication entries");
    }

    let stats_before = fifo_service.get_fifo_stats().await?;
    println!("\n๐Ÿ“Š Before cleanup:");
    println!("  Deduplication cache: {} entries", stats_before.deduplication_cache.len());
    println!("  Content deduplication cache: {} entries", stats_before.content_deduplication_cache.len());

    // Perform cleanup
    println!("\n๐Ÿงน Performing cleanup...");
    let removed_count = fifo_service.cleanup_deduplication().await?;

    let stats_after = fifo_service.get_fifo_stats().await?;
    println!("\n๐Ÿ“Š After cleanup:");
    println!("  Removed {} expired entries", removed_count);
    println!("  Deduplication cache: {} entries", stats_after.deduplication_cache.len());
    println!("  Content deduplication cache: {} entries", stats_after.content_deduplication_cache.len());

    Ok(())
}

/// Demonstrate configuration recommendations
async fn demo_configuration_recommendations() -> Result<(), Box<dyn std::error::Error>> {
    println!("\nโš™๏ธ  Configuration Recommendations");
    println!("===============================");

    let volumes = vec![
        (MessageVolume::Low, "Small application (100-1K messages/day)"),
        (MessageVolume::Medium, "Medium application (1K-10K messages/day)"),
        (MessageVolume::High, "Large application (10K+ messages/day)"),
    ];

    for (volume, description) in volumes {
        let config = backbone_queue::fifo::utils::get_recommended_config(volume);
        let errors = backbone_queue::fifo::utils::validate_config(&config);

        println!("\n๐Ÿ“ˆ {} Volume Recommendation:", volume as i32);
        println!("  ๐Ÿ“ Description: {}", description);
        println!("  โฐ Deduplication window: {} seconds", config.deduplication_window_seconds);
        println!("  ๐Ÿ“Š Max message groups: {}", config.max_message_groups);
        println!("  ๐Ÿ” Content deduplication: {}", config.enable_content_deduplication);

        if config.enable_content_deduplication {
            println!("  โฐ Content deduplication window: {} seconds", config.content_deduplication_window_seconds);
        }

        if !errors.is_empty() {
            println!("  โš ๏ธ  Validation issues:");
            for error in errors {
                println!("    โŒ {}", error);
            }
        } else {
            println!("  โœ… Configuration is valid");
        }
    }

    Ok(())
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize logging
    env_logger::init();

    println!("๐Ÿš€ FIFO Queue Demo");
    println!("===================");

    // Run all demos
    demo_basic_fifo_operations().await?;
    demo_message_deduplication().await?;
    demo_group_statistics().await?;
    demo_cleanup_operations().await?;
    demo_configuration_recommendations().await?;

    println!("\n๐ŸŽ‰ FIFO queue demo completed!");

    println!("\n๐Ÿ“š Key Takeaways:");
    println!("  โ€ข FIFO ensures exact message ordering within groups");
    println!("  โ€ข Message deduplication prevents duplicate processing");
    println!("  โ€ข Content deduplication provides additional safety");
    println!("  โ€ข Message groups allow parallel processing of independent streams");
    println!("  โ€ข Group statistics help monitor individual processing flows");
    println!("  โ€ข Automatic cleanup prevents memory leaks");
    println!("  โ€ข Configuration recommendations optimize for different volumes");

    Ok(())
}