growthbook 1.4.3__tar.gz → 1.4.5__tar.gz

{growthbook-1.4.3/growthbook.egg-info → growthbook-1.4.5}/PKG-INFO

@@ -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.3 → growthbook-1.4.5}/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-1.4.3 → growthbook-1.4.5}/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-1.4.3 → growthbook-1.4.5}/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-1.4.3 → growthbook-1.4.5}/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 → growthbook-1.4.5/growthbook.egg-info}/PKG-INFO

@@ -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.3 → growthbook-1.4.5}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.4.3
+current_version = 1.4.5
 commit = True
 tag = True
 

{growthbook-1.4.3 → growthbook-1.4.5}/tests/conftest.py

@@ -1,4 +1,5 @@
 import pytest
+import pytest_asyncio
 import asyncio
 import os
 import sys
@@ -22,7 +23,7 @@ def reset_singleton():
                 instance._stop_event.set()
         SingletonMeta._instances.clear()
 
-@pytest.fixture(autouse=True)
+@pytest_asyncio.fixture(autouse=True)
 async def cleanup_tasks():
     """Cleanup any pending tasks after each test."""
     yield

{growthbook-1.4.3 → growthbook-1.4.5}/tests/test_growthbook.py

@@ -215,6 +215,85 @@ def test_tracking():
     gb.destroy()
 
 
+def test_feature_usage_callback():
+    """Test that feature usage callback is called correctly"""
+    calls = []
+    
+    def feature_usage_cb(key, result):
+        calls.append([key, result])
+    
+    gb = GrowthBook(
+        attributes={"id": "1"},
+        on_feature_usage=feature_usage_cb,
+        features={
+            "feature-1": Feature(defaultValue=True),
+            "feature-2": Feature(defaultValue=False),
+            "feature-3": Feature(
+                defaultValue="blue",
+                rules=[
+                    FeatureRule(force="red", condition={"id": "1"})
+                ]
+            ),
+        }
+    )
+    
+    # Test eval_feature
+    result1 = gb.eval_feature("feature-1")
+    assert len(calls) == 1
+    assert calls[0][0] == "feature-1"
+    assert calls[0][1].value is True
+    assert calls[0][1].source == "defaultValue"
+    
+    # Test is_on
+    gb.is_on("feature-2")
+    assert len(calls) == 2
+    assert calls[1][0] == "feature-2"
+    assert calls[1][1].value is False
+    
+    # Test get_feature_value
+    value = gb.get_feature_value("feature-3", "blue")
+    assert len(calls) == 3
+    assert calls[2][0] == "feature-3"
+    assert calls[2][1].value == "red"
+    assert value == "red"
+    
+    # Test is_off
+    gb.is_off("feature-1")
+    assert len(calls) == 4
+    assert calls[3][0] == "feature-1"
+    
+    # Calling same feature multiple times should trigger callback each time
+    gb.eval_feature("feature-1")
+    gb.eval_feature("feature-1")
+    assert len(calls) == 6
+    
+    gb.destroy()
+
+
+def test_feature_usage_callback_error_handling():
+    """Test that feature usage callback errors are handled gracefully"""
+    
+    def failing_callback(key, result):
+        raise Exception("Callback error")
+    
+    gb = GrowthBook(
+        attributes={"id": "1"},
+        on_feature_usage=failing_callback,
+        features={
+            "feature-1": Feature(defaultValue=True),
+        }
+    )
+    
+    # Should not raise an error even if callback fails
+    result = gb.eval_feature("feature-1")
+    assert result.value is True
+    
+    # Should work with is_on as well
+    assert gb.is_on("feature-1") is True
+    
+    gb.destroy()
+
+
 def test_handles_weird_experiment_values():
     gb = GrowthBook(attributes={"id": "1"})
 
@@ -1009,4 +1088,164 @@ def test_multiple_instances_get_updated_on_cache_expiry(mocker):
     finally:
         gb1.destroy()
         gb2.destroy()
