Refactor interfaces and update Azure Key Vault options

Refactored various interfaces for better readability and added XML documentation comments. Introduced new generic interface `IDeletionAudited<TUser>`. Removed unnecessary `using` statements. Updated `OutboxProcessor` and `ServiceBusMessageDispatcher` for readability. Made several properties nullable in different classes and interfaces. Added new properties to `AzureKeyVaultOptions` and introduced `ExtensionsCertificates` for Azure Key Vault integration. Removed `UseAzureKeyVault` method from `Extensions` class.

Author: giovanninocco

src/Genocs.Core/Domain/Entities/Auditing/IDeletionAudited.cs

@@ -1,26 +1,25 @@
-namespace Genocs.Core.Domain.Entities.Auditing
+namespace Genocs.Core.Domain.Entities.Auditing;
+
+/// <summary>
+/// This interface is implemented by entities which wanted to store deletion information (who and when deleted).
+/// </summary>
+public interface IDeletionAudited : IHasDeletionTime
 {
     /// <summary>
-    /// This interface is implemented by entities which wanted to store deletion information (who and when deleted).
+    /// Which user deleted this entity.
     /// </summary>
-    public interface IDeletionAudited : IHasDeletionTime
-    {
-        /// <summary>
-        /// Which user deleted this entity?
-        /// </summary>
-        long? DeleterUserId { get; set; }
-    }
+    long? DeleterUserId { get; set; }
+}
 
+/// <summary>
+/// Adds navigation properties to <see cref="IDeletionAudited"/> interface for user.
+/// </summary>
+/// <typeparam name="TUser">Type of the user.</typeparam>
+public interface IDeletionAudited<TUser> : IDeletionAudited
+    where TUser : IEntity<long>
+{
     /// <summary>
-    /// Adds navigation properties to <see cref="IDeletionAudited"/> interface for user.
+    /// Reference to the deleter user of this entity.
     /// </summary>
-    /// <typeparam name="TUser">Type of the user</typeparam>
-    public interface IDeletionAudited<TUser> : IDeletionAudited
-        where TUser : IEntity<long>
-    {
-        /// <summary>
-        /// Reference to the deleter user of this entity.
-        /// </summary>
-        TUser DeleterUser { get; set; }
-    }
+    TUser DeleterUser { get; set; }
 }

src/Genocs.Core/Domain/Entities/Auditing/IFullAudited.cs

@@ -5,13 +5,12 @@ namespace Genocs.Core.Domain.Entities.Auditing;
 /// </summary>
 public interface IFullAudited : IAudited, IDeletionAudited
 {
-    
 }
 
 /// <summary>
 /// Adds navigation properties to <see cref="IFullAudited"/> interface for user.
 /// </summary>
