Remove ITableBasedExpression - Use annotation instead

Resolves #28667
dotnet · Aug 11, 2022 · 6da6e80 · 6da6e80
1 parent 30d4b22
commit 6da6e80
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 47 deletions.
diff --git a/src/EFCore.Relational/Metadata/RelationalAnnotationNames.cs b/src/EFCore.Relational/Metadata/RelationalAnnotationNames.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.EntityFrameworkCore.Query.SqlExpressions;
+
 namespace Microsoft.EntityFrameworkCore.Metadata;
 
 /// <summary>
@@ -333,4 +335,9 @@ public static class RelationalAnnotationNames
     ///     The JSON property name for the element that the property/navigation maps to.
     /// </summary>
     public const string JsonPropertyName = Prefix + "JsonPropertyName";
+
+    /// <summary>
+    ///     The <see cref="ITableBase"/> associated with the given <see cref="TableExpressionBase"/>.
+    /// </summary>
+    public const string QueryTableSource = Prefix + "QueryTableSource";
 }
diff --git a/src/EFCore.Relational/Query/SqlExpressionFactory.cs b/src/EFCore.Relational/Query/SqlExpressionFactory.cs
@@ -641,7 +641,7 @@ private void AddConditions(SelectExpression selectExpression, IEntityType entity
             return;
         }
 
