ipulse-shared-core-ftredge 27.3.0__py3-none-any.whl → 27.4.0__py3-none-any.whl

ipulse_shared_core_ftredge/models/base_api_response.py

@@ -16,6 +16,10 @@ class BaseAPIResponse(BaseModel, Generic[T]):
     message: Optional[str] = None
     error: Optional[str] = None
 
+    # Optional fields for specific use cases
+    cache_hit: Optional[bool] = None  # Whether data came from cache
+    charged: Optional[bool] = None    # Whether credits were charged for this request
+
     metadata: Dict[str, Any] = {
         "timestamp": dt.datetime.now(dt.timezone.utc).isoformat()
     }

ipulse_shared_core_ftredge/services/base/cache_aware_firestore_service.py

@@ -1,13 +1,14 @@
 """Cache-aware Firestore service base class."""
 import time
-from typing import TypeVar, Generic, Dict, Any, List, Optional, Union, Type
+from typing import TypeVar, Generic, Dict, Any, List, Optional, Union, Type, Tuple
 from google.cloud import firestore
 from . import BaseFirestoreService
 from ...exceptions import ResourceNotFoundError, ServiceError
 from ...cache.shared_cache import SharedCache
 from ...models import BaseDataModel
 
-T = TypeVar('T', bound=BaseDataModel)
+T = TypeVar('T', bound=BaseDataModel)0
+0
 
 class CacheAwareFirestoreService(BaseFirestoreService[T], Generic[T]):
     """
@@ -58,7 +59,9 @@ class CacheAwareFirestoreService(BaseFirestoreService[T], Generic[T]):
             cache_check_time = (time.time() - start_time) * 1000
 
             if cached_doc is not None:
-                self.logger.debug(f"Cache HIT for document {doc_id} in {cache_check_time:.2f}ms")
+                # SharedCache.get() already logs cache hit, only log timing if significant
+                if cache_check_time > 5.0:  # Only log if cache check took >5ms
+                    self.logger.debug(f"Cache HIT for document {doc_id} in {cache_check_time:.2f}ms")
                 if convert_to_model and self.model_class:
                     return self._convert_to_model(cached_doc, doc_id)
                 else:
@@ -68,7 +71,66 @@ class CacheAwareFirestoreService(BaseFirestoreService[T], Generic[T]):
                 self.logger.debug(f"Cache MISS for document {doc_id} - checking Firestore")
 
         # Fetch from Firestore using parent method
-        return await super().get_document(doc_id, convert_to_model)
+        result = await super().get_document(doc_id, convert_to_model)
+
+        # Cache the result if we have a cache and got valid data
+        if self.document_cache and result is not None:
+            if convert_to_model and isinstance(result, BaseDataModel):
+                # Cache the model's dict representation
+                self._cache_document_data(doc_id, result.model_dump())
+            elif isinstance(result, dict):
+                # Cache the dict directly
+                self._cache_document_data(doc_id, result)
+
+        return result
+
+    async def get_document_with_cache_info(self, doc_id: str, convert_to_model: bool = True) -> Tuple[Union[T, Dict[str, Any], None], bool]:
+        """
+        Get a document with cache hit information.
+
+        Args:
+            doc_id: Document ID to fetch
+            convert_to_model: Whether to convert to Pydantic model
+
+        Returns:
+            Tuple of (document, cache_hit) where cache_hit indicates if from cache
+
+        Raises:
+            ResourceNotFoundError: If document doesn't exist
+        """
+        cache_hit = False
+
+        # Check cache first
+        if self.document_cache:
+            cached_doc = self.document_cache.get(doc_id)
+            if cached_doc is not None:
+                cache_hit = True
+                # Note: SharedCache.get() already logs cache hit at DEBUG level
+                if convert_to_model and self.model_class:
+                    return self._convert_to_model(cached_doc, doc_id), cache_hit
+                else:
+                    cached_doc['id'] = doc_id
+                    return cached_doc, cache_hit
+
+        # Cache miss - fetch from Firestore
+        self.logger.debug(f"Cache MISS for document {doc_id} - checking Firestore")
+
+        try:
+            result = await super().get_document(doc_id, convert_to_model)
+
+            # Cache the result if we have a cache and got valid data
+            if self.document_cache and result is not None:
+                if convert_to_model and isinstance(result, BaseDataModel):
+                    # Cache the model's dict representation
+                    self._cache_document_data(doc_id, result.model_dump())
+                elif isinstance(result, dict):
+                    # Cache the dict directly
+                    self._cache_document_data(doc_id, result)
+
+            return result, cache_hit
+
+        except ResourceNotFoundError:
+            return None, cache_hit
 
     async def get_all_documents(self, cache_key: Optional[str] = None, as_models: bool = True) -> Union[List[T], List[Dict[str, Any]]]:
         """