+        feature_repo.clear_cache()
+
+
+def test_stale_while_revalidate_basic_functionality(mocker):
+    """Test basic stale-while-revalidate functionality"""
+    # Mock responses - first call returns v1, subsequent calls return v2
+    mock_responses = [
+        {"features": {"test_feature": {"defaultValue": "v1"}}, "savedGroups": {}},
+        {"features": {"test_feature": {"defaultValue": "v2"}}, "savedGroups": {}}
+    ]
+    
+    call_count = 0
+    def mock_fetch_features(api_host, client_key, decryption_key=""):
+        nonlocal call_count
+        response = mock_responses[min(call_count, len(mock_responses) - 1)]
+        call_count += 1
+        return response
+    
+    # Clear cache and mock the fetch method
+    feature_repo.clear_cache()
+    m = mocker.patch.object(feature_repo, '_fetch_features', side_effect=mock_fetch_features)
+    
+    # Create GrowthBook instance with stale-while-revalidate enabled and short refresh interval
+    gb = GrowthBook(
+        api_host="https://cdn.growthbook.io",
+        client_key="test-key",
+        cache_ttl=10,  # 10 second TTL
+        stale_while_revalidate=True,
+        stale_ttl=1  # 1 second refresh interval for testing
+    )
+    
+    try:
+        # Initial evaluation - should use initial loaded data
+        assert gb.get_feature_value('test_feature', 'default') == "v1"
+        assert call_count == 1  # Initial load
+        
+        # Wait for background refresh to happen
+        import time as time_module
+        time_module.sleep(1.5)  # Wait longer than refresh interval
+        
+        # Should have triggered background refresh
+        assert call_count >= 2
+        
+        # Next evaluation should get updated data from background refresh
+        assert gb.get_feature_value('test_feature', 'default') == "v2"
+        
+    finally:
+        gb.destroy()
+        feature_repo.clear_cache()
+
+
+def test_stale_while_revalidate_starts_background_task(mocker):
+    """Test that stale-while-revalidate starts background refresh task"""
+    mock_response = {"features": {"test_feature": {"defaultValue": "fresh"}}, "savedGroups": {}}
+    
+    call_count = 0
+    def mock_fetch_features(api_host, client_key, decryption_key=""):
+        nonlocal call_count
+        call_count += 1
+        return mock_response
+    
+    # Clear cache and mock the fetch method
+    feature_repo.clear_cache()
+    m = mocker.patch.object(feature_repo, '_fetch_features', side_effect=mock_fetch_features)
+    
+    # Create GrowthBook instance with stale-while-revalidate enabled
+    gb = GrowthBook(
+        api_host="https://cdn.growthbook.io",
+        client_key="test-key",
+        stale_while_revalidate=True,
+        stale_ttl=5
+    )
+    
+    try:
+        # Should have started background refresh task
+        assert feature_repo._refresh_thread is not None
+        assert feature_repo._refresh_thread.is_alive()
+        
+        # Initial evaluation should work
+        assert gb.get_feature_value('test_feature', 'default') == "fresh"
+        assert call_count == 1  # Initial load
+        
+    finally:
+        gb.destroy()
+        feature_repo.clear_cache()
+
+def test_stale_while_revalidate_disabled_fallback(mocker):
+    """Test that when stale_while_revalidate is disabled, it falls back to normal behavior"""
+    mock_response = {"features": {"test_feature": {"defaultValue": "normal"}}, "savedGroups": {}}
+    
+    call_count = 0
+    def mock_fetch_features(api_host, client_key, decryption_key=""):
+        nonlocal call_count
+        call_count += 1
+        return mock_response
+    
+    # Clear cache and mock the fetch method
+    feature_repo.clear_cache()
+    m = mocker.patch.object(feature_repo, '_fetch_features', side_effect=mock_fetch_features)
+    
+    # Create GrowthBook instance with stale-while-revalidate disabled (default)
+    gb = GrowthBook(
+        api_host="https://cdn.growthbook.io",
+        client_key="test-key",
+        cache_ttl=1,  # Short TTL
+        stale_while_revalidate=False  # Explicitly disabled
+    )
+    
+    try:
+        # Should NOT have started background refresh task
+        assert feature_repo._refresh_thread is None
+        
+        # Initial evaluation
+        assert gb.get_feature_value('test_feature', 'default') == "normal"
+        assert call_count == 1
+        
+        # Manually expire the cache
+        cache_key = "https://cdn.growthbook.io::test-key"
+        if hasattr(feature_repo.cache, 'cache') and cache_key in feature_repo.cache.cache:
+            feature_repo.cache.cache[cache_key].expires = time() - 10
+        
+        # Next evaluation should fetch synchronously (normal behavior)
+        assert gb.get_feature_value('test_feature', 'default') == "normal"
+        assert call_count == 2  # Should have fetched again
+        
+    finally:
+        gb.destroy()
+        feature_repo.clear_cache()
+
+
+def test_stale_while_revalidate_cleanup(mocker):
+    """Test that background refresh is properly cleaned up"""
+    mock_response = {"features": {"test_feature": {"defaultValue": "test"}}, "savedGroups": {}}
+    
+    # Mock the fetch method
+    feature_repo.clear_cache()
+    m = mocker.patch.object(feature_repo, '_fetch_features', return_value=mock_response)
+    
+    # Create GrowthBook instance with stale-while-revalidate enabled
+    gb = GrowthBook(
+        api_host="https://cdn.growthbook.io",
+        client_key="test-key",
+        stale_while_revalidate=True
+    )
+    
+    try:
+        # Should have started background refresh task
+        assert feature_repo._refresh_thread is not None
+        assert feature_repo._refresh_thread.is_alive()
+        
+        # Destroy should clean up the background task
+        gb.destroy()
+        
+        # Background task should be stopped
+        assert feature_repo._refresh_thread is None or not feature_repo._refresh_thread.is_alive()
+        
+    finally:
+        # Ensure cleanup even if test fails
+        if feature_repo._refresh_thread:
+            feature_repo.stop_background_refresh()
         feature_repo.clear_cache()

