| | | 1 | | using System.Diagnostics; |
| | | 2 | | using Microsoft.AspNetCore.Diagnostics; |
| | | 3 | | using Microsoft.Extensions.Options; |
| | | 4 | | using Microsoft.Extensions.Primitives; |
| | | 5 | | using ProjectTemplate.Web.Extensions; |
| | | 6 | | using ProjectTemplate.Web.Options; |
| | | 7 | | |
| | | 8 | | namespace ProjectTemplate.Web.ErrorHandling; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Provides extension methods for configuring standardized problem details and exception handling in ASP.NET Core |
| | | 12 | | /// applications. |
| | | 13 | | /// </summary> |
| | | 14 | | /// <remarks>These extensions integrate custom problem details formatting and exception handling into the |
| | | 15 | | /// application's dependency injection and middleware pipelines. They help ensure consistent error responses and |
| | | 16 | | /// traceability across environments.</remarks> |
| | | 17 | | internal static class ProblemDetailsExtensions |
| | | 18 | | { |
| | | 19 | | /// <summary> |
| | | 20 | | /// Adds standardized Problem Details error responses and a custom exception handler to the application's service |
| | | 21 | | /// collection. |
| | | 22 | | /// </summary> |
| | | 23 | | /// <remarks>This method configures Problem Details middleware to include trace and request identifiers in |
| | | 24 | | /// error responses and customizes error details for non-development environments. It also registers a custom |
| | | 25 | | /// exception handler for consistent error formatting.</remarks> |
| | | 26 | | /// <param name="services">The service collection to which Problem Details and the exception handler are added. Cann |
| | | 27 | | /// <param name="webHostEnvironment">The current web hosting environment. Used to determine error detail behavior ba |
| | | 28 | | /// null.</param> |
| | | 29 | | /// <returns>The same service collection instance, enabling method chaining.</returns> |
| | | 30 | | public static IServiceCollection AddApplicationProblemDetails( |
| | | 31 | | this IServiceCollection services, |
| | | 32 | | IWebHostEnvironment webHostEnvironment) |
| | | 33 | | { |
| | 114 | 34 | | ArgumentNullException.ThrowIfNull(services); |
| | 114 | 35 | | ArgumentNullException.ThrowIfNull(webHostEnvironment); |
| | | 36 | | |
| | 114 | 37 | | services.AddExceptionHandler<ProblemDetailsExceptionHandler>(); |
| | | 38 | | |
| | 114 | 39 | | services.AddProblemDetails(options => options.CustomizeProblemDetails = context => |
| | 114 | 40 | | { |
| | 114 | 41 | | string? originalExceptionPath = context.HttpContext.Features |
| | 114 | 42 | | .Get<IExceptionHandlerPathFeature>()? |
| | 114 | 43 | | .Path; |
| | 114 | 44 | | |
| | 114 | 45 | | string? originalStatusCodePath = context.HttpContext.Features |
| | 114 | 46 | | .Get<IStatusCodeReExecuteFeature>()? |
| | 114 | 47 | | .OriginalPath; |
| | 114 | 48 | | |
| | 114 | 49 | | context.ProblemDetails.Instance ??= !string.IsNullOrWhiteSpace(originalExceptionPath) |
| | 114 | 50 | | ? originalExceptionPath |
| | 114 | 51 | | : !string.IsNullOrWhiteSpace(originalStatusCodePath) |
| | 114 | 52 | | ? originalStatusCodePath |
| | 114 | 53 | | : context.HttpContext.Request.Path; |
| | 114 | 54 | | |
| | 114 | 55 | | string correlationId = GetCorrelationId(context.HttpContext); |
| | 114 | 56 | | |
| | 114 | 57 | | Activity? activity = Activity.Current; |
| | 114 | 58 | | |
| | 114 | 59 | | context.ProblemDetails.Extensions["traceId"] = |
| | 114 | 60 | | activity?.TraceId.ToString() ?? context.HttpContext.TraceIdentifier; |
| | 114 | 61 | | |
| | 114 | 62 | | if (activity is not null) |
| | 114 | 63 | | { |
| | 114 | 64 | | context.ProblemDetails.Extensions["spanId"] = activity.SpanId.ToString(); |
| | 114 | 65 | | } |
| | 114 | 66 | | |
| | 114 | 67 | | context.ProblemDetails.Extensions["requestId"] = |
| | 114 | 68 | | context.HttpContext.TraceIdentifier; |
| | 114 | 69 | | |
| | 114 | 70 | | context.ProblemDetails.Extensions["correlationId"] = |
| | 114 | 71 | | correlationId; |
| | 114 | 72 | | |
| | 114 | 73 | | if (!webHostEnvironment.IsDevelopment() && |
| | 114 | 74 | | context.ProblemDetails.Status >= StatusCodes.Status500InternalServerError) |
| | 114 | 75 | | { |
| | 114 | 76 | | context.ProblemDetails.Detail ??= |
| | 114 | 77 | | "An unexpected error occurred. Contact support with the request ID."; |
| | 114 | 78 | | } |
| | 114 | 79 | | }); |
| | | 80 | | |
| | 114 | 81 | | return services; |
| | | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// Configures standardized error handling and problem details middleware for the application based on the current |
| | | 86 | | /// environment. |
| | | 87 | | /// </summary> |
| | | 88 | | /// <remarks>In the development environment, this method enables the developer exception page. In other |
| | | 89 | | /// environments, it configures a generic exception handler, followed by HSTS through |
| | | 90 | | /// <c>SecurityHeadersExtensions.UseApplicationHsts</c> (defined with the security headers, registered here to keep |
| | | 91 | | /// it ahead of the status-code branches). It also sets up status code pages to return problem details responses whe |
| | | 92 | | /// error page otherwise.</remarks> |
| | | 93 | | /// <param name="app">The <see cref="WebApplication"/> instance to configure. Cannot be null.</param> |
| | | 94 | | /// <returns>The configured <see cref="WebApplication"/> instance.</returns> |
| | | 95 | | public static WebApplication UseProblemDetails(this WebApplication app) |
| | | 96 | | { |
| | 107 | 97 | | ArgumentNullException.ThrowIfNull(app); |
| | | 98 | | |
| | 107 | 99 | | if (app.Environment.IsDevelopment()) |
| | | 100 | | { |
| | 0 | 101 | | app.UseDeveloperExceptionPage(); |
| | | 102 | | } |
| | | 103 | | else |
| | | 104 | | { |
| | 107 | 105 | | app.UseExceptionHandler("/Home/Error/500"); |
| | | 106 | | } |
| | | 107 | | |
| | | 108 | | // HSTS belongs between the exception handler and the status-code branches below, so it runs once per |
| | | 109 | | // request and is not re-invoked by status-code re-execution. The implementation lives with the other |
| | | 110 | | // security headers; only the registration point is here. It is a no-op in development. |
| | 107 | 111 | | app.UseApplicationHsts(); |
| | | 112 | | |
| | 107 | 113 | | app.UseWhen( |
| | 107 | 114 | | ProblemDetailsRequestClassifier.ShouldWriteProblemDetails, |
| | 107 | 115 | | branch => branch.UseStatusCodePages()); |
| | | 116 | | |
| | 107 | 117 | | app.UseWhen( |
| | 107 | 118 | | context => !ProblemDetailsRequestClassifier.ShouldWriteProblemDetails(context), |
| | 107 | 119 | | branch => branch.UseStatusCodePagesWithReExecute("/Home/Error/{0}")); |
| | | 120 | | |
| | 107 | 121 | | return app; |
| | | 122 | | } |
| | | 123 | | |
| | | 124 | | private static string GetCorrelationId(HttpContext httpContext) |
| | | 125 | | { |
| | 10 | 126 | | ApplicationRequestLoggingOptions requestLoggingOptions = httpContext.RequestServices |
| | 10 | 127 | | .GetService<IOptions<ApplicationRequestLoggingOptions>>()?.Value |
| | 10 | 128 | | ?? new ApplicationRequestLoggingOptions(); |
| | | 129 | | |
| | 10 | 130 | | if (httpContext.Request.Headers.TryGetValue( |
| | 10 | 131 | | requestLoggingOptions.CorrelationHeaderName, |
| | 10 | 132 | | out StringValues correlationHeaderValues)) |
| | | 133 | | { |
| | 2 | 134 | | string? headerValue = correlationHeaderValues.FirstOrDefault(); |
| | | 135 | | |
| | 2 | 136 | | if (!string.IsNullOrWhiteSpace(headerValue)) |
| | | 137 | | { |
| | 2 | 138 | | string cleanValue = headerValue.Trim(); |
| | | 139 | | |
| | 2 | 140 | | return cleanValue.Length <= 128 |
| | 2 | 141 | | ? cleanValue |
| | 2 | 142 | | : cleanValue[..128]; |
| | | 143 | | } |
| | | 144 | | } |
| | | 145 | | |
| | 8 | 146 | | return httpContext.TraceIdentifier; |
| | | 147 | | } |
| | | 148 | | } |