Refactor to hide access to services that will be available via EndpointBuilder.ServiceProvider and minimize breaking changes in 7.0

Author: commonsensesoftware

src/AspNetCore/WebApi/src/Asp.Versioning.Http/SR.Designer.cs

@@ -123,6 +123,9 @@
   <data name="ConventionAddedAfterEndpointBuilt" xml:space="preserve">
     <value>Conventions cannot be added after building the endpoint.</value>
   </data>
+  <data name="NoEndpointBuilderServices" xml:space="preserve">
+    <value>The required services have not been provided to the EndointBuilder.</value>
+  </data>
   <data name="RequestTypeUnconfigured" xml:space="preserve">
     <value>The request type was not configured.</value>
   </data>

src/AspNetCore/WebApi/src/Asp.Versioning.Http/SR.resx

@@ -2,52 +2,21 @@
 
 namespace Asp.Versioning.Builder;
 
-using Microsoft.Extensions.Options;
-using Opts = Microsoft.Extensions.Options.Options;
-
 /// <summary>
 /// Represents an API version set.
 /// </summary>
 public class ApiVersionSet
 {
-    private readonly IOptions<ApiVersioningOptions> options;
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="ApiVersionSet"/> class.
-    /// </summary>
-    /// <param name="builder">The associated <see cref="ApiVersionSetBuilder">builder</see>.</param>
-    /// <param name="name">The optional API name.</param>
-    /// <param name="parameterSource">The configured <see cref="IApiVersionParameterSource">API version
-    /// parameter source</see>.</param>
-    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
-    public ApiVersionSet(
-        ApiVersionSetBuilder builder,
-        string? name,
-        IApiVersionParameterSource parameterSource,
-        ApiVersioningOptions options ) :
-        this( builder, name, parameterSource, Opts.Create( options ) )
-    {
-    }
-
     /// <summary>
     /// Initializes a new instance of the <see cref="ApiVersionSet"/> class.
     /// </summary>
     /// <param name="builder">The associated <see cref="ApiVersionSetBuilder">builder</see>.</param>
     /// <param name="name">The optional API name.</param>
-    /// <param name="parameterSource">The configured <see cref="IApiVersionParameterSource">API version
-    /// parameter source</see>.</param>
-    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
-    public ApiVersionSet(
-        ApiVersionSetBuilder builder,
-        string? name,
-        IApiVersionParameterSource parameterSource,
-        IOptions<ApiVersioningOptions> options )
+    public ApiVersionSet( ApiVersionSetBuilder builder, string? name )
     {
         Builder = builder ?? throw new ArgumentNullException( nameof( builder ) );
         Name = name;
         ReportApiVersions = builder.WillReportApiVersions;
-        ParameterSource = parameterSource;
-        this.options = options;
     }
 
     /// <summary>
@@ -62,17 +31,9 @@ public ApiVersionSet(
     /// <value>True if all APIs in the version set will report their API versions; otherwise, false.</value>
     public bool ReportApiVersions { get; }
 
-    /// <summary>
-    /// Gets the configured API version parameter source.
-    /// </summary>
-    /// <value>The configured <see cref="IApiVersionParameterSource">API version parameter source</see>.</value>
-    public IApiVersionParameterSource ParameterSource { get; }
-
-    /// <summary>
-    /// Gets the configured API versioning options.
-    /// </summary>
-    /// <value>The configured <see cref="ApiVersioningOptions">API versioning options</see>.</value>
-    public ApiVersioningOptions Options => options.Value;
+    // intentionally internal for 6.0, until EndpointBuilder.ServiceProvider is exposed in 7.0
+    // REF: https://github.com/dotnet/aspnetcore/pull/41238/files#diff-f8807c470bcc3a077fb176668a46df57b4bb99c992b6b7b375665f8bf3903c94R510
+    internal IServiceProvider? ServiceProvider { get; set; }
 
     /// <summary>
     /// Gets the associated builder.
@@ -83,8 +44,9 @@ public ApiVersionSet(
     /// <summary>
     /// Builds and returns the API version model for the version set.
     /// </summary>
+    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
     /// <returns>A new <see cref="ApiVersionModel">API version model</see>.</returns>
-    public virtual ApiVersionModel Build() => Builder.BuildApiVersionModel();
+    public virtual ApiVersionModel Build( ApiVersioningOptions options ) => Builder.BuildApiVersionModel( options );
 
     /// <summary>
     /// Advertises that the specified API version is supported in the version set.

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/ApiVersionSet.cs

@@ -3,33 +3,23 @@
 namespace Asp.Versioning.Builder;
 
 using Asp.Versioning.Conventions;
-using Microsoft.Extensions.Options;
 
 /// <summary>
 /// Represents the builder for an API version set.
 /// </summary>
 public class ApiVersionSetBuilder : ApiVersionConventionBuilderBase, IDeclareApiVersionConventionBuilder
 {
     private readonly string? name;
-    private readonly IApiVersionParameterSource parameterSource;
-    private readonly IOptions<ApiVersioningOptions> options;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="ApiVersionSetBuilder"/> class.
     /// </summary>
     /// <param name="name">The name of the API, if any.</param>
-    /// <param name="parameterSource">The <see cref="IApiVersionParameterSource">API version
-    /// parameter source</see>.</param>
-    /// <param name="options">The configured API versioning options.</param>
-    public ApiVersionSetBuilder(
-        string? name,
-        IApiVersionParameterSource parameterSource,
-        IOptions<ApiVersioningOptions> options )
-    {
-        this.name = name;
-        this.parameterSource = parameterSource;
-        this.options = options;
-    }
+    public ApiVersionSetBuilder( string? name ) => this.name = name;
+
+    // intentionally internal for 6.0, until EndpointBuilder.ServiceProvider is exposed in 7.0
+    // REF: https://github.com/dotnet/aspnetcore/pull/41238/files#diff-f8807c470bcc3a077fb176668a46df57b4bb99c992b6b7b375665f8bf3903c94R510
+    internal IServiceProvider? ServiceProvider { get; set; }
 
     /// <summary>
     /// Gets or sets a value indicating whether requests report the API version compatibility information in responses.
@@ -41,7 +31,7 @@ public ApiVersionSetBuilder(
     /// Builds and returns a new API versioning configuration.
     /// </summary>
     /// <returns>A new <see cref="ApiVersionSet">API versioning configuration</see>.</returns>
-    public virtual ApiVersionSet Build() => new( this, name, parameterSource, options );
+    public virtual ApiVersionSet Build() => new( this, name ) { ServiceProvider = ServiceProvider };
 
     /// <summary>
     /// Indicates that all APIs in the version set will report their versions.
@@ -120,17 +110,23 @@ public virtual ApiVersionSetBuilder AdvertisesDeprecatedApiVersion( ApiVersion a
     /// <summary>
     /// Builds and returns an API version model.
     /// </summary>
+    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
     /// <returns>A new <see cref="ApiVersionModel">API version model</see>.</returns>
-    protected internal virtual ApiVersionModel BuildApiVersionModel()
+    protected internal virtual ApiVersionModel BuildApiVersionModel( ApiVersioningOptions options )
     {
+        if ( options == null )
+        {
+            throw new ArgumentNullException( nameof( options ) );
+        }
+
         if ( VersionNeutral )
         {
             return ApiVersionModel.Neutral;
         }
 
         if ( IsEmpty )
         {
-            return new( options.Value.DefaultApiVersion );
+            return new( options.DefaultApiVersion );
         }
 
         return new(

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/ApiVersionSetBuilder.cs

@@ -1,32 +1,33 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 
-#pragma warning disable
-
 namespace Asp.Versioning.Builder;
 
-using Asp.Versioning.Conventions;
-using Asp.Versioning.Routing;
-using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Routing;
-using Microsoft.Extensions.Options;
-using System.Globalization;
-using static Asp.Versioning.ApiVersionParameterLocation;
-
-internal sealed class DefaultApiVersionSetBuilderFactory :
-    IApiVersionSetBuilderFactory
+/// <summary>
+/// Represents the default API version set builder factory.
+/// </summary>
+public class DefaultApiVersionSetBuilderFactory : IApiVersionSetBuilderFactory
 {
-    private readonly IApiVersionParameterSource parameterSource;
-    private readonly IOptions<ApiVersioningOptions> options;
+    private readonly IServiceProvider serviceProvider;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DefaultApiVersionSetBuilderFactory"/> class.
+    /// </summary>
+    /// <param name="serviceProvider">The underlying <see cref="IServiceProvider">service provider</see>.</param>
+    public DefaultApiVersionSetBuilderFactory( IServiceProvider serviceProvider ) =>
+        this.serviceProvider = serviceProvider;
 
-    public DefaultApiVersionSetBuilderFactory(
-        IApiVersionParameterSource parameterSource,
-        IOptions<ApiVersioningOptions> options )
+    /// <inheritdoc />
+    public ApiVersionSetBuilder Create( string? name = default )
     {
-        this.parameterSource = parameterSource;
-        this.options = options;
+        var instance = CreateInstance( name );
+        instance.ServiceProvider = serviceProvider;
+        return instance;
     }
 
-    public ApiVersionSetBuilder Create( string? name = default ) =>
-        new( name, parameterSource, options );
-}
+    /// <summary>
+    /// Creates and returns a new builder instance.
+    /// </summary>
+    /// <param name="name">The optional name associated with the builder.</param>
+    /// <returns>A new <see cref="ApiVersionSetBuilder">API version set builder</see>.</returns>
+    protected virtual ApiVersionSetBuilder CreateInstance( string? name ) => new( name );
+}

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/DefaultApiVersionSetBuilderFactory.cs

@@ -7,6 +7,8 @@ namespace Microsoft.AspNetCore.Builder;
 using Asp.Versioning.Routing;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Routing;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 using System.Globalization;
 using static Asp.Versioning.ApiVersionParameterLocation;
 
@@ -72,12 +74,21 @@ private static void Apply(
         IVersionedEndpointConventionBuilder conventions,
         ApiVersionSet versionSet )
     {
+        // this will change to EndpointBuilder.ServiceProvider in 7.0
+        // REF: https://github.com/dotnet/aspnetcore/pull/41238/files#diff-f8807c470bcc3a077fb176668a46df57b4bb99c992b6b7b375665f8bf3903c94R510
+        if ( versionSet.ServiceProvider is not IServiceProvider services )
+        {
+            throw new InvalidOperationException( SR.NoEndpointBuilderServices );
+        }
+
+        var parameterSource = services.GetRequiredService<IApiVersionParameterSource>();
+        var options = services.GetRequiredService<IOptions<ApiVersioningOptions>>().Value;
         var requestDelegate = default( RequestDelegate );
-        var metadata = conventions.Build();
+        var metadata = conventions.Build( options );
 
         endpointBuilder.Metadata.Add( metadata );
 
-        if ( versionSet.Options.ReportApiVersions ||
+        if ( options.ReportApiVersions ||
              versionSet.ReportApiVersions ||
              conventions.ReportApiVersions )
         {
@@ -86,9 +97,9 @@ private static void Apply(
             endpointBuilder.RequestDelegate = requestDelegate;
         }
 
-        if ( versionSet.ParameterSource.VersionsByMediaType() )
+        if ( parameterSource.VersionsByMediaType() )
         {
-            var parameterName = versionSet.ParameterSource.GetParameterName( MediaTypeParameter );
+            var parameterName = parameterSource.GetParameterName( MediaTypeParameter );
             requestDelegate = EnsureRequestDelegate( requestDelegate, endpointBuilder.RequestDelegate );
             requestDelegate = new ContentTypeApiVersionDecorator( requestDelegate, parameterName );
             endpointBuilder.RequestDelegate = requestDelegate;

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/IEndpointConventionBuilderExtensions.cs

@@ -20,6 +20,7 @@ public interface IVersionedEndpointConventionBuilder : IEndpointConventionBuilde
     /// <summary>
     /// Builds and returns a new API version metadata.
     /// </summary>
+    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
     /// <returns>A new <see cref="ApiVersionMetadata">API version metadata</see>.</returns>
-    ApiVersionMetadata Build();
+    ApiVersionMetadata Build( ApiVersioningOptions options );
 }

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/IVersionedEndpointConventionBuilder.cs

@@ -19,13 +19,9 @@ public class VersionedEndpointConventionBuilder :
     /// <summary>
     /// Initializes a new instance of the <see cref="VersionedEndpointConventionBuilder"/> class.
     /// </summary>
-    /// <param name="inner">The inner <see cref="IEndpointConventionBuilder"/> the new
-    /// instance decorates.</param>
-    /// <param name="apiVersionSet">The associated <see cref="ApiVersionSet">API version
-    /// set</see>.</param>
-    public VersionedEndpointConventionBuilder(
-        IEndpointConventionBuilder inner,
-        ApiVersionSet apiVersionSet )
+    /// <param name="inner">The inner <see cref="IEndpointConventionBuilder"/> the new instance decorates.</param>
+    /// <param name="apiVersionSet">The associated <see cref="ApiVersionSet">API version set</see>.</param>
+    public VersionedEndpointConventionBuilder( IEndpointConventionBuilder inner, ApiVersionSet apiVersionSet )
     {
         this.inner = inner ?? throw new ArgumentNullException( nameof( inner ) );
         VersionSet = apiVersionSet ?? throw new ArgumentNullException( nameof( apiVersionSet ) );
@@ -124,13 +120,14 @@ public virtual IVersionedEndpointConventionBuilder AdvertisesDeprecatedApiVersio
     /// <summary>
     /// Builds and returns a new API version metadata.
     /// </summary>
+    /// <param name="options">The configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
     /// <returns>A new <see cref="ApiVersionMetadata">API version metadata</see>.</returns>
-    protected virtual ApiVersionMetadata Build()
+    protected virtual ApiVersionMetadata Build( ApiVersioningOptions options )
     {
         var name = VersionSet.Name;
         ApiVersionModel? apiModel;
 
-        if ( VersionNeutral || ( apiModel = VersionSet.Build() ).IsApiVersionNeutral )
+        if ( VersionNeutral || ( apiModel = VersionSet.Build( options ) ).IsApiVersionNeutral )
         {
             if ( string.IsNullOrEmpty( name ) )
             {
@@ -194,7 +191,7 @@ protected virtual ApiVersionMetadata Build()
             name );
     }
 
-    ApiVersionMetadata IVersionedEndpointConventionBuilder.Build() => Build();
+    ApiVersionMetadata IVersionedEndpointConventionBuilder.Build( ApiVersioningOptions options ) => Build( options );
 
     void IDeclareApiVersionConventionBuilder.IsApiVersionNeutral() => IsApiVersionNeutral();
 

src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/VersionedEndpointConventionBuilder.cs

@@ -2,17 +2,13 @@
 
 namespace Asp.Versioning.Builder;
 
-using Microsoft.Extensions.Options;
-
 public class ApiVersionSetTest
 {
     [Fact]
     public void report_api_versions_should_derive_from_builder()
     {
         // arrange
-        var source = Mock.Of<IApiVersionParameterSource>();
-        var options = Options.Create( new ApiVersioningOptions() );
-        var builder = new ApiVersionSetBuilder( null, source, options ).ReportApiVersions();
+        var builder = new ApiVersionSetBuilder( default ).ReportApiVersions();
 
         // act
         var versionSet = builder.Build();
@@ -25,14 +21,10 @@ public void report_api_versions_should_derive_from_builder()
     public void build_should_construct_model_from_builder()
     {
         // arrange
-        var source = Mock.Of<IApiVersionParameterSource>();
-        var options = Options.Create( new ApiVersioningOptions() );
-        var versionSet = new ApiVersionSetBuilder( null, source, options )
-            .IsApiVersionNeutral()
-            .Build();
+        var versionSet = new ApiVersionSetBuilder( null ).IsApiVersionNeutral().Build();
 
         // act
-        var model = versionSet.Build();
+        var model = versionSet.Build( new() );
 
         // assert
         model.Should().BeSameAs( ApiVersionModel.Neutral );
@@ -42,9 +34,7 @@ public void build_should_construct_model_from_builder()
     public void advertises_api_version_should_propagate_to_builder()
     {
         // arrange
-        var source = Mock.Of<IApiVersionParameterSource>();
-        var options = Options.Create( new ApiVersioningOptions() );
-        var builder = new Mock<ApiVersionSetBuilder>( null, source, options ) { CallBase = true };
+        var builder = new Mock<ApiVersionSetBuilder>( null ) { CallBase = true };
 
         builder.Setup( b => b.AdvertisesApiVersion( It.IsAny<ApiVersion>() ) );
 
@@ -62,9 +52,7 @@ public void advertises_api_version_should_propagate_to_builder()
     public void advertises_deprecated_api_version_should_propagate_to_builder()
     {
         // arrange
-        var source = Mock.Of<IApiVersionParameterSource>();
-        var options = Options.Create( new ApiVersioningOptions() );
-        var builder = new Mock<ApiVersionSetBuilder>( null, source, options ) { CallBase = true };
+        var builder = new Mock<ApiVersionSetBuilder>( null ) { CallBase = true };
 
         builder.Setup( b => b.AdvertisesDeprecatedApiVersion( It.IsAny<ApiVersion>() ) );