WIP [dotnet] Reusable DriverService instance by Drivers

dotnet/src/webdriver/Chrome/ChromeDriver.cs

@@ -84,7 +84,7 @@ public ChromeDriver()
         /// </summary>
         /// <param name="options">The <see cref="ChromeOptions"/> to be used with the Chrome driver.</param>
         public ChromeDriver(ChromeOptions options)
-            : this(ChromeDriverService.CreateDefaultService(), options, RemoteWebDriver.DefaultCommandTimeout)
+            : this(ChromeDriverService.CreateDefaultService(), disposeService: true, options, RemoteWebDriver.DefaultCommandTimeout)
         {
         }
 
@@ -126,7 +126,7 @@ public ChromeDriver(string chromeDriverDirectory, ChromeOptions options)
         /// <param name="options">The <see cref="ChromeOptions"/> to be used with the Chrome driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public ChromeDriver(string chromeDriverDirectory, ChromeOptions options, TimeSpan commandTimeout)
-            : this(ChromeDriverService.CreateDefaultService(chromeDriverDirectory), options, commandTimeout)
+            : this(ChromeDriverService.CreateDefaultService(chromeDriverDirectory), disposeService: true, options, commandTimeout)
         {
         }
 
@@ -148,7 +148,12 @@ public ChromeDriver(ChromeDriverService service, ChromeOptions options)
         /// <param name="options">The <see cref="ChromeOptions"/> to be used with the Chrome driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public ChromeDriver(ChromeDriverService service, ChromeOptions options, TimeSpan commandTimeout)
-            : base(service, options, commandTimeout)
+            : this(service, disposeService: false, options, commandTimeout)
+        {
+        }
+
+        private ChromeDriver(ChromeDriverService service, bool disposeService, ChromeOptions options, TimeSpan commandTimeout)
+            : base(service, disposeService, options, commandTimeout)
         {
             this.AddCustomChromeCommands();
         }

dotnet/src/webdriver/Chromium/ChromiumDriver.cs

@@ -107,6 +107,8 @@ public class ChromiumDriver : WebDriver, ISupportsLogs, IDevTools
         /// </summary>
         public static readonly string SetPermissionCommand = "setPermission";
 
+        private readonly ChromiumDriverService driverService;
+        private readonly bool disposeDriverService;
         private readonly string optionsCapabilityName;
         private DevToolsSession devToolsSession;
 
@@ -125,11 +127,14 @@ public class ChromiumDriver : WebDriver, ISupportsLogs, IDevTools
         /// Initializes a new instance of the <see cref="ChromiumDriver"/> class using the specified <see cref="ChromiumDriverService"/>.
         /// </summary>
         /// <param name="service">The <see cref="ChromiumDriverService"/> to use.</param>
+        /// <param name="disposeService">Wheter to dispose the original <paramref name="service"/>.</param>
         /// <param name="options">The <see cref="ChromiumOptions"/> to be used with the ChromiumDriver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
-        protected ChromiumDriver(ChromiumDriverService service, ChromiumOptions options, TimeSpan commandTimeout)
+        protected ChromiumDriver(ChromiumDriverService service, bool disposeService, ChromiumOptions options, TimeSpan commandTimeout)
             : base(GenerateDriverServiceCommandExecutor(service, options, commandTimeout), ConvertOptionsToCapabilities(options))
         {
+            this.driverService = service;
+            this.disposeDriverService = disposeService;
             this.optionsCapabilityName = options.CapabilityName;
         }
 
@@ -141,28 +146,25 @@ protected static IReadOnlyDictionary<string, CommandInfo> ChromiumCustomCommands
             get { return new ReadOnlyDictionary<string, CommandInfo>(chromiumCustomCommands); }
         }
 
-        /// <summary>
-        /// Uses DriverFinder to set Service attributes if necessary when creating the command executor
-        /// </summary>
-        /// <param name="service"></param>
-        /// <param name="commandTimeout"></param>
-        /// <param name="options"></param>
-        /// <returns></returns>
         private static ICommandExecutor GenerateDriverServiceCommandExecutor(DriverService service, DriverOptions options, TimeSpan commandTimeout)
         {
-            if (service.DriverServicePath == null)
+            if (service.DriverServicePath == null || string.IsNullOrEmpty(options.BinaryLocation))
             {
                 DriverFinder finder = new DriverFinder(options);
                 string fullServicePath = finder.GetDriverPath();
                 service.DriverServicePath = Path.GetDirectoryName(fullServicePath);
                 service.DriverServiceExecutableName = Path.GetFileName(fullServicePath);
+
                 if (finder.HasBrowserPath())
                 {
                     options.BinaryLocation = finder.GetBrowserPath();
                     options.BrowserVersion = null;
                 }
             }
-            return new DriverServiceCommandExecutor(service, commandTimeout);
+
+            service.Start();
+
+            return new HttpCommandExecutor(service.ServiceUrl, commandTimeout);
         }
 
         /// <summary>
@@ -469,6 +471,18 @@ protected override void Dispose(bool disposing)
                     this.devToolsSession.Dispose();
                     this.devToolsSession = null;
                 }
