dmsc 0.1.9

Ri - A high-performance Rust middleware framework with modular architecture
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
//! Copyright © 2025-2026 Wenze Wei. All Rights Reserved.
//!
//! This file is part of Ri.
//! The Ri project belongs to the Dunimd Team.
//!
//! Licensed under the Apache License, Version 2.0 (the "License");
//! You may not use this file except in compliance with the License.
//! You may obtain a copy of the License at
//!
//!     http://www.apache.org/licenses/LICENSE-2.0
//!
//! Unless required by applicable law or agreed to in writing, software
//! distributed under the License is distributed on an "AS IS" BASIS,
//! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//! See the License for the specific language governing permissions and
//! limitations under the License.

#![allow(non_snake_case)]

//! # In-Memory Queue Implementation
//!
//! This file implements an in-memory queue backend for the Ri queue system. The in-memory queue
//! provides a lightweight, fast queue implementation suitable for testing, development, and
//! scenarios where durability is not a strict requirement. It also supports optional persistence
//! to disk for basic durability.
//!
//! ## Key Components
//!
//! - **RiMemoryQueue**: Main in-memory queue implementation
//! - **MemoryQueueState**: Internal state management for the queue
//! - **MemoryQueueProducer**: Producer implementation for sending messages
//! - **MemoryQueueConsumer**: Consumer implementation for receiving messages
//!
//! ## Design Principles
//!
//! 1. **Lightweight**: Minimal dependencies and overhead
//! 2. **Fast Performance**: In-memory operations for low latency
//! 3. **Optional Persistence**: Can be configured to persist messages to disk
//! 4. **Consumer Groups**: Supports multiple consumer groups with message distribution
//! 5. **Async-First**: All operations are asynchronous
//! 6. **Thread-safe**: Uses Arc and RwLock for safe concurrent access
//! 7. **Durable Option**: Optional disk persistence for message durability
//! 8. **Simple API**: Implements the standard RiQueue interfaces
//! 9. **Non-blocking**: Uses tokio's spawn_blocking for file I/O operations
//! 10. **Message Retry**: Supports message requeueing with retry count increment
//!
//! ## Usage
//!
//! ```rust
//! use ri::queue::{RiQueue, RiQueueMessage, RiQueueProducer, RiQueueConsumer};
//! use ri::queue::backends::RiMemoryQueue;
//! use ri::core::RiResult;
//! use serde_json::json;
//!
//! async fn example() -> RiResult<()> {
//!     // Create a basic in-memory queue
//!     let queue = RiMemoryQueue::new("example_queue");
//!     
//!     // Or create a queue with disk persistence
//!     // let queue = RiMemoryQueue::with_persistence("example_queue", "/tmp/queue_persistence");
//!     
//!     // Create a producer
//!     let producer = queue.create_producer().await?;
//!     
//!     // Create a message
//!     let payload = json!({ "key": "value" }).to_string().into_bytes();
//!     let message = RiQueueMessage::new(payload);
//!     
//!     // Send the message
//!     producer.send(message).await?;
//!     
//!     // Create a consumer
//!     let consumer = queue.create_consumer("consumer_group_1").await?;
//!     
//!     // Receive a message
//!     if let Some(message) = consumer.receive().await? {
//!         // Process the message
//!         let payload = String::from_utf8_lossy(&message.payload);
//!         println!("Received message: {}", payload);
//!         
//!         // Acknowledge the message
//!         consumer.ack(&message.id).await?;
//!     }
//!     
//!     Ok(())
//! }
//! ```

use crate::core::RiResult;
use crate::queue::{RiQueue, RiQueueConsumer, RiQueueMessage, RiQueueProducer, RiQueueStats};
use async_trait::async_trait;
use std::collections::{HashMap, VecDeque};
use std::fs::{File, OpenOptions};
use std::io::{Read, Write};
use std::path::Path;
use std::sync::Arc;
use tokio::sync::{Mutex, RwLock};
use tokio::task::spawn_blocking;

