OData / OData/AspNetCoreOData

Annotations are not selectable

Open
#857 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
C#
Stars
505
Forks
186
PR merge metrics
No merged PRs in 30d

Description

Assemblies affected
ASP.NET Core OData 8.0.12

Describe the bug
When specifying an instance annotation inside the select of a GET request, the user receives an error that this is not supported.
The OData specification on the other hand states that it should be possible.

Reproduce steps
This behavior can be reproduced simply by specifying any annotation inside the select of a request.

Data Model

namespace ODataRoutingSample.Models
{
    public class Customer
    {
        public int Id { get; set; }

        public string Name { get; set; }

        public Color FavoriteColor { get; set; }

        public int Amount { get; set; }

        public virtual Address HomeAddress { get; set; }

        public virtual IList<Address> FavoriteAddresses { get; set; }
    }

    public class VipCustomer : Customer
    {
        public IList<string> Emails { get; set; }
    }
}

Request/Response
Request: GET http://localhost:64771/v1/Customers?select=@ns.annotation
Response:

{
    "error": {
        "code": "",
        "message": "The query specified in the URI is not valid. The last segment 'AnnotationSegment' of the select or expand query option is not supported.",
        "details": [],
        "innererror": {
            "message": "The last segment 'AnnotationSegment' of the select or expand query option is not supported.",
            "type": "Microsoft.OData.ODataException",
            "stacktrace": "   at Microsoft.AspNetCore.OData.Query.SelectExpandPathExtensions.GetFirstNonTypeCastSegment(ODataPath path, Func`2 middleSegmentPredicte, Func`2 lastSegmentPredicte, IList`1& remainingSegments) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\SelectExpandPathExtensions.cs:line 89\r\n   at Microsoft.AspNetCore.OData.Query.SelectExpandPathExtensions.GetFirstNonTypeCastSegment(ODataSelectPath selectPath, IList`1& remainingSegments) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\SelectExpandPathExtensions.cs:line 36\r\n   at Microsoft.AspNetCore.OData.Query.Expressions.SelectExpandBinder.ProcessSelectedItem(PathSelectItem pathSelectItem, IEdmNavigationSource navigationSource, IDictionary`2 currentLevelPropertiesInclude) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Expressions\\SelectExpandBinder.cs:line 651\r\n   at Microsoft.AspNetCore.OData.Query.Expressions.SelectExpandBinder.GetSelectExpandProperties(IEdmModel model, IEdmStructuredType structuredType, IEdmNavigationSource navigationSource, SelectExpandClause selectExpandClause, IDictionary`2& propertiesToInclude, IDictionary`2& propertiesToExpand, ISet`1& autoSelectedProperties) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Expressions\\SelectExpandBinder.cs:line 512\r\n   at Microsoft.AspNetCore.OData.Query.Expressions.SelectExpandBinder.ProjectElement(QueryBinderContext context, Expression source, SelectExpandClause selectExpandClause, IEdmStructuredType structuredType, IEdmNavigationSource navigationSource) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Expressions\\SelectExpandBinder.cs:line 400\r\n   at Microsoft.AspNetCore.OData.Query.Expressions.SelectExpandBinder.BindSelectExpand(SelectExpandClause selectExpandClause, QueryBinderContext context) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Expressions\\SelectExpandBinder.cs:line 84\r\n   at Microsoft.AspNetCore.OData.Query.Expressions.BinderExtensions.ApplyBind(ISelectExpandBinder binder, IQueryable source, SelectExpandClause selectExpandClause, QueryBinderContext context) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Expressions\\BinderExtensions.cs:line 275\r\n   at Microsoft.AspNetCore.OData.Query.SelectExpandQueryOption.ApplyTo(IQueryable queryable, ODataQuerySettings settings) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\Query\\SelectExpandQueryOption.cs:line 214\r\n   at Microsoft.AspNetCore.OData.Query.ODataQueryOptions.ApplySelectExpand[T](T entity, ODataQuerySettings querySettings) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\ODataQueryOptions.cs:line 1086\r\n   at Microsoft.AspNetCore.OData.Query.ODataQueryOptions.ApplyTo(IQueryable query, ODataQuerySettings querySettings) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\ODataQueryOptions.cs:line 441\r\n   at Microsoft.AspNetCore.OData.Query.EnableQueryAttribute.ApplyQuery(IQueryable queryable, ODataQueryOptions queryOptions) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\EnableQueryAttribute.cs:line 510\r\n   at Microsoft.AspNetCore.OData.Query.EnableQueryAttribute.ExecuteQuery(Object responseValue, IQueryable singleResultCollection, ControllerActionDescriptor actionDescriptor, HttpRequest request) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\EnableQueryAttribute.cs:line 473\r\n   at Microsoft.AspNetCore.OData.Query.EnableQueryAttribute.OnActionExecuted(ActionExecutedContext actionExecutedContext, Object responseValue, IQueryable singleResultCollection, ControllerActionDescriptor actionDescriptor, HttpRequest request) in C:\\Users\\admin\\Downloads\\AspNetCoreOData-main\\AspNetCoreOData-main\\src\\Microsoft.AspNetCore.OData\\Query\\EnableQueryAttribute.cs:line 308"
        }
    }
}

Expected behavior
If the annotation exists, it should be included in the response

Additional context
Although this sample project does not make use of annotations it shows that it is generally not possible to receive annotations in a selected list.
I first noted the Bug when annotations of entities inside a list would not show up in the response body if only specific properties got requested by specifying them inside the select. After reading through the OData specification, I tried to also select the annotation but this gave me the error above.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the request with $select=@ns.annotation and start at SelectExpandPathExtensions.cs, especially GetFirstNonTypeCastSegment, then follow SelectExpandBinder.cs at ProcessSelectedItem. Confirm how AnnotationSegment is handled during select binding and verify that an existing annotation is included in the response without the unsupported-segment error.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.