refactor: ♻️ refactor problem details exception handler (#14)

mehdihadeli · Sep 9, 2024 · 0cf21fa · 0cf21fa
1 parent 848e805
commit 0cf21fa
Show file tree

Hide file tree

Showing 34 changed files with 667 additions and 1,348 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,8 +2,9 @@
   "name": "Vertical.Slice.Template",
   "version": "1.0.0",
   "scripts": {
-    "prepare": "husky install && dotnet tool restore",
-    "install-dev-cert-bash": "curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v vs2019 -l ~/vsdbg"
+    "prepare": "husky && dotnet tool restore",
+    "install-dev-cert-bash": "curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v vs2019 -l ~/vsdbg",
+    "upgrade-packages": "dotnet outdated Vertical.Slice.Template.sln"
   },
   "repository": {
     "type": "git",
@@ -16,8 +17,8 @@
   },
   "homepage": "https://github.com/mehdihadeli/vertical-slice-api-template#readme",
   "devDependencies": {
-    "@commitlint/cli": "^17.4.2",
-    "@commitlint/config-conventional": "^17.4.2",
-    "husky": "^8.0.3"
+    "@commitlint/cli": "^19.4.1",
+    "@commitlint/config-conventional": "^19.4.1",
+    "husky": "^9.1.5"
   }
 }
diff --git a/src/App/Vertical.Slice.Template/Shared/Data/CatalogsDbContextDesignFactory.cs b/src/App/Vertical.Slice.Template/Shared/Data/CatalogsDbContextDesignFactory.cs
@@ -4,4 +4,5 @@ namespace Vertical.Slice.Template.Shared.Data;
 
 public class CatalogsDbContextDesignFactory()
     : DbContextDesignFactoryBase<CatalogsDbContext>(
-        $"{nameof(PostgresOptions)}:{nameof(PostgresOptions.ConnectionString)}");
+        $"{nameof(PostgresOptions)}:{nameof(PostgresOptions.ConnectionString)}"
+    );
diff --git a/....Slice.Template/Shared/Data/Migrations/Catalogs/20240821165201_InitialCatalogMigration.cs b/....Slice.Template/Shared/Data/Migrations/Catalogs/20240821165201_InitialCatalogMigration.cs
@@ -11,8 +11,7 @@ public partial class InitialCatalogMigration : Migration
         /// <inheritdoc />
         protected override void Up(MigrationBuilder migrationBuilder)
         {
-            migrationBuilder.EnsureSchema(
-                name: "catalog");
+            migrationBuilder.EnsureSchema(name: "catalog");
 
             migrationBuilder.CreateTable(
                 name: "products",
@@ -23,27 +22,27 @@ protected override void Up(MigrationBuilder migrationBuilder)
                     price = table.Column<decimal>(type: "numeric(18,2)", nullable: false),
                     category_id = table.Column<Guid>(type: "uuid", nullable: false),
                     name = table.Column<string>(type: "character varying(50)", maxLength: 50, nullable: false),
-                    description = table.Column<string>(type: "character varying(250)", maxLength: 250, nullable: true)
+                    description = table.Column<string>(type: "character varying(250)", maxLength: 250, nullable: true),
                 },
                 constraints: table =>
                 {
                     table.PrimaryKey("pk_products", x => x.id);
-                });
+                }
+            );
 
             migrationBuilder.CreateIndex(
                 name: "ix_products_id",
                 schema: "catalog",
                 table: "products",
                 column: "id",
-                unique: true);
+                unique: true
+            );
         }
 
         /// <inheritdoc />
         protected override void Down(MigrationBuilder migrationBuilder)
         {
-            migrationBuilder.DropTable(
-                name: "products",
-                schema: "catalog");
+            migrationBuilder.DropTable(name: "products", schema: "catalog");
         }
     }
 }