/// Internal state management for the in-memory queue.
///
/// This struct holds the queue's messages and consumer-specific queues. It is protected by a
/// RwLock to ensure thread-safe access.
struct MemoryQueueState {
    /// Main queue of messages waiting to be consumed
    messages: VecDeque<RiQueueMessage>,
    /// Map of consumer group names to their respective message queues
    consumers: HashMap<String, VecDeque<RiQueueMessage>>,
}

impl MemoryQueueState {
    /// Creates a new MemoryQueueState with empty queues.
    ///
    /// # Returns
    ///
    /// A new MemoryQueueState instance
    fn new() -> Self {
        Self {
            messages: VecDeque::new(),
            consumers: HashMap::new(),
        }
    }
}

/// In-memory queue implementation.
///
/// This struct implements the RiQueue trait for an in-memory queue backend. It supports optional
/// disk persistence for message durability.
pub struct RiMemoryQueue {
    /// Name of the queue
    name: String,
    /// Internal queue state protected by a RwLock
    state: Arc<RwLock<MemoryQueueState>>,
    /// Optional path for disk persistence
    persistence_path: Option<String>,
}

#[allow(dead_code)]
impl RiMemoryQueue {
    /// Creates a new in-memory queue without persistence.
    ///
    /// # Parameters
    ///
    /// - `name`: The name of the queue
    ///
    /// # Returns
    ///
    /// A new RiMemoryQueue instance
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            state: Arc::new(RwLock::new(MemoryQueueState::new())),
            persistence_path: None,
        }
    }

    /// Creates a new in-memory queue with disk persistence.
    ///
    /// # Parameters
    ///
    /// - `name`: The name of the queue
    /// - `persistence_path`: Path to the file where messages will be persisted
    ///
    /// # Returns
    ///
    /// A new RiMemoryQueue instance with persistence enabled
    pub fn with_persistence(name: &str, persistence_path: &str) -> Self {
        let queue = Self {
            name: name.to_string(),
            state: Arc::new(RwLock::new(MemoryQueueState::new())),
            persistence_path: Some(persistence_path.to_string()),
        };

        // Load messages from disk if persistence is enabled
        if let Err(e) = queue.load_messages() {
            log::warn!("Failed to load persisted messages for queue '{name}': {e}");
        }

        queue
    }

    /// Loads messages from disk if persistence is enabled.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    fn load_messages(&self) -> RiResult<()> {
        if let Some(path) = &self.persistence_path {
            if Path::new(path).exists() {
                let mut file = File::open(path)?;
                
                // Security: Check file size before reading to prevent memory exhaustion
                const MAX_PERSISTENCE_FILE_SIZE: u64 = 100 * 1024 * 1024; // 100 MB
                let metadata = file.metadata()?;
                if metadata.len() > MAX_PERSISTENCE_FILE_SIZE {
                    log::warn!(
                        "[Ri.MemoryQueue] Persistence file too large: {} bytes (max {} bytes)",
                        metadata.len(), MAX_PERSISTENCE_FILE_SIZE
                    );
                    return Err(crate::core::RiError::Other(format!(
                        "Persistence file too large: {} bytes (max {} bytes)",
                        metadata.len(), MAX_PERSISTENCE_FILE_SIZE
                    )));
                }
                
                let mut content = String::new();
                file.read_to_string(&mut content)?;

                if !content.is_empty() {
                    // Security: Use bounded deserialization
                    let messages: VecDeque<RiQueueMessage> = serde_json::from_str(&content)
                        .map_err(|e| {
                            log::warn!("[Ri.MemoryQueue] Failed to deserialize messages: {}", e);
                            crate::core::RiError::Other(format!("Failed to deserialize messages: {}", e))
                        })?;
                    
                    // Security: Limit number of messages loaded
                    const MAX_MESSAGES: usize = 100000;
                    let messages: VecDeque<RiQueueMessage> = messages.into_iter().take(MAX_MESSAGES).collect();
                    
                    let mut state = self.state.blocking_write();
                    state.messages = messages;
                }
            }
        }
        Ok(())
    }

    /// Saves messages to disk if persistence is enabled.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    fn save_messages(&self) -> RiResult<()> {
        if let Some(path) = &self.persistence_path {
            let state = self.state.blocking_read();
            let content = serde_json::to_string(&state.messages)?;

            let mut file = OpenOptions::new()
                .write(true)
                .create(true)
                .truncate(true)
                .open(path)?;

            file.write_all(content.as_bytes())?;
        }
        Ok(())
    }
}

