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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
//! # Queue Port - Async Task Queue and Job Processing Interface
//!
//! This module defines the port trait for asynchronous task queue operations, enabling
//! distributed job processing, work distribution, and background task execution across
//! Paladin and Battalion operations.
//!
//! ## Purpose
//!
//! The Queue port provides a standardized interface for:
//! - **Task Distribution**: Enqueue work items for async processing
//! - **Job Processing**: Dequeue and process items with worker coordination
//! - **Priority Management**: Handle items based on urgency (Critical → High → Normal → Low)
//! - **Retry Handling**: Automatic retry with exponential backoff for failed items
//! - **Queue Lifecycle**: Create, pause, resume, and monitor multiple queues
//!
//! Following hexagonal architecture, this trait abstracts queue operations from their
//! implementations (in-memory, Redis, RabbitMQ, AWS SQS).
//!
//! ## Hexagonal Architecture Context
//!
//! ```text
//! ┌─────────────────────────────────────────────────────┐
//! │ Application Layer │
//! │ ┌──────────────────────────────────────────────┐ │
//! │ │ PaladinExecutionService │ │
//! │ │ - Queues Paladin execution tasks │ │
//! │ │ BattalionServices │ │
//! │ │ - Distributes sub-tasks to workers │ │
//! │ │ ContentIngestionService │ │
//! │ │ - Queues documents for processing │ │
//! │ └──────────────────────────────────────────────┘ │
//! │ │ │
//! │ ▼ │
//! │ ┌──────────────────────────────────────────────┐ │
//! │ │ QueuePort (this module) │ │
//! │ │ - Task queue interface │ │
//! │ └──────────────────────────────────────────────┘ │
//! └─────────────────────────────────────────────────────┘
//! │
//! ▼
//! ┌─────────────────────────────────────────────────────┐
//! │ Infrastructure Layer │
//! │ ┌──────────────────────────────────────────────┐ │
//! │ │ InMemoryQueue (Local processing) │ │
//! │ │ RedisQueueAdapter (Distributed) │ │
//! │ │ RabbitMQAdapter (Message broker) │ │
//! │ │ SqsAdapter (AWS SQS) │ │
//! │ └──────────────────────────────────────────────┘ │
//! └─────────────────────────────────────────────────────┘
//! ```
//!
//! ## Thread Safety
//!
//! All implementations must be `Send + Sync`:
//! - **Send**: Queue operations may happen across threads
//! - **Sync**: Multiple workers access the queue concurrently
//! - Implementations must handle concurrent enqueue/dequeue safely
//!
//! ## Error Handling
//!
//! Queue operations can fail for several reasons:
//! - **Queue Not Found**: Requested queue doesn't exist
//! - **Queue Full**: Maximum capacity reached (configurable)
//! - **Item Not Found**: Item ID doesn't exist or already processed
//! - **Serialization Error**: Item payload cannot be serialized/deserialized
//! - **Operation Failed**: Backend-specific errors (network, Redis down, etc.)
//!
//! All errors are represented via [`QueueError`]
//! with detailed context for debugging and recovery.
//!
//! ## Common Use Cases
//!
//! ### 1. Async Paladin Execution
//!
//! ```rust,ignore
//! use paladin::application::ports::output::queue_port::QueuePort;
//! use paladin::core::platform::container::queue_item::{QueueItem, QueueItemConfig};
//! use paladin::core::base::entity::message::Message;
//! use serde::{Serialize, Deserialize};
//!
//! #[derive(Debug, Clone, Serialize, Deserialize)]
//! struct PaladinTask {
//! paladin_id: String,
//! input: String,
//! }
//!
//! async fn queue_paladin_execution(
//! queue: &dyn QueuePort,
//! task: PaladinTask,
//! ) -> Result<(), Box<dyn std::error::Error>> {
//! // Create message with task payload
//! let message = Message::new(
//! task,
//! "paladin-service".to_string(),
//! paladin::core::base::entity::message::Location::Local,
//! );
//!
//! // Create queue item with retry config
//! let config = QueueItemConfig {
//! max_retries: 3,
//! timeout_seconds: 300,
//! ..Default::default()
//! };
//!
//! let item = QueueItem::new(
//! "paladin-executions".to_string(),
//! message,
//! Some(config),
//! );
//!
//! // Enqueue for async processing
//! let item_id = queue.enqueue("paladin-executions", item).await?;
//! println!("Queued Paladin task: {}", item_id);
//!
//! Ok(())
//! }
//! ```
//!
//! ### 2. Worker Processing Loop
//!
//! ```rust,ignore
//! use paladin::application::ports::output::queue_port::QueuePort;
//! use serde::{Serialize, Deserialize};
//!
//! #[derive(Debug, Clone, Serialize, Deserialize)]
//! struct DocumentTask {
//! document_id: String,
//! operation: String,
//! }
//!
//! async fn worker_process_loop(
//! queue: &dyn QueuePort,
//! worker_id: String,
//! ) -> Result<(), Box<dyn std::error::Error>> {
//! loop {
//! // Dequeue next item
//! if let Some(item) = queue.dequeue("document-processing").await? {
//! let item_id = item.action.id;
//!
//! // Mark as processing
//! queue.start_processing("document-processing", item_id, worker_id.clone()).await?;
//!
//! // Process the task
//! match process_document(&item).await {
//! Ok(result) => {
//! // Mark as complete
//! queue.complete_processing(
//! "document-processing",
//! item_id,
//! Some(result),
//! ).await?;
//! println!("Completed task: {}", item_id);
//! }
//! Err(e) => {
//! // Mark as failed (will retry if configured)
//! let should_retry = queue.fail_processing(
//! "document-processing",
//! item_id,
//! e.to_string(),
//! ).await?;
//!
//! if should_retry {
//! println!("Task {} will retry", item_id);
//! } else {
//! println!("Task {} failed permanently", item_id);
//! }
//! }
//! }
//! } else {
//! // No items available, wait before polling again
//! tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
//! }
//! }
//! }
//!
//! async fn process_document(
//! item: &paladin::core::platform::container::queue_item::QueueItem<serde_json::Value>,
//! ) -> Result<serde_json::Value, Box<dyn std::error::Error>> {
//! // Simulate document processing
//! Ok(serde_json::json!({"status": "processed"}))
//! }
//! ```
//!
//! ### 3. Priority-Based Processing
//!
//! ```rust,ignore
//! use paladin::application::ports::output::queue_port::QueuePort;
//! use paladin::core::platform::container::queue_item::{QueueItem, QueueItemConfig};
//! use paladin::core::base::entity::message::{Message, MessagePriority};
//! use serde::{Serialize, Deserialize};
//!
//! #[derive(Debug, Clone, Serialize, Deserialize)]
//! struct AlertTask {
//! alert_type: String,
//! severity: String,
//! }
//!
//! async fn queue_critical_alert(
//! queue: &dyn QueuePort,
//! alert: AlertTask,
//! ) -> Result<(), Box<dyn std::error::Error>> {
//! // Create message with Critical priority
//! let mut message = Message::new(
//! alert,
//! "alert-service".to_string(),
//! paladin::core::base::entity::message::Location::Local,
//! );
//! message.priority = MessagePriority::Critical;
//!
//! let item = QueueItem::new(
//! "alerts".to_string(),
//! message,
//! Some(QueueItemConfig::default()),
//! );
//!
//! // Will be processed before Normal/Low priority items
//! queue.enqueue("alerts", item).await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### 4. Queue Monitoring and Stats
//!
//! ```rust,ignore
//! use paladin::application::ports::output::queue_port::QueuePort;
//!
//! async fn monitor_queue_health(
//! queue: &dyn QueuePort,
//! ) -> Result<(), Box<dyn std::error::Error>> {
//! // Get all queue names
//! let queues = queue.list_queues().await;
//!
//! for queue_name in queues {
//! let stats = queue.get_queue_stats(&queue_name).await?;
//!
//! println!("Queue: {}", stats.name);
//! println!(" Total items: {}", stats.total_items);
//! println!(" Pending: {}", stats.pending_items);
//! println!(" Processing: {}", stats.processing_items);
//! println!(" Completed: {}", stats.completed_items);
//! println!(" Failed: {}", stats.failed_items);
//! println!(" Throughput: {:.2}/min", stats.throughput_per_minute);
//!
//! if let Some(avg_time) = stats.average_processing_time_ms {
//! println!(" Avg processing time: {}ms", avg_time);
//! }
//!
//! // Alert if queue is growing too large
//! if stats.pending_items > 1000 {
//! println!("⚠️ Queue {} has {} pending items!", queue_name, stats.pending_items);
//! }
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ## Implementation Notes
//!
//! ### Queue Backend Selection
//!
//! Choose based on deployment requirements:
//!
//! - **InMemoryQueue**: Best for development, single-instance deployments
//! - Fastest performance
//! - No external dependencies
//! - Lost on process restart
//!
//! - **RedisQueue**: Distributed, persistent, high performance
//! - Sub-millisecond latency
//! - Supports clustering
//! - Survives process restarts
//!
//! - **RabbitMQ**: Message broker with advanced routing
//! - Guaranteed delivery
//! - Complex routing patterns
//! - Higher latency
//!
//! - **AWS SQS**: Fully managed, infinite scale
//! - No infrastructure management
//! - Higher cost
//! - ~1 second minimum latency
//!
//! ### Performance Optimization
//!
//! 1. **Batch Operations**: Use `enqueue_batch()` / `dequeue_batch()` for bulk work
//! 2. **Priority Queues**: Enable `priority_based: true` only when needed
//! 3. **Worker Scaling**: Run multiple workers per queue for parallelism
//! 4. **Polling Strategy**: Use exponential backoff when queue is empty
//! 5. **Cleanup**: Run `cleanup_expired()` periodically to reclaim memory
//!
//! ### Retry Strategy
//!
//! Configure retry behavior via `QueueItemConfig`:
//!
//! ```rust,ignore
//! let config = QueueItemConfig {
//! max_retries: 3, // Number of retry attempts
//! retry_delay_seconds: 60, // Initial delay between retries
//! retry_backoff_multiplier: 2.0, // Exponential backoff (60s → 120s → 240s)
//! timeout_seconds: 300, // Max processing time per attempt
//! ..Default::default()
//! };
//! ```
//!
//! ### Best Practices
//!
//! 1. **Idempotent Operations**: Design tasks to be safely retried
//! 2. **Timeouts**: Set reasonable `timeout_seconds` for long-running tasks
//! 3. **Dead Letter Queues**: Move permanently failed items to DLQ for investigation
//! 4. **Monitoring**: Track `throughput_per_minute` and `pending_items` metrics
//! 5. **Graceful Shutdown**: Finish processing current items before stopping workers
//! 6. **Queue Naming**: Use descriptive names (e.g., `paladin-executions`, `document-processing`)
//!
//! ## Common Pitfalls
//!
//! - Not handling `QueueEmpty` gracefully (use polling loop with backoff)
//! - Forgetting to call `start_processing()` before processing (breaks visibility timeout)
//! - Not calling `complete_processing()` or `fail_processing()` (items stay "stuck")
//! - Setting `max_retries` too high (wastes resources on truly broken tasks)
//! - Using priority queues when not needed (adds overhead)
//! - Not monitoring queue depth (can lead to memory exhaustion)
//!
//! ## Related Modules
//!
//! - [`QueueItem`](paladin_core::platform::container::queue_item::QueueItem) - Queue item structure
//! - [`QueueItemConfig`](paladin_core::platform::container::queue_item::QueueItemConfig) - Item configuration
//! - [`QueueConfig`](paladin_core::platform::container::queue_config::QueueConfig) - Queue configuration
//! - [`QueueStats`] - Queue statistics
//! - [`QueueError`] - Error types
//! - [`Message`](paladin_core::base::entity::message::Message) - Message wrapper
//! - [`MessagePriority`](paladin_core::base::entity::message::MessagePriority) - Priority levels
//!
//! ## See Also
//!
//! - `examples/async_paladin_queue.rs` - Async execution example
//! - `examples/worker_pool.rs` - Worker processing example
//! - `examples/priority_queue.rs` - Priority-based processing example
use async_trait;
use ;
use QueueConfig;
use ;
use ;
use Error;
/// Queue service errors
/// Queue statistics
use HashMap;
use Uuid;
/// Port trait for core queue operations.
///
/// Provides the primary interface for async task queue management with support for:
/// - Queue lifecycle (create, delete)
/// - Item operations (enqueue, dequeue)
/// - Processing state management (start, complete, fail)
/// - Monitoring (stats, health)
///
/// # Capabilities
///
/// - **Queue Management**: Create/delete queues with custom configurations
/// - **Item Enqueue**: Add tasks to queues with serializable payloads
/// - **Item Dequeue**: Retrieve next item for processing (FIFO or priority-based)
/// - **Processing Lifecycle**: Track item states (pending → processing → complete/failed)
/// - **Automatic Retry**: Failed items retry based on `QueueItemConfig`
/// - **Statistics**: Monitor queue depth, throughput, and processing times
/// - **Health Check**: Verify queue backend connectivity
///
/// # Thread Safety
///
/// All implementations must be `Send + Sync` to support:
/// - Concurrent enqueue operations from multiple threads
/// - Safe dequeue by multiple workers
/// - Thread-safe state transitions
///
/// # Implementation Requirements
///
/// Implementations should:
/// 1. Use atomic operations for state transitions (pending → processing)
/// 2. Implement visibility timeout for processing items
/// 3. Support automatic retry with exponential backoff
/// 4. Handle serialization/deserialization gracefully
/// 5. Return `QueueEmpty` (not an error) when queue has no items
/// 6. Preserve completed/failed items based on `QueueConfig`
///
/// # Examples
///
/// ## Basic Queue Operations
///
/// ```rust,ignore
/// use paladin::application::ports::output::queue_port::QueuePort;
/// use paladin::core::platform::manager::queue_service::QueueConfig;
/// use paladin::core::platform::container::queue_item::{QueueItem, QueueItemConfig};
/// use paladin::core::base::entity::message::Message;
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct MyTask {
/// task_id: String,
/// data: String,
/// }
///
/// async fn basic_queue_usage(
/// queue: &dyn QueuePort,
/// ) -> Result<(), Box<dyn std::error::Error>> {
/// // Create a new queue
/// let config = QueueConfig {
/// max_capacity: 10000,
/// priority_based: true,
/// ..Default::default()
/// };
/// queue.create_queue("my-tasks".to_string(), Some(config)).await?;
///
/// // Enqueue a task
/// let task = MyTask {
/// task_id: "task-001".to_string(),
/// data: "process this".to_string(),
/// };
///
/// let message = Message::new(
/// task,
/// "my-service".to_string(),
/// paladin::core::base::entity::message::Location::Local,
/// );
///
/// let item = QueueItem::new(
/// "my-tasks".to_string(),
/// message,
/// Some(QueueItemConfig::default()),
/// );
///
/// let item_id = queue.enqueue("my-tasks", item).await?;
/// println!("Enqueued task: {}", item_id);
///
/// // Check queue stats
/// let stats = queue.get_queue_stats("my-tasks").await?;
/// println!("Pending items: {}", stats.pending_items);
///
/// Ok(())
/// }
/// ```
///
/// ## Worker Processing with Retry
///
/// ```rust,ignore
/// use paladin::application::ports::output::queue_port::QueuePort;
///
/// async fn worker_with_retry(
/// queue: &dyn QueuePort,
/// worker_id: String,
/// ) -> Result<(), Box<dyn std::error::Error>> {
/// loop {
/// // Dequeue next item
/// let item = match queue.dequeue("tasks").await? {
/// Some(i) => i,
/// None => {
/// // Queue empty, wait before polling again
/// tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;
/// continue;
/// }
/// };
///
/// let item_id = item.action.id;
///
/// // Mark as processing
/// queue.start_processing("tasks", item_id, worker_id.clone()).await?;
///
/// // Process (simulate work)
/// match process_task(&item).await {
/// Ok(result) => {
/// queue.complete_processing("tasks", item_id, Some(result)).await?;
/// println!("✅ Task {} completed", item_id);
/// }
/// Err(e) => {
/// let will_retry = queue.fail_processing("tasks", item_id, e.to_string()).await?;
/// if will_retry {
/// println!("🔄 Task {} will retry", item_id);
/// } else {
/// println!("❌ Task {} failed permanently", item_id);
/// }
/// }
/// }
/// }
/// }
///
/// async fn process_task(
/// item: &paladin::core::platform::container::queue_item::QueueItem<serde_json::Value>,
/// ) -> Result<serde_json::Value, Box<dyn std::error::Error>> {
/// // Simulate processing
/// Ok(serde_json::json!({"status": "done"}))
/// }
/// ```