WIP Add paging to comments field

TODO: Tests I've specified a maximum page size to provide some protection against excessively large queries.
smfeest · Oct 6, 2024 · a3fac53 · a3fac53
1 parent 288a44c
commit a3fac53
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 14 deletions.
diff --git a/src/Buttercup.Web.Tests/Api/CommentsTests.cs b/src/Buttercup.Web.Tests/Api/CommentsTests.cs
@@ -9,14 +9,16 @@ public sealed class CommentsTests(AppFactory appFactory) : EndToEndTests(appFact
     private const string CommentsQuery = """
         query {
             comments {
-                id
-                recipe { id title }
-                author { id name }
-                body
-                created
-                modified
-                revision
-                revisions { revision created body }
+                nodes {
+                    id
+                    recipe { id title }
+                    author { id name }
+                    body
+                    created
+                    modified
+                    revision
+                    revisions { revision created body }
+                }
             }
         }
         """;
@@ -56,7 +58,7 @@ public async Task QueryingComments()
             }),
         });
 
-        JsonAssert.Equivalent(expected, dataElement.GetProperty("comments"));
+        JsonAssert.Equivalent(expected, dataElement.GetProperty("comments").GetProperty("nodes"));
     }
 
     [Fact]
@@ -66,7 +68,7 @@ public async Task QueryingCommentsWhenUnauthenticated()
         using var response = await client.PostQuery(CommentsQuery);
         using var document = await response.Content.ReadAsJsonDocument();
 
-        JsonAssert.ValueIsNull(document.RootElement.GetProperty("data"));
+        JsonAssert.ValueIsNull(document.RootElement.GetProperty("data").GetProperty("comments"));
         ApiAssert.HasSingleError(ErrorCodes.Authentication.NotAuthorized, document);
     }
 
@@ -90,13 +92,17 @@ public async Task SortingComments()
         using var client = await this.AppFactory.CreateClientForApiUser(currentUser);
         using var response = await client.PostQuery("""
             query {
-                comments(order: { created: ASC }) { id }
+                comments(order: { created: ASC }) {
+                    nodes {
+                        id
+                    }
+                }
             }
             """);
         using var document = await response.Content.ReadAsJsonDocument();
 
         var dataElement = ApiAssert.SuccessResponse(document);
-        var ids = dataElement.GetProperty("comments").EnumerateArray().Select(
+        var ids = dataElement.GetProperty("comments").GetProperty("nodes").EnumerateArray().Select(
             c => c.GetProperty("id").GetInt64());
 
         Assert.Equal([1, 3, 2], ids);
@@ -111,12 +117,16 @@ public async Task SortingCommentsByAdminOnlyUserFieldsWhenNotAnAdmin()
         using var client = await this.AppFactory.CreateClientForApiUser(currentUser);
         using var response = await client.PostQuery("""
             query {
-                comments(order: { author: { email: ASC } }) { id }
+                comments(order: { author: { email: ASC } }) {
+                    nodes {
+                        id
+                    }
+                }
             }
             """);
         using var document = await response.Content.ReadAsJsonDocument();
 
-        JsonAssert.ValueIsNull(document.RootElement.GetProperty("data"));
+        JsonAssert.ValueIsNull(document.RootElement.GetProperty("data").GetProperty("comments"));
         ApiAssert.HasSingleError(ErrorCodes.Authentication.NotAuthorized, document);
     }
 }
diff --git a/src/Buttercup.Web/Api/Query.cs b/src/Buttercup.Web/Api/Query.cs
@@ -11,6 +11,7 @@ public sealed class Query
 {
     [Authorize]
     [Authorize(AuthorizationPolicyNames.AdminOnlyFilterAndSortFields)]
+    [UsePaging(MaxPageSize = 500)]
     [UseProjection]
     [UseFiltering]
     [UseSorting]