Making .NET ICommandExecutor interface extend IDisposable

Author: jimevans

dotnet/src/webdriver/DriverService.cs

@@ -38,6 +38,7 @@ public abstract class DriverService : ICommandServer
         private int driverServicePort;
         private bool silent;
         private bool hideCommandPromptWindow;
+        private bool isDisposed;
         private Process driverServiceProcess;
 
         /// <summary>
@@ -285,9 +286,14 @@ protected static string FindDriverServiceExecutable(string executableName, Uri d
         /// <param name="disposing"><see langword="true"/> if the Dispose method was explicitly called; otherwise, <see langword="false"/>.</param>
         protected virtual void Dispose(bool disposing)
         {
-            if (disposing)
+            if (!this.isDisposed)
             {
-                this.Stop();
+                if (disposing)
+                {
+                    this.Stop();
+                }
+
+                this.isDisposed = true;
             }
         }
 

dotnet/src/webdriver/Remote/DriverServiceCommandExecutor.cs

@@ -1,4 +1,4 @@
-// <copyright file="DriverServiceCommandExecutor.cs" company="WebDriver Committers">
+// <copyright file="DriverServiceCommandExecutor.cs" company="WebDriver Committers">
 // Licensed to the Software Freedom Conservancy (SFC) under one
 // or more contributor license agreements. See the NOTICE file
 // distributed with this work for additional information
@@ -27,6 +27,7 @@ internal class DriverServiceCommandExecutor : ICommandExecutor
     {
         private DriverService service;
         private HttpCommandExecutor internalExecutor;
+        private bool isDisposed;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="DriverServiceCommandExecutor"/> class.
@@ -87,11 +88,38 @@ public Response Execute(Command commandToExecute)
             {
                 if (commandToExecute.Name == DriverCommand.Quit)
                 {
-                    this.service.Dispose();
+                    this.Dispose();
                 }
             }
 
             return toReturn;
         }
+
+        /// <summary>
+        /// Releases all resources used by the <see cref="DriverServiceCommandExecutor"/>.
+        /// </summary>
+        public void Dispose()
+        {
+            this.Dispose(true);
+        }
+
+        /// <summary>
+        /// Releases the unmanaged resources used by the <see cref="HttpCommandExecutor"/> and
+        /// optionally releases the managed resources.
+        /// </summary>
+        /// <param name="disposing"><see langword="true"/> to release managed and resources;
+        /// <see langword="false"/> to only release unmanaged resources.</param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!this.isDisposed)
+            {
+                if (disposing)
+                {
+                    this.service.Dispose();
+                }
+
+                this.isDisposed = true;
+            }
+        }
     }
 }

dotnet/src/webdriver/Remote/HttpCommandExecutor.cs

@@ -40,6 +40,7 @@ public class HttpCommandExecutor : ICommandExecutor
         private Uri remoteServerUri;
         private TimeSpan serverResponseTimeout;
         private bool enableKeepAlive;
+        private bool isDisposed;
         private CommandInfoRepository commandInfoRepository = new WebDriverWireProtocolCommandInfoRepository();
 
         /// <summary>
@@ -292,6 +293,28 @@ private Response CreateResponse(HttpResponseInfo stuff)
             return commandResponse;
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="HttpCommandExecutor"/>.
+        /// </summary>
+        public void Dispose()
+        {
+            this.Dispose(true);
+        }
+
+        /// <summary>
+        /// Releases the unmanaged resources used by the <see cref="HttpCommandExecutor"/> and
+        /// optionally releases the managed resources.
+        /// </summary>
+        /// <param name="disposing"><see langword="true"/> to release managed and resources;
+        /// <see langword="false"/> to only release unmanaged resources.</param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!this.isDisposed)
+            {
+                this.isDisposed = true;
+            }
+        }
+
         private class HttpRequestInfo
         {
             public HttpRequestInfo(Uri serverUri, Command commandToExecute, CommandInfo commandInfo)

dotnet/src/webdriver/Remote/ICommandExecutor.cs

@@ -1,4 +1,4 @@
-// <copyright file="ICommandExecutor.cs" company="WebDriver Committers">
+// <copyright file="ICommandExecutor.cs" company="WebDriver Committers">
 // Licensed to the Software Freedom Conservancy (SFC) under one
 // or more contributor license agreements. See the NOTICE file
 // distributed with this work for additional information
@@ -16,12 +16,14 @@
 // limitations under the License.
 // </copyright>
 
+using System;
+
 namespace OpenQA.Selenium.Remote
 {
     /// <summary>
     /// Provides a way to send commands to the remote server
     /// </summary>
-    public interface ICommandExecutor
+    public interface ICommandExecutor : IDisposable
     {
         /// <summary>
         /// Gets the repository of objects containin information about commands.

dotnet/src/webdriver/Remote/RemoteWebDriver.cs

@@ -1091,6 +1091,11 @@ protected virtual void Dispose(bool disposing)
             }
             finally
             {
+                if (this.CommandExecutor != null)
+                {
+                    this.CommandExecutor.Dispose();
+                }
+
                 this.StopClient();
                 this.sessionId = null;
             }