Fix DefaultProblemDetailsWriter polymorphism (#45906)

* Support PD Polymorphism

* Code clean up

* Update src/Http/Http.Extensions/test/ProblemDetailsDefaultWriterTest.cs

Co-authored-by: Stephen Halter <[email protected]>

* Combining typeresolvers on postconfigure

* Combining typeresolvers in PDWriter

* Adding more unit tests

* Adding more unit tests

* Moving back to PostConfigure

* Update ProblemDetailsServiceCollectionExtensions.cs

* Adding ProblemDetailsJsonOptionsSetup

* Update ProblemDetailsServiceCollectionExtensions.cs

* Update DefaultProblemDetailsWriter.cs

Co-authored-by: Stephen Halter <[email protected]>

Author: brunolins16

src/Http/Http.Extensions/src/DefaultProblemDetailsWriter.cs

@@ -1,11 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.CompilerServices;
 using System.Text.Json;
-using System.Text.Json.Serialization;
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http.Json;
 using Microsoft.Extensions.Options;
 using Microsoft.Net.Http.Headers;
 
@@ -15,11 +12,14 @@ internal sealed partial class DefaultProblemDetailsWriter : IProblemDetailsWrite
 {
     private static readonly MediaTypeHeaderValue _jsonMediaType = new("application/json");
     private static readonly MediaTypeHeaderValue _problemDetailsJsonMediaType = new("application/problem+json");
+
     private readonly ProblemDetailsOptions _options;
+    private readonly JsonSerializerOptions _serializerOptions;
 
-    public DefaultProblemDetailsWriter(IOptions<ProblemDetailsOptions> options)
+    public DefaultProblemDetailsWriter(IOptions<ProblemDetailsOptions> options, IOptions<JsonOptions> jsonOptions)
     {
         _options = options.Value;
+        _serializerOptions = jsonOptions.Value.SerializerOptions;
     }
 
     public bool CanWrite(ProblemDetailsContext context)
@@ -49,49 +49,17 @@ public bool CanWrite(ProblemDetailsContext context)
         return false;
     }
 
-    [UnconditionalSuppressMessage("Trimming", "IL2026",
-        Justification = "JSON serialization of ProblemDetails.Extensions might require types that cannot be statically analyzed. The property is annotated with RequiresUnreferencedCode.")]
-    [UnconditionalSuppressMessage("Trimming", "IL3050",
-        Justification = "JSON serialization of ProblemDetails.Extensions might require types that cannot be statically analyzed. The property is annotated with RequiresDynamicCode.")]
     public ValueTask WriteAsync(ProblemDetailsContext context)
     {
         var httpContext = context.HttpContext;
         ProblemDetailsDefaults.Apply(context.ProblemDetails, httpContext.Response.StatusCode);
         _options.CustomizeProblemDetails?.Invoke(context);
 
-        // Use source generation serialization in two scenarios:
-        // 1. There are no extensions. Source generation is faster and works well with trimming.
-        // 2. Native AOT. In this case only the data types specified on ProblemDetailsJsonContext will work.
-        if (context.ProblemDetails.Extensions is { Count: 0 } || !RuntimeFeature.IsDynamicCodeSupported)
-        {
-            return new ValueTask(httpContext.Response.WriteAsJsonAsync(
-                context.ProblemDetails,
-                ProblemDetailsJsonContext.Default.ProblemDetails,
-                contentType: "application/problem+json"));
-        }
+        var problemDetailsType = context.ProblemDetails.GetType();
 
         return new ValueTask(httpContext.Response.WriteAsJsonAsync(
                         context.ProblemDetails,
-                        options: null,
+                         _serializerOptions.GetTypeInfo(problemDetailsType),
                         contentType: "application/problem+json"));
     }
-
-    // Additional values are specified on JsonSerializerContext to support some values for extensions.
-    // For example, the DeveloperExceptionMiddleware serializes its complex type to JsonElement, which problem details then needs to serialize.
-    [JsonSerializable(typeof(ProblemDetails))]
-    [JsonSerializable(typeof(JsonElement))]
-    [JsonSerializable(typeof(string))]
-    [JsonSerializable(typeof(decimal))]
-    [JsonSerializable(typeof(float))]
-    [JsonSerializable(typeof(double))]
-    [JsonSerializable(typeof(int))]
-    [JsonSerializable(typeof(long))]
-    [JsonSerializable(typeof(Guid))]
-    [JsonSerializable(typeof(Uri))]
-    [JsonSerializable(typeof(TimeSpan))]
-    [JsonSerializable(typeof(DateTime))]
-    [JsonSerializable(typeof(DateTimeOffset))]
-    internal sealed partial class ProblemDetailsJsonContext : JsonSerializerContext
-    {
-    }
 }

