Capture Endpoint and RouteValues on ExceptionHandlerFeature (#34205)

Author: Kahbazi

src/Middleware/Diagnostics.Abstractions/src/IExceptionHandlerFeature.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
 
 namespace Microsoft.AspNetCore.Diagnostics
 {
@@ -14,5 +16,21 @@ public interface IExceptionHandlerFeature
         /// The error encountered during the original request
         /// </summary>
         Exception Error { get; }
+
+        /// <summary>
+        /// The portion of the request path that identifies the requested resource. The value
+        /// is un-escaped.
+        /// </summary>
+        string Path => throw new NotSupportedException();
+
+        /// <summary>
+        /// Gets the selected <see cref="Http.Endpoint"/> for the original request.
+        /// </summary>
+        Endpoint? Endpoint => null;
+
+        /// <summary>
+        /// Gets the <see cref="RouteValueDictionary"/> associated with the original request.
+        /// </summary>
+        RouteValueDictionary? RouteValues => null;
     }
 }

src/Middleware/Diagnostics.Abstractions/src/IExceptionHandlerPathFeature.cs

@@ -12,6 +12,6 @@ public interface IExceptionHandlerPathFeature : IExceptionHandlerFeature
         /// The portion of the request path that identifies the requested resource. The value
         /// is un-escaped.
         /// </summary>
-        string? Path { get; }
+        new string Path => ((IExceptionHandlerFeature)this).Path;
     }
 }

src/Middleware/Diagnostics.Abstractions/src/PublicAPI.Unshipped.txt

@@ -15,8 +15,11 @@ Microsoft.AspNetCore.Diagnostics.ErrorContext.Exception.get -> System.Exception!
 Microsoft.AspNetCore.Diagnostics.ErrorContext.HttpContext.get -> Microsoft.AspNetCore.Http.HttpContext!
 Microsoft.AspNetCore.Diagnostics.ICompilationException.CompilationFailures.get -> System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Diagnostics.CompilationFailure?>?
 Microsoft.AspNetCore.Diagnostics.IDeveloperPageExceptionFilter.HandleExceptionAsync(Microsoft.AspNetCore.Diagnostics.ErrorContext! errorContext, System.Func<Microsoft.AspNetCore.Diagnostics.ErrorContext!, System.Threading.Tasks.Task!>! next) -> System.Threading.Tasks.Task!
+Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature.Endpoint.get -> Microsoft.AspNetCore.Http.Endpoint?
 Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature.Error.get -> System.Exception!
-Microsoft.AspNetCore.Diagnostics.IExceptionHandlerPathFeature.Path.get -> string?
+Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature.Path.get -> string!
+Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature.RouteValues.get -> Microsoft.AspNetCore.Routing.RouteValueDictionary?
+Microsoft.AspNetCore.Diagnostics.IExceptionHandlerPathFeature.Path.get -> string!
 Microsoft.AspNetCore.Diagnostics.IStatusCodeReExecuteFeature.OriginalPath.get -> string!
 Microsoft.AspNetCore.Diagnostics.IStatusCodeReExecuteFeature.OriginalPath.set -> void
 Microsoft.AspNetCore.Diagnostics.IStatusCodeReExecuteFeature.OriginalPathBase.get -> string!

src/Middleware/Diagnostics/src/ExceptionHandler/ExceptionHandlerFeature.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
 
 namespace Microsoft.AspNetCore.Diagnostics
 {
@@ -15,5 +17,11 @@ public class ExceptionHandlerFeature : IExceptionHandlerPathFeature
 
         /// <inheritdoc/>
         public string Path { get; set; } = default!;
+
+        /// <inheritdoc/>
+        public Endpoint? Endpoint { get; set; }
+
+        /// <inheritdoc/>
+        public RouteValueDictionary? RouteValues { get; set; }
     }
 }

src/Middleware/Diagnostics/src/ExceptionHandler/ExceptionHandlerMiddleware.cs

