Complete OData refactor with support for Endpoint Routing. Resolves #608, #616, #647

Author: Chris Martinez

src/Common.OData.ApiExplorer/AspNet.OData/DefaultModelTypeBuilder.cs

@@ -28,7 +28,10 @@ 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, IDictionary<EdmTypeKey, Type>> generatedEdmTypesPerVersion =
+            new ConcurrentDictionary<ApiVersion, IDictionary<EdmTypeKey, Type>>();
+        readonly ConcurrentDictionary<ApiVersion, ConcurrentDictionary<EdmTypeKey, Type>> generatedActionParamsPerVersion =
+            new ConcurrentDictionary<ApiVersion, ConcurrentDictionary<EdmTypeKey, Type>>();
 
         /// <inheritdoc />
         public Type NewStructuredType( IEdmStructuredType structuredType, Type clrType, ApiVersion apiVersion, IEdmModel edmModel )
@@ -47,12 +50,19 @@ public Type NewActionParameters( IServiceProvider services, IEdmAction action, A
                 throw new ArgumentNullException( nameof( action ) );
             }
 
-            var name = controllerName + "." + action.FullName() + "Parameters";
-            var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( services, p, this ) );
-            var signature = new ClassSignature( name, properties, apiVersion );
-            var moduleBuilder = modules.GetOrAdd( apiVersion, CreateModuleForApiVersion );
+            var paramTypes = generatedActionParamsPerVersion.GetOrAdd( apiVersion, _ => new ConcurrentDictionary<EdmTypeKey, Type>() );
+            var fullTypeName = $"{controllerName}.{action.Namespace}.{controllerName}{action.Name}Parameters";
+            var key = new EdmTypeKey( fullTypeName, apiVersion );
+            var type = paramTypes.GetOrAdd( key, _ =>
+            {
+                var properties = action.Parameters.Where( p => p.Name != "bindingParameter" ).Select( p => new ClassProperty( services, p, this ) );
+                var signature = new ClassSignature( fullTypeName, properties, apiVersion );
+                var moduleBuilder = modules.GetOrAdd( apiVersion, CreateModuleForApiVersion );
+
+                return CreateTypeInfoFromSignature( moduleBuilder, signature );
+            } );
 
-            return CreateTypeInfoFromSignature( moduleBuilder, signature );
+            return type;
         }
 
         IDictionary<EdmTypeKey, Type> GenerateTypesForEdmModel( IEdmModel model, ApiVersion apiVersion )

src/Common.OData.ApiExplorer/AspNet.OData/EdmTypeKey.cs

@@ -19,6 +19,9 @@ internal EdmTypeKey( IEdmStructuredType type, ApiVersion apiVersion ) =>
         internal EdmTypeKey( IEdmTypeReference type, ApiVersion apiVersion ) =>
             hashCode = ComputeHash( type.FullName(), apiVersion );
 
+        internal EdmTypeKey( string fullTypeName, ApiVersion apiVersion ) =>
+            hashCode = ComputeHash( fullTypeName, apiVersion );
+
         public static bool operator ==( EdmTypeKey obj, EdmTypeKey other ) => obj.Equals( other );
 
         public static bool operator !=( EdmTypeKey obj, EdmTypeKey other ) => !obj.Equals( other );

src/Common.OData.ApiExplorer/AspNet.OData/Routing/ODataRouteBuilder.cs

