Regression on default routing

[vbray1979]

Hi,

The default built in route "Products/NS.Book" targeting "GetFromBook" trigger a 404 Not Found.
Working fine in 4.1.1

Vincent

[commonsensesoftware]

I'm afraid your issue will require more information. This appears to be OData, but on which platform and version? There are no "default, built-in routes". Is that some OData example you are copying from or something else? A repro is always best, but the controller and application setup would be helpful.

[vbray1979]

Built in route conventions are coming from https://docs.microsoft.com/en-us/odata/webapi/built-in-routing-conventions
Version used:

• Microsoft.AspNetCore.OData: 7.5.7
• Microsoft.AspNetCore.OData.Versioning: 5.0.0
• Microsoft.AspNetCore.OData.Versioning.ApiExplorer: 5.0.0

While

• Microsoft.AspNetCore.OData.Versioning: 4.1.1
• Microsoft.AspNetCore.OData.Versioning.ApiExplorer: 4.1.1

allow accessing the controller below using https://localhost:44338/v1/ThirdPartyBases/AMI.ThirdPartyModel the version 5.0.0 trigger a 404 not found

[ODataRoute]
[Produces("application/json")]
[ProducesResponseType(typeof(ODataValue<IEnumerable<ThirdPartyModel>>), Status200OK)]
[ProducesResponseType(Status404NotFound)]
[EnableQuery(AllowedQueryOptions = All, MaxTop = 100)]
public IQueryable<ThirdPartyModel> GetFromThirdPartyModel()
{
     var thirdPartyModels = _Query.ThirdPartiesQueryProcessor.Get();
     return thirdPartyModels;
}

[commonsensesoftware]

Slightly insightful. So you intend to use the default OData conventions, but you are you using OData attributes (ex: [ODataRoute]). I strongly recommend you choose one or the other. While it might work, it's very confusing to mix routing methods. When things do (or don't) work, it's not obvious why.

This looks like the action maps to an OData function. It's hard to say without the controller definition, but this might be related to the naming of the controller. There was an optimization made that can cause this behavior. I would expect the controller to look something like:

[ApiVersion("1.0")]
[ODataRoutePrefix("ThirdPartyBases")]
public class ThirdPartyBasesController : ODataController
{
    [ODataRoute("ThirdPartyModel")]  // ← attribute routing supersedes convention-based routing
    [Produces("application/json")]
    [ProducesResponseType(typeof(ODataValue<IEnumerable<ThirdPartyModel>>), Status200OK)]
    [EnableQuery(AllowedQueryOptions = All, MaxTop = 100)]
    public IQueryable<ThirdPartyModel> GetFromThirdPartyModel() => _Query.ThirdPartiesQueryProcessor.Get();
}

OData now supports Endpoint Routing, which is generally the preferred approach, but you are not using that method. You can choose whichever method you prefer, but I recommend sticking to a single lane. The Endpoint Routing approach will allow interleaving partial sets of attributes, but they are the standard routing attributes (e.g. RouteAttribute, HttpGetAttribute, and so on).

Based on your example URL, I presume your setup looks like:

public void Configure( IApplicationBuilder app, VersionedODataModelBuilder modelBuilder )
{
    app.UseRouting();
    app.UseEndpoints(
        endpoints =>
        {
            endpoints.MapControllers();
            endpoints.MapVersionedODataRoute( "odata", "v{version:apiVersion}", modelBuilder );
        } );
}

The basic OData sample demonstrates how to use Endpoint Routing. I hope that helps you identify how your application is different from the expected setup.

[vbray1979]

This is indeed my setup, but I am targeting a cast and not a function (https://localhost:44338/v1/ThirdPartyBases/AMI.ThirdPartyModel)

• Base class: ThirdPartyBase
• Derived: ThirdPartyModel
• NameSpace: AMI

I only find a way to process this request using the Built in route conventions with end point name "GetFromThirdPartyModel". This was working until version 5.0.0. Is there a way to process this request using OData attributes ?

[commonsensesoftware]

I haven't seen this particular issue before. I've never found myself needing this OData capability, but it should work. OData has a history of making underlying changes so it's sometimes hard to tell the source of the issue. If you have a repro, that's always helpful. Do things work correctly if you remove API Versioning? There's a lot of open issues in OData. This link may be related.

The convention of GetFrom<Entity> is a naming convention to match the corresponding method that is only considered when there are no attributes. When there are any attributes, the name of the method is irrelevant.

I guess technically you can all this a cast, but it's not the cast function. This by way of specifying a qualified entity type name. I believe the default configuration now allows unqualified type names. That should mean that ~/ThirdPartyBases/ThirdPartyModel will work. You might also experiment with explicitly enabling or disabling that option in the configuration.

I recommend starting with that and I'll see if I'm able to determine anything else. The investigation queue is a bit backed up.

If I'm not mistaken, the native attribute routing method for OData Endpoint Routing would look like:

[ApiVersion("1.0")]
[Route("v{version:apiVersion}/[controller]")] // ← the prefix here has to match the endpoint registration
public class ThirdPartyBasesController : ODataController
{
    [HttpGet("[action]")]  // I've not tested if OData properly honors this built-in token; it 'should'
    [Produces("application/json")]
    [ProducesResponseType(typeof(ODataValue<IEnumerable<FirstPartyModel>>), Status200OK)]
    [EnableQuery(AllowedQueryOptions = All, MaxTop = 100)]
    public IQueryable<FirstPartyModel> FirstPartyModel() => _Query.FirstPartiesQueryProcessor.Get();

    [HttpGet(nameof(SecondPartyModel))]  // if [action] doesn't work, you can use an explicit name
    [Produces("application/json")]
    [ProducesResponseType(typeof(ODataValue<IEnumerable<SecondPartyModel>>), Status200OK)]
    [EnableQuery(AllowedQueryOptions = All, MaxTop = 100)]
    public IQueryable<SecondPartyModel> SecondPartyModel() => _Query.SecondPartiesQueryProcessor.Get();

    [HttpGet("[action]")]
    [Produces("application/json")]
    [ProducesResponseType(typeof(ODataValue<IEnumerable<ThirdPartyModel>>), Status200OK)]
    [EnableQuery(AllowedQueryOptions = All, MaxTop = 100)]
    public IQueryable<ThirdPartyModel> ThirdPartyModel() => _Query.ThirdPartiesQueryProcessor.Get();
}

Remember that the AMI namespace is part of the EDM, not the route template. OData parses the URL to process the namespace and resolve an OData Path. There is a close relationship between OData Path and route template, but they are not identical. For example, the prefix (e.g. v{version:apiVersion}) is not part of the OData Path.

[vbray1979]

I see that that Microsoft.AspNetCore.OData.Versioning: 5.0.0 and 4.1.1 are tageting the same version of Microsoft.AspNetCore.OData 7.5.7. It is certainly not the root cause.
I tried the proposed controller definition without any sucess. I still have 404 not found. I will provide a repro asap.

[commonsensesoftware]

This appears to be the same issue discovered in #689 and #710. There is bug in matching the long convention form of action names. This should be fixed in the next patch. In the meantime, you should have success using the short convention form - e.g. Get vs GetBook.

[vbray1979]

Hi Chris,

This is a good news. I will be able to upgrade as I was using the previous version for compatibility reason.