Create logger for the network stream readers and writers

Author: fubar-coder

src/FubarDev.FtpServer/ConnectionHandlers/SecureConnectionAdapter.cs

@@ -9,6 +9,8 @@
 
 using FubarDev.FtpServer.Authentication;
 
+using Microsoft.Extensions.Logging;
+
 namespace FubarDev.FtpServer.ConnectionHandlers
 {
     /// <summary>
@@ -21,6 +23,7 @@ internal class SecureConnectionAdapter : IFtpSecureConnectionAdapter
         private readonly ISslStreamWrapperFactory _sslStreamWrapperFactory;
 
         private readonly CancellationToken _connectionClosed;
+        private readonly ILoggerFactory? _loggerFactory;
         private IFtpConnectionAdapter _activeCommunicationService;
 
         /// <summary>
@@ -30,20 +33,24 @@ internal class SecureConnectionAdapter : IFtpSecureConnectionAdapter
         /// <param name="connectionPipe">The pipe to the connection object.</param>
         /// <param name="sslStreamWrapperFactory">The SSL stream wrapper factory.</param>
         /// <param name="connectionClosed">The cancellation token for a closed connection.</param>
+        /// <param name="loggerFactory">The logger factory.</param>
         public SecureConnectionAdapter(
             IDuplexPipe socketPipe,
             IDuplexPipe connectionPipe,
             ISslStreamWrapperFactory sslStreamWrapperFactory,
-            CancellationToken connectionClosed)
+            CancellationToken connectionClosed,
+            ILoggerFactory? loggerFactory = null)
         {
             _socketPipe = socketPipe;
             _connectionPipe = connectionPipe;
             _sslStreamWrapperFactory = sslStreamWrapperFactory;
             _connectionClosed = connectionClosed;
+            _loggerFactory = loggerFactory;
             _activeCommunicationService = new PassThroughConnectionAdapter(
                 socketPipe,
                 connectionPipe,
-                connectionClosed);
+                connectionClosed,
+                loggerFactory);
         }
 
         /// <inheritdoc />
@@ -60,7 +67,8 @@ await StopAsync(cancellationToken)
             _activeCommunicationService = new PassThroughConnectionAdapter(
                 _socketPipe,
                 _connectionPipe,
-                _connectionClosed);
+                _connectionClosed,
+                _loggerFactory);
             await StartAsync(cancellationToken)
                .ConfigureAwait(false);
         }
@@ -77,14 +85,16 @@ await StopAsync(cancellationToken)
                     _connectionPipe,
                     _sslStreamWrapperFactory,
                     certificate,
-                    _connectionClosed);
+                    _connectionClosed,
+                    _loggerFactory);
             }
             catch
             {
                 _activeCommunicationService = new PassThroughConnectionAdapter(
                     _socketPipe,
                     _connectionPipe,
-                    _connectionClosed);
+                    _connectionClosed,
+                    _loggerFactory);
                 throw;
             }
             finally

src/FubarDev.FtpServer/ConnectionHandlers/SslStreamConnectionAdapter.cs

@@ -27,6 +27,7 @@ internal class SslStreamConnectionAdapter : IFtpConnectionAdapter
         private readonly X509Certificate2 _certificate;
 
         private readonly CancellationToken _connectionClosed;
+        private readonly ILoggerFactory? _loggerFactory;
 
         private SslCommunicationInfo? _info;
 
@@ -35,13 +36,15 @@ public SslStreamConnectionAdapter(
             IDuplexPipe connectionPipe,
             ISslStreamWrapperFactory sslStreamWrapperFactory,
             X509Certificate2 certificate,
-            CancellationToken connectionClosed)
+            CancellationToken connectionClosed,
+            ILoggerFactory? loggerFactory = null)
         {
             _socketPipe = socketPipe;
             _connectionPipe = connectionPipe;
             _sslStreamWrapperFactory = sslStreamWrapperFactory;
             _certificate = certificate;
             _connectionClosed = connectionClosed;
+            _loggerFactory = loggerFactory;
         }
 
         /// <inheritdoc />
@@ -62,15 +65,24 @@ public async Task StartAsync(CancellationToken cancellationToken)
                 _socketPipe.Output);
             var sslStream = await _sslStreamWrapperFactory.WrapStreamAsync(rawStream, false, _certificate, cancellationToken)
                .ConfigureAwait(false);
+
+            var receiverLogger = _loggerFactory
+              ?.CreateLogger(typeof(SslStreamConnectionAdapter).FullName + ":Receiver");
             var receiverService = new NonClosingNetworkStreamReader(
                 sslStream,
                 _connectionPipe.Output,
                 _socketPipe.Input,
-                _connectionClosed);
+                _connectionClosed,
+                receiverLogger);
+
+            var transmitterLogger = _loggerFactory
+              ?.CreateLogger(typeof(SslStreamConnectionAdapter).FullName + ":Transmitter");
             var transmitterService = new NonClosingNetworkStreamWriter(
                 sslStream,
                 _connectionPipe.Input,
-                _connectionClosed);
+                _connectionClosed,
+                transmitterLogger);
+
             var info = new SslCommunicationInfo(transmitterService, receiverService, sslStream);
             _info = info;
 

src/FubarDev.FtpServer/FtpConnection.cs

@@ -182,7 +182,8 @@ public FtpConnection(
                     socketPipe,
                     connectionPipe,
                     sslStreamWrapperFactory,
-                    _cancellationTokenSource.Token),
+                    _cancellationTokenSource.Token,
+                    loggerFactory),
                 applicationOutputPipe.Writer);
 
             parentFeatures.Set<IConnectionFeature>(connectionFeature);

src/FubarDev.FtpServer/Networking/PausableFtpService.cs

@@ -169,24 +169,28 @@ protected abstract Task ExecuteAsync(
         protected virtual Task OnStopRequestingAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("STOP requesting");
             return Task.CompletedTask;
         }
 
         protected virtual Task OnStopRequestedAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("STOP requested");
             return Task.CompletedTask;
         }
 
         protected virtual Task OnPauseRequestingAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("PAUSE requesting");
             return Task.CompletedTask;
         }
 
         protected virtual Task OnPauseRequestedAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("PAUSE requested");
             return Task.CompletedTask;
         }
 
@@ -199,12 +203,14 @@ protected virtual Task OnContinueRequestingAsync(
         protected virtual Task OnPausedAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("PAUSED");
             return Task.CompletedTask;
         }
 
         protected virtual Task OnStoppedAsync(
             CancellationToken cancellationToken)
         {
+            Logger?.LogTrace("STOPPED");
             return Task.CompletedTask;
         }