quetty-server 0.1.7

Core Azure Service Bus client library for Quetty terminal application
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
511
512
513
514
515
516
517
use azservicebus::receiver::DeadLetterOptions;
use azservicebus::{ServiceBusClient, ServiceBusReceiver, ServiceBusReceiverOptions};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::Mutex;

use crate::model::MessageModel;

/// A wrapper around Azure Service Bus receiver for consuming messages from queues.
///
/// The Consumer provides a high-level interface for receiving, processing, and managing
/// messages from Azure Service Bus queues. It supports both peek operations (non-destructive)
/// and receive operations (which lock messages for processing).
///
/// # Thread Safety
///
/// The Consumer is thread-safe and can be shared across async tasks. The underlying
/// receiver is protected by a mutex to ensure safe concurrent access.
///
/// # Examples
///
/// ```no_run
/// use quetty_server::consumer::Consumer;
/// use azservicebus::{ServiceBusReceiver, ServiceBusReceiverOptions};
///
/// async fn example(receiver: ServiceBusReceiver) {
///     let mut consumer = Consumer::new(receiver);
///
///     // Peek at messages without consuming them
///     let messages = consumer.peek_messages(10, None).await?;
///
///     // Receive messages for processing
///     let received = consumer.receive_messages_with_timeout(5, std::time::Duration::from_secs(10)).await?;
///
///     // Process and complete messages
///     for message in &received {
///         consumer.complete_message(message).await?;
///     }
/// }
/// ```
#[derive(Debug)]
pub struct Consumer {
    receiver: Arc<Mutex<Option<ServiceBusReceiver>>>,
}

impl PartialEq for Consumer {
    fn eq(&self, other: &Self) -> bool {
        Arc::ptr_eq(&self.receiver, &other.receiver)
    }
}

impl Consumer {
    /// Creates a new Consumer wrapping the provided Service Bus receiver.
    ///
    /// # Arguments
    ///
    /// * `receiver` - The Azure Service Bus receiver to wrap
    pub fn new(receiver: ServiceBusReceiver) -> Self {
        Self {
            receiver: Arc::new(Mutex::new(Some(receiver))),
        }
    }

