feat: Mudança no Result Pattern

samuelzedec · samuelzedec · commit 2d7687334092 · 2025-10-19T17:53:53.000-04:00
Após uma análise as mensagens não de validação de campos não ficavam claras do que qual propriedade era realmente o Error, então agora foi feita uma alteração para voltar a proprieadade Details e ajustar outras, ficando mais claro a resposta da API para erros de validação
diff --git a/src/Riber.Api/Common/Api/GlobalExceptionHandler.cs b/src/Riber.Api/Common/Api/GlobalExceptionHandler.cs
@@ -19,20 +19,19 @@ public async ValueTask<bool> TryHandleAsync(
     {
         logger.LogError(exception, "Exception occurred: {ExceptionType} - {Message}", 
             exception.GetType().Name, exception.Message);
-        
-        (int statusCode, string[] messages) = exception switch
-        {
-            RequestTimeoutException timeoutEx => (timeoutEx.Code, [timeoutEx.Message]),
-            ValidationException validationEx => (ValidationException.Code, validationEx.Messages.Select(e => e.ErrorMessage).ToArray()),
-            Layer.ApplicationException applicationEx => (applicationEx.Code, [applicationEx.Message]),
-            DomainException domainEx => (StatusCodes.Status422UnprocessableEntity, [domainEx.Message]),
-            _ => (StatusCodes.Status500InternalServerError, ["Erro inesperado no servidor!"])
-        };
-        
-        await httpContext.WriteUnauthorizedResponse(
-            code: statusCode,
-            messages: messages
-        );
+    
+        (int statusCode, string message, Dictionary<string, string[]> details) = MapExceptionToError(exception);
+        await httpContext.WriteErrorResponse(statusCode, message, details);
         return true;
     }
+
+    private static (int StatusCode, string Message, Dictionary<string, string[]> Details) MapExceptionToError(Exception exception)
+        => exception switch
+        {
+            RequestTimeoutException timeoutEx => (timeoutEx.Code, timeoutEx.Message, []),
+            ValidationException validationEx => (StatusCodes.Status400BadRequest, string.Empty, validationEx.Details),
+            Layer.ApplicationException applicationEx => (applicationEx.Code, applicationEx.Message, []),
+            DomainException domainEx => (StatusCodes.Status422UnprocessableEntity, domainEx.Message, []),
+            _ => (StatusCodes.Status500InternalServerError, "Erro inesperado no servidor.", [])
+        };
 }
diff --git a/src/Riber.Api/Extensions/HttpContextExtension.cs b/src/Riber.Api/Extensions/HttpContextExtension.cs
@@ -13,14 +13,18 @@ public static class HttpContextExtension
         DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
     };
 
