Correct binding source for [FromODataUri]. Fixes #693, Fixes #729, Fixes #737

commonsensesoftware · commonsensesoftware · commit f9ab22d443d3 · 2021-06-23T21:55:13.000-07:00
diff --git a/samples/aspnetcore/SwaggerODataSample/SwaggerODataSample.csproj b/samples/aspnetcore/SwaggerODataSample/SwaggerODataSample.csproj
@@ -8,7 +8,7 @@
 
  <ItemGroup>
   <PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.1.0" />
-  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.0.2-*" />
+  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.4-*" />
  </ItemGroup>
  
  <ItemGroup>
diff --git a/samples/aspnetcore/SwaggerODataSample/V1/OrdersController.cs b/samples/aspnetcore/SwaggerODataSample/V1/OrdersController.cs
@@ -61,7 +61,6 @@ public IActionResult Post( [FromBody] Order order )
         /// <returns>The most expensive order.</returns>
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The no orders exist.</response>
-        [HttpGet]
         [ODataRoute( "MostExpensive" )]
         [MapToApiVersion( "1.0" )]
         [Produces( "application/json" )]
@@ -77,13 +76,12 @@ public IActionResult Post( [FromBody] Order order )
         /// <returns>The order line items.</returns>
         /// <response code="200">The line items were successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
-        [HttpGet]
         [ODataRoute( "{key}/LineItems" )]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( ODataValue<IEnumerable<LineItem>> ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
         [EnableQuery( AllowedQueryOptions = Select )]
-        public IActionResult LineItems( int key )
+        public IActionResult GetLineItems( int key )
         {
             var lineItems = new[]
             {
diff --git a/samples/aspnetcore/SwaggerODataSample/V1/PeopleController.cs b/samples/aspnetcore/SwaggerODataSample/V1/PeopleController.cs
@@ -22,7 +22,6 @@ public class PeopleController : ODataController
         /// <returns>The requested person.</returns>
         /// <response code="200">The person was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Person ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
diff --git a/samples/aspnetcore/SwaggerODataSample/V2/OrdersController.cs b/samples/aspnetcore/SwaggerODataSample/V2/OrdersController.cs
@@ -110,7 +110,6 @@ public IActionResult Patch( int key, Delta<Order> delta )
         /// <returns>The most expensive order.</returns>
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The no orders exist.</response>
-        [HttpGet]
         [ODataRoute( nameof( MostExpensive ) )]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), Status200OK )]
@@ -127,7 +126,6 @@ public IActionResult Patch( int key, Delta<Order> delta )
         /// <response code="204">The order was successfully rated.</response>
         /// <response code="400">The parameters are invalid.</response>
         /// <response code="404">The order does not exist.</response>
-        [HttpPost]
         [ODataRoute( "{key}/Rate" )]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status400BadRequest )]
@@ -150,13 +148,12 @@ public IActionResult Rate( int key, ODataActionParameters parameters )
         /// <returns>The order line items.</returns>
         /// <response code="200">The line items were successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
-        [HttpGet]
         [ODataRoute( "{key}/LineItems" )]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( ODataValue<IEnumerable<LineItem>> ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
         [EnableQuery( AllowedQueryOptions = Select )]
-        public IActionResult LineItems( int key )
+        public IActionResult GetLineItems( int key )
         {
             var lineItems = new[]
             {
diff --git a/samples/aspnetcore/SwaggerODataSample/V2/PeopleController.cs b/samples/aspnetcore/SwaggerODataSample/V2/PeopleController.cs
@@ -116,7 +116,6 @@ public IActionResult Get( int key, ODataQueryOptions<Person> options )
         /// <param name="options">The current OData query options.</param>
         /// <returns>The matching new hires.</returns>
         /// <response code="200">The people were successfully retrieved.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( ODataValue<IEnumerable<Person>> ), Status200OK )]
         public IActionResult NewHires( DateTime since, ODataQueryOptions<Person> options ) => Get( options );
@@ -128,7 +127,6 @@ public IActionResult Get( int key, ODataQueryOptions<Person> options )
         /// <returns>The person's home address.</returns>
         /// <response code="200">The home address was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Address ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
diff --git a/samples/aspnetcore/SwaggerODataSample/V3/AcmeController.cs b/samples/aspnetcore/SwaggerODataSample/V3/AcmeController.cs
@@ -37,7 +37,6 @@ public class AcmeController : ODataController
         /// <param name="navigationProperty">The product to link.</param>
         /// <param name="link">The product identifier.</param>
         /// <returns>None</returns>
-        [HttpPost]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status404NotFound )]
         public IActionResult CreateRef( [FromODataUri] string navigationProperty, [FromBody] Uri link ) => NoContent();
diff --git a/samples/aspnetcore/SwaggerODataSample/V3/OrdersController.cs b/samples/aspnetcore/SwaggerODataSample/V3/OrdersController.cs
@@ -123,7 +123,6 @@ public IActionResult Patch( int key, Delta<Order> delta )
         /// <returns>The most expensive order.</returns>
         /// <response code="200">The order was successfully retrieved.</response>
         /// <response code="404">The no orders exist.</response>
-        [HttpGet]
         [ODataRoute( nameof( MostExpensive ) )]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Order ), Status200OK )]
