add stop method to polling config manager (#410)

Author: andrewleap-optimizely

optimizely/config_manager.py

@@ -17,7 +17,6 @@
 from typing import TYPE_CHECKING, Any, Optional
 import requests
 import threading
-import time
 from requests import codes as http_status_codes
 from requests import exceptions as requests_exceptions
 
@@ -216,8 +215,8 @@ def __init__(
         self.set_update_interval(update_interval)
         self.set_blocking_timeout(blocking_timeout)
         self.last_modified: Optional[str] = None
-        self._polling_thread = threading.Thread(target=self._run)
-        self._polling_thread.daemon = True
+        self.stopped = threading.Event()
+        self._initialize_thread()
         self._polling_thread.start()
 
     @staticmethod
@@ -375,15 +374,23 @@ def is_running(self) -> bool:
         """ Check if polling thread is alive or not. """
         return self._polling_thread.is_alive()
 
+    def stop(self) -> None:
+        """ Stop the polling thread and wait for it to exit. """
+        if self.is_running:
+            self.stopped.set()
+            self._polling_thread.join()
+
     def _run(self) -> None:
         """ Triggered as part of the thread which fetches the datafile and sleeps until next update interval. """
         try:
-            while self.is_running:
+            while True:
                 self.fetch_datafile()
-                time.sleep(self.update_interval)
+                if self.stopped.wait(self.update_interval):
+                    self.stopped.clear()
+                    break
         except (OSError, OverflowError) as err:
             self.logger.error(
-                f'Error in time.sleep. Provided update_interval value may be too big. Error: {err}'
+                f'Provided update_interval value may be too big. Error: {err}'
             )
             raise
 
@@ -392,6 +399,9 @@ def start(self) -> None:
         if not self.is_running:
             self._polling_thread.start()
 
+    def _initialize_thread(self) -> None:
+        self._polling_thread = threading.Thread(target=self._run, daemon=True)
+
 
 class AuthDatafilePollingConfigManager(PollingConfigManager):
     """ Config manager that polls for authenticated datafile using access token. """

optimizely/optimizely.py

@@ -88,10 +88,9 @@ def __init__(
                                config_manager.BaseConfigManager implementation which can be using the
                                same NotificationCenter instance.
           event_processor: Optional component which processes the given event(s).
-                           By default optimizely.event.event_processor.ForwardingEventProcessor is used
-                           which simply forwards events to the event dispatcher.
-                           To enable event batching configure and use
-                           optimizely.event.event_processor.BatchEventProcessor.
+                           By default optimizely.event.event_processor.BatchEventProcessor is used
+                           which batches events. To simply forward events to the event dispatcher
+                           configure and use optimizely.event.event_processor.ForwardingEventProcessor.
           datafile_access_token: Optional string used to fetch authenticated datafile for a secure project environment.
           default_decide_options: Optional list of decide options used with the decide APIs.
           event_processor_options: Optional dict of options to be passed to the default batch event processor.
@@ -1381,3 +1380,5 @@ def close(self) -> None:
         if callable(getattr(self.event_processor, 'stop', None)):
             self.event_processor.stop()  # type: ignore[attr-defined]
         self.odp_manager.close()
+        if callable(getattr(self.config_manager, 'stop', None)):
+            self.config_manager.stop()  # type: ignore[attr-defined]

requirements/typing.txt

@@ -1,4 +1,4 @@
-mypy
+mypy==0.982
 types-jsonschema
 types-requests
 types-Flask