diff --git a/src/Shared/Cache/Behaviours/CachingBehavior.cs b/src/Shared/Cache/Behaviours/CachingBehavior.cs
@@ -56,9 +56,9 @@ CancellationToken cancellationToken
         var expiredTimeSpan =
             cacheRequest.AbsoluteExpirationRelativeToNow != TimeSpan.FromMinutes(5)
                 ? cacheRequest.AbsoluteExpirationRelativeToNow
-                : TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute) != TimeSpan.FromMinutes(5)
-                    ? TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute)
-                    : cacheRequest.AbsoluteExpirationRelativeToNow;
+            : TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute) != TimeSpan.FromMinutes(5)
+                ? TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute)
+            : cacheRequest.AbsoluteExpirationRelativeToNow;
 
         await _cacheProvider.SetAsync(cacheKey, response, expiredTimeSpan, cancellationToken);
 
@@ -126,9 +126,9 @@ CancellationToken cancellationToken
         var expiredTimeSpan =
             cacheRequest.AbsoluteExpirationRelativeToNow != TimeSpan.FromMinutes(5)
                 ? cacheRequest.AbsoluteExpirationRelativeToNow
-                : TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute) != TimeSpan.FromMinutes(5)
-                    ? TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute)
-                    : cacheRequest.AbsoluteExpirationRelativeToNow;
+            : TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute) != TimeSpan.FromMinutes(5)
+                ? TimeSpan.FromMinutes(_cacheOptions.ExpirationTimeInMinute)
+            : cacheRequest.AbsoluteExpirationRelativeToNow;
 
         await foreach (var response in next().WithCancellation(cancellationToken))
         {

diff --git a/src/Shared/Cache/Extensions.cs b/src/Shared/Cache/Extensions.cs
@@ -24,7 +24,7 @@ public static WebApplicationBuilder AddCustomEasyCaching(this WebApplicationBuil
                     {
                         config.DBConfig = new RedisDBOptions
                         {
-                            Configuration = cacheOptions.RedisCacheOptions.ConnectionString
+                            Configuration = cacheOptions.RedisCacheOptions.ConnectionString,
                         };
                         config.SerializerName = cacheOptions.SerializationType;
                     },
@@ -71,7 +71,7 @@ public static WebApplicationBuilder AddCustomRedis(this WebApplicationBuilder bu
                 new ConfigurationOptions
                 {
                     EndPoints = { $"{redisOptions.Host}:{redisOptions.Port}" },
-                    AllowAdmin = true
+                    AllowAdmin = true,
                 }
             );
         });

diff --git a/src/Shared/Core/Exceptions/AppException.cs b/src/Shared/Core/Exceptions/AppException.cs
@@ -2,12 +2,8 @@
 
 namespace Shared.Core.Exceptions;
 
-public class AppException : CustomException
-{
-    public AppException(
-        string message,
-        int statusCode = StatusCodes.Status400BadRequest,
-        Exception? innerException = null
-    )
-        : base(message, statusCode, innerException) { }
-}
+public class AppException(
+    string message,
+    int statusCode = StatusCodes.Status400BadRequest,
+    System.Exception? innerException = null
+) : CustomException(message, statusCode, innerException);
diff --git a/src/Shared/Core/Exceptions/BadRequestException.cs b/src/Shared/Core/Exceptions/BadRequestException.cs
@@ -2,8 +2,5 @@
 
 namespace Shared.Core.Exceptions;
 
-public class BadRequestException : CustomException
-{
-    public BadRequestException(string message, Exception? innerException = null)
-        : base(message, StatusCodes.Status400BadRequest, innerException) { }
-}
+public class BadRequestException(string message, System.Exception? innerException = null, params string[] errors)
+    : CustomException(message, StatusCodes.Status400BadRequest, innerException, errors);
diff --git a/src/Shared/Core/Exceptions/BusinessRuleValidationException.cs b/src/Shared/Core/Exceptions/BusinessRuleValidationException.cs
@@ -2,17 +2,10 @@
 
 namespace Shared.Core.Exceptions;
 