@@ -140,7 +139,6 @@ public IActionResult Patch( int key, Delta<Order> delta )
         /// <response code="204">The order was successfully rated.</response>
         /// <response code="400">The parameters are invalid.</response>
         /// <response code="404">The order does not exist.</response>
-        [HttpPost]
         [ODataRoute( "{key}/Rate" )]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status400BadRequest )]
@@ -163,13 +161,12 @@ public IActionResult Rate( int key, ODataActionParameters parameters )
         /// <returns>The order line items.</returns>
         /// <response code="200">The line items were successfully retrieved.</response>
         /// <response code="404">The order does not exist.</response>
-        [HttpGet]
         [ODataRoute( "{key}/LineItems" )]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( ODataValue<IEnumerable<LineItem>> ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
         [EnableQuery( AllowedQueryOptions = Select )]
-        public IActionResult LineItems( int key )
+        public IActionResult GetLineItems( int key )
         {
             var lineItems = new[]
             {
diff --git a/samples/aspnetcore/SwaggerODataSample/V3/PeopleController.cs b/samples/aspnetcore/SwaggerODataSample/V3/PeopleController.cs
@@ -142,7 +142,6 @@ public IActionResult Post( [FromBody] Person person )
         /// <param name="options">The current OData query options.</param>
         /// <returns>The matching new hires.</returns>
         /// <response code="200">The people were successfully retrieved.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( ODataValue<IEnumerable<Person>> ), Status200OK )]
         public IActionResult NewHires( DateTime since, ODataQueryOptions<Person> options ) => Get( options );
@@ -156,7 +155,6 @@ public IActionResult Post( [FromBody] Person person )
         /// <response code="204">The person was successfully promoted.</response>
         /// <response code="400">The parameters are invalid.</response>
         /// <response code="404">The person does not exist.</response>
-        [HttpPost]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status400BadRequest )]
         [ProducesResponseType( Status404NotFound )]
@@ -178,7 +176,6 @@ public IActionResult Promote( int key, ODataActionParameters parameters )
         /// <returns>The person's home address.</returns>
         /// <response code="200">The home address was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Address ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
@@ -199,7 +196,6 @@ public IActionResult GetHomeAddress( int key ) =>
         /// <returns>The person's work address.</returns>
         /// <response code="200">The work address was successfully retrieved.</response>
         /// <response code="404">The person does not exist.</response>
-        [HttpGet]
         [Produces( "application/json" )]
         [ProducesResponseType( typeof( Address ), Status200OK )]
         [ProducesResponseType( Status404NotFound )]
diff --git a/samples/aspnetcore/SwaggerODataSample/V3/ProductsController.cs b/samples/aspnetcore/SwaggerODataSample/V3/ProductsController.cs
@@ -170,7 +170,6 @@ public IActionResult GetRefToSupplier( [FromODataUri] int key, [FromODataUri] st
         /// <param name="navigationProperty">The supplier to link.</param>
         /// <param name="link">The supplier identifier.</param>
         /// <returns>None</returns>
-        [HttpPut]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status404NotFound )]
         public IActionResult CreateRefToSupplier( [FromODataUri] int key, [FromODataUri] string navigationProperty, [FromBody] Uri link ) => NoContent();
diff --git a/samples/aspnetcore/SwaggerODataSample/V3/SuppliersController.cs b/samples/aspnetcore/SwaggerODataSample/V3/SuppliersController.cs
@@ -142,7 +142,6 @@ public IActionResult Put( [FromODataUri] int key, [FromBody] Supplier update )
         /// <param name="navigationProperty">The product to link.</param>
         /// <param name="link">The product identifier.</param>
         /// <returns>None</returns>
