ipulse-shared-core-ftredge 12.0.1__tar.gz → 14.0.1__tar.gz

{ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-14.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 12.0.1
+Version: 14.0.1
 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-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='12.0.1',
+    version='14.0.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[

{ipulse_shared_core_ftredge-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/src/ipulse_shared_core_ftredge/__init__.py

@@ -2,7 +2,7 @@
 from .models import ( UserAuth, UserProfile,Subscription,
                      UserStatus, IAMUnitRefAssignment, UserProfileUpdate,
                      OrganizationProfile, BaseAPIResponse,
-                      CustomJSONResponse )
+                      CustomJSONResponse, BaseDataModel )
 
 
 

ipulse_shared_core_ftredge-14.0.1/src/ipulse_shared_core_ftredge/cache/__init__.py

@@ -0,0 +1,4 @@
+"""Cache utilities for shared core."""
+from ipulse_shared_core_ftredge.cache.shared_cache import SharedCache
+
+__all__ = ['SharedCache']

ipulse_shared_core_ftredge-14.0.1/src/ipulse_shared_core_ftredge/cache/shared_cache.py

@@ -0,0 +1,312 @@
+"""Module for shared caching functionality that can be used across microservices."""
+import os
+import time
+import logging
+import traceback
+import inspect
+import asyncio
+import threading
+from typing import Dict, Any, Optional, TypeVar, Generic, Callable, Tuple, List, Awaitable
+
+T = TypeVar('T')
+
+class SharedCache(Generic[T]):
+    """
+    Generic shared cache implementation that can be used across services.
+
+    Attributes:
+        name: The name of the cache for logging and identification.
+        ttl: Time-to-live in seconds for cached items.
+        enabled: Whether the cache is enabled.
+        logger: Logger for cache operations.
+        _cache: Dictionary holding cached values.
+        _timestamps: Dictionary holding timestamps for each cached item.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        ttl: float,
+        enabled: bool = True,
+        logger: Optional[logging.Logger] = None
+    ):
+        """Initialize the cache with name, TTL and enabled state."""
+        self.name = name
+        self.ttl = ttl
+        self.enabled = enabled
+        self.logger = logger or logging.getLogger(__name__)
+        self._cache: Dict[str, T] = {}
+        self._timestamps: Dict[str, float] = {}
+
+        # Thread-safe attributes
+        self.lock = threading.Lock()
+        self.hits = 0
+        self.misses = 0
+        self.sets = 0
+        self.evictions = 0
+
+        self.logger.info(f"{name} cache initialized. Enabled: {enabled}, TTL: {ttl} seconds")
+
+    def get(self, key: str) -> Optional[T]:
+        """
+        Get a value from the cache if it exists and hasn't expired.
+
+        Args:
+            key: The cache key to retrieve.
+
+        Returns:
+            The cached value if found and valid, None otherwise.
+        """
+        if not self.enabled:
+            return None
+
+        with self.lock:
+            try:
+                if key in self._cache:
+                    timestamp = self._timestamps.get(key, 0)
+                    if time.time() - timestamp < self.ttl:
+                        self.hits += 1
+                        self.logger.debug(f"Cache hit for {key} in {self.name}")
+                        return self._cache[key]
+                    else:
+                        # Expired item, remove it
+                        self.invalidate(key)
+                        self.logger.debug(f"Cache expired for {key} in {self.name}")
+                else:
+                    self.misses += 1
+            except Exception as e:
+                self.logger.error(f"Error getting item from {self.name} cache with key {key}: {str(e)}")
+                self.logger.error(traceback.format_exc())
+
+            return None
+
+    def set(self, key: str, value: T) -> None:
+        """
+        Set a value in the cache.
+
+        Args:
+            key: The cache key to set.
+            value: The value to cache.
+        """
+        if not self.enabled:
+            return
+
+        with self.lock:
+            try:
+                if len(self._cache) >= 1000 and key not in self._cache:
+                    # Basic LRU-like eviction: remove the first item found (not true LRU)
+                    try:
+                        oldest_key = next(iter(self._cache))
+                        self.invalidate(oldest_key)
+                        self.evictions += 1
+                    except StopIteration:
+                        # Cache was empty, which shouldn't happen if len >= max_size > 0
+                        pass # Or log an error
+
+                self._cache[key] = value
+                self._timestamps[key] = time.time()
+                self.sets += 1
+                self.logger.debug(f"Cached item {key} in {self.name}")
+            except Exception as e:
+                self.logger.error(f"Error setting item in {self.name} cache with key {key}: {str(e)}")
+                self.logger.error(traceback.format_exc())
+
+    def invalidate(self, key: str) -> None:
+        """
+        Remove a specific key from the cache.
+
+        Args:
+            key: The cache key to invalidate.
+        """
+        with self.lock:
+            try:
+                self._cache.pop(key, None)
+                self._timestamps.pop(key, None)
+                self.evictions += 1
+                self.logger.debug(f"Invalidated cache for {key} in {self.name}")
+            except Exception as e:
+                self.logger.error(f"Error invalidating cache in {self.name} for key {key}: {str(e)}")
+                self.logger.error(traceback.format_exc())
+
+    def invalidate_all(self) -> None:
+        """Clear all cached items."""
+        with self.lock:
+            try:
+                cache_size = len(self._cache)
+                self._cache.clear()
+                self._timestamps.clear()
+                self.evictions += cache_size
+                self.logger.info(f"Invalidated all {cache_size} entries in {self.name} cache")
+            except Exception as e:
+                self.logger.error(f"Error invalidating all cache entries in {self.name}: {str(e)}")
+                self.logger.error(traceback.format_exc())
+
+    def get_or_set(
+        self,
+        key: str,
+        data_loader: Callable[[], T]
+    ) -> Tuple[T, bool]:
+        """
+        Get a value from cache or set it using the data_loader if missing or expired.
+
+        Args:
+            key: The cache key.
+            data_loader: Function to load data if not in cache.
+
+        Returns:
+            Tuple of (data, was_cached) where was_cached indicates if from cache.
+        """
+        try:
+            cached_data = self.get(key)
+            if cached_data is not None:
+                return cached_data, True
+
+            # Not in cache or expired, load the data
+            self.logger.debug(f"Cache miss for {key} in {self.name}, loading data...")
+
+            # Check if the data_loader is a coroutine function
+            if inspect.iscoroutinefunction(data_loader):
+                self.logger.error(
+                    f"Error in get_or_set for {key} in {self.name}: "
+                    f"data_loader is a coroutine function which is not supported. "
+                    f"Use a regular function that returns a value, not a coroutine."
+                )
+                # Fall back to running the coroutine in the event loop if possible
+                try:
+                    loop = asyncio.get_event_loop()
+                    fresh_data = loop.run_until_complete(data_loader())
+                except Exception as coro_err:
+                    self.logger.error(f"Failed to execute coroutine data_loader: {str(coro_err)}")
+                    raise RuntimeError(f"Cannot use coroutine data_loader in cache: {str(coro_err)}")
+            else:
+                # Regular function, just call it
+                fresh_data = data_loader()
+
+            if fresh_data is not None:  # Only cache if we got valid data
+                self.set(key, fresh_data)
+
+            if fresh_data is None:
+                raise ValueError(f"Data loader returned None for key {key} in {self.name}")
+            return fresh_data, False
+        except Exception as e:
+            self.logger.error(f"Error in get_or_set for {key} in {self.name}: {str(e)}")
+            self.logger.error(traceback.format_exc())
+
+            # Since this is a critical function, re-raise the exception
+            # after logging it, but add context about the cache
+            raise RuntimeError(f"Cache error in {self.name} for key {key}: {str(e)}") from e
+
+    async def async_get_or_set(
+        self,
+        key: str,
+        async_data_loader: Callable[[], Awaitable[T]]
+    ) -> Tuple[T, bool]:
+        """
+        Async version of get_or_set for use with async data loaders.
+
+        Args:
+            key: The cache key.
+            async_data_loader: Async function to load data if not in cache.
+
+        Returns:
+            Tuple of (data, was_cached) where was_cached indicates if from cache.
+        """
+        if not self.enabled:
+            self.logger.debug(f"Cache {self.name} is disabled. Loading data directly for key {key}.")
+            try:
+                fresh_data = await async_data_loader()
+                if fresh_data is None:
+                    self.logger.error(f"Async data loader returned None for key {key} in disabled cache {self.name}")
+                    raise ValueError(f"Async data loader returned None for key {key} in {self.name} (cache disabled)")
+                return fresh_data, False
+            except Exception as e:
+                self.logger.error(f"Error in async_data_loader for key {key} in disabled cache {self.name}: {str(e)}")
+                self.logger.error(traceback.format_exc())
+                raise RuntimeError(f"Cache error (disabled) in {self.name} for key {key}: {str(e)}") from e
+
+        try:
+            cached_data = self.get(key) # self.get() is synchronous, assumed to be fast.
+            if cached_data is not None:
+                self.logger.debug(f"Cache HIT for key {key} in {self.name} (async_get_or_set)")
+                return cached_data, True
+
+            self.logger.debug(f"Cache MISS for key {key} in {self.name} (async_get_or_set). Loading data.")
+            # Not in cache or expired, load the data asynchronously
+            fresh_data = await async_data_loader()
+
+            if fresh_data is not None:  # Only cache if we got valid data
+                self.set(key, fresh_data)
+            else:
+                # Log an error if data_loader returns None, as it's unexpected.
+                self.logger.error(f"Async data loader returned None for key {key} in {self.name}")
+                raise ValueError(f"Async data loader returned None for key {key} in {self.name}")
+
+            return fresh_data, False
+        except Exception as e:
+            self.logger.error(f"Error in async_get_or_set for key {key} in {self.name}: {str(e)}")
+            self.logger.error(traceback.format_exc())
+            # Re-raise the exception after logging, adding context
+            raise RuntimeError(f"Cache error in {self.name} for key {key} (async): {str(e)}") from e
+
+    def get_stats(self) -> Dict[str, Any]:
+        """Get statistics about the current cache state."""
+        with self.lock:
+            try:
+                # Clean up expired items before reporting size
+                current_time = time.time()
+                # Corrected: Use self._timestamps to find expired keys
+                expired_keys = [k for k, ts in self._timestamps.items() if current_time - ts >= self.ttl]
+                for k in expired_keys:
+                    self._cache.pop(k, None)
+                    self._timestamps.pop(k, None)
+                    self.evictions += 1
+
+                return {
+                    "name": self.name,
+                    "enabled": self.enabled,
+                    "ttl_seconds": self.ttl,
+                    "item_count": len(self._cache),
+                    "first_20_keys": list(self._cache.keys())[:20],  # Limit to first 20 keys
+                    "total_keys": len(self._cache.keys()),
+                    "memory_usage_estimate_megabytes": round(
+                        sum(len(str(k)) + self._estimate_size(v) for k, v in self._cache.items()) / (1024 * 1024),
+                        3
+                    ),
+                    "hits": self.hits,
+                    "misses": self.misses,
+                    "sets": self.sets,
+                    "evictions": self.evictions,
+                    "default_ttl": self.ttl
+                }
+            except Exception as e:
+                self.logger.error(f"Error getting stats for {self.name} cache: {str(e)}")
+                self.logger.error(traceback.format_exc())
+                return {
+                    "name": self.name,
+                    "enabled": self.enabled,
+                    "error": str(e),
+                    "ttl_seconds": self.ttl,
+                    "item_count": len(self._cache) if self._cache else 0
+                }
+
+    def _estimate_size(self, obj: Any) -> int:
+        """Estimate the memory size of an object in bytes."""
+        try:
+            if obj is None:
+                return 0
+            if isinstance(obj, (str, bytes, bytearray)):
+                return len(obj)
+            if isinstance(obj, (int, float, bool)):
+                return 8
+            if isinstance(obj, dict):
+                return sum(len(str(k)) + self._estimate_size(v) for k, v in obj.items())
+            if isinstance(obj, (list, tuple, set)):
+                return sum(self._estimate_size(i) for i in obj)
+            # For other objects, use a rough approximation
+            return len(str(obj))
+        except Exception:
+            # If we can't estimate, return a reasonable default
+            return 100
+
+    def __str__(self) -> str:
+        return f"SharedCache(name='{self.name}', size={len(self._cache)}, max_size={self.max_size}, hits={self.hits}, misses={self.misses})"

{ipulse_shared_core_ftredge-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/src/ipulse_shared_core_ftredge/dependencies/authz_for_apis.py

@@ -231,7 +231,7 @@ async def authorizeAPIRequest(
 ) -> Dict[str, Any]:
     """
     Authorize API request based on user status and OPA policies.
-    Enhanced with credit check information.
+    Enhanced with credit check information and proper exception handling.
 
     Args:
         request: The incoming request
@@ -241,6 +241,9 @@ async def authorizeAPIRequest(
 
     Returns:
         Authorization result containing decision details
+
+    Raises:
+        HTTPException: For authorization failures (403) or service errors (500)
     """
     opa_decision = None
     try:
@@ -251,9 +254,11 @@ async def authorizeAPIRequest(
         # Extract request context
         user_uid = request.state.user.get('uid')
         if not user_uid:
-            raise AuthorizationError(
-                action="access API",
-                additional_info={"path": str(request.url)}
+            # Log authorization failures at DEBUG level, not ERROR
+            logger.debug(f"Authorization denied for {request.method} {request.url.path}: No user UID found")
+            raise HTTPException(
+                status_code=403,
+                detail="Not authorized to access this resource"
             )
 
         # Determine if we need fresh status
@@ -313,7 +318,7 @@ async def authorizeAPIRequest(
                     timeout=5.0  # 5 seconds timeout
                 )
                 logger.debug(f"OPA Response Status: {response.status_code}")
-                logger.debug(f"OPA Response Body: {response.text}")
+                # logger.debug(f"OPA Response Body: {response.text}")
 
                 if response.status_code != 200:
                     logger.error(f"OPA authorization failed: {response.text}")
@@ -326,11 +331,9 @@ async def authorizeAPIRequest(
                 logger.debug(f"Parsed OPA response: {result}")
 
                 # Handle unusual OPA response formats
-                # Try to find "decision" field as an alternative
                 if "result" in result:
                     opa_decision = result["result"]
                 else:
-                    # If we still don't have a result after all attempts, use default structure
                     logger.warning(f"OPA response missing 'result' field, using default")
                     raise HTTPException(
                         status_code=500,
@@ -340,31 +343,21 @@ async def authorizeAPIRequest(
                 # Extract key fields from result with better default handling
                 allow = opa_decision.get("allow", False)
 
-                # Handle authorization denial
+                # Handle authorization denial - log at DEBUG level, not ERROR
                 if not allow:
-                    logger.error(f"Authorization denied: {result}")
-                    raise AuthorizationError(
-                        action=f"{request.method} {request.url.path}",
-                        additional_info={
-                            "user_uid": user_uid,
-                            "resource_fields": request_resource_fields,
-                            "opa_decision": opa_decision,  # Include the full OPA decision result
-                            # Include the raw result if it's different from the processed decision
-                            "raw_opa_response": result if result != {"result": opa_decision} else None
-                        }
+                    logger.debug(f"Authorization denied for {request.method} {request.url.path}: insufficient permissions")
+                    raise HTTPException(
+                        status_code=403,
+                        detail=f"Not authorized to {request.method} {request.url.path}"
                     )
 
             except httpx.RequestError as e:
+                # Only log actual system errors at ERROR level
                 logger.error(f"Failed to connect to OPA: {str(e)}")
-                raise ServiceError(
-                    operation="API authorization",
-                    error=e,
-                    resource_type="authorization",
-                    additional_info={
-                        "opa_url": opa_url,
-                        "connection_error": str(e)
-                    }
-                ) from e
+                raise HTTPException(
+                    status_code=500,
+                    detail="Authorization service temporarily unavailable"
+                )
 
         # More descriptive metadata about the data freshness
         return {
@@ -374,21 +367,16 @@ async def authorizeAPIRequest(
             "opa_decision": opa_decision
         }
 
-    except (AuthorizationError, ResourceNotFoundError):
+    except HTTPException:
+        # Re-raise HTTPExceptions as-is (they're already properly formatted)
         raise
     except Exception as e:
-        logger.exception(f"Exception in authorizeAPIRequest: {e}")
-        raise ServiceError(
-            operation="API authorization",
-            error=e,
-            resource_type="authorization",
-            additional_info={
-                "path": str(request.url),
-                "method": request.method,
-                "user_uid": request.state.user.get('uid'),
-                "resource_fields": request_resource_fields
-            }
-        ) from e
+        # Only log unexpected errors at ERROR level
+        logger.error(f"Unexpected error during authorization for {request.method} {request.url.path}: {str(e)}")
+        raise HTTPException(
+            status_code=500,
+            detail="Internal authorization error"
+        )
 
 def _should_force_fresh_status(request: Request) -> bool:
     """

{ipulse_shared_core_ftredge-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/src/ipulse_shared_core_ftredge/models/__init__.py

@@ -5,7 +5,6 @@ from .user_profile_update import UserProfileUpdate
 from .user_auth import UserAuth
 from .organization_profile import OrganizationProfile
 from .base_api_response import BaseAPIResponse , CustomJSONResponse
-
-
+from .base_data_model import BaseDataModel
 
 

ipulse_shared_core_ftredge-14.0.1/src/ipulse_shared_core_ftredge/services/__init__.py

@@ -0,0 +1,14 @@
+"""Service utilities for shared core."""
+# Import existing components
+from ipulse_shared_core_ftredge.services.base_service_exceptions import (
+    BaseServiceException, ServiceError, ValidationError, ResourceNotFoundError, AuthorizationError
+)
+from ipulse_shared_core_ftredge.services.servicemon import Servicemon
+from ipulse_shared_core_ftredge.services.base_firestore_service import BaseFirestoreService
+from ipulse_shared_core_ftredge.services.cache_aware_firestore_service import CacheAwareFirestoreService
+
+__all__ = [
+   'AuthorizationError', 'BaseServiceException', 'ServiceError', 'ValidationError',
+    'ResourceNotFoundError',  'BaseFirestoreService',
+    'CacheAwareFirestoreService'
+]

ipulse_shared_core_ftredge-14.0.1/src/ipulse_shared_core_ftredge/services/cache_aware_firestore_service.py

@@ -0,0 +1,169 @@
+"""Cache-aware Firestore service base class."""
+import time
+from typing import TypeVar, Generic, Dict, Any, List, Optional
+from google.cloud import firestore
+from ipulse_shared_core_ftredge.services.base_firestore_service import BaseFirestoreService
+from ipulse_shared_core_ftredge.services.base_service_exceptions import ResourceNotFoundError, ServiceError
+from ipulse_shared_core_ftredge.cache.shared_cache import SharedCache
+from ipulse_shared_core_ftredge import BaseDataModel
+
+T = TypeVar('T', bound=BaseDataModel)
+
+class CacheAwareFirestoreService(BaseFirestoreService[T], Generic[T]):
+    """
+    Base service class that adds caching capabilities to BaseFirestoreService.
+    Supports both document-level and collection-level caching.
+    """
+
+    def __init__(
+        self,
+        db: firestore.Client,
+        collection_name: str,
+        resource_type: str,
+        logger,
+        document_cache: Optional[SharedCache] = None,
+        collection_cache: Optional[SharedCache] = None,
+        timeout: float = 30.0
+    ):
+        super().__init__(db, collection_name, resource_type, logger)
+        self.document_cache = document_cache
+        self.collection_cache = collection_cache
+        self.timeout = timeout
+
+        # Log cache configuration
+        if self.document_cache:
+            self.logger.info(f"Document cache enabled for {resource_type}: {self.document_cache.name}")
+        if self.collection_cache:
+            self.logger.info(f"Collection cache enabled for {resource_type}: {self.collection_cache.name}")
+
+    async def get_document(self, doc_id: str) -> Dict[str, Any]:
+        """
+        Get a document with caching support.
+
+        Args:
+            doc_id: Document ID to fetch
+
+        Returns:
+            Document data as dictionary
+
+        Raises:
+            ResourceNotFoundError: If document doesn't exist
+        """
+        # Check cache first
+        if self.document_cache:
+            start_time = time.time()
+            cached_doc = self.document_cache.get(doc_id)
+            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")
+                return cached_doc
+            else:
+                self.logger.debug(f"Cache MISS for document {doc_id} - checking Firestore")
+
+        # Fetch from Firestore
+        start_time = time.time()
+        doc_ref = self.db.collection(self.collection_name).document(doc_id)
+        doc = doc_ref.get(timeout=self.timeout)
+        firestore_time = (time.time() - start_time) * 1000
+
+        if not doc.exists:
+            self.logger.info(f"Document {doc_id} not found in Firestore after {firestore_time:.2f}ms")
+            raise ResourceNotFoundError(self.resource_type, doc_id)
+
+        doc_data = doc.to_dict()
+        self.logger.debug(f"Fetched document {doc_id} from Firestore in {firestore_time:.2f}ms")
+
+        # Cache the result
+        if self.document_cache and doc_data:
+            self.document_cache.set(doc_id, doc_data)
+            self.logger.debug(f"Cached document {doc_id}")
+
+        return doc_data
+
+    async def get_all_documents(self, cache_key: Optional[str] = None) -> List[Dict[str, Any]]:
+        """
+        Retrieves all documents from the collection.
+        Uses collection_cache if cache_key is provided and cache is available.
+        Also populates document_cache for each retrieved document.
+        """
+        if cache_key and self.collection_cache:
+            cached_collection_data = self.collection_cache.get(cache_key)
+            if cached_collection_data is not None:
+                self.logger.debug(f"Cache HIT for collection key '{cache_key}' in {self.collection_cache.name}")
+                # Ensure individual documents are also in document_cache if possible
+                if self.document_cache:
+                    for doc_data in cached_collection_data:
+                        if "id" in doc_data and not self.document_cache.get(doc_data["id"]):
+                            self._cache_document_data(doc_data["id"], doc_data)
+                return cached_collection_data
+            else:
+                self.logger.debug(f"Cache MISS for collection key '{cache_key}' in {self.collection_cache.name} - checking Firestore")
+
+        self.logger.info(f"Fetching all documents for {self.resource_type} from Firestore.")
+        start_time = time.time()
+
+        try:
+            docs_stream = self.db.collection(self.collection_name).stream(timeout=self.timeout)
+            docs_data_list = []
+            for doc in docs_stream:
+                doc_data = doc.to_dict()
+                if doc_data is not None:
+                    doc_data["id"] = doc.id  # Ensure 'id' field is present
+                    docs_data_list.append(doc_data)
+
+            fetch_time = (time.time() - start_time) * 1000
+            self.logger.debug(f"Fetched {len(docs_data_list)} documents for {self.resource_type} from Firestore in {fetch_time:.2f}ms")
+
+            # Cache the entire collection if cache_key and collection_cache are available
+            if cache_key and self.collection_cache:
+                self.collection_cache.set(cache_key, docs_data_list)
+                self.logger.debug(f"Cached collection with key '{cache_key}' in {self.collection_cache.name}")
+
+            # Populate individual document cache
+            if self.document_cache:
+                self.logger.debug(f"Populating document cache ({self.document_cache.name}) with {len(docs_data_list)} items for {self.resource_type}.")
+                for doc_data in docs_data_list:
+                    # _cache_document_data expects 'id' to be in doc_data for keying
+                    self._cache_document_data(doc_data["id"], doc_data)
+
+            return docs_data_list
+
+        except Exception as e:
+            self.logger.error(f"Error fetching all documents for {self.resource_type}: {str(e)}", exc_info=True)
+            raise ServiceError(operation=f"fetching all {self.resource_type}s", error=e, resource_type=self.resource_type) from e
+
+    def _cache_document_data(self, doc_id: str, data: Dict[str, Any]):
+        """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}")
+
+    async def create_document(self, doc_id: str, data: T, creator_uid: str) -> Dict[str, Any]:
+        """Create document and invalidate cache."""
+        result = await super().create_document(doc_id, data, creator_uid)
+        self._invalidate_document_cache(doc_id)
+        return result
+
+    async def update_document(self, doc_id: str, update_data: Dict[str, Any], updater_uid: str) -> Dict[str, Any]:
+        """Update document and invalidate cache."""
+        result = await super().update_document(doc_id, update_data, updater_uid)
+        self._invalidate_document_cache(doc_id)
+        return result
+
+    async def delete_document(self, doc_id: str, deleter_uid: Optional[str] = None) -> None:
+        """Delete document and invalidate cache."""
+        await super().delete_document(doc_id)
+        self._invalidate_document_cache(doc_id)
+
+    def _invalidate_document_cache(self, doc_id: str) -> None:
+        """Invalidate document cache for a specific document."""
+        if self.document_cache:
+            self.document_cache.invalidate(doc_id)
+            self.logger.debug(f"Invalidated cache for document {doc_id}")
+
+    def _invalidate_collection_cache(self, cache_key: str) -> None:
+        """Invalidate collection cache for a specific cache key."""
+        if self.collection_cache:
+            self.collection_cache.invalidate(cache_key)
+            self.logger.debug(f"Invalidated collection cache for key {cache_key}")

{ipulse_shared_core_ftredge-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/src/ipulse_shared_core_ftredge/services/credit_service.py

@@ -135,7 +135,7 @@ class CreditService:
                 error=e,
                 resource_type="user_credits",
                 resource_id=user_uid,
-                additional_info={"credits_to_charge": credits_to_charge}
+                additional_info={"credits_to_charge": required_credits_for_resource}
             ) from e
 
     async def charge_credits(self, user_uid: str, credits_to_charge: Optional[float], operation_details: str) -> bool:

{ipulse_shared_core_ftredge-12.0.1 → ipulse_shared_core_ftredge-14.0.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipulse_shared_core_ftredge
-Version: 12.0.1
+Version: 14.0.1
 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-12.0.1 → ipulse_shared_core_ftredge-14.0.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt
 src/ipulse_shared_core_ftredge.egg-info/dependency_links.txt
 src/ipulse_shared_core_ftredge.egg-info/requires.txt
 src/ipulse_shared_core_ftredge.egg-info/top_level.txt
+src/ipulse_shared_core_ftredge/cache/__init__.py
+src/ipulse_shared_core_ftredge/cache/shared_cache.py
 src/ipulse_shared_core_ftredge/dependencies/__init__.py
 src/ipulse_shared_core_ftredge/dependencies/auth_firebase_token_validation.py
 src/ipulse_shared_core_ftredge/dependencies/auth_protected_router.py
@@ -25,9 +27,12 @@ src/ipulse_shared_core_ftredge/models/user_status.py
 src/ipulse_shared_core_ftredge/services/__init__.py
 src/ipulse_shared_core_ftredge/services/base_firestore_service.py
 src/ipulse_shared_core_ftredge/services/base_service_exceptions.py
+src/ipulse_shared_core_ftredge/services/cache_aware_firestore_service.py
 src/ipulse_shared_core_ftredge/services/credit_service.py
 src/ipulse_shared_core_ftredge/services/fastapiservicemon.py
 src/ipulse_shared_core_ftredge/services/servicemon.py
 src/ipulse_shared_core_ftredge/utils/__init__.py
 src/ipulse_shared_core_ftredge/utils/custom_json_encoder.py
-src/ipulse_shared_core_ftredge/utils/json_encoder.py
+src/ipulse_shared_core_ftredge/utils/json_encoder.py
+tests/test_cache_aware_service.py
+tests/test_shared_cache.py

ipulse_shared_core_ftredge-14.0.1/tests/test_cache_aware_service.py

@@ -0,0 +1,233 @@
+"""Tests for the CacheAwareFirestoreService."""
+
+import unittest
+import logging
+from unittest.mock import MagicMock, patch, AsyncMock
+from pydantic import BaseModel
+from ipulse_shared_core_ftredge.cache.shared_cache import SharedCache
+from ipulse_shared_core_ftredge.services import CacheAwareFirestoreService
+
+
+# Configure logging for tests
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+# Create a simple model for testing
+class TestModel(BaseModel):
+    id: str
+    name: str
+    description: str
+
+
+class TestCacheAwareFirestoreService(unittest.TestCase):
+    """Test cases for CacheAwareFirestoreService."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        # Create mock Firestore client
+        self.db_mock = MagicMock()
+
+        # Create mock caches
+        self.document_cache = SharedCache[dict](
+            name="TestDocCache",
+            ttl=1.0,
+            enabled=True,
+            logger=logger
+        )
+
+        self.collection_cache = SharedCache[list](
+            name="TestCollectionCache",
+            ttl=1.0,
+            enabled=True,
+            logger=logger
+        )
+
+        # Create service instance with mocks
+        self.service = CacheAwareFirestoreService[TestModel](
+            db=self.db_mock,
+            collection_name="test_collection",
+            resource_type="test_resource",
+            logger=logger,
+            document_cache=self.document_cache,
+            collection_cache=self.collection_cache,
+            timeout=5.0
+        )
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.get_document')
+    async def test_get_document_cache_hit(self, mock_get_document):
+        """Test get_document with cache hit."""
+        # Prepare cached data
+        test_data = {"id": "doc123", "name": "Test Doc", "description": "This is a test"}
+        self.document_cache.set("doc123", test_data)
+
+        # Execute get_document
+        result = await self.service.get_document("doc123")
+
+        # Verify result comes from cache
+        self.assertEqual(result, test_data)
+
+        # Verify Firestore was not called
+        mock_get_document.assert_not_called()
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.get_document')
+    async def test_get_document_cache_miss(self, mock_get_document):
+        """Test get_document with cache miss."""
+        # Configure mock to return data
+        mock_data = {"id": "doc123", "name": "Test Doc", "description": "This is a test"}
+        mock_get_document.return_value = mock_data
+
+        # Execute get_document
+        result = await self.service.get_document("doc123")
+
+        # Verify Firestore was called
+        mock_get_document.assert_called_once_with("doc123")
+
+        # Verify result is correct
+        self.assertEqual(result, mock_data)
+
+        # Verify data was cached
+        cached_data = self.document_cache.get("doc123")
+        self.assertEqual(cached_data, mock_data)
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.get_all_documents')
+    async def test_get_all_documents_cache_hit(self, mock_get_all):
+        """Test get_all_documents with cache hit."""
+        # Prepare cached data
+        test_docs = [
+            {"id": "doc1", "name": "Doc 1", "description": "First doc"},
+            {"id": "doc2", "name": "Doc 2", "description": "Second doc"}
+        ]
+        self.collection_cache.set("test_cache_key", test_docs)
+
+        # Execute get_all_documents
+        result = await self.service.get_all_documents("test_cache_key")
+
+        # Verify result comes from cache
+        self.assertEqual(result, test_docs)
+
+        # Verify Firestore was not called
+        mock_get_all.assert_not_called()
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.get_all_documents')
+    async def test_get_all_documents_cache_miss(self, mock_get_all):
+        """Test get_all_documents with cache miss."""
+        # Configure mock to return data
+        mock_docs = [
+            {"id": "doc1", "name": "Doc 1", "description": "First doc"},
+            {"id": "doc2", "name": "Doc 2", "description": "Second doc"}
+        ]
+        mock_get_all.return_value = mock_docs
+
+        # Execute get_all_documents
+        result = await self.service.get_all_documents("test_cache_key")
+
+        # Verify Firestore was called
+        mock_get_all.assert_called_once()
+
+        # Verify result is correct
+        self.assertEqual(result, mock_docs)
+
+        # Verify data was cached
+        cached_docs = self.collection_cache.get("test_cache_key")
+        self.assertEqual(cached_docs, mock_docs)
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.update_document')
+    async def test_update_document_invalidates_cache(self, mock_update):
+        """Test that update_document invalidates cache."""
+        # Prepare cached data
+        test_data = {"id": "doc123", "name": "Test Doc", "description": "This is a test"}
+        self.document_cache.set("doc123", test_data)
+
+        # Configure mock to return updated data
+        updated_data = {"id": "doc123", "name": "Updated Doc", "description": "This was updated"}
+        mock_update.return_value = updated_data
+
+        # Execute update_document
+        await self.service.update_document("doc123", {"name": "Updated Doc"}, "user123")
+
+        # Verify cache was invalidated
+        self.assertIsNone(self.document_cache.get("doc123"))
+
+        # Verify collection cache was also invalidated
+        if self.collection_cache.get("all_documents"):
+            self.fail("Collection cache was not invalidated")
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.create_document')
+    async def test_create_document_invalidates_cache(self, mock_create):
+        """Test that create_document invalidates cache."""
+        # Prepare collection cache data
+        test_docs = [{"id": "doc1", "name": "Doc 1"}]
+        self.collection_cache.set("all_documents", test_docs)
+
+        # Configure mock to return created data
+        new_data = {"id": "doc2", "name": "New Doc", "description": "Newly created"}
+        mock_create.return_value = new_data
+
+        # Create model instance
+        new_model = TestModel(id="doc2", name="New Doc", description="Newly created")
+
+        # Execute create_document
+        await self.service.create_document("doc2", new_model, "user123")
+
+        # Verify collection cache was invalidated
+        self.assertIsNone(self.collection_cache.get("all_documents"))
+
+    @patch('ipulse_shared_core_ftredge.services.BaseFirestoreService.delete_document')
+    async def test_delete_document_invalidates_cache(self, mock_delete):
+        """Test that delete_document invalidates cache."""
+        # Prepare cached data
+        test_data = {"id": "doc123", "name": "Test Doc", "description": "This is a test"}
+        self.document_cache.set("doc123", test_data)
+
+        test_docs = [test_data]
+        self.collection_cache.set("all_documents", test_docs)
+
+        # Execute delete_document
+        await self.service.delete_document("doc123")
+
+        # Verify document cache was invalidated
+        self.assertIsNone(self.document_cache.get("doc123"))
+
+        # Verify collection cache was also invalidated
+        self.assertIsNone(self.collection_cache.get("all_documents"))
+
+    def test_invalidate_document_cache(self):
+        """Test _invalidate_document_cache method."""
+        # Prepare cached data
+        test_data = {"id": "doc123", "name": "Test Doc"}
+        self.document_cache.set("doc123", test_data)
+
+        # Execute invalidation
+        self.service._invalidate_document_cache("doc123")
+
+        # Verify cache was invalidated
+        self.assertIsNone(self.document_cache.get("doc123"))
+
+    def test_invalidate_collection_cache(self):
+        """Test _invalidate_collection_cache method."""
+        # Prepare cached data
+        test_docs = [{"id": "doc1", "name": "Doc 1"}, {"id": "doc2", "name": "Doc 2"}]
+        self.collection_cache.set("all_documents", test_docs)
+
+        # Execute invalidation
+        self.service._invalidate_collection_cache()
+
+        # Verify cache was invalidated
+        self.assertIsNone(self.collection_cache.get("all_documents"))
+
+    def test_invalidate_collection_cache_custom_key(self):
+        """Test _invalidate_collection_cache method with custom key."""
+        # Prepare cached data
+        test_docs = [{"id": "doc1", "name": "Doc 1"}, {"id": "doc2", "name": "Doc 2"}]
+        self.collection_cache.set("custom_key", test_docs)
+
+        # Execute invalidation
+        self.service._invalidate_collection_cache("custom_key")
+
+        # Verify cache was invalidated
+        self.assertIsNone(self.collection_cache.get("custom_key"))
+
+
+if __name__ == "__main__":
+    unittest.main()

ipulse_shared_core_ftredge-14.0.1/tests/test_shared_cache.py

@@ -0,0 +1,146 @@
+"""Tests for the SharedCache implementation."""
+
+import time
+import unittest
+import logging
+from ipulse_shared_core_ftredge.cache.shared_cache import SharedCache
+
+# Configure logging for tests
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+class TestSharedCache(unittest.TestCase):
+    """Test cases for SharedCache."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        self.cache = SharedCache[str](
+            name="TestCache",
+            ttl=0.5,  # Short TTL for faster testing
+            enabled=True,
+            logger=logger
+        )
+
+    def test_cache_set_get(self):
+        """Test basic cache set and get operations."""
+        # Set a value
+        self.cache.set("test_key", "test_value")
+
+        # Get the value
+        cached_value = self.cache.get("test_key")
+
+        # Verify value was cached
+        self.assertEqual(cached_value, "test_value")
+
+    def test_cache_ttl_expiration(self):
+        """Test cache TTL expiration."""
+        # Set a value
+        self.cache.set("expiring_key", "expiring_value")
+
+        # Verify it's initially cached
+        self.assertEqual(self.cache.get("expiring_key"), "expiring_value")
+
+        # Wait for TTL to expire
+        time.sleep(0.6)  # Slightly longer than TTL
+
+        # Verify value is no longer cached
+        self.assertIsNone(self.cache.get("expiring_key"))
+
+    def test_cache_invalidate(self):
+        """Test cache invalidation."""
+        # Set multiple values
+        self.cache.set("key1", "value1")
+        self.cache.set("key2", "value2")
+
+        # Invalidate specific key
+        self.cache.invalidate("key1")
+
+        # Verify key1 is gone but key2 remains
+        self.assertIsNone(self.cache.get("key1"))
+        self.assertEqual(self.cache.get("key2"), "value2")
+
+    def test_cache_invalidate_all(self):
+        """Test invalidating all cache entries."""
+        # Set multiple values
+        self.cache.set("key1", "value1")
+        self.cache.set("key2", "value2")
+
+        # Invalidate all
+        self.cache.invalidate_all()
+
+        # Verify both keys are gone
+        self.assertIsNone(self.cache.get("key1"))
+        self.assertIsNone(self.cache.get("key2"))
+
+    def test_cache_get_or_set(self):
+        """Test get_or_set functionality."""
+        # Define a counter to verify how many times the loader is called
+        counter = [0]
+
+        def data_loader():
+            counter[0] += 1
+            return f"loaded_value_{counter[0]}"
+
+        # First call should use data_loader
+        value1, was_cached1 = self.cache.get_or_set("loader_key", data_loader)
+
+        # Second call should use cached value
+        value2, was_cached2 = self.cache.get_or_set("loader_key", data_loader)
+
+        # Verify results
+        self.assertEqual(value1, "loaded_value_1")
+        self.assertEqual(value2, "loaded_value_1")  # Same value from cache
+        self.assertFalse(was_cached1)  # First call was not cached
+        self.assertTrue(was_cached2)   # Second call was cached
+        self.assertEqual(counter[0], 1)  # Loader called exactly once
+
+    def test_cache_disabled(self):
+        """Test cache behavior when disabled."""
+        # Create disabled cache
+        disabled_cache = SharedCache[str](
+            name="DisabledCache",
+            ttl=1.0,
+            enabled=False,
+            logger=logger
+        )
+
+        # Set a value
+        disabled_cache.set("disabled_key", "disabled_value")
+
+        # Attempt to get - should return None since cache is disabled
+        cached_value = disabled_cache.get("disabled_key")
+        self.assertIsNone(cached_value)
+
+    def test_cache_generic_typing(self):
+        """Test cache with different data types."""
+        # Integer cache
+        int_cache = SharedCache[int](name="IntCache", ttl=1.0, enabled=True)
+        int_cache.set("int_key", 123)
+        self.assertEqual(int_cache.get("int_key"), 123)
+
+        # Dictionary cache
+        dict_cache = SharedCache[dict](name="DictCache", ttl=1.0, enabled=True)
+        dict_cache.set("dict_key", {"a": 1, "b": 2})
+        self.assertEqual(dict_cache.get("dict_key"), {"a": 1, "b": 2})
+
+    def test_cache_stats(self):
+        """Test cache statistics."""
+        # Add some data
+        self.cache.set("stats_key1", "stats_value1")
+        self.cache.set("stats_key2", "stats_value2")
+
+        # Get stats
+        stats = self.cache.get_stats()
+
+        # Verify stats
+        self.assertEqual(stats["name"], "TestCache")
+        self.assertEqual(stats["enabled"], True)
+        self.assertEqual(stats["ttl_seconds"], 0.5)
+        self.assertEqual(stats["item_count"], 2)
+        self.assertIn("stats_key1", stats["keys"])
+        self.assertIn("stats_key2", stats["keys"])
+
+
+if __name__ == "__main__":
+    unittest.main()

ipulse_shared_core_ftredge-12.0.1/src/ipulse_shared_core_ftredge/services/__init__.py

@@ -1,6 +0,0 @@
-from .base_firestore_service  import BaseFirestoreService
-
-from .base_service_exceptions import (BaseServiceException, ResourceNotFoundError, AuthorizationError,
-                            ValidationError ,ServiceError)
-from .servicemon import Servicemon
-from .fastapiservicemon import FastAPIServiceMon