Expand Base property

[eduardoxvii]

I can't expand property in base class.

Assemblies affected
Microsoft.AspNetCore.OData 7.4.1

public class StreetAddress
{
public int Id { get; set; }
public string Street { get; set; }
public string City { get; set; }
}

public class Order
{
    public int Id { get; set; }
    public string Description { get; set; }
}

public abstract class Place
{
public int Id { get; set; }
public string Name { get; set; }
public StreetAddress ShippingAddress { get; set; }
}

public class School : Place
{
public Order Order { get; set; }
}

Reproduce steps
I made these requists:
http://localhost:5000/School?$expand=Order (Working)
http://localhost:5000/School?$select=Name (Working)
But
http://localhost:5000/School?$expand=ShippingAddress (Not Working)

Actual result

EF.Property called with wrong property name.

[gathogojr]

@eduardoxvii $expand is only applicable to navigation properties (comprising entity or entity collection). ShippingAddress in your example is a complex type. It should be included in the default response

[eduardoxvii]

@eduardoxvii $expand is only applicable to navigation properties (comprising entity or entity collection). ShippingAddress in your example is a complex type. It should be included in the default response

Are you saying that 'ShippingAddress' is a complex class because I forgot to put the id property?
Why 'ShippingAddress' is not woking like 'Order'?
How could I include 'ShippingAddress' in the default response?

[gathogojr]

@eduardoxvii If ShippingAddress is an entity type as per your latest code sample, then $expand should work on that as well.
I just fired up a quick repro mirroring your exact scenario above and I'm able to expand ShippingAddress:

Request: http://localhost:28541/odata/School?$expand=ShippingAddress
Response:

{
  "@odata.context": "http://ServiceRoot/$metadata#School(ShippingAddress())",
  "value": [
    {
      "Id": 1,
      "Name": "School 1",
      "ShippingAddress": {
        "Id": 1,
        "Street": "Street 1",
        "City": "City 1"
      }
    }
  ]
}

Are you using conventional model builder? Can you share the model builder snippet? Here's the model builder code for the repro that produced the output above:

var modelBuilder = new ODataConventionModelBuilder();
modelBuilder.EntitySet<School>("School");

Here's the metadata:

<?xml version="1.0" encoding="UTF-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
   <edmx:DataServices>
      <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NS.Models">
         <EntityType Name="School">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Name" Type="Edm.String" />
            <NavigationProperty Name="Order" Type="NS.Models.Order" />
            <NavigationProperty Name="ShippingAddress" Type="NS.Models.StreetAddress" />
         </EntityType>
         <EntityType Name="Order">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Description" Type="Edm.String" />
         </EntityType>
         <EntityType Name="StreetAddress">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Street" Type="Edm.String" />
            <Property Name="City" Type="Edm.String" />
         </EntityType>
      </Schema>
      <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Default">
         <EntityContainer Name="Container">
            <EntitySet Name="School" EntityType="NS.Models.School" />
         </EntityContainer>
      </Schema>
   </edmx:DataServices>
</edmx:Edmx>

[eduardoxvii]

Are you using conventional model builder? Can you share the model builder snippet?

Gathogojr, I'm using enpoint:

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
                endpoints.EnableDependencyInjection();
                endpoints.Select().Filter().Expand().Count().MaxTop(10);
            });

I decided to do several tests, see the results:

TEST I