+
+                if (this.SessionId is not null)
+                {
+                    this.Execute(DriverCommand.Quit, null);
+
+                    this.SessionId = null;
+                }
+
+                if (this.disposeDriverService)
+                {
+                    this.driverService.Dispose();
+                }
             }
 
             base.Dispose(disposing);

dotnet/src/webdriver/DriverService.cs

@@ -41,6 +41,7 @@ public abstract class DriverService : ICommandServer
         private bool hideCommandPromptWindow;
         private bool isDisposed;
         private Process driverServiceProcess;
+        private object driverServiceProcessLock = new object();
         private TimeSpan initializationTimeout = TimeSpan.FromSeconds(20);
 
         /// <summary>
@@ -258,38 +259,42 @@ public void Dispose()
         /// </summary>
         public void Start()
         {
-            if (this.driverServiceProcess != null)
+            if (this.driverServiceProcess is null)
             {
-                return;
-            }
-
-            this.driverServiceProcess = new Process();
+                lock (this.driverServiceProcessLock)
+                {
+                    if (driverServiceProcess is null)
+                    {
+                        this.driverServiceProcess = new Process();
 
-            if (this.driverServicePath != null)
-            {
-                this.driverServiceProcess.StartInfo.FileName = Path.Combine(this.driverServicePath, this.driverServiceExecutableName);
-            }
-            else
-            {
-                this.driverServiceProcess.StartInfo.FileName = new DriverFinder(this.GetDefaultDriverOptions()).GetDriverPath();
-            }
+                        if (this.driverServicePath != null)
+                        {
+                            this.driverServiceProcess.StartInfo.FileName = Path.Combine(this.driverServicePath, this.driverServiceExecutableName);
+                        }
+                        else
+                        {
+                            this.driverServiceProcess.StartInfo.FileName = new DriverFinder(this.GetDefaultDriverOptions()).GetDriverPath();
+                        }
 
-            this.driverServiceProcess.StartInfo.Arguments = this.CommandLineArguments;
-            this.driverServiceProcess.StartInfo.UseShellExecute = false;
-            this.driverServiceProcess.StartInfo.CreateNoWindow = this.hideCommandPromptWindow;
+                        this.driverServiceProcess.StartInfo.Arguments = this.CommandLineArguments;
+                        this.driverServiceProcess.StartInfo.UseShellExecute = false;
+                        this.driverServiceProcess.StartInfo.CreateNoWindow = this.hideCommandPromptWindow;
 
-            DriverProcessStartingEventArgs eventArgs = new DriverProcessStartingEventArgs(this.driverServiceProcess.StartInfo);
-            this.OnDriverProcessStarting(eventArgs);
+                        DriverProcessStartingEventArgs eventArgs = new DriverProcessStartingEventArgs(this.driverServiceProcess.StartInfo);
+                        this.OnDriverProcessStarting(eventArgs);
 
-            this.driverServiceProcess.Start();
-            bool serviceAvailable = this.WaitForServiceInitialization();
-            DriverProcessStartedEventArgs processStartedEventArgs = new DriverProcessStartedEventArgs(this.driverServiceProcess);
-            this.OnDriverProcessStarted(processStartedEventArgs);
+                        this.driverServiceProcess.Start();
+                        bool serviceAvailable = this.WaitForServiceInitialization();
+                        DriverProcessStartedEventArgs processStartedEventArgs = new DriverProcessStartedEventArgs(this.driverServiceProcess);
+                        this.OnDriverProcessStarted(processStartedEventArgs);
 
-            if (!serviceAvailable)
-            {
-                string msg = "Cannot start the driver service on " + this.ServiceUrl;
-                throw new WebDriverException(msg);
+                        if (!serviceAvailable)
+                        {
+                            string msg = "Cannot start the driver service on " + this.ServiceUrl;
+                            throw new WebDriverException(msg);
+                        }
+                    }
+                }
             }
         }
 

dotnet/src/webdriver/Edge/EdgeDriver.cs

@@ -54,7 +54,7 @@ public EdgeDriver()
         /// </summary>
         /// <param name="options">The <see cref="EdgeOptions"/> to be used with the Edge driver.</param>
         public EdgeDriver(EdgeOptions options)
-            : this(EdgeDriverService.CreateDefaultService(), options)
+            : this(EdgeDriverService.CreateDefaultService(), disposeService: true, options, RemoteWebDriver.DefaultCommandTimeout)
         {
         }
 
@@ -96,7 +96,7 @@ public EdgeDriver(string edgeDriverDirectory, EdgeOptions options)
         /// <param name="options">The <see cref="EdgeOptions"/> to be used with the Edge driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public EdgeDriver(string edgeDriverDirectory, EdgeOptions options, TimeSpan commandTimeout)
-            : this(EdgeDriverService.CreateDefaultService(edgeDriverDirectory), options, commandTimeout)
+            : this(EdgeDriverService.CreateDefaultService(edgeDriverDirectory), disposeService: true, options, commandTimeout)
         {
         }
 
