solace-agent-mesh 1.11.2__py3-none-any.whl

solace_agent_mesh/gateway/http_sse/components/__init__.py

@@ -0,0 +1,7 @@
+"""
+Makes components within this directory importable.
+"""
+
+from .visualization_forwarder_component import VisualizationForwarderComponent
+
+__all__ = ["VisualizationForwarderComponent"]

solace_agent_mesh/gateway/http_sse/components/components_llm.txt

@@ -0,0 +1,105 @@
+# DEVELOPER GUIDE: components
+
+## Quick Summary
+This directory contains SAC (Solace AI Connector) components for the HTTP SSE (Server-Sent Events) gateway. These components forward messages from Solace broker inputs to internal Python queues, enabling real-time visualization and task logging in web-based user interfaces.
+
+## Files Overview
+- `__init__.py` - Makes the `VisualizationForwarderComponent` class directly importable from the components package
+- `components_llm.txt` - Developer guide documentation for this directory
+- `task_logger_forwarder.py` - SAC component that forwards messages to a task logging queue
+- `visualization_forwarder_component.py` - SAC component that forwards messages to a visualization queue
+
+## Developer API Reference
+
+### __init__.py
+**Purpose:** Exposes the public components of this directory for easy importing
+**Import:** `from solace_agent_mesh.gateway.http_sse.components import VisualizationForwarderComponent`
+
+**Exports:**
+- `VisualizationForwarderComponent` - The main component class for forwarding messages to a visualization queue
+
+### task_logger_forwarder.py
+**Purpose:** A SAC component that forwards messages from a BrokerInput to a target queue for task logging
+**Import:** `from solace_agent_mesh.gateway.http_sse.components.task_logger_forwarder import TaskLoggerForwarderComponent`
+
+**Classes:**
+- `TaskLoggerForwarderComponent(**kwargs: Any)` - A component that forwards messages to a task logging queue, initialized with configuration parameters including `target_queue_ref`
+  - `invoke(message: SolaceMessage, data: Dict[str, Any]) -> None` - Core method called by SAC framework for each incoming message; formats data and places it onto the target queue
+  - `target_queue: queue.Queue` - The queue instance where messages are forwarded
+
+**Constants/Variables:**
+- `info: Dict` - Metadata dictionary required by SAC framework describing component configuration, input schema, and purpose
+
+**Usage Examples:**
+```python
+import queue
+from solace_agent_mesh.gateway.http_sse.components.task_logger_forwarder import TaskLoggerForwarderComponent
+from solace_ai_connector.common.message import Message as SolaceMessage
+
+# 1. Create a target queue for task logging
+task_logging_queue = queue.Queue()
+
+# 2. Instantiate the component with target queue reference
+task_forwarder = TaskLoggerForwarderComponent(
+    name="task_logger",
+    target_queue_ref=task_logging_queue
+)
+
+# 3. The invoke method is called automatically by SAC framework
+# when messages arrive from connected BrokerInput component
+
+# 4. Consume forwarded messages from the queue
+if not task_logging_queue.empty():
+    forwarded_data = task_logging_queue.get()
+    print(f"Task Topic: {forwarded_data['topic']}")
+    print(f"Task Payload: {forwarded_data['payload']}")
+    print(f"User Properties: {forwarded_data['user_properties']}")
+```
+
+### visualization_forwarder_component.py
+**Purpose:** A SAC component that forwards messages from a BrokerInput to a target queue for visualization
+**Import:** `from solace_agent_mesh.gateway.http_sse.components.visualization_forwarder_component import VisualizationForwarderComponent`
+
+**Classes:**
+- `VisualizationForwarderComponent(**kwargs: Any)` - A component that forwards messages to a visualization queue, initialized with configuration parameters including `target_queue_ref`
+  - `invoke(message: SolaceMessage, data: Dict[str, Any]) -> None` - Core method called by SAC framework for each incoming message; formats data and places it onto the target queue
+  - `target_queue: queue.Queue` - The queue instance where messages are forwarded
+
+**Constants/Variables:**
+- `info: Dict` - Metadata dictionary required by SAC framework describing component configuration, input schema, and purpose
+
+**Usage Examples:**
+```python
+import queue
+from solace_agent_mesh.gateway.http_sse.components import VisualizationForwarderComponent
+from solace_ai_connector.common.message import Message as SolaceMessage
+
+# 1. Create a target queue that will receive the forwarded messages
+visualization_queue = queue.Queue()
+
+# 2. Instantiate the component with target queue reference
+forwarder = VisualizationForwarderComponent(
+    name="my_forwarder",
+    target_queue_ref=visualization_queue
+)
+
+# 3. The invoke method is called automatically by SAC framework
+# when messages arrive from connected BrokerInput component
+
+# 4. Consume forwarded messages from the queue
+if not visualization_queue.empty():
+    forwarded_data = visualization_queue.get()
+    print(f"Topic: {forwarded_data['topic']}")
+    print(f"Payload: {forwarded_data['payload']}")
+    print(f"User Properties: {forwarded_data['user_properties']}")
+    
+# Expected structure of forwarded_data:
+# {
+#     "topic": "some/broker/topic",
+#     "payload": {"key": "value"},
+#     "user_properties": {"prop1": "value1"},
+#     "_original_broker_message": <SolaceMessage object>
+# }
+```
+
+# content_hash: bb6b96e24d423d56a25e3c84eb411d061ad160ea98fc2ff83da46e3f317d34fb

