ipulse-shared-core-ftredge 6.1.2__tar.gz → 6.3.1__tar.gz

{ipulse_shared_core_ftredge-6.1.2/src/ipulse_shared_core_ftredge.egg-info → ipulse_shared_core_ftredge-6.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 6.1.2
+Version: 6.3.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
@@ -8,7 +8,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
-Requires-Dist: ipulse_shared_base_ftredge>=5.1.1
+Requires-Dist: ipulse_shared_base_ftredge>=5.2.1
 Dynamic: author
 Dynamic: home-page
 Dynamic: requires-dist

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='ipulse_shared_core_ftredge',
-    version='6.1.2',
+    version='6.3.1',
     package_dir={'': 'src'},  # Specify the source directory
     packages=find_packages(where='src'),  # Look for packages in 'src'
     install_requires=[
@@ -11,7 +11,7 @@ setup(
         'pydantic[email]~=2.5',
         'python-dateutil~=2.8',
         'pytest~=7.1',
-        'ipulse_shared_base_ftredge>=5.1.1',
+        'ipulse_shared_base_ftredge>=5.2.1',
     ],
     author='Russlan Ramdowar',
     description='Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.',

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge/dependencies/authorization_api.py

@@ -5,7 +5,7 @@ from datetime import datetime, timedelta, timezone
 import httpx
 from fastapi import HTTPException, Request
 from google.cloud import firestore
-from ipulse_shared_core_ftredge.services.exceptions import ServiceError, AuthorizationError, ResourceNotFoundError
+from ipulse_shared_core_ftredge.services import ServiceError, AuthorizationError, ResourceNotFoundError
 
 # Constants
 USERS_STATUS_COLLECTION_NAME = "user-statuses"

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge/models/user_profile.py

@@ -1,7 +1,7 @@
-from datetime import datetime, date
-import dateutil.parser
+""" User Profile model representing user information. """
+from datetime import date
 from typing import Set, Optional, ClassVar
-from pydantic import BaseModel, EmailStr, Field, ConfigDict, field_validator
+from pydantic import EmailStr, Field, ConfigDict, field_validator
 from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject
 from .base_data_model import BaseDataModel
 
@@ -83,6 +83,7 @@ class UserProfile(BaseDataModel):
     @field_validator('id', mode='before')
     @classmethod
     def validate_or_generate_id(cls, v: Optional[str], info) -> str:
+        """Validate or generate user ID based on user_uid."""
         # If id is already provided (Firebase Auth case), return it
         if v:
             return v

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge/models/user_status.py

@@ -1,14 +1,15 @@
+""" User Status model for tracking user subscription and access rights. """
 from datetime import datetime
 from typing import Set, Optional, Dict, List, ClassVar
-from pydantic import BaseModel, Field, ConfigDict, field_validator
-from .subscription import Subscription
+from pydantic import Field, ConfigDict, field_validator
 from ipulse_shared_base_ftredge import Layer, Module, list_as_lower_strings, Subject
-import dateutil.parser
+from .subscription import Subscription
 from .base_data_model import BaseDataModel
+
 # ORIGINAL AUTHOR ="Russlan Ramdowar;russlan@ftredge.com"
 # CLASS_ORGIN_DATE=datetime(2024, 2, 12, 20, 5)
 
-############################################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! ############################################
+############################ !!!!! ALWAYS UPDATE SCHEMA VERSION , IF SCHEMA IS BEING MODIFIED !!! #################################
 class UserStatus(BaseDataModel):
     """
     User Status model for tracking user subscription and access rights.
@@ -35,7 +36,7 @@ class UserStatus(BaseDataModel):
         frozen=True,
         description="Version of this Class == version of DB Schema"
     )
-    
+
     id : str = Field(
         ...,
         description="User ID, format: {OBJ_REF}_{user_uid}"
@@ -90,6 +91,9 @@ class UserStatus(BaseDataModel):
     @field_validator('id', mode='before')
     @classmethod
     def validate_or_generate_id(cls, v: Optional[str], info) -> str:
+        """
+        Validate or generate the id field based on user_uid.
+        """
         # If id is already provided (Firebase Auth case), return it
         if v:
             return v

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

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

ipulse_shared_core_ftredge-6.1.2/src/ipulse_shared_core_ftredge/services/exceptions.py → ipulse_shared_core_ftredge-6.3.1/src/ipulse_shared_core_ftredge/services/base_exceptions.py

@@ -1,9 +1,11 @@
-from fastapi import HTTPException
+"""Base classes for service exceptions with enhanced logging"""
 from typing import Optional, Any, Dict
 import traceback
 import logging
+from fastapi import HTTPException
 
 class BaseServiceException(HTTPException):
+    """Base class for service exceptions with enhanced logging"""
     def __init__(
         self,
         status_code: int,

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge/services/base_firestore_service.py

@@ -1,9 +1,10 @@
-from typing import Dict, Any, Optional, List, TypeVar, Generic
+""" Base class for Firestore services with common CRUD operations """
+from typing import Dict, Any, List, TypeVar, Generic
 import logging
 from datetime import datetime, timezone
 from pydantic import BaseModel
 from google.cloud import firestore
-from .exceptions import ResourceNotFoundError, ValidationError, ServiceError
+from .base_exceptions import ResourceNotFoundError, ValidationError, ServiceError
 
 T = TypeVar('T', bound=BaseModel)
 

ipulse_shared_core_ftredge-6.3.1/src/ipulse_shared_core_ftredge/services/fastapiservicemon.py

@@ -0,0 +1,138 @@
+""" FastAPI ServiceMon"""
+import logging
+import time
+from fastapi import Request
+from ipulse_shared_base_ftredge import DataResource, Action, ProgressStatus, LogLevel
+from starlette.middleware.base import BaseHTTPMiddleware
+from . import Servicemon
+
+
+class FastAPIServiceMon(Servicemon):
+    """
+    Extension of Servicemon designed specifically for FastAPI applications.
+    Adds integration with FastAPI request/response lifecycle.
+    """
+
+    @staticmethod
+    def get_fastapi_middleware():
+        """
+        Creates a FastAPI middleware class that uses ServiceMon for request logging.
+
+        Returns:
+            A middleware class that can be registered with FastAPI
+        """
+
+
+        class ServiceMonMiddleware(BaseHTTPMiddleware):
+            """
+            Middleware class for integrating ServiceMon into FastAPI request/response lifecycle.
+            """
+            async def dispatch(self, request: Request, call_next):
+                # Create ServiceMon instance
+                logger_name = f"{request.app.state.env_prefix}__dp_core_api_live__apilogger"
+                logger = logging.getLogger(logger_name)
+
+                path = request.url.path
+                method = request.method
+
+                # Skip monitoring for certain paths
+                skip_paths = ["/health", "/metrics", "/docs", "/redoc", "/openapi.json"]
+                if any(path.startswith(skip_p) for skip_p in skip_paths):
+                    return await call_next(request)
+
+                # Initialize ServiceMon
+                svcmon = Servicemon(
+                    logger=logger,
+                    base_context=f"API: {path}\nMethod: {method}",
+                    service_name=f"API_{method}_{path.replace('/', '_')}"
+                )
+
+                # Start monitoring
+                client_ip = request.client.host if request.client else "unknown"
+                user_agent = request.headers.get("user-agent", "unknown")
+                svcmon.start(f"API Request {method} {path}")
+
+
+                # Add request info
+                svcmon.log(
+                    level=LogLevel.INFO,
+                    description=f"Request received for {method} {path}. Client IP: {client_ip}. User Agent: {user_agent}",
+                    resource=DataResource.API_INTERNAL,
+                    action=Action.EXECUTE,
+                    progress_status=ProgressStatus.STARTED,
+                )
+
+                # Process the request and catch any errors
+                try:
+                    # Store ServiceMon in request state for handlers to access
+                    request.state.svcmon = svcmon
+
+                    # Process request
+                    start_time = time.time()
+                    response = await call_next(request)
+                    process_time = int((time.time() - start_time) * 1000)
+
+                    # Log response
+                    status_code = response.status_code
+                    progress_status = (
+                        ProgressStatus.DONE
+                        if 200 <= status_code < 300
+                        else ProgressStatus.FINISHED_WITH_ISSUES
+                    )
+
+                    log_level = (
+                        LogLevel.ERROR if status_code >= 500
+                        else LogLevel.WARNING if status_code >= 400
+                        else LogLevel.INFO
+                    )
+
+                    svcmon.log(
+                        level=log_level,
+                        description=f"Response sent: {status_code} in {process_time}ms for {method} {path}",
+                        resource=DataResource.API_INTERNAL,
+                        action=Action.EXECUTE,
+                        progress_status=progress_status
+
+                    )
+
+                    # Finalize monitoring
+                    svcmon.end(status=progress_status)
+                    return response
+
+                except Exception as exc:
+                    svcmon.error(
+                        f"Error processing request: {str(exc)}",
+                        resource=DataResource.API_INTERNAL,
+                        action=Action.EXECUTE,
+                        progress_status=ProgressStatus.FAILED,
+                        e=exc
+                    )
+                    svcmon.end(status=ProgressStatus.FAILED)
+                    raise
+
+        return ServiceMonMiddleware
+
+    # @staticmethod
+    # def setup_fastapi(app):
+    #     """
+    #     Configure a FastAPI application with ServiceMon integration.
+
+    #     Args:
+    #         app: The FastAPI application instance
+    #     """
+    #     from fastapi import FastAPI
+
+    #     if not isinstance(app, FastAPI):
+    #         raise TypeError("Expected FastAPI application instance")
+
+    #     # Register middleware
+    #     app.add_middleware(FastAPIServiceMon.get_fastapi_middleware())
+
+    #     # Add dependency for route handlers
+    #     from fastapi import Depends, Request
+
+    #     async def get_servicemon(request: Request):
+    #         """Dependency for accessing the current ServiceMon instance."""
+    #         return getattr(request.state, "svcmon", None)
+
+    #     app.dependency_overrides[FastAPIServiceMon] = get_servicemon

ipulse_shared_core_ftredge-6.3.1/src/ipulse_shared_core_ftredge/services/servicemon.py

@@ -0,0 +1,240 @@
+"""
+ServiceMon - Lightweight monitoring for service functions and API endpoints
+"""
+import uuid
+import time
+from datetime import datetime, timezone
+from typing import Dict, Any, Optional
+from contextlib import contextmanager
+from ipulse_shared_base_ftredge import (LogLevel, AbstractResource,
+                                      ProgressStatus, Action, Resource,
+                                      Alert, StructLog)
+
+class Servicemon:
+    """
+    ServiceMon is a lightweight version of Pipelinemon designed specifically for monitoring
+    service functions like Cloud Functions and API endpoints.
+
+    It provides:
+    1. Structured logging with context tracking
+    2. Performance metrics capture
+    3. Service health monitoring
+    4. Integration with FastAPI request/response cycle
+    """
+
+    def __init__(self, logger,
+                 base_context: str,
+                 service_name: str):
+        """
+        Initialize ServiceMon with basic configuration.
+
+        Args:
+            logger: The logger instance to use for logging
+            base_context: Base context information for all logs
+            service_name: Name of the service being monitored
+        """
+        # Set up execution tracking details
+        self._start_time = None
+        self._service_name = service_name
+
+        timestamp = datetime.now(timezone.utc).strftime('%Y%m%d_%H%M%S')
+        uuid_suffix = str(uuid.uuid4())[:8]  # Take first 8 chars of UUID
+        self._id = f"{timestamp}_{uuid_suffix}"
+
+        # Set up context handling
+        self._base_context = base_context
+        self._context_stack = []
+
+        # Configure logging
+        self._logger = logger
+
+        # Metrics tracking
+        self._metrics = {
+            "status": ProgressStatus.NOT_STARTED.name,
+            "errors": 0,
+            "warnings": 0,
+            "start_time": None,
+            "end_time": None,
+            "duration_ms": None,
+        }
+
+    @property
+    def id(self) -> str:
+        """Get the unique ID for this service execution."""
+        return self._id
+
+    @property
+    def base_context(self) -> str:
+        """Get the base context for this service execution."""
+        return self._base_context
+
+    @property
+    def service_name(self) -> str:
+        """Get the service name being monitored."""
+        return self._service_name
+
+    @property
+    def metrics(self) -> Dict[str, Any]:
+        """Get the current service metrics."""
+        return self._metrics.copy()
+
+    @property
+    def current_context(self) -> str:
+        """Get the current context stack as a string."""
+        return " >> ".join(self._context_stack) if self._context_stack else "root"
+
+    @contextmanager
+    def context(self, context_name: str):
+        """
+        Context manager for tracking execution context.
+
+        Args:
+            context_name: The name of the current execution context
+        """
+        self.push_context(context_name)
+        try:
+            yield
+        finally:
+            self.pop_context()
+
+    def push_context(self, context: str):
+        """Add a context level to the stack."""
+        self._context_stack.append(context)
+
+    def pop_context(self):
+        """Remove the most recent context from the stack."""
+        if self._context_stack:
+            return self._context_stack.pop()
+
+    def start(self, description: Optional[str] = None) -> None:
+        """
+        Start monitoring a service execution.
+
+        Args:
+            description: Optional description of what's being executed
+        """
+        self._start_time = time.time()
+        self._metrics["start_time"] = datetime.now(timezone.utc).isoformat()
+        self._metrics["status"] = ProgressStatus.IN_PROGRESS.name
+
+        # Log the start event
+        msg = description if description else f"Starting {self.service_name}"
+        self.log(level=LogLevel.INFO, description=msg, resource=AbstractResource.SERVICEMON, action=Action.EXECUTE,
+                 progress_status=ProgressStatus.IN_PROGRESS)
+
+    def end(self, status: ProgressStatus = ProgressStatus.DONE) -> Dict[str, Any]:
+        """
+        End monitoring and record final metrics.
+
+        Args:
+            status: The final status of the service execution
+
+        Returns:
+            Dict containing metrics summary
+        """
+        # Calculate duration
+        end_time = time.time()
+        if self._start_time:
+            duration_ms = int((end_time - self._start_time) * 1000)
+            self._metrics["duration_ms"] = duration_ms
+
+        # Update metrics
+        self._metrics["end_time"] = datetime.now(timezone.utc).isoformat()
+        self._metrics["status"] = status.name
+
+        # Determine log level based on metrics
+        if self._metrics["errors"] > 0:
+            level = LogLevel.ERROR
+            if status == ProgressStatus.DONE:
+                status = ProgressStatus.FINISHED_WITH_ISSUES
+        elif self._metrics["warnings"] > 0:
+            level = LogLevel.WARNING
+            if status == ProgressStatus.DONE:
+                status = ProgressStatus.DONE_WITH_WARNINGS
+        else:
+            level = LogLevel.INFO
+
+        # Prepare summary message
+        summary_msg = (
+            f"Service {self.service_name} completed with status {status.name}. "
+            f"Duration: {self._metrics['duration_ms']}ms. "
+            f"Errors: {self._metrics['errors']}, Warnings: {self._metrics['warnings']}"
+        )
+
+        # Log the completion
+        self.log(
+            level=level,
+            description=summary_msg,
+            resource=AbstractResource.SERVICEMON,
+            action=Action.EXECUTE,
+            progress_status=status,
+        )
+
+        return self._metrics
+
+    def log(self,
+           level: LogLevel,
+           description: str,
+           resource: Optional[Resource] = None,
+           source: Optional[str] = None,
+           destination: Optional[str] = None,
+           action: Optional[Action] = None,
+           progress_status: Optional[ProgressStatus] = None,
+           alert: Optional[Alert] = None,
+           e: Optional[Exception] = None,
+           systems_impacted: Optional[str] = None,
+           notes: Optional[str] = None,
+           **kwargs) -> None:
+        """
+        Log a message with structured context.
+
+        Args:
+            level: Log level
+            description: Log message
+            resource: Resource being accessed
+            action: Action being performed
+            progress_status: Current progress status
+            alert: Alert type if applicable
+            e: Exception if logging an error
+            **kwargs: Additional fields to include in the log
+        """
+        # Update metrics
+        if level in (LogLevel.ERROR, LogLevel.CRITICAL):
+            self._metrics["errors"] += 1
+        elif level == LogLevel.WARNING:
+            self._metrics["warnings"] += 1
+
+
+        formatted_notes = f"{notes} ;elapsed_ms: {int((time.time() - self._start_time) * 1000)} " + str(kwargs)
+        # Create structured log
+        log = StructLog(
+            level=level,
+            resource=resource,
+            action=action,
+            progress_status=progress_status,
+            alert=alert,
+            e=e,
+            source=source,
+            destination=destination,
+            description=description,
+            collector_id=self.id,
+            base_context=self.base_context,
+            context=self.current_context,
+            systems_impacted=systems_impacted,
+            note=formatted_notes,
+            **kwargs
+        )
+
+        # Add service-specific fields
+        log_dict = log.to_dict()
+
+        # Write to logger
+        if level.value >= LogLevel.ERROR.value:
+            self._logger.error(log_dict)
+        elif level.value >= LogLevel.WARNING.value:
+            self._logger.warning(log_dict)
+        elif level.value >= LogLevel.INFO.value:
+            self._logger.info(log_dict)
+        else:
+            self._logger.debug(log_dict)
+

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1/src/ipulse_shared_core_ftredge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ipulse_shared_core_ftredge
-Version: 6.1.2
+Version: 6.3.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
@@ -8,7 +8,7 @@ License-File: LICENCE
 Requires-Dist: pydantic[email]~=2.5
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest~=7.1
-Requires-Dist: ipulse_shared_base_ftredge>=5.1.1
+Requires-Dist: ipulse_shared_base_ftredge>=5.2.1
 Dynamic: author
 Dynamic: home-page
 Dynamic: requires-dist

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge.egg-info/SOURCES.txt

@@ -24,5 +24,7 @@ src/ipulse_shared_core_ftredge/models/user_profile.py
 src/ipulse_shared_core_ftredge/models/user_profile_update.py
 src/ipulse_shared_core_ftredge/models/user_status.py
 src/ipulse_shared_core_ftredge/services/__init__.py
+src/ipulse_shared_core_ftredge/services/base_exceptions.py
 src/ipulse_shared_core_ftredge/services/base_firestore_service.py
-src/ipulse_shared_core_ftredge/services/exceptions.py
+src/ipulse_shared_core_ftredge/services/fastapiservicemon.py
+src/ipulse_shared_core_ftredge/services/servicemon.py

{ipulse_shared_core_ftredge-6.1.2 → ipulse_shared_core_ftredge-6.3.1}/src/ipulse_shared_core_ftredge.egg-info/requires.txt

@@ -1,4 +1,4 @@
 pydantic[email]~=2.5
 python-dateutil~=2.8
 pytest~=7.1
-ipulse_shared_base_ftredge>=5.1.1
+ipulse_shared_base_ftredge>=5.2.1

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

@@ -1,4 +0,0 @@
-from .base_firestore_service  import BaseFirestoreService
-
-from .exceptions import (BaseServiceException, ResourceNotFoundError, AuthorizationError,
-                            ValidationError )