Using existing logger functionality.

Messages will be shown to the console
using the Logger functionality.

Adding a test that listens to the
logger and checks that logs are being
sent to console.

Fixing an issue when sending the log
to a file, as the OnDriverProcessStarted
method in the base class was not being
invoked.

Author: diemol

dotnet/src/webdriver/DriverService.cs

@@ -26,6 +26,7 @@
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
+using OpenQA.Selenium.Internal.Logging;
 
 namespace OpenQA.Selenium;
 
@@ -36,6 +37,8 @@ public abstract class DriverService : ICommandServer
 {
     private bool isDisposed;
     private Process? driverServiceProcess;
+    
+    private static readonly ILogger _logger = Log.GetLogger(typeof(DriverService));    
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DriverService"/> class.
@@ -156,7 +159,7 @@ public int ProcessId
     /// to the console. Defaults to <see langword="false"/>, meaning console output from the
     /// driver will be suppressed.
     /// </summary>
-    public bool LogToConsole { get; set; }
+    public bool LogToConsole { get; set; } = false;
 
     /// <summary>
     /// Gets the command-line arguments for the driver service.
@@ -250,11 +253,8 @@ public void Start()
         this.driverServiceProcess.StartInfo.UseShellExecute = false;
         this.driverServiceProcess.StartInfo.CreateNoWindow = this.HideCommandPromptWindow;
 
-        if (!this.LogToConsole)
-        {
-            this.driverServiceProcess.StartInfo.RedirectStandardOutput = true;
-            this.driverServiceProcess.StartInfo.RedirectStandardError = true;
-        }
+        this.driverServiceProcess.StartInfo.RedirectStandardOutput = this.LogToConsole;
+        this.driverServiceProcess.StartInfo.RedirectStandardError = this.LogToConsole;
 
         DriverProcessStartingEventArgs eventArgs = new DriverProcessStartingEventArgs(this.driverServiceProcess.StartInfo);
         this.OnDriverProcessStarting(eventArgs);
@@ -318,6 +318,16 @@ protected virtual void OnDriverProcessStarted(DriverProcessStartedEventArgs even
             throw new ArgumentNullException(nameof(eventArgs), "eventArgs must not be null");
         }
 
+        if (this.LogToConsole && eventArgs.StandardOutputStreamReader != null)
+        {
+            _ = Task.Run(() => ReadStreamAsync(eventArgs.StandardOutputStreamReader, "stdout"));
+        }
+
+        if (this.LogToConsole && eventArgs.StandardErrorStreamReader != null)
+        {
+            _ = Task.Run(() => ReadStreamAsync(eventArgs.StandardErrorStreamReader, "stderr"));
+        }
+
         this.DriverProcessStarted?.Invoke(this, eventArgs);
     }
 
@@ -399,4 +409,37 @@ private bool WaitForServiceInitialization()
 
         return isInitialized;
     }
+    
+    private async Task ReadStreamAsync(StreamReader reader, string streamType)
+    {
+        try
+        {
+            string? line;
+            while ((line = await reader.ReadLineAsync()) != null)
+            {
+                if (streamType.Equals("stdout", StringComparison.OrdinalIgnoreCase))
+                {
+                    if (_logger.IsEnabled(LogEventLevel.Info))
+                    {
+                        _logger.Info(line);
+                    }
+                }
+                else
+                {
+                    if (_logger.IsEnabled(LogEventLevel.Error))
+                    {
+                        _logger.Error(line);
+                    }
+                }
+            }
+        }
+        catch (Exception ex)
+        {
+            if (_logger.IsEnabled(LogEventLevel.Error))
+            {
+                _logger.Error($"Error reading stream: {ex.Message}");
+            }
+        }
+    }
+    
 }

dotnet/src/webdriver/Firefox/FirefoxDriverService.cs

@@ -23,6 +23,7 @@
 using System.IO;
 using System.Text;
 using System.Threading.Tasks;
+using OpenQA.Selenium.Internal.Logging;
 
 namespace OpenQA.Selenium.Firefox;
 
@@ -32,7 +33,8 @@ namespace OpenQA.Selenium.Firefox;
 public sealed class FirefoxDriverService : DriverService
 {
     private const string DefaultFirefoxDriverServiceFileName = "geckodriver";
-
+    private static readonly ILogger _logger = Log.GetLogger(typeof(FirefoxDriverService));
+    
     /// <summary>
     /// Process management fields for the log writer.
     /// </summary>
@@ -210,15 +212,10 @@ protected override void OnDriverProcessStarting(DriverProcessStartingEventArgs e
                 Directory.CreateDirectory(directory);
             }
 
-            // Initialize the log writer
             logWriter = new StreamWriter(this.LogPath, append: true) { AutoFlush = true };
 
-            // LogToConsole and LogPath are mutually exclusive, therefore we redirect log output.
-            if (this.LogToConsole)
-            {
-                eventArgs.DriverServiceProcessStartInfo.RedirectStandardOutput = true;
-                eventArgs.DriverServiceProcessStartInfo.RedirectStandardError = true;
-            }
+            eventArgs.DriverServiceProcessStartInfo.RedirectStandardOutput = true;
+            eventArgs.DriverServiceProcessStartInfo.RedirectStandardError = true;
         }
 
         base.OnDriverProcessStarting(eventArgs);
