Apply entity equality to query filters

Fixes #18158

src/EFCore/Query/Internal/EntityEqualityRewritingExpressionVisitor.cs

@@ -319,7 +319,7 @@ protected override Expression VisitMethodCall(MethodCallExpression methodCallExp
  {
  // Visit all arguments, rewriting the single lambda to replace its parameter expression
  newArguments[i] = arguments[i].GetLambdaOrNull() is LambdaExpression lambda
- ? Unwrap(RewriteAndVisitLambda(lambda, newSourceWrapper))
+ ? Unwrap(RewriteSingleParamLambda(lambda, newSourceWrapper))
  : Unwrap(Visit(arguments[i]));
  }
 
@@ -469,7 +469,7 @@ protected virtual Expression VisitOrderingMethodCall(MethodCallExpression method
  return methodCallExpression.Update(null, new[] { newSource, Unwrap(Visit(arguments[1])) });
  }
 
- var newKeySelector = RewriteAndVisitLambda(arguments[1].UnwrapLambdaFromQuote(), sourceWrapper);
+ var newKeySelector = RewriteSingleParamLambda(arguments[1].UnwrapLambdaFromQuote(), sourceWrapper);
 
  if (!(newKeySelector.Body is EntityReferenceExpression keySelectorWrapper)
  || !(keySelectorWrapper.EntityType is IEntityType entityType))
@@ -553,7 +553,7 @@ protected virtual Expression VisitSelectMethodCall(MethodCallExpression methodCa
  if (arguments.Count == 2)
  {
  var selector = arguments[1].UnwrapLambdaFromQuote();
- var newSelector = RewriteAndVisitLambda(selector, sourceWrapper);
+ var newSelector = RewriteSingleParamLambda(selector, sourceWrapper);
 
  newMethodCall = methodCallExpression.Update(null, new[] { Unwrap(newSource), Unwrap(newSelector) });
  return newSelector.Body is EntityReferenceExpression entityWrapper
@@ -564,11 +564,11 @@ protected virtual Expression VisitSelectMethodCall(MethodCallExpression methodCa
  if (arguments.Count == 3)
  {
  var collectionSelector = arguments[1].UnwrapLambdaFromQuote();
- var newCollectionSelector = RewriteAndVisitLambda(collectionSelector, sourceWrapper);
+ var newCollectionSelector = RewriteSingleParamLambda(collectionSelector, sourceWrapper);
 
  var resultSelector = arguments[2].UnwrapLambdaFromQuote();
  var newResultSelector = newCollectionSelector.Body is EntityReferenceExpression newCollectionSelectorWrapper
- ? RewriteAndVisitLambda(resultSelector, sourceWrapper, newCollectionSelectorWrapper)
+ ? RewriteTwoParamLambda(resultSelector, sourceWrapper, newCollectionSelectorWrapper)
  : (LambdaExpression)Visit(resultSelector);
 
  newMethodCall = methodCallExpression.Update(
@@ -610,9 +610,9 @@ protected virtual Expression VisitJoinMethodCall(MethodCallExpression methodCall
  });
  }
 
- var newOuterKeySelector = RewriteAndVisitLambda(outerKeySelector, outerWrapper);
- var newInnerKeySelector = RewriteAndVisitLambda(innerKeySelector, innerWrapper);
- var newResultSelector = RewriteAndVisitLambda(resultSelector, outerWrapper, innerWrapper);
+ var newOuterKeySelector = RewriteSingleParamLambda(outerKeySelector, outerWrapper);
+ var newInnerKeySelector = RewriteSingleParamLambda(innerKeySelector, innerWrapper);
+ var newResultSelector = RewriteTwoParamLambda(resultSelector, outerWrapper, innerWrapper);
 
  MethodCallExpression newMethodCall;
 
@@ -713,8 +713,14 @@ protected virtual Expression VisitOfType(MethodCallExpression methodCallExpressi
  /// Replaces the lambda's single parameter with a type wrapper based on the given source, and then visits
  /// the lambda's body.
  /// </summary>
- protected virtual LambdaExpression RewriteAndVisitLambda(LambdaExpression lambda, EntityReferenceExpression source)
- => Expression.Lambda(
+ protected virtual LambdaExpression RewriteSingleParamLambda(LambdaExpression lambda, EntityReferenceExpression source)
+ {
+ if (lambda.Parameters.Count != 1)
+ {
+ throw new ArgumentException("Lambda must have exactly one parameter", nameof(lambda));
+ }
+
+ return Expression.Lambda(
  lambda.Type,
  Visit(
  ReplacingExpressionVisitor.Replace(
@@ -723,16 +729,22 @@ protected virtual LambdaExpression RewriteAndVisitLambda(LambdaExpression lambda
  lambda.Body)),
  lambda.TailCall,
  lambda.Parameters);
+ }
 
  /// <summary>
  /// Replaces the lambda's two parameters with type wrappers based on the given sources, and then visits
  /// the lambda's body.
  /// </summary>
- protected virtual LambdaExpression RewriteAndVisitLambda(
+ protected virtual LambdaExpression RewriteTwoParamLambda(
  LambdaExpression lambda,
  EntityReferenceExpression source1,
  EntityReferenceExpression source2)
  {
+ if (lambda.Parameters.Count != 2)
+ {
+ throw new ArgumentException("Lambda must have exactly two parameters", nameof(lambda));
+ }
+
  Expression original1 = lambda.Parameters[0];
  Expression replacement1 = source1.Update(lambda.Parameters[0]);
  Expression original2 = lambda.Parameters[1];

src/EFCore/Query/Internal/NavigationExpandingExpressionVisitor.cs

@@ -23,6 +23,7 @@ public partial class NavigationExpandingExpressionVisitor : ExpressionVisitor
  private readonly EntityReferenceOptionalMarkingExpressionVisitor _entityReferenceOptionalMarkingExpressionVisitor;
  private readonly ISet<string> _parameterNames = new HashSet<string>();
  private readonly EnumerableToQueryableMethodConvertingExpressionVisitor _enumerableToQueryableMethodConvertingExpressionVisitor;
+ private readonly EntityEqualityRewritingExpressionVisitor _entityEqualityRewritingExpressionVisitor;
  private readonly ParameterExtractingExpressionVisitor _parameterExtractingExpressionVisitor;
 
  private readonly Dictionary<IEntityType, LambdaExpression> _parameterizedQueryFilterPredicateCache
@@ -44,6 +45,7 @@ public NavigationExpandingExpressionVisitor(
  _reducingExpressionVisitor = new ReducingExpressionVisitor();
  _entityReferenceOptionalMarkingExpressionVisitor = new EntityReferenceOptionalMarkingExpressionVisitor();
  _enumerableToQueryableMethodConvertingExpressionVisitor = new EnumerableToQueryableMethodConvertingExpressionVisitor();
+ _entityEqualityRewritingExpressionVisitor = new EntityEqualityRewritingExpressionVisitor(_queryCompilationContext);
  _parameterExtractingExpressionVisitor = new ParameterExtractingExpressionVisitor(
  evaluatableExpressionFilter,
  _parameters,
@@ -162,7 +164,8 @@ private Expression ApplyQueryFilter(NavigationExpansionExpression navigationExpa
  {
  if (!_queryCompilationContext.IgnoreQueryFilters)
  {
- var entityType = _queryCompilationContext.Model.FindEntityType(navigationExpansionExpression.Type.GetSequenceType());
+ var sequenceType = navigationExpansionExpression.Type.GetSequenceType();
+ var entityType = _queryCompilationContext.Model.FindEntityType(sequenceType);
  var rootEntityType = entityType.GetRootType();
  var queryFilter = rootEntityType.GetQueryFilter();
  if (queryFilter != null)
@@ -172,13 +175,23 @@ private Expression ApplyQueryFilter(NavigationExpansionExpression navigationExpa
  filterPredicate = queryFilter;
  filterPredicate = (LambdaExpression)_parameterExtractingExpressionVisitor.ExtractParameters(filterPredicate);
  filterPredicate = (LambdaExpression)_enumerableToQueryableMethodConvertingExpressionVisitor.Visit(filterPredicate);
+
+ // We need to do entity equality, but that requires a full method call on a query root to properly flow the
+ // entity information through. Construct a MethodCall wrapper for the predicate with the proper query root.
+ var queryableType = typeof(EntityQueryable<>).MakeGenericType(sequenceType);
+ var filterWrapper = Expression.Call(
+ QueryableMethods.Where.MakeGenericMethod(sequenceType),
+ Expression.Constant(Activator.CreateInstance(queryableType, NullAsyncQueryProvider.Instance), queryableType),
+ filterPredicate);
+ var rewrittenFilterWrapper = (MethodCallExpression)_entityEqualityRewritingExpressionVisitor.Rewrite(filterWrapper);
+ filterPredicate = rewrittenFilterWrapper.Arguments[1].UnwrapLambdaFromQuote();
+
  _parameterizedQueryFilterPredicateCache[rootEntityType] = filterPredicate;
  }
 
  filterPredicate =
  (LambdaExpression)new SelfReferenceEntityQueryableRewritingExpressionVisitor(this, entityType).Visit(
  filterPredicate);
- var sequenceType = navigationExpansionExpression.Type.GetSequenceType();
 
  // if we are constructing EntityQueryable of a derived type, we need to re-map filter predicate to the correct derived type
  var filterPredicateParameter = filterPredicate.Parameters[0];

test/EFCore.Specification.Tests/Query/FiltersTestBase.cs

@@ -168,6 +168,14 @@ public virtual void Compiled_query()
  }
  }
 
+ [ConditionalFact]
+ public virtual void Entity_Equality()
+ {
+ var results = _context.Orders.ToList();
+
+ Assert.Equal(80, results.Count);
+ }
+
  protected NorthwindContext CreateContext() => Fixture.CreateContext();
 
  public void Dispose() => _context.Dispose();

test/EFCore.Specification.Tests/TestModels/Northwind/NorthwindContext.cs

@@ -134,7 +134,7 @@ public void ConfigureFilters(ModelBuilder modelBuilder)
  // so we can capture TenantPrefix in filter exprs (simulates OnModelCreating).
 
  modelBuilder.Entity<Customer>().HasQueryFilter(c => c.CompanyName.StartsWith(TenantPrefix));
- modelBuilder.Entity<Order>().HasQueryFilter(o => o.Customer.CompanyName != null);
+ modelBuilder.Entity<Order>().HasQueryFilter(o => o.Customer != null && o.Customer.CompanyName != null);
  modelBuilder.Entity<OrderDetail>().HasQueryFilter(od => EF.Property<short>(od, "Quantity") > _quantity);
  modelBuilder.Entity<Employee>().HasQueryFilter(e => e.Address.StartsWith("A"));
  modelBuilder.Entity<Product>().HasQueryFilter(p => ClientMethod(p));

test/EFCore.SqlServer.FunctionalTests/Query/FiltersSqlServerTest.cs

@@ -125,7 +125,7 @@ LEFT JOIN (
  FROM [Customers] AS [c0]
  WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c0].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
  ) AS [t] ON [o].[CustomerID] = [t].[CustomerID]
- WHERE [t].[CompanyName] IS NOT NULL
+ WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL
 ) AS [t0] ON [c].[CustomerID] = [t0].[CustomerID]
 WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
 ORDER BY [c].[CustomerID], [t0].[OrderID]");
@@ -156,7 +156,7 @@ LEFT JOIN (
  FROM [Customers] AS [c]
  WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
 ) AS [t] ON [o].[CustomerID] = [t].[CustomerID]
-WHERE [t].[CompanyName] IS NOT NULL");
+WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL");
  }
 
  public override void Project_reference_that_itself_has_query_filter_with_another_reference()
@@ -177,7 +177,7 @@ LEFT JOIN (
  FROM [Customers] AS [c]
  WHERE ((@__ef_filter__TenantPrefix_1 = N'') AND @__ef_filter__TenantPrefix_1 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_1 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_1)) = @__ef_filter__TenantPrefix_1) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_1)) IS NOT NULL AND @__ef_filter__TenantPrefix_1 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_1)) IS NULL AND @__ef_filter__TenantPrefix_1 IS NULL))))
  ) AS [t] ON [o0].[CustomerID] = [t].[CustomerID]
