Remove missing-order enforcement and related code (#944)

Remove the built-in missing-ORDER BY enforcement and all associated plumbing: delete MissingOrder visitor/factory/visitor files, remove ThrowForMissingOrderBy API, drop order-required SqlInstance and related tests/verified outputs, and remove NameOrAlias helper. Update docs and snippets to no longer reference the removed feature and add guidance to use EntityFramework.OrderBy instead. Adjust DbContextBuilder initialization and global usings accordingly.

Author: SimonCropp

claude.md

@@ -36,8 +36,7 @@ src/
 │   │   ├── QueryableConverter.cs     # Converts IQueryable to SQL + results
 │   │   ├── TrackerConverter.cs       # Converts ChangeTracker state
 │   │   └── LogEntryConverter.cs      # Recorded SQL entries
-│   ├── LogCommandInterceptor.cs      # DbCommandInterceptor for SQL recording
-│   └── MissingOrder/                 # Detects missing ORDER BY clauses
+│   └── LogCommandInterceptor.cs      # DbCommandInterceptor for SQL recording
 │
 ├── Verify.EntityFramework.Tests/     # EF Core tests
 ├── Verify.EntityFrameworkClassic/    # EF 6 library
@@ -64,7 +63,6 @@ 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
-- `ThrowForMissingOrderBy()` - Enforce ORDER BY clauses in queries
 - `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#L384-L391' 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#L329-L336' 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#L483-L501' 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#L428-L446' 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#L674-L699' 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#L619-L644' 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#L451-L474' 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#L396-L419' 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#L545-L568' 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#L490-L513' 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#L87-L103' 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#L32-L48' 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#L105-L124' 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#L50-L69' 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#L126-L146' 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#L71-L91' 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#L341-L347' 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#L286-L292' 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#L320-L327' 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#L265-L272' 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#L148-L170' 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#L93-L115' 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#L198-L204' 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#L143-L149' 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#L628-L640' 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#L573-L585' 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#L601-L611' 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#L546-L556' 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,15 @@ await Verify(
         sql = entries
     });
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L613-L622' 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#L558-L567' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyRecordedCommandsWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
+## Missing OrderBy
+
+To detect and correct missing `OrderBy` clauses in EF queries, use [EntityFramework.OrderBy](https://github.com/SimonCropp/EntityFramework.OrderBy).
+
+
 ## ScrubInlineEfDateTimes
 
 In some scenarios EntityFrmaeowrk does not parameterise DateTimes. For example when querying [temporal tables](https://learn.microsoft.com/en-us/sql/relational-databases/tables/temporal-tables).
@@ -680,7 +685,7 @@ var settings = new VerifySettings();
 settings.ScrubInlineEfDateTimes();
 await Verify(target, settings);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L34-L40' 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#L10-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesInstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -692,7 +697,7 @@ await Verify(target, settings);
 await Verify(target)
     .ScrubInlineEfDateTimes();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L48-L53' 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#L24-L29' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesFluent' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

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

@@ -2,30 +2,6 @@
 [Parallelizable(ParallelScope.All)]
 public class CoreTests
 {
-    [Test]
-    public async Task MissingOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await ThrowsTask(
-                () => data.Companies
-                    .ToListAsync())
-            .IgnoreStackTrace();
-    }
-
-    [Test]
-    public async Task NestedMissingOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await ThrowsTask(
-                () => data.Companies
-                    .Include(_ => _.Employees)
-                    .OrderBy(_ => _.Name)
-                    .ToListAsync())
-            .IgnoreStackTrace();
-    }
-
     [Test]
     public async Task ScrubInlineEfDateTimes()
     {
@@ -53,37 +29,6 @@ await Verify(target)
         #endregion
     }
 
-    [Test]
-    public async Task WithOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(
-            data.Companies
-                .OrderBy(_ => _.Name)
-                .ToListAsync());
-    }
-
-    [Test]
-    public async Task SingleMissingOrder()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(data.Companies.Where(_ => _.Name == "Company1").SingleAsync());
-    }
-
-    [Test]
-    public async Task WithNestedOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(
-            data.Companies
-                .Include(_ => _.Employees.OrderBy(_ => _.Age))
-                .OrderBy(_ => _.Name)
-                .ToListAsync());
-    }
-
     #region Added
 
     [Test]

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

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

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

@@ -11,21 +11,6 @@ public static IQueryable<object> AsNoTracking(this IQueryable<object> set, Type
         return (IQueryable<object>) genericNoTracking.Invoke(null, [set])!;
     }
 
-    public static string? NameOrAlias(this TableExpressionBase tableExpressionBase)
-    {
-        if (tableExpressionBase.Alias != null)
-        {
-            return tableExpressionBase.Alias;
-        }
-
-        if (tableExpressionBase is TableExpression tableExpression)
-        {
-            return tableExpression.Name;
-        }
-
-        return null;
-    }
-
     public static IQueryable<object> Set(this DbContext data, Type t) =>
         (IQueryable<object>) setMethod
             .MakeGenericMethod(t)