solace-agent-mesh 1.3.3__py3-none-any.whl → 1.4.1__py3-none-any.whl

solace_agent_mesh/gateway/http_sse/app.py

@@ -3,15 +3,16 @@ Custom Solace AI Connector App class for the Web UI Backend.
 Defines configuration schema and programmatically creates the WebUIBackendComponent.
 """
 
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 import os
 from alembic import command
 from alembic.config import Config
+from pydantic import Field, ValidationError
 from solace_ai_connector.common.log import log
 
 from ...gateway.http_sse.component import WebUIBackendComponent
 
-from ...gateway.base.app import BaseGatewayApp
+from ...gateway.base.app import BaseGatewayApp, BaseGatewayAppConfig
 from ...gateway.base.component import BaseGatewayComponent
 
 
@@ -21,6 +22,88 @@ info = {
 }
 
 
+class WebUIBackendAppConfig(BaseGatewayAppConfig):
+    """Pydantic model for the Web UI Backend application configuration."""
+
+    session_secret_key: str = Field(
+        ..., description="Secret key for signing web user sessions."
+    )
+    fastapi_host: str = Field(
+        default="127.0.0.1", description="Host address for the embedded FastAPI server."
+    )
+    fastapi_port: int = Field(
+        default=8000, description="Port for the embedded FastAPI server."
+    )
+    fastapi_https_port: int = Field(
+        default=8443, description="Port for the embedded FastAPI server when SSL is enabled."
+    )
+    cors_allowed_origins: List[str] = Field(
+        default=["*"], description="List of allowed origins for CORS requests."
+    )
+    sse_max_queue_size: int = Field(
+        default=200,
+        description="Maximum size of the SSE connection queues. Adjust based on expected load.",
+    )
+    sse_buffer_max_age_seconds: int = Field(
+        default=600,  # 10 minutes
+        description="Maximum age in seconds for a pending event buffer before it is cleaned up.",
+    )
+    sse_buffer_cleanup_interval_seconds: int = Field(
+        default=300,  # 5 minutes
+        description="How often to run the cleanup task for stale pending event buffers.",
+    )
+    resolve_artifact_uris_in_gateway: bool = Field(
+        default=True,
+        description="If true, the gateway will resolve artifact:// URIs found in A2A messages and embed the content as bytes before sending to the UI. If false, URIs are passed through.",
+    )
+    system_purpose: str = Field(
+        default="",
+        description="Detailed description of the system's overall purpose, to be optionally used by agents.",
+    )
+    response_format: str = Field(
+        default="",
+        description="General guidelines on how agent responses should be structured, to be optionally used by agents.",
+    )
+    frontend_welcome_message: str = Field(
+        default="Hi! How can I help?",
+        description="Initial welcome message displayed in the chat.",
+    )
+    frontend_bot_name: str = Field(
+        default="A2A Agent", description="Name displayed for the bot/agent in the UI."
+    )
+    frontend_collect_feedback: bool = Field(
+        default=False, description="Enable/disable the feedback buttons in the UI."
+    )
+    frontend_auth_login_url: str = Field(
+        default="", description="URL for the external login page (if auth is enabled)."
+    )
+    frontend_use_authorization: bool = Field(
+        default=False, description="Tell frontend whether backend expects authorization."
+    )
+    frontend_redirect_url: str = Field(
+        default="", description="Redirect URL for OAuth flows (if auth is enabled)."
+    )
+    external_auth_callback_uri: str = Field(
+        default="", description="Redirect URI for the OIDC application."
+    )
+    external_auth_service_url: str = Field(
+        default="http://localhost:8080",
+        description="External authorization service URL for login initiation.",
+    )
+    external_auth_provider: str = Field(
+        default="", description="The external authentication provider."
+    )
+    ssl_keyfile: str = Field(
+        default="", description="The file path to the SSL private key."
+    )
+    ssl_certfile: str = Field(
+        default="", description="The file path to the SSL certificate."
+    )
+    ssl_keyfile_password: str = Field(
+        default="", description="The passphrase for the SSL private key."
+    )
+
+
 class WebUIBackendApp(BaseGatewayApp):
     """
     Custom App class for the A2A Web UI Backend.
