Regression with computed in $orderby with Microsoft.AspNetCore.OData versions >= 8.0.5: "Could not find a property named 'computedProp' on type" error

[andy-clymer]

Assemblies affected

This issue is similar to #1416

The issue occurs in Microsoft.AspNetCore.OData versions starting from 8.0.5 and up. The last known working version is 8.0.4.

Describe the bug

A regression occurs when using $orderby=COMPUTED_PROP_NAME in OData queries. The query that worked in Microsoft.AspNetCore.OData version 8.0.4 now fails in versions 8.0.5 and later.

Reproduce steps

1. Create a new ASP.NET Core Web API project with OData setup.
2. Add the Microsoft.AspNetCore.OData NuGet package version 8.0.4.
3. Add a computed parameter to your query string and reference it in the orderby parameter:

GET http://localhost:5050/odata/MyEntities?$compute=age add 10 as agePlusTen&$orderby=agePlusTen desc&$select=id, name, agePlusTen&$filter=agePlusTen ge 21

This query works successfully in version 8.0.4, but fails in all subsequent versions. In all version the computed field works in $select and $filter, but $orderby doesn't work after 8.0.4

[xuzhg]

@andy-clymer I created a sample to test (using the Microsoft.AspNetCore.OData versions >= 8.0.5)
, it' 8.3.0

Here's my test result:

1 No query

GET {{ComputeOrderByTest_HostAddress}}/odata/customers , the response is:

{
  "@odata.context": "http://localhost:5182/odata/$metadata#Customers",
  "value": [
    {
      "Id": 1,
      "Name": "Freezing",
      "Age": 34
    },
    {
      "Id": 2,
      "Name": "Bracing",
      "Age": 54
    },
    {
      "Id": 3,
      "Name": "Chilly",
      "Age": 10
    },
    {
      "Id": 4,
      "Name": "Cool",
      "Age": 8
    },
    {
      "Id": 5,
      "Name": "Mild",
      "Age": 19
    }
  ]
}

2 With $compute & $select query,

GET {{ComputeOrderByTest_HostAddress}}/odata/customers?$compute=age add 10 as agePlusTen&$select=id,name,agePlusTen

the response is:

{
  "@odata.context": "http://localhost:5182/odata/$metadata#Customers(Id,Name,agePlusTen)",
  "value": [
    {
      "Id": 1,
      "Name": "Freezing",
      "agePlusTen": 44
    },
    {
      "Id": 2,
      "Name": "Bracing",
      "agePlusTen": 64
    },
    {
      "Id": 3,
      "Name": "Chilly",
      "agePlusTen": 20
    },
    {
      "Id": 4,
      "Name": "Cool",
      "agePlusTen": 18
    },
    {
      "Id": 5,
      "Name": "Mild",
      "agePlusTen": 29
    }
  ]
}

3 With $orderby and $filter on computed property

GET {{ComputeOrderByTest_HostAddress}}/odata/customers?$compute=age add 10 as agePlusTen&$orderby=agePlusTen desc&$select=id,name,agePlusTen&$filter=agePlusTen ge 21

the response is:

{
  "@odata.context": "http://localhost:5182/odata/$metadata#Customers(Id,Name,agePlusTen)",
  "value": [
    {
      "Id": 2,
      "Name": "Bracing",
      "agePlusTen": 64
    },
    {
      "Id": 1,
      "Name": "Freezing",
      "agePlusTen": 44
    },
    {
      "Id": 5,
      "Name": "Mild",
      "agePlusTen": 29
    }
  ]
}

It seems it works fine. Would you please share us a repro to dig more?
Or you can find my sample at: https://github.com/xuzhg/WebApiSample/tree/main/v8.x/ComputeOrderByTest

[andy-clymer]

@xuzhg Sorry I didn't provide an example of what I was trying in my original post. I should've waited to report it until I had the time to include an example of what I was trying.

When I experience this issue, it's on an endpoint that is passed the ODataQueryOptions and then uses the AppyTo method. Additionally, it looks like the issue arises only if the ODataQuerySettings are passed into the method. I only tried the two permutations of the ApplyTo that are shown below in my code sample.

GET {{ComputeOrderByTest_HostAddress}}/UsingApplyTo?$compute=age add 10 as agePlusTen&$orderby=agePlusTen desc&$select=id,name,agePlusTen&$filter=agePlusTen ge 21

[HttpGet("UsingApplyTo")]
public IQueryable Get(ODataQueryOptions<Customer> queryOptions)
{
    var customers = Enumerable.Range(1, 5).Select(index => new Customer
    {
        Id = index,
        Name = WeatherForecastController.Summaries[index - 1],
        Age = Ages[index - 1]
    })
    .AsQueryable();

    // WORKS
    // return queryOptions.ApplyTo(customers);

    // FAILS
    return queryOptions.ApplyTo(customers, new ODataQuerySettings
    {
        PageSize = 3,
        TimeZone = TimeZoneInfo.Utc
    });
}

[xuzhg]

@andy-clymer I see.

Since you have a pagesize=3, it triggers the 'Stable Sorting' and therefore, a new OrderByQueryOptions is built to handle the 'Stable sorting'.

The new one does not contain the '$compute' query options, meanwhile, your entity is not an open type. So ODL cannot identify agePlusTen property and throws Microsoft.OData.ODataException: Could not find a property named 'agePlusTen' on type 'ComputeOrderByTest.Customer'.

This a bug and we should fix it ASAP.
Would you please let me know if you need this one into 8.x version? We can both release new 8.x and 9.x version since it's a regression.

[andy-clymer]

@xuzhg Thanks for investigating this so quickly. I don't need an 8.x version. I was simply reporting the last version that I saw it working in which was 8.0.4 to help narrow down where the issue first appeared. I'm currently using the latest release, so a fix in 9.x would be fine as far as I'm concerned.

[xuzhg]

@andy-clymer It should be fixed https://www.nuget.org/packages/Microsoft.AspNetCore.OData/9.3.2
And It's ported to main branch also.
Please let us know any other questions.