HTTP/3: Add IStreamAbortFeature

Author: JamesNK

src/Servers/Connections.Abstractions/src/Features/IStreamAbortFeature.cs

@@ -0,0 +1,23 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace Microsoft.AspNetCore.Connections.Features
+{
+    /// <summary>
+    /// Explicitly abort one direction of a connection stream.
+    /// </summary>
+    public interface IStreamAbortFeature
+    {
+        /// <summary>
+        /// Abort reading from the connection stream.
+        /// </summary>
+        /// <param name="abortReason">An optional <see cref="ConnectionAbortedException"/> describing the reason to abort reading from the connection stream.</param>
+        void AbortRead(ConnectionAbortedException abortReason);
+
+        /// <summary>
+        /// Abort writing to the connection stream.
+        /// </summary>
+        /// <param name="abortReason">An optional <see cref="ConnectionAbortedException"/> describing the reason to abort writing to the connection stream.</param>
+        void AbortWrite(ConnectionAbortedException abortReason);
+    }
+}

src/Servers/Connections.Abstractions/src/PublicAPI.Unshipped.txt

@@ -2,6 +2,9 @@
 *REMOVED*Microsoft.AspNetCore.Connections.IConnectionListener.AcceptAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Connections.ConnectionContext!>
 Microsoft.AspNetCore.Connections.Features.IConnectionSocketFeature
 Microsoft.AspNetCore.Connections.Features.IConnectionSocketFeature.Socket.get -> System.Net.Sockets.Socket!
+Microsoft.AspNetCore.Connections.Features.IStreamAbortFeature
+Microsoft.AspNetCore.Connections.Features.IStreamAbortFeature.AbortRead(Microsoft.AspNetCore.Connections.ConnectionAbortedException! abortReason) -> void
+Microsoft.AspNetCore.Connections.Features.IStreamAbortFeature.AbortWrite(Microsoft.AspNetCore.Connections.ConnectionAbortedException! abortReason) -> void
 Microsoft.AspNetCore.Connections.IConnectionListener.AcceptAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Connections.ConnectionContext?>
 Microsoft.AspNetCore.Connections.IMultiplexedConnectionBuilder
 Microsoft.AspNetCore.Connections.IMultiplexedConnectionBuilder.ApplicationServices.get -> System.IServiceProvider!

src/Servers/Kestrel/Core/src/Internal/Http3/Http3Stream.cs

@@ -42,6 +42,7 @@ internal abstract partial class Http3Stream : HttpProtocol, IHttp3Stream, IHttpH
         private readonly Http3StreamContext _context;
         private readonly IProtocolErrorCodeFeature _errorCodeFeature;
         private readonly IStreamIdFeature _streamIdFeature;
+        private readonly IStreamAbortFeature _streamAbortFeature;
         private readonly Http3RawFrame _incomingFrame = new Http3RawFrame();
         protected RequestHeaderParsingState _requestHeaderParsingState;
         private PseudoHeaderFields _parsedPseudoHeaderFields;
@@ -69,6 +70,7 @@ public Http3Stream(Http3StreamContext context)
 
             _errorCodeFeature = _context.ConnectionFeatures.Get<IProtocolErrorCodeFeature>()!;
             _streamIdFeature = _context.ConnectionFeatures.Get<IStreamIdFeature>()!;
+            _streamAbortFeature = _context.ConnectionFeatures.Get<IStreamAbortFeature>()!;
 
             _frameWriter = new Http3FrameWriter(
                 context.Transport.Output,
@@ -353,10 +355,8 @@ private void CompleteStream(bool errored)
                     // the request stream, send a complete response, and cleanly close the sending part of the stream.
                     // The error code H3_NO_ERROR SHOULD be used when requesting that the client stop sending on the
                     // request stream.
-
-                    // TODO(JamesNK): Abort the read half of the stream with H3_NO_ERROR
-                    // https://github.com/dotnet/aspnetcore/issues/33575
-
+                    _errorCodeFeature.Error = (long)Http3ErrorCode.NoError;
+                    _streamAbortFeature.AbortRead(new ConnectionAbortedException("The application completed without reading the entire request body."));
                     RequestBodyPipe.Writer.Complete();
                 }
 

src/Servers/Kestrel/Transport.Quic/src/Internal/QuicStreamContext.cs