@@ -28,154 +111,8 @@ class WebUIBackendApp(BaseGatewayApp):
     - Defines WebUI-specific configuration parameters.
     """
 
-    SPECIFIC_APP_SCHEMA_PARAMS: List[Dict[str, Any]] = [
-        {
-            "name": "session_secret_key",
-            "required": True,
-            "type": "string",
-            "description": "Secret key for signing web user sessions.",
-        },
-        {
-            "name": "fastapi_host",
-            "required": False,
-            "type": "string",
-            "default": "127.0.0.1",
-            "description": "Host address for the embedded FastAPI server.",
-        },
-        {
-            "name": "fastapi_port",
-            "required": False,
-            "type": "integer",
-            "default": 8000,
-            "description": "Port for the embedded FastAPI server.",
-        },
-        {
-            "name": "fastapi_https_port",
-            "required": False,
-            "type": "integer",
-            "default": 8443,
-            "description": "Port for the embedded FastAPI server when SSL is enabled.",
-        },
-        {
-            "name": "cors_allowed_origins",
-            "required": False,
-            "type": "list",
-            "default": ["*"],
-            "description": "List of allowed origins for CORS requests.",
-        },
-        {
-            "name": "sse_max_queue_size",
-            "required": False,
-            "type": "integer",
-            "default": 200,
-            "description": "Maximum size of the SSE connection queues. Adjust based on expected load.",
-        },
-        {
-            "name": "resolve_artifact_uris_in_gateway",
-            "required": False,
-            "type": "boolean",
-            "default": True,
-            "description": "If true, the gateway will resolve artifact:// URIs found in A2A messages and embed the content as bytes before sending to the UI. If false, URIs are passed through.",
-        },
-        {
-            "name": "system_purpose",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "Detailed description of the system's overall purpose, to be optionally used by agents.",
-        },
-        {
-            "name": "response_format",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "General guidelines on how agent responses should be structured, to be optionally used by agents.",
-        },
-        {
-            "name": "frontend_welcome_message",
-            "required": False,
-            "type": "string",
-            "default": "Hi! How can I help?",
-            "description": "Initial welcome message displayed in the chat.",
-        },
-        {
-            "name": "frontend_bot_name",
-            "required": False,
-            "type": "string",
-            "default": "A2A Agent",
-            "description": "Name displayed for the bot/agent in the UI.",
-        },
-        {
-            "name": "frontend_collect_feedback",
-            "required": False,
-            "type": "boolean",
-            "default": False,
-            "description": "Enable/disable the feedback buttons in the UI.",
-        },
-        {
-            "name": "frontend_auth_login_url",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "URL for the external login page (if auth is enabled).",
-        },
-        {
-            "name": "frontend_use_authorization",
-            "required": False,
-            "type": "boolean",
-            "default": False,
-            "description": "Tell frontend whether backend expects authorization.",
-        },
-        {
-            "name": "frontend_redirect_url",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "Redirect URL for OAuth flows (if auth is enabled).",
-        },
-        {
-            "name": "external_auth_callback_uri",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "Redirect URI for the OIDC application.",
-        },
-        {
-            "name": "external_auth_service_url",
-            "required": False,
-            "type": "string",
-            "default": "http://localhost:8080",
-            "description": "External authorization service URL for login initiation.",
-        },
-        {
-            "name": "external_auth_provider",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "The external authentication provider.",
-        },
-        {
-            "name": "ssl_keyfile",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "The file path to the SSL private key.",
-        },
-        {
-            "name": "ssl_certfile",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "The file path to the SSL certificate.",
-        },
-        {
-            "name": "ssl_keyfile_password",
-            "required": False,
-            "type": "string",
-            "default": "",
-            "description": "The passphrase for the SSL private key.",
-        },
-    ]
+    # This is now a placeholder. Validation is handled by the Pydantic model.
+    SPECIFIC_APP_SCHEMA_PARAMS: List[Dict[str, Any]] = []
 
     def __init__(self, app_info: Dict[str, Any], **kwargs):
         """
@@ -186,6 +123,18 @@ class WebUIBackendApp(BaseGatewayApp):
             "%s Initializing WebUIBackendApp...",
             app_info.get("name", "WebUIBackendApp"),
         )
+
+        app_config_dict = app_info.get("app_config", {})
+        try:
+            # Validate the raw dict, cleaning None values to allow defaults to apply
+            app_config = WebUIBackendAppConfig.model_validate_and_clean(
+                app_config_dict
+            )
+            app_info["app_config"] = app_config
+        except ValidationError as e:
+            log.error("Web UI Gateway configuration validation failed:\n%s", e)
+            raise ValueError(f"Invalid Web UI Gateway configuration: {e}") from e
+
         super().__init__(app_info, **kwargs)
 
         try:

solace_agent_mesh/gateway/http_sse/component.py

@@ -17,12 +17,14 @@ from fastapi import Request as FastAPIRequest
 from solace_ai_connector.common.log import log
 from solace_ai_connector.components.inputs_outputs.broker_input import BrokerInput
 from solace_ai_connector.flow.app import App as SACApp
+from solace_ai_connector.common.event import Event, EventType
 
 from ...common.agent_registry import AgentRegistry
 from ...core_a2a.service import CoreA2AService
 from ...gateway.base.component import BaseGatewayComponent
 from ...gateway.http_sse.session_manager import SessionManager
 from ...gateway.http_sse.sse_manager import SSEManager
+from .sse_event_buffer import SSEEventBuffer
 from .components import VisualizationForwarderComponent
 
 try:
