FEAT: Adding new methods

Author: Felipe Mattioli

src/AzureServiceBusFlow/Abstractions/IServiceBusProducer.cs

@@ -2,13 +2,52 @@
 
 namespace AzureServiceBusFlow.Abstractions
 {
+    /// <summary>
+    /// Defines a producer responsible for sending messages to Azure Service Bus.
+    /// </summary>
+    /// <typeparam name="TMessage">The type of the message to be sent.</typeparam>
     public interface IServiceBusProducer<in TMessage> where TMessage : class, IServiceBusMessage
     {
+        /// <summary>
+        /// Sends a message to the Azure Service Bus without any additional options.
+        /// </summary>
+        /// <param name="message">The message to be sent.</param>
+        /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
         Task ProduceAsync(TMessage message, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends a message to the Azure Service Bus with custom producer options,
+        /// such as delivery delay or application properties.
+        /// </summary>
+        /// <param name="message">The message to be sent.</param>
+        /// <param name="producerOptions">Additional options for message delivery.</param>
+        /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
         Task ProduceAsync(
             TMessage message,
             MessageOptions producerOptions,
             CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Sends a message to the Azure Service Bus with a specified delivery delay.
+        /// </summary>
+        /// <param name="message">The message to be sent.</param>
+        /// <param name="delay">The delay duration before the message becomes available.</param>
+        /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
+        Task ProduceAsync(
+            TMessage message,
+            TimeSpan delay,
+            CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Sends a message to the Azure Service Bus with application properties
+        /// that can be used for downstream filtering or routing.
+        /// </summary>
+        /// <param name="message">The message to be sent.</param>
+        /// <param name="applicationProperties">Key-value pairs attached to the message.</param>
+        /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
+        Task ProduceAsync(
+            TMessage message,
+            IDictionary<string, string> applicationProperties,
+            CancellationToken cancellationToken);
     }
 }

src/AzureServiceBusFlow/Models/MessageOptions.cs

@@ -1,4 +1,4 @@
 namespace AzureServiceBusFlow.Models
 {
-    public record MessageOptions(TimeSpan? Delay, IDictionary<string, object>? ApplicationProperties);
+    public record MessageOptions(TimeSpan? Delay, IDictionary<string, string>? ApplicationProperties);
 }

src/AzureServiceBusFlow/Producers/CommandProducer.cs

@@ -3,19 +3,41 @@
 
 namespace AzureServiceBusFlow.Producers
 {
+    /// <summary>
+    /// A producer responsible for dispatching command messages through the underlying Service Bus producer.
+    /// </summary>
+    /// <typeparam name="TCommand">The type of command being produced.</typeparam>
     public class CommandProducer<TCommand>(IServiceBusProducer<TCommand> producer) : ICommandProducer<TCommand>
-    where TCommand : class, IServiceBusMessage
+        where TCommand : class, IServiceBusMessage
     {
         private readonly IServiceBusProducer<TCommand> _producer = producer;
 
+        /// <inheritdoc />
         public Task ProduceCommandAsync(TCommand command, CancellationToken cancellationToken)
         {
             return _producer.ProduceAsync(command, cancellationToken);
         }
 
+        /// <inheritdoc />
         public Task ProduceCommandAsync(TCommand command, MessageOptions messageOptions, CancellationToken cancellationToken)
         {
             return _producer.ProduceAsync(command, messageOptions, cancellationToken);
         }
+
+        /// <summary>
+        /// Produces a command with a delivery delay.
+        /// </summary>
+        public Task ProduceCommandAsync(TCommand command, TimeSpan delay, CancellationToken cancellationToken)
+        {
+            return _producer.ProduceAsync(command, delay, cancellationToken);
+        }
+
+        /// <summary>
+        /// Produces a command with application properties.
+        /// </summary>
+        public Task ProduceCommandAsync(TCommand command, IDictionary<string, string> applicationProperties, CancellationToken cancellationToken)
+        {
+            return _producer.ProduceAsync(command, applicationProperties, cancellationToken);
+        }
     }
 }

src/AzureServiceBusFlow/Producers/ServiceBusProducer.cs

@@ -15,29 +15,15 @@ public ServiceBusProducer(AzureServiceBusConfiguration azureServiceBusConfigurat
         {
             var client = new ServiceBusClient(azureServiceBusConfiguration.ConnectionString);
             _sender = client.CreateSender(queueOrTopicName);
-
             _logger = logger;
         }
 
         public async Task ProduceAsync(TMessage message, CancellationToken cancellationToken)
         {
-            var json = JsonConvert.SerializeObject(message);
-            var serviceBusMessage = new ServiceBusMessage(json)
-            {
-                Subject = message.RoutingKey,
-                ApplicationProperties =
-                {
-                    { "MessageType", message.GetType().FullName },
-                    { "CreatedAt", message.CreatedDate.ToString("O") }
-                }
-            };
-
-            await _sender.SendMessageAsync(serviceBusMessage, cancellationToken);
-
-            _logger.LogInformation("Message {MessageType} published with successfully!", message.GetType().Name);
+            await ProduceAsync(message, producerOptions: null, cancellationToken);
         }
 
-        public Task ProduceAsync(TMessage message, MessageOptions producerOptions, CancellationToken cancellationToken)
+        public async Task ProduceAsync(TMessage message, MessageOptions? producerOptions, CancellationToken cancellationToken)
         {
             var json = JsonConvert.SerializeObject(message);
             var serviceBusMessage = new ServiceBusMessage(json)
@@ -52,19 +38,31 @@ public Task ProduceAsync(TMessage message, MessageOptions producerOptions, Cance
 
             if (producerOptions?.ApplicationProperties is not null)
             {
-                producerOptions?.ApplicationProperties?
-                    .Where(kvp => !serviceBusMessage.ApplicationProperties.ContainsKey(kvp.Key))
-                    .ToList()
-                    .ForEach(kvp => serviceBusMessage.ApplicationProperties.Add(kvp.Key, kvp.Value));
+                foreach (var kvp in producerOptions.ApplicationProperties)
+                {
+                    if (!serviceBusMessage.ApplicationProperties.ContainsKey(kvp.Key))
+                        serviceBusMessage.ApplicationProperties.Add(kvp.Key, kvp.Value);
+                }
             }
 
             if (producerOptions?.Delay is not null)
             {
                 serviceBusMessage.ScheduledEnqueueTime = DateTimeOffset.UtcNow.Add(producerOptions.Delay.Value);
             }
 
-            return _sender.SendMessageAsync(serviceBusMessage, cancellationToken);
+            await _sender.SendMessageAsync(serviceBusMessage, cancellationToken);
+
+            _logger.LogInformation("Message {MessageType} published successfully!", message.GetType().Name);
         }
 
+        public Task ProduceAsync(TMessage message, TimeSpan delay, CancellationToken cancellationToken)
+        {
+            return ProduceAsync(message, new MessageOptions(delay, null), cancellationToken);
+        }
+
+        public Task ProduceAsync(TMessage message, IDictionary<string, string> applicationProperties, CancellationToken cancellationToken)
+        {
+            return ProduceAsync(message, new MessageOptions(null, applicationProperties), cancellationToken);
+        }
     }
 }