Merge pull request #65 from PandaTechAM/development

Fix internal server error handling and update package references

Author: HaikAsatryan

src/ResponseCrafter/ExceptionHandlers/Http/ApiExceptionHandler.cs

@@ -156,6 +156,15 @@ private async Task HandleApiExceptionAsync(HttpContext httpContext,
    {
       var traceId = Activity.Current?.TraceId.ToString() ?? string.Empty;
       var instance = CreateRequestPath(httpContext);
+      var isServerError = exception.StatusCode >= 500;
+
+      var clientMessage = isServerError && _visibility != "Private"
+         ? ExceptionMessages.DefaultMessage.ConvertCase(_convention)
+         : exception.Message.ConvertCase(_convention);
+
+      var clientErrors = isServerError && _visibility != "Private"
+         ? null
+         : exception.Errors.ConvertCase(_convention);
 
       using (_logger.BeginScope(new Dictionary<string, object>
              {
@@ -173,24 +182,23 @@ private async Task HandleApiExceptionAsync(HttpContext httpContext,
             TraceId = traceId,
             Instance = instance,
             StatusCode = exception.StatusCode,
-            Type = exception.GetType()
-                            .Name,
-            Errors = exception.Errors.ConvertCase(_convention),
-            Message = exception.Message.ConvertCase(_convention)
+            Type = isServerError ? "InternalServerError" : exception.GetType().Name,
+            Errors = clientErrors,
+            Message = clientMessage
          };
 
-         httpContext.Response.StatusCode = exception.StatusCode;
+         httpContext.Response.StatusCode = response.StatusCode;
          await httpContext.Response.WriteAsJsonAsync(response, ct);
 
-         if (response.Errors is null || response.Errors.Count == 0)
+         if (isServerError)
          {
-            _logger.LogWarning("ApiException encountered: {Message}", response.Message);
+            _logger.LogError(exception, "ApiException {StatusCode}: {Message} {@Errors}",
+               exception.StatusCode, exception.Message, exception.Errors);
          }
          else
          {
-            _logger.LogWarning("ApiException encountered: {Message} with errors: {@Errors}",
-               response.Message,
-               response.Errors);
+            _logger.LogWarning(exception, "ApiException {StatusCode}: {Message} {@Errors}",
+               exception.StatusCode, exception.Message, exception.Errors);
          }
       }
    }

src/ResponseCrafter/ExceptionHandlers/SignalR/SignalRExceptionFilter.cs

@@ -98,6 +98,15 @@ private async Task HandleApiExceptionAsync(HubInvocationContext ctx,
       string invocationId)
    {
       var traceId = Activity.Current?.TraceId.ToString() ?? string.Empty;
+      var isServerError = ex.StatusCode >= 500;
+
+      var clientMessage = isServerError && _visibility != "Private"
+         ? ExceptionMessages.DefaultMessage.ConvertCase(_convention)
+         : ex.Message.ConvertCase(_convention);
+
+      var clientErrors = isServerError && _visibility != "Private"
+         ? null
+         : ex.Errors.ConvertCase(_convention);
 
       using (_logger.BeginScope(new Dictionary<string, object>
              {
@@ -117,19 +126,25 @@ private async Task HandleApiExceptionAsync(HubInvocationContext ctx,
             InvocationId = invocationId,
             Instance = ctx.HubMethodName,
             StatusCode = ex.StatusCode,
-            Message = ex.Message.ConvertCase(_convention),
-            Errors = ex.Errors.ConvertCase(_convention)
+            Message = clientMessage,
+            Errors = clientErrors
          };
 
-         if (response.Errors is null || response.Errors.Count == 0)
+         if (isServerError)
          {
-            _logger.LogWarning("SignalR exception: {Message}", response.Message);
+            _logger.LogError(ex,
+               "SignalR ApiException {StatusCode}: {Message} {@Errors}",
+               ex.StatusCode,
+               ex.Message,
+               ex.Errors);
          }
          else
          {
-            _logger.LogWarning("SignalR exception: {Message} with errors: {@Errors}",
-               response.Message,
-               response.Errors);
+            _logger.LogWarning(ex,
+               "SignalR ApiException {StatusCode}: {Message} {@Errors}",
+               ex.StatusCode,
+               ex.Message,
+               ex.Errors);
          }
 
          await ctx.Hub.Clients.Caller.SendAsync("ReceiveError", response, ctx.Context.ConnectionAborted);

src/ResponseCrafter/Extensions/WebApplicationExtensions.cs

@@ -11,22 +11,21 @@ public static class WebApplicationExtensions
 {
    public static WebApplicationBuilder AddResponseCrafter(this WebApplicationBuilder builder,
       NamingConvention namingConvention = NamingConvention.Default,
-      bool suppressExceptionHandlerMiddlewareLog  = true)
+      bool suppressExceptionHandlerMiddlewareLog = true)
    {
       builder.Services.AddSingleton(new NamingConventionOptions
       {
          NamingConvention = namingConvention
       });
       builder.Services.AddExceptionHandler<ApiExceptionHandler>();
 
-      if (suppressExceptionHandlerMiddlewareLog )
+      if (!suppressExceptionHandlerMiddlewareLog)
       {
-         builder.Logging.AddFilter(
-            "Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware",
-            LogLevel.None);
+         return builder;
       }
 
-
+      builder.Logging.AddFilter("Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware", LogLevel.None);
+      
       return builder;
    }
 

src/ResponseCrafter/ResponseCrafter.csproj

@@ -8,13 +8,13 @@
         <Copyright>MIT</Copyright>
         <PackageIcon>pandatech.png</PackageIcon>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
-        <Version>5.2.2</Version>
+        <Version>5.3.0</Version>
         <PackageId>Pandatech.ResponseCrafter</PackageId>
         <PackageTags>Pandatech, library, exception handler, exception, middleware, Api response</PackageTags>
         <Title>ResponseCrafter</Title>
         <Description>Handling exceptions, custom Dtos.</Description>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-response-crafter</RepositoryUrl>
-        <PackageReleaseNotes>Nuget updates.</PackageReleaseNotes>
+        <PackageReleaseNotes>Fixed bug on internal server error exception.</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
@@ -27,7 +27,7 @@
         <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8"/>
         <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="9.0.8"/>
         <PackageReference Include="PandaTech.FluentImporter" Version="3.0.9" />
-        <PackageReference Include="Pandatech.GridifyExtensions" Version="2.0.14" />
+        <PackageReference Include="Pandatech.GridifyExtensions" Version="2.1.4" />
     </ItemGroup>
 
 </Project>

test/ResponseCrafter.Demo/Program.cs

@@ -1,14 +1,16 @@
-using Humanizer;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.SignalR;
 using ResponseCrafter.Demo.Hubs;
 using ResponseCrafter.Enums;
 using ResponseCrafter.ExceptionHandlers.SignalR;
 using ResponseCrafter.Extensions;
 using ResponseCrafter.HttpExceptions;
+using SharedKernel.Logging;
 
 var builder = WebApplication.CreateBuilder(args);
 
+builder.AddSerilog(LogBackend.ElasticSearch);
+
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen();
 builder.AddResponseCrafter(NamingConvention.ToSnakeCase);
@@ -47,10 +49,10 @@
          });
    });
 
-app.MapPost("/errors/dotnet",
+app.MapPost("/errors/internal-server-error",
    () =>
    {
-      throw new InvalidOperationException("simulated_invalid_operation");
+      throw new InternalServerErrorException("simulated_internal_server_error");
    });
 
 app.MapPost("/errors/500",

test/ResponseCrafter.Demo/ResponseCrafter.Demo.csproj

@@ -9,7 +9,8 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.4" />
+        <PackageReference Include="Pandatech.SharedKernel" Version="1.8.5" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>

test/ResponseCrafter.Demo/appsettings.json

@@ -1,12 +1,17 @@
 {
-  "Logging": {
-    "LogLevel": {
+  "Serilog": {
+    "MinimumLevel": {
       "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
+      "Override": {
+        "Microsoft": "Warning",
+        "System": "Warning"
+      }
     }
   },
-  "AllowedHosts": "*",
-  "ResponseCrafterVisibility" : "Public"
+  "ConnectionStrings": {
+    "PersistentStorage": "./persistence"
+  },
+  "RepositoryName": "ResponseCrafter.Demo"
 }