[dotnet] Rename TerminateDevToolsSession to ResetDevToolsSession

For the case where a CDP session is made invalid, for example, because a window is closed, this method will now reset the CDP session so that the user can continue to use it without closing and establishing a new web socket connection. Also added disposal of DevTools sessions to Firefox and Remote when required.
SeleniumHQ · Sep 22, 2021 · 702b1c7 · 702b1c7
1 parent 5a6504a
commit 702b1c7
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 42 deletions.
diff --git a/dotnet/src/webdriver/Chromium/ChromiumDriver.cs b/dotnet/src/webdriver/Chromium/ChromiumDriver.cs
@@ -216,12 +216,15 @@ public DevToolsSession GetDevToolsSession(int devToolsProtocolVersion)
             return this.devToolsSession;
         }
 
-        public void TerminateDevToolsSession()
+        /// <summary>
+        /// Resets a DevTools session
+        /// </summary>
+        public void ResetDevToolsSession()
         {
             if (this.devToolsSession != null)
             {
-                this.devToolsSession.Dispose();
-                this.devToolsSession = null;
+                this.devToolsSession.ActiveSessionId = null;
+                this.devToolsSession.InitializeSession().ConfigureAwait(false).GetAwaiter().GetResult();
             }
         }
 

diff --git a/dotnet/src/webdriver/DevTools/DevToolsSession.cs b/dotnet/src/webdriver/DevTools/DevToolsSession.cs
@@ -249,10 +249,49 @@ public T GetVersionSpecificDomains<T>() where T: DevToolsSessionDomains
         /// <summary>
         /// Asynchronously starts the session.
         /// </summary>
-        /// <param name="protocolVersion">The version of the protocol to use in communicating with the browswer.</param>
+        /// <param name="requestedProtocolVersion">The requested version of the protocol to use in communicating with the browswer.</param>
         /// <returns>A task that represents the asynchronous operation.</returns>
-        internal async Task Start(int protocolVersion)
+        internal async Task Start(int requestedProtocolVersion)
         {
+            int protocolVersion = await InitializeProtocol(requestedProtocolVersion);
+            this.domains = DevToolsDomains.InitializeDomains(protocolVersion, this);
+            await this.InitializeSession();
+        }
+
+        internal async Task InitializeSession()
+        {
+            string targetId = null;
+            var targets = await this.domains.Target.GetTargets();
+            foreach (var target in targets)
+            {
+                if (target.Type == "page")
+                {
+                    targetId = target.TargetId;
+                    LogTrace("Found Target ID {0}.", targetId);
+                    string sessionId = await this.domains.Target.AttachToTarget(targetId);
+                    LogTrace("Target ID {0} attached. Active session ID: {1}", targetId, sessionId);
+                    this.ActiveSessionId = sessionId;
+                    break;
+                }
+            }
+
+            await this.domains.Target.SetAutoAttach();
+            LogTrace("AutoAttach is set.", targetId);
+            try
+            {
+                // Wrap this in a try-catch, because it's not the end of the
+                // world if clearing the log doesn't work.
+                await this.domains.Log.Clear();
+                LogTrace("Log cleared.", targetId);
+            }
+            catch (WebDriverException)
+            {
+            }
+        }
+
+        private async Task<int> InitializeProtocol(int requestedProtocolVersion)
+        {
+            int protocolVersion = requestedProtocolVersion;
             if (this.websocketAddress == null)
             {
                 string debuggerUrl = string.Format(CultureInfo.InvariantCulture, "http://{0}", this.debuggerEndpoint);
@@ -266,7 +305,7 @@ internal async Task Start(int protocolVersion)
                 var versionInfo = JsonConvert.DeserializeObject<DevToolsVersionInfo>(rawVersionInfo);
                 this.websocketAddress = versionInfo.WebSocketDebuggerUrl;
 
-                if (protocolVersion == AutoDetectDevToolsProtocolVersion)
+                if (requestedProtocolVersion == AutoDetectDevToolsProtocolVersion)
                 {
                     bool versionParsed = int.TryParse(versionInfo.BrowserMajorVersion, out protocolVersion);
                     if (!versionParsed)
@@ -283,35 +322,7 @@ internal async Task Start(int protocolVersion)
                 }
             }
 
-            this.domains = DevToolsDomains.InitializeDomains(protocolVersion, this);
-
-            string targetId = null;
-            var targets = await this.domains.Target.GetTargets();
-            foreach(var target in targets)
-            {
-                if (target.Type == "page")
-                {
-                    targetId = target.TargetId;
-                    LogTrace("Found Target ID {0}.", targetId);
-                    string sessionId = await this.domains.Target.AttachToTarget(targetId);
-                    LogTrace("Target ID {0} attached. Active session ID: {1}", targetId, sessionId);
-                    this.ActiveSessionId = sessionId;
-                    break;
-                }
-            }
-
-            await this.domains.Target.SetAutoAttach();
-            LogTrace("AutoAttach is set.", targetId);
-            try
-            {
-                // Wrap this in a try-catch, because it's not the end of the
-                // world if clearing the log doesn't work.
-                await this.domains.Log.Clear();
-                LogTrace("Log cleared.", targetId);
-            }
-            catch (WebDriverException)
-            {
-            }
+            return protocolVersion;
         }
 
         private async Task OpenSessionConnection(CancellationToken cancellationToken)

