Support AOT compatibility where possible

Author: commonsensesoftware

src/Abstractions/src/Asp.Versioning.Abstractions/Asp.Versioning.Abstractions.csproj

@@ -10,6 +10,10 @@
   <PackageTags>Asp;AspNet;AspNetCore;Versioning</PackageTags>
  </PropertyGroup>
 
+ <PropertyGroup Condition=" '$(TargetFramework)' == '$(DefaultTargetFramework)' ">
+  <IsAotCompatible>true</IsAotCompatible>
+ </PropertyGroup>
+
  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.0' ">
   <Compile Remove="netstandard2.0\**\*.cs;net#.0\**\*.cs" />
   <None Include="netstandard2.0\**\*.cs;net#.0\**\*.cs" />

src/AspNetCore/WebApi/src/Asp.Versioning.Http/Asp.Versioning.Http.csproj

@@ -8,6 +8,7 @@
   <AssemblyTitle>ASP.NET Core API Versioning</AssemblyTitle>
   <Description>A service API versioning library for Microsoft ASP.NET Core.</Description>
   <PackageTags>Asp;AspNet;AspNetCore;Versioning</PackageTags>
+  <IsAotCompatible>true</IsAotCompatible>
  </PropertyGroup>
 
  <ItemGroup>

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

@@ -6,6 +6,7 @@ namespace Microsoft.Extensions.DependencyInjection;
 using Asp.Versioning.ApiExplorer;
 using Asp.Versioning.Routing;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Json;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Options;
@@ -90,26 +91,7 @@ private static void AddApiVersioningServices( IServiceCollection services )
         services.TryAddEnumerable( Singleton<IApiVersionMetadataCollationProvider, EndpointApiVersionMetadataCollationProvider>() );
         services.Replace( WithLinkGeneratorDecorator( services ) );
         TryAddProblemDetailsRfc7231Compliance( services );
-    }
-
-    // REF: https://github.com/dotnet/runtime/blob/master/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceDescriptor.cs#L125
-    private static Type GetImplementationType( this ServiceDescriptor descriptor )
-    {
-        if ( descriptor.ImplementationType != null )
-        {
-            return descriptor.ImplementationType;
-        }
-        else if ( descriptor.ImplementationInstance != null )
-        {
-            return descriptor.ImplementationInstance.GetType();
-        }
-        else if ( descriptor.ImplementationFactory != null )
-        {
-            var typeArguments = descriptor.ImplementationFactory.GetType().GenericTypeArguments;
-            return typeArguments[1];
-        }
-
-        throw new InvalidOperationException();
+        TryAddErrorObjectJsonOptions( services );
     }
 
     private static ServiceDescriptor WithLinkGeneratorDecorator( IServiceCollection services )
@@ -127,12 +109,31 @@ private static ServiceDescriptor WithLinkGeneratorDecorator( IServiceCollection
 
         if ( factory == null )
         {
-            var decoratedType = descriptor.GetImplementationType();
-            var decoratorType = typeof( ApiVersionLinkGenerator<> ).MakeGenericType( decoratedType );
+            // REF: https://github.com/dotnet/aspnetcore/blob/main/src/Http/Routing/src/DependencyInjection/RoutingServiceCollectionExtensions.cs#L96
+            // REF: https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.DependencyInjection.Abstractions/src/ServiceDescriptor.cs#L292
+            var decoratedType = descriptor switch
+            {
+                { ImplementationType: var type } when type is not null => type,
+                { ImplementationInstance: var instance } when instance is not null => instance.GetType(),
+                _ => throw new InvalidOperationException(),
+            };
 
             services.Replace( Describe( decoratedType, decoratedType, lifetime ) );
 
-            return Describe( typeof( LinkGenerator ), decoratorType, lifetime );
+            LinkGenerator NewFactory( IServiceProvider serviceProvider )
+            {
+                var instance = (LinkGenerator) serviceProvider.GetRequiredService( decoratedType! );
+                var source = serviceProvider.GetRequiredService<IApiVersionParameterSource>();
+
+                if ( source.VersionsByUrl() )
+                {
+                    instance = new ApiVersionLinkGenerator( instance );
+                }
+
+                return instance;
+            }
+
+            return Describe( typeof( LinkGenerator ), NewFactory, lifetime );
         }
         else
         {
@@ -177,4 +178,24 @@ static bool IsDefaultProblemDetailsWriter( ServiceDescriptor serviceDescriptor )
         static Rfc7231ProblemDetailsWriter NewProblemDetailsWriter( IServiceProvider serviceProvider, Type decoratedType ) =>
             new( (IProblemDetailsWriter) serviceProvider.GetRequiredService( decoratedType ) );
     }
+
+    private static void TryAddErrorObjectJsonOptions( IServiceCollection services )
+    {
+        var serviceType = typeof( IProblemDetailsWriter );
+        var implementationType = typeof( ErrorObjectWriter );
+
+        for ( var i = 0; i < services.Count; i++ )
+        {
+            var service = services[i];
+
+            // inheritance is intentionally not considered here because it will require a user-defined
+            // JsonSerlizerContext and IConfigureOptions<JsonOptions>
+            if ( service.ServiceType == serviceType &&
+                 service.ImplementationType == implementationType )
+            {
+                services.TryAddEnumerable( Singleton<IConfigureOptions<JsonOptions>, ErrorObjectJsonOptionsSetup>() );
+                return;
+            }
+        }
+    }
 }

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