-public class BusinessRuleValidationException : DomainException
+public class BusinessRuleValidationException(IBusinessRule brokenRule) : DomainException(brokenRule.Message)
 {
-    public IBusinessRule BrokenRule { get; }
-    public string Details { get; }
-
-    public BusinessRuleValidationException(IBusinessRule brokenRule)
-        : base(brokenRule.Message)
-    {
-        BrokenRule = brokenRule;
-        Details = brokenRule.Message;
-    }
+    public IBusinessRule BrokenRule { get; } = brokenRule;
+    public string Details { get; } = brokenRule.Message;
 
     public override string ToString()
     {

diff --git a/src/Shared/Core/Exceptions/ConflictException.cs b/src/Shared/Core/Exceptions/ConflictException.cs
@@ -2,8 +2,5 @@
 
 namespace Shared.Core.Exceptions;
 
-public class ConflictException : CustomException
-{
-    public ConflictException(string message, Exception? innerException = null)
-        : base(message, StatusCodes.Status409Conflict, innerException) { }
-}
+public class ConflictException(string message, Exception? innerException = null)
+    : CustomException(message, StatusCodes.Status409Conflict, innerException);
diff --git a/src/Shared/Core/Exceptions/CustomException.cs b/src/Shared/Core/Exceptions/CustomException.cs
@@ -2,21 +2,15 @@
 
 namespace Shared.Core.Exceptions;
 
-public class CustomException : Exception
+public class CustomException(
+    string message,
+    int statusCode = StatusCodes.Status500InternalServerError,
+    Exception? innerException = null,
+    params string[] errors
+)
+    : Exception(message, innerException)
 {
-    public CustomException(
-        string message,
-        int statusCode = StatusCodes.Status500InternalServerError,
-        Exception? innerException = null,
-        params string[] errors
-    )
-        : base(message, innerException)
-    {
-        ErrorMessages = errors;
-        StatusCode = statusCode;
-    }
+    public IEnumerable<string> ErrorMessages { get; protected set; } = errors;
 
-    public IEnumerable<string> ErrorMessages { get; protected set; }
-
-    public int StatusCode { get; protected set; }
+    public int StatusCode { get; protected set; } = statusCode;
 }
diff --git a/src/Shared/Core/Exceptions/DomainException.cs b/src/Shared/Core/Exceptions/DomainException.cs
@@ -5,12 +5,9 @@ namespace Shared.Core.Exceptions;
 /// <summary>
 /// Exception type for domain exceptions.
 /// </summary>
-public class DomainException : CustomException
-{
-    public DomainException(
-        string message,
-        int statusCode = StatusCodes.Status400BadRequest,
-        Exception? innerException = null
-    )
-        : base(message, statusCode, innerException) { }
-}
+public class DomainException(
+    string message,
+    int statusCode = StatusCodes.Status400BadRequest,
+    Exception? innerException = null
+)
+    : CustomException(message, statusCode, innerException);
diff --git a/src/Shared/Core/Exceptions/NotFoundException.cs b/src/Shared/Core/Exceptions/NotFoundException.cs
@@ -2,8 +2,5 @@
 
 namespace Shared.Core.Exceptions;
 
-public class NotFoundException : CustomException
-{
-    public NotFoundException(string message, Exception? innerException = null)
-        : base(message, StatusCodes.Status404NotFound, innerException) { }
-}
+public class NotFoundException(string message, Exception? innerException = null)
+    : CustomException(message, StatusCodes.Status404NotFound, innerException);
diff --git a/src/Shared/Core/Exceptions/ValidationException.cs b/src/Shared/Core/Exceptions/ValidationException.cs
@@ -1,9 +1,4 @@
-using Microsoft.AspNetCore.Http;
-
 namespace Shared.Core.Exceptions;
 
-public class ValidationException : CustomException
-{
-    public ValidationException(string message, Exception? innerException = null, params string[] errors)
-        : base(message, StatusCodes.Status400BadRequest, innerException, errors) { }
-}
+public class ValidationException(string message, Exception? innerException = null, params string[] errors)
+    : BadRequestException(message, innerException, errors);
diff --git a/...ed/Core/Extensions/ServiceCollectionsExtensions/ServiceCollectionExtensions.Dependency.cs b/...ed/Core/Extensions/ServiceCollectionsExtensions/ServiceCollectionExtensions.Dependency.cs
@@ -273,7 +273,7 @@ public static void ValidateDependencies(
         params Assembly[] assembliesToScan
     )
     {
-        var scanAssemblies = assembliesToScan.Length != 0 ? assembliesToScan : [Assembly.GetExecutingAssembly(),];
+        var scanAssemblies = assembliesToScan.Length != 0 ? assembliesToScan : [Assembly.GetExecutingAssembly()];
 
         // for resolving scoped based dependencies without errors
         using var scope = rootServiceProvider.CreateScope();

diff --git a/src/Shared/Core/Extensions/ValidationExtensions.cs b/src/Shared/Core/Extensions/ValidationExtensions.cs
@@ -9,7 +9,7 @@ namespace Shared.Core.Extensions;
 // https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/attributes/caller-information
 public static class ValidationExtensions
 {
-    private static readonly HashSet<string> _allowedCurrency = new() { "USD", "EUR", };
+    private static readonly HashSet<string> _allowedCurrency = ["USD", "EUR",];
 
     public static T NotBeNull<T>(
         [NotNull] this T? argument,

diff --git a/src/Shared/Core/Reflection/Extensions/TypeExtensions.cs b/src/Shared/Core/Reflection/Extensions/TypeExtensions.cs
@@ -589,11 +589,9 @@ public static Type UnwrapEnumType(this Type type)
     }
 
     public static Type MakeNullable(this Type type, bool nullable = true) =>
-        type.IsNullableType() == nullable
-            ? type
-            : nullable
-                ? typeof(Nullable<>).MakeGenericType(type)
-                : type.UnwrapNullableType();
+        type.IsNullableType() == nullable ? type
+        : nullable ? typeof(Nullable<>).MakeGenericType(type)
+        : type.UnwrapNullableType();
 
     /// <summary>
     /// Helper method use to differentiate behavior between command/query/event handlers.

diff --git a/src/Shared/Core/Reflection/ReflectionUtilities.cs b/src/Shared/Core/Reflection/ReflectionUtilities.cs
@@ -120,14 +120,14 @@ public static TResult CompileMethodInvocation<TResult>(MethodInfo methodInfo)
                 .Compile();
         }
 
-        var lambdaArgument = new List<ParameterExpression> { instanceArgument, };
+        var lambdaArgument = new List<ParameterExpression> { instanceArgument };
 
         var type = methodInfo.DeclaringType;
         var instanceVariable = Expression.Variable(type);
-        var blockVariables = new List<ParameterExpression> { instanceVariable, };
+        var blockVariables = new List<ParameterExpression> { instanceVariable };
         var blockExpressions = new List<Expression>
         {
-            Expression.Assign(instanceVariable, Expression.ConvertChecked(instanceArgument, type))
+            Expression.Assign(instanceVariable, Expression.ConvertChecked(instanceArgument, type)),
         };
         var callArguments = new List<ParameterExpression>();
 

diff --git a/src/Shared/Logging/Extensions.cs b/src/Shared/Logging/Extensions.cs
@@ -85,7 +85,7 @@ public static WebApplicationBuilder AddCustomSerilog(
                                     builder.Environment.EnvironmentName
                                 }-{
                                     DateTime.Now
-                                    :yyyy-MM}"
+                                    :yyyy-MM}",
                         }
                     );
                 }
