[py] Configure WebSocket timeout and wait interval via ClientConfig

Author: cgoldberg

py/selenium/webdriver/remote/client_config.py

@@ -50,22 +50,19 @@ class ClientConfig:
     keep_alive = _ClientConfigDescriptor("_keep_alive")
     """Gets and Sets Keep Alive value."""
     proxy = _ClientConfigDescriptor("_proxy")
-    """Gets and Sets the proxy used for communicating to the driver/server."""
+    """Gets and Sets the proxy used for communicating with the driver/server."""
     ignore_certificates = _ClientConfigDescriptor("_ignore_certificates")
     """Gets and Sets the ignore certificate check value."""
     init_args_for_pool_manager = _ClientConfigDescriptor("_init_args_for_pool_manager")
     """Gets and Sets the ignore certificate check."""
     timeout = _ClientConfigDescriptor("_timeout")
-    """Gets and Sets the timeout (in seconds) used for communicating to the
-    driver/server."""
+    """Gets and Sets the timeout (in seconds) used for communicating with the driver/server."""
     ca_certs = _ClientConfigDescriptor("_ca_certs")
     """Gets and Sets the path to bundle of CA certificates."""
     username = _ClientConfigDescriptor("_username")
-    """Gets and Sets the username used for basic authentication to the
-    remote."""
+    """Gets and Sets the username used for basic authentication to the remote."""
     password = _ClientConfigDescriptor("_password")
-    """Gets and Sets the password used for basic authentication to the
-    remote."""
+    """Gets and Sets the password used for basic authentication to the remote."""
     auth_type = _ClientConfigDescriptor("_auth_type")
     """Gets and Sets the type of authentication to the remote server."""
     token = _ClientConfigDescriptor("_token")
@@ -74,6 +71,10 @@ class ClientConfig:
     """Gets and Sets user agent to be added to the request headers."""
     extra_headers = _ClientConfigDescriptor("_extra_headers")
     """Gets and Sets extra headers to be added to the request."""
+    websocket_timeout = _ClientConfigDescriptor("_websocket_timeout")
+    """Gets and Sets the WebSocket response wait timeout (in seconds) used for communicating with the browser."""
+    websocket_interval = _ClientConfigDescriptor("_websocket_interval")
+    """Gets and Sets the WebSocket response wait interval (in seconds) used for communicating with the browser."""
 
     def __init__(
         self,
@@ -90,6 +91,8 @@ def __init__(
         token: Optional[str] = None,
         user_agent: Optional[str] = None,
         extra_headers: Optional[dict] = None,
+        websocket_timeout: Optional[float] = 30.0,
+        websocket_interval: Optional[float] = 0.1,
     ) -> None:
         self.remote_server_addr = remote_server_addr
         self.keep_alive = keep_alive
@@ -103,6 +106,8 @@ def __init__(
         self.token = token
         self.user_agent = user_agent
         self.extra_headers = extra_headers
+        self.websocket_timeout = websocket_timeout
+        self.websocket_interval = websocket_interval
 
         self.ca_certs = (
             (os.getenv("REQUESTS_CA_BUNDLE") if "REQUESTS_CA_BUNDLE" in os.environ else certifi.where())

py/selenium/webdriver/remote/webdriver.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 """The WebDriver implementation."""
 
 import base64
@@ -1211,7 +1212,9 @@ def start_devtools(self):
             return self._devtools, self._websocket_connection
         if self.caps["browserName"].lower() == "firefox":
             raise RuntimeError("CDP support for Firefox has been removed. Please switch to WebDriver BiDi.")
-        self._websocket_connection = WebSocketConnection(ws_url)
+        self._websocket_connection = WebSocketConnection(
+            ws_url, self.client_config.websocket_timeout, self.client_config.websocket_interval
+        )
         targets = self._websocket_connection.execute(self._devtools.target.get_targets())
         for target in targets:
             if target.target_id == self.current_window_handle:
@@ -1260,7 +1263,9 @@ def _start_bidi(self):
         else:
             raise WebDriverException("Unable to find url to connect to from capabilities")
 
-        self._websocket_connection = WebSocketConnection(ws_url)
+        self._websocket_connection = WebSocketConnection(
+            ws_url, self.client_config.websocket_timeout, self.client_config.websocket_interval
+        )
 
     @property
     def network(self):

py/selenium/webdriver/remote/websocket_connection.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 import json
 import logging
 from ssl import CERT_NONE
@@ -28,15 +29,14 @@
 
 
 class WebSocketConnection:
-    _response_wait_timeout = 30
-    _response_wait_interval = 0.1
-
     _max_log_message_size = 9999
 
-    def __init__(self, url):
+    def __init__(self, url, timeout, interval):
         self.callbacks = {}
         self.session_id = None
         self.url = url
+        self.response_wait_timeout = timeout
+        self.response_wait_interval = interval
 
         self._id = 0
         self._messages = {}
@@ -46,7 +46,7 @@ def __init__(self, url):
         self._wait_until(lambda: self._started)
 
     def close(self):
-        self._ws_thread.join(timeout=self._response_wait_timeout)
+        self._ws_thread.join(timeout=self.response_wait_timeout)
         self._ws.close()
         self._started = False
         self._ws = None
@@ -142,8 +142,8 @@ def _process_message(self, message):
                 Thread(target=callback, args=(params,)).start()
 
     def _wait_until(self, condition):
-        timeout = self._response_wait_timeout
-        interval = self._response_wait_interval
+        timeout = self.response_wait_timeout
+        interval = self.response_wait_interval
 
         while timeout > 0:
             result = condition()