solace-agent-mesh 1.4.12__py3-none-any.whl → 1.5.0__py3-none-any.whl

solace_agent_mesh/gateway/http_sse/services/services_llm.txt

@@ -1,13 +1,17 @@
 # DEVELOPER GUIDE: services
 
 ## Quick Summary
-The `services` directory contains the business logic layer for the HTTP SSE Gateway. It provides high-level services for agent management (discovering and retrieving A2A agents), user identity operations (searching for users), and task management (cancelling A2A tasks). These services abstract the complexities of interacting with agent registries, identity providers, and A2A messaging protocols.
+The `services` directory contains the business logic layer for the HTTP SSE Gateway. It provides high-level services for agent management (discovering and retrieving A2A agents), user feedback processing with database persistence and event publishing, user search via identity services, session management with database persistence, task logging to database, data retention/cleanup, and A2A task operations like cancellation.
 
 ## Files Overview
 - `__init__.py` - Package initialization file marking the directory as a Python package
-- `agent_service.py` - Service for retrieving information about discovered A2A agents from the registry
+- `agent_card_service.py` - Service for retrieving information about discovered A2A agents from the registry
+- `data_retention_service.py` - Service for automatic cleanup of old tasks and feedback based on retention policies
+- `feedback_service.py` - Service for processing and storing user feedback on chat messages with database and event publishing
 - `people_service.py` - Service for searching users via configured identity services
-- `task_service.py` - Service for handling A2A task cancellation operations
+- `session_service.py` - Service for managing chat sessions and messages with database persistence
+- `task_logger_service.py` - Service for logging A2A tasks and events to the database
+- `task_service.py` - Service for handling A2A task operations like cancellation
 
 ## Developer API Reference
 
@@ -15,36 +19,107 @@ The `services` directory contains the business logic layer for the HTTP SSE Gate
 **Purpose:** Marks the services directory as a Python package
 **Import:** N/A - No public interfaces
 
-### agent_service.py
+### agent_card_service.py
 **Purpose:** Provides methods for accessing information about discovered A2A agents from the shared AgentRegistry
-**Import:** `from solace_agent_mesh.gateway.http_sse.services.agent_service import AgentService`
+**Import:** `from solace_agent_mesh.gateway.http_sse.services.agent_card_service import AgentCardService`
 
 **Classes:**
-- `AgentService(agent_registry: AgentRegistry)` - Service for accessing discovered A2A agent information
-  - `get_all_agents() -> List[AgentCard]` - Retrieves all currently discovered and registered agent cards
-  - `get_agent_by_name(agent_name: str) -> Optional[AgentCard]` - Retrieves a specific agent card by name, returns None if not found
+- `AgentCardService(agent_registry: AgentRegistry)` - Service for accessing discovered A2A agent information
+  - `get_all_agent_cards() -> List[AgentCard]` - Retrieves all currently discovered and registered agent cards
+  - `get_agent_card_by_name(agent_name: str) -> Optional[AgentCard]` - Retrieves a specific agent card by name, returns None if not found
 
 **Usage Examples:**
 ```python
-from solace_agent_mesh.gateway.http_sse.services.agent_service import AgentService
+from solace_agent_mesh.gateway.http_sse.services.agent_card_service import AgentCardService
 from solace_agent_mesh.common.agent_registry import AgentRegistry
 
 # Initialize with shared agent registry
 agent_registry = AgentRegistry()  # Usually injected as shared instance
-agent_service = AgentService(agent_registry=agent_registry)
+agent_service = AgentCardService(agent_registry=agent_registry)
 
 # Get all available agents
-all_agents = agent_service.get_all_agents()
+all_agents = agent_service.get_all_agent_cards()
 print(f"Found {len(all_agents)} agents")
 
 # Get specific agent by name
-agent = agent_service.get_agent_by_name("data-processor")
+agent = agent_service.get_agent_card_by_name("data-processor")
 if agent:
     print(f"Found agent: {agent.name}")
 else:
     print("Agent not found")
 ```
 