@@ -14,7 +14,7 @@
 
 namespace Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.Internal
 {
-    internal class QuicStreamContext : TransportConnection, IStreamDirectionFeature, IProtocolErrorCodeFeature, IStreamIdFeature
+    internal class QuicStreamContext : TransportConnection, IStreamDirectionFeature, IProtocolErrorCodeFeature, IStreamIdFeature, IStreamAbortFeature
     {
         // Internal for testing.
         internal Task _processingTask = Task.CompletedTask;
@@ -312,6 +312,36 @@ public override void Abort(ConnectionAbortedException abortReason)
             Output.CancelPendingRead();
         }
 
+        public void AbortRead(ConnectionAbortedException abortReason)
+        {
+            lock (_shutdownLock)
+            {
+                if (_stream.CanRead)
+                {
+                    _stream.AbortRead(Error);
+                }
+                else
+                {
+                    throw new InvalidOperationException("Unable to abort reading from a stream that doesn't support reading.");
+                }
+            }
+        }
+
+        public void AbortWrite(ConnectionAbortedException abortReason)
+        {
+            lock (_shutdownLock)
+            {
+                if (_stream.CanWrite)
+                {
+                    _stream.AbortWrite(Error);
+                }
+                else
+                {
+                    throw new InvalidOperationException("Unable to abort writing to a stream that doesn't support writing.");
+                }
+            }
+        }
+
         private async ValueTask ShutdownWrite(Exception? shutdownReason)
         {
             try

src/Servers/Kestrel/test/InMemory.FunctionalTests/Http3/Http3StreamTests.cs

@@ -2431,8 +2431,8 @@ public async Task MaxRequestBodySize_ContentLengthOver_413()
 
             await requestStream.OnStreamCompletedTask.DefaultTimeout();
 
-            // TODO(JamesNK): Check for abort of request side of stream after https://github.com/dotnet/aspnetcore/issues/31970
             Assert.Contains(LogMessages, m => m.Message.Contains("the application completed without reading the entire request body."));
+            Assert.Equal("The application completed without reading the entire request body.", requestStream.AbortReadException.Message);
 
             Assert.Equal(3, receivedHeaders.Count);
             Assert.Contains("date", receivedHeaders.Keys, StringComparer.OrdinalIgnoreCase);
@@ -2756,8 +2756,8 @@ await requestStream.SendHeadersAsync(new[]
 
             await requestStream.OnStreamCompletedTask.DefaultTimeout();
 
-            // TODO(JamesNK): Check for abort of request side of stream after https://github.com/dotnet/aspnetcore/issues/31970
             Assert.Contains(LogMessages, m => m.Message.Contains("the application completed without reading the entire request body."));
+            Assert.Equal("The application completed without reading the entire request body.", requestStream.AbortReadException.Message);
         }
 
         [Fact]

src/Servers/Kestrel/test/InMemory.FunctionalTests/Http3/Http3TestBase.cs

@@ -466,7 +466,7 @@ public ValueTask<ConnectionContext> StartBidirectionalStreamAsync()
             return new ValueTask<ConnectionContext>(stream.StreamContext);
         }
 
-        public class Http3StreamBase : IProtocolErrorCodeFeature
+        public class Http3StreamBase : IProtocolErrorCodeFeature, IStreamAbortFeature
         {
             internal TaskCompletionSource _onStreamCreatedTcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
             internal TaskCompletionSource _onStreamCompletedTcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
@@ -477,11 +477,23 @@ public class Http3StreamBase : IProtocolErrorCodeFeature
             internal Http3Connection _connection;
             public long BytesReceived { get; private set; }
             public long Error { get; set; }
+            public ConnectionAbortedException AbortReadException { get; private set; }
+            public ConnectionAbortedException AbortWriteException { get; private set; }
 
             public Task OnStreamCreatedTask => _onStreamCreatedTcs.Task;
             public Task OnStreamCompletedTask => _onStreamCompletedTcs.Task;
             public Task OnHeaderReceivedTask => _onHeaderReceivedTcs.Task;
 
+            void IStreamAbortFeature.AbortRead(ConnectionAbortedException abortReason)
+            {
+                AbortReadException = abortReason;
+            }
+
+            void IStreamAbortFeature.AbortWrite(ConnectionAbortedException abortReason)
+            {
+                AbortWriteException = abortReason;
+            }
+
             protected Task SendAsync(ReadOnlySpan<byte> span)
             {
                 var writableBuffer = _pair.Application.Output;
@@ -610,7 +622,7 @@ public Http3RequestStream(Http3TestBase testBase, Http3Connection connection)
 
                 _pair = DuplexPipe.CreateConnectionPair(inputPipeOptions, outputPipeOptions);
                 _streamId = testBase.GetStreamId(0x00);
-                _testStreamContext = new TestStreamContext(canRead: true, canWrite: true, _pair, this, _streamId);
+                _testStreamContext = new TestStreamContext(canRead: true, canWrite: true, _pair, this, this, _streamId);
                 StreamContext = _testStreamContext;
             }
 
@@ -736,7 +748,7 @@ public Http3ControlStream(Http3TestBase testBase, StreamInitiator initiator)
                 var outputPipeOptions = GetOutputPipeOptions(_testBase._serviceContext, _testBase._memoryPool, PipeScheduler.ThreadPool);
                 _pair = DuplexPipe.CreateConnectionPair(inputPipeOptions, outputPipeOptions);
                 _streamId = testBase.GetStreamId(initiator == StreamInitiator.Client ? 0x02 : 0x03);
-                StreamContext = new TestStreamContext(canRead: true, canWrite: false, _pair, this, _streamId);
+                StreamContext = new TestStreamContext(canRead: true, canWrite: false, _pair, this, this, _streamId);
             }
 
             public Http3ControlStream(ConnectionContext streamContext)
@@ -957,12 +969,13 @@ public void RequestClose()
         private class TestStreamContext : ConnectionContext, IStreamDirectionFeature, IStreamIdFeature
         {
             private readonly DuplexPipePair _pair;
-            public TestStreamContext(bool canRead, bool canWrite, DuplexPipePair pair, IProtocolErrorCodeFeature errorCodeFeature, long streamId)
+            public TestStreamContext(bool canRead, bool canWrite, DuplexPipePair pair, IProtocolErrorCodeFeature errorCodeFeature, IStreamAbortFeature streamAbortFeature, long streamId)
             {
                 _pair = pair;
                 Features = new FeatureCollection();
                 Features.Set<IStreamDirectionFeature>(this);
                 Features.Set<IStreamIdFeature>(this);
+                Features.Set(streamAbortFeature);
                 Features.Set(errorCodeFeature);
 
                 CanRead = canRead;