Merge pull request #36 from scivisum/bug/RD-41645_optimise_performance

[RD-41645] Use a threading Event to speed up message polling

Author: erustusagutu

browserdebuggertools/chrome/interface.py

@@ -90,7 +90,7 @@ def set_timeout(self, value):
             self._session_manager.timeout = _timeout
 
     def navigate(self, url):
-        """ Navigates to the given url asynchronously
+        """ Navigates to the given url
         """
         return self.execute("Page", "navigate", {
             "url": url

browserdebuggertools/wssessionmanager.py

@@ -4,7 +4,7 @@
 import socket
 import time
 import collections
-from threading import Thread, Lock
+from threading import Thread, Lock, Event
 
 from typing import Dict
 
@@ -28,7 +28,7 @@ class _WSMessageProducer(Thread):
     """
     _CONN_TIMEOUT = 15
     _BLOCKED_TIMEOUT = 5
-    _POLL_INTERVAL = 0.01  # How long to wait for new ws messages
+    _POLL_INTERVAL = 1  # How long to wait for new ws messages
 
     def __init__(self, port, send_queue, on_message):
         super(_WSMessageProducer, self).__init__()
@@ -41,6 +41,7 @@ def __init__(self, port, send_queue, on_message):
         self.exception = None
         self.ws = self._get_websocket()
         self.daemon = True
+        self.poll_signal = Event()
 
     def __del__(self):
         self.close()
@@ -122,8 +123,9 @@ def run(self):
                 self._last_ws_attempt = time.time()
                 self._empty_send_queue()
                 self._empty_websocket()
-
-                time.sleep(self._POLL_INTERVAL)
+                self.poll_signal.wait(self._POLL_INTERVAL)
+                if self.poll_signal.isSet():
+                    self.poll_signal.clear()
 
     @property
     def blocked(self):
@@ -386,6 +388,7 @@ def _wait_for_result(self, result_id):
                 return self._results.pop(result_id)
 
             self._check_message_producer()
+            self._message_producer.poll_signal.set()
             time.sleep(0.01)
         raise DevToolsTimeoutException(
             "Reached timeout limit of {}, waiting for a response message".format(self.timeout)

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name="browserdebuggertools",
-    version="6.0.1",
+    version="6.0.2",
     python_requires='>=3.8',
     packages=PACKAGES,
     install_requires=requires,

tests/unittests/test_wssessionmanager.py

@@ -1,6 +1,7 @@
 import collections
 import copy
 import socket
+import time
 from unittest import TestCase
 
 from mock import patch, MagicMock, call, PropertyMock
@@ -173,13 +174,11 @@ def test_fail(self):
         ], self.processed_messages)
 
 
-@patch(MODULE_PATH + "time")
 @patch(MODULE_PATH + "_WSMessageProducer._empty_send_queue", MagicMock())
 @patch(MODULE_PATH + "_WSMessageProducer._empty_websocket", MagicMock())
 class Test__WSMessageProducer_run(WSMessageProducerTest):
 
-    def prepare(self, time):
-        _WSMessageProducer._POLL_INTERVAL = 0
+    def prepare(self, time_):
         self.next_time = 0
 
         def increment_time():
@@ -190,25 +189,60 @@ def increment_time():
 
             return current_time
 
-        time.time = increment_time
+        time_.time = increment_time
 
-    def test(self, time):
-        self.prepare(time)
+    @patch(MODULE_PATH + "_WSMessageProducer._POLL_INTERVAL", 0)
+    @patch(MODULE_PATH + "time")
+    def test(self, time_):
+        self.prepare(time_)
 
         self.ws_message_producer.run()
 
         self.assertEqual(10, self.ws_message_producer._last_ws_attempt)
 
-    def test_exception(self, time):
+    @patch(MODULE_PATH + "_WSMessageProducer._POLL_INTERVAL", 0)
+    @patch(MODULE_PATH + "time")
+    def test_exception(self, time_):
         exception = Exception()
         self.ws_message_producer._empty_send_queue.side_effect = exception
-        self.prepare(time)
+        self.prepare(time_)
 
         self.ws_message_producer.run()
 
         self.assertEqual(0, self.ws_message_producer._last_ws_attempt)
         self.assertEqual(exception, self.ws_message_producer.exception)
 
+    def test_wait_timeout(self):
+
+        def _stop():
+            self.ws_message_producer._continue = False
+
+        self.ws_message_producer._empty_send_queue = MagicMock()
+        self.ws_message_producer._empty_websocket.side_effect = _stop
+        self.ws_message_producer.poll_signal.clear = MagicMock()
+        start = time.time()
+
+        self.ws_message_producer.run()
+
+        self.assertGreater(time.time() - start, 1)
+        self.ws_message_producer.poll_signal.clear.assert_not_called()
+
+    def test_poll_signal_set(self):
+
+        def _stop():
+            self.ws_message_producer._continue = False
+
+        self.ws_message_producer._empty_send_queue = MagicMock()
+        self.ws_message_producer._empty_websocket.side_effect = _stop
+        self.ws_message_producer.poll_signal.set()
+        self.ws_message_producer.poll_signal.clear = MagicMock()
+
+        start = time.time()
+        self.ws_message_producer.run()
+
+        self.assertLess(time.time() - start, 1)
+        self.ws_message_producer.poll_signal.clear.assert_called_once_with()
+
 
 class Test__WSMessagingThread_blocked(WSMessageProducerTest):