+### data_retention_service.py
+**Purpose:** Service for automatically cleaning up old tasks, task events, and feedback based on configurable retention policies
+**Import:** `from solace_agent_mesh.gateway.http_sse.services.data_retention_service import DataRetentionService`
+
+**Classes:**
+- `DataRetentionService(session_factory: Callable[[], DBSession] | None, config: Dict[str, Any])` - Service for automatic data cleanup based on retention policies
+  - `cleanup_old_data() -> None` - Main orchestration method for cleaning up old data, calls cleanup methods for tasks and feedback
+
+**Constants/Variables:**
+- `MIN_RETENTION_DAYS: int` - Minimum retention period (7 days)
+- `MIN_CLEANUP_INTERVAL_HOURS: int` - Minimum cleanup interval (1 hour)
+- `MIN_BATCH_SIZE: int` - Minimum batch size for deletion (1)
+- `MAX_BATCH_SIZE: int` - Maximum batch size for deletion (10000)
+
+**Usage Examples:**
+```python
+from solace_agent_mesh.gateway.http_sse.services.data_retention_service import DataRetentionService
+from sqlalchemy.orm import sessionmaker
+
+# Initialize with database session factory and config
+session_factory = sessionmaker(bind=your_engine)
+config = {
+    "enabled": True,
+    "task_retention_days": 90,
+    "feedback_retention_days": 90,
+    "cleanup_interval_hours": 24,
+    "batch_size": 1000
+}
+
+retention_service = DataRetentionService(
+    session_factory=session_factory,
+    config=config
+)
+
+# Run cleanup (typically called by scheduler)
+retention_service.cleanup_old_data()
+```
+
+### feedback_service.py
+**Purpose:** Handles the business logic for processing and storing user feedback with database persistence and event publishing
+**Import:** `from solace_agent_mesh.gateway.http_sse.services.feedback_service import FeedbackService`
+
+**Classes:**
+- `FeedbackService(session_factory: Callable[[], DBSession] | None, component: WebUIBackendComponent, task_repo: ITaskRepository)` - Service for processing user feedback with database persistence and event publishing
+  - `process_feedback(payload: FeedbackPayload, user_id: str) -> None` - Asynchronously processes and stores feedback, publishes events if configured
+
+**Usage Examples:**
+```python
+import asyncio
+from solace_agent_mesh.gateway.http_sse.services.feedback_service import FeedbackService
+from sqlalchemy.orm import sessionmaker
+
+# Initialize with database session factory
+session_factory = sessionmaker(bind=your_engine)
+component = YourWebUIBackendComponent()  # Your component instance
+task_repo = YourTaskRepository()  # Your task repository
+
+feedback_service = FeedbackService(
+    session_factory=session_factory,
+    component=component,
+    task_repo=task_repo
+)
+
+# Process feedback (requires FeedbackPayload from router)
+async def process_user_feedback():
+    # payload would be a FeedbackPayload instance from the router
+    await feedback_service.process_feedback(payload, user_id="user123")
+
+asyncio.run(process_user_feedback())
+```
+
 ### people_service.py
 **Purpose:** Provides user search functionality via configured identity services
 **Import:** `from solace_agent_mesh.gateway.http_sse.services.people_service import PeopleService`
