How to handle multi-part keys as same as v7.x

[iwate]

Hi, guys!

I'm planning to update OData lib from v7.x to v8.x. So, I'm checking differences of the versions.
And I found there are differences at behavior of Routing.

This is my test code and the result.

[Theory]
[InlineData("/Data(2,'A')")]
[InlineData("/Data(2, 'A')")]
[InlineData("/Data(Key1=2, Key2='A')")]
[InlineData("/Data(Key1=2,Key2='A')")]
[InlineData("/Data(Key2='A',Key1=2)")]
public async Task GetWithMultipleKeys(string request)
{
    var response = await _client.GetAsync(request);
    
    Assert.Equal(HttpStatusCode.OK, response.StatusCode);
}

PS> dotnet test -v quiet
...
[xUnit.net 00:00:00.66]     ODataSample.Tests.V8.UnitTest1.GetWithMultipleKeys(request: "/Data(2, 'A')") [FAIL]
[xUnit.net 00:00:00.66]     ODataSample.Tests.V8.UnitTest1.GetWithMultipleKeys(request: "/Data(Key1=2, Key2='A')") [FAIL]
[xUnit.net 00:00:00.66]     ODataSample.Tests.V8.UnitTest1.GetWithMultipleKeys(request: "/Data(2,'A')") [FAIL]
[xUnit.net 00:00:00.77]     ODataSample.Tests.V8.UnitTest1.GetWithMultipleKeys(request: "/Data(Key2='A',Key1=2)") [FAIL]

Passed!  - Failed:     0, Passed:     5, Skipped:     0, Total:     5, Duration: 4 ms - ODataSample.Tests.V7.dll (net6.0)
Failed!  - Failed:     4, Passed:     1, Skipped:     0, Total:     5, Duration: 112 ms - ODataSample.Tests.V8.dll (net6.0)

v7.x succeeded all InlineData but x8.x failed except one which was specified at Route attribute.

Full code of the sample is here.
https://github.com/iwate/odatasample

I'm looking for a way to allow these request on v8.x.

Do you have any idea?

---

This is a simple idea. Making actions as need as it.

https://github.com/iwate/odatasample/blob/999575a9f6e2f4f665405b679d7bf6f9ec9208fe/ODataSample.V8/Controllers/SampleController.cs#L24-L42

[Route("/Data({Key1},{Key2})")]
public IActionResult GetOne1(long Key1, string Key2)
{
    ...
}

[Route("/Data(Key1={Key1},Key2={Key2})")]
public IActionResult GetOne2(long Key1, string Key2) => GetOne1(Key1, Key2);

[Route("/Data(Key2={Key2},Key1={Key1})")]
public IActionResult GetOne3(long Key1, string Key2) => GetOne1(Key1, Key2);

If you have another idea, could you share here?

[xuzhg]

Support "/data({key1},{key2})", you need some codes as below:

using Microsoft.AspNetCore.Mvc.ApplicationModels;
using Microsoft.AspNetCore.OData.Extensions;
using Microsoft.AspNetCore.OData.Routing;
using Microsoft.AspNetCore.OData.Routing.Template;
using Microsoft.OData.Edm;
using ODataSample.V8;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class ODataRouteAttribute : Attribute, IActionModelConvention
{
    public void Apply(ActionModel action)
    {
        // Lower order value gets higher priority.
        // So, Let's specify a lower order value for existing routings
        // And Move the more generic routing behind.
        // Without this setting.
        // The request like 'http://localhost:5296/Data(Key1=2,Key2='A')' will be handled by
        // routing as "/Data({key1},{key2}). And we will get exception.
        foreach (var selector in action.Selectors)
        {
            if (selector.EndpointMetadata.Any(c => c is IODataRoutingMetadata))
            {
                if (selector.AttributeRouteModel != null)
                {
                    selector.AttributeRouteModel.Order = -1;
                }
            }
        }

        IEdmEntitySet data = ModelProvider.Model.EntityContainer.FindEntitySet("Data");
        IEdmEntityType dataType = data.EntityType();
        IDictionary<string, string> keyMappings = new Dictionary<string, string>
        {
            { "Key1", "{Key1}" },
            { "Key2", "{Key2}" }
        };

        action.AddSelector("GET", string.Empty,
            ModelProvider.Model,
            new ODataPathTemplate(new EntitySetSegmentTemplate(data),
                new MyKeyTemplate(keyMappings, dataType, data)),
            null);
    }
}

public class MyKeyTemplate : KeySegmentTemplate
{
    public MyKeyTemplate(IDictionary<string, string> keys, IEdmEntityType entityType, IEdmNavigationSource navigationSource)
        : base(keys, entityType, navigationSource)
    {
    }

    public override IEnumerable<string> GetTemplates(ODataRouteOptions options)
    {
        yield return "({Key1},{Key2})";
        yield return "({Key1}, {Key2})";
        // add more
    }
}

Use the attribute on the controller:

Other new added lines are used to support other templates.

move the model builder into a static to re-use:

Here's the test

[iwate]

@xuzhg Thank you! Your sample is so excellent and help me much!