Updating .NET DevTools code to persist DevTools session once created

Author: jimevans

dotnet/src/webdriver/Chromium/ChromiumDriver.cs

@@ -45,6 +45,7 @@ public abstract class ChromiumDriver : RemoteWebDriver, ISupportsLogs, IDevTools
         private const string SendChromeCommandWithResult = "sendChromeCommandWithResult";
 
         private readonly string optionsCapabilityName;
+        private DevToolsSession devToolsSession;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ChromiumDriver"/> class using the specified
@@ -169,7 +170,7 @@ public object ExecuteChromeCommandWithResult(string commandName, Dictionary<stri
         /// </summary>
         /// <param name="devToolsProtocolVersion">The version of the Chromium Developer Tools protocol to use. Defaults to autodetect the protocol version.</param>
         /// <returns>The active session to use to communicate with the Chromium Developer Tools debugging protocol.</returns>
-        public DevToolsSession CreateDevToolsSession()
+        public DevToolsSession GetDevToolsSession()
         {
             return CreateDevToolsSession(DevToolsSession.AutoDetectDevToolsProtocolVersion);
         }
@@ -181,33 +182,51 @@ public DevToolsSession CreateDevToolsSession()
         /// <returns>The active session to use to communicate with the Chromium Developer Tools debugging protocol.</returns>
         public DevToolsSession CreateDevToolsSession(int devToolsProtocolVersion)
         {
-            if (!this.Capabilities.HasCapability(this.optionsCapabilityName))
+            if (this.devToolsSession == null)
             {
-                throw new WebDriverException("Cannot find " + this.optionsCapabilityName + " capability for driver");
-            }
+                if (!this.Capabilities.HasCapability(this.optionsCapabilityName))
+                {
+                    throw new WebDriverException("Cannot find " + this.optionsCapabilityName + " capability for driver");
+                }
 
-            Dictionary<string, object> options = this.Capabilities.GetCapability(this.optionsCapabilityName) as Dictionary<string, object>;
-            if (options == null)
-            {
-                throw new WebDriverException("Found " + this.optionsCapabilityName + " capability, but is not an object");
-            }
+                Dictionary<string, object> options = this.Capabilities.GetCapability(this.optionsCapabilityName) as Dictionary<string, object>;
+                if (options == null)
+                {
+                    throw new WebDriverException("Found " + this.optionsCapabilityName + " capability, but is not an object");
+                }
 
-            if (!options.ContainsKey("debuggerAddress"))
-            {
-                throw new WebDriverException("Did not find debuggerAddress capability in " + this.optionsCapabilityName);
-            }
+                if (!options.ContainsKey("debuggerAddress"))
+                {
+                    throw new WebDriverException("Did not find debuggerAddress capability in " + this.optionsCapabilityName);
+                }
 
-            string debuggerAddress = options["debuggerAddress"].ToString();
-            try
-            {
-                DevToolsSession session = new DevToolsSession(debuggerAddress);
-                session.Start(devToolsProtocolVersion).ConfigureAwait(false).GetAwaiter().GetResult();
-                return session;
+                string debuggerAddress = options["debuggerAddress"].ToString();
+                try
+                {
+                    DevToolsSession session = new DevToolsSession(debuggerAddress);
+                    session.Start(devToolsProtocolVersion).ConfigureAwait(false).GetAwaiter().GetResult();
+                    this.devToolsSession = session;
+                }
+                catch (Exception e)
+                {
+                    throw new WebDriverException("Unexpected error creating WebSocket DevTools session.", e);
+                }
             }
-            catch (Exception e)
+
+            return this.devToolsSession;
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            if (disposing)
             {
-                throw new WebDriverException("Unexpected error creating WebSocket DevTools session.", e);
+                if (this.devToolsSession != null)
+                {
+                    this.devToolsSession.Dispose();
+                }
             }
+
+            base.Dispose(disposing);
         }
 
         private static ICapabilities ConvertOptionsToCapabilities(ChromiumOptions options)

dotnet/src/webdriver/DevTools/IDevTools.cs

@@ -27,6 +27,13 @@ public interface IDevTools
         /// Creates a session to communicate with a browser using a Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
-        DevToolsSession CreateDevToolsSession();
+        DevToolsSession GetDevToolsSession();
+
+        /// <summary>
+        /// Creates a session to communicate with a browser using a specific version of the Developer Tools debugging protocol.
+        /// </summary>
+        /// <param name="protocolVersion">The specific version of the Developer Tools debugging protocol to use.</param>
+        /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
+        DevToolsSession GetDevToolsSession(int protocolVersion);
     }
 }