@@ -73,7 +73,7 @@ void BuildPath( StringBuilder builder )
 
         void AppendRoutePrefix( IList<string> segments )
         {
-            var prefix = Context.Route.RoutePrefix?.Trim( '/' );
+            var prefix = Context.RoutePrefix;
 
             if ( IsNullOrEmpty( prefix ) )
             {

src/Common.OData.ApiExplorer/AspNet.OData/Routing/ODataRouteBuilderContext.cs

@@ -17,14 +17,17 @@
 #endif
     using System;
     using System.Collections.Generic;
+    using System.Linq;
     using System.Reflection;
+    using System.Text.RegularExpressions;
 #if WEBAPI
     using System.Web.Http.Description;
     using System.Web.Http.Dispatcher;
     using ControllerActionDescriptor = System.Web.Http.Controllers.HttpActionDescriptor;
 #endif
     using static Microsoft.OData.ODataUrlKeyDelimiter;
     using static ODataRouteTemplateGenerationKind;
+    using static System.StringComparison;
 
     sealed partial class ODataRouteBuilderContext
     {
@@ -52,7 +55,7 @@ sealed partial class ODataRouteBuilderContext
 
         internal string? RouteTemplate { get; }
 
-        internal ODataRoute Route { get; }
+        internal string? RoutePrefix { get; }
 
         internal ControllerActionDescriptor ActionDescriptor { get; }
 
@@ -74,7 +77,11 @@ sealed partial class ODataRouteBuilderContext
 
         internal bool AllowUnqualifiedEnum => Services.GetRequiredService<ODataUriResolver>() is StringAsEnumResolver;
 
-        internal static ODataRouteActionType GetActionType( IEdmEntitySet entitySet, IEdmOperation operation )
+        internal
+#if !WEBAPI
+        static
+#endif
+        ODataRouteActionType GetActionType( IEdmEntitySet? entitySet, IEdmOperation? operation, ControllerActionDescriptor action )
         {
             if ( entitySet == null )
             {
@@ -91,7 +98,14 @@ internal static ODataRouteActionType GetActionType( IEdmEntitySet entitySet, IEd
             {
                 if ( operation == null )
                 {
-                    return ODataRouteActionType.EntitySet;
+                    if ( IsActionOrFunction( entitySet, action.ActionName, GetHttpMethods( action ) ) )
+                    {
+                        return ODataRouteActionType.Unknown;
+                    }
+                    else
+                    {
+                        return ODataRouteActionType.EntitySet;
+                    }
                 }
                 else if ( operation.IsBound )
                 {
@@ -105,5 +119,113 @@ internal static ODataRouteActionType GetActionType( IEdmEntitySet entitySet, IEd
         // Slash became the default 4/18/2018
         // REF: https://github.com/OData/WebApi/pull/1393
         static ODataUrlKeyDelimiter UrlKeyDelimiterOrDefault( ODataUrlKeyDelimiter? urlKeyDelimiter ) => urlKeyDelimiter ?? Slash;
+
+        // REF: https://github.com/OData/WebApi/blob/master/src/Microsoft.AspNet.OData.Shared/Routing/Conventions/ActionRoutingConvention.cs
+        // REF: https://github.com/OData/WebApi/blob/master/src/Microsoft.AspNet.OData.Shared/Routing/Conventions/FunctionRoutingConvention.cs
+        // REF: https://github.com/OData/WebApi/blob/master/src/Microsoft.AspNet.OData.Shared/Routing/Conventions/EntitySetRoutingConvention.cs
+        // REF: https://github.com/OData/WebApi/blob/master/src/Microsoft.AspNet.OData.Shared/Routing/Conventions/EntityRoutingConvention.cs
+        static bool IsActionOrFunction( IEdmEntitySet? entitySet, string actionName, IEnumerable<string> methods )
+        {
+            using var iterator = methods.GetEnumerator();
+
+            if ( !iterator.MoveNext() )
+            {
+                return false;
+            }
+
+            var method = iterator.Current;
+
+            if ( iterator.MoveNext() )
+            {
+                return false;
+            }
+
+            const string ActionMethod = "Post";
+            const string FunctionMethod = "Get";
+
+            if ( ActionMethod.Equals( method, OrdinalIgnoreCase ) && actionName != ActionMethod )
+            {
+                if ( entitySet == null )
+                {
+                    return true;
+                }
+
+                return actionName != ( ActionMethod + entitySet.Name ) &&
+                       actionName != ( ActionMethod + entitySet.EntityType().Name ) &&
+                      !actionName.StartsWith( "CreateRef", Ordinal );
+            }
+            else if ( FunctionMethod.Equals( method, OrdinalIgnoreCase ) && actionName != FunctionMethod )
+            {
+                if ( entitySet == null )
+                {
+                    // TODO: could be a singleton here
+                    return true;
+                }
+
+                if ( actionName == ( ActionMethod + entitySet.Name ) ||
+                     actionName.StartsWith( "GetRef", Ordinal ) )
+                {
+                    return false;
+                }
+
+                var entity = entitySet.EntityType();
+
+                if ( actionName == ( ActionMethod + entity.Name ) )
+                {
+                    return false;
+                }
+
+                foreach ( var property in entity.NavigationProperties() )
+                {
+                    if ( actionName.StartsWith( FunctionMethod + property.Name, OrdinalIgnoreCase ) )
+                    {
+                        return false;
+                    }
+                }
+
+                return true;
+            }
+
+            return false;
+        }
+
+        IEdmOperation? ResolveOperation( IEdmEntityContainer container, string name )
+        {
+            var import = container.FindOperationImports( name ).SingleOrDefault();
+
+            if ( import != null )
+            {
+                return import.Operation;
+            }
+
+            var qualifiedName = container.Namespace + "." + name;
+
+            if ( EntitySet != null )
+            {
+                var operation = EdmModel.FindBoundOperations( qualifiedName, EntitySet.EntityType() ).SingleOrDefault();
+
+                if ( operation != null )
+                {
+                    return operation;
+                }
+            }
+
+            return EdmModel.FindDeclaredOperations( qualifiedName ).SingleOrDefault();
+        }
+
+        sealed class FixedEdmModelServiceProviderDecorator : IServiceProvider
+        {
+            readonly IServiceProvider decorated;
+            readonly IEdmModel edmModel;
+
+            internal FixedEdmModelServiceProviderDecorator( IServiceProvider decorated, IEdmModel edmModel )
+            {
+                this.decorated = decorated;
+                this.edmModel = edmModel;
+            }
+
+            public object GetService( Type serviceType ) =>
+                serviceType == typeof( IEdmModel ) ? edmModel : decorated.GetService( serviceType );
+        }
     }
 }

src/Common.OData/AspNet.OData/Builder/DelegatingModelConfiguration.cs

@@ -9,10 +9,10 @@
 
     sealed class DelegatingModelConfiguration : IModelConfiguration
     {
-        readonly Action<ODataModelBuilder, ApiVersion> action;
+        readonly Action<ODataModelBuilder, ApiVersion, string?> action;
 
-        internal DelegatingModelConfiguration( Action<ODataModelBuilder, ApiVersion> action ) => this.action = action;
+        internal DelegatingModelConfiguration( Action<ODataModelBuilder, ApiVersion, string?> action ) => this.action = action;
 
-        public void Apply( ODataModelBuilder builder, ApiVersion apiVersion ) => action( builder, apiVersion );
+        public void Apply( ODataModelBuilder builder, ApiVersion apiVersion, string? routePrefix ) => action( builder, apiVersion, routePrefix );
     }
 }

src/Common.OData/AspNet.OData/Builder/IModelConfiguration.cs

@@ -20,6 +20,7 @@ public interface IModelConfiguration
         /// </summary>
         /// <param name="builder">The <see cref="ODataModelBuilder">builder</see> used to apply configurations.</param>
         /// <param name="apiVersion">The <see cref="ApiVersion">API version</see> associated with the <paramref name="builder"/>.</param>
-        void Apply( ODataModelBuilder builder, ApiVersion apiVersion );
+        /// <param name="routePrefix">The route prefix associated with the configuration, if any.</param>
+        void Apply( ODataModelBuilder builder, ApiVersion apiVersion, string? routePrefix );
     }
 }

src/Common.OData/AspNet.OData/Builder/VersionedODataModelBuilder.cs

@@ -3,6 +3,7 @@
 #if !WEBAPI
     using Microsoft.AspNetCore.Mvc;
     using Microsoft.AspNetCore.Mvc.Versioning;
+    using Microsoft.OData;
 #endif
     using Microsoft.OData.Edm;
 #if WEBAPI
@@ -11,6 +12,7 @@
 #endif
     using System;
     using System.Collections.Generic;
+    using System.Linq;
 
     /// <summary>
     /// Represents a versioned variant of the <see cref="ODataModelBuilder"/>.
@@ -27,9 +29,9 @@ public partial class VersionedODataModelBuilder
         /// <summary>
         /// Gets or sets the default model configuration.
         /// </summary>
-        /// <value>The <see cref="Action{T1, T2}">method</see> for the default model configuration.
+        /// <value>The <see cref="Action{T1, T2, T3}">method</see> for the default model configuration.
         /// The default value is <c>null</c>.</value>
-        public Action<ODataModelBuilder, ApiVersion>? DefaultModelConfiguration { get; set; }
+        public Action<ODataModelBuilder, ApiVersion, string?>? DefaultModelConfiguration { get; set; }
 
         /// <summary>
         /// Gets the list of model configurations associated with the builder.
@@ -48,13 +50,20 @@ public partial class VersionedODataModelBuilder
         /// Builds and returns the sequence of EDM models based on the define model configurations.
         /// </summary>
         /// <returns>A <see cref="IEnumerable{T}">sequence</see> of <see cref="IEdmModel">EDM models</see>.</returns>
-        public virtual IEnumerable<IEdmModel> GetEdmModels()
+        public IEnumerable<IEdmModel> GetEdmModels() => GetEdmModels( default );
+
+        /// <summary>
+        /// Builds and returns the sequence of EDM models based on the define model configurations.
+        /// </summary>
+        /// <param name="routePrefix">The route prefix associated with the configuration, if any.</param>
+        /// <returns>A <see cref="IEnumerable{T}">sequence</see> of <see cref="IEdmModel">EDM models</see>.</returns>
+        public virtual IEnumerable<IEdmModel> GetEdmModels( string? routePrefix )
         {
             var apiVersions = GetApiVersions();
             var configurations = GetMergedConfigurations();
             var models = new List<IEdmModel>();
 
-            BuildModelPerApiVersion( apiVersions, configurations, models );
+            BuildModelPerApiVersion( apiVersions, configurations, models, routePrefix );
 
             return models;
         }
@@ -76,7 +85,11 @@ IList<IModelConfiguration> GetMergedConfigurations()
             return configurations;
         }
 
-        void BuildModelPerApiVersion( IReadOnlyList<ApiVersion> apiVersions, IList<IModelConfiguration> configurations, ICollection<IEdmModel> models )
+        void BuildModelPerApiVersion(
+            IReadOnlyList<ApiVersion> apiVersions,
+            IList<IModelConfiguration> configurations,
+            ICollection<IEdmModel> models,
+            string? routePrefix )
         {
             for ( var i = 0; i < apiVersions.Count; i++ )
             {
@@ -85,10 +98,19 @@ void BuildModelPerApiVersion( IReadOnlyList<ApiVersion> apiVersions, IList<IMode
 
                 for ( var j = 0; j < configurations.Count; j++ )
                 {
-                    configurations[j].Apply( builder, apiVersion );
+                    configurations[j].Apply( builder, apiVersion, routePrefix );
                 }
 
                 var model = builder.GetEdmModel();
+                var container = model.EntityContainer;
+                var empty = !container.EntitySets().Any() &&
+                            !container.Singletons().Any() &&
+                            !container.OperationImports().Any();
+
+                if ( empty )
+                {
+                    continue;
+                }
 
                 model.SetAnnotationValue( model, new ApiVersionAnnotation( apiVersion ) );
                 OnModelCreated?.Invoke( builder, model );

src/Common.OData/AspNet.OData/Routing/ODataConventionConfigurationContext.cs

@@ -42,5 +42,20 @@ public partial class ODataConventionConfigurationContext
         [CLSCompliant( false )]
 #endif
         public IList<IODataRoutingConvention> RoutingConventions { get; }
+
+        /// <summary>
+        /// Gets the associate service provider.
+        /// </summary>
+        /// <value>The associated <see cref="IServiceProvider">service provider</see>.</value>
+        public IServiceProvider ServiceProvider { get; }
+
+        sealed class No : IServiceProvider
+        {
+            No() { }
+
+            internal static IServiceProvider ServiceProvider { get; } = new No();
+
+            public object GetService( Type serviceType ) => default!;
+        }
     }
 }

src/Common.OData/AspNet.OData/Routing/ODataPathTemplateHandlerExtensions.cs

@@ -0,0 +1,27 @@
+namespace Microsoft.AspNet.OData.Routing
+{
+    using Microsoft.AspNet.OData.Routing.Template;
+    using Microsoft.OData;
+    using System;
+
+    static class ODataPathTemplateHandlerExtensions
+    {
+        internal static ODataPathTemplate? SafeParseTemplate(
+            this IODataPathTemplateHandler handler,
+            string pathTemplate,
+            IServiceProvider serviceProvider )
+        {
+            try
+            {
+                return handler.ParseTemplate( pathTemplate, serviceProvider );
+            }
+            catch ( ODataException )
+            {
+                // this 'should' mean the controller does not map to the current edm model. there's no way to know this without
+                // forcing a developer to explicitly map it. while it could be a mistake, simply yield null. this results in the
+                // template being skipped and will ultimately result in a 4xx if requested, which is acceptable.
+                return default;
+            }
+        }
+    }
+}