Improve expression debugging

Author: roji

src/EFCore.Relational/Query/JsonQueryExpression.cs

@@ -212,9 +212,10 @@ public virtual JsonQueryExpression MakeNullable()
     /// <inheritdoc />
     public virtual void Print(ExpressionPrinter expressionPrinter)
     {
-        expressionPrinter.Append("JsonQueryExpression(");
         expressionPrinter.Visit(JsonColumn);
-        expressionPrinter.Append($""", "{string.Join(".", Path.Select(e => e.ToString()))}")""");
+        expressionPrinter
+            .Append(" Q-> ")
+            .Append(string.Join(".", Path.Select(e => e.ToString())));
     }
 
     /// <inheritdoc />

src/EFCore.Relational/Query/SqlExpressions/ColumnExpression.cs

@@ -12,7 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
-[DebuggerDisplay("{DebuggerDisplay(),nq}")]
+[DebuggerDisplay("{TableAlias}.{Name}")]
 public abstract class ColumnExpression : SqlExpression
 {
     /// <summary>
@@ -64,7 +64,4 @@ protected override void Print(ExpressionPrinter expressionPrinter)
         expressionPrinter.Append(TableAlias).Append(".");
         expressionPrinter.Append(Name);
     }
-
-    private string DebuggerDisplay()
-        => $"{TableAlias}.{Name}";
 }

src/EFCore.Relational/Query/SqlExpressions/JsonScalarExpression.cs

@@ -126,9 +126,10 @@ public virtual JsonScalarExpression Update(SqlExpression json)
     /// <inheritdoc />
     protected override void Print(ExpressionPrinter expressionPrinter)
     {
-        expressionPrinter.Append("JsonScalarExpression(column: ");
         expressionPrinter.Visit(Json);
-        expressionPrinter.Append($""", "{string.Join(".", Path.Select(e => e.ToString()))}")""");
+        expressionPrinter
+            .Append(" -> ")
+            .Append(string.Join(".", Path.Select(e => e.ToString())));
     }
 
     /// <inheritdoc />

src/EFCore.Relational/Query/SqlExpressions/OrderingExpression.cs