{growthbook-1.4.3 → growthbook-1.4.5}/tests/test_growthbook_client.py

@@ -767,5 +767,129 @@ async def test_handles_tracking_errors():
             calls = getMockedTrackingCalls()
             assert len(calls) == 1, "Expected exactly 1 tracking call"
 
+    finally:
+        await client.close()
+
+
+@pytest.mark.asyncio
+async def test_feature_usage_callback():
+    """Test that feature usage callback is called correctly"""
+    calls = []
+    
+    def feature_usage_cb(key, result):
+        calls.append([key, result])
+    
+    client = GrowthBookClient(Options(
+        api_host="https://localhost.growthbook.io",
+        client_key="test-key",
+        enabled=True,
+        on_feature_usage=feature_usage_cb
+    ))
+    
+    user_context = UserContext(attributes={"id": "1"})
+    
+    try:
+        # Set up mocks for feature repository
+        mock_features = {
+            "features": {
+                "feature-1": {"defaultValue": True},
+                "feature-2": {"defaultValue": False},
+                "feature-3": {
+                    "defaultValue": "blue",
+                    "rules": [
+                        {"force": "red", "condition": {"id": "1"}}
+                    ]
+                },
+            },
+            "savedGroups": {}
+        }
+        
+        with patch('growthbook.FeatureRepository.load_features_async', 
+                  new_callable=AsyncMock, return_value=mock_features), \
+             patch('growthbook.growthbook_client.EnhancedFeatureRepository.start_feature_refresh',
+                  new_callable=AsyncMock), \
+             patch('growthbook.growthbook_client.EnhancedFeatureRepository.stop_refresh',
+                  new_callable=AsyncMock):
+            
+            # Initialize client
+            await client.initialize()
+            
+            # Test eval_feature
+            result1 = await client.eval_feature("feature-1", user_context)
+            assert len(calls) == 1
+            assert calls[0][0] == "feature-1"
+            assert calls[0][1].value is True
+            assert calls[0][1].source == "defaultValue"
+            
+            # Test is_on
+            await client.is_on("feature-2", user_context)
+            assert len(calls) == 2
+            assert calls[1][0] == "feature-2"
+            assert calls[1][1].value is False
+            
+            # Test get_feature_value
+            value = await client.get_feature_value("feature-3", "blue", user_context)
+            assert len(calls) == 3
+            assert calls[2][0] == "feature-3"
+            assert calls[2][1].value == "red"
+            assert value == "red"
+            
+            # Test is_off
+            await client.is_off("feature-1", user_context)
+            assert len(calls) == 4
+            assert calls[3][0] == "feature-1"
+            
+            # Calling same feature multiple times should trigger callback each time
+            await client.eval_feature("feature-1", user_context)
+            await client.eval_feature("feature-1", user_context)
+            assert len(calls) == 6
+            
+    finally:
+        await client.close()
+
+
+@pytest.mark.asyncio
+async def test_feature_usage_callback_error_handling():
+    """Test that feature usage callback errors are handled gracefully"""
+    
+    def failing_callback(key, result):
+        raise Exception("Callback error")
+    
+    client = GrowthBookClient(Options(
+        api_host="https://localhost.growthbook.io",
+        client_key="test-key",
+        enabled=True,
+        on_feature_usage=failing_callback
+    ))
+    
+    user_context = UserContext(attributes={"id": "1"})
+    
+    try:
+        # Set up mocks for feature repository
+        mock_features = {
+            "features": {
+                "feature-1": {"defaultValue": True},
+            },
+            "savedGroups": {}
+        }
+        
+        with patch('growthbook.FeatureRepository.load_features_async', 
+                  new_callable=AsyncMock, return_value=mock_features), \
+             patch('growthbook.growthbook_client.EnhancedFeatureRepository.start_feature_refresh',
+                  new_callable=AsyncMock), \
+             patch('growthbook.growthbook_client.EnhancedFeatureRepository.stop_refresh',
+                  new_callable=AsyncMock):
+            
+            # Initialize client
+            await client.initialize()
+            
+            # Should not raise an error even if callback fails
+            result = await client.eval_feature("feature-1", user_context)
+            assert result.value is True
+            
+            # Should work with is_on as well
+            is_on = await client.is_on("feature-1", user_context)
+            assert is_on is True
+            
     finally:
         await client.close()