@@ -0,0 +1,24 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes
+
+namespace Asp.Versioning;
+
+using Microsoft.AspNetCore.Http.Json;
+using Microsoft.Extensions.Options;
+
+/// <summary>
+/// Adds the ErrorObjectJsonContext to the current JsonSerializerOptions.
+///
+/// This allows for consistent serialization behavior for ErrorObject regardless if the
+/// default reflection-based serializer is used and makes it trim/NativeAOT compatible.
+/// </summary>
+internal sealed class ErrorObjectJsonOptionsSetup : IConfigureOptions<JsonOptions>
+{
+    // Always insert the ErrorObjectJsonContext to the beginning of the chain at the time this Configure
+    // is invoked. This JsonTypeInfoResolver will be before the default reflection-based resolver, and
+    // before any other resolvers currently added. If apps need to customize serialization, they can
+    // prepend a custom ErrorObject resolver to the chain in an IConfigureOptions<JsonOptions> registered.
+    public void Configure( JsonOptions options ) =>
+        options.SerializerOptions.TypeInfoResolverChain.Insert( 0, new ErrorObjectWriter.ErrorObjectJsonContext() );
+}

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

@@ -4,8 +4,11 @@ namespace Asp.Versioning;
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System.Text.Json;
 using System.Text.Json.Serialization;
 using static System.Text.Json.Serialization.JsonIgnoreCondition;
+using JsonOptions = Microsoft.AspNetCore.Http.Json.JsonOptions;
 
 /// <summary>
 /// Represents a problem details writer that outputs error objects in responses.
@@ -15,8 +18,18 @@ namespace Asp.Versioning;
 /// in the Microsoft REST API Guidelines and
 /// <a ref="https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#_Toc38457793">OData Error Responses</a>.</remarks>
 [CLSCompliant( false )]
