growthbook 1.4.3__py2.py3-none-any.whl → 1.4.5__py2.py3-none-any.whl

growthbook/__init__.py

@@ -18,5 +18,5 @@ from .plugins import (
 )
 
 # x-release-please-start-version
-__version__ = "1.4.3"
+__version__ = "1.4.5"
 # x-release-please-end

growthbook/common_types.py

@@ -426,6 +426,7 @@ class Options:
     sticky_bucket_service: Optional[AbstractStickyBucketService] = None
     sticky_bucket_identifier_attributes: Optional[List[str]] = None
     on_experiment_viewed: Optional[Callable[[Experiment, Result, Optional[UserContext]], None]] = None
+    on_feature_usage: Optional[Callable[[str, 'FeatureResult'], None]] = None
     tracking_plugins: Optional[List[Any]] = None
 
 

growthbook/growthbook.py

@@ -100,7 +100,8 @@ class InMemoryFeatureCache(AbstractFeatureCache):
     def set(self, key: str, value: Dict, ttl: int) -> None:
         if key in self.cache:
             self.cache[key].update(value)
-        self.cache[key] = CacheEntry(value, ttl)
+        else:
+            self.cache[key] = CacheEntry(value, ttl)
 
     def clear(self) -> None:
         self.cache.clear()
@@ -327,6 +328,11 @@ class FeatureRepository(object):
         self.http: Optional[PoolManager] = None
         self.sse_client: Optional[SSEClient] = None
         self._feature_update_callbacks: List[Callable[[Dict], None]] = []
+        
+        # Background refresh support
+        self._refresh_thread: Optional[threading.Thread] = None
+        self._refresh_stop_event = threading.Event()
+        self._refresh_lock = threading.Lock()
 
     def set_cache(self, cache: AbstractFeatureCache) -> None:
         self.cache = cache
@@ -375,6 +381,7 @@ class FeatureRepository(object):
                 return res
         return cached
     
+    
     async def load_features_async(
         self, api_host: str, client_key: str, decryption_key: str = "", ttl: int = 600
     ) -> Optional[Dict]:
@@ -493,6 +500,52 @@ class FeatureRepository(object):
         if self.sse_client:
             self.sse_client.disconnect(timeout=timeout)
             self.sse_client = None
+    
+    def start_background_refresh(self, api_host: str, client_key: str, decryption_key: str, ttl: int = 600, refresh_interval: int = 300) -> None:
+        """Start periodic background refresh task"""
+        with self._refresh_lock:
+            if self._refresh_thread is not None:
+                return  # Already running
+            
+            self._refresh_stop_event.clear()
+            self._refresh_thread = threading.Thread(
+                target=self._background_refresh_worker,
+                args=(api_host, client_key, decryption_key, ttl, refresh_interval),
+                daemon=True
+            )
+            self._refresh_thread.start()
+            logger.debug("Started background refresh task")
+    
+    def _background_refresh_worker(self, api_host: str, client_key: str, decryption_key: str, ttl: int, refresh_interval: int) -> None:
+        """Worker method for periodic background refresh"""
+        while not self._refresh_stop_event.is_set():
+            try:
+                # Wait for the refresh interval or stop event
+                if self._refresh_stop_event.wait(refresh_interval):
+                    break  # Stop event was set
+                
+                logger.debug("Background refresh for Features - started")
+                res = self._fetch_features(api_host, client_key, decryption_key)
+                if res is not None:
+                    cache_key = api_host + "::" + client_key
+                    self.cache.set(cache_key, res, ttl)
+                    logger.debug("Background refresh completed")
+                    # Notify callbacks about fresh features
+                    self._notify_feature_update_callbacks(res)
+                else:
+                    logger.warning("Background refresh failed")
+            except Exception as e:
+                logger.warning(f"Background refresh error: {e}")
+    
+    def stop_background_refresh(self) -> None:
+        """Stop background refresh task"""
+        self._refresh_stop_event.set()
+        
+        with self._refresh_lock:
+            if self._refresh_thread is not None:
+                self._refresh_thread.join(timeout=1.0)  # Wait up to 1 second
+                self._refresh_thread = None
+                logger.debug("Stopped background refresh task")
 
     @staticmethod
     def _get_features_url(api_host: str, client_key: str) -> str:
@@ -512,6 +565,7 @@ class GrowthBook(object):
         features: dict = {},
         qa_mode: bool = False,
         on_experiment_viewed=None,
+        on_feature_usage=None,
         api_host: str = "",
         client_key: str = "",
         decryption_key: str = "",
@@ -522,6 +576,8 @@ class GrowthBook(object):
         savedGroups: dict = {},
         streaming: bool = False,
         streaming_connection_timeout: int = 30,
+        stale_while_revalidate: bool = False,
+        stale_ttl: int = 300,  # 5 minutes default
         plugins: List = None,
         # Deprecated args
         trackingCallback=None,