diff --git a/dotnet/src/webdriver/DevTools/IDevTools.cs b/dotnet/src/webdriver/DevTools/IDevTools.cs
@@ -36,6 +36,9 @@ public interface IDevTools
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
         DevToolsSession GetDevToolsSession(int protocolVersion);
 
-        void TerminateDevToolsSession();
+        /// <summary>
+        /// Resets a DevTools session
+        /// </summary>
+        void ResetDevToolsSession();
     }
 }
diff --git a/dotnet/src/webdriver/Firefox/FirefoxDriver.cs b/dotnet/src/webdriver/Firefox/FirefoxDriver.cs
@@ -300,12 +300,15 @@ public DevToolsSession GetDevToolsSession(int devToolsProtocolVersion)
             return this.devToolsSession;
         }
 
-        public void TerminateDevToolsSession()
+        /// <summary>
+        /// Resets a DevTools session
+        /// </summary>
+        public void ResetDevToolsSession()
         {
             if (this.devToolsSession != null)
             {
-                this.devToolsSession.Dispose();
-                this.devToolsSession = null;
+                this.devToolsSession.ActiveSessionId = null;
+                this.devToolsSession.InitializeSession().ConfigureAwait(false).GetAwaiter().GetResult();
             }
         }
 
@@ -317,6 +320,19 @@ protected virtual void PrepareEnvironment()
             // Does nothing, but provides a hook for subclasses to do "stuff"
         }
 
+        protected override void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                if (this.devToolsSession != null)
+                {
+                    this.devToolsSession.Dispose();
+                }
+            }
+
+            base.Dispose(disposing);
+        }
+
         private static ICapabilities ConvertOptionsToCapabilities(FirefoxOptions options)
         {
             if (options == null)

diff --git a/dotnet/src/webdriver/Remote/RemoteWebDriver.cs b/dotnet/src/webdriver/Remote/RemoteWebDriver.cs
@@ -444,13 +444,29 @@ public DevToolsSession GetDevToolsSession(int protocolVersion)
             return this.devToolsSession;
         }
 
-        public void TerminateDevToolsSession()
+        /// <summary>
+        /// Resets a DevTools session
+        /// </summary>
+        public void ResetDevToolsSession()
         {
             if (this.devToolsSession != null)
             {
-                this.devToolsSession.Dispose();
-                this.devToolsSession = null;
+                this.devToolsSession.ActiveSessionId = null;
+                this.devToolsSession.InitializeSession().ConfigureAwait(false).GetAwaiter().GetResult();
+            }
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                if (this.devToolsSession != null)
+                {
+                    this.devToolsSession.Dispose();
+                }
             }
+
+            base.Dispose(disposing);
         }
 
         private static ICapabilities ConvertOptionsToCapabilities(DriverOptions options)