Simplified extending pagination pipelines. (#6921)

ChilliCream · Feb 19, 2024 · 1f34422 · 1f34422
1 parent 85c1d03
commit 1f34422
Show file tree

Hide file tree

Showing 10 changed files with 86 additions and 19 deletions.
diff --git a/src/HotChocolate/Core/src/Abstractions/SetState.cs b/src/HotChocolate/Core/src/Abstractions/SetState.cs
@@ -1,5 +1,5 @@
 namespace HotChocolate;
 
-public delegate void SetState<T>(T value);
+public delegate void SetState<in T>(T value);
 
 public delegate void SetState(object value);
diff --git a/src/HotChocolate/Core/src/Abstractions/WellKnownContextData.cs b/src/HotChocolate/Core/src/Abstractions/WellKnownContextData.cs
@@ -289,4 +289,9 @@ public static class WellKnownContextData
     /// Type key to access the internal schema options.
     /// </summary>
     public const string InternalSchemaOptions = "HotChocolate.Types.InternalSchemaOptions";
+
+    /// <summary>
+    /// Type key to access the paging arguments in the local resolver state.
+    /// </summary>
+    public const string PagingArguments = "HotChocolate.Types.PagingArguments";
 }
diff --git a/src/HotChocolate/Core/src/Types.CursorPagination/CursorPagingArguments.cs b/src/HotChocolate/Core/src/Types.CursorPagination/CursorPagingArguments.cs
@@ -1,12 +1,14 @@
-#nullable enable
-
 namespace HotChocolate.Types.Pagination;
 
 /// <summary>
 /// The cursor paging arguments are used to specify the
 /// paging behavior of the cursor based paging handler.
 /// </summary>
+#if NET6_0_OR_GREATER
+public readonly record struct CursorPagingArguments
+#else
 public readonly struct CursorPagingArguments
+#endif
 {
     /// <summary>
     /// Initializes a new instance of <see cref="CursorPagingArguments"/>.

diff --git a/src/HotChocolate/Core/src/Types.CursorPagination/CursorPagingHandler.cs b/src/HotChocolate/Core/src/Types.CursorPagination/CursorPagingHandler.cs
@@ -89,9 +89,7 @@ public void ValidateContext(IResolverContext context)
         }
     }
 
-    async ValueTask<IPage> IPagingHandler.SliceAsync(
-        IResolverContext context,
-        object source)
+    public void PublishPagingArguments(IResolverContext context)
     {
         var first = context.ArgumentValue<int?>(CursorPagingArgumentNames.First);
         var last = AllowBackwardPagination
@@ -110,7 +108,15 @@ async ValueTask<IPage> IPagingHandler.SliceAsync(
             AllowBackwardPagination
                 ? context.ArgumentValue<string?>(CursorPagingArgumentNames.Before)
                 : null);
+
+        context.SetLocalState(WellKnownContextData.PagingArguments, arguments);
+    }
 
+    async ValueTask<IPage> IPagingHandler.SliceAsync(
+        IResolverContext context,
+        object source)
+    {
+        var arguments = context.GetLocalState<CursorPagingArguments>(WellKnownContextData.PagingArguments);   
         return await SliceAsync(context, source, arguments).ConfigureAwait(false);
     }
 

diff --git a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs
@@ -76,14 +76,19 @@ public void ValidateContext(IResolverContext context)
         }
     }
 
-    async ValueTask<IPage> IPagingHandler.SliceAsync(
-        IResolverContext context,
-        object source)
+    public void PublishPagingArguments(IResolverContext context)
     {
         var skip = context.ArgumentValue<int?>(OffsetPagingArgumentNames.Skip);
         var take = context.ArgumentValue<int?>(OffsetPagingArgumentNames.Take);
         var arguments = new OffsetPagingArguments(skip, take ?? DefaultPageSize);
+        context.SetLocalState(WellKnownContextData.PagingArguments, arguments);
+    }
 
+    async ValueTask<IPage> IPagingHandler.SliceAsync(
+        IResolverContext context,
+        object source)
+    {
+        var arguments =context.GetLocalState<OffsetPagingArguments>(WellKnownContextData.PagingArguments);
         return await SliceAsync(context, source, arguments).ConfigureAwait(false);
     }
 

diff --git a/src/HotChocolate/Core/src/Types/SchemaBuilder.cs b/src/HotChocolate/Core/src/Types/SchemaBuilder.cs
@@ -7,8 +7,10 @@
 using HotChocolate.Resolvers;
 using HotChocolate.Types;
 using HotChocolate.Types.Descriptors;
+using HotChocolate.Types.Descriptors.Definitions;
 using HotChocolate.Types.Interceptors;
 using HotChocolate.Types.Introspection;
+using HotChocolate.Types.Pagination;
 using HotChocolate.Utilities;
 
 #nullable enable
@@ -451,4 +453,24 @@ public ISchemaBuilder TryAddTypeInterceptor(TypeInterceptor interceptor)
     /// Returns a new instance of <see cref="SchemaBuilder"/>.
     /// </returns>
     public static SchemaBuilder New() => new();
