feat: default enable SSE connections (#80)

* feat: default enable SSE connections

* fix: run ruff formatting

Signed-off-by: Jonathan Norris <jonathan@taplytics.com>

* fix: test_config_manager.py tests

* chore: update formatting using black

---------

Signed-off-by: Jonathan Norris <jonathan@taplytics.com>

Author: jonathannorris

.gitignore

@@ -70,4 +70,5 @@ target/
 .benchmarks
 benchmark.json
 
-pip-wheel-metadata/
+pip-wheel-metadata/
+.venv/

devcycle_python_sdk/managers/config_manager.py

@@ -80,7 +80,7 @@ def _get_config(self, last_modified: Optional[float] = None):
 
             json_config = json.dumps(self._config)
             self._local_bucketing.store_config(json_config)
-            if self._options.enable_beta_realtime_updates:
+            if not self._options.disable_realtime_updates:
                 if self._sse_manager is None:
                     self._sse_manager = SSEManager(
                         self.sse_state,

devcycle_python_sdk/options.py

@@ -46,6 +46,7 @@ def __init__(
         disable_automatic_event_logging: bool = False,
         disable_custom_event_logging: bool = False,
         enable_beta_realtime_updates: bool = False,
+        disable_realtime_updates: bool = False,
     ):
         self.events_api_uri = events_api_uri
         self.config_cdn_uri = config_cdn_uri
@@ -61,7 +62,12 @@ def __init__(
         self.on_client_initialized = on_client_initialized
         self.event_request_timeout_ms = event_request_timeout_ms
         self.event_retry_delay_ms = event_retry_delay_ms
-        self.enable_beta_realtime_updates = enable_beta_realtime_updates
+        self.disable_realtime_updates = disable_realtime_updates
+
+        if enable_beta_realtime_updates:
+            logger.warning(
+                "DevCycle: `enable_beta_realtime_updates` is deprecated and will be removed in a future release.",
+            )
 
         if self.flush_event_queue_size >= self.max_event_queue_size:
             logger.warning(

example/local_bucketing_client_example.py

@@ -21,7 +21,7 @@ def main():
 
     # create an instance of the DevCycle Client object
     server_sdk_key = os.environ["DEVCYCLE_SERVER_SDK_KEY"]
-    options = DevCycleLocalOptions(enable_beta_realtime_updates=True)
+    options = DevCycleLocalOptions()
     client = DevCycleLocalClient(server_sdk_key, options)
 
     # Wait for DevCycle to initialize and load the configuration

test/managers/test_config_manager.py

@@ -19,7 +19,9 @@ class EnvironmentConfigManagerTest(unittest.TestCase):
     def setUp(self) -> None:
         self.sdk_key = "dvc_server_" + str(uuid.uuid4())
         self.test_local_bucketing = MagicMock()
-        self.test_options = DevCycleLocalOptions(config_polling_interval_ms=500)
+        self.test_options = DevCycleLocalOptions(
+            config_polling_interval_ms=500, disable_realtime_updates=True
+        )
 
         now = datetime.now()
         stamp = mktime(now.timetuple())

test/test_local_client.py

@@ -40,6 +40,7 @@ def setUp(self) -> None:
             config_cdn_uri="http://localhost/",
             disable_custom_event_logging=True,
             disable_automatic_event_logging=True,
+            disable_realtime_updates=True,
         )
         self.test_user = DevCycleUser(user_id="test_user_id")
         self.test_user_empty_id = DevCycleUser(user_id="")