-        [HttpPost]
         [ProducesResponseType( Status204NoContent )]
         [ProducesResponseType( Status404NotFound )]
         public IActionResult CreateRefToProducts( [FromODataUri] int key, [FromODataUri] string navigationProperty, [FromBody] Uri link ) => NoContent();
diff --git a/samples/aspnetcore/SwaggerSample/SwaggerSample.csproj b/samples/aspnetcore/SwaggerSample/SwaggerSample.csproj
@@ -8,7 +8,7 @@
 
  <ItemGroup>
   <PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.1.0" />
-  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.0.2-*" />
+  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.4-*" />
  </ItemGroup>
 
  <ItemGroup>
diff --git a/src/Common.OData.ApiExplorer/AspNet.OData/DefaultModelTypeBuilder.cs b/src/Common.OData.ApiExplorer/AspNet.OData/DefaultModelTypeBuilder.cs
@@ -27,11 +27,9 @@
     public sealed class DefaultModelTypeBuilder : IModelTypeBuilder
     {
         static readonly Type IEnumerableOfT = typeof( IEnumerable<> );
-        readonly ConcurrentDictionary<ApiVersion, ModuleBuilder> modules = new ConcurrentDictionary<ApiVersion, ModuleBuilder>();
-        readonly ConcurrentDictionary<ApiVersion, IDictionary<EdmTypeKey, Type>> generatedEdmTypesPerVersion =
-            new ConcurrentDictionary<ApiVersion, IDictionary<EdmTypeKey, Type>>();
-        readonly ConcurrentDictionary<ApiVersion, ConcurrentDictionary<EdmTypeKey, Type>> generatedActionParamsPerVersion =
-            new ConcurrentDictionary<ApiVersion, ConcurrentDictionary<EdmTypeKey, Type>>();
+        readonly ConcurrentDictionary<ApiVersion, ModuleBuilder> modules = new();
+        readonly ConcurrentDictionary<ApiVersion, IDictionary<EdmTypeKey, Type>> generatedEdmTypesPerVersion = new();
+        readonly ConcurrentDictionary<ApiVersion, ConcurrentDictionary<EdmTypeKey, Type>> generatedActionParamsPerVersion = new();
 
         /// <inheritdoc />
         public Type NewStructuredType( IEdmStructuredType structuredType, Type clrType, ApiVersion apiVersion, IEdmModel edmModel )
@@ -152,9 +150,12 @@ static Tuple<bool, bool> BuildSignatureProperties(
             var visitedEdmTypes = context.VisitedEdmTypes;
             var clrTypeMatchesEdmType = true;
             var hasUnfinishedTypes = false;
+            var clrProperties = clrType.GetProperties( Public | Instance );
 
-            foreach ( var property in clrType.GetProperties( Public | Instance ) )
+            for ( var i = 0; i < clrProperties.Length; i++ )
             {
+                var property = clrProperties[i];
+
                 if ( !structuralProperties.TryGetValue( property.Name, out var structuralProperty ) &&
                      !mappedClrProperties.TryGetValue( property, out structuralProperty ) )
                 {
diff --git a/src/Common.OData.ApiExplorer/CollectionExtensions.cs b/src/Common.OData.ApiExplorer/CollectionExtensions.cs
@@ -10,9 +10,29 @@ static class CollectionExtensions
     {
         internal static void AddRange<T>( this ICollection<T> collection, IEnumerable<T> items )
         {
-            foreach ( var item in items )
+            switch ( items )
             {
-                collection.Add( item );
+                case IList<T> list:
+                    for ( var i = 0; i < list.Count; i++ )
+                    {
+                        collection.Add( list[i] );
+                    }
+
+                    break;
+                case IReadOnlyList<T> list:
+                    for ( var i = 0; i < list.Count; i++ )
+                    {
+                        collection.Add( list[i] );
+                    }
+
+                    break;
+                default:
+                    foreach ( var item in items )
+                    {
+                        collection.Add( item );
+                    }
+
+                    break;
             }
         }
     }
diff --git a/src/Common.OData.ApiExplorer/OData.Edm/EdmExtensions.cs b/src/Common.OData.ApiExplorer/OData.Edm/EdmExtensions.cs
@@ -21,7 +21,7 @@ static class EdmExtensions
     {
         internal static Type? GetClrType( this IEdmType edmType, IEdmModel edmModel )
         {
-            if ( !( edmType is IEdmSchemaType schemaType ) )
+            if ( edmType is not IEdmSchemaType schemaType )
             {
                 return null;
             }
diff --git a/src/Common.OData/TypeExtensions.cs b/src/Common.OData/TypeExtensions.cs
@@ -38,5 +38,17 @@ internal static bool IsModelBound( this Type type ) =>
            Delta.IsAssignableFrom( type ) ||
            ODataActionParameters.IsAssignableFrom( type ) ||
            ODataParameterHelper.Equals( type );
+
+#if !WEBAPI
+        static readonly Type ODataModelBinder = ResolveType( "Microsoft.AspNet.OData.Formatter.ODataModelBinder" );
+
+        internal static bool IsODataModelBinder( this Type type ) => ODataModelBinder.IsAssignableFrom( type );
+
+        static Type ResolveType( string name )
+        {
+            var assembly = ODataRoutingAttributeType.Assembly;
+            return assembly.GetType( name, throwOnError: true )!;
+        }
+#endif
     }
 }
diff --git a/src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNetCore.Mvc/ApiExplorer/ODataApiDescriptionProvider.cs b/src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNetCore.Mvc/ApiExplorer/ODataApiDescriptionProvider.cs
@@ -23,11 +23,11 @@
     using System.Linq;
     using System.Threading.Tasks;
     using static Microsoft.AspNet.OData.Routing.ODataRouteActionType;
+    using static Microsoft.AspNet.OData.Routing.ODataRouteConstants;
     using static Microsoft.AspNetCore.Http.StatusCodes;
     using static Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource;
     using static System.Linq.Enumerable;
     using static System.StringComparison;
-    using static Microsoft.AspNet.OData.Routing.ODataRouteConstants;
 
     /// <summary>
     /// Represents an API explorer that provides <see cref="ApiDescription">API descriptions</see> for actions represented by
@@ -570,6 +570,10 @@ static void UpdateBindingInfo( ApiParameterContext context, ParameterDescriptor
                 {
                     bindingInfo.BindingSource = Special;
                 }
+                else if ( bindingInfo.BinderType.IsODataModelBinder() )
+                {
+                    bindingInfo.BindingSource = default;
+                }
             }
 
             if ( bindingInfo.BindingSource != null )
@@ -584,7 +588,7 @@ static void UpdateBindingInfo( ApiParameterContext context, ParameterDescriptor
             switch ( context.RouteContext.ActionType )
             {
                 case EntitySet:
-                    var keys = context.RouteContext.EntitySet.EntityType().Key().ToArray();
+                    var keys = context.RouteContext.EntitySet.EntityType().Key();
 
                     key = keys.FirstOrDefault( k => k.Name.Equals( paramName, OrdinalIgnoreCase ) );
 
diff --git a/src/Microsoft.AspNetCore.OData.Versioning/AspNet.OData/Routing/ODataRouteBindingInfoConvention.cs b/src/Microsoft.AspNetCore.OData.Versioning/AspNet.OData/Routing/ODataRouteBindingInfoConvention.cs
@@ -192,6 +192,10 @@ void UpdateBindingInfo( ActionParameterContext context, ParameterDescriptor para
                 {
                     bindingInfo.BindingSource = Special;
                 }
+                else if ( bindingInfo.BinderType.IsODataModelBinder() )
+                {
+                    bindingInfo.BindingSource = default;
+                }
             }
 
             if ( bindingInfo.BindingSource != null )
@@ -206,8 +210,7 @@ void UpdateBindingInfo( ActionParameterContext context, ParameterDescriptor para
             switch ( context.RouteContext.ActionType )
             {
                 case EntitySet:
-
-                    var keys = context.RouteContext.EntitySet.EntityType().Key().ToArray();
+                    var keys = context.RouteContext.EntitySet.EntityType().Key();
 
                     key = keys.FirstOrDefault( k => k.Name.Equals( paramName, OrdinalIgnoreCase ) );
 
@@ -229,7 +232,6 @@ void UpdateBindingInfo( ActionParameterContext context, ParameterDescriptor para
                     break;
                 case BoundOperation:
                 case UnboundOperation:
-
                     var operation = context.RouteContext.Operation;
 
                     if ( operation == null )