#[async_trait]
impl RiQueue for RiMemoryQueue {
    /// Creates a new producer for this queue.
    ///
    /// # Returns
    ///
    /// A `RiResult<Box<dyn RiQueueProducer>>` containing the producer
    async fn create_producer(&self) -> RiResult<Box<dyn RiQueueProducer>> {
        Ok(Box::new(MemoryQueueProducer {
            state: self.state.clone(),
            persistence_path: self.persistence_path.clone(),
        }))
    }

    /// Creates a new consumer for this queue with the given consumer group.
    ///
    /// # Parameters
    ///
    /// - `consumer_group`: The name of the consumer group
    ///
    /// # Returns
    ///
    /// A `RiResult<Box<dyn RiQueueConsumer>>` containing the consumer
    async fn create_consumer(
        &self,
        consumer_group: &str,
    ) -> RiResult<Box<dyn RiQueueConsumer>> {
        Ok(Box::new(MemoryQueueConsumer {
            state: self.state.clone(),
            consumer_group: consumer_group.to_string(),
            paused: Arc::new(Mutex::new(false)),
            persistence_path: self.persistence_path.clone(),
        }))
    }

    /// Gets statistics for this queue.
    ///
    /// # Returns
    ///
    /// A `RiResult<RiQueueStats>` containing the queue statistics
    async fn get_stats(&self) -> RiResult<RiQueueStats> {
        let state = self.state.read().await;
        Ok(RiQueueStats {
            queue_name: self.name.clone(),
            message_count: state.messages.len() as u64,
            consumer_count: state.consumers.len() as u32,
            producer_count: 1,
            processed_messages: 0,
            failed_messages: 0,
            avg_processing_time_ms: 0.0,
            total_bytes_sent: 0,
            total_bytes_received: 0,
            last_message_time: 0,
        })
    }

    /// Purges all messages from this queue.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn purge(&self) -> RiResult<()> {
        let mut state = self.state.write().await;
        state.messages.clear();
        state.consumers.clear();

        // Clear persistence file if enabled
        if let Some(path) = &self.persistence_path {
            let path_clone = path.clone();
            spawn_blocking(move || {
                if Path::new(&path_clone).exists() {
                    if let Err(e) = std::fs::remove_file(&path_clone) {
                        log::warn!("Failed to remove persistence file '{path_clone}': {e}");
                    }
                }
            })
            .await
            .map_err(|e| {
                log::error!("Failed to execute persistence file removal: {e}");
                crate::core::RiError::Other(format!("Failed to clear persistence: {e}"))
            })?;
        }

        Ok(())
    }

    /// Deletes this queue.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn delete(&self) -> RiResult<()> {
        self.purge().await
    }
}

/// Producer implementation for the in-memory queue.
///
/// This struct implements the RiQueueProducer trait for sending messages to the in-memory queue.
struct MemoryQueueProducer {
    /// Shared queue state
    state: Arc<RwLock<MemoryQueueState>>,
    /// Optional path for disk persistence
    persistence_path: Option<String>,
}

#[async_trait]
impl RiQueueProducer for MemoryQueueProducer {
    /// Sends a single message to the queue.
    ///
    /// # Parameters
    ///
    /// - `message`: The message to send
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn send(&self, message: RiQueueMessage) -> RiResult<()> {
        let mut state = self.state.write().await;
        state.messages.push_back(message);

        // Save to disk if persistence is enabled
        if let Some(path) = &self.persistence_path {
            let messages_clone = state.messages.clone();
            let path_clone = path.clone();

            let _ = spawn_blocking(move || {
            let content = serde_json::to_string(&messages_clone)
                .map_err(|e| {
                    log::error!("Failed to serialize messages for persistence: {e}");
                    crate::core::RiError::Serde(format!("Serialization failed: {e}"))
                })?;
            let mut file = OpenOptions::new()
                .write(true)
                .create(true)
                .truncate(true)
                .open(path_clone)
                .map_err(|e| {
                    log::error!("Failed to open persistence file: {e}");
                    crate::core::RiError::Io(format!("File open failed: {e}"))
                })?;
            file.write_all(content.as_bytes())
                .map_err(|e| {
                    log::error!("Failed to write persistence file: {e}");
                    crate::core::RiError::Io(format!("File write failed: {e}"))
                })?;
            Ok::<(), crate::core::RiError>(())
        })
        .await
        .map_err(|e| {
            log::error!("Failed to execute persistence task: {e}");
            crate::core::RiError::Other(format!("Persistence task failed: {e}"))
        });
        }

        Ok(())
    }

