Adds Variable Batching (#6981)

ChilliCream · May 22, 2024 · a162880 · a162880
1 parent 9d1e3ce
commit a162880
Show file tree

Hide file tree

Showing 653 changed files with 15,331 additions and 19,577 deletions.
diff --git a/src/CookieCrumble/src/CookieCrumble/Extensions/CommonTestExtensions.cs b/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()

diff --git a/src/CookieCrumble/src/CookieCrumble/Extensions/WriterExtensions.cs b/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)
     {

diff --git a/src/CookieCrumble/src/CookieCrumble/Formatters/OperationResultSnapshotValueFormatter.cs b/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());
         }
     }

diff --git a/...ion/test/ApolloFederation.Tests/CertificationSchema/AnnotationBased/CertificationTests.cs b/...ion/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();

diff --git a/...ederation/test/ApolloFederation.Tests/CertificationSchema/CodeFirst/CertificationTests.cs b/...ederation/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();

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/DefaultHttpRequestInterceptor.cs b/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);

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/DefaultSocketSessionInterceptor.cs b/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);
 

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/DelegateHttpRequestInterceptor.cs b/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);

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/ErrorHelper.cs b/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));

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/HeaderUtilities.cs b/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; }

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/HttpMultipartMiddleware.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/HttpMultipartMiddleware.cs
@@ -18,7 +18,7 @@ public sealed class HttpMultipartMiddleware : HttpPostMiddlewareBase
     private const string _operations = "operations";
     private const string _map = "map";
     private readonly FormOptions _formOptions;
