Obsolete the Libuv transport

Pilchie · Pilchie · commit e798ab58cca9 · 2020-06-29T12:13:18.000-07:00
diff --git a/src/Servers/Kestrel/Kestrel/test/WebHostBuilderKestrelExtensionsTests.cs b/src/Servers/Kestrel/Kestrel/test/WebHostBuilderKestrelExtensionsTests.cs
@@ -63,17 +63,21 @@ public void SocketTransportIsTheDefault()
         [Fact]
         public void LibuvTransportCanBeManuallySelectedIndependentOfOrder()
         {
+#pragma warning disable CS0618
             var hostBuilder = new WebHostBuilder()
                 .UseKestrel()
                 .UseLibuv()
                 .Configure(app => { });
+#pragma warning restore CS0618
 
             Assert.IsType<LibuvTransportFactory>(hostBuilder.Build().Services.GetService<IConnectionListenerFactory>());
 
+#pragma warning disable CS0618
             var hostBuilderReversed = new WebHostBuilder()
                 .UseLibuv()
                 .UseKestrel()
                 .Configure(app => { });
+#pragma warning restore CS0618
 
             Assert.IsType<LibuvTransportFactory>(hostBuilderReversed.Build().Services.GetService<IConnectionListenerFactory>());
         }
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvConnectionListener.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvConnectionListener.cs
@@ -40,7 +40,10 @@ public LibuvConnectionListener(LibuvFunctions uv, LibuvTransportContext context,
 
         public IHostApplicationLifetime AppLifetime => TransportContext.AppLifetime;
         public ILibuvTrace Log => TransportContext.Log;
+
+#pragma warning disable CS0618
         public LibuvTransportOptions TransportOptions => TransportContext.Options;
+#pragma warning restore CS0618
 
         public EndPoint EndPoint { get; set; }
 
@@ -131,7 +134,9 @@ internal async Task BindAsync()
         {
             // TODO: Move thread management to LibuvTransportFactory
             // TODO: Split endpoint management from thread management
+#pragma warning disable CS0618
             for (var index = 0; index < TransportOptions.ThreadCount; index++)
+#pragma warning restore CS0618
             {
                 Threads.Add(new LibuvThread(Libuv, TransportContext));
             }
@@ -143,7 +148,9 @@ internal async Task BindAsync()
 
             try
             {
+#pragma warning disable CS0618
                 if (TransportOptions.ThreadCount == 1)
+#pragma warning restore CS0618
                 {
                     var listener = new Listener(TransportContext);
                     _listeners.Add(listener);
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvTransportContext.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvTransportContext.cs
@@ -7,7 +7,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv.Internal
 {
     internal class LibuvTransportContext
     {
+#pragma warning disable CS0618
         public LibuvTransportOptions Options { get; set; }
+#pragma warning restore CS0618
 
         public IHostApplicationLifetime AppLifetime { get; set; }
 
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvTransportFactory.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/LibuvTransportFactory.cs
@@ -17,7 +17,9 @@ internal class LibuvTransportFactory : IConnectionListenerFactory
         private readonly LibuvTransportContext _baseTransportContext;
 
         public LibuvTransportFactory(
+#pragma warning disable CS0618
             IOptions<LibuvTransportOptions> options,
+#pragma warning restore CS0618
             IHostApplicationLifetime applicationLifetime,
             ILoggerFactory loggerFactory)
         {
@@ -37,7 +39,9 @@ public LibuvTransportFactory(
             var logger = loggerFactory.CreateLogger("Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv");
             var trace = new LibuvTrace(logger);
 
+#pragma warning disable CS0618
             var threadCount = options.Value.ThreadCount;
+#pragma warning restore CS0618
 
             if (threadCount <= 0)
             {
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/Listener.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/Listener.cs
@@ -37,7 +37,9 @@ public Task StartAsync(
             return Thread.PostAsync(listener =>
             {
                 listener.ListenSocket = listener.CreateListenSocket();
+#pragma warning disable CS0618
                 listener.ListenSocket.Listen(TransportContext.Options.Backlog, ConnectionCallback, listener);
+#pragma warning restore CS0618
             }, this);
         }
 
@@ -66,7 +68,9 @@ private UvTcpHandle ListenTcp(bool useFileHandle)
             try
             {
                 socket.Init(Thread.Loop, Thread.QueueCloseHandle);
+#pragma warning disable CS0618
                 socket.NoDelay(TransportContext.Options.NoDelay);
+#pragma warning restore CS0618
 
                 if (!useFileHandle)
                 {
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/ListenerContext.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/ListenerContext.cs
@@ -109,7 +109,9 @@ protected internal void HandleConnection(UvStreamHandle socket)
                 }
 
                 var options = TransportContext.Options;
+#pragma warning disable CS0618
                 var connection = new LibuvConnection(socket, TransportContext.Log, Thread, remoteEndPoint, localEndPoint, InputOptions, OutputOptions, options.MaxReadBufferSize, options.MaxWriteBufferSize);
+#pragma warning restore CS0618
                 connection.Start();
 
                 bool accepted = _acceptQueue.Writer.TryWrite(connection);
@@ -128,7 +130,9 @@ private UvTcpHandle AcceptTcp()
             try
             {
                 socket.Init(Thread.Loop, Thread.QueueCloseHandle);
+#pragma warning disable CS0618
                 socket.NoDelay(TransportContext.Options.NoDelay);
+#pragma warning restore CS0618
             }
             catch
             {
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/Internal/ListenerPrimary.cs b/src/Servers/Kestrel/Transport.Libuv/src/Internal/ListenerPrimary.cs
@@ -69,8 +69,10 @@ private void PostCallback()
             ListenPipe = new UvPipeHandle(Log);
             ListenPipe.Init(Thread.Loop, Thread.QueueCloseHandle, false);
             ListenPipe.Bind(_pipeName);
+#pragma warning disable CS0618
             ListenPipe.Listen(TransportContext.Options.Backlog,
                 (pipe, status, error, state) => ((ListenerPrimary)state).OnListenPipe(pipe, status, error), this);
+#pragma warning restore CS0618
         }
 
         private void OnListenPipe(UvStreamHandle pipe, int status, UvException error)
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/LibuvTransportOptions.cs b/src/Servers/Kestrel/Transport.Libuv/src/LibuvTransportOptions.cs
@@ -9,6 +9,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv
     /// <summary>
     /// Provides programmatic configuration of Libuv transport features.
     /// </summary>
+    [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
     public class LibuvTransportOptions
     {
         /// <summary>
@@ -17,6 +18,7 @@ public class LibuvTransportOptions
         /// <remarks>
         /// Defaults to half of <see cref="Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.
         /// </remarks>
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public int ThreadCount { get; set; } = ProcessorThreadCount;
 
         /// <summary>
@@ -25,6 +27,7 @@ public class LibuvTransportOptions
         /// <remarks>
         /// Defaults to true.
         /// </remarks>
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public bool NoDelay { get; set; } = true;
 
         /// <summary>
@@ -33,10 +36,13 @@ public class LibuvTransportOptions
         /// <remarks>
         /// Defaults to 128.
         /// </remarks>
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public int Backlog { get; set; } = 128;
 
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public long? MaxReadBufferSize { get; set; } = 1024 * 1024;
 
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public long? MaxWriteBufferSize { get; set; } = 64 * 1024;
 
         internal Func<MemoryPool<byte>> MemoryPoolFactory { get; set; } = System.Buffers.SlabMemoryPoolFactory.Create;
diff --git a/src/Servers/Kestrel/Transport.Libuv/src/WebHostBuilderLibuvExtensions.cs b/src/Servers/Kestrel/Transport.Libuv/src/WebHostBuilderLibuvExtensions.cs
@@ -9,6 +9,7 @@
 
 namespace Microsoft.AspNetCore.Hosting
 {
+    [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
     public static class WebHostBuilderLibuvExtensions
     {
         /// <summary>
@@ -20,6 +21,7 @@ public static class WebHostBuilderLibuvExtensions
         /// <returns>
         /// The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
         /// </returns>
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder)
         {
             return hostBuilder.ConfigureServices(services =>
@@ -40,6 +42,7 @@ public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder)
         /// <returns>
         /// The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
         /// </returns>
+        [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]
         public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder, Action<LibuvTransportOptions> configureOptions)
         {
             return hostBuilder.UseLibuv().ConfigureServices(services =>
diff --git a/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportFactoryTests.cs b/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportFactoryTests.cs
@@ -18,7 +18,9 @@ public class LibuvTransportFactoryTests
         [InlineData(-1337)]
         public void StartWithNonPositiveThreadCountThrows(int threadCount)
         {
+#pragma warning disable CS0618
             var options = new LibuvTransportOptions { ThreadCount = threadCount };
+#pragma warning restore CS0618
 
             var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
                 new LibuvTransportFactory(Options.Create(options), new LifetimeNotImplemented(), Mock.Of<ILoggerFactory>()));
@@ -30,7 +32,9 @@ public void StartWithNonPositiveThreadCountThrows(int threadCount)
         public void LoggerCategoryNameIsLibuvTransportNamespace()
         {
             var mockLoggerFactory = new Mock<ILoggerFactory>();
+#pragma warning disable CS0618
             new LibuvTransportFactory(Options.Create<LibuvTransportOptions>(new LibuvTransportOptions()), new LifetimeNotImplemented(), mockLoggerFactory.Object);
+#pragma warning restore CS0618
             mockLoggerFactory.Verify(factory => factory.CreateLogger("Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv"));
         }
     }
diff --git a/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportOptionsTests.cs b/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportOptionsTests.cs
@@ -14,9 +14,11 @@ public void SetThreadCountUsingProcessorCount()
             // Ideally we'd mock Environment.ProcessorCount to test edge cases.
             var expected = Clamp(Environment.ProcessorCount >> 1, 1, 16);
 
+#pragma warning disable CS0618
             var information = new LibuvTransportOptions();
 
             Assert.Equal(expected, information.ThreadCount);
+#pragma warning restore CS0618
         }
 
         private static int Clamp(int value, int min, int max)
diff --git a/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportTests.cs b/src/Servers/Kestrel/Transport.Libuv/test/LibuvTransportTests.cs
@@ -191,7 +191,9 @@ public async Task OneToTenThreads(int threadCount)
 
             var transportContext = new TestLibuvTransportContext
             {
+#pragma warning disable CS0618
                 Options = new LibuvTransportOptions { ThreadCount = threadCount }
+#pragma warning restore CS0618
             };
 
             await using var transport = new LibuvConnectionListener(transportContext, listenOptions.EndPoint);
diff --git a/src/Servers/Kestrel/Transport.Libuv/test/TestHelpers/TestLibuvTransportContext.cs b/src/Servers/Kestrel/Transport.Libuv/test/TestHelpers/TestLibuvTransportContext.cs
@@ -14,7 +14,9 @@ public TestLibuvTransportContext()
 
             AppLifetime = new LifetimeNotImplemented();
             Log = new LibuvTrace(logger);
+#pragma warning disable CS0618
             Options = new LibuvTransportOptions { ThreadCount = 1 };
+#pragma warning restore CS0618
         }
     }
 }
diff --git a/src/Servers/Kestrel/samples/SampleApp/Startup.cs b/src/Servers/Kestrel/samples/SampleApp/Startup.cs
@@ -157,11 +157,13 @@ public static Task Main(string[] args)
             if (string.Equals(Process.GetCurrentProcess().Id.ToString(), Environment.GetEnvironmentVariable("LISTEN_PID")))
             {
                 // Use libuv if activated by systemd, since that's currently the only transport that supports being passed a socket handle.
+#pragma warning disable CS0618
                 hostBuilder.UseLibuv(options =>
                  {
                      // Uncomment the following line to change the default number of libuv threads for all endpoints.
                      // options.ThreadCount = 4;
                  });
+#pragma warning restore CS0618
             }
 
             return hostBuilder.Build().RunAsync();
diff --git a/src/Servers/Kestrel/samples/SystemdTestApp/Startup.cs b/src/Servers/Kestrel/samples/SystemdTestApp/Startup.cs
@@ -75,11 +75,13 @@ public static Task Main(string[] args)
             if (string.Equals(Process.GetCurrentProcess().Id.ToString(), Environment.GetEnvironmentVariable("LISTEN_PID")))
             {
                 // Use libuv if activated by systemd, since that's currently the only transport that supports being passed a socket handle.
+#pragma warning disable CS0618
                 hostBuilder.UseLibuv(options =>
                  {
                      // Uncomment the following line to change the default number of libuv threads for all endpoints.
                      // options.ThreadCount = 4;
                  });
+#pragma warning restore CS0618
             }
 
             return hostBuilder.Build().RunAsync();
diff --git a/src/Servers/Kestrel/test/Libuv.FunctionalTests/TransportSelector.cs b/src/Servers/Kestrel/test/Libuv.FunctionalTests/TransportSelector.cs
@@ -12,11 +12,13 @@ public static class TransportSelector
         public static IWebHostBuilder GetWebHostBuilder(Func<MemoryPool<byte>> memoryPoolFactory = null,
                                                         long? maxReadBufferSize = null)
         {
+#pragma warning disable CS0618
             return new WebHostBuilder().UseLibuv(options =>
             {
                 options.MemoryPoolFactory = memoryPoolFactory ?? options.MemoryPoolFactory;
                 options.MaxReadBufferSize = maxReadBufferSize;
             });
+#pragma warning restore CS0618
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,10 @@ public LibuvConnectionListener(LibuvFunctions uv, LibuvTransportContext context,`
`40`	`40`
`41`	`41`	`public IHostApplicationLifetime AppLifetime => TransportContext.AppLifetime;`
`42`	`42`	`public ILibuvTrace Log => TransportContext.Log;`
	`43`	`+`
	`44`	`+#pragma warning disable CS0618`
`43`	`45`	`public LibuvTransportOptions TransportOptions => TransportContext.Options;`
	`46`	`+#pragma warning restore CS0618`
`44`	`47`
`45`	`48`	`public EndPoint EndPoint { get; set; }`
`46`	`49`
`@@ -131,7 +134,9 @@ internal async Task BindAsync()`
`131`	`134`	`{`
`132`	`135`	`// TODO: Move thread management to LibuvTransportFactory`
`133`	`136`	`// TODO: Split endpoint management from thread management`
	`137`	`+#pragma warning disable CS0618`
`134`	`138`	`for (var index = 0; index < TransportOptions.ThreadCount; index++)`
	`139`	`+#pragma warning restore CS0618`
`135`	`140`	`{`
`136`	`141`	`Threads.Add(new LibuvThread(Libuv, TransportContext));`
`137`	`142`	`}`
`@@ -143,7 +148,9 @@ internal async Task BindAsync()`
`143`	`148`
`144`	`149`	`try`
`145`	`150`	`{`
	`151`	`+#pragma warning disable CS0618`
`146`	`152`	`if (TransportOptions.ThreadCount == 1)`
	`153`	`+#pragma warning restore CS0618`
`147`	`154`	`{`
`148`	`155`	`var listener = new Listener(TransportContext);`
`149`	`156`	`_listeners.Add(listener);`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv.Internal`
`7`	`7`	`{`
`8`	`8`	`internal class LibuvTransportContext`
`9`	`9`	`{`
	`10`	`+#pragma warning disable CS0618`
`10`	`11`	`public LibuvTransportOptions Options { get; set; }`
	`12`	`+#pragma warning restore CS0618`
`11`	`13`
`12`	`14`	`public IHostApplicationLifetime AppLifetime { get; set; }`
`13`	`15`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,9 @@ public Task StartAsync(`
`37`	`37`	`return Thread.PostAsync(listener =>`
`38`	`38`	`{`
`39`	`39`	`listener.ListenSocket = listener.CreateListenSocket();`
	`40`	`+#pragma warning disable CS0618`
`40`	`41`	`listener.ListenSocket.Listen(TransportContext.Options.Backlog, ConnectionCallback, listener);`
	`42`	`+#pragma warning restore CS0618`
`41`	`43`	`}, this);`
`42`	`44`	`}`
`43`	`45`
`@@ -66,7 +68,9 @@ private UvTcpHandle ListenTcp(bool useFileHandle)`
`66`	`68`	`try`
`67`	`69`	`{`
`68`	`70`	`socket.Init(Thread.Loop, Thread.QueueCloseHandle);`
	`71`	`+#pragma warning disable CS0618`
`69`	`72`	`socket.NoDelay(TransportContext.Options.NoDelay);`
	`73`	`+#pragma warning restore CS0618`
`70`	`74`
`71`	`75`	`if (!useFileHandle)`
`72`	`76`	`{`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,9 @@ protected internal void HandleConnection(UvStreamHandle socket)`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`var options = TransportContext.Options;`
	`112`	`+#pragma warning disable CS0618`
`112`	`113`	`var connection = new LibuvConnection(socket, TransportContext.Log, Thread, remoteEndPoint, localEndPoint, InputOptions, OutputOptions, options.MaxReadBufferSize, options.MaxWriteBufferSize);`
	`114`	`+#pragma warning restore CS0618`
`113`	`115`	`connection.Start();`
`114`	`116`
`115`	`117`	`bool accepted = _acceptQueue.Writer.TryWrite(connection);`
`@@ -128,7 +130,9 @@ private UvTcpHandle AcceptTcp()`
`128`	`130`	`try`
`129`	`131`	`{`
`130`	`132`	`socket.Init(Thread.Loop, Thread.QueueCloseHandle);`
	`133`	`+#pragma warning disable CS0618`
`131`	`134`	`socket.NoDelay(TransportContext.Options.NoDelay);`
	`135`	`+#pragma warning restore CS0618`
`132`	`136`	`}`
`133`	`137`	`catch`
`134`	`138`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`namespace Microsoft.AspNetCore.Hosting`
`11`	`11`	`{`
	`12`	`+ [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]`
`12`	`13`	`public static class WebHostBuilderLibuvExtensions`
`13`	`14`	`{`
`14`	`15`	`/// <summary>`
`@@ -20,6 +21,7 @@ public static class WebHostBuilderLibuvExtensions`
`20`	`21`	`/// <returns>`
`21`	`22`	`/// The Microsoft.AspNetCore.Hosting.IWebHostBuilder.`
`22`	`23`	`/// </returns>`
	`24`	`+ [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]`
`23`	`25`	`public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder)`
`24`	`26`	`{`
`25`	`27`	`return hostBuilder.ConfigureServices(services =>`
`@@ -40,6 +42,7 @@ public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder)`
`40`	`42`	`/// <returns>`
`41`	`43`	`/// The Microsoft.AspNetCore.Hosting.IWebHostBuilder.`
`42`	`44`	`/// </returns>`
	`45`	`+ [Obsolete("The libuv transport is obsolete and will be removed in a future release. See https://aka.ms/libuvtransport for details.", error: false)]`
`43`	`46`	`public static IWebHostBuilder UseLibuv(this IWebHostBuilder hostBuilder, Action<LibuvTransportOptions> configureOptions)`
`44`	`47`	`{`
`45`	`48`	`return hostBuilder.UseLibuv().ConfigureServices(services =>`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,9 @@ public class LibuvTransportFactoryTests`
`18`	`18`	`[InlineData(-1337)]`
`19`	`19`	`public void StartWithNonPositiveThreadCountThrows(int threadCount)`
`20`	`20`	`{`
	`21`	`+#pragma warning disable CS0618`
`21`	`22`	`var options = new LibuvTransportOptions { ThreadCount = threadCount };`
	`23`	`+#pragma warning restore CS0618`
`22`	`24`
`23`	`25`	`var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>`
`24`	`26`	`new LibuvTransportFactory(Options.Create(options), new LifetimeNotImplemented(), Mock.Of<ILoggerFactory>()));`
`@@ -30,7 +32,9 @@ public void StartWithNonPositiveThreadCountThrows(int threadCount)`
`30`	`32`	`public void LoggerCategoryNameIsLibuvTransportNamespace()`
`31`	`33`	`{`
`32`	`34`	`var mockLoggerFactory = new Mock<ILoggerFactory>();`
	`35`	`+#pragma warning disable CS0618`
`33`	`36`	`new LibuvTransportFactory(Options.Create<LibuvTransportOptions>(new LibuvTransportOptions()), new LifetimeNotImplemented(), mockLoggerFactory.Object);`
	`37`	`+#pragma warning restore CS0618`
`34`	`38`	`mockLoggerFactory.Verify(factory => factory.CreateLogger("Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv"));`
`35`	`39`	`}`
`36`	`40`	`}`