@@ -233,13 +230,12 @@ protected override void OnDriverProcessStarting(DriverProcessStartingEventArgs e
     /// </remarks>
     protected override void OnDriverProcessStarted(DriverProcessStartedEventArgs eventArgs)
     {
-        if (logWriter == null) return;
-        if (eventArgs.StandardOutputStreamReader != null)
+        if (!string.IsNullOrEmpty(this.LogPath) && eventArgs.StandardOutputStreamReader != null)
         {
             _ = Task.Run(() => ReadStreamAsync(eventArgs.StandardOutputStreamReader));
         }
 
-        if (eventArgs.StandardErrorStreamReader != null)
+        if (!string.IsNullOrEmpty(this.LogPath) && eventArgs.StandardErrorStreamReader != null)
         {
             _ = Task.Run(() => ReadStreamAsync(eventArgs.StandardErrorStreamReader));
         }
@@ -362,8 +358,10 @@ private async Task ReadStreamAsync(StreamReader reader)
         }
         catch (Exception ex)
         {
-            // Log or handle the exception appropriately
-            System.Diagnostics.Debug.WriteLine($"Error reading stream: {ex.Message}");
-        }
+            if (_logger.IsEnabled(LogEventLevel.Error))
+            {
+                _logger.Error($"Error reading stream: {ex.Message}");
+            }
+        }        
     }
 }

dotnet/test/firefox/FirefoxDriverServiceTest.cs

@@ -17,26 +17,51 @@
 // under the License.
 // </copyright>
 
+using System;
+using System.Collections.Generic;
 using NUnit.Framework;
 using System.IO;
+using OpenQA.Selenium.Internal.Logging;
 
 namespace OpenQA.Selenium.Firefox;
 
 [TestFixture]
-public class FirefoxDriverServiceTest : DriverTestFixture
+public class FirefoxDriverServiceTest
 {
+    private TestLogHandler testLogHandler;
+
+    private void ResetGlobalLog()
+    {
+        Log.SetLevel(LogEventLevel.Info);
+        Log.Handlers.Clear().Handlers.Add(new TextWriterHandler(Console.Error));
+    }
+
+    [SetUp]
+    public void SetUp()
+    {
+        ResetGlobalLog();
+
+        testLogHandler = new TestLogHandler();
+    }
+
+    [TearDown]
+    public void TearDown()
+    {
+        ResetGlobalLog();
+    }
+
     [Test]
     public void ShouldRedirectGeckoDriverLogsToFile()
     {
         FirefoxOptions options = new FirefoxOptions();
         string logPath = Path.GetTempFileName();
         options.LogLevel = FirefoxDriverLogLevel.Trace;
-
+    
         FirefoxDriverService service = FirefoxDriverService.CreateDefaultService();
         service.LogPath = logPath;
-
-        IWebDriver driver2 = new FirefoxDriver(service, options);
-
+    
+        IWebDriver firefoxDriver = new FirefoxDriver(service, options);
+    
         try
         {
             Assert.That(File.Exists(logPath), Is.True);
@@ -45,9 +70,46 @@ public void ShouldRedirectGeckoDriverLogsToFile()
         }
         finally
         {
-            driver2.Quit();
+            firefoxDriver.Quit();
             File.Delete(logPath);
         }
     }
+    
+    [Test]
+    public void ShouldRedirectGeckoDriverLogsToConsole()
+    {
+        Log.SetLevel(LogEventLevel.Info).Handlers.Add(testLogHandler);
+        FirefoxOptions options = new FirefoxOptions();
+        options.LogLevel = FirefoxDriverLogLevel.Info;
+    
+        FirefoxDriverService service = FirefoxDriverService.CreateDefaultService();
+        service.LogToConsole = true;
+    
+        IWebDriver firefoxDriver = new FirefoxDriver(service, options);
+    
+        try
+        {
+            Assert.That(testLogHandler.Events, Has.Count.AtLeast(1));
+            Assert.That(testLogHandler.Events[0].Message, Does.Contain("geckodriver"));
+        }
+        finally
+        {
+            firefoxDriver.Quit();
+        }
+    }    
+}
+
+class TestLogHandler : ILogHandler
+{
+    public ILogHandler Clone()
+    {
+        return this;
+    }
+
+    public void Handle(LogEvent logEvent)
+    {
+        Events.Add(logEvent);
+    }
 
+    public IList<LogEvent> Events { get; internal set; } = new List<LogEvent>();
 }