+
+    private sealed class CopyOptions : TypeInterceptor
+    {
+        public override void OnBeforeCompleteType(ITypeCompletionContext completionContext, DefinitionBase definition)
+        {
+            if (definition is SchemaTypeDefinition schemaDef)
+            {
+                var key = typeof(PagingOptions).FullName!;
+
+                if (completionContext.DescriptorContext.ContextData.TryGetValue(key, out var value))
+                {
+                    schemaDef.ContextData[key] = value;
+                }
+                else
+                {
+                    schemaDef.ContextData[key] = new PagingOptions();
+                }
+            }
+        }
+    }
 }
diff --git a/src/HotChocolate/Core/src/Types/Types/Pagination/IPagingHandler.cs b/src/HotChocolate/Core/src/Types/Types/Pagination/IPagingHandler.cs
@@ -5,6 +5,9 @@
 
 namespace HotChocolate.Types.Pagination;
 
+/// <summary>
+/// The paging handler is used in the paging middleware to abstract the actual paging logic.
+/// </summary>
 public interface IPagingHandler
 {
     /// <summary>
@@ -19,6 +22,14 @@ public interface IPagingHandler
     /// </exception>
     void ValidateContext(IResolverContext context);
 
+    /// <summary>
+    /// Publish Paging Arguments to local state.
+    /// </summary>
+    /// <param name="context">
+    /// The current resolver context.
+    /// </param>
+    void PublishPagingArguments(IResolverContext context);
+
     /// <summary>
     /// Slices the <paramref name="source"/> and returns a page from it.
     /// </summary>

diff --git a/src/HotChocolate/Core/src/Types/Types/Pagination/PagingHelper.cs b/src/HotChocolate/Core/src/Types/Types/Pagination/PagingHelper.cs
@@ -107,10 +107,12 @@ IExtendedType ResolveType()
     }
 
     private static FieldMiddleware CreateMiddleware(
-        IPagingHandler handler) =>
-        FieldClassMiddlewareFactory.Create(
-            typeof(PagingMiddleware),
-            (typeof(IPagingHandler), handler));
+        IPagingHandler handler)
+        => next =>
+        {
+            var middleware = new PagingMiddleware(next, handler);
+            return context => middleware.InvokeAsync(context);
+        };
 
     public static IExtendedType GetSchemaType(
         IDescriptorContext context,

diff --git a/src/HotChocolate/Core/src/Types/Types/Pagination/PagingMiddleware.cs b/src/HotChocolate/Core/src/Types/Types/Pagination/PagingMiddleware.cs
@@ -13,12 +13,14 @@ public class PagingMiddleware(FieldDelegate next, IPagingHandler pagingHandler)
     private readonly IPagingHandler _pagingHandler = pagingHandler ??
         throw new ArgumentNullException(nameof(pagingHandler));
 
-    public async Task InvokeAsync(IMiddlewareContext context)
+    public async ValueTask InvokeAsync(IMiddlewareContext context)
     {
         _pagingHandler.ValidateContext(context);
+        _pagingHandler.PublishPagingArguments(context);
 
         await _next(context).ConfigureAwait(false);
 
+        // if the result is a field result we gonna unwrap it.
         if (context.Result is IFieldResult fieldResult)
         {
             if (fieldResult.IsError)

diff --git a/...HotChocolate/Core/test/Types.CursorPagination.Tests/QueryableCursorPagingProviderTests.cs b/...HotChocolate/Core/test/Types.CursorPagination.Tests/QueryableCursorPagingProviderTests.cs
@@ -34,6 +34,7 @@ public async Task TakeFirst()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -75,6 +76,7 @@ public async Task TakeLastSingle()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -110,6 +112,7 @@ public async Task TakeLast()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -148,12 +151,14 @@ public async Task TakeFirstAfter()
 
         var pagingDetails = new CursorPagingArguments();
         var context = new MockContext(pagingDetails);
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         pagingDetails = new CursorPagingArguments(after: connection.Info.StartCursor, first: 2);
         context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -192,12 +197,14 @@ public async Task TakeLastBefore()
 
         var pagingDetails = new CursorPagingArguments(first: 5);
         var context = new MockContext(pagingDetails);
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         pagingDetails = new CursorPagingArguments(before: connection.Info.EndCursor, last: 2);
         context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -238,6 +245,7 @@ public async Task HasNextPage_True()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -260,6 +268,7 @@ public async Task HasNextPage_False()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -280,12 +289,15 @@ public async Task HasPrevious_True()
 
         var pagingDetails = new CursorPagingArguments(first: 1);
         var context = new MockContext(pagingDetails);
+
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         pagingDetails = new CursorPagingArguments(after: connection.Info.EndCursor, first: 2);
         context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -308,6 +320,7 @@ public async Task HasPrevious_False()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -339,6 +352,7 @@ public async Task Executable()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -388,6 +402,7 @@ public async Task Executable_Queryable()
         var context = new MockContext(pagingDetails);
 
         // act
+        pagingHandler.PublishPagingArguments(context);
         var connection = (Connection)await pagingHandler.SliceAsync(context, list);
 
         // assert
@@ -444,11 +459,8 @@ public IServiceProvider Services
             set => throw new NotImplementedException();
         }
 
-        public IImmutableDictionary<string, object?> LocalContextData
-        {
-            get => throw new NotImplementedException();
-            set => throw new NotImplementedException();
-        }
+        public IImmutableDictionary<string, object?> LocalContextData { get; set; } = 
+            ImmutableDictionary<string, object?>.Empty;
 
         public CancellationToken RequestAborted => default;