- WHERE [t].[CompanyName] IS NOT NULL
+ WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL
 ) AS [t0] ON [o].[OrderID] = [t0].[OrderID]
 WHERE [o].[Quantity] > @__ef_filter___quantity_0");
  }
@@ -200,7 +200,7 @@ LEFT JOIN (
  FROM [Customers] AS [c0]
  WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c0].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c0].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
  ) AS [t] ON [o].[CustomerID] = [t].[CustomerID]
- WHERE [t].[CompanyName] IS NOT NULL
+ WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL
 ) AS [t0] ON [c].[CustomerID] = [t0].[CustomerID]
 INNER JOIN (
  SELECT [o0].[OrderID], [o0].[ProductID], [o0].[Discount], [o0].[Quantity], [o0].[UnitPrice]
@@ -252,7 +252,7 @@ LEFT JOIN (
  FROM [Customers] AS [c]
  WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
 ) AS [t] ON [o].[CustomerID] = [t].[CustomerID]
-WHERE [t].[CompanyName] IS NOT NULL");
+WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL");
  }
 
  public override void Compiled_query()
@@ -275,6 +275,23 @@ FROM [Customers] AS [c]
 WHERE (((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))) AND (([c].[CustomerID] = @__customerID) AND @__customerID IS NOT NULL)");
  }
 
