Refactor and update dependencies and logging level

giovanninocco · giovanninocco · commit 63533a2ccfb6 · 2024-07-27T08:42:51.000+02:00
- Changed logging level in `appsettings.json` from "information" to "debug".
- Downgraded `MongoDB.Driver` in `Genocs.Persistence.MongoDb.csproj` from 2.28.0 to 2.27.0.
- Made `Role` and `AccessToken` properties nullable in `AuthDto.cs` and added a class-level comment.
- Reformatted constructors in `RefreshToken.cs`, `InvalidNameException.cs`, and `AppException.cs` for readability.
- Updated `GetCode` method in `ExceptionToResponseMapper.cs` to return a nullable string and reformatted the method.
- Added null check for `users` in `Extensions.cs` and reformatted the code.
- Reformatted `IJwtProvider.cs`, `JwtProvider.cs`, `MessageBroker.cs`, `Program.cs`, `CreateProductHandler.cs`, and `HubService.cs` for readability.
- Updated comments in `GetOrderHandler.cs` for clarity.
- Removed constructor from `CreateProduct.cs`.
- Removed namespace declaration from `BrowseProductsHandler.cs`.
- Added closing brace in `OperationUpdatedHandler.cs`.
diff --git a/src/Genocs.Core.Demo.WebApi/appsettings.json b/src/Genocs.Core.Demo.WebApi/appsettings.json
@@ -8,7 +8,7 @@
     "displayVersion": true
   },
   "logger": {
-    "level": "information",
+    "level": "debug",
     "applicationName": "demo-service",
     "excludePaths": [ "/ping", "/metrics" ],
     "console": {
diff --git a/src/Genocs.Persistence.MongoDb/Genocs.Persistence.MongoDb.csproj b/src/Genocs.Persistence.MongoDb/Genocs.Persistence.MongoDb.csproj
@@ -50,7 +50,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="MongoDB.Driver" Version="2.28.0" />
+        <PackageReference Include="MongoDB.Driver" Version="2.27.0" />
         <PackageReference Include="MongoDB.Driver.Core.Extensions.DiagnosticSources" Version="1.4.0" />
     </ItemGroup>
 
diff --git a/src/apps/identity/Genocs.Identities.Application/DTO/AuthDto.cs b/src/apps/identity/Genocs.Identities.Application/DTO/AuthDto.cs
@@ -1,11 +1,14 @@
 namespace Genocs.Identities.Application.DTO;
 
+/// <summary>
+/// The AuthDto class.
+/// </summary>
 public class AuthDto
 {
     public Guid UserId { get; set; }
     public string Username { get; set; }
-    public string Role { get; set; }
-    public string AccessToken { get; set; }
+    public string? Role { get; set; }
+    public string? AccessToken { get; set; }
     public string RefreshToken { get; set; }
     public long Expires { get; set; }
 }
diff --git a/src/apps/identity/Genocs.Identities.Application/Domain/Entities/RefreshToken.cs b/src/apps/identity/Genocs.Identities.Application/Domain/Entities/RefreshToken.cs
@@ -10,8 +10,13 @@ public class RefreshToken : AggregateRoot
     public DateTime? RevokedAt { get; private set; }
     public bool Revoked => RevokedAt.HasValue;
 
-    public RefreshToken(AggregateId id, AggregateId userId, string token, DateTime createdAt,
-        DateTime? revokedAt = null) : base(id)
+    public RefreshToken(
+                        AggregateId id,
+                        AggregateId userId,
+                        string token,
+                        DateTime createdAt,
+                        DateTime? revokedAt = null)
+        : base(id)
     {
         if (string.IsNullOrWhiteSpace(token))
         {
diff --git a/src/apps/identity/Genocs.Identities.Application/Domain/Exceptions/InvalidNameException.cs b/src/apps/identity/Genocs.Identities.Application/Domain/Exceptions/InvalidNameException.cs
@@ -2,7 +2,8 @@ namespace Genocs.Identities.Application.Domain.Exceptions;
 
 public class InvalidNameException : DomainException
 {
-    public InvalidNameException(string name) : base($"Invalid name: {name}.")
+    public InvalidNameException(string name)
+        : base($"Invalid name: {name}.")
     {
     }
 }
diff --git a/src/apps/identity/Genocs.Identities.Application/Exceptions/AppException.cs b/src/apps/identity/Genocs.Identities.Application/Exceptions/AppException.cs
@@ -2,7 +2,8 @@ namespace Genocs.Identities.Application.Exceptions;
 
 public abstract class AppException : Exception
 {
-    protected AppException(string message) : base(message)
+    protected AppException(string message)
+        : base(message)
     {
     }
 }
diff --git a/src/apps/identity/Genocs.Identities.Application/Exceptions/ExceptionToResponseMapper.cs b/src/apps/identity/Genocs.Identities.Application/Exceptions/ExceptionToResponseMapper.cs
@@ -13,24 +13,24 @@ public class ExceptionToResponseMapper : IExceptionToResponseMapper
     public ExceptionResponse Map(Exception exception)
         => exception switch
         {
-            DomainException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message },
-                HttpStatusCode.BadRequest),
-            AppException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message },
-                HttpStatusCode.BadRequest),
-            _ => new ExceptionResponse(new { code = "error", reason = "There was an error." },
-                HttpStatusCode.BadRequest)
+            DomainException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message }, HttpStatusCode.BadRequest),
+            AppException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message }, HttpStatusCode.BadRequest),
+            _ => new ExceptionResponse(new { code = "error", reason = "There was an error." }, HttpStatusCode.BadRequest)
         };
 