-/// <typeparam name="TUser">Type of the user</typeparam>
+/// <typeparam name="TUser">Type of the user.</typeparam>
 public interface IFullAudited<TUser> : IAudited<TUser>, IFullAudited, IDeletionAudited<TUser>
     where TUser : IEntity<long>
 {

src/Genocs.Core/Domain/Entities/Auditing/IHasCreationTime.cs

@@ -1,7 +1,5 @@
 namespace Genocs.Core.Domain.Entities.Auditing;
 
-using System;
-
 /// <summary>
 /// An entity can implement this interface if <see cref="CreationTime"/> of this entity must be stored.
 /// <see cref="CreationTime"/> is automatically set when saving <see cref="Entity"/> to database.

src/Genocs.MessageBrokers.Outbox/IMessageOutbox.cs

@@ -1,19 +1,21 @@
 namespace Genocs.MessageBrokers.Outbox;
 
 /// <summary>
-/// The Message Outbox interface definition
+/// The Message Outbox interface definition.
 /// </summary>
 public interface IMessageOutbox
 {
     bool Enabled { get; }
 
     Task HandleAsync(string messageId, Func<Task> handler);
 
-    Task SendAsync<T>(T message,
-                      string? originatedMessageId = null,
-                      string? messageId = null,
-                      string? correlationId = null,
-                      string? spanContext = null,
-                      object? messageContext = null,
-                      IDictionary<string, object>? headers = null) where T : class;
+    Task SendAsync<T>(
+                        T message,
+                        string? originatedMessageId = null,
+                        string? messageId = null,
+                        string? correlationId = null,
+                        string? spanContext = null,
+                        object? messageContext = null,
+                        IDictionary<string, object>? headers = null)
+        where T : class;
 }

src/Genocs.MessageBrokers.Outbox/Processors/OutboxProcessor.cs

@@ -16,8 +16,11 @@ internal sealed class OutboxProcessor : IHostedService
     private readonly OutboxType _type;
     private Timer _timer;
 
-    public OutboxProcessor(IServiceProvider serviceProvider, IBusPublisher publisher, OutboxOptions options,
-        ILogger<OutboxProcessor> logger)
+    public OutboxProcessor(
+                            IServiceProvider serviceProvider,
+                            IBusPublisher publisher,
+                            OutboxOptions options,
+                            ILogger<OutboxProcessor> logger)
     {
         if (options.Enabled && options.IntervalMilliseconds <= 0)
         {
@@ -79,7 +82,7 @@ private void SendOutboxMessages(object state)
 
     private async Task SendOutboxMessagesAsync()
     {
-        var jobId = Guid.NewGuid().ToString("N");
+        string jobId = Guid.NewGuid().ToString("N");
         _logger.LogTrace($"Started processing outbox messages... [job id: '{jobId}']");
         var stopwatch = new Stopwatch();
         stopwatch.Start();

src/Genocs.MessageBrokers.RabbitMQ/Extensions.cs

@@ -30,9 +30,9 @@ public static class Extensions
     /// </summary>
     /// <param name="builder">The builder.</param>
     /// <param name="sectionName">the default section name.</param>
-    /// <param name="plugins"></param>
-    /// <param name="connectionFactoryConfigurator"></param>
-    /// <param name="serializer"></param>
+    /// <param name="plugins">The plugin action method.</param>
+    /// <param name="connectionFactoryConfigurator">The configurator.</param>
+    /// <param name="serializer">The serializer.</param>
     /// <returns></returns>
     /// <exception cref="ArgumentException">Raised when configuration is incorrect.</exception>
     public static IGenocsBuilder AddRabbitMq(

src/Genocs.MessageBrokers.RabbitMQ/FailedMessage.cs

@@ -4,19 +4,19 @@ namespace Genocs.MessageBrokers.RabbitMQ;
 
 public class FailedMessage
 {
-    public object Message { get; }
+    public object? Message { get; }
     public bool ShouldRetry { get; }
 
     [Description("This will only work if 'deadLetter' is enabled in RabbitMQ options." +
                  "For more information, see https://www.rabbitmq.com/dlx.html")]
     public bool MoveToDeadLetter { get; }
 
-    public FailedMessage(bool shouldRetry = true, bool moveToDeadLetter = true) : this(null, shouldRetry,
-        moveToDeadLetter)
+    public FailedMessage(bool shouldRetry = true, bool moveToDeadLetter = true)
+        : this(null, shouldRetry, moveToDeadLetter)
     {
     }
 
-    public FailedMessage(object message, bool shouldRetry = true, bool moveToDeadLetter = true)
+    public FailedMessage(object? message, bool shouldRetry = true, bool moveToDeadLetter = true)
     {
         Message = message;
         ShouldRetry = shouldRetry;

src/Genocs.MessageBrokers.RabbitMQ/IConventionsBuilder.cs

@@ -1,5 +1,3 @@
-using System;
-
 namespace Genocs.MessageBrokers.RabbitMQ;
 
 public interface IConventionsBuilder

src/Genocs.MessageBrokers.RabbitMQ/Subscribers/MessageSubscriber.cs

@@ -4,10 +4,12 @@ internal class MessageSubscriber : IMessageSubscriber
 {
     public MessageSubscriberAction Action { get; }
     public Type Type { get; }
-    public Func<IServiceProvider, object, object, Task> Handle { get; }
+    public Func<IServiceProvider, object, object, Task>? Handle { get; }
 
-    private MessageSubscriber(MessageSubscriberAction action, Type type,
-        Func<IServiceProvider, object, object, Task> handle = null)
+    private MessageSubscriber(
+                                MessageSubscriberAction action,
+                                Type type,
+                                Func<IServiceProvider, object, object, Task>? handle = null)
     {
         Action = action;
         Type = type;

src/Genocs.MessageBrokers/CQRS/Dispatchers/ServiceBusMessageDispatcher.cs

@@ -14,9 +14,11 @@ public ServiceBusMessageDispatcher(IBusPublisher busPublisher, ICorrelationConte
         _accessor = accessor;
     }
 
-    public Task SendAsync<T>(T command, CancellationToken cancellationToken = default) where T : class, ICommand
+    public Task SendAsync<T>(T command, CancellationToken cancellationToken = default)
+        where T : class, ICommand
         => _busPublisher.SendAsync(command, _accessor.CorrelationContext);
 
-    public Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default) where T : class, IEvent
+    public Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default)
+        where T : class, IEvent
         => _busPublisher.PublishAsync(@event, _accessor.CorrelationContext);
 }