FFM-6932 - SDK seems to disconnect from the relay proxy (#57)

* FFM-6932 - SDK seems to disconnect from the relay proxy

What
Add timeout parameter of 60 seconds to HTTP request to force socket to time out if no data arrives.
The timeout will trigger an exception so that the poller is restarted. Also before putting
the poller to sleep when stream is enabled, make sure we retrieve the flags.

Why
Customers are reporting SSE updates stopping and flags getting out of date

Testing
Manual - ensured that after connection was lost to SSE stream that the poller is restarted

Author: andybharness

examples/getting_started/getting_started.py

@@ -24,7 +24,7 @@ def main():
     # Loop forever reporting the state of the flag
     while True:
         result = client.bool_variation(flagName, target, False)
-        log.info("Flag variation %s", result)
+        log.info("%s flag variation %s", flagName, result)
         time.sleep(10)
 
     close()

featureflags/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Enver Bisevac"""
 __email__ = "[email protected]"
-__version__ = '1.1.8'
+__version__ = '1.1.9'

featureflags/polling.py

@@ -65,6 +65,8 @@ def run(self):
                             self.__stream_ready.is_set():
                         log.debug('Poller will be paused because' +
                                   ' streaming mode is active')
+                        # on stream disconnect, make sure flags are in sync
+                        self.retrieve_flags_and_segments()
                         #  Block until ready.set() is called
                         self.__ready.wait()
                         log.debug('Poller resuming ')

featureflags/sse_client.py

@@ -48,6 +48,10 @@ def __init__(
         # The 'Accept' header is not required, but explicit > implicit
         self.requests_kwargs["headers"]["Accept"] = "text/event-stream"
 
+        # If we haven't gotten any heartbeats from the server in 60 seconds,
+        # then we assume the socket has died
+        self.requests_kwargs["timeout"] = 60
+
         # Keep data here as it streams in
         self.buf: str = ""
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.8
+current_version = 1.1.9
 commit = True
 tag = True
 

setup.py

@@ -56,6 +56,6 @@
     test_suite="tests",
     tests_require=test_requirements,
     url="https://github.com/harness/ff-python-server-sdk",
-    version='1.1.8',
+    version='1.1.9',
     zip_safe=False,
 )

tests/unit/test_sse_client.py

@@ -166,7 +166,7 @@ def multiple_responses(monkeypatch):
     fake_get.assert_called_once_with(
         "http://blah.com",
         headers={"Accept": "text/event-stream", "Cache-Control": "no-cache"},
-        stream=True,
+        stream=True, timeout=60
     )
 
 
@@ -244,7 +244,7 @@ def unicode_multibyte_responses(monkeypatch):
     fake_get.assert_called_once_with(
         "http://blah.com",
         headers={"Accept": "text/event-stream", "Cache-Control": "no-cache"},
-        stream=True,
+        stream=True, timeout=60
     )