-    private static string GetCode(Exception exception)
+    private static string? GetCode(Exception exception)
     {
         var type = exception.GetType();
-        if (Codes.TryGetValue(type, out var code))
+        if (Codes.TryGetValue(type, out string? code))
         {
             return code;
         }
 
-        var exceptionCode = exception.GetType().Name.Underscore().Replace("_exception", string.Empty);
-        Codes.TryAdd(type, exceptionCode);
+        string? exceptionCode = exception.GetType().Name.Underscore()?.Replace("_exception", string.Empty);
+        if (!string.IsNullOrWhiteSpace(exceptionCode))
+        {
+            Codes.TryAdd(type, exceptionCode);
+        }
 
         return exceptionCode;
     }
diff --git a/src/apps/identity/Genocs.Identities.Application/Mongo/Extensions.cs b/src/apps/identity/Genocs.Identities.Application/Mongo/Extensions.cs
@@ -11,17 +11,26 @@ public static class Extensions
     public static IApplicationBuilder UseMongo(this IApplicationBuilder builder)
     {
         using var scope = builder.ApplicationServices.CreateScope();
-        var users = scope.ServiceProvider.GetService<IMongoRepository<UserDocument, Guid>>().Collection;
+        var users = scope.ServiceProvider.GetService<IMongoRepository<UserDocument, Guid>>()?.Collection;
+
+        if (users is null)
+        {
+            return builder;
+        }
+
         var userBuilder = Builders<UserDocument>.IndexKeys;
+
         Task.Run(async () => await users.Indexes.CreateManyAsync(
             new[]
             {
-                new CreateIndexModel<UserDocument>(userBuilder.Ascending(i => i.Email),
+                new CreateIndexModel<UserDocument>(
+                    userBuilder.Ascending(i => i.Email),
                     new CreateIndexOptions
                     {
                         Unique = true
                     }),
-                new CreateIndexModel<UserDocument>(userBuilder.Ascending(i => i.Name),
+                new CreateIndexModel<UserDocument>(
+                    userBuilder.Ascending(i => i.Name),
                     new CreateIndexOptions
                     {
                         Unique = true
diff --git a/src/apps/identity/Genocs.Identities.Application/Services/IJwtProvider.cs b/src/apps/identity/Genocs.Identities.Application/Services/IJwtProvider.cs
@@ -3,10 +3,15 @@
 namespace Genocs.Identities.Application.Services;
 
 /// <summary>
-/// JwtProvider interface definition
+/// JwtProvider interface definition.
 /// </summary>
 public interface IJwtProvider
 {
-    AuthDto Create(Guid userId, string username, string role, string? audience = null,
-        IDictionary<string, IEnumerable<string>>? claims = null);
+    AuthDto Create(
+                    Guid userId,
+                    string username,
+                    string role,
+                    string? audience = null,
+                    IDictionary<string,
+                    IEnumerable<string>>? claims = null);
 }
diff --git a/src/apps/identity/Genocs.Identities.Application/Services/JwtProvider.cs b/src/apps/identity/Genocs.Identities.Application/Services/JwtProvider.cs
@@ -12,11 +12,12 @@ public JwtProvider(IJwtHandler jwtHandler)
         _jwtHandler = jwtHandler;
     }
 
-    public AuthDto Create(Guid userId,
-                          string username,
-                          string role,
-                          string? audience = null,
-                          IDictionary<string, IEnumerable<string>>? claims = null)
+    public AuthDto Create(
+                            Guid userId,
+                            string username,
+                            string role,
+                            string? audience = null,
+                            IDictionary<string, IEnumerable<string>>? claims = null)
     {
         var jwt = _jwtHandler.CreateToken(userId.ToString("N"), role, audience, claims);
 
diff --git a/src/apps/identity/Genocs.Identities.Application/Services/MessageBroker.cs b/src/apps/identity/Genocs.Identities.Application/Services/MessageBroker.cs
@@ -21,10 +21,15 @@ internal class MessageBroker : IMessageBroker
     private readonly ILogger<IMessageBroker> _logger;
     private readonly string _spanContextHeader;
 
-    public MessageBroker(IBusPublisher busPublisher, IMessageOutbox outbox,
-        ICorrelationContextAccessor contextAccessor, IHttpContextAccessor httpContextAccessor,
-        IMessagePropertiesAccessor messagePropertiesAccessor, ICorrelationIdFactory correlationIdFactory,
-        RabbitMQOptions options, ILogger<IMessageBroker> logger)
+    public MessageBroker(
+                            IBusPublisher busPublisher,
+                            IMessageOutbox outbox,
+                            ICorrelationContextAccessor contextAccessor,
+                            IHttpContextAccessor httpContextAccessor,
+                            IMessagePropertiesAccessor messagePropertiesAccessor,
+                            ICorrelationIdFactory correlationIdFactory,
+                            RabbitMQOptions options,
+                            ILogger<IMessageBroker> logger)
     {
         if (options is null)
         {
@@ -53,11 +58,12 @@ private async Task PublishAsync(IEnumerable<IEvent>? events)
         }
 
         var messageProperties = _messagePropertiesAccessor.MessageProperties;
-        var originatedMessageId = messageProperties?.MessageId;
-        var correlationId = _correlationIdFactory.Create();
-        var spanContext = messageProperties?.GetSpanContext(_spanContextHeader);
-        var correlationContext = _contextAccessor.CorrelationContext ??
+        string? originatedMessageId = messageProperties?.MessageId;
+        string? correlationId = _correlationIdFactory.Create();
+        string? spanContext = messageProperties?.GetSpanContext(_spanContextHeader);
+        object correlationContext = _contextAccessor.CorrelationContext ??
                                  _httpContextAccessor.GetCorrelationContext();
+
         var headers = new Dictionary<string, object>();
 
         foreach (var @event in events)
@@ -67,11 +73,12 @@ private async Task PublishAsync(IEnumerable<IEvent>? events)
                 continue;
             }
 
-            var messageId = Guid.NewGuid().ToString("N");
+            string messageId = Guid.NewGuid().ToString("N");
             _logger.LogTrace($"Publishing integration event: {@event.GetType().Name.Underscore()} [ID: '{messageId}'].");
             if (_outbox.Enabled)
             {
-                await _outbox.SendAsync(@event,
+                await _outbox.SendAsync(
+                                        @event,
                                         originatedMessageId,
                                         messageId,
                                         correlationId,
@@ -81,12 +88,13 @@ await _outbox.SendAsync(@event,
                 continue;
             }
 
-            await _busPublisher.PublishAsync(@event,
-                                             messageId,
-                                             correlationId,
-                                             spanContext,
-                                             correlationContext,
-                                             headers);
+            await _busPublisher.PublishAsync(
+                                                @event,
+                                                messageId,
+                                                correlationId,
+                                                spanContext,
+                                                correlationContext,
+                                                headers);
         }
     }
 }
diff --git a/src/apps/orders/Genocs.Orders.WebApi/Program.cs b/src/apps/orders/Genocs.Orders.WebApi/Program.cs
@@ -81,8 +81,7 @@
         .Get(string.Empty, ctx => ctx.Response.WriteAsync("Orders Service"))
         .Get("ping", ctx => ctx.Response.WriteAsync("pong"))
         .Get<GetOrder, OrderDto>("orders/{orderId}")
-        .Post<CreateOrder>("orders",
-            afterDispatch: (cmd, ctx) => ctx.Response.Created($"orders/{cmd.OrderId}")))
+        .Post<CreateOrder>("orders",            afterDispatch: (cmd, ctx) => ctx.Response.Created($"orders/{cmd.OrderId}")))
     .UseJaeger()
     .UseSwaggerDocs()
     .UseRabbitMq()
diff --git a/src/apps/orders/Genocs.Orders.WebApi/Queries/Handlers/GetOrderHandler.cs b/src/apps/orders/Genocs.Orders.WebApi/Queries/Handlers/GetOrderHandler.cs
@@ -15,10 +15,10 @@ public GetOrderHandler(IMongoRepository<Order, Guid> repository)
     }
 
     /// <summary>
-    /// GetOrder query handler
+    /// GetOrder query handler.
     /// </summary>
-    /// <param name="query">The query</param>
-    /// <param name="cancellationToken">The cancellation token</param>
+    /// <param name="query">The query.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
     /// <returns></returns>
     public async Task<OrderDto?> HandleAsync(GetOrder query, CancellationToken cancellationToken = default)
     {
diff --git a/src/apps/products/Genocs.Products.WebApi/Commands/CreateProduct.cs b/src/apps/products/Genocs.Products.WebApi/Commands/CreateProduct.cs
@@ -8,7 +8,6 @@ public class CreateProduct : ICommand
     public string SKU { get; }
     public decimal UnitPrice { get; }
 
-
     public CreateProduct(Guid productId, string sku, decimal unitPrice)
     {
         ProductId = productId == Guid.Empty ? Guid.NewGuid() : productId;
diff --git a/src/apps/products/Genocs.Products.WebApi/Commands/Handlers/CreateProductHandler.cs b/src/apps/products/Genocs.Products.WebApi/Commands/Handlers/CreateProductHandler.cs
@@ -16,9 +16,12 @@ public class CreateProductHandler : ICommandHandler<CreateProduct>
     private readonly ILogger<CreateProductHandler> _logger;
     private readonly ITracer _tracer;
 
-    public CreateProductHandler(IMongoRepository<Product, Guid> repository, IBusPublisher publisher,
-        IMessageOutbox outbox, ITracer tracer,
-        ILogger<CreateProductHandler> logger)
+    public CreateProductHandler(
+                                IMongoRepository<Product, Guid> repository,
+                                IBusPublisher publisher,
+                                IMessageOutbox outbox,
+                                ITracer tracer,
+                                ILogger<CreateProductHandler> logger)
     {
         _repository = repository;
         _publisher = publisher;
@@ -29,7 +32,7 @@ public CreateProductHandler(IMongoRepository<Product, Guid> repository, IBusPubl
 
     public async Task HandleAsync(CreateProduct command, CancellationToken cancellationToken = default)
     {
-        var exists = await _repository.ExistsAsync(o => o.Id == command.ProductId);
+        bool exists = await _repository.ExistsAsync(o => o.Id == command.ProductId);
         if (exists)
         {
             throw new InvalidOperationException($"Product with given id: {command.ProductId} already exists!");
@@ -40,7 +43,7 @@ public async Task HandleAsync(CreateProduct command, CancellationToken cancellat
 
         _logger.LogInformation($"Created a product with id: {command.ProductId}, sku: {command.SKU}, unitPrice: {command.UnitPrice}.");
 
-        var spanContext = _tracer.ActiveSpan?.Context.ToString();
+        string? spanContext = _tracer.ActiveSpan?.Context.ToString();
         var @event = new ProductCreated(product.Id);
         if (_outbox.Enabled)
         {
diff --git a/src/apps/products/Genocs.Products.WebApi/Program.cs b/src/apps/products/Genocs.Products.WebApi/Program.cs
@@ -76,12 +76,11 @@
     .UseCertificateAuthentication()
     .UseEndpoints(r => r.MapControllers())
     .UseDispatcherEndpoints(endpoints => endpoints
-        .Get("", ctx => ctx.Response.WriteAsync("Products Service"))
+        .Get(string.Empty, ctx => ctx.Response.WriteAsync("Products Service"))
         .Get("ping", ctx => ctx.Response.WriteAsync("pong"))
         .Get<BrowseProducts, PagedResult<ProductDto>>("products")
         .Get<GetProduct, ProductDto>("products/{productId}")
-        .Post<CreateProduct>("products",
-            afterDispatch: (cmd, ctx) => ctx.Response.Created($"products/{cmd.ProductId}")))
+        .Post<CreateProduct>("products", afterDispatch: (cmd, ctx) => ctx.Response.Created($"products/{cmd.ProductId}")))
     .UseJaeger()
     .UseSwaggerDocs()
     .UseRabbitMq();
diff --git a/src/apps/products/Genocs.Products.WebApi/Queries/Handlers/BrowseProductsHandler.cs b/src/apps/products/Genocs.Products.WebApi/Queries/Handlers/BrowseProductsHandler.cs
@@ -4,7 +4,6 @@
 using Genocs.Products.WebApi.DTO;
 using MongoDB.Driver;
 
-
 namespace Genocs.Products.WebApi.Queries.Handlers;
 
 public class BrowseProductsHandler : IQueryHandler<BrowseProducts, PagedResult<ProductDto>>
@@ -25,7 +24,6 @@ public BrowseProductsHandler(IMongoDatabase database)
         var pagedResult = PagedResult<ProductDto>.From(result, result.Items.Select(x => Map(x)));
 
         return pagedResult;
-
     }
 
     private static ProductDto Map(Product product)
diff --git a/src/apps/signalr/Genocs.SignalR.WebApi/Exceptions/ExceptionToResponseMapper.cs b/src/apps/signalr/Genocs.SignalR.WebApi/Exceptions/ExceptionToResponseMapper.cs
@@ -14,22 +14,23 @@ public ExceptionResponse Map(Exception exception)
         {
             // DomainException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message },
             //    HttpStatusCode.BadRequest),
-            AppException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message },
-                HttpStatusCode.BadRequest),
-            _ => new ExceptionResponse(new { code = "error", reason = "There was an error." },
-                HttpStatusCode.BadRequest)
+            AppException ex => new ExceptionResponse(new { code = GetCode(ex), reason = ex.Message }, HttpStatusCode.BadRequest),
+            _ => new ExceptionResponse(new { code = "error", reason = "There was an error." }, HttpStatusCode.BadRequest)
         };
 
-    private static string GetCode(Exception exception)
+    private static string? GetCode(Exception exception)
     {
         var type = exception.GetType();
-        if (Codes.TryGetValue(type, out var code))
+        if (Codes.TryGetValue(type, out string? code))
         {
             return code;
         }
 
-        string exceptionCode = exception.GetType().Name.Underscore().Replace("_exception", string.Empty);
-        Codes.TryAdd(type, exceptionCode);
+        string? exceptionCode = exception.GetType().Name.Underscore()?.Replace("_exception", string.Empty);
+        if (!string.IsNullOrWhiteSpace(exceptionCode))
+        {
+            Codes.TryAdd(type, exceptionCode);
+        }
 
         return exceptionCode;
     }
diff --git a/src/apps/signalr/Genocs.SignalR.WebApi/Handlers/OperationUpdatedHandler.cs b/src/apps/signalr/Genocs.SignalR.WebApi/Handlers/OperationUpdatedHandler.cs
@@ -21,5 +21,4 @@ public async Task HandleAsync(OperationCompleted @event, CancellationToken cance
     public async Task HandleAsync(OperationRejected @event, CancellationToken cancellationToken = default)
         => await _hubService.PublishOperationRejectedAsync(@event);
 
-
 }
diff --git a/src/apps/signalr/Genocs.SignalR.WebApi/Program.cs b/src/apps/signalr/Genocs.SignalR.WebApi/Program.cs
@@ -73,8 +73,7 @@
     .UseDispatcherEndpoints(endpoints => endpoints
         .Get("", ctx => ctx.Response.WriteAsync("SignalR Service"))
         .Get("ping", ctx => ctx.Response.WriteAsync("pong"))
-        .Post<PublishNotification>("notifications",
-            afterDispatch: (cmd, ctx) => ctx.Response.Created($"notifications/{cmd.NotificationId}")))
+        .Post<PublishNotification>("notifications", afterDispatch: (cmd, ctx) => ctx.Response.Created($"notifications/{cmd.NotificationId}")))
     .UseJaeger()
     .UseSwaggerDocs()
     .UseRabbitMq();
diff --git a/src/apps/signalr/Genocs.SignalR.WebApi/Services/HubService.cs b/src/apps/signalr/Genocs.SignalR.WebApi/Services/HubService.cs

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ namespace Genocs.Identities.Application.Domain.Exceptions;`
`2`	`2`
`3`	`3`	`public class InvalidNameException : DomainException`
`4`	`4`	`{`
`5`		`- public InvalidNameException(string name) : base($"Invalid name: {name}.")`
	`5`	`+ public InvalidNameException(string name)`
	`6`	`+ : base($"Invalid name: {name}.")`
`6`	`7`	`{`
`7`	`8`	`}`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ namespace Genocs.Identities.Application.Exceptions;`
`2`	`2`
`3`	`3`	`public abstract class AppException : Exception`
`4`	`4`	`{`
`5`		`- protected AppException(string message) : base(message)`
	`5`	`+ protected AppException(string message)`
	`6`	`+ : base(message)`
`6`	`7`	`{`
`7`	`8`	`}`
`8`	`9`	`}`