src/Http/Http.Extensions/src/JsonOptions.cs

@@ -33,7 +33,7 @@ public class JsonOptions
     /// <summary>
     /// Gets the <see cref="JsonSerializerOptions"/>.
     /// </summary>
-    public JsonSerializerOptions SerializerOptions { get; } = new JsonSerializerOptions(DefaultSerializerOptions);
+    public JsonSerializerOptions SerializerOptions { get; internal set; } = new JsonSerializerOptions(DefaultSerializerOptions);
 
 #pragma warning disable IL2026 // Suppressed in Microsoft.AspNetCore.Http.Extensions.WarningSuppressions.xml
 #pragma warning disable IL3050 // Calling members annotated with 'RequiresDynamicCodeAttribute' may break functionality when AOT compiling.

src/Http/Http.Extensions/src/ProblemDetailsJsonContext.cs

@@ -0,0 +1,17 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.Json.Serialization;
+using System.Text.Json;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Microsoft.AspNetCore.Http;
+
+[JsonSerializable(typeof(ProblemDetails))]
+[JsonSerializable(typeof(HttpValidationProblemDetails))]
+// Additional values are specified on JsonSerializerContext to support some values for extensions.
+// For example, the DeveloperExceptionMiddleware serializes its complex type to JsonElement, which problem details then needs to serialize.
+[JsonSerializable(typeof(JsonElement))]
+internal sealed partial class ProblemDetailsJsonContext : JsonSerializerContext
+{
+}

src/Http/Http.Extensions/src/ProblemDetailsJsonOptionsSetup.cs

@@ -0,0 +1,25 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.Json.Serialization.Metadata;
+using Microsoft.AspNetCore.Http.Json;
+using Microsoft.Extensions.Options;
+
+namespace Microsoft.AspNetCore.Http;
+
+internal sealed class ProblemDetailsJsonOptionsSetup : IPostConfigureOptions<JsonOptions>
+{
+    public void PostConfigure(string? name, JsonOptions options)
+    {
+        if (options.SerializerOptions.TypeInfoResolver is not null)
+        {
+            if (options.SerializerOptions.IsReadOnly)
+            {
+                options.SerializerOptions = new(options.SerializerOptions);
+            }
+
+            // Combine the current resolver with our internal problem details context
+            options.SerializerOptions.TypeInfoResolver = JsonTypeInfoResolver.Combine(options.SerializerOptions.TypeInfoResolver!, ProblemDetailsJsonContext.Default);
+        }
+    }
+}

src/Http/Http.Extensions/src/ProblemDetailsServiceCollectionExtensions.cs

@@ -2,8 +2,10 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Json;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
 
 namespace Microsoft.Extensions.DependencyInjection;
 
@@ -38,6 +40,7 @@ public static IServiceCollection AddProblemDetails(
         // Adding default services;
         services.TryAddSingleton<IProblemDetailsService, ProblemDetailsService>();
         services.TryAddEnumerable(ServiceDescriptor.Singleton<IProblemDetailsWriter, DefaultProblemDetailsWriter>());
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IPostConfigureOptions<JsonOptions>, ProblemDetailsJsonOptionsSetup>());
 
         if (configure != null)
         {