    /// Sends multiple messages to the queue in a batch.
    ///
    /// # Parameters
    ///
    /// - `messages`: A vector of messages to send
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn send_batch(&self, messages: Vec<RiQueueMessage>) -> RiResult<()> {
        let mut state = self.state.write().await;
        for message in messages {
            state.messages.push_back(message);
        }

        // Save to disk if persistence is enabled
        if let Some(path) = &self.persistence_path {
            let messages_clone = state.messages.clone();
            let path_clone = path.clone();

            let _ = spawn_blocking(move || {
            let content = serde_json::to_string(&messages_clone)
                .map_err(|e| {
                    log::error!("Failed to serialize messages for persistence: {e}");
                    crate::core::RiError::Serde(format!("Serialization failed: {e}"))
                })?;
            let mut file = OpenOptions::new()
                .write(true)
                .create(true)
                .truncate(true)
                .open(path_clone)
                .map_err(|e| {
                    log::error!("Failed to open persistence file: {e}");
                    crate::core::RiError::Io(format!("File open failed: {e}"))
                })?;
            file.write_all(content.as_bytes())
                .map_err(|e| {
                    log::error!("Failed to write persistence file: {e}");
                    crate::core::RiError::Io(format!("File write failed: {e}"))
                })?;
            Ok::<(), crate::core::RiError>(())
        })
        .await
        .map_err(|e| {
            log::error!("Failed to execute persistence task: {e}");
            crate::core::RiError::Other(format!("Persistence task failed: {e}"))
        });
        }

        Ok(())
    }
}

/// Consumer implementation for the in-memory queue.
///
/// This struct implements the RiQueueConsumer trait for receiving messages from the in-memory queue.
struct MemoryQueueConsumer {
    /// Shared queue state
    state: Arc<RwLock<MemoryQueueState>>,
    /// Name of the consumer group
    consumer_group: String,
    /// Flag indicating if the consumer is paused
    paused: Arc<Mutex<bool>>,
    /// Optional path for disk persistence
    persistence_path: Option<String>,
}

#[async_trait]
impl RiQueueConsumer for MemoryQueueConsumer {
    /// Receives a message from the queue.
    ///
    /// # Returns
    ///
    /// A `RiResult<Option<RiQueueMessage>>` containing the message if available, or None if no message is available
    async fn receive(&self) -> RiResult<Option<RiQueueMessage>> {
        let paused = *self.paused.lock().await;
        if paused {
            return Ok(None);
        }

        let mut state = self.state.write().await;

        // If consumer queue exists and has messages, return one
        if let Some(consumer_queue) = state.consumers.get_mut(&self.consumer_group) {
            if let Some(message) = consumer_queue.pop_front() {
                return Ok(Some(message));
            }
        }

        // If main queue has messages, move one to consumer queue
        if let Some(message) = state.messages.pop_front() {
            let mut consumer_queue = VecDeque::new();
            consumer_queue.push_back(message.clone());
            state
                .consumers
                .insert(self.consumer_group.clone(), consumer_queue);

            // Save to disk if persistence is enabled (since main queue changed)
            if let Some(path) = &self.persistence_path {
                let messages_clone = state.messages.clone();
                let path_clone = path.clone();

                let _ = spawn_blocking(move || {
                    let content = serde_json::to_string(&messages_clone)
                        .map_err(|e| {
                            log::error!("Failed to serialize messages for persistence: {e}");
                            crate::core::RiError::Serde(format!("Serialization failed: {e}"))
                        })?;
                    let mut file = OpenOptions::new()
                        .write(true)
                        .create(true)
                        .truncate(true)
                        .open(path_clone)
                        .map_err(|e| {
                            log::error!("Failed to open persistence file: {e}");
                            crate::core::RiError::Io(format!("File open failed: {e}"))
                        })?;
                    file.write_all(content.as_bytes())
                        .map_err(|e| {
                            log::error!("Failed to write persistence file: {e}");
                            crate::core::RiError::Io(format!("File write failed: {e}"))
                        })?;
                    Ok::<(), crate::core::RiError>(())
                })
                .await
                .map_err(|e| {
                    log::error!("Failed to execute persistence task: {e}");
                    crate::core::RiError::Other(format!("Persistence task failed: {e}"))
                });
            }

            Ok(Some(message))
        } else {
            Ok(None)
        }
    }

