#302 Add a timeout for draining requests on shutdown

Author: Tratcher

src/Microsoft.AspNetCore.Server.WebListener/MessagePump.cs

@@ -29,6 +29,7 @@ internal class MessagePump : IServer
         private bool _stopping;
         private int _outstandingRequests;
         private ManualResetEvent _shutdownSignal;
+        private TimeSpan _shutdownTimeout;
 
         private readonly ServerAddressesFeature _serverAddresses;
 
@@ -54,6 +55,7 @@ public MessagePump(IOptions<WebListenerOptions> options, ILoggerFactory loggerFa
             _maxAccepts = optionsInstance.MaxAccepts;
             EnableResponseCaching = optionsInstance.EnableResponseCaching;
             _shutdownSignal = new ManualResetEvent(false);
+            _shutdownTimeout = TimeSpan.FromSeconds(5);
         }
 
         internal Microsoft.Net.Http.Server.WebListener Listener
@@ -222,7 +224,15 @@ public void Dispose()
             if (_outstandingRequests > 0)
             {
                 LogHelper.LogInfo(_logger, "Stopping, waiting for " + _outstandingRequests + " request(s) to drain.");
-                _shutdownSignal.WaitOne();
+                var drained = _shutdownSignal.WaitOne(_shutdownTimeout);
+                if (drained)
+                {
+                    LogHelper.LogInfo(_logger, "All requests drained successfully.");
+                }
+                else
+                {
+                    LogHelper.LogInfo(_logger, "Timed out, terminating " + _outstandingRequests + " request(s).");
+                }
             }
             // All requests are finished
             _listener.Dispose();

test/Microsoft.AspNetCore.Server.WebListener.FunctionalTests/ServerTests.cs

@@ -68,7 +68,7 @@ public async Task Server_EchoHelloWorld_Success()
         }
 
         [Fact]
-        public async Task Server_ShutdownDurringRequest_Success()
+        public async Task Server_ShutdownDuringRequest_Success()
         {
             Task<string> responseTask;
             ManualResetEvent received = new ManualResetEvent(false);
@@ -87,6 +87,30 @@ public async Task Server_ShutdownDurringRequest_Success()
             Assert.Equal("Hello World", response);
         }
 
+        [Fact]
+        public async Task Server_ShutdownDuringLongRunningRequest_TimesOut()
+        {
+            Task<string> responseTask;
+            var received = new ManualResetEvent(false);
+            bool? shutdown = null;
+            var waitForShutdown = new ManualResetEvent(false);
+            string address;
+            using (Utilities.CreateHttpServer(out address, httpContext =>
+            {
+                received.Set();
+                shutdown = waitForShutdown.WaitOne(TimeSpan.FromSeconds(15));
+                httpContext.Response.ContentLength = 11;
+                return httpContext.Response.WriteAsync("Hello World");
+            }))
+            {
+                responseTask = SendRequestAsync(address);
+                Assert.True(received.WaitOne(TimeSpan.FromSeconds(10)));
+            }
+            Assert.False(shutdown.HasValue);
+            waitForShutdown.Set();
+            await Assert.ThrowsAsync<HttpRequestException>(async () => await responseTask);
+        }
+
         [Fact]
         public void Server_AppException_ClientReset()
         {