add orderby callback

SimonCropp · SimonCropp · commit e6a2dec42461 · 2024-10-29T13:52:39.000+11:00
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <NoWarn>CS1591;NU5104;CS1573;CS9107</NoWarn>
-    <Version>27.2.2</Version>
+    <Version>28.0.0-beta.1</Version>
     <LangVersion>preview</LangVersion>
     <AssemblyVersion>1.0.0</AssemblyVersion>
     <PackageTags>EntityFrameworkCore, EntityFramework, GraphQL</PackageTags>
diff --git a/src/GraphQL.EntityFramework/GraphApi/EfGraphQLService_Queryable.cs b/src/GraphQL.EntityFramework/GraphApi/EfGraphQLService_Queryable.cs
@@ -8,10 +8,11 @@ public FieldBuilder<object, TReturn> AddQueryField<TReturn>(
         string name,
         Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>>? resolve = null,
         Type? graphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class
     {
-        var field = BuildQueryField(graphType, name, resolve, omitQueryArguments);
+        var field = BuildQueryField(graphType, name, resolve, omitQueryArguments, orderBy);
         graph.AddField(field);
         return new FieldBuilderEx<object, TReturn>(field);
     }
@@ -21,10 +22,11 @@ public FieldBuilder<TSource, TReturn> AddQueryField<TSource, TReturn>(
         string name,
         Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>>? resolve = null,
         Type? itemGraphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class
     {
-        var field = BuildQueryField(itemGraphType, name, resolve, omitQueryArguments);
+        var field = BuildQueryField(itemGraphType, name, resolve, omitQueryArguments, orderBy);
         graph.AddField(field);
         return new FieldBuilderEx<TSource, TReturn>(field);
     }
@@ -33,7 +35,8 @@ FieldType BuildQueryField<TSource, TReturn>(
         Type? itemGraphType,
         string name,
         Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>>? resolve,
-        bool omitQueryArguments)
+        bool omitQueryArguments,
+        Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy)
         where TReturn : class
     {
         Guard.AgainstWhiteSpace(nameof(name), name);
@@ -65,6 +68,11 @@ FieldType BuildQueryField<TSource, TReturn>(
                         query = query.ApplyGraphQlArguments(context, names, true, omitQueryArguments);
                     }
 
+                    if(orderBy is not null)
+                    {
+                        query = orderBy(fieldContext, query);
+                    }
+
                     QueryLogger.Write(query);
 
                     List<TReturn> list;
diff --git a/src/GraphQL.EntityFramework/GraphApi/EfInterfaceGraphType.cs b/src/GraphQL.EntityFramework/GraphApi/EfInterfaceGraphType.cs
@@ -38,9 +38,10 @@ public ConnectionBuilder<TSource> AddQueryConnectionField<TReturn>(
     public FieldBuilder<object, TReturn> AddQueryField<TReturn>(
         string name,
         Type? graphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class =>
-        GraphQlService.AddQueryField<TReturn>(this, name, null, graphType, omitQueryArguments);
+        GraphQlService.AddQueryField(this, name, null, graphType, omitQueryArguments, orderBy);
 
     public TDbContext ResolveDbContext(IResolveFieldContext<TSource> context) =>
         GraphQlService.ResolveDbContext(context);
diff --git a/src/GraphQL.EntityFramework/GraphApi/EfObjectGraphType.cs b/src/GraphQL.EntityFramework/GraphApi/EfObjectGraphType.cs
@@ -54,9 +54,10 @@ public FieldBuilder<TSource, TReturn> AddQueryField<TReturn>(
         string name,
         Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>> resolve,
         Type? graphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class =>
-        GraphQlService.AddQueryField(this, name, resolve, graphType, omitQueryArguments);
+        GraphQlService.AddQueryField(this, name, resolve, graphType, omitQueryArguments, orderBy);
 
     public TDbContext ResolveDbContext(IResolveFieldContext<TSource> context) =>
         GraphQlService.ResolveDbContext(context);
diff --git a/src/GraphQL.EntityFramework/GraphApi/IEfGraphQLService_Queryable.cs b/src/GraphQL.EntityFramework/GraphApi/IEfGraphQLService_Queryable.cs
@@ -7,14 +7,16 @@ FieldBuilder<object, TReturn> AddQueryField<TReturn>(
         string name,
         Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>>? resolve = null,
         Type? itemGraphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class;
 
     FieldBuilder<TSource, TReturn> AddQueryField<TSource, TReturn>(
         IComplexGraphType graph,
         string name,
         Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>>? resolve = null,
         Type? itemGraphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, TSource>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class;
 }
diff --git a/src/GraphQL.EntityFramework/GraphApi/QueryGraphType.cs b/src/GraphQL.EntityFramework/GraphApi/QueryGraphType.cs
@@ -23,9 +23,10 @@ public FieldBuilder<object, TReturn> AddQueryField<TReturn>(
         string name,
         Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>> resolve,
         Type? graphType = null,
-        bool omitQueryArguments = false)
+        bool omitQueryArguments = false,
+        Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>, IOrderedQueryable<TReturn>>? orderBy = null)
         where TReturn : class =>
-        GraphQlService.AddQueryField(this, name, resolve, graphType, omitQueryArguments);
+        GraphQlService.AddQueryField(this, name, resolve, graphType, omitQueryArguments, orderBy);
 
     public FieldBuilder<object, TReturn> AddSingleField<TReturn>(
         Func<ResolveEfFieldContext<TDbContext, object>, IQueryable<TReturn>> resolve,
diff --git a/src/Tests/IntegrationTests/Graphs/CustomOrder/CustomOrderChildEntity.cs b/src/Tests/IntegrationTests/Graphs/CustomOrder/CustomOrderChildEntity.cs
@@ -1,6 +1,7 @@
 ﻿public class CustomOrderChildEntity
 {
     public Guid Id { get; set; } = Guid.NewGuid();
+    public string? Property { get; set; }
     public Guid? ParentId { get; set; }
     public CustomOrderParentEntity? Parent { get; set; }
 }
diff --git a/src/Tests/IntegrationTests/Graphs/CustomOrder/CustomOrderParentGraphType.cs b/src/Tests/IntegrationTests/Graphs/CustomOrder/CustomOrderParentGraphType.cs
@@ -1,7 +1,8 @@
 ﻿public class CustomOrderParentGraphType :
     EfObjectGraphType<IntegrationDbContext, CustomOrderParentEntity>
 {
-    public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQlService) :
+    public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQlService)
+        :
         base(graphQlService)
     {
         AddQueryField(
@@ -11,7 +12,8 @@ public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQ
                 var parentId = context.Source.Id;
                 return context.DbContext.CustomOrderChildEntities
                     .Where(_ => _.ParentId == parentId);
-            });
+            },
+            orderBy: (context, query) => query.OrderBy(_ => _.Property));
         AutoMap();
     }
 }
diff --git a/src/Tests/IntegrationTests/IntegrationTests.CustomOrder.verified.txt b/src/Tests/IntegrationTests/IntegrationTests.CustomOrder.verified.txt
@@ -6,17 +6,20 @@
       {
         "customOrderChildren": [
           {
-            "id": "Guid_1"
+            "id": "Guid_1",
+            "property": "Value2"
           },
           {
-            "id": "Guid_2"
+            "id": "Guid_2",
+            "property": "Value3"
           }
         ]
       },
       {
         "customOrderChildren": [
           {
-            "id": "Guid_3"
+            "id": "Guid_3",
+            "property": "Value5"
           }
         ]
       }
@@ -32,9 +35,10 @@ FROM [CustomOrderParentEntities] AS [c],
     },
     {
       Text:
-SELECT [c].[Id], [c].[ParentId]
+SELECT [c].[Id], [c].[ParentId], [c].[Property]
 FROM [CustomOrderChildEntities] AS [c]
-WHERE [c].[ParentId] = @__parentId_0,
+WHERE [c].[ParentId] = @__parentId_0
+ORDER BY [c].[Property],
       Parameters: {
         @__parentId_0: {
           Value: Guid_4,
@@ -45,9 +49,10 @@ WHERE [c].[ParentId] = @__parentId_0,
     },
     {
       Text:
-SELECT [c].[Id], [c].[ParentId]
+SELECT [c].[Id], [c].[ParentId], [c].[Property]
 FROM [CustomOrderChildEntities] AS [c]
-WHERE [c].[ParentId] = @__parentId_0,
+WHERE [c].[ParentId] = @__parentId_0
+ORDER BY [c].[Property],
       Parameters: {
         @__parentId_0: {
           Value: Guid_5,
diff --git a/src/Tests/IntegrationTests/IntegrationTests.SchemaPrint.verified.txt b/src/Tests/IntegrationTests/IntegrationTests.SchemaPrint.verified.txt
@@ -230,6 +230,7 @@ type CustomOrderChild {
   parent: CustomOrderParent
   id: ID!
   parentId: ID
+  property: String
 }
 
 type Parent {
diff --git a/src/Tests/IntegrationTests/IntegrationTests.cs b/src/Tests/IntegrationTests/IntegrationTests.cs
@@ -2524,7 +2524,8 @@ public async Task CustomOrder()
               {
                 customOrderChildren
                 {
-                  id
+                  id,
+                  property
                 }
               }
             }
@@ -2533,18 +2534,21 @@ public async Task CustomOrder()
         var entity1 = new CustomOrderParentEntity();
         var entity2 = new CustomOrderChildEntity
         {
-            Parent = entity1
+            Parent = entity1,
+            Property = "Value2"
         };
         var entity3 = new CustomOrderChildEntity
         {
-            Parent = entity1
+            Parent = entity1,
+            Property = "Value3"
         };
         entity1.Children.Add(entity2);
         entity1.Children.Add(entity3);
         var entity4 = new CustomOrderParentEntity();
         var entity5 = new CustomOrderChildEntity
         {
-            Parent = entity4
+            Parent = entity4,
+            Property = "Value5"
         };
         entity4.Children.Add(entity5);
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`public class CustomOrderChildEntity`
`2`	`2`	`{`
`3`	`3`	`public Guid Id { get; set; } = Guid.NewGuid();`
	`4`	`+ public string? Property { get; set; }`
`4`	`5`	`public Guid? ParentId { get; set; }`
`5`	`6`	`public CustomOrderParentEntity? Parent { get; set; }`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`public class CustomOrderParentGraphType :`
`2`	`2`	`EfObjectGraphType<IntegrationDbContext, CustomOrderParentEntity>`
`3`	`3`	`{`
`4`		`- public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQlService) :`
	`4`	`+ public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQlService)`
	`5`	`+ :`
`5`	`6`	`base(graphQlService)`
`6`	`7`	`{`
`7`	`8`	`AddQueryField(`
`@@ -11,7 +12,8 @@ public CustomOrderParentGraphType(IEfGraphQLService<IntegrationDbContext> graphQ`
`11`	`12`	`var parentId = context.Source.Id;`
`12`	`13`	`return context.DbContext.CustomOrderChildEntities`
`13`	`14`	`.Where(_ => _.ParentId == parentId);`
`14`		`- });`
	`15`	`+ },`
	`16`	`+ orderBy: (context, query) => query.OrderBy(_ => _.Property));`
`15`	`17`	`AutoMap();`
`16`	`18`	`}`
`17`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,17 +6,20 @@`
`6`	`6`	`{`
`7`	`7`	`"customOrderChildren": [`
`8`	`8`	`{`
`9`		`- "id": "Guid_1"`
	`9`	`+ "id": "Guid_1",`
	`10`	`+ "property": "Value2"`
`10`	`11`	`},`
`11`	`12`	`{`
`12`		`- "id": "Guid_2"`
	`13`	`+ "id": "Guid_2",`
	`14`	`+ "property": "Value3"`
`13`	`15`	`}`
`14`	`16`	`]`
`15`	`17`	`},`
`16`	`18`	`{`
`17`	`19`	`"customOrderChildren": [`
`18`	`20`	`{`
`19`		`- "id": "Guid_3"`
	`21`	`+ "id": "Guid_3",`
	`22`	`+ "property": "Value5"`
`20`	`23`	`}`
`21`	`24`	`]`
`22`	`25`	`}`
`@@ -32,9 +35,10 @@ FROM [CustomOrderParentEntities] AS [c],`
`32`	`35`	`},`
`33`	`36`	`{`
`34`	`37`	`Text:`
`35`		`-SELECT [c].[Id], [c].[ParentId]`
	`38`	`+SELECT [c].[Id], [c].[ParentId], [c].[Property]`
`36`	`39`	`FROM [CustomOrderChildEntities] AS [c]`
`37`		`-WHERE [c].[ParentId] = @__parentId_0,`
	`40`	`+WHERE [c].[ParentId] = @__parentId_0`
	`41`	`+ORDER BY [c].[Property],`
`38`	`42`	`Parameters: {`
`39`	`43`	`@__parentId_0: {`
`40`	`44`	`Value: Guid_4,`
`@@ -45,9 +49,10 @@ WHERE [c].[ParentId] = @__parentId_0,`
`45`	`49`	`},`
`46`	`50`	`{`
`47`	`51`	`Text:`
`48`		`-SELECT [c].[Id], [c].[ParentId]`
	`52`	`+SELECT [c].[Id], [c].[ParentId], [c].[Property]`
`49`	`53`	`FROM [CustomOrderChildEntities] AS [c]`
`50`		`-WHERE [c].[ParentId] = @__parentId_0,`
	`54`	`+WHERE [c].[ParentId] = @__parentId_0`
	`55`	`+ORDER BY [c].[Property],`
`51`	`56`	`Parameters: {`
`52`	`57`	`@__parentId_0: {`
`53`	`58`	`Value: Guid_5,`
Original file line number	Diff line number	Diff line change
`@@ -230,6 +230,7 @@ type CustomOrderChild {`
`230`	`230`	`parent: CustomOrderParent`
`231`	`231`	`id: ID!`
`232`	`232`	`parentId: ID`
	`233`	`+ property: String`
`233`	`234`	`}`
`234`	`235`
`235`	`236`	`type Parent {`