@@ -118,13 +118,16 @@ private async Task HandleException(HttpContext context, ExceptionDispatchInfo ed
             }
             try
             {
-                ClearHttpContext(context);
-
                 var exceptionHandlerFeature = new ExceptionHandlerFeature()
                 {
                     Error = edi.SourceException,
                     Path = originalPath.Value!,
+                    Endpoint = context.GetEndpoint(),
+                    RouteValues = context.Features.Get<IRouteValuesFeature>()?.RouteValues
                 };
+
+                ClearHttpContext(context);
+                
                 context.Features.Set<IExceptionHandlerFeature>(exceptionHandlerFeature);
                 context.Features.Set<IExceptionHandlerPathFeature>(exceptionHandlerFeature);
                 context.Response.StatusCode = StatusCodes.Status500InternalServerError;
@@ -168,7 +171,10 @@ private static void ClearHttpContext(HttpContext context)
             // the endpoint and route values to ensure things are re-calculated.
             context.SetEndpoint(endpoint: null);
             var routeValuesFeature = context.Features.Get<IRouteValuesFeature>();
-            routeValuesFeature?.RouteValues?.Clear();
+            if (routeValuesFeature != null)
+            {
+                routeValuesFeature.RouteValues = null!;
+            }
         }
 
         private static Task ClearCacheHeaders(object state)

src/Middleware/Diagnostics/src/PublicAPI.Unshipped.txt

@@ -52,6 +52,10 @@ Microsoft.AspNetCore.Builder.ExceptionHandlerOptions.ExceptionHandler.get -> Mic
 Microsoft.AspNetCore.Builder.ExceptionHandlerOptions.ExceptionHandler.set -> void
 Microsoft.AspNetCore.Builder.StatusCodePagesOptions.HandleAsync.get -> System.Func<Microsoft.AspNetCore.Diagnostics.StatusCodeContext!, System.Threading.Tasks.Task!>!
 Microsoft.AspNetCore.Builder.StatusCodePagesOptions.HandleAsync.set -> void
+Microsoft.AspNetCore.Diagnostics.ExceptionHandlerFeature.Endpoint.get -> Microsoft.AspNetCore.Http.Endpoint?
+Microsoft.AspNetCore.Diagnostics.ExceptionHandlerFeature.Endpoint.set -> void
+Microsoft.AspNetCore.Diagnostics.ExceptionHandlerFeature.RouteValues.get -> Microsoft.AspNetCore.Routing.RouteValueDictionary?
+Microsoft.AspNetCore.Diagnostics.ExceptionHandlerFeature.RouteValues.set -> void
 ~Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.DeveloperExceptionPageMiddleware(Microsoft.AspNetCore.Http.RequestDelegate! next, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.DeveloperExceptionPageOptions!>! options, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory, Microsoft.AspNetCore.Hosting.IWebHostEnvironment! hostingEnvironment, System.Diagnostics.DiagnosticSource! diagnosticSource, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Diagnostics.IDeveloperPageExceptionFilter!>! filters) -> void
 Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext! context) -> System.Threading.Tasks.Task!
 Microsoft.AspNetCore.Diagnostics.ExceptionHandlerFeature.Error.get -> System.Exception!

src/Middleware/Diagnostics/test/UnitTests/ExceptionHandlerMiddlewareTest.cs

@@ -36,6 +36,30 @@ public async Task Invoke_ExceptionThrownResultsInClearedRouteValuesAndEndpoint()
             await middleware.Invoke(httpContext);
         }
 
+        [Fact]
+        public async Task Invoke_ExceptionHandlerCaptureRouteValuesAndEndpoint()
+        {
+            // Arrange
+            var httpContext = CreateHttpContext();
+            var endpoint = new Endpoint((_) => Task.CompletedTask, new EndpointMetadataCollection(), "Test");
+            httpContext.SetEndpoint(endpoint);
+            httpContext.Request.RouteValues["John"] = "Doe";
+
+            var optionsAccessor = CreateOptionsAccessor(
+                exceptionHandler: context =>
+                {
+                    var feature = context.Features.Get<IExceptionHandlerPathFeature>();
+                    Assert.Equal(endpoint, feature.Endpoint);
+                    Assert.Equal("Doe", feature.RouteValues["John"]);
+
+                    return Task.CompletedTask;
+                });
+            var middleware = CreateMiddleware(_ => throw new InvalidOperationException(), optionsAccessor);
+
+            // Act & Assert
+            await middleware.Invoke(httpContext);
+        }
+
         private HttpContext CreateHttpContext()
         {
             var httpContext = new DefaultHttpContext