solace_agent_mesh/gateway/http_sse/components/task_logger_forwarder.py

@@ -0,0 +1,109 @@
+"""
+SAC Component to forward messages from an internal BrokerInput
+to the WebUIBackendComponent's internal queue for task logging.
+"""
+import logging
+import queue
+from typing import Any, Dict
+
+from solace_ai_connector.components.component_base import ComponentBase
+from solace_ai_connector.common.message import Message as SolaceMessage
+
+log = logging.getLogger(__name__)
+
+info = {
+    "class_name": "TaskLoggerForwarderComponent",
+    "description": (
+        "Forwards A2A messages from an internal BrokerInput to the main "
+        "WebUIBackendComponent's internal queue for task logging."
+    ),
+    "config_parameters": [
+        {
+            "name": "target_queue_ref",
+            "required": True,
+            "type": "queue.Queue",
+            "description": "A direct reference to the target queue.Queue instance in WebUIBackendComponent.",
+        }
+    ],
+    "input_schema": {
+        "type": "object",
+        "description": "Output from a BrokerInput component.",
+        "properties": {
+            "payload": {"type": "any", "description": "The message payload."},
+            "topic": {"type": "string", "description": "The message topic."},
+            "user_properties": {
+                "type": "object",
+                "description": "User properties of the message.",
+            },
+        },
+        "required": ["payload", "topic"],
+    },
+    "output_schema": None,
+}
+
+
+class TaskLoggerForwarderComponent(ComponentBase):
+    """
+    A simple SAC component that takes messages from its input (typically
+    from a BrokerInput) and puts them onto a target Python queue.Queue
+    instance provided in its configuration.
+    """
+
+    def __init__(self, **kwargs: Any):
+        super().__init__(info, **kwargs)
+        self.target_queue: queue.Queue = self.get_config("target_queue_ref")
+        if not isinstance(self.target_queue, queue.Queue):
+            log.error(
+                "%s Configuration 'target_queue_ref' is not a valid queue.Queue instance. Type: %s",
+                self.log_identifier,
+                type(self.target_queue),
+            )
+            raise ValueError(
+                f"{self.log_identifier} 'target_queue_ref' must be a queue.Queue instance."
+            )
+        log.info("%s TaskLoggerForwarderComponent initialized.", self.log_identifier)
+
+    def invoke(self, message: SolaceMessage, data: Dict[str, Any]) -> None:
+        """
+        Processes the incoming message and forwards it.
+
+        Args:
+            message: The SolaceMessage object from BrokerInput (this is the original message).
+            data: The data extracted by BrokerInput's output_schema (payload, topic, user_properties).
+        """
+        log_id_prefix = f"{self.log_identifier}[Invoke]"
+        try:
+
+            forward_data = {
+                "topic": data.get("topic"),
+                "payload": data.get("payload"),
+                "user_properties": data.get("user_properties") or {},
+                "_original_broker_message": message,
+            }
+            log.debug(
+                "%s Forwarding message for topic: %s",
+                log_id_prefix,
+                forward_data["topic"],
+            )
+            try:
+                self.target_queue.put_nowait(forward_data)
+            except queue.Full:
+                log.warning(
+                    "%s Task logging queue is full. Message dropped. Current size: %d",
+                    log_id_prefix,
+                    self.target_queue.qsize(),
+                )
+
+            message.call_acknowledgements()
+            log.debug("%s Message acknowledged to BrokerInput.", log_id_prefix)
+
+        except Exception as e:
+            log.exception(
+                "%s Error in TaskLoggerForwarderComponent invoke: %s",
+                log_id_prefix,
+                e,
+            )
+            if message:
+                message.call_negative_acknowledgements()
+            raise
+        return None

