Support SkipStatusCodePages on endpoints and authorized routes

Author: captainsafia

src/Http/Http.Abstractions/src/Metadata/IStatusCodePagesMetadata.cs

@@ -0,0 +1,16 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Http.Metadata;
+
+/// <summary>
+/// Defines a contract used to specify metadata for skipping the StatusCodePage
+/// middleware in <see cref="Endpoint.Metadata"/>.
+/// </summary>
+public interface ISkipStatusCodePagesMetadata
+{
+    /// <summary>
+    /// Gets whether or not status code pages are enabled for an endpoint.
+    /// </summary>
+    bool Enabled { get; }
+}

src/Http/Http.Abstractions/src/PublicAPI.Unshipped.txt

@@ -1,3 +1,5 @@
 #nullable enable
 *REMOVED*abstract Microsoft.AspNetCore.Http.HttpResponse.ContentType.get -> string!
 abstract Microsoft.AspNetCore.Http.HttpResponse.ContentType.get -> string?
+Microsoft.AspNetCore.Http.Metadata.ISkipStatusCodePagesMetadata
+Microsoft.AspNetCore.Http.Metadata.ISkipStatusCodePagesMetadata.Enabled.get -> bool

src/Middleware/Diagnostics/src/StatusCodePage/StatusCodePagesMiddleware.cs

@@ -5,6 +5,7 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Diagnostics;
@@ -41,10 +42,12 @@ public async Task Invoke(HttpContext context)
     {
         var statusCodeFeature = new StatusCodePagesFeature();
         context.Features.Set<IStatusCodePagesFeature>(statusCodeFeature);
+        var endpoint = context.GetEndpoint();
+        var statusCodeMetadata = endpoint?.Metadata.GetMetadata<ISkipStatusCodePagesMetadata>();
 
         await _next(context);
 
-        if (!statusCodeFeature.Enabled)
+        if (!statusCodeFeature.Enabled || statusCodeMetadata?.Enabled is false)
         {
             // Check if the feature is still available because other middleware (such as a web API written in MVC) could
             // have disabled the feature to prevent HTML status code responses from showing up to an API client.

src/Middleware/Diagnostics/test/UnitTests/Microsoft.AspNetCore.Diagnostics.Tests.csproj

@@ -20,6 +20,7 @@
     <Reference Include="Microsoft.Extensions.DiagnosticAdapter" />
     <Reference Include="Microsoft.Extensions.FileProviders.Embedded" />
     <Reference Include="Microsoft.AspNetCore" />
+    <Reference Include="Microsoft.AspNetCore.Mvc.ViewFeatures" />
   </ItemGroup>
 
 </Project>

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

@@ -8,6 +8,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -283,4 +284,38 @@ public async Task Reexecute_WorksAfterUseRoutingWithGlobalRouteBuilder()
         var content = await response.Content.ReadAsStringAsync();
         Assert.Equal("errorPage", content);
     }
+
+    [Fact]
+    public async Task SkipStatusCodePages_SupportsEndpoints()
+    {
+        var builder = WebApplication.CreateBuilder();
+        builder.WebHost.UseTestServer();
+        await using var app = builder.Build();
+
+        app.UseRouting();
+
+        app.UseStatusCodePages();
+
+        app.UseEndpoints(endpoints =>
+        {
+            endpoints.MapGet("/", [SkipStatusCodePages] (c) =>
+            {
+                c.Response.StatusCode = 404;
+                return Task.CompletedTask;
+            });
+        });
+
+        app.Run((context) =>
+        {
+            throw new InvalidOperationException("Invalid input provided.");
+        });
+
+        await app.StartAsync();
+
+        using var server = app.GetTestServer();
+        var client = server.CreateClient();
+        var response = await client.GetAsync("/");
+        var content = await response.Content.ReadAsStringAsync();
+        Assert.Empty(content);
+    }
 }

src/Mvc/Mvc.ViewFeatures/src/PublicAPI.Unshipped.txt

@@ -1 +1,2 @@
 #nullable enable
+Microsoft.AspNetCore.Mvc.SkipStatusCodePagesAttribute.Enabled.get -> bool

src/Mvc/Mvc.ViewFeatures/src/SkipStatusCodePagesAttribute.cs

@@ -4,15 +4,25 @@
 using System;
 using Microsoft.AspNetCore.Diagnostics;
 using Microsoft.AspNetCore.Mvc.Filters;
+using Microsoft.AspNetCore.Http.Metadata;
 
 namespace Microsoft.AspNetCore.Mvc;
 
 /// <summary>
 /// A filter that prevents execution of the StatusCodePages middleware.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
-public class SkipStatusCodePagesAttribute : Attribute, IResourceFilter
+public class SkipStatusCodePagesAttribute : Attribute, IResourceFilter, ISkipStatusCodePagesMetadata
 {
+    /// <summary>
+    /// Initializes a new instace of <see cref="SkipStatusCodePagesAttribute" />
+    /// with <see cref="ISkipStatusCodePagesMetadata.Enabled" /> set to <lang ref="false" />.
+    /// </summary>
+    public SkipStatusCodePagesAttribute()
+    {
+        Enabled = false;
+    }
+
     /// <inheritdoc />
     public void OnResourceExecuted(ResourceExecutedContext context)
     {
@@ -33,4 +43,7 @@ public void OnResourceExecuting(ResourceExecutingContext context)
             statusCodeFeature.Enabled = false;
         }
     }
+
+    /// <inheritdoc />
+    public bool Enabled { get; }
 }

src/Mvc/Mvc.ViewFeatures/test/SkipStatusCodePagesAttributeTest.cs

@@ -28,6 +28,7 @@ public void SkipStatusCodePagesAttribute_TurnsOfStatusCodePages()
 
         // Assert
         Assert.False(statusCodePagesFeature.Enabled);
+        Assert.False(skipStatusCodeAttribute.Enabled);
     }
 
     [Fact]
@@ -39,6 +40,9 @@ public void SkipStatusCodePagesAttribute_Does_Not_Throw_If_Feature_Missing()
 
         // Act
         skipStatusCodeAttribute.OnResourceExecuting(resourceExecutingContext);
+
+        // Assert
+        Assert.False(skipStatusCodeAttribute.Enabled);
     }
 
     private static ResourceExecutingContext CreateResourceExecutingContext(IFilterMetadata[] filters)