Corrected version-neutral handling. Fixes #118.

Chris Martinez · commonsensesoftware · commit 665917d5a148 · 2017-04-28T11:50:05.000-07:00
diff --git a/src/Microsoft.AspNet.WebApi.Versioning.ApiExplorer/Description/VersionedApiExplorer.cs b/src/Microsoft.AspNet.WebApi.Versioning.ApiExplorer/Description/VersionedApiExplorer.cs
@@ -133,14 +133,18 @@ protected virtual bool ShouldExploreAction( string actionRouteParameterValue, Ht
 
             if ( ( setting == null || !setting.IgnoreApi ) && MatchRegexConstraint( route, RouteValueKeys.Action, actionRouteParameterValue ) )
             {
-                var versions = actionDescriptor.GetApiVersions();
+                var model = actionDescriptor.GetApiVersionModel();
 
-                if ( versions.Contains( apiVersion ) )
+                if ( model.IsApiVersionNeutral || model.DeclaredApiVersions.Contains( apiVersion ) )
                 {
                     return true;
                 }
 
-                return versions.Count == 0 && actionDescriptor.ControllerDescriptor.GetDeclaredApiVersions().Contains( apiVersion );
+                if ( model.DeclaredApiVersions.Count == 0 )
+                {
+                    model = actionDescriptor.ControllerDescriptor.GetApiVersionModel();
+                    return model.IsApiVersionNeutral || model.DeclaredApiVersions.Contains( apiVersion );
+                }
             }
 
             return false;
@@ -164,7 +168,8 @@ protected virtual bool ShouldExploreController( string controllerRouteParameterV
 
             if ( ( setting == null || !setting.IgnoreApi ) && MatchRegexConstraint( route, RouteValueKeys.Controller, controllerRouteParameterValue ) )
             {
-                return controllerDescriptor.GetDeclaredApiVersions().Contains( apiVersion );
+                var model = controllerDescriptor.GetApiVersionModel();
+                return model.IsApiVersionNeutral || model.DeclaredApiVersions.Contains( apiVersion );
             }
 
             return false;
@@ -478,8 +483,15 @@ IEnumerable<ApiVersion> FlattenApiVersions()
             advertisedDeprecated.ExceptWith( declared );
             supported.ExceptWith( advertisedSupported );
             deprecated.ExceptWith( supported.Concat( advertisedDeprecated ) );
+            supported.UnionWith( deprecated );
+
+            if ( supported.Count == 0 )
+            {
+                supported.Add( options.DefaultApiVersion );
+                return supported;
+            }
 
-            return supported.Union( deprecated ).OrderBy( v => v );
+            return supported.OrderBy( v => v );
         }
 
         static HttpControllerDescriptor GetDirectRouteController( CandidateAction[] directRouteCandidates, ApiVersion apiVersion )
diff --git a/src/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/DefaultApiVersionDescriptionProvider.cs b/src/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/DefaultApiVersionDescriptionProvider.cs
@@ -4,6 +4,7 @@
     using Microsoft.AspNetCore.Mvc.ApplicationModels;
     using Microsoft.AspNetCore.Mvc.Infrastructure;
     using Microsoft.AspNetCore.Mvc.Versioning;
+    using Microsoft.Extensions.Options;
     using System;
     using System.Collections.Generic;
     using System.Diagnostics.Contracts;
@@ -16,19 +17,26 @@
     public class DefaultApiVersionDescriptionProvider : IApiVersionDescriptionProvider
     {
         readonly Lazy<IReadOnlyList<ApiVersionDescription>> apiVersionDescriptions;
+        readonly IOptions<ApiVersioningOptions> options;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="DefaultApiVersionDescriptionProvider"/> class.
         /// </summary>
         /// <param name="actionDescriptorCollectionProvider">The <see cref="IActionDescriptorCollectionProvider">provider</see> used to enumerate the actions within an application.</param>
         /// <param name="groupNameFormatter">The <see cref="IApiVersionGroupNameFormatter">formatter</see> used to get group names for API versions.</param>
-        public DefaultApiVersionDescriptionProvider( IActionDescriptorCollectionProvider actionDescriptorCollectionProvider, IApiVersionGroupNameFormatter groupNameFormatter )
+        /// <param name="apiVersioningOptions">The <see cref="IOptions{TOptions}">container</see> of configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
+        public DefaultApiVersionDescriptionProvider(
+            IActionDescriptorCollectionProvider actionDescriptorCollectionProvider,
+            IApiVersionGroupNameFormatter groupNameFormatter,
+            IOptions<ApiVersioningOptions> apiVersioningOptions )
         {
             Arg.NotNull( actionDescriptorCollectionProvider, nameof( actionDescriptorCollectionProvider ) );
             Arg.NotNull( groupNameFormatter, nameof( groupNameFormatter ) );
+            Arg.NotNull( apiVersioningOptions, nameof( apiVersioningOptions ) );
 
             apiVersionDescriptions = new Lazy<IReadOnlyList<ApiVersionDescription>>( () => EnumerateApiVersions( actionDescriptorCollectionProvider ) );
             GroupNameFormatter = groupNameFormatter;
+            options = apiVersioningOptions;
         }
 
         /// <summary>
@@ -37,6 +45,12 @@ public DefaultApiVersionDescriptionProvider( IActionDescriptorCollectionProvider
         /// <value>The <see cref="IApiVersionGroupNameFormatter">group name formatter</see> used to format group names.</value>
         protected IApiVersionGroupNameFormatter GroupNameFormatter { get; }
 
+        /// <summary>
+        /// Gets the current API versioning options associated with the API explorer.
+        /// </summary>
+        /// <value>The current <see cref="ApiVersioningOptions">API versioning options</see>.</value>
+        protected ApiVersioningOptions Options => options.Value;
+
         /// <summary>
         /// Gets a read-only list of discovered API version descriptions.
         /// </summary>
@@ -88,7 +102,7 @@ protected virtual IReadOnlyList<ApiVersionDescription> EnumerateApiVersions( IAc
             return descriptions.OrderBy( d => d.ApiVersion ).ToArray();
         }
 
-        static void BucketizeApiVersions( IReadOnlyList<ActionDescriptor> actions, ISet<ApiVersion> supported, ISet<ApiVersion> deprecated )
+        void BucketizeApiVersions( IReadOnlyList<ActionDescriptor> actions, ISet<ApiVersion> supported, ISet<ApiVersion> deprecated )
         {
             Contract.Requires( actions != null );
             Contract.Requires( supported != null );
@@ -125,6 +139,11 @@ static void BucketizeApiVersions( IReadOnlyList<ActionDescriptor> actions, ISet<
             advertisedDeprecated.ExceptWith( declared );
             supported.ExceptWith( advertisedSupported );
             deprecated.ExceptWith( supported.Concat( advertisedDeprecated ) );
+
+            if ( supported.Count == 0 && deprecated.Count == 0 )
+            {
+                supported.Add( Options.DefaultApiVersion );
+            }
         }
 
         void AppendDescriptions( ICollection<ApiVersionDescription> descriptions, IEnumerable<ApiVersion> versions, bool deprecated )
diff --git a/src/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/VersionedApiDescriptionProvider.cs b/src/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/VersionedApiDescriptionProvider.cs
@@ -7,6 +7,7 @@
     using Microsoft.AspNetCore.Mvc.Routing;
     using Microsoft.AspNetCore.Mvc.Versioning;
     using Microsoft.AspNetCore.Routing;
+    using Microsoft.Extensions.Options;
     using System;
     using System.Collections.Generic;
     using System.Diagnostics.Contracts;
@@ -20,18 +21,26 @@
     [CLSCompliant( false )]
     public class VersionedApiDescriptionProvider : IApiDescriptionProvider
     {
+        readonly IOptions<ApiVersioningOptions> options;
+
         /// <summary>
         /// Initializes a new instance of <see cref="VersionedApiDescriptionProvider"/> class.
         /// </summary>
         /// <param name="groupNameFormatter">The <see cref="IApiVersionGroupNameFormatter">formatter</see> used to get group names for API versions.</param>
         /// <param name="metadadataProvider">The <see cref="IModelMetadataProvider">provider</see> used to retrieve model metadata.</param>
-        public VersionedApiDescriptionProvider( IApiVersionGroupNameFormatter groupNameFormatter, IModelMetadataProvider metadadataProvider )
+        /// <param name="apiVersioningOptions">The <see cref="IOptions{TOptions}">container</see> of configured <see cref="ApiVersioningOptions">API versioning options</see>.</param>
+        public VersionedApiDescriptionProvider(
+            IApiVersionGroupNameFormatter groupNameFormatter,
+            IModelMetadataProvider metadadataProvider,
+            IOptions<ApiVersioningOptions> apiVersioningOptions )
         {
             Arg.NotNull( groupNameFormatter, nameof( groupNameFormatter ) );
             Arg.NotNull( metadadataProvider, nameof( metadadataProvider ) );
+            Arg.NotNull( apiVersioningOptions, nameof( apiVersioningOptions ) );
 
             GroupNameFormatter = groupNameFormatter;
             MetadadataProvider = metadadataProvider;
+            options = apiVersioningOptions;
         }
 
         /// <summary>
@@ -46,6 +55,12 @@ public VersionedApiDescriptionProvider( IApiVersionGroupNameFormatter groupNameF
         /// <value>The <see cref="IModelMetadataProvider">provider</see> used to retrieve model metadata.</value>
         protected IModelMetadataProvider MetadadataProvider { get; }
 
+        /// <summary>
+        /// Gets the current API versioning options associated with the API explorer.
+        /// </summary>
+        /// <value>The current <see cref="ApiVersioningOptions">API versioning options</see>.</value>
+        protected ApiVersioningOptions Options => options.Value;
+
         /// <summary>
         /// Gets the order prescendence of the current API description provider.
         /// </summary>
@@ -139,7 +154,7 @@ public virtual void OnProvidersExecuted( ApiDescriptionProviderContext context )
         /// <remarks>The default implementation performs no operation.</remarks>
         public virtual void OnProvidersExecuting( ApiDescriptionProviderContext context ) { }
 
-        static IEnumerable<ApiVersion> FlattenApiVersions( IEnumerable<ApiDescription> descriptions )
+        IEnumerable<ApiVersion> FlattenApiVersions( IEnumerable<ApiDescription> descriptions )
         {
             Contract.Requires( descriptions != null );
             Contract.Ensures( Contract.Result<IEnumerable<ApiVersion>>() != null );
@@ -158,6 +173,12 @@ static IEnumerable<ApiVersion> FlattenApiVersions( IEnumerable<ApiDescription> d
                 }
             }
 
+            if ( versions.Count == 0 )
+            {
+                versions.Add( Options.DefaultApiVersion );
+                return versions;
+            }
+
             return versions.OrderBy( v => v );
         }
 
diff --git a/test/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.Tests/DefaultApiVersionDescriptionProviderTest.cs b/test/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.Tests/DefaultApiVersionDescriptionProviderTest.cs
@@ -5,6 +5,7 @@
     using Microsoft.AspNetCore.Mvc.ApplicationModels;
     using Microsoft.AspNetCore.Mvc.Infrastructure;
     using Microsoft.AspNetCore.Mvc.Versioning;
+    using Microsoft.Extensions.Options;
     using Moq;
     using System.Reflection;
     using Xunit;
@@ -18,7 +19,8 @@ public void api_version_descriptions_should_collate_expected_versions()
             // arrange
             var actionProvider = new TestActionDescriptorCollectionProvider();
             var groupNameFormatter = new DefaultApiVersionGroupNameFormatter();
-            var descriptionProvider = new DefaultApiVersionDescriptionProvider( actionProvider, groupNameFormatter );
+            var apiVersioningOptions = new OptionsWrapper<ApiVersioningOptions>( new ApiVersioningOptions() );
+            var descriptionProvider = new DefaultApiVersionDescriptionProvider( actionProvider, groupNameFormatter, apiVersioningOptions );
 
             // act
             var descriptions = descriptionProvider.ApiVersionDescriptions;
@@ -40,7 +42,8 @@ public void is_deprecated_should_return_false_without_api_vesioning()
             // arrange
             var provider = new DefaultApiVersionDescriptionProvider(
                 new Mock<IActionDescriptorCollectionProvider>().Object,
-                new Mock<IApiVersionGroupNameFormatter>().Object );
+                new Mock<IApiVersionGroupNameFormatter>().Object,
+                new OptionsWrapper<ApiVersioningOptions>( new ApiVersioningOptions() ) );
             var action = new ActionDescriptor();
 
             // act
@@ -56,7 +59,8 @@ public void is_deprecated_should_return_false_when_controller_is_versionX2Dneutr
             // arrange
             var provider = new DefaultApiVersionDescriptionProvider(
                 new Mock<IActionDescriptorCollectionProvider>().Object,
-                new Mock<IApiVersionGroupNameFormatter>().Object );
+                new Mock<IApiVersionGroupNameFormatter>().Object,
+                new OptionsWrapper<ApiVersioningOptions>( new ApiVersioningOptions() ) );
             var action = new ActionDescriptor();
             var controller = new ControllerModel( typeof( Controller ).GetTypeInfo(), new object[0] );
 
@@ -78,7 +82,8 @@ public void is_deprecated_should_return_expected_result_for_deprecated_version(
             // arrange
             var provider = new DefaultApiVersionDescriptionProvider(
                 new Mock<IActionDescriptorCollectionProvider>().Object,
-                new Mock<IApiVersionGroupNameFormatter>().Object );
+                new Mock<IApiVersionGroupNameFormatter>().Object,
+                new OptionsWrapper<ApiVersioningOptions>( new ApiVersioningOptions() ) );
             var action = new ActionDescriptor();
             var controller = new ControllerModel( typeof( Controller ).GetTypeInfo(), new object[0] );
             var model = new ApiVersionModel(
diff --git a/test/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.Tests/VersionedApiDescriptionProviderTest.cs b/test/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.Tests/VersionedApiDescriptionProviderTest.cs
@@ -3,6 +3,8 @@
     using FluentAssertions;
     using Microsoft.AspNetCore.Mvc.ModelBinding;
     using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
+    using Microsoft.AspNetCore.Mvc.Versioning;
+    using Microsoft.Extensions.Options;
     using Moq;
     using System.Collections.Generic;
     using Xunit;
@@ -17,7 +19,8 @@ public void versioned_api_explorer_should_group_and_order_descriptions_on_provid
             var context = new ApiDescriptionProviderContext( actionProvider.ActionDescriptors.Items );
             var groupNameFormatter = new DefaultApiVersionGroupNameFormatter();
             var modelMetadataProvider = NewModelMetadataProvider();
-            var apiExplorer = new VersionedApiDescriptionProvider( groupNameFormatter, modelMetadataProvider );
+            var apiVersioningOptions = new OptionsWrapper<ApiVersioningOptions>( new ApiVersioningOptions() );
+            var apiExplorer = new VersionedApiDescriptionProvider( groupNameFormatter, modelMetadataProvider, apiVersioningOptions );
 
             foreach ( var action in context.Actions )
             {

Original file line number	Diff line number	Diff line change
`@@ -133,14 +133,18 @@ protected virtual bool ShouldExploreAction( string actionRouteParameterValue, Ht`
`133`	`133`
`134`	`134`	`if ( ( setting == null \|\| !setting.IgnoreApi ) && MatchRegexConstraint( route, RouteValueKeys.Action, actionRouteParameterValue ) )`
`135`	`135`	`{`
`136`		`- var versions = actionDescriptor.GetApiVersions();`
	`136`	`+ var model = actionDescriptor.GetApiVersionModel();`
`137`	`137`
`138`		`- if ( versions.Contains( apiVersion ) )`
	`138`	`+ if ( model.IsApiVersionNeutral \|\| model.DeclaredApiVersions.Contains( apiVersion ) )`
`139`	`139`	`{`
`140`	`140`	`return true;`
`141`	`141`	`}`
`142`	`142`
`143`		`- return versions.Count == 0 && actionDescriptor.ControllerDescriptor.GetDeclaredApiVersions().Contains( apiVersion );`
	`143`	`+ if ( model.DeclaredApiVersions.Count == 0 )`
	`144`	`+ {`
	`145`	`+ model = actionDescriptor.ControllerDescriptor.GetApiVersionModel();`
	`146`	`+ return model.IsApiVersionNeutral \|\| model.DeclaredApiVersions.Contains( apiVersion );`
	`147`	`+ }`
`144`	`148`	`}`
`145`	`149`
`146`	`150`	`return false;`
`@@ -164,7 +168,8 @@ protected virtual bool ShouldExploreController( string controllerRouteParameterV`
`164`	`168`
`165`	`169`	`if ( ( setting == null \|\| !setting.IgnoreApi ) && MatchRegexConstraint( route, RouteValueKeys.Controller, controllerRouteParameterValue ) )`
`166`	`170`	`{`
`167`		`- return controllerDescriptor.GetDeclaredApiVersions().Contains( apiVersion );`
	`171`	`+ var model = controllerDescriptor.GetApiVersionModel();`
	`172`	`+ return model.IsApiVersionNeutral \|\| model.DeclaredApiVersions.Contains( apiVersion );`
`168`	`173`	`}`
`169`	`174`
`170`	`175`	`return false;`
`@@ -478,8 +483,15 @@ IEnumerable<ApiVersion> FlattenApiVersions()`
`478`	`483`	`advertisedDeprecated.ExceptWith( declared );`
`479`	`484`	`supported.ExceptWith( advertisedSupported );`
`480`	`485`	`deprecated.ExceptWith( supported.Concat( advertisedDeprecated ) );`
	`486`	`+ supported.UnionWith( deprecated );`
	`487`	`+`
	`488`	`+ if ( supported.Count == 0 )`
	`489`	`+ {`
	`490`	`+ supported.Add( options.DefaultApiVersion );`
	`491`	`+ return supported;`
	`492`	`+ }`
`481`	`493`
`482`		`- return supported.Union( deprecated ).OrderBy( v => v );`
	`494`	`+ return supported.OrderBy( v => v );`
`483`	`495`	`}`
`484`	`496`
`485`	`497`	`static HttpControllerDescriptor GetDirectRouteController( CandidateAction[] directRouteCandidates, ApiVersion apiVersion )`