@@ -548,9 +604,12 @@ class GrowthBook(object):
 
         self._qaMode = qa_mode or qaMode
         self._trackingCallback = on_experiment_viewed or trackingCallback
+        self._featureUsageCallback = on_feature_usage
 
         self._streaming = streaming
         self._streaming_timeout = streaming_connection_timeout
+        self._stale_while_revalidate = stale_while_revalidate
+        self._stale_ttl = stale_ttl
 
         # Deprecated args
         self._user = user
@@ -603,6 +662,13 @@ class GrowthBook(object):
         if self._streaming:
             self.load_features()
             self.startAutoRefresh()
+        elif self._stale_while_revalidate and self._client_key:
+            # Start background refresh task for stale-while-revalidate
+            self.load_features()  # Initial load
+            feature_repo.start_background_refresh(
+                self._api_host, self._client_key, self._decryption_key, 
+                self._cache_ttl, self._stale_ttl
+            )
 
     def _on_feature_update(self, features_data: Dict) -> None:
         """Callback to handle automatic feature updates from FeatureRepository"""
@@ -739,6 +805,13 @@ class GrowthBook(object):
         except Exception as e:
             logger.warning(f"Error stopping auto refresh during destroy: {e}")
         
+        try:
+            # Stop background refresh operations
+            if self._stale_while_revalidate and self._client_key:
+                feature_repo.stop_background_refresh()
+        except Exception as e:
+            logger.warning(f"Error stopping background refresh during destroy: {e}")
+        
         try:
             # Clean up feature update callback
             if self._client_key:
@@ -752,6 +825,7 @@ class GrowthBook(object):
             self._tracked.clear()
             self._assigned.clear()
             self._trackingCallback = None
+            self._featureUsageCallback = None
             self._forcedVariations.clear()
             self._overrides.clear()
             self._groups.clear()
@@ -790,8 +864,8 @@ class GrowthBook(object):
     def _ensure_fresh_features(self) -> None:
         """Lazy refresh: Check cache expiry and refresh if needed, but only if client_key is provided"""
         
-        if self._streaming or not self._client_key:
-            return  # Skip cache checks - SSE handles freshness for streaming users
+        if self._streaming or self._stale_while_revalidate or not self._client_key:
+            return  # Skip cache checks - SSE or background refresh handles freshness
 
         try:
             self.load_features()
@@ -815,11 +889,18 @@ class GrowthBook(object):
         )
 
     def eval_feature(self, key: str) -> FeatureResult:
-        return core_eval_feature(key=key, 
-                                 evalContext=self._get_eval_context(), 
-                                 callback_subscription=self._fireSubscriptions,
-                                 tracking_cb=self._track
-                                 )
+        result = core_eval_feature(key=key, 
+                                   evalContext=self._get_eval_context(), 
+                                   callback_subscription=self._fireSubscriptions,
+                                   tracking_cb=self._track
+                                   )
+        # Call feature usage callback if provided
+        if self._featureUsageCallback:
+            try:
+                self._featureUsageCallback(key, result)
+            except Exception:
+                pass
+        return result
 
     # @deprecated, use get_all_results
     def getAllResults(self):

growthbook/growthbook_client.py

@@ -500,24 +500,50 @@ class GrowthBookClient:
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
             result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
+            # Call feature usage callback if provided
+            if self.options.on_feature_usage:
+                try:
+                    self.options.on_feature_usage(key, result)
+                except Exception:
+                    logger.exception("Error in feature usage callback")
             return result
 
     async def is_on(self, key: str, user_context: UserContext) -> bool:
         """Check if a feature is enabled with proper async context management"""
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            return core_eval_feature(key=key, evalContext=context, tracking_cb=self._track).on
+            result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
+            # Call feature usage callback if provided
+            if self.options.on_feature_usage:
+                try:
+                    self.options.on_feature_usage(key, result)
+                except Exception:
+                    logger.exception("Error in feature usage callback")
+            return result.on
     
     async def is_off(self, key: str, user_context: UserContext) -> bool:
         """Check if a feature is set to off with proper async context management"""
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            return core_eval_feature(key=key, evalContext=context, tracking_cb=self._track).off
+            result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
+            # Call feature usage callback if provided
+            if self.options.on_feature_usage:
+                try:
+                    self.options.on_feature_usage(key, result)
+                except Exception:
+                    logger.exception("Error in feature usage callback")
+            return result.off
     
     async def get_feature_value(self, key: str, fallback: Any, user_context: UserContext) -> Any:
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
             result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
+            # Call feature usage callback if provided
+            if self.options.on_feature_usage:
+                try:
+                    self.options.on_feature_usage(key, result)
+                except Exception:
+                    logger.exception("Error in feature usage callback")
             return result.value if result.value is not None else fallback
 
     async def run(self, experiment: Experiment, user_context: UserContext) -> Result:

