solace-agent-mesh 0.2.4__py3-none-any.whl → 1.0.1__py3-none-any.whl

solace_agent_mesh/gateway/base/__init__.py

@@ -0,0 +1 @@
+"""Base classes and utilities for the Gateway Development Kit (GDK)."""

solace_agent_mesh/gateway/base/app.py

@@ -0,0 +1,266 @@
+"""
+Base App class for Gateway implementations in the Solace AI Connector.
+"""
+
+import uuid
+from abc import abstractmethod
+from typing import Any, Dict, List, Type
+
+from solace_ai_connector.common.log import log
+from solace_ai_connector.common.utils import deep_merge
+from solace_ai_connector.flow.app import App
+from solace_ai_connector.components.component_base import ComponentBase
+
+from ...common.a2a_protocol import (
+    get_discovery_topic,
+    get_gateway_response_subscription_topic,
+    get_gateway_status_subscription_topic,
+)
+
+
+class BaseGatewayComponent(ComponentBase):
+    pass
+
+
+BASE_GATEWAY_APP_SCHEMA: Dict[str, List[Dict[str, Any]]] = {
+    "config_parameters": [
+        {
+            "name": "namespace",
+            "required": True,
+            "type": "string",
+            "description": "Absolute topic prefix for A2A communication (e.g., 'myorg/dev').",
+        },
+        {
+            "name": "gateway_id",
+            "required": False,
+            "type": "string",
+            "default": None,
+            "description": "Unique ID for this gateway instance. Auto-generated if omitted.",
+        },
+        {
+            "name": "artifact_service",
+            "required": True,
+            "type": "object",
+            "description": "Configuration for the SHARED ADK Artifact Service.",
+        },
+        {
+            "name": "enable_embed_resolution",
+            "required": False,
+            "type": "boolean",
+            "default": True,
+            "description": "Enable late-stage 'artifact_content' embed resolution in the gateway.",
+        },
+        {
+            "name": "gateway_max_artifact_resolve_size_bytes",
+            "required": False,
+            "type": "integer",
+            "default": 104857600,  # 100MB
+            "description": "Maximum size of an individual artifact's raw content for 'artifact_content' embeds and max total accumulated size for a parent artifact after internal recursive resolution.",
+        },
+        {
+            "name": "gateway_recursive_embed_depth",
+            "required": False,
+            "type": "integer",
+            "default": 12,
+            "description": "Maximum depth for recursively resolving 'artifact_content' embeds within files.",
+        },
+        # --- Default User Identity Configuration ---
+        {
+            "name": "default_user_identity",
+            "required": False,
+            "type": "string",
+            "description": "Default user identity to use when no user authentication is provided. WARNING: Only use in development environments with trusted access!",
+        },
+        {
+            "name": "force_user_identity",
+            "required": False,
+            "type": "string",
+            "description": "Override any provided user identity with this value. WARNING: Development only! This completely replaces authentication.",
+        },
+        # --- Identity Service Configuration ---
+        {
+            "name": "identity_service",
+            "required": False,
+            "type": "object",
+            "default": None,
+            "description": "Configuration for the pluggable Identity Service provider.",
+        },
+    ]
+}
+
+
+class BaseGatewayApp(App):
+    """
+    Base class for Gateway applications.
+
+    Handles common configuration, Solace broker setup, and instantiation
+    of the gateway-specific component. It also automatically merges its
+    base schema with specific schema parameters defined by subclasses.
+    """
+
+    app_schema: Dict[str, List[Dict[str, Any]]] = BASE_GATEWAY_APP_SCHEMA
+    SPECIFIC_APP_SCHEMA_PARAMS_ATTRIBUTE_NAME = "SPECIFIC_APP_SCHEMA_PARAMS"
+
+    def __init_subclass__(cls, **kwargs):
+        """
+        Automatically merges the base gateway schema with specific schema
+        parameters defined in any subclass.
+        """
+        super().__init_subclass__(**kwargs)
+
+        specific_params = getattr(
+            cls, cls.SPECIFIC_APP_SCHEMA_PARAMS_ATTRIBUTE_NAME, []
+        )
+
+        if not isinstance(specific_params, list):
+            log.warning(
+                "Class attribute '%s' in %s is not a list. Schema merging might be incorrect.",
+                cls.SPECIFIC_APP_SCHEMA_PARAMS_ATTRIBUTE_NAME,
+                cls.__name__,
+            )
+            specific_params = []
+
+        base_params = BaseGatewayApp.app_schema.get("config_parameters", [])
+
+        merged_config_parameters = list(base_params)
+        merged_config_parameters.extend(specific_params)
+
+        cls.app_schema = {"config_parameters": merged_config_parameters}
+        log.debug(
+            "BaseGatewayApp.__init_subclass__ created merged app_schema for %s with %d params.",
+            cls.__name__,
+            len(merged_config_parameters),
+        )
+
+    def __init__(self, app_info: Dict[str, Any], **kwargs):
+        """
+        Initializes the BaseGatewayApp.
+
+        Args:
+            app_info: Configuration dictionary for the app, typically from YAML.
+            **kwargs: Additional arguments for the parent App class.
+        """
+        log.debug(
+            "Initializing BaseGatewayApp with app_info: %s",
+            app_info.get("name", "Unnamed App"),
+        )
+
+        code_config_app_block = getattr(self.__class__, "app_config", {}).get(
+            "app_config", {}
+        )
+        yaml_app_config_block = app_info.get("app_config", {})
+        resolved_app_config_block = deep_merge(
+            code_config_app_block, yaml_app_config_block
+        )
+
+        self.namespace: str = resolved_app_config_block.get("namespace")
+        if not self.namespace:
+            raise ValueError(
+                "Namespace is required in app_config for BaseGatewayApp or its derivatives."
+            )
+
+        self.gateway_id: str = resolved_app_config_block.get("gateway_id")
+        if not self.gateway_id:
+            self.gateway_id = f"gdk-gateway-{uuid.uuid4().hex[:8]}"
+            resolved_app_config_block["gateway_id"] = self.gateway_id
+            log.info("Generated unique gateway_id: %s", self.gateway_id)
+
+        self.artifact_service_config: Dict = resolved_app_config_block.get(
+            "artifact_service", {}
+        )
+        self.enable_embed_resolution: bool = resolved_app_config_block.get(
+            "enable_embed_resolution", True
+        )
+
+        new_size_limit_key = "gateway_max_artifact_resolve_size_bytes"
+        default_new_size_limit = 104857600
+        old_size_limit_key = "gateway_artifact_content_limit_bytes"
+
+        new_value = resolved_app_config_block.get(new_size_limit_key)
+        old_value = resolved_app_config_block.get(old_size_limit_key)
+
+        app_name_for_log = app_info.get("name", "BaseGatewayApp")
+
+        if new_value is not None:
+            self.gateway_max_artifact_resolve_size_bytes = new_value
+            if old_value is not None and new_value != old_value:
+                log.warning(
+                    f"[{app_name_for_log}] Both '{new_size_limit_key}' (value: {new_value}) and deprecated '{old_size_limit_key}' (value: {old_value}) are present. "
+                    f"Using value from '{new_size_limit_key}'."
+                )
+        elif old_value is not None:
+            self.gateway_max_artifact_resolve_size_bytes = old_value
+            log.warning(
+                f"[{app_name_for_log}] Configuration key '{old_size_limit_key}' (value: {old_value}) is deprecated. "
+                f"Please use '{new_size_limit_key}'. Using value from old key."
+            )
+        else:
+            self.gateway_max_artifact_resolve_size_bytes = default_new_size_limit
+
+        self.gateway_recursive_embed_depth: int = resolved_app_config_block.get(
+            "gateway_recursive_embed_depth", 12
+        )
+
+        modified_app_info = app_info.copy()
+        modified_app_info["app_config"] = resolved_app_config_block
+
+        subscriptions = [
+            {"topic": get_discovery_topic(self.namespace)},
+            {
+                "topic": get_gateway_response_subscription_topic(
+                    self.namespace, self.gateway_id
+                )
+            },
+            {
+                "topic": get_gateway_status_subscription_topic(
+                    self.namespace, self.gateway_id
+                )
+            },
+        ]
+        log.info(
+            "Generated Solace subscriptions for gateway '%s': %s",
+            self.gateway_id,
+            subscriptions,
+        )
+
+        gateway_component_class = self._get_gateway_component_class()
+        if not gateway_component_class or not issubclass(
+            gateway_component_class, ComponentBase
+        ):
+            raise TypeError(
+                f"_get_gateway_component_class in {self.__class__.__name__} must return a valid ComponentBase subclass."
+            )
+
+        component_definition = {
+            "name": f"{self.gateway_id}_component",
+            "component_class": gateway_component_class,
+            "component_config": {"app_config": resolved_app_config_block},
+            "subscriptions": subscriptions,
+        }
+        modified_app_info["components"] = [component_definition]
+
+        broker_config = modified_app_info.setdefault("broker", {})
+        broker_config["input_enabled"] = True
+        broker_config["output_enabled"] = True
+        broker_config["queue_name"] = (
+            f"{self.namespace.strip('/')}/q/gdk/gateway/{self.gateway_id}"
+        )
+        broker_config["temporary_queue"] = True
+        log.debug(
+            "Injected broker settings for gateway '%s': %s",
+            self.gateway_id,
+            broker_config,
+        )
+
+        super().__init__(app_info=modified_app_info, **kwargs)
+        log.info("BaseGatewayApp '%s' initialized successfully.", self.name)
+
+    @abstractmethod
+    def _get_gateway_component_class(self) -> Type[BaseGatewayComponent]:
+        """
+        Abstract method to be implemented by derived gateway applications.
+
+        Returns:
+            The specific gateway component class (e.g., WebUIBackendComponent).
+        """
+        pass

