Refactor to IProblemDetailsService

Author: commonsensesoftware

src/Common/src/Common.ProblemDetails/IProblemDetailsFactory.cs renamed to src/AspNet/WebApi/src/Asp.Versioning.WebApi/IProblemDetailsFactory.cs

@@ -4,7 +4,6 @@
 namespace Asp.Versioning;
 
 using Newtonsoft.Json;
-using System.Web.Http;
 using static Asp.Versioning.ProblemDetailsDefaults;
 using static Newtonsoft.Json.NullValueHandling;
 using static System.Globalization.CultureInfo;

src/AspNet/WebApi/src/Asp.Versioning.WebApi/ProblemDetailsFactory.cs

@@ -1,7 +1,5 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 
-#pragma warning disable CA1056 // URI-like properties should not be strings
-
 namespace Asp.Versioning;
 
 using Microsoft.AspNetCore.Builder;
@@ -26,7 +24,7 @@ public abstract partial class HttpServerFixture
     protected virtual void OnConfigurePartManager( ApplicationPartManager partManager ) =>
         partManager.ApplicationParts.Add( new TestApplicationPart( FilteredControllerTypes ) );
 
-    protected virtual void OnConfigureServices( IServiceCollection services ) => services.AddControllers();
+    protected virtual void OnConfigureServices( IServiceCollection services ) => services.AddProblemDetails().AddControllers();
 
     protected virtual void OnAddMvcApiVersioning( MvcApiVersioningOptions options ) { }
 

src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/HttpServerFixture.cs

@@ -43,7 +43,14 @@ public async Task then_get_should_return_406_for_an_unsupported_version()
         // arrange
         using var request = new HttpRequestMessage( Get, "api/values" )
         {
-            Headers = { Accept = { Parse( "application/json;v=3.0" ) } },
+            Headers =
+            {
+                Accept =
+                {
+                    Parse( "application/json;v=3.0" ),
+                    Parse( ProblemDetailsDefaults.MediaType.Json ),
+                },
+            },
         };
 
         // act

src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/Mvc/UsingMediaType/given a versioned Controller/when using media type negotiation.cs

@@ -25,7 +25,7 @@ protected override void OnConfigurePartManager( ApplicationPartManager partManag
     }
 
     protected override void OnConfigureServices( IServiceCollection services ) =>
-        services.AddControllers().AddOData();
+        services.AddProblemDetails().AddControllers().AddOData();
 
     protected override void OnAddApiVersioning( IApiVersioningBuilder builder ) =>
         builder.AddOData( OnEnableOData );

src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/OData/ODataFixture.cs

@@ -86,7 +86,6 @@ private static void AddApiVersioningServices( IServiceCollection services )
 
         services.TryAddSingleton<IApiVersionSetBuilderFactory, DefaultApiVersionSetBuilderFactory>();
         services.TryAddSingleton<IApiVersionParser, ApiVersionParser>();
-        services.TryAddSingleton<IProblemDetailsFactory, DefaultProblemDetailsFactory>();
         services.Add( Singleton( sp => sp.GetRequiredService<IOptions<ApiVersioningOptions>>().Value.ApiVersionReader ) );
         services.Add( Singleton( sp => (IApiVersionParameterSource) sp.GetRequiredService<IOptions<ApiVersioningOptions>>().Value.ApiVersionReader ) );
         services.Add( Singleton( sp => sp.GetRequiredService<IOptions<ApiVersioningOptions>>().Value.ApiVersionSelector ) );
@@ -95,6 +94,7 @@ private static void AddApiVersioningServices( IServiceCollection services )
         services.TryAddEnumerable( Transient<IPostConfigureOptions<RouteOptions>, ApiVersioningRouteOptionsSetup>() );
         services.TryAddEnumerable( Singleton<MatcherPolicy, ApiVersionMatcherPolicy>() );
         services.Replace( WithLinkGeneratorDecorator( services ) );
+        TryAddProblemDetailsRfc7231Compliance( services );
     }
 
     // REF: https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceDescriptor.cs#L125
@@ -157,4 +157,27 @@ LinkGenerator NewFactory( IServiceProvider serviceProvider )
             return Describe( typeof( LinkGenerator ), NewFactory, lifetime );
         }
     }
+
+    private static void TryAddProblemDetailsRfc7231Compliance( IServiceCollection services )
+    {
+        var descriptor = services.FirstOrDefault( IsDefaultProblemDetailsWriter );
+
+        if ( descriptor == null )
+        {
+            return;
+        }
+
+        var decoratedType = descriptor.ImplementationType!;
+        var lifetime = descriptor.Lifetime;
+
+        services.Add( Describe( decoratedType, decoratedType, lifetime ) );
+        services.Replace( Describe( typeof( IProblemDetailsWriter ), sp => NewProblemDetailsWriter( sp, decoratedType ), lifetime ) );
+
+        static bool IsDefaultProblemDetailsWriter( ServiceDescriptor serviceDescriptor ) =>
+            serviceDescriptor.ServiceType == typeof( IProblemDetailsWriter ) &&
+            serviceDescriptor.ImplementationType?.FullName == "Microsoft.AspNetCore.Http.DefaultProblemDetailsWriter";
+
+        static Rfc7231ProblemDetailsWriter NewProblemDetailsWriter( IServiceProvider serviceProvider, Type decoratedType ) =>
+            new( (IProblemDetailsWriter) serviceProvider.GetRequiredService( decoratedType ) );
+    }
 }