@@ -118,8 +120,23 @@ class WebUIBackendComponent(BaseGatewayComponent):
             raise ValueError(f"Configuration retrieval error: {e}") from e
 
         sse_max_queue_size = self.get_config("sse_max_queue_size", 200)
+        sse_buffer_max_age_seconds = self.get_config("sse_buffer_max_age_seconds", 600)
 
-        self.sse_manager = SSEManager(max_queue_size=sse_max_queue_size)
+        self.sse_event_buffer = SSEEventBuffer(
+            max_queue_size=sse_max_queue_size,
+            max_age_seconds=sse_buffer_max_age_seconds,
+        )
+        self.sse_manager = SSEManager(
+            max_queue_size=sse_max_queue_size, event_buffer=self.sse_event_buffer
+        )
+
+        self._sse_cleanup_timer_id = f"sse_cleanup_{self.gateway_id}"
+        cleanup_interval_sec = self.get_config("sse_buffer_cleanup_interval_seconds", 300)
+        self.add_timer(
+            delay_ms=cleanup_interval_sec * 1000,
+            timer_id=self._sse_cleanup_timer_id,
+            interval_ms=cleanup_interval_sec * 1000,
+        )
 
         session_config = self._resolve_session_config()
         if session_config.get("type") == "sql":
@@ -167,6 +184,15 @@ class WebUIBackendComponent(BaseGatewayComponent):
 
         log.info("%s Web UI Backend Component initialized.", self.log_identifier)
 
+    def process_event(self, event: Event):
+        if event.event_type == EventType.TIMER:
+            if event.data.get("timer_id") == self._sse_cleanup_timer_id:
+                log.debug("%s SSE buffer cleanup timer triggered.", self.log_identifier)
+                self.sse_event_buffer.cleanup_stale_buffers()
+                return
+
+        super().process_event(event)
+
     def _get_visualization_lock(self) -> asyncio.Lock:
         """Get or create a visualization lock for the current event loop."""
         try:
@@ -1025,6 +1051,7 @@ class WebUIBackendComponent(BaseGatewayComponent):
     def cleanup(self):
         """Gracefully shuts down the component and the FastAPI server."""
         log.info("%s Cleaning up Web UI Backend Component...", self.log_identifier)
+        self.cancel_timer(self._sse_cleanup_timer_id)
         log.info("%s Cleaning up visualization resources...", self.log_identifier)
         if self._visualization_message_queue:
             self._visualization_message_queue.put(None)
@@ -1056,6 +1083,35 @@ class WebUIBackendComponent(BaseGatewayComponent):
         self._cleanup_visualization_locks()
         log.info("%s Visualization resources cleaned up.", self.log_identifier)
 
+        super().cleanup()
+
+        if self.fastapi_thread and self.fastapi_thread.is_alive():
+            log.info(
+                "%s Waiting for FastAPI server thread to exit...", self.log_identifier
+            )
+            self.fastapi_thread.join(timeout=10)
+            if self.fastapi_thread.is_alive():
+                log.warning(
+                    "%s FastAPI server thread did not exit gracefully.",
+                    self.log_identifier,
+                )
+
+        if self.sse_manager:
+            log.info(
+                "%s Closing active SSE connections (best effort)...",
+                self.log_identifier,
+            )
+            try:
+                asyncio.run(self.sse_manager.close_all())
+            except Exception as sse_close_err:
+                log.error(
+                    "%s Error closing SSE connections during cleanup: %s",
+                    self.log_identifier,
+                    sse_close_err,
+                )
+
+        log.info("%s Web UI Backend Component cleanup finished.", self.log_identifier)
+
     def _infer_visualization_event_details(
         self, topic: str, payload: dict[str, Any]
     ) -> dict[str, Any]:
@@ -1302,35 +1358,6 @@ class WebUIBackendComponent(BaseGatewayComponent):
             )
         return agents
 
-        super().cleanup()
-
-        if self.fastapi_thread and self.fastapi_thread.is_alive():
-            log.info(
-                "%s Waiting for FastAPI server thread to exit...", self.log_identifier
-            )
-            self.fastapi_thread.join(timeout=10)
-            if self.fastapi_thread.is_alive():
-                log.warning(
-                    "%s FastAPI server thread did not exit gracefully.",
-                    self.log_identifier,
-                )
-
-        if self.sse_manager:
-            log.info(
-                "%s Closing active SSE connections (best effort)...",
-                self.log_identifier,
-            )
-            try:
-                asyncio.run(self.sse_manager.close_all())
-            except Exception as sse_close_err:
-                log.error(
-                    "%s Error closing SSE connections during cleanup: %s",
-                    self.log_identifier,
-                    sse_close_err,
-                )
-
-        log.info("%s Web UI Backend Component cleanup finished.", self.log_identifier)
-
     def get_agent_registry(self) -> AgentRegistry:
         return self.agent_registry