@@ -12,6 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
+[DebuggerDisplay("{Microsoft.EntityFrameworkCore.Query.ExpressionPrinter.Print(this), nq}")]
 public class OrderingExpression : Expression, IPrintableExpression
 {
     /// <summary>

src/EFCore.Relational/Query/SqlExpressions/ProjectionExpression.cs

@@ -12,6 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///     application or provider, then please file an issue at
 ///     <see href="https://github.com/dotnet/efcore">github.com/dotnet/efcore</see>.
 /// </remarks>
+[DebuggerDisplay("{Microsoft.EntityFrameworkCore.Query.ExpressionPrinter.Print(this), nq}")]
 public sealed class ProjectionExpression : Expression, IPrintableExpression
 {
     internal ProjectionExpression(SqlExpression expression, string alias)
@@ -57,6 +58,7 @@ public ProjectionExpression Update(SqlExpression expression)
     void IPrintableExpression.Print(ExpressionPrinter expressionPrinter)
     {
         expressionPrinter.Visit(Expression);
+
         if (Alias != string.Empty
             && !(Expression is ColumnExpression column
                 && column.Name == Alias))

src/EFCore.Relational/Query/SqlExpressions/SelectExpression.cs

@@ -21,6 +21,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///     an issue at <see href="https://github.com/dotnet/efcore">github.com/dotnet/efcore</see>.
 /// </remarks>
 // Class is sealed because there are no public/protected constructors. Can be unsealed if this is changed.
+[DebuggerDisplay("{PrintShortSql(), nq}")]
 public sealed partial class SelectExpression : TableExpressionBase
 {
     private const string DiscriminatorColumnAlias = "Discriminator";
@@ -4561,6 +4562,13 @@ public override IEnumerable<IAnnotation> GetAnnotations()
 
     /// <inheritdoc />
     protected override void Print(ExpressionPrinter expressionPrinter)
+    {
+        PrintProjections(expressionPrinter);
+        expressionPrinter.AppendLine();
+        PrintSql(expressionPrinter);
+    }
+
+    private void PrintProjections(ExpressionPrinter expressionPrinter)
     {
         if (_clientProjections.Count > 0)
         {
@@ -4588,12 +4596,16 @@ protected override void Print(ExpressionPrinter expressionPrinter)
                 }
             }
         }
+    }
 
-        expressionPrinter.AppendLine();
-
-        foreach (var tag in Tags)
+    private void PrintSql(ExpressionPrinter expressionPrinter, bool withTags = true)
+    {
+        if (withTags)
         {
-            expressionPrinter.Append($"-- {tag}");
+            foreach (var tag in Tags)
+            {
+                expressionPrinter.Append($"-- {tag}");
+            }
         }
 
         IDisposable? indent = null;
@@ -4682,6 +4694,26 @@ protected override void Print(ExpressionPrinter expressionPrinter)
         }
     }
 
+    private string PrintShortSql()
+    {
+        var expressionPrinter = new ExpressionPrinter();
+        PrintSql(expressionPrinter, withTags: false);
+        return expressionPrinter.ToString();
+    }
+
+    /// <summary>
+    ///     <para>
+    ///         Expand this property in the debugger for a human-readable representation of this <see cref="SelectExpression" />.
+    ///     </para>
+    ///     <para>
+    ///         Warning: Do not rely on the format of the debug strings.
+    ///         They are designed for debugging only and may change arbitrarily between releases.
+    ///     </para>
+    /// </summary>
+    [EntityFrameworkInternal]
+    public string DebugView
+        => this.Print();
+
     /// <inheritdoc />
     public override bool Equals(object? obj)
         => obj != null

src/EFCore.Relational/Query/SqlExpressions/SqlExpression.cs

@@ -12,9 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
-#if DEBUG
-[DebuggerDisplay("{new Microsoft.EntityFrameworkCore.Query.ExpressionPrinter().PrintExpression(this), nq}")]
-#endif
+[DebuggerDisplay("{Microsoft.EntityFrameworkCore.Query.ExpressionPrinter.Print(this), nq}")]
 public abstract class SqlExpression : Expression, IPrintableExpression
 {
     /// <summary>

src/EFCore.Relational/Query/SqlExpressions/TableExpressionBase.cs

@@ -12,6 +12,7 @@ namespace Microsoft.EntityFrameworkCore.Query.SqlExpressions;
 ///         not used in application code.
 ///     </para>
 /// </summary>
+[DebuggerDisplay("{Microsoft.EntityFrameworkCore.Query.ExpressionPrinter.Print(this), nq}")]
 public abstract class TableExpressionBase : Expression, IPrintableExpression
 {
     private readonly IReadOnlyDictionary<string, IAnnotation>? _annotations;

src/EFCore/Query/ExpressionPrinter.cs

@@ -166,16 +166,22 @@ private string PrintCore(Expression expression, int? characterLimit = null, bool
 
         Visit(expression);
 
-        var queryPlan = PostProcess(_stringBuilder.ToString());
+        return ToString();
+    }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        var printed = PostProcess(_stringBuilder.ToString());
 
-        if (characterLimit is > 0)
+        if (CharacterLimit is > 0)
         {
-            queryPlan = queryPlan.Length > characterLimit
-                ? queryPlan[..characterLimit.Value] + "..."
-                : queryPlan;
+            printed = printed.Length > CharacterLimit
+                ? printed[..CharacterLimit.Value] + "..."
+                : printed;
         }
 
-        return queryPlan;
+        return printed;
     }
 
     /// <summary>

src/EFCore/Query/ProjectionMember.cs

@@ -16,7 +16,6 @@ namespace Microsoft.EntityFrameworkCore.Query;
 ///     See <see href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</see>
 ///     and <see href="https://aka.ms/efcore-docs-how-query-works">How EF Core queries work</see> for more information and examples.
 /// </remarks>
-[DebuggerDisplay("{ToString(), nq}")]
 public sealed class ProjectionMember
 {
     private readonly IList<MemberInfo> _memberChain;