    /// Acknowledges a message, indicating it has been successfully processed.
    ///
    /// For in-memory queues, acknowledgment is implicit when the message is received.
    ///
    /// # Parameters
    ///
    /// - `_message_id`: The ID of the message to acknowledge (not used for in-memory queues)
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn ack(&self, _message_id: &str) -> RiResult<()> {
        // In memory queue, acknowledgment is implicit when message is received
        Ok(())
    }

    /// Negatively acknowledges a message, indicating it failed to process and should be retried.
    ///
    /// # Parameters
    ///
    /// - `message_id`: The ID of the message to negatively acknowledge
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn nack(&self, message_id: &str) -> RiResult<()> {
        // Find the message in consumer queue and put it back in main queue
        let mut state = self.state.write().await;

        if let Some(consumer_queue) = state.consumers.get_mut(&self.consumer_group) {
            // Find the message by ID
            let mut message_to_requeue: Option<RiQueueMessage> = None;

            // Iterate through consumer queue to find the message
            let mut index = 0;
            for (i, message) in consumer_queue.iter().enumerate() {
                if message.id == message_id {
                    message_to_requeue = Some(message.clone());
                    index = i;
                    break;
                }
            }

            // If found, remove from consumer queue and put back in main queue
            if let Some(mut message) = message_to_requeue {
                consumer_queue.remove(index);
                message.increment_retry();
                state.messages.push_back(message);

                // Save to disk if persistence is enabled
                if let Some(path) = &self.persistence_path {
                    let messages_clone = state.messages.clone();
                    let path_clone = path.clone();

                    let _ = spawn_blocking(move || {
                        let content = serde_json::to_string(&messages_clone)
                            .map_err(|e| {
                                log::error!("Failed to serialize messages for persistence: {e}");
                                crate::core::RiError::Serde(format!("Serialization failed: {e}"))
                            })?;
                        let mut file = OpenOptions::new()
                            .write(true)
                            .create(true)
                            .truncate(true)
                            .open(path_clone)
                            .map_err(|e| {
                                log::error!("Failed to open persistence file: {e}");
                                crate::core::RiError::Io(format!("File open failed: {e}"))
                            })?;
                        file.write_all(content.as_bytes())
                            .map_err(|e| {
                                log::error!("Failed to write persistence file: {e}");
                                crate::core::RiError::Io(format!("File write failed: {e}"))
                            })?;
                        Ok::<(), crate::core::RiError>(())
                    })
                    .await
                    .map_err(|e| {
                        log::error!("Failed to execute persistence task: {e}");
                        crate::core::RiError::Other(format!("Persistence task failed: {e}"))
                    });
                }
            }
        }

        Ok(())
    }

    /// Pauses message consumption.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn pause(&self) -> RiResult<()> {
        let mut paused = self.paused.lock().await;
        *paused = true;
        Ok(())
    }

    /// Resumes message consumption after pausing.
    ///
    /// # Returns
    ///
    /// A `RiResult<()>` indicating success or failure
    async fn resume(&self) -> RiResult<()> {
        let mut paused = self.paused.lock().await;
        *paused = false;
        Ok(())
    }
}