Abandon Response Formatting Gracefully on Cancellation

ChilliCream · Feb 27, 2025 · 287d6cb · 287d6cb
1 parent 60d8bc1
commit 287d6cb
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 7 deletions.
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Serialization/DefaultHttpResponseFormatter.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Serialization/DefaultHttpResponseFormatter.cs
@@ -168,6 +168,23 @@ public async ValueTask FormatAsync(
             throw ThrowHelper.Formatter_InvalidAcceptMediaType();
         }
 
+        try
+        {
+            await FormatInternalAsync(response, result, proposedStatusCode, format, cancellationToken);
+        }
+        catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
+        {
+            // if the request is aborted we will fail gracefully.
+        }
+    }
+
+    private async ValueTask FormatInternalAsync(
+        HttpResponse response,
+        IExecutionResult result,
+        HttpStatusCode? proposedStatusCode,
+        FormatInfo format,
+        CancellationToken cancellationToken)
+    {
         switch (result)
         {
             case IOperationResult operationResult:

diff --git a/src/HotChocolate/Core/src/Execution/Serialization/EventStreamResultFormatter.cs b/src/HotChocolate/Core/src/Execution/Serialization/EventStreamResultFormatter.cs
@@ -74,8 +74,11 @@ private async ValueTask FormatOperationResultAsync(
             MessageHelper.WriteNextMessage(_payloadFormatter, operationResult, buffer);
             MessageHelper.WriteCompleteMessage(buffer);
 
-            await outputStream.WriteAsync(buffer.GetInternalBuffer(), 0, buffer.Length, ct).ConfigureAwait(false);
-            await outputStream.FlushAsync(ct).ConfigureAwait(false);
+            if (!ct.IsCancellationRequested)
+            {
+                await outputStream.WriteAsync(buffer.GetInternalBuffer(), 0, buffer.Length, ct).ConfigureAwait(false);
+                await outputStream.FlushAsync(ct).ConfigureAwait(false);
+            }
         }
         catch (Exception ex)
         {
@@ -111,8 +114,14 @@ private async ValueTask FormatResultBatchAsync(
                         {
                             buffer ??= new ArrayWriter();
                             MessageHelper.WriteNextMessage(_payloadFormatter, operationResult, buffer);
+
                             writer.Write(buffer.GetWrittenSpan());
-                            await writer.FlushAsync(ct).ConfigureAwait(false);
+
+                            if (!ct.IsCancellationRequested)
+                            {
+                                await writer.FlushAsync(ct).ConfigureAwait(false);
+                            }
+
                             keepAlive?.Reset();
                             buffer.Reset();
                         }
@@ -148,8 +157,11 @@ private async ValueTask FormatResultBatchAsync(
             buffer?.Dispose();
         }
 
-        MessageHelper.WriteCompleteMessage(writer);
-        await writer.FlushAsync(ct).ConfigureAwait(false);
+        if (!ct.IsCancellationRequested)
+        {
+            MessageHelper.WriteCompleteMessage(writer);
+            await writer.FlushAsync(ct).ConfigureAwait(false);
+        }
     }
 
     private async ValueTask FormatResponseStreamAsync(
@@ -165,8 +177,11 @@ private async ValueTask FormatResponseStreamAsync(
             await formatter.ProcessAsync(ct).ConfigureAwait(false);
         }
 
-        MessageHelper.WriteCompleteMessage(writer);
-        await writer.FlushAsync(ct).ConfigureAwait(false);
+        if (!ct.IsCancellationRequested)
+        {
+            MessageHelper.WriteCompleteMessage(writer);
+            await writer.FlushAsync(ct).ConfigureAwait(false);
+        }
     }
 
     private sealed class StreamFormatter(
@@ -207,6 +222,12 @@ public async Task ProcessAsync(CancellationToken ct)
                     }
                 }
             }
+            catch (OperationCanceledException)
+            {
+                // if the operation was canceled we do not need to log this
+                // and will stop gracefully.
+                return;
+            }
             finally
             {
                 await responseStream.DisposeAsync().ConfigureAwait(false);