-    private readonly IQueryResult _multipartRequestError = MultiPartRequestPreflightRequired();
+    private readonly IOperationResult _multipartRequestError = MultiPartRequestPreflightRequired();
 
     public HttpMultipartMiddleware(
         HttpRequestDelegate next,
@@ -185,7 +185,7 @@ private static void InsertFilesIntoRequest(
         GraphQLRequest request,
         IDictionary<string, IFile> fileMap)
     {
-        if (!(request.Variables is Dictionary<string, object?> mutableVariables))
+        if (request.Variables is not [Dictionary<string, object?> mutableVariables,])
         {
             throw new InvalidOperationException(
                 HttpMultipartMiddleware_InsertFilesIntoRequest_VariablesImmutable);

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/HttpPostMiddlewareBase.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/HttpPostMiddlewareBase.cs
@@ -99,7 +99,7 @@ protected async Task HandleRequestAsync(HttpContext context)
             statusCode = HttpStatusCode.NotAcceptable;
 
             var error = ErrorHelper.NoSupportedAcceptMediaType();
-            result = QueryResultBuilder.CreateError(error);
+            result = OperationResultBuilder.CreateError(error);
             DiagnosticEvents.HttpRequestError(context, error);
             goto HANDLE_RESULT;
         }
@@ -120,15 +120,15 @@ protected async Task HandleRequestAsync(HttpContext context)
                 // GraphQL error result.
                 statusCode = HttpStatusCode.BadRequest;
                 var errors = errorHandler.Handle(ex.Errors);
-                result = QueryResultBuilder.CreateError(errors);
+                result = OperationResultBuilder.CreateError(errors);
                 DiagnosticEvents.ParserErrors(context, errors);
                 goto HANDLE_RESULT;
             }
             catch (Exception ex)
             {
                 statusCode = HttpStatusCode.InternalServerError;
                 var error = errorHandler.CreateUnexpectedError(ex).Build();
-                result = QueryResultBuilder.CreateError(error);
+                result = OperationResultBuilder.CreateError(error);
                 DiagnosticEvents.HttpRequestError(context, error);
                 goto HANDLE_RESULT;
             }
@@ -145,7 +145,7 @@ protected async Task HandleRequestAsync(HttpContext context)
                 {
                     statusCode = HttpStatusCode.BadRequest;
                     var error = errorHandler.Handle(ErrorHelper.RequestHasNoElements());
-                    result = QueryResultBuilder.CreateError(error);
+                    result = OperationResultBuilder.CreateError(error);
                     DiagnosticEvents.HttpRequestError(context, error);
                     break;
                 }
@@ -178,7 +178,7 @@ protected async Task HandleRequestAsync(HttpContext context)
                     {
                         var error = errorHandler.Handle(ErrorHelper.InvalidRequest());
                         statusCode = HttpStatusCode.BadRequest;
-                        result = QueryResultBuilder.CreateError(error);
+                        result = OperationResultBuilder.CreateError(error);
                         DiagnosticEvents.HttpRequestError(context, error);
                     }
 
@@ -221,7 +221,7 @@ protected async Task HandleRequestAsync(HttpContext context)
                     {
                         var error = errorHandler.Handle(ErrorHelper.InvalidRequest());
                         statusCode = HttpStatusCode.BadRequest;
-                        result = QueryResultBuilder.CreateError(error);
+                        result = OperationResultBuilder.CreateError(error);
                         DiagnosticEvents.HttpRequestError(context, error);
                     }
                     break;
@@ -231,7 +231,7 @@ protected async Task HandleRequestAsync(HttpContext context)
         {
             // This allows extensions to throw GraphQL exceptions in the GraphQL interceptor.
             statusCode = null; // we let the serializer determine the status code.
-            result = QueryResultBuilder.CreateError(ex.Errors);
+            result = OperationResultBuilder.CreateError(ex.Errors);
 
             foreach (var error in ex.Errors)
             {
@@ -242,7 +242,7 @@ protected async Task HandleRequestAsync(HttpContext context)
         {
             statusCode = HttpStatusCode.InternalServerError;
             var error = errorHandler.CreateUnexpectedError(ex).Build();
-            result = QueryResultBuilder.CreateError(error);
+            result = OperationResultBuilder.CreateError(error);
             DiagnosticEvents.HttpRequestError(context, error);
         }
 
@@ -262,7 +262,7 @@ protected async Task HandleRequestAsync(HttpContext context)
             // to the HTTP response stream.
             Debug.Assert(result is not null, "No GraphQL result was created.");
 
-            if (result is IQueryResult queryResult)
+            if (result is IOperationResult queryResult)
             {
                 formatScope = DiagnosticEvents.FormatHttpResponse(context, queryResult);
             }

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/HttpRequestInterceptorDelegate.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/HttpRequestInterceptorDelegate.cs
@@ -5,5 +5,5 @@ namespace HotChocolate.AspNetCore;
 public delegate ValueTask HttpRequestInterceptorDelegate(
     HttpContext context,
     IRequestExecutor requestExecutor,
-    IQueryRequestBuilder requestBuilder,
+    OperationRequestBuilder requestBuilder,
     CancellationToken cancellationToken);
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/IHttpRequestInterceptor.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/IHttpRequestInterceptor.cs
@@ -26,6 +26,6 @@ public interface IHttpRequestInterceptor
     ValueTask OnCreateAsync(
         HttpContext context,
         IRequestExecutor requestExecutor,
-        IQueryRequestBuilder requestBuilder,
+        OperationRequestBuilder requestBuilder,
         CancellationToken cancellationToken);
 }
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/ISocketSessionInterceptor.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/ISocketSessionInterceptor.cs
@@ -47,7 +47,7 @@ ValueTask<ConnectionStatus> OnConnectAsync(
     ValueTask OnRequestAsync(
         ISocketSession session,
         string operationSessionId,
-        IQueryRequestBuilder requestBuilder,
+        OperationRequestBuilder requestBuilder,
         CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -69,10 +69,10 @@ ValueTask OnRequestAsync(
     /// <returns>
     /// Returns the result that shall be send to the client.
     /// </returns>
-    ValueTask<IQueryResult> OnResultAsync(
+    ValueTask<IOperationResult> OnResultAsync(
         ISocketSession session,
         string operationSessionId,
-        IQueryResult result,
+        IOperationResult result,
         CancellationToken cancellationToken = default);
 
     /// <summary>

diff --git a/...olate/AspNetCore/src/AspNetCore/Instrumentation/AggregateServerDiagnosticEventListener.cs b/...olate/AspNetCore/src/AspNetCore/Instrumentation/AggregateServerDiagnosticEventListener.cs
@@ -87,7 +87,7 @@ public void ParserErrors(HttpContext context, IReadOnlyList<IError> errors)
         }
     }
 
-    public IDisposable FormatHttpResponse(HttpContext context, IQueryResult result)
+    public IDisposable FormatHttpResponse(HttpContext context, IOperationResult result)
     {
         var scopes = new IDisposable[_listeners.Length];
 

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Instrumentation/IServerDiagnosticEvents.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Instrumentation/IServerDiagnosticEvents.cs
@@ -124,7 +124,7 @@ void StartOperationBatchRequest(
     /// <returns>
     /// A scope that will be disposed when GraphQL query result is written to the response stream.
     /// </returns>
-    IDisposable FormatHttpResponse(HttpContext context, IQueryResult result);
+    IDisposable FormatHttpResponse(HttpContext context, IOperationResult result);
 
     /// <summary>
     /// Called when starting to establish a GraphQL WebSocket session.

diff --git a/...tChocolate/AspNetCore/src/AspNetCore/Instrumentation/NoopServerDiagnosticEventListener.cs b/...tChocolate/AspNetCore/src/AspNetCore/Instrumentation/NoopServerDiagnosticEventListener.cs
@@ -37,7 +37,7 @@ public void ParserErrors(HttpContext context, IReadOnlyList<IError> errors)
     {
     }
 
-    public IDisposable FormatHttpResponse(HttpContext context, IQueryResult result) => EmptyScope;
+    public IDisposable FormatHttpResponse(HttpContext context, IOperationResult result) => EmptyScope;
 
     public IDisposable WebSocketSession(HttpContext context) => EmptyScope;
 

diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Instrumentation/ServerDiagnosticEventListener.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Instrumentation/ServerDiagnosticEventListener.cs
@@ -57,7 +57,7 @@ public virtual void ParserErrors(HttpContext context, IReadOnlyList<IError> erro
     }
 
     /// <inheritdoc />
-    public virtual IDisposable FormatHttpResponse(HttpContext context, IQueryResult result)
+    public virtual IDisposable FormatHttpResponse(HttpContext context, IOperationResult result)
         => EmptyScope;
 
     /// <inheritdoc />