src/AspNetCore/WebApi/src/Asp.Versioning.Http/DefaultProblemDetailsFactory.cs

@@ -3,6 +3,7 @@
 namespace Microsoft.AspNetCore.Http;
 
 using Asp.Versioning;
+using Microsoft.Extensions.DependencyInjection;
 
 /// <summary>
 /// Provides extension methods for the <see cref="HttpContext"/> class.
@@ -42,4 +43,10 @@ public static IApiVersioningFeature ApiVersioningFeature( this HttpContext conte
     /// API version is in an invalid format.</remarks>
     /// <exception cref="AmbiguousApiVersionException">Multiple, different API versions were requested.</exception>
     public static ApiVersion? GetRequestedApiVersion( this HttpContext context ) => context.ApiVersioningFeature().RequestedApiVersion;
+
+    internal static bool TryGetProblemDetailsService( this HttpContext context, [NotNullWhen( true )] out IProblemDetailsService? problemDetailsService )
+    {
+        problemDetailsService = context.RequestServices.GetService<IProblemDetailsService>();
+        return problemDetailsService is not null;
+    }
 }

src/AspNetCore/WebApi/src/Asp.Versioning.Http/DependencyInjection/IServiceCollectionExtensions.cs

@@ -0,0 +1,50 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+
+namespace Asp.Versioning;
+
+using Microsoft.AspNetCore.Http;
+using Microsoft.Net.Http.Headers;
+
+// REF: https://github.com/dotnet/aspnetcore/blob/release/7.0/src/Http/Http.Extensions/src/DefaultProblemDetailsWriter.cs
+internal sealed class Rfc7231ProblemDetailsWriter : IProblemDetailsWriter
+{
+    private static readonly MediaTypeHeaderValue jsonMediaType = new( "application/json" );
+    private static readonly MediaTypeHeaderValue problemDetailsJsonMediaType = new( "application/problem+json" );
+    private readonly IProblemDetailsWriter decorated;
+
+    public Rfc7231ProblemDetailsWriter( IProblemDetailsWriter decorated ) => this.decorated = decorated;
+
+    public bool CanWrite( ProblemDetailsContext context )
+    {
+        if ( decorated.CanWrite( context ) )
+        {
+            return true;
+        }
+
+        var httpContext = context.HttpContext;
+        var accept = httpContext.Request.Headers.Accept;
+
+        // REF: https://www.rfc-editor.org/rfc/rfc7231#section-5.3.2
+        if ( accept.Count == 0 )
+        {
+            return true;
+        }
+
+        var acceptHeader = httpContext.Request.GetTypedHeaders().Accept;
+
+        for ( var i = 0; i < acceptHeader.Count; i++ )
+        {
+            var acceptHeaderValue = acceptHeader[i];
+
+            if ( jsonMediaType.IsSubsetOf( acceptHeaderValue ) ||
+                 problemDetailsJsonMediaType.IsSubsetOf( acceptHeaderValue ) )
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public ValueTask WriteAsync( ProblemDetailsContext context ) => decorated.WriteAsync( context );
+}

src/AspNetCore/WebApi/src/Asp.Versioning.Http/Http/HttpContextExtensions.cs

@@ -17,27 +17,25 @@ internal AmbiguousApiVersionEndpoint( ILogger logger )
 
     private static Task OnExecute( HttpContext context, ILogger logger )
     {
-        var services = context.RequestServices;
-        var factory = services.GetRequiredService<IProblemDetailsFactory>();
         var apiVersions = context.ApiVersioningFeature().RawRequestedApiVersions;
-        var (type, title) = ProblemDetailsDefaults.Ambiguous;
+
+        logger.ApiVersionAmbiguous( apiVersions.ToArray() );
+        context.Response.StatusCode = StatusCodes.Status400BadRequest;
+
+        if ( !context.TryGetProblemDetailsService( out var problemDetails ) )
+        {
+            return Task.CompletedTask;
+        }
+
         var detail = string.Format(
             CultureInfo.CurrentCulture,
             CommonSR.MultipleDifferentApiVersionsRequested,
             string.Join( ", ", apiVersions ) );
-        var problem = factory.CreateProblemDetails(
-            context.Request,
-            StatusCodes.Status400BadRequest,
-            title,
-            type,
-            detail );
-
-        logger.ApiVersionAmbiguous( apiVersions.ToArray() );
-        context.Response.StatusCode = StatusCodes.Status400BadRequest;
 
-        return context.Response.WriteAsJsonAsync(
-            problem,
-            options: default,
-            contentType: ProblemDetailsDefaults.MediaType.Json );
+        return problemDetails.WriteAsync(
+            EndpointProblem.New(
+                context,
+                ProblemDetailsDefaults.Ambiguous,
+                detail ) ).AsTask();
     }
 }