Advise on handling Exceptions
gang89 opened this issue · comments
Hi guys,
Thanks for sharing this project with the community. Have benefited a lot from here just by studying and trying out the project structure.
Would like to clarify regarding the handling of exceptions for this project. It seems like any exceptions that are found in the domain layer is not able to be captured by a global exception.
Example:
In one of my domain model constructor - I were to deliberate throw an exception
I would expect it to be caught by a global exception handler such as below and returns an error
However, the API constantly returns a 200 OK success with no error message (probably because I didnt use the domainNotification Bus).
I also tried implementing along with GlobalExceptionFilter / Exception Middleware but to no avail.
It seems like the system exceptions are not surfaced to the API project Exception Handlers.
Have been looking for solutions for a few days now. Hence any advise would be greatly appreciated.
Regards,
Hello Eduardo,
I've implemented a middleware exceptions for .net core, maybe it sees great for the equinox project.
Follow attached the file. I hope it help you to improve your project.
#region Imports
using System;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
using System.IO;
using System.Text;
using System.Net;
using Infrastructure.Logger.Model;
using System.Diagnostics;
using Microsoft.AspNetCore.Http.Internal;
using Microsoft.Extensions.Options;
using Infrastructure.Infrastructure.CrossCutting.Util.ApplicationSettings;
#endregion
namespace Infrastructure.Logger.Middleware
{
public class RequestResponseLoggingMiddleware
{
private readonly RequestDelegate _next;
private readonly ILoggerManager _logger;
private readonly Stopwatch _watch;
private string _log;
private Guid _guidLog;
private readonly IOptions<AppSettingsModel> _AppSett;
public RequestResponseLoggingMiddleware(RequestDelegate next, ILoggerManager logger, IOptions<AppSettingsModel> App)
{
_logger = logger;
_next = next;
_watch = new Stopwatch();
_AppSett = App;
}
public async Task Invoke(HttpContext httpContext)
{
try
{
var request = httpContext.Request;
_watch.Restart();
_log = string.Empty;
var requestBodyContent = await ReadRequestBody(request);
_log += !string.IsNullOrEmpty(requestBodyContent) ? requestBodyContent : string.Empty;
_guidLog = Guid.NewGuid();
if (_AppSett.Value.appSettings.UseTracer)
{
_logger.LogInfo("Iniciando transação: " + _guidLog);
_logger.LogInfo("Mieddleware");
_logger.LogInfo($"Request: {requestBodyContent} ");
}
var originalBodyStream = httpContext.Response.Body;
using (var responseBody = new MemoryStream())
{
var response = httpContext.Response;
response.Body = responseBody;
await _next(httpContext);
_watch.Stop();
var responseBodyContent = await ReadResponseBody(response);
if (_AppSett.Value.appSettings.UseTracer)
{
_log += !string.IsNullOrEmpty(responseBodyContent) ? $"{ Environment.NewLine } {responseBodyContent}" : string.Empty;
_logger.LogInfo($"Response: {responseBodyContent} executed in: {_watch.ElapsedMilliseconds} ms");
_logger.LogInfo("Finalizando transação: " + _guidLog + "\n\n");
}
await responseBody.CopyToAsync(originalBodyStream);
}
}
catch (Exception ex)
{
// Não realizar o tratamento do Exception
_logger.LogError($"{_log} - Exception: {ex}");
_logger.LogInfo("Finalizando transação - Erro: " + _guidLog + "\n\n");
await HandleExceptionAsync(httpContext, ex);
}
}
private async Task<string> ReadRequestBody(HttpRequest request)
{
request.EnableRewind();
var buffer = new byte[Convert.ToInt32(request.ContentLength)];
await request.Body.ReadAsync(buffer, 0, buffer.Length);
var bodyAsText = Encoding.UTF8.GetString(buffer);
request.Body.Seek(0, SeekOrigin.Begin);
return $"{request.Scheme} {request.Host}{request.Path} {request.QueryString} {request.Method} {bodyAsText}";
}
private async Task<string> ReadResponseBody(HttpResponse response)
{
response.Body.Seek(0, SeekOrigin.Begin);
var bodyAsText = await new StreamReader(response.Body).ReadToEndAsync();
response.Body.Seek(0, SeekOrigin.Begin);
return $"Code: {response.StatusCode} - Response: {bodyAsText}";
}
private Task HandleExceptionAsync(HttpContext context, Exception ex)
{
context.Response.ContentType = "application/json";
context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
return context.Response.WriteAsync(new ErrorDetails()
{
StatusCode = context.Response.StatusCode,
Message = ex.Message
}.ToString());
}
}
}
At.,
Agnei Silva
…________________________________
From: gang89 <notifications@github.com>
Sent: Sunday, October 20, 2019 8:45 AM
To: EduardoPires/EquinoxProject <EquinoxProject@noreply.github.com>
Cc: Subscribed <subscribed@noreply.github.com>
Subject: [EduardoPires/EquinoxProject] Advise on handling Exceptions (#147)
Hi guys,
Thanks for sharing this project with the community. Have benefited a lot from here just by studying and trying out the project structure.
Would like to clarify regarding the handling of exceptions for this project. It seems like any exceptions that are found in the domain layer is not able to be captured by a global exception.
Example:
In one of my domain model constructor - I were to deliberate throw an exception
[Screenshot 2019-10-20 at 6 36 28 PM]<https://user-images.githubusercontent.com/32039249/67158269-97c61400-f368-11e9-9ba8-80e5604710fd.png>
I would expect it to be caught by a global exception handler such as below and returns an error
[Screenshot 2019-10-20 at 6 37 40 PM]<https://user-images.githubusercontent.com/32039249/67158283-c348fe80-f368-11e9-8f08-0f083b3c5c97.png>
However, the API constantly returns a 200 OK success with no error message (probably because I didnt use the domainNotification Bus).
I also tried implementing along with GlobalExceptionFilter / Exception Middleware but to no avail.
It seems like the system exceptions are not surfaced to the API project Exception Handlers.
Have been looking for solutions for a few days now. Hence any advise would be greatly appreciated.
Regards,
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub<#147?email_source=notifications&email_token=ADBJEIGKMXA4L7KCFKFQPFDQPQZDRA5CNFSM4JCTXQQ2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HS7Q44Q>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADBJEIBRRDVLT2N3WSE4QGLQPQZDRANCNFSM4JCTXQQQ>.
#region Imports
using System;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
using System.IO;
using System.Text;
using System.Net;
using Infrastructure.Logger.Model;
using System.Diagnostics;
using Microsoft.AspNetCore.Http.Internal;
using Microsoft.Extensions.Options;
using Infrastructure.Infrastructure.CrossCutting.Util.ApplicationSettings;
#endregion
namespace Infrastructure.Logger.Middleware
{
public class RequestResponseLoggingMiddleware
{
private readonly RequestDelegate _next;
private readonly ILoggerManager _logger;
private readonly Stopwatch _watch;
private string _log;
private Guid _guidLog;
private readonly IOptions<AppSettingsModel> _AppSett;
public RequestResponseLoggingMiddleware(RequestDelegate next, ILoggerManager logger, IOptions<AppSettingsModel> App)
{
_logger = logger;
_next = next;
_watch = new Stopwatch();
_AppSett = App;
}
public async Task Invoke(HttpContext httpContext)
{
try
{
var request = httpContext.Request;
_watch.Restart();
_log = string.Empty;
var requestBodyContent = await ReadRequestBody(request);
_log += !string.IsNullOrEmpty(requestBodyContent) ? requestBodyContent : string.Empty;
_guidLog = Guid.NewGuid();
if (_AppSett.Value.appSettings.UseTracer)
{
_logger.LogInfo("Iniciando transação: " + _guidLog);
_logger.LogInfo("Mieddleware");
_logger.LogInfo($"Request: {requestBodyContent} ");
}
var originalBodyStream = httpContext.Response.Body;
using (var responseBody = new MemoryStream())
{
var response = httpContext.Response;
response.Body = responseBody;
await _next(httpContext);
_watch.Stop();
var responseBodyContent = await ReadResponseBody(response);
if (_AppSett.Value.appSettings.UseTracer)
{
_log += !string.IsNullOrEmpty(responseBodyContent) ? $"{ Environment.NewLine } {responseBodyContent}" : string.Empty;
_logger.LogInfo($"Response: {responseBodyContent} executed in: {_watch.ElapsedMilliseconds} ms");
_logger.LogInfo("Finalizando transação: " + _guidLog + "\n\n");
}
await responseBody.CopyToAsync(originalBodyStream);
}
}
catch (Exception ex)
{
// Não realizar o tratamento do Exception
_logger.LogError($"{_log} - Exception: {ex}");
_logger.LogInfo("Finalizando transação - Erro: " + _guidLog + "\n\n");
await HandleExceptionAsync(httpContext, ex);
}
}
private async Task<string> ReadRequestBody(HttpRequest request)
{
request.EnableRewind();
var buffer = new byte[Convert.ToInt32(request.ContentLength)];
await request.Body.ReadAsync(buffer, 0, buffer.Length);
var bodyAsText = Encoding.UTF8.GetString(buffer);
request.Body.Seek(0, SeekOrigin.Begin);
return $"{request.Scheme} {request.Host}{request.Path} {request.QueryString} {request.Method} {bodyAsText}";
}
private async Task<string> ReadResponseBody(HttpResponse response)
{
response.Body.Seek(0, SeekOrigin.Begin);
var bodyAsText = await new StreamReader(response.Body).ReadToEndAsync();
response.Body.Seek(0, SeekOrigin.Begin);
return $"Code: {response.StatusCode} - Response: {bodyAsText}";
}
private Task HandleExceptionAsync(HttpContext context, Exception ex)
{
context.Response.ContentType = "application/json";
context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
return context.Response.WriteAsync(new ErrorDetails()
{
StatusCode = context.Response.StatusCode,
Message = ex.Message
}.ToString());
}
}
}
@gang89 We try to avoid exceptions for known reasons. You can let validations do all the work and they will publish error notifications