@@ -76,6 +151,95 @@ people_service_no_id = PeopleService(identity_service=None)
 asyncio.run(search_users())
 ```
 
+### session_service.py
+**Purpose:** Manages chat sessions and messages with database persistence support
+**Import:** `from solace_agent_mesh.gateway.http_sse.services.session_service import SessionService`
+
+**Classes:**
+- `SessionService(component: WebUIBackendComponent = None)` - Service for managing chat sessions and messages
+  - `is_persistence_enabled() -> bool` - Checks if the service is configured with a persistent backend
+  - `get_user_sessions(db: DbSession, user_id: UserId, pagination: PaginationParams | None = None) -> PaginatedResponse[Session]` - Retrieves paginated sessions for a user
+  - `get_session_details(db: DbSession, session_id: SessionId, user_id: UserId) -> Session | None` - Gets session details for a specific session
+  - `get_session_history(db: DbSession, session_id: SessionId, user_id: UserId, pagination: PaginationInfo | None = None) -> SessionHistory | None` - Gets session with messages
+  - `create_session(db: DbSession, user_id: UserId, name: str | None = None, agent_id: str | None = None, session_id: str | None = None) -> Optional[Session]` - Creates a new session
+  - `update_session_name(db: DbSession, session_id: SessionId, user_id: UserId, name: str) -> Session | None` - Updates session name
+  - `delete_session_with_notifications(db: DbSession, session_id: SessionId, user_id: UserId) -> bool` - Deletes session and notifies agents
+  - `add_message_to_session(db: DbSession, session_id: SessionId, user_id: UserId, message: str, sender_type: SenderType, sender_name: str, agent_id: str | None = None, message_type: MessageType = MessageType.TEXT) -> Message` - Adds a message to a session
+
+**Usage Examples:**
+```python
+from solace_agent_mesh.gateway.http_sse.services.session_service import SessionService
+from solace_agent_mesh.gateway.http_sse.shared.enums import SenderType, MessageType
+from sqlalchemy.orm import Session as DbSession
+
+# Initialize with component
+component = YourWebUIBackendComponent()  # Your component
+session_service = SessionService(component=component)
+
+# Use with database session
+with your_session_factory() as db:
+    # Create a new session
+    session = session_service.create_session(
+        db=db,
+        user_id="user123",
+        name="My Chat Session",
+        agent_id="assistant-agent"
+    )
+
+    # Add a message to the session
+    message = session_service.add_message_to_session(
+        db=db,
+        session_id=session.id,
+        user_id="user123",
+        message="Hello, how can you help me?",
+        sender_type=SenderType.USER,
+        sender_name="John Doe"
+    )
+
+    # Get user's sessions with pagination
+    paginated_sessions = session_service.get_user_sessions(db, "user123")
+    
+    db.commit()
+```
+
+### task_logger_service.py
+**Purpose:** Service for logging A2A tasks and events to the database with configurable filtering and sanitization
+**Import:** `from solace_agent_mesh.gateway.http_sse.services.task_logger_service import TaskLoggerService`
+
+**Classes:**
+- `TaskLoggerService(session_factory: Callable[[], DBSession] | None, config: Dict[str, Any])` - Service for logging A2A tasks and events to database
+  - `log_event(event_data: Dict[str, Any]) -> None` - Parses a raw A2A message and logs it as a task event, creates or updates master task record
+
+**Usage Examples:**
+```python
+from solace_agent_mesh.gateway.http_sse.services.task_logger_service import TaskLoggerService
+from sqlalchemy.orm import sessionmaker
+
+# Initialize with database session factory and config
+session_factory = sessionmaker(bind=your_engine)
+config = {
+    "enabled": True,
+    "log_status_updates": True,
+    "log_artifact_events": False,
+    "log_file_parts": True,
+    "max_file_part_size_bytes": 102400
+}
+
+task_logger = TaskLoggerService(
+    session_factory=session_factory,
+    config=config
+)
+
+# Log an A2A event
+event_data = {
+    "topic": "sam/agents/my-agent/request",
+    "payload": {"id": "task-123", "method": "sendMessage"},
+    "user_properties": {"userId": "user@example.com"}
+}
+
+task_logger.log_event(event_data)
+```
+
 ### task_service.py
 **Purpose:** Handles A2A task operations, specifically task cancellation using CoreA2AService and message publishing
 **Import:** `from solace_agent_mesh.gateway.http_sse.services.task_service import TaskService, PublishFunc`
@@ -130,4 +294,4 @@ async def cancel_task_example():
 asyncio.run(cancel_task_example())
 ```
 
-# content_hash: 83ddf6b403dc50598ed550e4b3a5445f832b3956dad75f7a3fbbb7e6e5c6c115
+# content_hash: 12385f5117d2f5c30f0e44a0913ea91d62722aa82eb55268ae6bd317311ec5eb

solace_agent_mesh/gateway/http_sse/services/session_service.py

@@ -1,18 +1,17 @@
 import uuid
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Optional, List, Dict, Any
 
 from solace_ai_connector.common.log import log
 from sqlalchemy.orm import Session as DbSession
 
 from ..repository import (
-    IMessageRepository,
     ISessionRepository,
-    Message,
     Session,
-    SessionHistory,
 )
-from ..shared.enums import MessageType, SenderType
-from ..shared.types import PaginationInfo, SessionId, UserId
+from ..repository.chat_task_repository import ChatTaskRepository
+from ..repository.entities import ChatTask
+from ..shared.enums import SenderType
+from ..shared.types import SessionId, UserId
 from ..shared import now_epoch_ms
 from ..shared.pagination import PaginationParams, PaginatedResponse, get_pagination_or_default
 
@@ -28,11 +27,10 @@ class SessionService:
         self.component = component
 
     def _get_repositories(self, db: DbSession):
