Add support for the substitution of ODataActionParameter parameters.

LuukN2 · commonsensesoftware · commit 35234f183912 · 2018-11-01T13:28:28.000-07:00
diff --git a/src/Common.OData.ApiExplorer/AspNet.OData/ClassProperty.cs b/src/Common.OData.ApiExplorer/AspNet.OData/ClassProperty.cs
@@ -24,22 +24,27 @@ internal ClassProperty( PropertyInfo clrProperty, Type propertyType )
             Attributes = AttributesFromProperty( clrProperty );
         }
 
-        internal ClassProperty( IEnumerable<Assembly> assemblies, IEdmOperationParameter parameter )
+        internal ClassProperty( IServiceProvider services, IEnumerable<Assembly> assemblies, IEdmOperationParameter parameter, IModelTypeBuilder typeBuilder )
         {
             Contract.Requires( assemblies != null );
             Contract.Requires( parameter != null );
 
             Name = parameter.Name;
+            var context = new TypeSubstitutionContext( services, assemblies, typeBuilder );
 
             if ( parameter.Type.IsCollection() )
             {
                 var collectionType = parameter.Type.AsCollection();
                 var elementType = collectionType.ElementType().Definition.GetClrType( assemblies );
-                type = typeof( IEnumerable<> ).MakeGenericType( elementType );
+                var substitutedType = elementType.SubstituteIfNecessary( context );
+
+                type = typeof( IEnumerable<> ).MakeGenericType( substitutedType );
             }
             else
             {
-                type = parameter.Type.Definition.GetClrType( assemblies );
+                var parameterType = parameter.Type.Definition.GetClrType( assemblies );
+
+                type = parameterType.SubstituteIfNecessary( context );
             }
 
             Attributes = AttributesFromOperationParameter( parameter );
diff --git a/src/Common.OData.ApiExplorer/AspNet.OData/DefaultModelTypeBuilder.cs b/src/Common.OData.ApiExplorer/AspNet.OData/DefaultModelTypeBuilder.cs
@@ -171,14 +171,14 @@ public Type NewStructuredType( IEdmStructuredType structuredType, Type clrType,
         }
 
         /// <inheritdoc />
-        public Type NewActionParameters( IEdmAction action, ApiVersion apiVersion )
+        public Type NewActionParameters( IServiceProvider services, IEdmAction action, ApiVersion apiVersion )
         {
             Arg.NotNull( action, nameof( action ) );
             Arg.NotNull( apiVersion, nameof( apiVersion ) );
             Contract.Ensures( Contract.Result<Type>() != null );
 
             var name = action.FullName() + "Parameters";
-            var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( assemblies, p ) );
+            var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( services, assemblies, p, this ) );
             var signature = new ClassSignature( name, properties, apiVersion );
 
             return CreateTypeInfoFromSignature( signature );
diff --git a/src/Common.OData.ApiExplorer/AspNet.OData/IModelTypeBuilder.cs b/src/Common.OData.ApiExplorer/AspNet.OData/IModelTypeBuilder.cs
@@ -29,14 +29,15 @@ public interface IModelTypeBuilder
         Type NewStructuredType( IEdmStructuredType structuredType, Type clrType, ApiVersion apiVersion );
 
         /// <summary>
-        /// Creates an returns a stronly-typed definition for OData action parameters.
+        /// Creates an returns a strongly-typed definition for OData action parameters.
         /// </summary>
+        /// <param name="services">The <see cref="IServiceProvider">services</see> needed to potentially substitute types.</param>
         /// <param name="action">The defining <see cref="IEdmAction">action</see>.</param>
         /// <param name="apiVersion">The <see cref="ApiVersion">API version</see> of the <paramref name="action"/> to create the parameter type for.</param>
         /// <returns>A strong <see cref="Type">type</see> definition for the OData <paramref name="action"/> parameters.</returns>
         /// <remarks><see cref="ODataActionParameters">OData action parameters</see> are modeled as a <see cref="Dictionary{TKey,TValue}">dictionary</see>,
         /// which is difficult to use effectively by documentation tools such as the API Explorer. The corresponding type is generated only once per
         /// <paramref name="apiVersion">API version</paramref>.</remarks>