-    public static async Task WriteUnauthorizedResponse(
+    public static async Task WriteErrorResponse(
         this HttpContext context,
         int code,
-        params string[] messages)
+        string message,
+        Dictionary<string, string[]> details)
     {
-        var jsonResponse = JsonSerializer.Serialize(
-            Result.Failure<object>(new Error(GetErrorCode(code), messages)), JsonOptions);
+        var errorType = GetErrorCode(code);
+        var response = details.Count == 0
+            ? Result.Failure<object>(new Error(errorType, message))
+            : Result.Failure<object>(new Error(errorType, details));
 
+        var jsonResponse = JsonSerializer.Serialize(response, JsonOptions);
         context.Response.StatusCode = code;
         context.Response.ContentType = "application/json";
 
diff --git a/src/Riber.Api/Middlewares/SecurityStampMiddleware.cs b/src/Riber.Api/Middlewares/SecurityStampMiddleware.cs
@@ -23,9 +23,10 @@ public async Task InvokeAsync(HttpContext context, RequestDelegate next)
         if (string.IsNullOrWhiteSpace(userId) || string.IsNullOrWhiteSpace(tokenSecurityStamp))
         {
             logger.LogError("Valores: userId = {UserId}, securityStamp = {TokenSecurityStamp}", userId, tokenSecurityStamp);
-            await context.WriteUnauthorizedResponse(
+            await context.WriteErrorResponse(
                 StatusCodes.Status401Unauthorized,
-                "Token do usuário inválido ou mal formado."
+                "Token do usuário inválido ou mal formado.",
+                details: []
             );
             return;
         }
@@ -34,9 +35,10 @@ await context.WriteUnauthorizedResponse(
         var user = await authService.FindByIdAsync(userId);
         if (user is null || user.SecurityStamp != tokenSecurityStamp)
         {
-            await context.WriteUnauthorizedResponse(
+            await context.WriteErrorResponse(
                 code: StatusCodes.Status401Unauthorized,
-                messages: "Security stamp inválido ou usuário não encontrado."
+                message: "Security stamp inválido ou usuário não encontrado.",
+                details: []
             );
             return;
         }
diff --git a/src/Riber.Application/Behaviors/ValidationBehavior.cs b/src/Riber.Application/Behaviors/ValidationBehavior.cs
@@ -1,7 +1,6 @@
 ﻿using FluentValidation;
 using Mediator;
-using Riber.Application.Common;
-using Exceptions_ValidationException = Riber.Application.Exceptions.ValidationException;
+using LayerValidationException = Riber.Application.Exceptions.ValidationException;
 
 namespace Riber.Application.Behaviors;
 
@@ -22,11 +21,14 @@ public async ValueTask<TResponse> Handle(
             .Select(x => x.Validate(context))
             .Where(x => !x.IsValid)
             .SelectMany(x => x.Errors)
-            .Select(x => new ValidationError(x.PropertyName, x.ErrorMessage))
-            .ToList();
+            .GroupBy(x => x.PropertyName)
+            .ToDictionary(
+                g => g.Key,
+                g => g.Select(x => x.ErrorMessage).ToArray()
+            );
         
         return validationErrors.Count > 0 
-            ? throw new Exceptions_ValidationException(validationErrors)
+            ? throw new LayerValidationException(validationErrors)
             : await next(message, cancellationToken);
     }
 }
diff --git a/src/Riber.Application/Common/Result.cs b/src/Riber.Application/Common/Result.cs
@@ -27,9 +27,17 @@ protected Result(bool isSuccess, Error error)
 
     #region Static Methods
 
-    public static Result<object> Success() => new(null, true, new Error());
-    public static Result<T> Success<T>(T value) => new(value, true, new Error());
-    public static Result<T> Failure<T>(Error error) => new(default, false, error);
+    public static Result<object> Success()
+        => new(null, true, new Error());
+
+    public static Result<T> Success<T>(T value)
+        => new(value, true, new Error());
+
+    public static Result<T> Failure<T>(Error error)
+        => new(default, false, error);
+
+    public static Result<T> Failure<T>(string type, Dictionary<string, string[]> details)
+        => new(default, false, new Error(type, details));
 
     protected static Result<T> Create<T>(T? value) =>
         value is not null ? Success(value) : Failure<T>(new Error());
diff --git a/src/Riber.Application/Common/ValidationError.cs b/src/Riber.Application/Common/ValidationError.cs
diff --git a/src/Riber.Application/Exceptions/ValidationException.cs b/src/Riber.Application/Exceptions/ValidationException.cs
@@ -3,8 +3,7 @@
 
 namespace Riber.Application.Exceptions;
 
-public sealed class ValidationException(IEnumerable<ValidationError> messages) : Exception
+public sealed class ValidationException(Dictionary<string, string[]> details) : Exception
 {
-    public IEnumerable<ValidationError> Messages => messages;
-    public static int Code => (int)HttpStatusCode.BadRequest;
+    public Dictionary<string, string[]> Details => details;
 }
diff --git a/src/Riber.Domain/Abstractions/Error.cs b/src/Riber.Domain/Abstractions/Error.cs
@@ -9,21 +9,29 @@ public sealed class Error
 {
     #region Properties
 
-    public string Code { get; init; } = string.Empty;
-    public string[] Messages { get; init; } = [];
+    public string Type { get; init; } = string.Empty;
+    public string Message { get; init; } = string.Empty;
+    public Dictionary<string, string[]> Details { get; set; } = [];
 
     #endregion
 
     #region Constructors
 
     [JsonConstructor]
-    public Error() {}
-    
-    public Error(string code, params string[] messages)
+    public Error() { }
+
+    public Error(string type, string message)
     {
-        Code = code;
-        Messages = messages;
+        Type = type;
+        Message = message;
     }
-    
+
+    public Error(string type, Dictionary<string, string[]> details)
+    {
+        Type = type;
+        Message = "Dados Inválidos.";
+        Details = details;
+    }
+
     #endregion
 }
diff --git a/tests/Riber.Api.Tests/Controllers/AuthControllerTests.cs b/tests/Riber.Api.Tests/Controllers/AuthControllerTests.cs
@@ -48,8 +48,9 @@ public async Task Should_NotLoginSuccessfully_WithInvalidCredentials()
         loginResponse.Should().NotBeNull();
         loginResponse.IsSuccess.Should().BeFalse();
         loginResponse.Value.Should().BeNull();
-        loginResponse.Error.Code.Should().Be("NOT_FOUND");
-        loginResponse.Error.Messages.Should().HaveCountGreaterThan(0);
+        loginResponse.Error.Type.Should().Be("NOT_FOUND");
+        loginResponse.Error.Message.Should().NotBeNullOrEmpty();
+        loginResponse.Error.Details.Should().BeNullOrEmpty();
     }
     
     #endregion
diff --git a/tests/Riber.Application.Tests/Behaviors/ValidationBehaviorTests.cs b/tests/Riber.Application.Tests/Behaviors/ValidationBehaviorTests.cs
@@ -42,7 +42,7 @@ public async Task Handle_WhenNoValidatorsProvided_ShouldProceedToNextHandler()
         );
 
         // Assert
-        result.Should().Be(result);
+        result.Should().Be(_response);
     }
 
     [Trait("Category", "Unit")]
@@ -65,7 +65,7 @@ public async Task Handle_WhenValidationPasses_ShouldProceedToNextHandler()
         );
 
         // Assert