@@ -151,7 +213,7 @@ class CacheAwareFirestoreService(BaseFirestoreService[T], Generic[T]):
         """Helper to cache document data if document_cache is available."""
         if self.document_cache:
             self.document_cache.set(doc_id, data)
-            self.logger.debug(f"Cached item {doc_id} in {self.document_cache.name}")
+            # Note: SharedCache.set() already logs at DEBUG level
 
     async def create_document(self, doc_id: str, data: Union[T, Dict[str, Any]], creator_uid: str, merge: bool = False) -> Dict[str, Any]:
         """Create document and invalidate cache."""

{ipulse_shared_core_ftredge-27.3.0.dist-info → ipulse_shared_core_ftredge-27.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 27.3.0
+Version: 27.4.0
 Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
 Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
 Author: Russlan Ramdowar

{ipulse_shared_core_ftredge-27.3.0.dist-info → ipulse_shared_core_ftredge-27.4.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ ipulse_shared_core_ftredge/exceptions/__init__.py,sha256=Cb_RsIie4DbT_NLwFVwjw4r
 ipulse_shared_core_ftredge/exceptions/base_exceptions.py,sha256=117YsiCbYLLBu_D0IffYFVSX2yh-pisALMtoSMwj6xI,5338
 ipulse_shared_core_ftredge/exceptions/user_exceptions.py,sha256=I-nm21MKrUYEoybpRODeYNzc184HfgHvRZQm_xux4VY,6824
 ipulse_shared_core_ftredge/models/__init__.py,sha256=jhaVbOzJiFUf24saV1-a4GeKUaPif3jqAnIr4wgiUVs,455
-ipulse_shared_core_ftredge/models/base_api_response.py,sha256=g7f1jH3VkEyMuW-d_j3ex2zk8LO2EMlkYRJQqYic_KU,792
+ipulse_shared_core_ftredge/models/base_api_response.py,sha256=vEcy5BDXcuJFldWq8FgadSAiq0kbVFA8BYVIpY3n9aE,993
 ipulse_shared_core_ftredge/models/base_data_model.py,sha256=GZ7KTT5FanHTgvmaHHTxawzAJtuixkbyb-SuL-mjWys,2193
 ipulse_shared_core_ftredge/models/credit_api_response.py,sha256=gavsJeuIsQJmY1t8DPzRZP5da68DT6IknE_oAeoapTc,797
 ipulse_shared_core_ftredge/models/custom_json_response.py,sha256=5WCqpb6YEzZQitXE9DdnPv3x-me_0iV_qmd6laeiPWA,1396
@@ -32,7 +32,7 @@ ipulse_shared_core_ftredge/services/charging_processors.py,sha256=Ynt8nQZprdsny9
 ipulse_shared_core_ftredge/services/user_charging_service.py,sha256=WNVGn77Rcy_Al3M9wF0VZPYQVWL__E2baVRDQeA37I4,14609
 ipulse_shared_core_ftredge/services/base/__init__.py,sha256=hP2x_F07nycNj6_WCIQE7-8o84cIRj-tZlGwrA1yIcI,491
 ipulse_shared_core_ftredge/services/base/base_firestore_service.py,sha256=leZFwxb1ruheypqudpKnuNtRQXtO4KNeoJk6ZACozHc,19512
-ipulse_shared_core_ftredge/services/base/cache_aware_firestore_service.py,sha256=ya5Asff9BQodYnJVAw6M_Pm8WtVRPpEK7izFlZ2MyjA,10016
+ipulse_shared_core_ftredge/services/base/cache_aware_firestore_service.py,sha256=cMqXKat956BJR7qzPHLhAOvgFsjin9-GdQgVut1f3XI,12563
 ipulse_shared_core_ftredge/services/base/multi_collection_cache_aware_firestore_service.py,sha256=Z-L20YkGhArTlwabPsqRXew-o87oL_9B5WOEh5zF0A4,10739
 ipulse_shared_core_ftredge/services/catalog/__init__.py,sha256=ctc2nDGwsW_Ji4lk9pys3oyNwR_V-gHSbSHawym5fKQ,385
 ipulse_shared_core_ftredge/services/catalog/catalog_subscriptionplan_service.py,sha256=X5xAi9sOk_F1ky0ECwPVlwIPPsN2PrZC6bN_pASGDjQ,9702
@@ -47,11 +47,10 @@ ipulse_shared_core_ftredge/services/user/userauth_operations.py,sha256=QY_ueDei4
 ipulse_shared_core_ftredge/services/user/userprofile_operations.py,sha256=_qyIEAQYCTV-subgP-5naMs_26apCpauomE6qmCCVWs,7333
 ipulse_shared_core_ftredge/services/user/userstatus_operations.py,sha256=Om9d94cM4uOdTmCNXECU0hFtsUZ-o-OLMEiLAG74YUQ,22730
 ipulse_shared_core_ftredge/utils/__init__.py,sha256=JnxUb8I2MRjJC7rBPXSrpwBIQDEOku5O9JsiTi3oun8,56
-ipulse_shared_core_ftredge/utils/authz_credit_extraction.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ipulse_shared_core_ftredge/utils/custom_json_encoder.py,sha256=DblQLD0KOSNDyQ58wQRogBrShIXzPIZUw_oGOBATnJY,1366
 ipulse_shared_core_ftredge/utils/json_encoder.py,sha256=QkcaFneVv3-q-s__Dz4OiUWYnM6jgHDJrDMdPv09RCA,2093
-ipulse_shared_core_ftredge-27.3.0.dist-info/licenses/LICENCE,sha256=YBtYAXNqCCOo9Mr2hfkbSPAM9CeAr2j1VZBSwQTrNwE,1060
-ipulse_shared_core_ftredge-27.3.0.dist-info/METADATA,sha256=9kTpPalCVGts8D7cxf5LFMCzSpcP-C_nVlfZRZeZWu0,782
-ipulse_shared_core_ftredge-27.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ipulse_shared_core_ftredge-27.3.0.dist-info/top_level.txt,sha256=8sgYrptpexkA_6_HyGvho26cVFH9kmtGvaK8tHbsGHk,27
-ipulse_shared_core_ftredge-27.3.0.dist-info/RECORD,,
+ipulse_shared_core_ftredge-27.4.0.dist-info/licenses/LICENCE,sha256=YBtYAXNqCCOo9Mr2hfkbSPAM9CeAr2j1VZBSwQTrNwE,1060
+ipulse_shared_core_ftredge-27.4.0.dist-info/METADATA,sha256=8oj6rngXz42Rf_-m4Qj5LL-aBTTW5MxsOnlGn6vaEhI,782
+ipulse_shared_core_ftredge-27.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ipulse_shared_core_ftredge-27.4.0.dist-info/top_level.txt,sha256=8sgYrptpexkA_6_HyGvho26cVFH9kmtGvaK8tHbsGHk,27
+ipulse_shared_core_ftredge-27.4.0.dist-info/RECORD,,