The classes created in memory, and this way it(http://localhost:5000/School?$expand=ShippingAddress) worked ...

        [HttpGet]
        [EnableQuery]
        public IActionResult Get()
        {
               var list2 = new List<School>() { new School { ShippingAddress = new ShippingAddress { } } }.AsQueryable();
               return Ok(list2);
        }

TEST II

Class from database. Result: EF.Property called with wrong property name.

        [HttpGet]
        [EnableQuery]
        public IActionResult Get()
        {
               var list2 = _repo.all;
               return Ok(list2);
        }

TEST III

Class from database than bring it to memory and send to Odata, and this way it(http://localhost:5000/School?$expand=ShippingAddress) worked ...

        [HttpGet]
        [EnableQuery]
        public IActionResult Get()
        {
            var list2 = await _repo.All
                .Include(s=>s.ShippingAddress)
                .ToListAsync();
               return Ok(list2.AsQueryable());
        }

TEST IV

Class from database with Include of ShippingAddress send to Odata. Result: EF.Property called with wrong property name.

        [HttpGet]
        [EnableQuery]
        public IActionResult Get()
        {
            var list2 = _repo.All
                .Include(s=>s.ShippingAddress);
               return Ok(list2);
        }

Complete message error
System.InvalidOperationException: EF.Property called with wrong property name.
at Microsoft.EntityFrameworkCore.Query.RelationalSqlTranslatingExpressionVisitor.VisitMethodCall(MethodCallExpression methodCallExpression)
at System.Linq.Expressions.MethodCallExpression.Accept(ExpressionVisitor visitor)
at Microsoft.EntityFrameworkCore.Query.RelationalSqlTranslatingExpressionVisitor.VisitBinary(BinaryExpression binaryExpression)
at Pomelo.EntityFrameworkCore.MySql.Query.ExpressionVisitors.Internal.MySqlSqlTranslatingExpressionVisitor.VisitBinary(BinaryExpression binaryExpression)
at System.Linq.Expressions.BinaryExpression.Accept(ExpressionVisitor visitor)
at Microsoft.EntityFrameworkCore.Query.RelationalSqlTranslatingExpressionVisitor.Translate(Expression expression)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.Visit(Expression expression)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.VisitMemberAssignment(MemberAssignment memberAssignment)
at System.Linq.Expressions.ExpressionVisitor.VisitMemberBinding(MemberBinding node)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.VisitMemberInit(MemberInitExpression memberInitExpression)
at System.Linq.Expressions.MemberInitExpression.Accept(ExpressionVisitor visitor)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.Visit(Expression expression)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.VisitMemberAssignment(MemberAssignment memberAssignment)
at System.Linq.Expressions.ExpressionVisitor.VisitMemberBinding(MemberBinding node)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.VisitMemberInit(MemberInitExpression memberInitExpression)
at System.Linq.Expressions.MemberInitExpression.Accept(ExpressionVisitor visitor)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.Visit(Expression expression)
at Microsoft.EntityFrameworkCore.Query.Internal.RelationalProjectionBindingExpressionVisitor.Translate(SelectExpression selectExpression, Expression expression)
at Microsoft.EntityFrameworkCore.Query.RelationalQueryableMethodTranslatingExpressionVisitor.TranslateSelect(ShapedQueryExpression source, LambdaExpression selector)
at Microsoft.EntityFrameworkCore.Query.QueryableMethodTranslatingExpressionVisitor.VisitMethodCall(MethodCallExpression methodCallExpression)
at Microsoft.EntityFrameworkCore.Query.RelationalQueryableMethodTranslatingExpressionVisitor.VisitMethodCall(MethodCallExpression methodCallExpression)
at System.Linq.Expressions.MethodCallExpression.Accept(ExpressionVisitor visitor)
at Microsoft.EntityFrameworkCore.Query.QueryCompilationContext.CreateQueryExecutor[TResult](Expression query)
at Microsoft.EntityFrameworkCore.Storage.Database.CompileQuery[TResult](Expression query, Boolean async)
at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.CompileQueryCore[TResult](IDatabase database, Expression query, IModel model, Boolean async)
at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.<>c__DisplayClass12_01.<ExecuteAsync>b__0() at Microsoft.EntityFrameworkCore.Query.Internal.CompiledQueryCache.GetOrAddQueryCore[TFunc](Object cacheKey, Func1 compiler)
at Microsoft.EntityFrameworkCore.Query.Internal.CompiledQueryCache.GetOrAddQuery[TResult](Object cacheKey, Func1 compiler) at Microsoft.EntityFrameworkCore.Query.Internal.QueryCompiler.ExecuteAsync[TResult](Expression query, CancellationToken cancellationToken) at Microsoft.EntityFrameworkCore.Query.Internal.EntityQueryProvider.ExecuteAsync[TResult](Expression expression, CancellationToken cancellationToken) at Microsoft.EntityFrameworkCore.Query.Internal.EntityQueryable1.GetAsyncEnumerator(CancellationToken cancellationToken)
at Microsoft.AspNetCore.Mvc.Infrastructure.AsyncEnumerableReader.ReadInternal[T](IAsyncEnumerable1 value) at Microsoft.AspNetCore.Mvc.Infrastructure.ObjectResultExecutor.ExecuteAsyncEnumerable(ActionContext context, ObjectResult result, IAsyncEnumerable1 asyncEnumerable)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|29_0[TFilter,TFilterAsync](ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Rethrow(ResultExecutedContextSealed context)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.ResultNext[TFilter,TFilterAsync](State& next, Scope& scope, Object& state, Boolean& isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.InvokeResultFilters()
--- End of stack trace from previous location where exception was thrown ---
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|19_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Logged|17_1(ResourceInvoker invoker)
at Microsoft.AspNetCore.Routing.EndpointMiddleware.g__AwaitRequestTask|6_0(Endpoint endpoint, Task requestTask, ILogger logger)
at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

[gathogojr]

@eduardoxvii Using endpoint routing doesn't stop you from using the model builder, unless you want to go for a Non-Edm Approach. Either way, here's a resource on using endpoint routing in OData that covers both the Edm and Non-Edm approach https://devblogs.microsoft.com/odata/enabling-endpoint-routing-in-odata/

I have also gone ahead and pushed a repro I used to verify that $expand works for both Edm and Non-Edm approaches https://github.com/gathogojr/ODataWebApiIssue2213Repro

Note that in the repro I'm returning IQueryable and I'm not having to add .Include() in the query. In short, it's not an issue with ShippingAddress belonging to the base class.
I hope this helps.

[gathogojr]

Closing issue after sharing repro confirming $expand works on a base type navigation property for both Edm and Non-Edm OData service.
@eduardoxvii Feel free to reopen the issue if there's any angle that was not covered

[vbray1979]

Hi, I am experiencing the same issue describe in test IV by @eduardoxvii using EF Core 3.1.5 and AspNetCore.OData 7.4.1
How did you managed to solve it or workaround it?

[gathogojr]

@vbray1979 I only went as far as demonstrating that there's no issue with $expand when applied to a navigation property inherited from the base class. As for invalid query being generated when you use .Include(), could you kindly report the issue with EF Core

[eduardoxvii]

@gathogojr , I managed to reproduce the error in your project! In my project Expand never works, but yours insisted on working! So far!
I created some new classes in your example ODataWebApiIssue2213ReproNonEdm:

    public abstract class People
    {
        public int Id { get; set; }
        public string Name { get; set; }

    }

public class Legal : People
    {
        public string Municipalregistry { get; set; }
    }

    public class Individual : People
    {
        public string  MotherName { get; set; }
    }

    public class Company : Place
    {
        public string ManagerNage { get; set; }
    }

I needed change your InMemoryDbContext to:

        public DbSet<StreetAddress> Streetaddresses { get; set; }
        public DbSet<Order> Orders { get; set; }
        public DbSet<Company> Companies { get; set; }
        public DbSet<School> Schools { get; set; }
        public DbSet<Legal> PeopleLegal { get; set; }
        public DbSet<Individual> PeopleIndividual { get; set; }

I change the startup too:

using (IServiceScope serviceScope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>().CreateScope())
            {
                InMemoryDbContext db = serviceScope.ServiceProvider.GetRequiredService<InMemoryDbContext>();
                Company company=null;
                if (!db.Companies.Any())
                {
                    var shippingAddress = new StreetAddress { Id = 3, Street = "Company 2", City = "City 1" };
                    db.Streetaddresses.Add(shippingAddress);
                    company = new Company { Id = 2, Name = "Company 1", ManagerNage = "Blá Blá", StreetAddress = shippingAddress };
                    db.Companies.Add(company);

                    db.SaveChanges();
                }

                if (!db.Schools.Any())
                {
                    var shippingAddress = new StreetAddress { Id = 1, Street = "Street 1", City = "City 1" };
                    db.Streetaddresses.Add(shippingAddress);

                    var order = new Order { Id = 1, Description = "Order 1 Description " };
                    db.Orders.Add(order);

                    db.Schools.Add(new School { Id = 1, Branch = company, Name = "School 1", StreetAddress = shippingAddress, Order = order });

                    db.SaveChanges();
                }
            }

I'm using always this Request: http://localhost:28541/odata/School?$expand=ShippingAddress

TESTE I
School with a abstract class in property. worked ...

    public class School : Place
    {
        public People Owner { get; set; }
    }

TESTE II
School with a concrete class in property. worked ...

    public class School : Place
    {
        public Order Order { get; set; }
    }

TESTE III
School with a concrete class of its own hierarchy in property. worked ...

    public class School : Place
    {
        public Company Branch { get; set; }
    }

TESTE IV
But, a School with a abstract class of its own hierarchy in property. Don't worked ...

    public class School : Place
    {
        public Place Branch { get; set; }
    }

Error: System.InvalidOperationException: EF.Property called with wrong property name.

Please, help me! I'm stuck with that.

[vbray1979]

@eduardoxvii If ShippingAddress is an entity type as per your latest code sample, then $expand should work on that as well.
I just fired up a quick repro mirroring your exact scenario above and I'm able to expand ShippingAddress:

Request: http://localhost:28541/odata/School?$expand=ShippingAddress
Response:

{
  "@odata.context": "http://ServiceRoot/$metadata#School(ShippingAddress())",
  "value": [
    {
      "Id": 1,
      "Name": "School 1",
      "ShippingAddress": {
        "Id": 1,
        "Street": "Street 1",
        "City": "City 1"
      }
    }
  ]
}

Are you using conventional model builder? Can you share the model builder snippet? Here's the model builder code for the repro that produced the output above:

var modelBuilder = new ODataConventionModelBuilder();
modelBuilder.EntitySet<School>("School");

Here's the metadata:

<?xml version="1.0" encoding="UTF-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
   <edmx:DataServices>
      <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NS.Models">
         <EntityType Name="School">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Name" Type="Edm.String" />
            <NavigationProperty Name="Order" Type="NS.Models.Order" />
            <NavigationProperty Name="ShippingAddress" Type="NS.Models.StreetAddress" />
         </EntityType>
         <EntityType Name="Order">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Description" Type="Edm.String" />
         </EntityType>
         <EntityType Name="StreetAddress">
            <Key>
               <PropertyRef Name="Id" />
            </Key>
            <Property Name="Id" Type="Edm.Int32" Nullable="false" />
            <Property Name="Street" Type="Edm.String" />
            <Property Name="City" Type="Edm.String" />
         </EntityType>
      </Schema>
      <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Default">
         <EntityContainer Name="Container">
            <EntitySet Name="School" EntityType="NS.Models.School" />
         </EntityContainer>
      </Schema>
   </edmx:DataServices>
</edmx:Edmx>

I just realised that your metadata does not include any basetype property but instead bring back the base navigation property to the derived object... There must be some configuration difference. Here is my definition..

 [Table("Asset", Schema = "Asset")]
    public class AssetModel : IInsertable, IUpdatable
    {
        [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public Guid AssetId { get; set; }

        [Required]
        public string AssetSymbol { get; set; }

        [Required]
        [ForeignKey("AssetType")]
        public Guid AssetTypeId { get; set; }

        public virtual AssetTypeModel AssetType { get; set; }

 public class FinancialAssetModel : AssetModel
    {
        public string Ticker { get; set; }

and the related metadata

<EntityType Name="AssetModel">
<Key>
<PropertyRef Name="assetId" />
</Key>
...
<NavigationProperty Name="assetType" Type="AMI.AssetTypeModel">
     <ReferentialConstraint Property="assetTypeId" ReferencedProperty="assetTypeId" />
</NavigationProperty>
</EntityType>

<EntityType Name="FinancialAssetModel" BaseType="AMI.AssetModel">
<Property Name="ticker" Type="Edm.String" />
</EntityType>

and my configuration

var Assets = builder.EntitySet<AssetModel>("Assets").EntityType.HasKey(x => x.AssetId);