Merge pull request #182 from sethbrite/ensure_factory_readiness

Make block_until_ready() guarantee factory readiness

Author: mredolatti

splitio/client/factory.py

@@ -109,17 +109,12 @@ def __init__(  # pylint: disable=too-many-arguments
         if self._sdk_ready_flag is not None:
             self._status = Status.NOT_INITIALIZED
             # add a listener that updates the status to READY once the flag is set.
-            ready_updater = threading.Thread(target=self._update_status_when_ready)
+            ready_updater = threading.Thread(target=self.block_until_ready)
             ready_updater.setDaemon(True)
             ready_updater.start()
         else:
             self._status = Status.READY
 
-    def _update_status_when_ready(self):
-        """Wait until the sdk is ready and update the status."""
-        self._sdk_ready_flag.wait()
-        self._status = Status.READY
-
     def _get_storage(self, name):
         """
         Return a reference to the specified storage.
@@ -153,6 +148,7 @@ def manager(self):
     def block_until_ready(self, timeout=None):
         """
         Blocks until the sdk is ready or the timeout specified by the user expires.
+        When ready, the factory's status is updated accordingly.
 
         :param timeout: Number of seconds to wait (fractions allowed)
         :type timeout: int
@@ -163,6 +159,8 @@ def block_until_ready(self, timeout=None):
             if not ready:
                 raise TimeoutException('SDK Initialization: time of %d exceeded' % timeout)
 
+            self._status = Status.READY
+
     @property
     def ready(self):
         """

tests/client/test_factory.py

@@ -86,7 +86,6 @@ def _segment_task_init_mock(self, api, storage, split_storage, period, event):
         assert factory._tasks['telemetry']._api == factory._apis['telemetry']
         assert factory._labels_enabled is True
         factory.block_until_ready()
-        time.sleep(1) # give a chance for the bg thread to set the ready status
         assert factory.ready
         factory.destroy()
 
@@ -164,7 +163,6 @@ def test_redis_client_creation(self, mocker):
         assert factory._labels_enabled is False
         assert isinstance(factory._impressions_manager, ImpressionsManager)
         factory.block_until_ready()
-        time.sleep(1) # give a chance for the bg thread to set the ready status
         assert factory.ready
         factory.destroy()
 
@@ -181,7 +179,6 @@ def test_uwsgi_client_creation(self):
         assert factory._tasks == {}
         assert factory._labels_enabled is True
         factory.block_until_ready()
-        time.sleep(1) # give a chance for the bg thread to set the ready status
         assert factory.ready
         factory.destroy()
 
@@ -232,7 +229,6 @@ def _event_task_init_mock(self, api, storage, refresh_rate, bulk_size):
         # Start factory and make assertions
         factory = get_factory('some_api_key')
         factory.block_until_ready()
-        time.sleep(1) # give a chance for the bg thread to set the ready status
         assert factory.ready
         assert factory.destroyed is False
 
@@ -302,7 +298,6 @@ def _telemetry_task_init_mock(self, api, storage, refresh_rate):
         assert factory.destroyed is False
 
         factory.block_until_ready()
-        time.sleep(1) # give a chance for the bg thread to set the ready status
         assert factory.ready
 
         event = threading.Event()

tests/integration/test_client_e2e.py

@@ -798,7 +798,6 @@ def test_localhost_e2e(self):
         filename = os.path.join(os.path.dirname(__file__), 'files', 'file2.yaml')
         factory = get_factory('localhost', config={'splitFile': filename})
         factory.block_until_ready()
-        time.sleep(1)
         client = factory.client()
         assert client.get_treatment_with_config('key', 'my_feature') == ('on', '{"desc" : "this applies only to ON treatment"}')
         assert client.get_treatment_with_config('only_key', 'my_feature') == (