-        result.Should().Be(result);
+        result.Should().Be(_response);
         _mockValidator.Verify(x => x.Validate(
             It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
     }
@@ -96,16 +96,16 @@ public async Task Handle_WhenSingleValidatorFails_ShouldThrowValidationException
         );
 
         // Assert
-        await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-
         var thrownException = await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-        thrownException.Which.Messages.Should().HaveCount(2);
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Name" && e.ErrorMessage == "Name is required");
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Age" && e.ErrorMessage == "Age must be between 20 and 50");
-
-        _mockValidator.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
+        
+        thrownException.Which.Details.Should().NotBeNull();
+        thrownException.Which.Details.Should().HaveCount(2);
+        thrownException.Which.Details.Should().ContainKey("Name");
+        thrownException.Which.Details.Should().ContainKey("Age");
+        thrownException.Which.Details["Name"].Should().Equal("Name is required");
+        thrownException.Which.Details["Age"].Should().Equal("Age must be between 20 and 50");
+
+        _mockValidator.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
     }
 
     [Trait("Category", "Unit")]
@@ -138,19 +138,23 @@ public async Task Handle_WhenMultipleValidatorsFail_ShouldThrowValidationExcepti
         );
 
         // Assert
-        await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-
         var thrownException = await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-        thrownException.Which.Messages.Should().HaveCount(3);
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Name" && e.ErrorMessage == "Name is required");
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Age" && e.ErrorMessage == "Age must be positive");
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Name" && e.ErrorMessage == "Name must be unique");
-
-        mockValidator1.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
-        mockValidator2.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
+        
+        thrownException.Which.Details.Should().NotBeNull();
+        thrownException.Which.Details.Should().HaveCount(2);
+        thrownException.Which.Details.Should().ContainKey("Name");
+        thrownException.Which.Details.Should().ContainKey("Age");
+        
+        // Name tem 2 erros agrupados
+        thrownException.Which.Details["Name"].Should().HaveCount(2);
+        thrownException.Which.Details["Name"].Should().Contain("Name is required");
+        thrownException.Which.Details["Name"].Should().Contain("Name must be unique");
+        
+        // Age tem 1 erro
+        thrownException.Which.Details["Age"].Should().Equal("Age must be positive");
+
+        mockValidator1.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
+        mockValidator2.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
     }
 
     [Trait("Category", "Unit")]
@@ -162,7 +166,6 @@ public async Task Handle_WhenCollectingErrorsFromAllValidators_ShouldThrowSingle
         var mockValidator2 = new Mock<IValidator<RequestTest>>();
         var mockValidator3 = new Mock<IValidator<RequestTest>>();
 
-        // First validator fails
         mockValidator1.Setup(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()))
             .Returns(new ValidationResult([
                 new ValidationFailure("Name", "Name is required")
@@ -187,18 +190,18 @@ public async Task Handle_WhenCollectingErrorsFromAllValidators_ShouldThrowSingle
         );
 
         // Assert
-        await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-
         var thrownException = await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-        thrownException.Which.Messages.Should().HaveCount(2);
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Name" && e.ErrorMessage == "Name is required");
-        thrownException.Which.Messages.Should()
-            .Contain(e => e.PropertyName == "Age" && e.ErrorMessage == "Age must be positive");
-
-        mockValidator1.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
-        mockValidator2.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
-        mockValidator3.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Exactly(2));
+        
+        thrownException.Which.Details.Should().NotBeNull();
+        thrownException.Which.Details.Should().HaveCount(2);
+        thrownException.Which.Details.Should().ContainKey("Name");
+        thrownException.Which.Details.Should().ContainKey("Age");
+        thrownException.Which.Details["Name"].Should().Equal("Name is required");
+        thrownException.Which.Details["Age"].Should().Equal("Age must be positive");
+
+        mockValidator1.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
+        mockValidator2.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
+        mockValidator3.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
     }
 
     [Trait("Category", "Unit")]
@@ -230,10 +233,15 @@ public async Task Handle_WhenSomeValidatorsFail_ShouldValidateAllValidators()
         );
 
         // Assert
-        await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
-
+        var thrownException = await exception.Should().ThrowExactlyAsync<ApplicationLayer.ValidationException>();
+        
         // Verifica que TODOS os validators foram chamados
         mockValidator1.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
         mockValidator2.Verify(x => x.Validate(It.IsAny<ValidationContext<RequestTest>>()), Times.Once);
+        
+        // Verifica que os erros foram agrupados corretamente
+        thrownException.Which.Details.Should().HaveCount(2);
+        thrownException.Which.Details.Should().ContainKey("Name");
+        thrownException.Which.Details.Should().ContainKey("Age");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace Riber.Application.Exceptions;`
`5`	`5`
`6`		`-public sealed class ValidationException(IEnumerable<ValidationError> messages) : Exception`
	`6`	`+public sealed class ValidationException(Dictionary<string, string[]> details) : Exception`
`7`	`7`	`{`
`8`		`- public IEnumerable<ValidationError> Messages => messages;`
`9`		`- public static int Code => (int)HttpStatusCode.BadRequest;`
	`8`	`+ public Dictionary<string, string[]> Details => details;`
`10`	`9`	`}`