Remove marker interfaces for ISunsetPolicyBuilder and IDeprecationPolicyBuilder

Author: Matthias Gessinger

src/Abstractions/src/Asp.Versioning.Abstractions/IDeprecationPolicyManager.cs

@@ -8,7 +8,7 @@ public class ISunsetPolicyManagerExtensionsTest
     public void try_get_policy_should_get_global_policy_by_version()
     {
         // arrange
-        var manager = new Mock<ISunsetPolicyManager>();
+        var manager = new Mock<IPolicyManager<SunsetPolicy>>();
         var version = ApiVersion.Default;
         var expected = new SunsetPolicy();
 
@@ -26,7 +26,7 @@ public void try_get_policy_should_get_global_policy_by_version()
     public void try_get_policy_should_get_global_policy_by_name()
     {
         // arrange
-        var manager = new Mock<ISunsetPolicyManager>();
+        var manager = new Mock<IPolicyManager<SunsetPolicy>>();
         var expected = new SunsetPolicy();
 
         manager.Setup( m => m.TryGetPolicy( "Test", default, out expected ) )
@@ -43,7 +43,7 @@ public void try_get_policy_should_get_global_policy_by_name()
     public void resolve_policy_should_return_most_specific_result()
     {
         // arrange
-        var manager = new Mock<ISunsetPolicyManager>();
+        var manager = new Mock<IPolicyManager<SunsetPolicy>>();
         var expected = new SunsetPolicy();
         var other = new SunsetPolicy();
 
@@ -61,7 +61,7 @@ public void resolve_policy_should_return_most_specific_result()
     public void resolve_policy_should_fall_back_to_global_result()
     {
         // arrange
-        var manager = new Mock<ISunsetPolicyManager>();
+        var manager = new Mock<IPolicyManager<SunsetPolicy>>();
         var expected = new SunsetPolicy();
         var other = new SunsetPolicy();
 

src/Abstractions/src/Asp.Versioning.Abstractions/ISunsetPolicyManager.cs

@@ -31,10 +31,10 @@ public async Task options_should_return_expected_headers()
         var resolver = new SimpleDependencyResolver( configuration );
 
         resolver.AddService(
-            typeof( ISunsetPolicyManager ),
+            typeof( IPolicyManager<SunsetPolicy> ),
             ( sp, t ) => new SunsetPolicyManager( sp.GetRequiredService<HttpConfiguration>().GetApiVersioningOptions() ) );
         resolver.AddService(
-            typeof( IDeprecationPolicyManager ),
+            typeof( IPolicyManager<DeprecationPolicy> ),
             ( sp, t ) => new DeprecationPolicyManager( sp.GetRequiredService<HttpConfiguration>().GetApiVersioningOptions() ) );
         configuration.DependencyResolver = resolver;
         configuration.AddApiVersioning(

src/Abstractions/test/Asp.Versioning.Abstractions.Tests/ISunsetPolicyManagerExtensionsTest.cs

@@ -32,8 +32,8 @@ public class VersionedApiExplorer : IApiExplorer
     private readonly ApiExplorerOptions options;
     private readonly Lazy<ApiDescriptionGroupCollection> apiDescriptionsHolder;
     private IDocumentationProvider? documentationProvider;
-    private ISunsetPolicyManager? sunsetPolicyManager;
-    private IDeprecationPolicyManager? deprecationPolicyManager;
+    private IPolicyManager<SunsetPolicy>? sunsetPolicyManager;
+    private IPolicyManager<DeprecationPolicy>? deprecationPolicyManager;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="VersionedApiExplorer"/> class.
@@ -99,8 +99,8 @@ public IDocumentationProvider DocumentationProvider
     /// <summary>
     /// Gets or sets the manager used to resolve sunset policies for API descriptions.
     /// </summary>
-    /// <value>The configured <see cref="ISunsetPolicyManager">sunset policy manager</see>.</value>
-    protected ISunsetPolicyManager SunsetPolicyManager
+    /// <value>The configured <see cref="IPolicyManager{TPolicy}">sunset policy manager</see>.</value>
+    protected IPolicyManager<SunsetPolicy> SunsetPolicyManager
     {
         get => sunsetPolicyManager ??= Configuration.GetSunsetPolicyManager();
         set => sunsetPolicyManager = value;
@@ -109,8 +109,8 @@ protected ISunsetPolicyManager SunsetPolicyManager
     /// <summary>
     /// Gets or sets the manager used to resolve deprecation policies for API descriptions.
     /// </summary>
-    /// <value>The configured <see cref="IDeprecationPolicyManager">deprecation policy manager</see>.</value>
-    protected IDeprecationPolicyManager DeprecationPolicyManager
+    /// <value>The configured <see cref="IPolicyManager{TPolicy}">deprecation policy manager</see>.</value>
+    protected IPolicyManager<DeprecationPolicy> DeprecationPolicyManager
     {
         get => deprecationPolicyManager ??= Configuration.GetDeprecationPolicyManager();
         set => deprecationPolicyManager = value;

src/AspNet/OData/test/Asp.Versioning.WebApi.OData.Tests/Controllers/VersionedMetadataControllerTest.cs

@@ -18,8 +18,8 @@ internal DefaultContainer()
         container.AddService( typeof( IApiVersionParser ), static ( sc, t ) => ApiVersionParser.Default );
         container.AddService( typeof( IControllerNameConvention ), static ( sc, t ) => ControllerNameConvention.Default );
         container.AddService( typeof( IProblemDetailsFactory ), static ( sc, t ) => new ProblemDetailsFactory() );
-        container.AddService( typeof( ISunsetPolicyManager ), NewSunsetPolicyManager );
-        container.AddService( typeof( IDeprecationPolicyManager ), NewDeprecationPolicyManager );
+        container.AddService( typeof( IPolicyManager<SunsetPolicy> ), NewSunsetPolicyManager );
+        container.AddService( typeof( IPolicyManager<DeprecationPolicy> ), NewDeprecationPolicyManager );
         container.AddService( typeof( IReportApiVersions ), NewApiVersionReporter );
     }
 
@@ -67,10 +67,10 @@ public IEnumerable<object> GetServices( Type serviceType )
     private static ApiVersioningOptions GetApiVersioningOptions( IServiceProvider serviceProvider ) =>
         (ApiVersioningOptions) serviceProvider.GetService( typeof( ApiVersioningOptions ) );
 
-    private static ISunsetPolicyManager NewSunsetPolicyManager( IServiceProvider serviceProvider, Type type ) =>
+    private static IPolicyManager<SunsetPolicy> NewSunsetPolicyManager( IServiceProvider serviceProvider, Type type ) =>
         new SunsetPolicyManager( GetApiVersioningOptions( serviceProvider ) );
 
-    private static IDeprecationPolicyManager NewDeprecationPolicyManager( IServiceProvider serviceProvider, Type type ) =>
+    private static IPolicyManager<DeprecationPolicy> NewDeprecationPolicyManager( IServiceProvider serviceProvider, Type type ) =>
         new DeprecationPolicyManager( GetApiVersioningOptions( serviceProvider ) );
 
     private static IReportApiVersions NewApiVersionReporter( IServiceProvider serviceProvider, Type type )
@@ -79,8 +79,8 @@ private static IReportApiVersions NewApiVersionReporter( IServiceProvider servic
 
         if ( options.ReportApiVersions )
         {
-            var sunsetPolicyManager = (ISunsetPolicyManager) serviceProvider.GetService( typeof( ISunsetPolicyManager ) );
-            var deprecationPolicyManager = (IDeprecationPolicyManager) serviceProvider.GetService( typeof( IDeprecationPolicyManager ) );
+            var sunsetPolicyManager = (IPolicyManager<SunsetPolicy>) serviceProvider.GetService( typeof( IPolicyManager<SunsetPolicy> ) );
+            var deprecationPolicyManager = (IPolicyManager<DeprecationPolicy>) serviceProvider.GetService( typeof( IPolicyManager<DeprecationPolicy> ) );
             return new DefaultApiVersionReporter( sunsetPolicyManager, deprecationPolicyManager );
         }
 

src/AspNet/WebApi/src/Asp.Versioning.WebApi.ApiExplorer/ApiExplorer/VersionedApiExplorer.cs

@@ -35,11 +35,11 @@ internal static IProblemDetailsFactory GetProblemDetailsFactory( this HttpConfig
         configuration.DependencyResolver.GetService<IProblemDetailsFactory>() ??
         configuration.ApiVersioningServices().GetRequiredService<IProblemDetailsFactory>();
 
-    internal static ISunsetPolicyManager GetSunsetPolicyManager( this HttpConfiguration configuration ) =>
-        configuration.DependencyResolver.GetService<ISunsetPolicyManager>() ??
-        configuration.ApiVersioningServices().GetRequiredService<ISunsetPolicyManager>();
+    internal static IPolicyManager<SunsetPolicy> GetSunsetPolicyManager( this HttpConfiguration configuration ) =>
+        configuration.DependencyResolver.GetService<IPolicyManager<SunsetPolicy>>() ??
+        configuration.ApiVersioningServices().GetRequiredService<IPolicyManager<SunsetPolicy>>();
 
-    internal static IDeprecationPolicyManager GetDeprecationPolicyManager( this HttpConfiguration configuration ) =>
-        configuration.DependencyResolver.GetService<IDeprecationPolicyManager>() ??
-        configuration.ApiVersioningServices().GetRequiredService<IDeprecationPolicyManager>();
+    internal static IPolicyManager<DeprecationPolicy> GetDeprecationPolicyManager( this HttpConfiguration configuration ) =>
+        configuration.DependencyResolver.GetService<IPolicyManager<DeprecationPolicy>>() ??
+        configuration.ApiVersioningServices().GetRequiredService<IPolicyManager<DeprecationPolicy>>();
 }

src/AspNet/WebApi/src/Asp.Versioning.WebApi/Dependencies/DefaultContainer.cs

@@ -1,5 +1,5 @@
 | :mega: Formerly [Microsoft.AspNet.WebApi.Versioning](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
-|-|
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 
 ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
 and existing REST services built with ASP.NET Web API. The API versioning extensions define simple metadata attributes
@@ -13,9 +13,8 @@ and conventions that you use to describe which API versions are implemented by y
 - Asp.Versioning.IApiVersionSelector
 - Asp.Versioning.IReportApiVersions
 - Asp.Versioning.ISunsetPolicyBuilder
-- Asp.Versioning.ISunsetPolicyManager
+- Asp.Versioning.IPolicyManager<SunsetPolicy>
 - Asp.Versioning.QueryStringApiVersionReader
 - Asp.Versioning.ReportApiVersionsAttribute
 
 ## Release Notes
-

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

@@ -71,7 +71,7 @@ public void report_should_add_expected_headers()
                 ] );
     }
 
-    private sealed class TestSunsetPolicyManager : ISunsetPolicyManager
+    private sealed class TestSunsetPolicyManager : IPolicyManager<SunsetPolicy>
     {
         private readonly DateTimeOffset sunsetDate;
 
@@ -92,7 +92,7 @@ public bool TryGetPolicy( string name, ApiVersion apiVersion, out SunsetPolicy s
         }
     }
 
-    private sealed class TestDeprecationPolicyManager : IDeprecationPolicyManager
+    private sealed class TestDeprecationPolicyManager : IPolicyManager<DeprecationPolicy>
     {
         private readonly DateTimeOffset deprecationDate;
 

src/AspNet/WebApi/src/Asp.Versioning.WebApi/README.md

@@ -143,8 +143,8 @@ private static void AddApiVersioningServices( IServiceCollection services )
         services.AddSingleton( static sp => (IApiVersionParameterSource) sp.GetRequiredService<IOptions<ApiVersioningOptions>>().Value.ApiVersionReader );
         services.AddSingleton( static sp => sp.GetRequiredService<IOptions<ApiVersioningOptions>>().Value.ApiVersionSelector );
         services.TryAddSingleton<IReportApiVersions, DefaultApiVersionReporter>();
-        services.TryAddSingleton<ISunsetPolicyManager, SunsetPolicyManager>();
-        services.TryAddSingleton<IDeprecationPolicyManager, DeprecationPolicyManager>();
+        services.TryAddSingleton<IPolicyManager<SunsetPolicy>, SunsetPolicyManager>();
+        services.TryAddSingleton<IPolicyManager<DeprecationPolicy>, DeprecationPolicyManager>();
         services.TryAddEnumerable( Transient<IValidateOptions<ApiVersioningOptions>, ValidateApiVersioningOptions>() );
         services.TryAddEnumerable( Transient<IPostConfigureOptions<RouteOptions>, ApiVersioningRouteOptionsSetup>() );
         services.TryAddEnumerable( Singleton<MatcherPolicy, ApiVersionMatcherPolicy>() );