-        var table = ((ITableBasedExpression)selectExpression.Tables[0]).Table;
+        var table = (ITableBase)selectExpression.Tables[0].FindAnnotation(RelationalAnnotationNames.QueryTableSource)!.Value!;
         if (table.IsOptional(entityType))
         {
             var entityProjectionExpression = GetMappedEntityProjectionExpression(selectExpression);

diff --git a/src/EFCore.Relational/Query/SqlExpressions/FromSqlExpression.cs b/src/EFCore.Relational/Query/SqlExpressions/FromSqlExpression.cs
@@ -14,18 +14,17 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
-public class FromSqlExpression : TableExpressionBase, IClonableTableExpressionBase, ITableBasedExpression
+public class FromSqlExpression : TableExpressionBase, IClonableTableExpressionBase
 {
-    private readonly ITableBase _table;
-
     /// <summary>
     ///     Creates a new instance of the <see cref="FromSqlExpression" /> class.
     /// </summary>
     /// <param name="defaultTableBase">A default table base associated with this table source.</param>
     /// <param name="sql">A user-provided custom SQL for the table source.</param>
     /// <param name="arguments">A user-provided parameters to pass to the custom SQL.</param>
     public FromSqlExpression(ITableBase defaultTableBase, string sql, Expression arguments)
-        : this(defaultTableBase.Name[..1].ToLowerInvariant(), defaultTableBase, sql, arguments, annotations: null)
+        : this(defaultTableBase.Name[..1].ToLowerInvariant(), sql, arguments,
+              new[] { new Annotation(RelationalAnnotationNames.QueryTableSource, defaultTableBase)})
     {
     }
 
@@ -41,13 +40,11 @@ public FromSqlExpression(ITableBase defaultTableBase, string sql, Expression arg
 
     private FromSqlExpression(
         string alias,
-        ITableBase tableBase,
         string sql,
         Expression arguments,
         IEnumerable<IAnnotation>? annotations)
         : base(alias, annotations)
     {
-        _table = tableBase;
         Sql = sql;
         Arguments = arguments;
     }
@@ -80,23 +77,20 @@ public override string? Alias
     /// <returns>This expression if no children changed, or an expression with the updated children.</returns>
     public virtual FromSqlExpression Update(Expression arguments)
         => arguments != Arguments
-            ? new FromSqlExpression(Alias, _table, Sql, arguments, GetAnnotations())
+            ? new FromSqlExpression(Alias, Sql, arguments, GetAnnotations())
             : this;
 
     /// <inheritdoc />
     protected override TableExpressionBase CreateWithAnnotations(IEnumerable<IAnnotation> annotations)
-        => new FromSqlExpression(Alias, _table, Sql, Arguments, annotations);
-
-    /// <inheritdoc />
-    ITableBase ITableBasedExpression.Table => _table;
+        => new FromSqlExpression(Alias, Sql, Arguments, annotations);
 
     /// <inheritdoc />
     protected override Expression VisitChildren(ExpressionVisitor visitor)
         => this;
 
     /// <inheritdoc />
     public virtual TableExpressionBase Clone()
-        => new FromSqlExpression(Alias, _table, Sql, Arguments, GetAnnotations());
+        => new FromSqlExpression(Alias, Sql, Arguments, GetAnnotations());
 
     /// <inheritdoc />
     protected override void Print(ExpressionPrinter expressionPrinter)
@@ -114,7 +108,6 @@ public override bool Equals(object? obj)
 
     private bool Equals(FromSqlExpression fromSqlExpression)
         => base.Equals(fromSqlExpression)
-            && _table == fromSqlExpression._table
             && Sql == fromSqlExpression.Sql
             && ExpressionEqualityComparer.Instance.Equals(Arguments, fromSqlExpression.Arguments);
 

diff --git a/src/EFCore.Relational/Query/SqlExpressions/ITableBasedExpression.cs b/src/EFCore.Relational/Query/SqlExpressions/ITableBasedExpression.cs
diff --git a/src/EFCore.Relational/Query/SqlExpressions/SelectExpression.cs b/src/EFCore.Relational/Query/SqlExpressions/SelectExpression.cs
@@ -439,7 +439,7 @@ internal SelectExpression(IEntityType entityType, TableExpressionBase tableExpre
             throw new InvalidOperationException(RelationalStrings.SelectExpressionNonTphWithCustomTable(entityType.DisplayName()));
         }
 
-        var table = ((ITableBasedExpression)tableExpressionBase).Table;
+        var table = (ITableBase)tableExpressionBase.FindAnnotation(RelationalAnnotationNames.QueryTableSource)!.Value!;
         var tableReferenceExpression = new TableReferenceExpression(this, tableExpressionBase.Alias!);
         AddTable(tableExpressionBase, tableReferenceExpression);
 

diff --git a/src/EFCore.Relational/Query/SqlExpressions/TableExpression.cs b/src/EFCore.Relational/Query/SqlExpressions/TableExpression.cs
@@ -13,10 +13,10 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///     application or database provider code. If this is a problem for your application or provider, then please file
 ///     an issue at <see href="https://github.com/dotnet/efcore">github.com/dotnet/efcore</see>.
 /// </remarks>
-public sealed class TableExpression : TableExpressionBase, IClonableTableExpressionBase, ITableBasedExpression
+public sealed class TableExpression : TableExpressionBase, IClonableTableExpressionBase
 {
     internal TableExpression(ITableBase table)
-        : this(table, annotations: null)
+        : this(table, annotations: new[] { new Annotation(RelationalAnnotationNames.QueryTableSource, table) })
     {
     }
 
@@ -57,9 +57,6 @@ public override string? Alias
     protected override TableExpressionBase CreateWithAnnotations(IEnumerable<IAnnotation> annotations)
         => new TableExpression(Table, annotations) { Alias = Alias };
 
-    /// <inheritdoc />
-    ITableBase ITableBasedExpression.Table => Table;
-
     /// <inheritdoc />
     protected override void Print(ExpressionPrinter expressionPrinter)
     {

diff --git a/src/EFCore.Relational/Query/SqlExpressions/TableExpressionBase.cs b/src/EFCore.Relational/Query/SqlExpressions/TableExpressionBase.cs
@@ -97,7 +97,39 @@ public override bool Equals(object? obj)
                 && Equals(tableExpressionBase));
 
     private bool Equals(TableExpressionBase tableExpressionBase)
-        => Alias == tableExpressionBase.Alias;
+    {
+        if (Alias != tableExpressionBase.Alias)
+        {
+            return false;
+        }
+
+        if (_annotations == null)
+        {
+            return tableExpressionBase._annotations == null;
+        }
+
+        if (tableExpressionBase._annotations == null)
+        {
+            return false;
+        }
+
+        if (_annotations.Count != tableExpressionBase._annotations.Count)
+        {
+            return false;
+        }
+
+        foreach (var kvp in _annotations)
+        {
+            if (!tableExpressionBase._annotations.TryGetValue(kvp.Key, out var value)
+                || !Equals(value, kvp.Value))
+            {
+                return false;
+            }
+        }
+
+        return false;
+    }
+
 
     /// <inheritdoc />
     public override int GetHashCode()

diff --git a/src/EFCore.Relational/Query/SqlExpressions/TableValuedFunctionExpression.cs b/src/EFCore.Relational/Query/SqlExpressions/TableValuedFunctionExpression.cs
@@ -14,7 +14,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
-public class TableValuedFunctionExpression : TableExpressionBase, ITableBasedExpression
+public class TableValuedFunctionExpression : TableExpressionBase
 {
     /// <summary>
     ///     Creates a new instance of the <see cref="TableValuedFunctionExpression" /> class.
@@ -26,7 +26,7 @@ public TableValuedFunctionExpression(IStoreFunction storeFunction, IReadOnlyList
             storeFunction.Name[..1].ToLowerInvariant(),
             storeFunction,
             arguments,
-            annotations: null)
+            annotations: new[] { new Annotation(RelationalAnnotationNames.QueryTableSource, storeFunction) })
     {
     }
 
@@ -61,9 +61,6 @@ public override string? Alias
     /// </summary>
     public virtual IReadOnlyList<SqlExpression> Arguments { get; }
 
-    /// <inheritdoc />
-    ITableBase ITableBasedExpression.Table => StoreFunction;
-
     /// <inheritdoc />
     protected override Expression VisitChildren(ExpressionVisitor visitor)
     {