-        Type NewActionParameters( IEdmAction action, ApiVersion apiVersion );
+        Type NewActionParameters( IServiceProvider services, IEdmAction action, ApiVersion apiVersion );
     }
 }
diff --git a/src/Microsoft.AspNet.OData.Versioning.ApiExplorer/AspNet.OData/Routing/ODataRouteBuilderContext.cs b/src/Microsoft.AspNet.OData.Versioning.ApiExplorer/AspNet.OData/Routing/ODataRouteBuilderContext.cs
@@ -79,7 +79,7 @@ void ConvertODataActionParametersToTypedModel( IModelTypeBuilder modelTypeBuilde
 
                 if ( parameter.ParameterType.IsODataActionParameters() )
                 {
-                    description.ParameterDescriptor = new ODataModelBoundParameterDescriptor( parameter, modelTypeBuilder.NewActionParameters( action, apiVersion.Value ) );
+                    description.ParameterDescriptor = new ODataModelBoundParameterDescriptor( parameter, modelTypeBuilder.NewActionParameters( serviceProvider, action, apiVersion.Value ) );
                     break;
                 }
             }
diff --git a/src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNetCore.Mvc.ApiExplorer/PseudoModelBindingVisitor.cs b/src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNetCore.Mvc.ApiExplorer/PseudoModelBindingVisitor.cs
@@ -88,7 +88,7 @@ ApiParameterDescription CreateResult( ApiParameterDescriptionContext bindingCont
             {
                 var action = (IEdmAction) Context.RouteContext.Operation;
                 var apiVersion = Context.RouteContext.ApiVersion;
-                type = Context.TypeBuilder.NewActionParameters( action, apiVersion );
+                type = Context.TypeBuilder.NewActionParameters( Context.Services, action, apiVersion );
             }
             else
             {
diff --git a/test/Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests/AspNet.OData/DefaultModelTypeBuilderTest.cs b/test/Microsoft.AspNet.OData.Versioning.ApiExplorer.Tests/AspNet.OData/DefaultModelTypeBuilderTest.cs
@@ -8,6 +8,7 @@
     using System.Collections.Generic;
     using System.Linq;
     using System.Reflection;
+    using Microsoft.Extensions.DependencyInjection;
     using Xunit;
 
     public class DefaultModelTypeBuilderTest
@@ -231,9 +232,11 @@ public void substitute_should_generate_type_for_action_parameters()
             var model = context.Model;
             var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
             var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
 
             // act
-            var substitutionType = context.ModelTypeBuilder.NewActionParameters( operation, ApiVersion.Default );
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
 
             // assert
             substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );
@@ -242,6 +245,43 @@ public void substitute_should_generate_type_for_action_parameters()
             substitutionType.Should().HaveProperty<bool>( "callbackRequired" );
         }
 
+        [Fact]
+        public void substitute_should_generate_type_for_action_parameters_with_substituted_types()
+        {
+            // arrange
+            var modelBuilder = new ODataConventionModelBuilder();
+            var contact = modelBuilder.EntitySet<Contact>( "Contacts" ).EntityType;
+            contact.Ignore( c => c.Email  );
+            var action = contact.Action( "PlanInterview" );
+
+            action.Parameter<DateTime>( "when" );
+            action.Parameter<Contact>( "interviewer" );
+            action.Parameter<Contact>( "interviewee" );
+
+            var context = NewContext( modelBuilder.GetEdmModel() );
+            var model = context.Model;
+            var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
+            var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
+
+            // act
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
+
+            // assert
+            substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );
+            substitutionType.Should().HaveProperty<DateTimeOffset>( "when" );
+            var contactType = substitutionType.GetRuntimeProperty( "interviewer" ).PropertyType;
+            contactType.Should().Be( substitutionType.GetRuntimeProperty( "interviewee" ).PropertyType );
+
+            contactType.GetRuntimeProperties().Should().HaveCount( 5 );
+            contactType.Should().HaveProperty<int>( "ContactId" );
+            contactType.Should().HaveProperty<string>( "FirstName" );
+            contactType.Should().HaveProperty<string>( "LastName" );
+            contactType.Should().HaveProperty<string>( "Phone" );
+            contactType.Should().HaveProperty<List<Address>>( "Addresses" );
+        }
+
         [Fact]
         public void substitute_should_generate_type_for_action_parameters_with_collection_parameters()
         {
@@ -258,9 +298,11 @@ public void substitute_should_generate_type_for_action_parameters_with_collectio
             var model = context.Model;
             var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
             var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
 
             // act
-            var substitutionType = context.ModelTypeBuilder.NewActionParameters( operation, ApiVersion.Default );
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
 
             // assert
             substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );
diff --git a/test/Microsoft.AspNetCore.OData.Versioning.ApiExplorer.Tests/AspNet.OData/DefaultModelTypeBuilderTest.cs b/test/Microsoft.AspNetCore.OData.Versioning.ApiExplorer.Tests/AspNet.OData/DefaultModelTypeBuilderTest.cs
@@ -8,6 +8,7 @@
     using System.Collections.Generic;
     using System.Linq;
     using System.Reflection;
+    using Microsoft.Extensions.DependencyInjection;
     using Xunit;
 
     public class DefaultModelTypeBuilderTest
@@ -231,9 +232,11 @@ public void substitute_should_generate_type_for_action_parameters()
             var model = context.Model;
             var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
             var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
 
             // act
-            var substitutionType = context.ModelTypeBuilder.NewActionParameters( operation, ApiVersion.Default );
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
 
             // assert
             substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );
@@ -242,6 +245,43 @@ public void substitute_should_generate_type_for_action_parameters()
             substitutionType.Should().HaveProperty<bool>( "callbackRequired" );
         }
 
+        [Fact]
+        public void substitute_should_generate_type_for_action_parameters_with_substituted_types()
+        {
+            // arrange
+            var modelBuilder = new ODataConventionModelBuilder();
+            var contact = modelBuilder.EntitySet<Contact>( "Contacts" ).EntityType;
+            contact.Ignore( c => c.Email  );
+            var action = contact.Action( "PlanInterview" );
+
+            action.Parameter<DateTime>( "when" );
+            action.Parameter<Contact>( "interviewer" );
+            action.Parameter<Contact>( "interviewee" );
+
+            var context = NewContext( modelBuilder.GetEdmModel() );
+            var model = context.Model;
+            var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
+            var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
+
+            // act
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
+
+            // assert
+            substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );
+            substitutionType.Should().HaveProperty<DateTimeOffset>( "when" );
+            var contactType = substitutionType.GetRuntimeProperty( "interviewer" ).PropertyType;
+            contactType.Should().Be( substitutionType.GetRuntimeProperty( "interviewee" ).PropertyType );
+
+            contactType.GetRuntimeProperties().Should().HaveCount( 5 );
+            contactType.Should().HaveProperty<int>( "ContactId" );
+            contactType.Should().HaveProperty<string>( "FirstName" );
+            contactType.Should().HaveProperty<string>( "LastName" );
+            contactType.Should().HaveProperty<string>( "Phone" );
+            contactType.Should().HaveProperty<List<Address>>( "Addresses" );
+        }
+
         [Fact]
         public void substitute_should_generate_type_for_action_parameters_with_collection_parameters()
         {
@@ -258,9 +298,11 @@ public void substitute_should_generate_type_for_action_parameters_with_collectio
             var model = context.Model;
             var qualifiedName = $"{model.EntityContainer.Namespace}.{action.Name}";
             var operation = (IEdmAction) model.FindDeclaredOperations( qualifiedName ).Single();
+            var services = new ServiceCollection();
+            services.AddSingleton( model );
 
             // act
-            var substitutionType = context.ModelTypeBuilder.NewActionParameters( operation, ApiVersion.Default );
+            var substitutionType = context.ModelTypeBuilder.NewActionParameters( services.BuildServiceProvider(), operation, ApiVersion.Default );
 
             // assert
             substitutionType.GetRuntimeProperties().Should().HaveCount( 3 );

Original file line number	Diff line number	Diff line change
`@@ -24,22 +24,27 @@ internal ClassProperty( PropertyInfo clrProperty, Type propertyType )`
`24`	`24`	`Attributes = AttributesFromProperty( clrProperty );`
`25`	`25`	`}`
`26`	`26`
`27`		`- internal ClassProperty( IEnumerable<Assembly> assemblies, IEdmOperationParameter parameter )`
	`27`	`+ internal ClassProperty( IServiceProvider services, IEnumerable<Assembly> assemblies, IEdmOperationParameter parameter, IModelTypeBuilder typeBuilder )`
`28`	`28`	`{`
`29`	`29`	`Contract.Requires( assemblies != null );`
`30`	`30`	`Contract.Requires( parameter != null );`
`31`	`31`
`32`	`32`	`Name = parameter.Name;`
	`33`	`+ var context = new TypeSubstitutionContext( services, assemblies, typeBuilder );`
`33`	`34`
`34`	`35`	`if ( parameter.Type.IsCollection() )`
`35`	`36`	`{`
`36`	`37`	`var collectionType = parameter.Type.AsCollection();`
`37`	`38`	`var elementType = collectionType.ElementType().Definition.GetClrType( assemblies );`
`38`		`- type = typeof( IEnumerable<> ).MakeGenericType( elementType );`
	`39`	`+ var substitutedType = elementType.SubstituteIfNecessary( context );`
	`40`	`+`
	`41`	`+ type = typeof( IEnumerable<> ).MakeGenericType( substitutedType );`
`39`	`42`	`}`
`40`	`43`	`else`
`41`	`44`	`{`
`42`		`- type = parameter.Type.Definition.GetClrType( assemblies );`
	`45`	`+ var parameterType = parameter.Type.Definition.GetClrType( assemblies );`
	`46`	`+`
	`47`	`+ type = parameterType.SubstituteIfNecessary( context );`
`43`	`48`	`}`
`44`	`49`
`45`	`50`	`Attributes = AttributesFromOperationParameter( parameter );`
Original file line number	Diff line number	Diff line change
`@@ -171,14 +171,14 @@ public Type NewStructuredType( IEdmStructuredType structuredType, Type clrType,`
`171`	`171`	`}`
`172`	`172`
`173`	`173`	`/// <inheritdoc />`
`174`		`- public Type NewActionParameters( IEdmAction action, ApiVersion apiVersion )`
	`174`	`+ public Type NewActionParameters( IServiceProvider services, IEdmAction action, ApiVersion apiVersion )`
`175`	`175`	`{`
`176`	`176`	`Arg.NotNull( action, nameof( action ) );`
`177`	`177`	`Arg.NotNull( apiVersion, nameof( apiVersion ) );`
`178`	`178`	`Contract.Ensures( Contract.Result<Type>() != null );`
`179`	`179`
`180`	`180`	`var name = action.FullName() + "Parameters";`
`181`		`- var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( assemblies, p ) );`
	`181`	`+ var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( services, assemblies, p, this ) );`
`182`	`182`	`var signature = new ClassSignature( name, properties, apiVersion );`
`183`	`183`
`184`	`184`	`return CreateTypeInfoFromSignature( signature );`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ void ConvertODataActionParametersToTypedModel( IModelTypeBuilder modelTypeBuilde`
`79`	`79`
`80`	`80`	`if ( parameter.ParameterType.IsODataActionParameters() )`
`81`	`81`	`{`
`82`		`- description.ParameterDescriptor = new ODataModelBoundParameterDescriptor( parameter, modelTypeBuilder.NewActionParameters( action, apiVersion.Value ) );`
	`82`	`+ description.ParameterDescriptor = new ODataModelBoundParameterDescriptor( parameter, modelTypeBuilder.NewActionParameters( serviceProvider, action, apiVersion.Value ) );`
`83`	`83`	`break;`
`84`	`84`	`}`
`85`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ ApiParameterDescription CreateResult( ApiParameterDescriptionContext bindingCont`
`88`	`88`	`{`
`89`	`89`	`var action = (IEdmAction) Context.RouteContext.Operation;`
`90`	`90`	`var apiVersion = Context.RouteContext.ApiVersion;`
`91`		`- type = Context.TypeBuilder.NewActionParameters( action, apiVersion );`
	`91`	`+ type = Context.TypeBuilder.NewActionParameters( Context.Services, action, apiVersion );`
`92`	`92`	`}`
`93`	`93`	`else`
`94`	`94`	`{`