Merge pull request #198 from AArnott/channelShutdownFix

Shutdown ExistingPipe streams on channel disposal

Author: AArnott

src/Nerdbank.Streams.Tests/MultiplexingStreamTests.cs

@@ -208,7 +208,7 @@ public async Task Dispose_DisposesChannels()
     [Fact]
     public async Task ChannelDispose_ClosesExistingStream()
     {
-        var ms = new MonitoringStream(new MemoryStream());
+        var ms = new MonitoringStream(FullDuplexStream.CreatePair().Item1);
         var disposal = new AsyncManualResetEvent();
         ms.Disposed += (s, e) => disposal.Set();
 
@@ -220,7 +220,7 @@ public async Task ChannelDispose_ClosesExistingStream()
     [Fact]
     public async Task RemoteChannelClose_ClosesExistingStream()
     {
-        var ms = new MonitoringStream(new MemoryStream());
+        var ms = new MonitoringStream(FullDuplexStream.CreatePair().Item1);
         var disposal = new AsyncManualResetEvent();
         ms.Disposed += (s, e) => disposal.Set();
 

src/Nerdbank.Streams/MultiplexingStream.Channel.cs

@@ -38,6 +38,11 @@ public class Channel : IDisposableObservable, IDuplexPipe
             /// </summary>
             private readonly TaskCompletionSource<object?> completionSource = new TaskCompletionSource<object?>();
 
+            /// <summary>
+            /// The source for a token that will be canceled when this channel has completed.
+            /// </summary>
+            private readonly CancellationTokenSource disposalTokenSource = new CancellationTokenSource();
+
             /// <summary>
             /// The source for the <see cref="OptionsApplied"/> property. May be null if options were provided in ctor.
             /// </summary>
@@ -107,11 +112,17 @@ public class Channel : IDisposableObservable, IDuplexPipe
             private PipeWriter? mxStreamIOWriter;
 
             /// <summary>
-            /// The I/O to expose on this channel. Will be <c>null</c> if <see cref="ChannelOptions.ExistingPipe"/>
-            /// was set to a non-null value when this channel was created.
+            /// The I/O to expose on this channel if <see cref="ChannelOptions.ExistingPipe"/> was not specified;
+            /// otherwise it is the buffering pipe we use as an intermediary with the specified <see cref="ChannelOptions.ExistingPipe"/>.
             /// </summary>
             private IDuplexPipe? channelIO;
 
+            /// <summary>
+            /// The value of <see cref="ChannelOptions.ExistingPipe"/> as it was when we received it.
+            /// We don't use this field, but we set it for diagnostic purposes later.
+            /// </summary>
+            private IDuplexPipe? existingPipe;
+
             /// <summary>
             /// A value indicating whether this <see cref="Channel"/> was created or accepted with a non-null value for <see cref="ChannelOptions.ExistingPipe"/>.
             /// </summary>
@@ -229,6 +240,11 @@ public PipeWriter Output
             /// </summary>
             public MultiplexingStream MultiplexingStream { get; }
 
+            /// <summary>
+            /// Gets a token that is canceled just before <see cref="Completion" /> has transitioned to its final state.
+            /// </summary>
+            internal CancellationToken DisposalToken => this.disposalTokenSource.Token;
+
             internal OfferParameters OfferParams { get; }
 
             internal string Name => this.OfferParams.Name;
@@ -297,6 +313,7 @@ public void Dispose()
                     Action<object?, object> finalDisposalAction = (exOrAntecedent, state) =>
                     {
                         var self = (Channel)state;
+                        self.disposalTokenSource.Cancel();
                         self.completionSource.TrySetResult(null);
                         self.MultiplexingStream.OnChannelDisposed(self);
                     };
@@ -574,8 +591,14 @@ private void ApplyChannelOptions(ChannelOptions channelOptions)
                         if (channelOptions.ExistingPipe is object)
                         {
                             Assumes.NotNull(this.channelIO);
-                            this.DisposeSelfOnFailure(this.channelIO.LinkToAsync(channelOptions.ExistingPipe));
+                            this.existingPipe = channelOptions.ExistingPipe;
                             this.existingPipeGiven = true;
+
+                            // We always want to write ALL received data to the user's ExistingPipe, rather than truncating it on disposal, so don't use a cancellation token in that direction.
+                            this.DisposeSelfOnFailure(this.channelIO.Input.LinkToAsync(channelOptions.ExistingPipe.Output));
+
+                            // Upon disposal, we no longer want to continue reading from the user's ExistingPipe into our buffer since we won't be propagating it any further, so use our DisposalToken.
+                            this.DisposeSelfOnFailure(channelOptions.ExistingPipe.Input.LinkToAsync(this.channelIO.Output, this.DisposalToken));
                         }
                         else
                         {