Better alias (#945)

Author: SimonCropp

claude.md

@@ -63,6 +63,7 @@ Tests use `[ModuleInitializer]` to call `VerifyEntityFramework.Initialize(model)
 - `IgnoreNavigationProperties()` - Exclude EF navigation properties from serialization
 - `EnableRecording()` - Enable SQL command recording on DbContextOptionsBuilder
 - `DisableRecording()` - Stop recording for a specific context instance
+- `UseDescriptiveTableAliases()` - Replace single-char SQL table aliases with full table names via custom `ISqlAliasManagerFactory`
 - `ScrubInlineEfDateTimes()` - Sanitize DateTime values in SQL
 
 ## Testing Conventions

readme.md

@@ -87,7 +87,7 @@ builder.UseSqlServer(connection);
 builder.EnableRecording();
 var data = new SampleDbContext(builder.Options);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L329-L336' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L358-L365' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 `EnableRecording` should only be called in the test context.
@@ -116,7 +116,7 @@ await data
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L428-L446' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L457-L475' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -168,7 +168,7 @@ await Verify(
         entries
     });
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L619-L644' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSpecific' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L648-L673' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSpecific' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -200,7 +200,7 @@ await data2
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L396-L419' title='Snippet source file'>snippet source</a> | <a href='#snippet-MultiDbContexts' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L425-L448' title='Snippet source file'>snippet source</a> | <a href='#snippet-MultiDbContexts' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: CoreTests.MultiDbContexts.verified.txt -->
@@ -265,7 +265,7 @@ await data
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L490-L513' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingDisableForInstance' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L519-L542' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingDisableForInstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: CoreTests.RecordingDisabledTest.verified.txt -->
@@ -313,7 +313,7 @@ public async Task Added()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L32-L48' title='Snippet source file'>snippet source</a> | <a href='#snippet-Added' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L61-L77' title='Snippet source file'>snippet source</a> | <a href='#snippet-Added' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -358,7 +358,7 @@ public async Task Deleted()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L50-L69' title='Snippet source file'>snippet source</a> | <a href='#snippet-Deleted' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L79-L98' title='Snippet source file'>snippet source</a> | <a href='#snippet-Deleted' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -403,7 +403,7 @@ public async Task Modified()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L71-L91' title='Snippet source file'>snippet source</a> | <a href='#snippet-Modified' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L100-L120' title='Snippet source file'>snippet source</a> | <a href='#snippet-Modified' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -438,7 +438,7 @@ var queryable = data.Companies
     .Where(_ => _.Name == "company name");
 await Verify(queryable);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L286-L292' title='Snippet source file'>snippet source</a> | <a href='#snippet-Queryable' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L315-L321' title='Snippet source file'>snippet source</a> | <a href='#snippet-Queryable' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified files:
@@ -505,7 +505,7 @@ await Verify(data.AllData())
         serializer =>
             serializer.TypeNameHandling = TypeNameHandling.Objects);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L265-L272' title='Snippet source file'>snippet source</a> | <a href='#snippet-AllData' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L294-L301' title='Snippet source file'>snippet source</a> | <a href='#snippet-AllData' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file with all data in the database:
@@ -588,7 +588,7 @@ public async Task IgnoreNavigationProperties()
         .IgnoreNavigationProperties();
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L93-L115' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationProperties' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L122-L144' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationProperties' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -601,7 +601,7 @@ var options = DbContextOptions();
 using var data = new SampleDbContext(options);
 VerifyEntityFramework.IgnoreNavigationProperties();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L143-L149' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationPropertiesGlobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L172-L178' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationPropertiesGlobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -622,7 +622,7 @@ protected override void ConfigureWebHost(IWebHostBuilder webBuilder)
             _ => dataBuilder.Options));
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L573-L585' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecordingWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L602-L614' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecordingWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Then use the same identifier for recording:
@@ -638,7 +638,7 @@ var companies = await httpClient.GetFromJsonAsync<Company[]>("/companies");
 
 var entries = Recording.Stop(testName);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L546-L556' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L575-L585' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 The results will not be automatically included in verified file so it will have to be verified manually:
@@ -653,10 +653,47 @@ await Verify(
         sql = entries
     });
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L558-L567' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyRecordedCommandsWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L587-L596' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyRecordedCommandsWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
+## Descriptive Table Aliases
+
+By default EF generates single character table aliases in SQL (eg `c` for Companies, `e` for Employees). `UseDescriptiveTableAliases` replaces these with the full table name, making recorded and verified SQL easier to read.
+
+
+### Enable
+
+Call `UseDescriptiveTableAliases()` on `DbContextOptionsBuilder`.
+
+```cs
+var builder = new DbContextOptionsBuilder<SampleDbContext>();
+builder.UseSqlServer(connection);
+builder.UseDescriptiveTableAliases();
+```
+
+
+### Result
+
+With descriptive aliases enabled, the generated SQL:
+
+```sql
+SELECT [companies].[Id], [companies].[Name], [employees].[Id], [employees].[Age], [employees].[CompanyId], [employees].[Name]
+FROM [Companies] AS [companies]
+LEFT JOIN [Employees] AS [employees] ON [companies].[Id] = [employees].[CompanyId]
+ORDER BY [companies].[Name], [companies].[Id]
+```
+
+Instead of the default:
+
+```sql
+SELECT [c].[Id], [c].[Name], [e].[Id], [e].[Age], [e].[CompanyId], [e].[Name]
+FROM [Companies] AS [c]
+LEFT JOIN [Employees] AS [e] ON [c].[Id] = [e].[CompanyId]
+ORDER BY [c].[Name], [c].[Id]
+```
+
+
 ## Missing OrderBy
 
 To detect and correct missing `OrderBy` clauses in EF queries, use [EntityFramework.OrderBy](https://github.com/SimonCropp/EntityFramework.OrderBy).
@@ -685,7 +722,7 @@ var settings = new VerifySettings();
 settings.ScrubInlineEfDateTimes();
 await Verify(target, settings);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L10-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesInstance' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L39-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesInstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -697,7 +734,7 @@ await Verify(target, settings);
 await Verify(target)
     .ScrubInlineEfDateTimes();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L24-L29' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesFluent' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L53-L58' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesFluent' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliases.verified.txt

@@ -0,0 +1,19 @@
+{
+  ef: {
+    Type: ReaderExecutedAsync,
+    HasTransaction: false,
+    Text:
+select   companies.Id,
+         companies.Name,
+         employees.Id,
+         employees.Age,
+         employees.CompanyId,
+         employees.Name
+from     Companies as companies
+         left outer join
+         Employees as employees
+         on companies.Id = employees.CompanyId
+order by companies.Name,
+         companies.Id
+  }
+}

src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliasesQueryable.verified.sql

@@ -0,0 +1,3 @@
+SELECT [companies].[Id], [companies].[Name]
+FROM [Companies] AS [companies]
+WHERE [companies].[Name] = N'company name'

src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliasesQueryable.verified.txt

@@ -0,0 +1,5 @@
+[
+  {
+    Name: company name
+  }
+]

src/Verify.EntityFramework.Tests/CoreTests.cs

@@ -2,6 +2,35 @@
 [Parallelizable(ParallelScope.All)]
 public class CoreTests
 {
+    [Test]
+    public async Task DescriptiveTableAliasesQueryable()
+    {
+        var database = await DbContextBuilder.GetDescriptiveAliasDatabase();
+        await database.AddData(
+            new Company
+            {
+                Name = "company name"
+            });
+        var data = database.Context;
+
+        var queryable = data.Companies
+            .Where(_ => _.Name == "company name");
+        await Verify(queryable);
+    }
+
+    [Test]
+    public async Task DescriptiveTableAliases()
+    {
+        await using var database = await DbContextBuilder.GetDescriptiveAliasDatabase();
+        var data = database.Context;
+        Recording.Start();
+        await data.Companies
+            .Include(_ => _.Employees)
+            .OrderBy(_ => _.Name)
+            .ToListAsync();
+        await Verify();
+    }
+
     [Test]
     public async Task ScrubInlineEfDateTimes()
     {

src/Verify.EntityFramework.Tests/Snippets/DbContextBuilder.cs

@@ -3,16 +3,28 @@
 
 public static class DbContextBuilder
 {
-    static DbContextBuilder() =>
+    static DbContextBuilder()
+    {
         sqlInstance = new(
             buildTemplate: CreateDb,
             constructInstance: builder =>
             {
                 builder.EnableRecording();
                 return new(builder.Options);
             });
+        descriptiveAliasSqlInstance = new(
+            buildTemplate: CreateDb,
+            storage: Storage.FromSuffix<SampleDbContext>("DescriptiveTableAliases"),
+            constructInstance: builder =>
+            {
+                builder.EnableRecording();
+                builder.UseDescriptiveTableAliases();
+                return new(builder.Options);
+            });
+    }
 
     static SqlInstance<SampleDbContext> sqlInstance;
+    static SqlInstance<SampleDbContext> descriptiveAliasSqlInstance;
 
     static async Task CreateDb(SampleDbContext data)
     {
@@ -65,4 +77,7 @@ static async Task CreateDb(SampleDbContext data)
 
     public static Task<SqlDatabase<SampleDbContext>> GetDatabase([CallerMemberName] string suffix = "")
         => sqlInstance.Build(suffix);
+
+    public static Task<SqlDatabase<SampleDbContext>> GetDescriptiveAliasDatabase([CallerMemberName] string suffix = "")
+        => descriptiveAliasSqlInstance.Build(suffix);
 }

src/Verify.EntityFramework/DescriptiveSqlAliasManager.cs

@@ -0,0 +1,24 @@
+#pragma warning disable EF9002
+
+class DescriptiveSqlAliasManager : SqlAliasManager
+{
+    Dictionary<string, int> aliases = new(StringComparer.OrdinalIgnoreCase);
+
+    public override string GenerateTableAlias(string name)
+    {
+        var lowerName = name.ToLowerInvariant();
+
+        if (aliases.TryGetValue(lowerName, out var counter))
+        {
+            aliases[lowerName] = counter + 1;
+            return lowerName + counter;
+        }
+
+        aliases[lowerName] = 0;
+        return lowerName;
+    }
+
+    protected override Dictionary<string, string>? RemapTableAliases(IReadOnlySet<string> usedAliases) =>
+        // Skip gap-closing since the base implementation assumes single-char alias prefixes
+        null;
+}

src/Verify.EntityFramework/DescriptiveSqlAliasManagerFactory.cs

@@ -0,0 +1,6 @@
+#pragma warning disable EF9002
+
+class DescriptiveSqlAliasManagerFactory : ISqlAliasManagerFactory
+{
+    public SqlAliasManager Create() => new DescriptiveSqlAliasManager();
+}

src/Verify.EntityFramework/GlobalUsings.cs

@@ -8,6 +8,7 @@
 global using Microsoft.EntityFrameworkCore.ChangeTracking;
 global using Microsoft.EntityFrameworkCore.Diagnostics;
 global using Microsoft.EntityFrameworkCore.Metadata;
+global using Microsoft.EntityFrameworkCore.Query;
 global using Microsoft.EntityFrameworkCore.Query.Internal;
 global using Microsoft.SqlServer.TransactSql.ScriptDom;
 global using VerifyTests.EntityFramework;