{growthbook-1.4.3.dist-info → growthbook-1.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: growthbook
-Version: 1.4.3
+Version: 1.4.5
 Summary: Powerful Feature flagging and A/B testing for Python apps
 Home-page: https://github.com/growthbook/growthbook-python
 Author: GrowthBook

growthbook-1.4.5.dist-info/RECORD

@@ -0,0 +1,15 @@
+growthbook/__init__.py,sha256=JLdue4592q3iH1ck1qG9Fbv-p8i07SJo-tUJhGCf60s,444
+growthbook/common_types.py,sha256=KYA9rmWRMde2JnsUjygsiaJ1q-KZakDdzPAtUOnrKyY,14959
+growthbook/core.py,sha256=n9nwna26iZTY48LIvQqu5N_RrE35X0wlRBhq0-Qdb-s,35241
+growthbook/growthbook.py,sha256=xjuX-q8oPsLqP0kWBZqy7LpoTkrgjMZCOWjtpUsQR1o,39793
+growthbook/growthbook_client.py,sha256=kfdc2NGhdmsXxaVIm0CBlNCMkwicfPpbDZ10nZSPd7w,24576
+growthbook/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+growthbook/plugins/__init__.py,sha256=y2eAV1sA041XWcftBVTDH0t-ggy9r2C5oKRYRF6XR6s,602
+growthbook/plugins/base.py,sha256=PWBXUBj62hi25Y5Eif9WmEWagWdkwGXHi2dMtn44bo8,3637
+growthbook/plugins/growthbook_tracking.py,sha256=FvPFOuKF_xKjmTX8x_hzMlHrrL-68Y2ZPw1Hfl2_ilQ,11333
+growthbook/plugins/request_context.py,sha256=O5FJDrjJR5u0rx3ENGO9cOsKMHd9e0l0Nvdb1PHfmm8,12951
+growthbook-1.4.5.dist-info/licenses/LICENSE,sha256=D-TcBckB0dTPUlNJ8jBiTIJIj1ekHLB1CY7HJtJKhMY,1069
+growthbook-1.4.5.dist-info/METADATA,sha256=8KBWZ908qYYku0GqZCeZ1KNS5YLPxs7FXZVl6wesLWM,22074
+growthbook-1.4.5.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+growthbook-1.4.5.dist-info/top_level.txt,sha256=dzfRQFGYejCIUstRSrrRVTMlxf7pBqASTI5S8gGRlXw,11
+growthbook-1.4.5.dist-info/RECORD,,

growthbook-1.4.3.dist-info/RECORD

@@ -1,15 +0,0 @@
-growthbook/__init__.py,sha256=Js_KujzX2ehccclPD8fRM8duCGQdwiOyyV5uNdWCKf8,444
-growthbook/common_types.py,sha256=OUGkqoUuYetWz1cyA1eWz5DM3awYw_ExcNAjFqJuGAc,14881
-growthbook/core.py,sha256=n9nwna26iZTY48LIvQqu5N_RrE35X0wlRBhq0-Qdb-s,35241
-growthbook/growthbook.py,sha256=EK7nkS0Rbkc0aDORKh_0ie6cc7hXlJUui5ve-GkWmHk,35996
-growthbook/growthbook_client.py,sha256=1bDIuJoxlKUR_bKe_gD6V7JlUPt53uGgix9DhgSkPPc,23360
-growthbook/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-growthbook/plugins/__init__.py,sha256=y2eAV1sA041XWcftBVTDH0t-ggy9r2C5oKRYRF6XR6s,602
-growthbook/plugins/base.py,sha256=PWBXUBj62hi25Y5Eif9WmEWagWdkwGXHi2dMtn44bo8,3637
-growthbook/plugins/growthbook_tracking.py,sha256=FvPFOuKF_xKjmTX8x_hzMlHrrL-68Y2ZPw1Hfl2_ilQ,11333
-growthbook/plugins/request_context.py,sha256=O5FJDrjJR5u0rx3ENGO9cOsKMHd9e0l0Nvdb1PHfmm8,12951
-growthbook-1.4.3.dist-info/licenses/LICENSE,sha256=D-TcBckB0dTPUlNJ8jBiTIJIj1ekHLB1CY7HJtJKhMY,1069
-growthbook-1.4.3.dist-info/METADATA,sha256=l5wX61QF36lMGmPSxZsr_CKmHOdqOU9PKAbQPA3gN50,22074
-growthbook-1.4.3.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-growthbook-1.4.3.dist-info/top_level.txt,sha256=dzfRQFGYejCIUstRSrrRVTMlxf7pBqASTI5S8gGRlXw,11
-growthbook-1.4.3.dist-info/RECORD,,