-        """Create repositories for the given database session."""
-        from ..repository import SessionRepository, MessageRepository
+        """Create session repository for the given database session."""
+        from ..repository import SessionRepository
         session_repository = SessionRepository(db)
-        message_repository = MessageRepository(db)
-        return session_repository, message_repository
+        return session_repository
 
     def is_persistence_enabled(self) -> bool:
         """Checks if the service is configured with a persistent backend."""
@@ -54,18 +52,10 @@ class SessionService:
             raise ValueError("User ID cannot be empty")
 
         pagination = get_pagination_or_default(pagination)
-        session_repository, _ = self._get_repositories(db)
-
-        pagination_info = PaginationInfo(
-            page=pagination.page_number,
-            page_size=pagination.page_size,
-            total_items=0,
-            total_pages=0,
-            has_next=False,
-            has_previous=False,
-        )
+        session_repository = self._get_repositories(db)
 
-        sessions = session_repository.find_by_user(user_id, pagination_info)
+        # Pass pagination params directly - repository will handle offset calculation
+        sessions = session_repository.find_by_user(user_id, pagination)
         total_count = session_repository.count_by_user(user_id)
 
         return PaginatedResponse.create(sessions, total_count, pagination)
@@ -76,33 +66,9 @@ class SessionService:
         if not self._is_valid_session_id(session_id):
             return None
 
-        session_repository, _ = self._get_repositories(db)
+        session_repository = self._get_repositories(db)
         return session_repository.find_user_session(session_id, user_id)
 
-    def get_session_history(
-        self,
-        db: DbSession,
-        session_id: SessionId,
-        user_id: UserId,
-        pagination: PaginationInfo | None = None,
-    ) -> SessionHistory | None:
-        if not self._is_valid_session_id(session_id):
-            return None
-
-        session_repository, _ = self._get_repositories(db)
-        result = session_repository.find_user_session_with_messages(
-            session_id, user_id, pagination
-        )
-        if not result:
-            return None
-
-        session, messages = result
-        return SessionHistory(
-            session=session,
-            messages=messages,
-            total_message_count=len(messages),
-        )
-
     def create_session(
         self,
         db: DbSession,
@@ -131,7 +97,7 @@ class SessionService:
             updated_time=now_ms,
         )
 
-        session_repository, _ = self._get_repositories(db)
+        session_repository = self._get_repositories(db)
         created_session = session_repository.save(session)
         log.info("Created new session %s for user %s", created_session.id, user_id)
 
@@ -152,7 +118,7 @@ class SessionService:
         if len(name.strip()) > 255:
             raise ValueError("Session name cannot exceed 255 characters")
 
-        session_repository, _ = self._get_repositories(db)
+        session_repository = self._get_repositories(db)
         session = session_repository.find_user_session(session_id, user_id)
         if not session:
             return None
@@ -169,7 +135,7 @@ class SessionService:
         if not self._is_valid_session_id(session_id):
             raise ValueError("Invalid session ID")
 
