Adds Variable Batching (#6981)

Author: michaelstaib

src/CookieCrumble/src/CookieCrumble/Extensions/CommonTestExtensions.cs

@@ -16,10 +16,10 @@ public static ValueTask<IRequestExecutor> CreateExceptionExecutor(
                 if (context.ContextData.TryGetValue("ex", out var queryString))
                 {
                     context.Result =
-                        QueryResultBuilder
+                        OperationResultBuilder
                             .FromResult(context.Result!.ExpectQueryResult())
                             .SetContextData("ex", queryString)
-                            .Create();
+                            .Build();
                 }
             })
             .UseDefaultPipeline()

src/CookieCrumble/src/CookieCrumble/Extensions/WriterExtensions.cs

@@ -20,6 +20,17 @@ public static void AppendLine(this IBufferWriter<byte> snapshot)
         snapshot.GetSpan(1)[0] = (byte)'\n';
         snapshot.Advance(1);
     }
+    
+    public static void AppendLine(this IBufferWriter<byte> snapshot, bool appendWhenTrue)
+    {
+        if (!appendWhenTrue)
+        {
+            return;
+        }
+        
+        snapshot.GetSpan(1)[0] = (byte)'\n';
+        snapshot.Advance(1);
+    }
 
     public static void AppendSeparator(this IBufferWriter<byte> snapshot)
     {

src/CookieCrumble/src/CookieCrumble/Formatters/OperationResultSnapshotValueFormatter.cs

@@ -8,24 +8,43 @@ internal sealed class OperationResultSnapshotValueFormatter : SnapshotValueForma
 {
     protected override void Format(IBufferWriter<byte> snapshot, OperationResult value)
     {
+        var next = false;
+        
+        if(value.RequestIndex.HasValue)
+        {
+            snapshot.Append("RequestIndex: ");
+            snapshot.Append(value.RequestIndex.Value.ToString());
+            next = true;
+        }
+        
+        if(value.VariableIndex.HasValue)
+        {
+            snapshot.AppendLine(appendWhenTrue: next);   
+            snapshot.Append("VariableIndex: ");
+            snapshot.Append(value.VariableIndex.Value.ToString());
+            next = true;
+        }
+        
         if (value.Data.ValueKind is JsonValueKind.Object)
         {
-            snapshot.Append("Data:");
-            snapshot.AppendLine();
+            snapshot.AppendLine(appendWhenTrue: next);
+            snapshot.Append("Data: ");
             snapshot.Append(value.Data.ToString());
+            next = true;
         }
 
         if (value.Errors.ValueKind is JsonValueKind.Array)
         {
-            snapshot.Append("Errors:");
-            snapshot.AppendLine();
+            snapshot.AppendLine(appendWhenTrue: next);
+            snapshot.Append("Errors: ");
             snapshot.Append(value.Errors.ToString());
+            next = true;
         }
 
         if (value.Extensions.ValueKind is JsonValueKind.Object)
         {
-            snapshot.Append("Extensions:");
-            snapshot.AppendLine();
+            snapshot.AppendLine(appendWhenTrue: next);
+            snapshot.Append("Extensions: ");
             snapshot.Append(value.Extensions.ToString());
         }
     }

src/HotChocolate/ApolloFederation/test/ApolloFederation.Tests/CertificationSchema/AnnotationBased/CertificationTests.cs

@@ -33,7 +33,7 @@ public async Task Subgraph_SDL()
         // assert
         Assert.IsType<ObjectResult>(
             Assert.IsType<ObjectResult>(
-                Assert.IsType<QueryResult>(result).Data)
+                Assert.IsType<OperationResult>(result).Data)
                     .GetValueOrDefault("_service"))
                         .GetValueOrDefault("sdl")
                             .MatchSnapshot();

src/HotChocolate/ApolloFederation/test/ApolloFederation.Tests/CertificationSchema/CodeFirst/CertificationTests.cs

@@ -33,7 +33,7 @@ public async Task Subgraph_SDL()
             """);
 
         // assert
-        var queryResult = Assert.IsType<QueryResult>(result);
+        var queryResult = Assert.IsType<OperationResult>(result);
         var data = Assert.IsType<ObjectResult>(queryResult.Data);
         var service = Assert.IsType<ObjectResult>(data.GetValueOrDefault("_service"));
         service.GetValueOrDefault("sdl").MatchSnapshot();

src/HotChocolate/AspNetCore/src/AspNetCore/DefaultHttpRequestInterceptor.cs

@@ -13,7 +13,7 @@ public class DefaultHttpRequestInterceptor : IHttpRequestInterceptor
     public virtual ValueTask OnCreateAsync(
         HttpContext context,
         IRequestExecutor requestExecutor,
-        IQueryRequestBuilder requestBuilder,
+        OperationRequestBuilder requestBuilder,
         CancellationToken cancellationToken)
     {
         var userState = new UserState(context.User);

src/HotChocolate/AspNetCore/src/AspNetCore/DefaultSocketSessionInterceptor.cs

@@ -18,13 +18,13 @@ public virtual ValueTask<ConnectionStatus> OnConnectAsync(
     public virtual ValueTask OnRequestAsync(
         ISocketSession session,
         string operationSessionId,
-        IQueryRequestBuilder requestBuilder,
+        OperationRequestBuilder requestBuilder,
         CancellationToken cancellationToken = default)
     {
         var context = session.Connection.HttpContext;
         var userState = new UserState(context.User);
         var serviceScopeFactory = session.Connection.RequestServices.GetService<IServiceScopeFactory>();
-        
+
         requestBuilder.TryAddGlobalState(nameof(IServiceScopeFactory), serviceScopeFactory);
         requestBuilder.TryAddGlobalState(nameof(CancellationToken), session.Connection.RequestAborted);
         requestBuilder.TryAddGlobalState(nameof(HttpContext), context);
@@ -47,10 +47,10 @@ public virtual ValueTask OnRequestAsync(
         return default;
     }
 
-    public virtual ValueTask<IQueryResult> OnResultAsync(
+    public virtual ValueTask<IOperationResult> OnResultAsync(
         ISocketSession session,
         string operationSessionId,
-        IQueryResult result,
+        IOperationResult result,
         CancellationToken cancellationToken = default)
         => new(result);
 

src/HotChocolate/AspNetCore/src/AspNetCore/DelegateHttpRequestInterceptor.cs

@@ -14,7 +14,7 @@ public DelegateHttpRequestInterceptor(HttpRequestInterceptorDelegate interceptor
     public override async ValueTask OnCreateAsync(
         HttpContext context,
         IRequestExecutor requestExecutor,
-        IQueryRequestBuilder requestBuilder,
+        OperationRequestBuilder requestBuilder,
         CancellationToken cancellationToken)
     {
         await _interceptor(context, requestExecutor, requestBuilder, cancellationToken);

src/HotChocolate/AspNetCore/src/AspNetCore/ErrorHelper.cs

@@ -25,14 +25,14 @@ public static IError NoSupportedAcceptMediaType()
             .SetCode(ErrorCodes.Server.NoSupportedAcceptMediaType)
             .Build();
 
-    public static IQueryResult TypeNameIsEmpty()
-        => QueryResultBuilder.CreateError(
+    public static IOperationResult TypeNameIsEmpty()
+        => OperationResultBuilder.CreateError(
             new Error(
                 ErrorHelper_TypeNameIsEmpty,
                 code: ErrorCodes.Server.TypeParameterIsEmpty));
 
-    public static IQueryResult InvalidTypeName(string typeName)
-        => QueryResultBuilder.CreateError(
+    public static IOperationResult InvalidTypeName(string typeName)
+        => OperationResultBuilder.CreateError(
             new Error(
                 ErrorHelper_InvalidTypeName,
                 code: ErrorCodes.Server.InvalidTypeName,
@@ -41,8 +41,8 @@ public static IQueryResult InvalidTypeName(string typeName)
                     { nameof(typeName), typeName },
                 }));
 
-    public static IQueryResult TypeNotFound(string typeName)
-        => QueryResultBuilder.CreateError(
+    public static IOperationResult TypeNotFound(string typeName)
+        => OperationResultBuilder.CreateError(
             new Error(
                 string.Format(ErrorHelper_TypeNotFound, typeName),
                 code: ErrorCodes.Server.TypeDoesNotExist,
@@ -51,8 +51,8 @@ public static IQueryResult TypeNotFound(string typeName)
                     { nameof(typeName), typeName },
                 }));
 
-    public static IQueryResult InvalidAcceptMediaType(string headerValue)
-        => QueryResultBuilder.CreateError(
+    public static IOperationResult InvalidAcceptMediaType(string headerValue)
+        => OperationResultBuilder.CreateError(
             new Error(
                 string.Format(ErrorHelper_InvalidAcceptMediaType, headerValue),
                 code: ErrorCodes.Server.InvalidAcceptHeaderValue,
@@ -61,8 +61,8 @@ public static IQueryResult InvalidAcceptMediaType(string headerValue)
                     { nameof(headerValue), headerValue },
                 }));
 
-    public static IQueryResult MultiPartRequestPreflightRequired()
-        => QueryResultBuilder.CreateError(
+    public static IOperationResult MultiPartRequestPreflightRequired()
+        => OperationResultBuilder.CreateError(
             new Error(
                 ErrorHelper_MultiPartRequestPreflightRequired,
                 code: ErrorCodes.Server.MultiPartPreflightRequired));

src/HotChocolate/AspNetCore/src/AspNetCore/HeaderUtilities.cs

@@ -165,7 +165,7 @@ public AcceptHeaderResult(string headerValue)
 
         public AcceptMediaType[] AcceptMediaTypes { get; }
 
-        public IQueryResult? ErrorResult { get; }
+        public IOperationResult? ErrorResult { get; }
 
         [MemberNotNullWhen(true, nameof(ErrorResult))]
         public bool HasError { get; }