solace_agent_mesh/gateway/http_sse/components/visualization_forwarder_component.py

@@ -0,0 +1,110 @@
+"""
+SAC Component to forward messages from an internal BrokerInput
+to the WebUIBackendComponent's internal queue for visualization.
+"""
+
+import logging
+import queue
+from typing import Any, Dict
+
+from solace_ai_connector.components.component_base import ComponentBase
+from solace_ai_connector.common.message import Message as SolaceMessage
+
+log = logging.getLogger(__name__)
+
+info = {
+    "class_name": "VisualizationForwarderComponent",
+    "description": (
+        "Forwards A2A messages from an internal BrokerInput to the main "
+        "WebUIBackendComponent's internal queue for visualization."
+    ),
+    "config_parameters": [
+        {
+            "name": "target_queue_ref",
+            "required": True,
+            "type": "queue.Queue",
+            "description": "A direct reference to the target queue.Queue instance in WebUIBackendComponent.",
+        }
+    ],
+    "input_schema": {
+        "type": "object",
+        "description": "Output from a BrokerInput component.",
+        "properties": {
+            "payload": {"type": "any", "description": "The message payload."},
+            "topic": {"type": "string", "description": "The message topic."},
+            "user_properties": {
+                "type": "object",
+                "description": "User properties of the message.",
+            },
+        },
+        "required": ["payload", "topic"],
+    },
+    "output_schema": None,
+}
+
+
+class VisualizationForwarderComponent(ComponentBase):
+    """
+    A simple SAC component that takes messages from its input (typically
+    from a BrokerInput) and puts them onto a target Python queue.Queue
+    instance provided in its configuration.
+    """
+
+    def __init__(self, **kwargs: Any):
+        super().__init__(info, **kwargs)
+        self.target_queue: queue.Queue = self.get_config("target_queue_ref")
+        if not isinstance(self.target_queue, queue.Queue):
+            log.error(
+                "%s Configuration 'target_queue_ref' is not a valid queue.Queue instance. Type: %s",
+                self.log_identifier,
+                type(self.target_queue),
+            )
+            raise ValueError(
+                f"{self.log_identifier} 'target_queue_ref' must be a queue.Queue instance."
+            )
+        log.info("%s VisualizationForwarderComponent initialized.", self.log_identifier)
+
+    def invoke(self, message: SolaceMessage, data: Dict[str, Any]) -> None:
+        """
+        Processes the incoming message and forwards it.
+
+        Args:
+            message: The SolaceMessage object from BrokerInput (this is the original message).
+            data: The data extracted by BrokerInput's output_schema (payload, topic, user_properties).
+        """
+        log_id_prefix = f"{self.log_identifier}[Invoke]"
+        try:
+
+            forward_data = {
+                "topic": data.get("topic"),
+                "payload": data.get("payload"),
+                "user_properties": data.get("user_properties") or {},
+                "_original_broker_message": message,
+            }
+            log.debug(
+                "%s Forwarding message for topic: %s",
+                log_id_prefix,
+                forward_data["topic"],
+            )
+            try:
+                self.target_queue.put_nowait(forward_data)
+            except queue.Full:
+                log.warning(
+                    "%s Visualization queue is full. Message dropped. Current size: %d",
+                    log_id_prefix,
+                    self.target_queue.qsize(),
+                )
+
+            message.call_acknowledgements()
+            log.debug("%s Message acknowledged to BrokerInput.", log_id_prefix)
+
+        except Exception as e:
+            log.exception(
+                "%s Error in VisualizationForwarderComponent invoke: %s",
+                log_id_prefix,
+                e,
+            )
+            if message:
+                message.call_negative_acknowledgements()
+            raise
+        return None