-public class ErrorObjectWriter : IProblemDetailsWriter
+public partial class ErrorObjectWriter : IProblemDetailsWriter
 {
+    private readonly JsonSerializerOptions options;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ErrorObjectWriter"/> class.
+    /// </summary>
+    /// <param name="options">The current <see cref="JsonOptions">JSON options</see>.</param>
+    /// <exception cref="ArgumentNullException"><paramref name="options"/> is <c>null</c>.</exception>
+    public ErrorObjectWriter( IOptions<JsonOptions> options ) =>
+        this.options = ( options ?? throw new ArgumentNullException( nameof( options ) ) ).Value.SerializerOptions;
+
     /// <inheritdoc />
     public virtual bool CanWrite( ProblemDetailsContext context )
     {
@@ -40,7 +53,7 @@ public virtual ValueTask WriteAsync( ProblemDetailsContext context )
 
         OnBeforeWrite( context, ref obj );
 
-        return new( response.WriteAsJsonAsync( obj ) );
+        return new( response.WriteAsJsonAsync( obj, options.GetTypeInfo( obj.GetType() ) ) );
     }
 
     /// <summary>
@@ -58,7 +71,7 @@ protected virtual void OnBeforeWrite( ProblemDetailsContext context, ref ErrorOb
     /// <summary>
     /// Represents an error object.
     /// </summary>
-    protected readonly struct ErrorObject
+    protected internal readonly partial struct ErrorObject
     {
         internal ErrorObject( ProblemDetails problemDetails ) =>
             Error = new( problemDetails );
@@ -74,7 +87,7 @@ internal ErrorObject( ProblemDetails problemDetails ) =>
     /// <summary>
     /// Represents the error detail.
     /// </summary>
-    protected readonly struct ErrorDetail
+    protected internal readonly partial struct ErrorDetail
     {
         private readonly ProblemDetails problemDetails;
         private readonly InnerError? innerError;
@@ -154,7 +167,7 @@ public string? Target
     /// <summary>
     /// Represents an inner error.
     /// </summary>
-    protected readonly struct InnerError
+    protected internal readonly partial struct InnerError
     {
         private readonly ProblemDetails problemDetails;
         private readonly Dictionary<string, object> extensions = [];
@@ -181,4 +194,9 @@ public string? Message
         [JsonExtensionData]
         public IDictionary<string, object> Extensions => extensions;
     }
+
+    [JsonSerializable( typeof( ErrorObject ) )]
+    internal sealed partial class ErrorObjectJsonContext : JsonSerializerContext
+    {
+    }
 }

src/AspNetCore/WebApi/src/Asp.Versioning.Http/Routing/ApiVersioningRouteOptionsSetup.cs

@@ -24,7 +24,7 @@ public virtual void PostConfigure( string? name, RouteOptions options )
     {
         ArgumentNullException.ThrowIfNull( options );
 
-        var key = versioningOptions.Value.RouteConstraintName;
-        options.ConstraintMap.Add( key, typeof( ApiVersionRouteConstraint ) );
+        var token = versioningOptions.Value.RouteConstraintName;
+        options.SetParameterPolicy<ApiVersionRouteConstraint>( token );
     }
 }

src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/ErrorObjectWriterTest.cs

@@ -3,6 +3,8 @@
 namespace Asp.Versioning;
 
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Json;
+using Microsoft.Extensions.Options;
 using System.Text.Json;
 using System.Threading.Tasks;
 
@@ -16,7 +18,7 @@ public class ErrorObjectWriterTest
     public void can_write_should_be_true_for_api_versioning_problem_types( string type )
     {
         // arrange
-        var writer = new ErrorObjectWriter();
+        var writer = new ErrorObjectWriter( Options.Create( new JsonOptions() ) );
         var context = new ProblemDetailsContext()
         {
             HttpContext = new DefaultHttpContext(),
@@ -38,7 +40,7 @@ public void can_write_should_be_false_for_other_problem_types()
     {
         // arrange
         const string BadRequest = "https://tools.ietf.org/html/rfc7231#section-6.5.1";
-        var writer = new ErrorObjectWriter();
+        var writer = new ErrorObjectWriter( Options.Create( new JsonOptions() ) );
         var context = new ProblemDetailsContext()
         {
             HttpContext = new DefaultHttpContext(),
@@ -73,14 +75,14 @@ public async Task write_async_should_output_expected_json()
             },
         };
 
-        var writer = new ErrorObjectWriter();
+        var writer = new ErrorObjectWriter( Options.Create( new JsonOptions() ) );
         using var stream = new MemoryStream();
         var response = new Mock<HttpResponse>() { CallBase = true };
         var httpContext = new Mock<HttpContext>() { CallBase = true };
 
         response.SetupGet( r => r.Body ).Returns( stream );
         response.SetupProperty( r => r.ContentType );
-        response.SetupGet(r => r.HttpContext).Returns(() => httpContext.Object );
+        response.SetupGet( r => r.HttpContext ).Returns( () => httpContext.Object );
         httpContext.SetupGet( c => c.Response ).Returns( response.Object );
 
         var context = new ProblemDetailsContext()

src/Client/src/Asp.Versioning.Http.Client/Asp.Versioning.Http.Client.csproj

@@ -10,6 +10,10 @@
   <PackageTags>Asp;AspNet;AspNetCore;Versioning;Http</PackageTags>
  </PropertyGroup>
 
+ <PropertyGroup Condition=" '$(TargetFramework)' == '$(DefaultTargetFramework)' ">
+  <IsAotCompatible>true</IsAotCompatible>
+ </PropertyGroup>
+
  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.1' ">
   <Compile Remove="net#.0\**\*.cs" />
   <None Include="net#.0\**\*.cs" />
@@ -44,5 +48,5 @@
  <ItemGroup>
   <ProjectReference Include="..\..\..\Abstractions\src\Asp.Versioning.Abstractions\Asp.Versioning.Abstractions.csproj" />
  </ItemGroup>
- 
+
 </Project>