+ public override void Entity_Equality()
+ {
+ base.Entity_Equality();
+
+ AssertSql(
+ @"@__ef_filter__TenantPrefix_0='B' (Size = 4000)
+
+SELECT [o].[OrderID], [o].[CustomerID], [o].[EmployeeID], [o].[OrderDate]
+FROM [Orders] AS [o]
+LEFT JOIN (
+ SELECT [c].[CustomerID], [c].[Address], [c].[City], [c].[CompanyName], [c].[ContactName], [c].[ContactTitle], [c].[Country], [c].[Fax], [c].[Phone], [c].[PostalCode], [c].[Region]
+ FROM [Customers] AS [c]
+ WHERE ((@__ef_filter__TenantPrefix_0 = N'') AND @__ef_filter__TenantPrefix_0 IS NOT NULL) OR ([c].[CompanyName] IS NOT NULL AND (@__ef_filter__TenantPrefix_0 IS NOT NULL AND (((LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) = @__ef_filter__TenantPrefix_0) AND (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NOT NULL AND @__ef_filter__TenantPrefix_0 IS NOT NULL)) OR (LEFT([c].[CompanyName], LEN(@__ef_filter__TenantPrefix_0)) IS NULL AND @__ef_filter__TenantPrefix_0 IS NULL))))
+) AS [t] ON [o].[CustomerID] = [t].[CustomerID]
+WHERE [t].[CustomerID] IS NOT NULL AND [t].[CompanyName] IS NOT NULL");
+ }
+
  private void AssertSql(params string[] expected)
  => Fixture.TestSqlLoggerFactory.AssertBaseline(expected);
  }