solace_agent_mesh/gateway/base/base_llm.txt

@@ -0,0 +1,119 @@
+## Quick Summary
+The `base` directory provides the foundational, abstract classes for building Gateway implementations within the Solace AI Connector. It establishes a framework for handling common gateway tasks such as application configuration, Solace broker integration, A2A (Agent-to-Agent) message protocol handling, and managing the lifecycle of requests from external platforms. Developers should subclass `BaseGatewayApp` and `BaseGatewayComponent` to create a new gateway.
+
+## Files Overview
+- `__init__.py`: Marks the directory as a Python package.
+- `app.py`: Contains the base application class (`BaseGatewayApp`) that handles configuration, schema merging, and broker setup.
+- `component.py`: Contains the core logic class (`BaseGatewayComponent`) for processing A2A messages and integrating with external platforms.
+- `task_context.py`: Provides a thread-safe manager for mapping A2A task IDs to their original request context.
+
+## Developer API Reference
+
+### __init__.py
+**Purpose:** Initializes the `gateway.base` Python package.
+**Import:** `from gateway.base import ...`
+
+---
+
+### app.py
+**Purpose:** Provides the base application class for gateway implementations. It automates configuration schema merging, Solace broker setup (including topic subscriptions and queue creation), and component instantiation.
+**Import:** `from gateway.base.app import BaseGatewayApp, BaseGatewayComponent`
+
+**Classes:**
+- `BaseGatewayComponent(ComponentBase)` - A base class marker for gateway components. Subclasses of `BaseGatewayComponent` from `component.py` inherit from this.
+- `BaseGatewayApp(app_info: Dict[str, Any], **kwargs)` - The main application class to be subclassed for a new gateway.
+  - `_get_gateway_component_class(self) -> Type[BaseGatewayComponent]` - **[Abstract Method]** Must be implemented by subclasses to return the specific gateway component class that will handle the core logic.
+  - `namespace: str` - The absolute topic prefix for A2A communication (e.g., 'myorg/dev').
+  - `gateway_id: str` - The unique ID for this gateway instance. Auto-generated if not provided.
+  - `artifact_service_config: Dict` - Configuration for the shared ADK Artifact Service.
+  - `enable_embed_resolution: bool` - Flag to enable or disable late-stage 'artifact_content' embed resolution.
+  - `gateway_max_artifact_resolve_size_bytes: int` - Maximum size for resolving individual or recursively embedded artifacts.
+  - `gateway_recursive_embed_depth: int` - Maximum depth for recursively resolving 'artifact_content' embeds.
+
+**Constants/Variables:**
+- `BASE_GATEWAY_APP_SCHEMA: Dict[str, List[Dict[str, Any]]]` - The base configuration schema dictionary that is automatically merged with subclass-specific parameters.
+- `SPECIFIC_APP_SCHEMA_PARAMS_ATTRIBUTE_NAME: str` - The class attribute name (`"SPECIFIC_APP_SCHEMA_PARAMS"`) that subclasses should use to define their own configuration parameters.
+
+**Usage Examples:**
+```python
+# In your custom gateway's app.py
+
+from typing import Type, List, Dict, Any
+from gateway.base.app import BaseGatewayApp
+from .component import MyGatewayComponent # Your custom component
+
+class MyGatewayApp(BaseGatewayApp):
+    """
+    A custom gateway application for My Platform.
+    """
+    # Define additional configuration parameters specific to this gateway
+    SPECIFIC_APP_SCHEMA_PARAMS: List[Dict[str, Any]] = [
+        {
+            "name": "my_platform_api_key",
+            "required": True,
+            "type": "string",
+            "description": "API key for connecting to My Platform."
+        }
+    ]
+
+    def _get_gateway_component_class(self) -> Type[MyGatewayComponent]:
+        """
+        Returns our custom component class.
+        """
+        return MyGatewayComponent
+
+# To run this app (typically via a YAML configuration file):
+# app_config = {
+#     "name": "my-gateway-app",
+#     "app_class": MyGatewayApp,
+#     "app_config": {
+#         "namespace": "myorg/prod",
+#         "gateway_id": "my-gateway-instance-01",
+#         "artifact_service": {
+#             "type": "local_file",
+#             "base_path": "/data/artifacts"
+#         },
+#         "my_platform_api_key": "secret-key-here"
+#     }
+# }
+# app = MyGatewayApp(app_info=app_config)
+# app.run()
+```
+
+---
+
+### component.py
+**Purpose:** Provides the abstract base class for gateway components. This class contains the core logic for handling the A2A protocol, managing services (identity, artifacts), and defining the interface for interaction with an external platform (e.g., a web server, a chat application).
+**Import:** `from gateway.base.component import BaseGatewayComponent`
+
+**Classes:**
+- `BaseGatewayComponent(**kwargs: Any)` - The abstract base class for gateway components. Developers must subclass this and implement the abstract methods.
+  - **Public Methods:**
+    - `publish_a2a_message(self, topic: str, payload: Dict, user_properties: Optional[Dict] = None) -> None` - Publishes a message to the Solace broker for A2A communication.
+    - `authenticate_and_enrich_user(self, external_event_data: Any) -> Optional[Dict[str, Any]]` - Orchestrates the full user authentication and identity enrichment flow by calling `_extract_initial_claims` and the configured Identity Service.
+    - `submit_a2a_task(self, target_agent_name: str, a2a_parts: List[A2APart], external_request_context: Dict[str, Any], user_identity: Any, is_streaming: bool = True, api_version: str = "v2") -> str` - Submits a task to a target agent, handling user configuration resolution, message creation, and context storage. Returns the generated `task_id`.
+    - `run(self) -> None` - Starts the component's asynchronous operations, including the message processor loop and the external platform listener.
+    - `cleanup(self) -> None` - Cleans up all resources, stops listeners, and shuts down background threads.
+  - **Abstract Methods (Must be Implemented by Subclasses):**
+    - `_extract_initial_claims(self, external_event_data: Any) -> Optional[Dict[str, Any]]` - Extracts primary identity claims (e.g., user ID) from a platform-specific event. Must return a dict with an 'id' key, or None if auth fails.
+    - `_start_listener(self) -> None` - Starts the listener for the external platform (e.g., start a web server, connect to a WebSocket).
+    - `_stop_listener(self) -> None` - Stops the listener for the external platform.
+    - `_translate_external_input(self, external_event: Any) -> Tuple[str, List[A2APart], Dict[str, Any]]` - Translates an incoming event from the external platform into a format the A2A protocol understands: `(target_agent_name, list_of_a2a_parts, external_request_context)`.
+    - `_send_update_to_external(self, external_request_context: Dict[str, Any], event_data: Union[TaskStatusUpdateEvent, TaskArtifactUpdateEvent], is_final_chunk_of_update: bool) -> None` - Sends a streaming update (e.g., a status message or an artifact) back to the external platform.
+    - `_send_final_response_to_external(self, external_request_context: Dict[str, Any], task_data: Task) -> None` - Sends the final, complete response of a task back to the external platform.
+    - `_send_error_to_external(self, external_request_context: Dict[str, Any], error_data: JSONRPCError) -> None` - Sends an error message back to the external platform.
+
+**Usage Examples:**
+```python
+# In your custom gateway's component.py
+
+from typing import Any, Dict, List, Optional, Tuple, Union
+from gateway.base.component import BaseGatewayComponent
+from ...common.types import (
+    Part as A2APart, TextPart, Task, TaskStatusUpdateEvent,
+    TaskArtifactUpdateEvent, JSONRPCError
+)
+
+class MyGatewayComponent(BaseGatewayComponent):
+    # This is a simplified example. A real implementation would
+    #