Improve filters by uniformizing results

Author: imclint21

src/Initium/Filters/ApiExceptionFilter.cs

@@ -1,6 +1,7 @@
 using System.Net;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Initium.Exceptions;
+using Initium.Helpers;
 using Initium.Response;
 
 namespace Initium.Filters;
@@ -20,39 +21,29 @@ public void OnException(ExceptionContext context)
 	{
 		// Start building the ApiResponse using the Fluent Builder
 		var apiResponseBuilder = ApiResponseBuilder.CreateFromContext(context.HttpContext);
-
-		// Use pattern switch to handle exceptions
-		context.Result = context.Exception switch
+		
+		// Determine the HTTP status code:
+		var statusCode = context.Exception switch
 		{
-			ApiException ex => apiResponseBuilder
-				.WithMessage(ex.Message)
-				.WithStatusCode(ex.StatusCode)
-				.BuildAsJsonResult(),
-
-			NotImplementedException ex => apiResponseBuilder
-				.WithMessage(ex.Message)
-				.WithStatusCode(HttpStatusCode.NotImplemented)
-				.BuildAsJsonResult(),
-
-			_ => apiResponseBuilder
-				.WithMessage("An unexpected error occurred.")
-				.WithStatusCode(HttpStatusCode.InternalServerError)
-				.BuildAsJsonResult()
+			ApiException exception => exception.StatusCode,
+			NotImplementedException => HttpStatusCode.NotImplemented,
+			_ => HttpStatusCode.InternalServerError 
 		};
 
+		// Determine the response message:
+		// 1. Use the exception's message if it's not null or whitespace.
+		// 2. Otherwise, get the message from [ApiResponse] attributes.
+		// 3. If none is found, use the default message for the StatusCode.
+		var message = 
+			(string.IsNullOrWhiteSpace(context.Exception.Message) ? null : context.Exception.Message)
+			?? ApiResponseHelper.GetApiResponseMessage(context.ActionDescriptor, statusCode) 
+			?? ApiResponseHelper.GetDefaultMessageForStatusCode(statusCode);
+
+		// Construct a standardized ApiResponse object including HTTP context details.
 		context.ExceptionHandled = true;
+		context.Result = apiResponseBuilder
+			.WithStatusCode(statusCode)
+			.WithMessage(message)
+			.BuildAsJsonResult();
 	}
-}
-//
-// public static implicit operator ActionResult(ServiceResult result)
-// {
-// 	if (result.Success && result.StatusCode == HttpStatusCode.NoContent)
-// 	{
-// 		return new NoContentResult();
-// 	}
-//
-// 	return new ObjectResult(result)
-// 	{
-// 		StatusCode = (int)result.StatusCode
-// 	};
-// }
+}

src/Initium/Filters/ApiResponseFilter.cs

@@ -22,6 +22,9 @@ public override void OnActionExecuted(ActionExecutedContext context)
         // Check if the result of the action is an ObjectResult containing a ServiceResult.
         if (context.Result is not ObjectResult { Value: ServiceResult serviceResult }) return;
 
+        // Start building the ApiResponse using the Fluent Builder
+        var apiResponseBuilder = ApiResponseBuilder.CreateFromContext(context.HttpContext);
+        
         // Determine the HTTP status code:
 		// 1. Use ServiceResult status code if set.
 		// 2. Otherwise, use the default based on the HTTP method.
@@ -32,26 +35,22 @@ public override void OnActionExecuted(ActionExecutedContext context)
 		// Determine the response message:
 		// 1. Use ServiceResult message if set.
 		// 2. Otherwise, get the message from [ApiResponse] attributes.
-		// 3. If none found, use the default message for the StatusCode.
+		// 3. If none is found, use the default message for the StatusCode.
         var message = 
-	        serviceResult.Message 
-	        ?? GetApiResponseMessage(context, statusCode)
+	        serviceResult.Message
+	        ?? ApiResponseHelper.GetApiResponseMessage(context.ActionDescriptor, statusCode)
 	        ?? ApiResponseHelper.GetDefaultMessageForStatusCode(statusCode);
 
         // Determine the appropriate response based on the status code:
 		// - For 204 (No Content) and 304 (Not Modified), set a StatusCodeResult without a response body.
-		// - For other status codes, create a standardized ApiResponse object including HTTP context details.
+		// - For other status codes, construct a standardized ApiResponse object including HTTP context details.
         context.Result = statusCode switch
         {
 	        HttpStatusCode.NoContent or HttpStatusCode.NotModified => new StatusCodeResult((int)statusCode),
-	        _ => ApiResponseBuilder
-		        .CreateFromContext(context.HttpContext)
+	        _ => apiResponseBuilder
 		        .WithStatusCode(statusCode)
 		        .WithMessage(message)
 		        .BuildAsJsonResult()
         };
     }
-
-    private static string? GetApiResponseMessage(ActionExecutedContext context, HttpStatusCode statusCode) => 
-        ApiResponseHelper.GetApiResponseAttributes(context.ActionDescriptor).FirstOrDefault(attribute => attribute.StatusCode == statusCode)?.Message;
 }

src/Initium/Helpers/ApiResponseHelper.cs

@@ -60,7 +60,11 @@ public static IEnumerable<ApiResponseAttribute> GetApiResponseAttributes(ActionD
     public static HttpStatusCode GetDefaultStatusCode(HttpContext context) => context.Request.Method.ToUpper() switch
     {
         "POST" => HttpStatusCode.Created,
-        "DELETE" => HttpStatusCode.NoContent,
-        _ => (HttpStatusCode)context.Response.StatusCode
+        "DELETE" or "PATCH" or "PUT" => HttpStatusCode.NoContent, 
+        "GET" or "HEAD" => HttpStatusCode.OK,
+        _ => context.Response.StatusCode > 0 ? (HttpStatusCode)context.Response.StatusCode : HttpStatusCode.InternalServerError
     };
+
+    public static string? GetApiResponseMessage(ActionDescriptor actionDescriptor, HttpStatusCode statusCode) =>
+        GetApiResponseAttributes(actionDescriptor).FirstOrDefault(attribute => attribute.StatusCode == statusCode)?.Message;
 }