    /// Peeks at messages in the queue without consuming them.
    ///
    /// This operation allows you to inspect messages without locking them
    /// or affecting their delivery count. Useful for browsing queue contents.
    ///
    /// # Arguments
    ///
    /// * `max_count` - Maximum number of messages to peek at
    /// * `from_sequence_number` - Optional starting sequence number
    ///
    /// # Returns
    ///
    /// Vector of MessageModel instances representing the peeked messages
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn peek_messages(
        &mut self,
        max_count: u32,
        from_sequence_number: Option<i64>,
    ) -> Result<Vec<MessageModel>, Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            let messages = receiver
                .peek_messages(max_count, from_sequence_number)
                .await?;
            let result = MessageModel::try_convert_messages_collect(messages);
            Ok(result)
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Receives messages from the queue with a timeout.
    ///
    /// This operation locks the received messages for processing. The messages
    /// must be completed, abandoned, or dead-lettered to release the lock.
    ///
    /// # Arguments
    ///
    /// * `max_count` - Maximum number of messages to receive
    /// * `timeout` - Maximum time to wait for messages
    ///
    /// # Returns
    ///
    /// Vector of received messages that are locked for processing.
    /// Returns an empty vector if the timeout expires before messages are available.
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn receive_messages_with_timeout(
        &mut self,
        max_count: u32,
        timeout: Duration,
    ) -> Result<Vec<azservicebus::ServiceBusReceivedMessage>, Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            match tokio::time::timeout(timeout, receiver.receive_messages(max_count)).await {
                Ok(result) => result.map_err(|e| e.into()),
                Err(_) => {
                    // Timeout occurred - return empty vector instead of error
                    log::debug!(
                        "receive_messages timed out after {timeout:?}, returning empty result"
                    );
                    Ok(Vec::new())
                }
            }
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Abandons a received message, returning it to the queue.
    ///
    /// The message becomes available for redelivery and its delivery count is incremented.
    ///
    /// # Arguments
    ///
    /// * `message` - The message to abandon
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn abandon_message(
        &mut self,
        message: &azservicebus::ServiceBusReceivedMessage,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            receiver.abandon_message(message, None).await?;
            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Moves a message to the dead letter queue.
    ///
    /// Dead lettered messages are permanently removed from the main queue
    /// and can be inspected in the dead letter queue for debugging.
    ///
    /// # Arguments
    ///
    /// * `message` - The message to dead letter
    /// * `reason` - Optional reason for dead lettering
    /// * `error_description` - Optional error description
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn dead_letter_message(
        &mut self,
        message: &azservicebus::ServiceBusReceivedMessage,
        reason: Option<String>,
        error_description: Option<String>,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            let options = DeadLetterOptions {
                dead_letter_reason: reason,
                dead_letter_error_description: error_description,
                properties_to_modify: None,
            };
            receiver.dead_letter_message(message, options).await?;
            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Completes a message, removing it from the queue.
    ///
    /// This indicates successful processing of the message.
    ///
    /// # Arguments
    ///
    /// * `message` - The message to complete
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn complete_message(
        &mut self,
        message: &azservicebus::ServiceBusReceivedMessage,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            receiver.complete_message(message).await?;
            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Completes multiple messages in a batch for better performance.
    ///
    /// Attempts to complete all provided messages, logging results for each.
    /// If any message fails to complete, the operation continues with remaining
    /// messages and returns an error indicating the failure count.
    ///
    /// # Arguments
    ///
    /// * `messages` - Slice of messages to complete
    ///
    /// # Returns
    ///
    /// `Ok(())` if all messages were completed successfully,
    /// `Err` if any messages failed to complete
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if any message completion fails
    pub async fn complete_messages(
        &mut self,
        messages: &[azservicebus::ServiceBusReceivedMessage],
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            // Complete messages one by one since batch completion may not be available
            let mut completed_count = 0;
            let mut failed_count = 0;

            for message in messages {
                let message_id = message
                    .message_id()
                    .map(|s| s.to_string())
                    .unwrap_or_else(|| "unknown".to_string());
                let sequence = message.sequence_number();

                match receiver.complete_message(message).await {
                    Ok(()) => {
                        completed_count += 1;
                        log::debug!(
                            "Successfully completed message {message_id} (sequence: {sequence})"
                        );
                    }
                    Err(e) => {
                        failed_count += 1;
                        log::error!(
                            "Failed to complete message {message_id} (sequence: {sequence}): {e}"
                        );
                        // Don't return early - try to complete as many as possible
                    }
                }
            }

            log::info!(
                "Batch completion result: {} successful, {} failed out of {} messages",
                completed_count,
                failed_count,
                messages.len()
            );

            if failed_count > 0 {
                return Err(format!(
                    "Failed to complete {} out of {} messages",
                    failed_count,
                    messages.len()
                )
                .into());
            }

            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Abandons multiple messages in a batch.
    ///
    /// All provided messages are returned to the queue for redelivery.
    ///
    /// # Arguments
    ///
    /// * `messages` - Slice of messages to abandon
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if any abandon operation fails
    pub async fn abandon_messages(
        &mut self,
        messages: &[azservicebus::ServiceBusReceivedMessage],
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            for message in messages {
                receiver.abandon_message(message, None).await?;
            }
            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Renews the lock on a received message to extend processing time.
    ///
    /// This prevents the message from becoming available for redelivery
    /// while it's still being processed.
    ///
    /// # Arguments
    ///
    /// * `message` - The message whose lock should be renewed
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the lock renewal fails
    pub async fn renew_message_lock(
        &mut self,
        message: &mut azservicebus::ServiceBusReceivedMessage,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            receiver.renew_message_lock(message).await?;
            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Renews locks on multiple messages.
    ///
    /// Attempts to renew locks for all provided messages, logging results.
    /// Continues processing all messages even if some renewals fail.
    ///
    /// # Arguments
    ///
    /// * `messages` - Mutable slice of messages whose locks should be renewed
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed. Lock renewal failures
    /// are logged but do not cause the method to return an error.
    pub async fn renew_message_locks(
        &mut self,
        messages: &mut [azservicebus::ServiceBusReceivedMessage],
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            let mut renewed_count = 0;
            let mut failed_count = 0;

            for message in messages.iter_mut() {
                let message_id = message
                    .message_id()
                    .map(|s| s.to_string())
                    .unwrap_or_else(|| "unknown".to_string());
                let sequence = message.sequence_number();

                match receiver.renew_message_lock(message).await {
                    Ok(()) => {
                        renewed_count += 1;
                        log::debug!(
                            "Successfully renewed lock for message {message_id} (sequence: {sequence})"
                        );
                    }
                    Err(e) => {
                        failed_count += 1;
                        log::warn!(
                            "Failed to renew lock for message {message_id} (sequence: {sequence}): {e}"
                        );
                        // Continue trying to renew other locks
                    }
                }
            }

            log::debug!(
                "Lock renewal result: {} successful, {} failed out of {} messages",
                renewed_count,
                failed_count,
                messages.len()
            );

            if failed_count > 0 {
                log::warn!(
                    "Failed to renew locks for {} out of {} messages - some may expire during processing",
                    failed_count,
                    messages.len()
                );
            }

            Ok(())
        } else {
            Err("Receiver already disposed".into())
        }
    }

    /// Disposes the underlying Service Bus receiver, releasing all resources.
    ///
    /// After disposal, all other operations on this Consumer will fail.
    ///
    /// # Errors
    ///
    /// Returns an error if the disposal operation fails
    pub async fn dispose(&self) -> Result<(), Box<dyn std::error::Error>> {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.take() {
            receiver.dispose().await?;
        }
        Ok(())
    }

    /// Receives deferred messages by their sequence numbers.
    ///
    /// This allows operations (delete/complete) on messages that were previously
    /// deferred without re-activating them in the main queue first.
    ///
    /// # Arguments
    ///
    /// * `sequence_numbers` - Array of sequence numbers for the deferred messages
    ///
    /// # Returns
    ///
    /// Vector of received deferred messages that are locked for processing
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver has been disposed or if the Service Bus operation fails
    pub async fn receive_deferred_messages(
        &mut self,
        sequence_numbers: &[i64],
    ) -> Result<
        Vec<azservicebus::ServiceBusReceivedMessage>,
        Box<dyn std::error::Error + Send + Sync>,
    > {
        let mut guard = self.receiver.lock().await;
        if let Some(receiver) = guard.as_mut() {
            let messages = receiver
                .receive_deferred_messages(sequence_numbers.to_vec())
                .await?;
            Ok(messages)
        } else {
            Err("Receiver already disposed".into())
        }
    }
}

/// Extension trait for ServiceBusClient to create Consumer instances.
///
/// This trait provides a convenient method to create a Consumer directly
/// from a ServiceBusClient without manually creating the receiver first.
pub trait ServiceBusClientExt {
    /// Creates a Consumer for the specified queue.
    ///
    /// # Arguments
    ///
    /// * `queue_name` - Name of the queue to create a consumer for
    /// * `options` - Configuration options for the receiver
    ///
    /// # Returns
    ///
    /// A Consumer instance configured for the specified queue
    ///
    /// # Errors
    ///
    /// Returns an error if the receiver creation fails
    fn create_consumer_for_queue(
        &mut self,
        queue_name: impl Into<String> + Send,
        options: ServiceBusReceiverOptions,
    ) -> impl Future<Output = Result<Consumer, azure_core::Error>>;
}

impl<RP> ServiceBusClientExt for ServiceBusClient<RP>
where
    RP: azservicebus::ServiceBusRetryPolicy
        + From<azservicebus::ServiceBusRetryOptions>
        + Send
        + Sync
        + 'static,
{
    /// Creates a Consumer for the specified queue using this ServiceBusClient.
    ///
    /// This method handles the creation of the underlying receiver and wraps it
    /// in a Consumer instance for easier usage.
    async fn create_consumer_for_queue(
        &mut self,
        queue_name: impl Into<String> + Send,
        options: ServiceBusReceiverOptions,
    ) -> Result<Consumer, azure_core::Error> {
        let receiver = self
            .create_receiver_for_queue(queue_name, options)
            .await
            .map_err(|e| {
                azure_core::Error::message(
                    azure_core::error::ErrorKind::Other,
                    format!("Receiver error: {e}"),
                )
            })?;

        Ok(Consumer::new(receiver))
    }
}