@@ -118,7 +118,12 @@ public EdgeDriver(EdgeDriverService service, EdgeOptions options)
         /// <param name="options">The <see cref="EdgeOptions"/> to be used with the Edge driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public EdgeDriver(EdgeDriverService service, EdgeOptions options, TimeSpan commandTimeout)
-            : base(service, options, commandTimeout)
+            : this(service, disposeService: false, options, commandTimeout)
+        {
+        }
+
+        private EdgeDriver(EdgeDriverService service, bool disposeService, EdgeOptions options, TimeSpan commandTimeout)
+            : base(service, disposeService, options, commandTimeout)
         {
             this.AddCustomEdgeCommands();
         }

dotnet/src/webdriver/Firefox/FirefoxDriver.cs

@@ -110,6 +110,8 @@ public class FirefoxDriver : WebDriver, IDevTools
             { GetFullPageScreenshotCommand, new HttpCommandInfo(HttpCommandInfo.GetCommand, "/session/{sessionId}/moz/screenshot/full") }
         };
 
+        private FirefoxDriverService driverService;
+        private bool disposeDriverService;
         private DevToolsSession devToolsSession;
 
         /// <summary>
@@ -125,7 +127,7 @@ public FirefoxDriver()
         /// </summary>
         /// <param name="options">The <see cref="FirefoxOptions"/> to be used with the Firefox driver.</param>
         public FirefoxDriver(FirefoxOptions options)
-            : this(FirefoxDriverService.CreateDefaultService(), options, RemoteWebDriver.DefaultCommandTimeout)
+            : this(FirefoxDriverService.CreateDefaultService(), disposeService: true, options, RemoteWebDriver.DefaultCommandTimeout)
         {
         }
 
@@ -167,7 +169,7 @@ public FirefoxDriver(string geckoDriverDirectory, FirefoxOptions options)
         /// <param name="options">The <see cref="FirefoxOptions"/> to be used with the Firefox driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public FirefoxDriver(string geckoDriverDirectory, FirefoxOptions options, TimeSpan commandTimeout)
-            : this(FirefoxDriverService.CreateDefaultService(geckoDriverDirectory), options, commandTimeout)
+            : this(FirefoxDriverService.CreateDefaultService(geckoDriverDirectory), disposeService: true, options, commandTimeout)
         {
         }
 
@@ -188,8 +190,17 @@ public FirefoxDriver(FirefoxDriverService service, FirefoxOptions options)
         /// <param name="options">The <see cref="FirefoxOptions"/> to be used with the Firefox driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public FirefoxDriver(FirefoxDriverService service, FirefoxOptions options, TimeSpan commandTimeout)
+            : this(service, disposeService: false, options, commandTimeout)
+        {
+
+        }
+
+        private FirefoxDriver(FirefoxDriverService service, bool disposeService, FirefoxOptions options, TimeSpan commandTimeout)
             : base(GenerateDriverServiceCommandExecutor(service, options, commandTimeout), ConvertOptionsToCapabilities(options))
         {
+            this.driverService = service;
+            this.disposeDriverService = disposeService;
+
             // Add the custom commands unique to Firefox
             this.AddCustomFirefoxCommands();
         }
@@ -203,19 +214,23 @@ public FirefoxDriver(FirefoxDriverService service, FirefoxOptions options, TimeS
         /// <returns></returns>
         private static ICommandExecutor GenerateDriverServiceCommandExecutor(DriverService service, DriverOptions options, TimeSpan commandTimeout)
         {
-            if (service.DriverServicePath == null)
+            if (service.DriverServicePath == null || string.IsNullOrEmpty(options.BinaryLocation))
             {
                 DriverFinder finder = new DriverFinder(options);
                 string fullServicePath = finder.GetDriverPath();
                 service.DriverServicePath = Path.GetDirectoryName(fullServicePath);
                 service.DriverServiceExecutableName = Path.GetFileName(fullServicePath);
+
                 if (finder.HasBrowserPath())
                 {
                     options.BinaryLocation = finder.GetBrowserPath();
                     options.BrowserVersion = null;
                 }
             }
-            return new DriverServiceCommandExecutor(service, commandTimeout);
+
+            service.Start();
+
+            return new HttpCommandExecutor(service.ServiceUrl, commandTimeout);
         }
 
         /// <summary>
@@ -474,6 +489,32 @@ protected override void Dispose(bool disposing)
                     this.devToolsSession.Dispose();
                     this.devToolsSession = null;
                 }
+
+                if (this.SessionId is not null)
+                {
+                    try
+                    {
+                        this.Execute(DriverCommand.Quit, null);
+                    }
+                    catch (NotImplementedException)
+                    {
+                    }
+                    catch (InvalidOperationException)
+                    {
+                    }
+                    catch (WebDriverException)
+                    {
+                    }
+                    finally
+                    {
+                        this.SessionId = null;
+                    }
+                }
+
+                if (this.disposeDriverService)
+                {
+                    this.driverService.Dispose();
+                }
             }
 
             base.Dispose(disposing);