@@ -97,7 +97,7 @@ public static WebApplicationBuilder AddCustomSerilog(
                         serilogOptions.GrafanaLokiUrl,
                         new[]
                         {
-                            new LokiLabel { Key = "service", Value = "vertical-slice-api-template" }
+                            new LokiLabel { Key = "service", Value = "vertical-slice-api-template" },
                         },
                         new[] { "app" }
                     );

diff --git a/src/Shared/Swagger/ConfigureSwaggerOptions.cs b/src/Shared/Swagger/ConfigureSwaggerOptions.cs
@@ -41,7 +41,7 @@ private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription descrip
             Title = "Vertical.Slice.Template",
             Version = description.ApiVersion.ToString(),
             Contact = new OpenApiContact() { Name = "Bill Mei", Email = "[email protected]" },
-            License = new OpenApiLicense() { Name = "MIT", Url = new Uri("https://opensource.org/licenses/MIT") }
+            License = new OpenApiLicense() { Name = "MIT", Url = new Uri("https://opensource.org/licenses/MIT") },
         };
 
         if (description.IsDeprecated)

diff --git a/src/Shared/Validation/Extensions/ValidatorExtension.cs b/src/Shared/Validation/Extensions/ValidatorExtension.cs
@@ -15,7 +15,11 @@ public static async Task<TRequest> HandleValidationAsync<TRequest>(
     {
         var validationResult = await validator.ValidateAsync(request, cancellationToken).ConfigureAwait(false);
         if (!validationResult.IsValid)
-            throw new ValidationException(validationResult.ToValidationResultModel().Message);
+        {
+            throw new ValidationException(
+                validationResult.ToValidationResultModel().Errors?.FirstOrDefault()?.Message ??
+                validationResult.ToValidationResultModel().Message);
+        }
 
         return request;
     }
@@ -24,7 +28,11 @@ public static TRequest HandleValidation<TRequest>(this IValidator<TRequest> vali
     {
         var validationResult = validator.Validate(request);
         if (!validationResult.IsValid)
-            throw new ValidationException(validationResult.ToValidationResultModel().Message);
+        {
+            throw new ValidationException(
+                validationResult.ToValidationResultModel().Errors?.FirstOrDefault()?.Message ??
+                validationResult.ToValidationResultModel().Message);
+        }
 
         return request;
     }

diff --git a/src/Shared/Web/Extensions/HeaderDictionaryExtensions.cs b/src/Shared/Web/Extensions/HeaderDictionaryExtensions.cs
@@ -46,7 +46,7 @@ public static T Get<T>(
             {
                 ParameterPick.First => values.FirstOrDefault(),
                 ParameterPick.Last => values.LastOrDefault(),
-                _ => value
+                _ => value,
             };
         }
 
@@ -57,5 +57,5 @@ public static T Get<T>(
 public enum ParameterPick
 {
     First,
-    Last
+    Last,
 }
diff --git a/src/Shared/Web/Extensions/QueryCollectionExtensions.cs b/src/Shared/Web/Extensions/QueryCollectionExtensions.cs
@@ -47,7 +47,7 @@ public static T Get<T>(
             {
                 ParameterPick.First => values.FirstOrDefault(),
                 ParameterPick.Last => values.LastOrDefault(),
-                _ => value
+                _ => value,
             };
         }
 

diff --git a/src/Shared/Web/Minimal/Extensions/MinimalApiExtensions.cs b/src/Shared/Web/Minimal/Extensions/MinimalApiExtensions.cs
@@ -74,7 +74,7 @@ this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder builder
             {
                 x.GroupName,
                 x.PrefixRoute,
-                x.Version
+                x.Version,
             })
             .ToDictionary(
                 x => x.Key,
@@ -87,7 +87,7 @@ this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder builder
             {
                 Verion = x.Key.Version,
                 x.Key.GroupName,
-                Endpoints = x.Select(v => v)
+                Endpoints = x.Select(v => v),
             });
 
         foreach (var endpointVersion in endpointVersions)