-        session_repository, _ = self._get_repositories(db)
+        session_repository = self._get_repositories(db)
         session = session_repository.find_user_session(session_id, user_id)
         if not session:
             log.warning(
@@ -198,50 +164,151 @@ class SessionService:
 
         return True
 
-    def add_message_to_session(
+    def save_task(
         self,
         db: DbSession,
-        session_id: SessionId,
-        user_id: UserId,
-        message: str,
-        sender_type: SenderType,
-        sender_name: str,
-        agent_id: str | None = None,
-        message_type: MessageType = MessageType.TEXT,
-    ) -> Message:
-        if not self._is_valid_session_id(session_id):
-            raise ValueError("Invalid session ID")
-
-        if not message or message.strip() == "":
-            raise ValueError("Message cannot be empty")
-
-        session_repository, message_repository = self._get_repositories(db)
+        task_id: str,
+        session_id: str,
+        user_id: str,
+        user_message: Optional[str],
+        message_bubbles: str,  # JSON string (opaque)
+        task_metadata: Optional[str] = None  # JSON string (opaque)
+    ) -> ChatTask:
+        """
+        Save a complete task interaction.
+        
+        Args:
+            db: Database session
+            task_id: A2A task ID
+            session_id: Session ID
+            user_id: User ID
+            user_message: Original user input text
+            message_bubbles: Array of all message bubbles displayed during this task
+            task_metadata: Task-level metadata (status, feedback, agent name, etc.)
+            
+        Returns:
+            Saved ChatTask entity
+            
+        Raises:
+            ValueError: If session not found or validation fails
+        """
+        # Validate session exists and belongs to user
+        session_repository = self._get_repositories(db)
         session = session_repository.find_user_session(session_id, user_id)
         if not session:
-            session = self.create_session(
-                db=db,
-                user_id=user_id,
-                agent_id=agent_id,
-                session_id=session_id,
-            )
-
-        message_entity = Message(
-            id=str(uuid.uuid4()),
+            raise ValueError(f"Session {session_id} not found for user {user_id}")
+        
+        # Create task entity - pass strings directly
+        task = ChatTask(
+            id=task_id,
             session_id=session_id,
-            message=message.strip(),
-            sender_type=sender_type,
-            sender_name=sender_name,
-            message_type=message_type,
+            user_id=user_id,
+            user_message=user_message,
+            message_bubbles=message_bubbles,  # Already a string
+            task_metadata=task_metadata,      # Already a string
             created_time=now_epoch_ms(),
+            updated_time=None
         )
-
-        saved_message = message_repository.save(message_entity)
-
+        
+        # Save via repository
+        task_repo = ChatTaskRepository(db)
+        saved_task = task_repo.save(task)
+        
+        # Update session activity
         session.mark_activity()
         session_repository.save(session)
+        
+        log.info(f"Saved task {task_id} for session {session_id}")
+        return saved_task
 
-        log.info("Added message to session %s from %s", session_id, sender_name)
-        return saved_message
+    def get_session_tasks(
+        self,
+        db: DbSession,
+        session_id: str,
+        user_id: str
+    ) -> List[ChatTask]:
+        """
+        Get all tasks for a session.
+        
+        Args:
+            db: Database session
+            session_id: Session ID
+            user_id: User ID
+            
+        Returns:
+            List of ChatTask entities in chronological order
+            
+        Raises:
+            ValueError: If session not found
+        """
+        # Validate session exists and belongs to user
+        session_repository = self._get_repositories(db)
+        session = session_repository.find_user_session(session_id, user_id)
+        if not session:
+            raise ValueError(f"Session {session_id} not found for user {user_id}")
+        
+        # Load tasks
+        task_repo = ChatTaskRepository(db)
+        return task_repo.find_by_session(session_id, user_id)
+
+    def get_session_messages_from_tasks(
+        self,
+        db: DbSession,
+        session_id: str,
+        user_id: str
+    ) -> List[Dict[str, Any]]:
+        """
+        Get session messages by flattening task message_bubbles.
+        This provides backward compatibility with the old message-based API.
+        
+        Args:
+            db: Database session
+            session_id: Session ID
+            user_id: User ID
+            
+        Returns:
+            List of message dictionaries flattened from tasks
+            
+        Raises:
+            ValueError: If session not found
+        """
+        # Load tasks
+        tasks = self.get_session_tasks(db, session_id, user_id)
+        
+        # Flatten message_bubbles from all tasks
+        messages = []
+        for task in tasks:
+            import json
+            message_bubbles = json.loads(task.message_bubbles) if isinstance(task.message_bubbles, str) else task.message_bubbles
+            
+            for bubble in message_bubbles:
+                # Determine sender type from bubble type
+                bubble_type = bubble.get("type", "agent")
+                sender_type = "user" if bubble_type == "user" else "agent"
+                
+                # Get sender name
+                if bubble_type == "user":
+                    sender_name = user_id
+                else:
+                    # Try to get agent name from task metadata, fallback to "agent"
+                    sender_name = "agent"
+                    if task.task_metadata:
+                        task_metadata = json.loads(task.task_metadata) if isinstance(task.task_metadata, str) else task.task_metadata
+                        sender_name = task_metadata.get("agent_name", "agent")
+                
+                # Create message dictionary
+                message = {
+                    "id": bubble.get("id", str(uuid.uuid4())),
+                    "session_id": session_id,
+                    "message": bubble.get("text", ""),
+                    "sender_type": sender_type,
+                    "sender_name": sender_name,
+                    "message_type": "text",
+                    "created_time": task.created_time
+                }
+                messages.append(message)
+        
+        return messages
 
     def _is_valid_session_id(self, session_id: SessionId) -> bool:
         return (
@@ -289,4 +356,4 @@ class SessionService:
                 "Failed to publish session deletion event to agent %s: %s",
                 agent_id,
                 e,
-            )
+            )