No MapODataServiceRoute() extension method with both ODataBatchHandler and HttpMessageHandler

[Andos25]

Currently I'm trying to add per-route delegating handler. but seems there is no proper method in src/Microsoft.AspNet.OData/Extensions/HttpConfigurationExtensions.cs which can support both ODataBatchHandler and HttpMessageHandler as parameters. It is a common case if we want use ODataBatchHandler + HttpMessageHandler

Assemblies affected

*Which assemblies and versions are known to be affected e.g. OData WebApi lib 5.9.0

Additional detail

In order to solve the issue, I have to create my own extension method as below

        public static void MapODataServiceRouteWithHandler(
            this HttpConfiguration httpConfiguration,
            string routeName,
            string routePrefix,
            IEdmModel model,
            List<IODataRoutingConvention> routingConventions,
            IODataPathHandler pathHandler,
            HttpMessageHandler defaultHandler,
            ODataBatchHandler batchHandler)
        {
            HttpRouteCollection routes = httpConfiguration.Routes;
            if (batchHandler != null)
            {
                batchHandler.ODataRouteName = routeName;
                string routeTemplate = string.IsNullOrEmpty(routePrefix) ? ODataRouteConstants.Batch : routePrefix + (object)'/' + ODataRouteConstants.Batch;
                routes.MapHttpBatchRoute(routeName + "Batch", routeTemplate, batchHandler);
            }
            routingConventions.AddRange(ODataRoutingConventions.CreateDefaultWithAttributeRouting(httpConfiguration, model));
            httpConfiguration.MapODataServiceRoute(
                routeName: routeName,
                routePrefix: routePrefix,
                model: model,
                pathHandler: pathHandler,
                routingConventions: routingConventions,
                defaultHandler: defaultHandler);
        }

[madansr7]

@Andos25 Thanks for your inputs. It seems that you have your own solution, and is it useful for every person? By the way, can you achieve it by calling couple "MapODataServiceRoute"?

Can you also let us know what version of OData WebApi library are you using?

[Andos25]

@madansr7 Thanks for you reply. The version of OData WebApi library I'm using is 5.9.0.
The code I shared above just an example, I need to change a little bit if we want to make it be useful to every person.

public static void MapODataServiceRouteWithHandler(
    this HttpConfiguration httpConfiguration,
    string routeName,
    string routePrefix,
    IEdmModel model,
    List<IODataRoutingConvention> routingConventions,
    IODataPathHandler pathHandler,
    HttpMessageHandler defaultHandler,
    ODataBatchHandler batchHandler)
{
    HttpRouteCollection routes = httpConfiguration.Routes;
    routePrefix = this.RemoveTrailingSlash(routePrefix);
    if (odataBatchHandler != null)
    {
        odataBatchHandler.ODataRouteName = routeName;
        string routeTemplate = string.IsNullOrEmpty(routePrefix) ? ODataRouteConstants.Batch : routePrefix + (object)'/' + ODataRouteConstants.Batch;
        routes.MapHttpBatchRoute(routeName + "Batch", routeTemplate, odataBatchHandler);
    }

    httpConfiguration.MapODataServiceRoute(
        routeName: routeName,
        routePrefix: routePrefix,
        model: model,
        pathHandler: new DefaultODataPathHandler(),
        routingConventions: routingConventions,
        defaultHandler: defaultHandler);
}

Per my investigation, there is no way to simply achieve it by calling different "MapODataServiceRoute", especially for adding ODataBatchDelegatingHandler part.

[KanishManuja-MS]

@Andos25 Thanks for the follow-up. Note that Aspnet 5.9 is pretty old code base and we are not actively fixing issues for that. However, we can consider this when we implement endpoint routing for aspnet core 3