mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-06-21 10:22:18 +00:00
237fa7d29c
Wire the relay adapter into gateway startup and make activation config-driven instead of a dark-launch flag. - gateway/relay/__init__.py: replace relay_enabled()/HERMES_GATEWAY_RELAY with relay_url() (GATEWAY_RELAY_URL env or gateway.relay_url in config.yaml) — the same shape as gateway.proxy_url. register_relay_adapter() registers when a URL is configured and builds a live WebSocketRelayTransport; with no URL it's a no-op (direct/single-tenant deployments unaffected). force=True keeps the transport-less adapter for unit tests. relay_platform_identity() reads the hello platform/botId from GATEWAY_RELAY_PLATFORM/GATEWAY_RELAY_BOT_ID. - gateway/run.py: call register_relay_adapter() during GatewayRunner.start(), right after plugin discovery, so a configured connector relay is registered on every boot. Failures are logged, never block startup. This removes the dark-launch posture: the relay is on whenever it's configured, shipping the production end state rather than hiding it behind a flag.
112 lines
4.4 KiB
Python
112 lines
4.4 KiB
Python
"""Relay/connector support package for the Hermes gateway.
|
|
|
|
EXPERIMENTAL. This package implements the gateway side of the "Gateway Gateway"
|
|
relay design: a generic ``RelayAdapter`` plus the wire-serializable
|
|
``CapabilityDescriptor`` the connector hands it at handshake time, and the
|
|
production ``WebSocketRelayTransport`` that dials the connector. The public API
|
|
(module names, descriptor field set, transport protocol) MAY CHANGE without a
|
|
deprecation cycle until at least two real Class-1 platforms (Discord + Telegram)
|
|
have shaken out the schema.
|
|
|
|
See ``docs/relay-connector-contract.md`` for the formal cross-repo interface.
|
|
|
|
Activation is driven by configuration, not a separate feature flag: the relay
|
|
platform is registered when a connector relay URL is configured
|
|
(``GATEWAY_RELAY_URL`` env or ``gateway.relay_url`` in config.yaml). Deployments
|
|
that don't set it are unaffected — exactly the same shape as ``gateway.proxy_url``.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
from typing import Optional
|
|
|
|
|
|
def relay_url() -> Optional[str]:
|
|
"""The connector relay endpoint URL, or None when relay is not configured.
|
|
|
|
Checks ``GATEWAY_RELAY_URL`` (convenient for Docker) first, then
|
|
``gateway.relay_url`` in config.yaml. A non-empty value activates the relay
|
|
platform; absence means a normal direct/single-tenant gateway.
|
|
"""
|
|
url = os.environ.get("GATEWAY_RELAY_URL", "").strip()
|
|
if url:
|
|
return url.rstrip("/")
|
|
try:
|
|
from gateway.run import _load_gateway_config # late import to avoid cycle
|
|
|
|
cfg = _load_gateway_config()
|
|
url = (cfg.get("gateway") or {}).get("relay_url", "").strip()
|
|
if url:
|
|
return url.rstrip("/")
|
|
except Exception: # noqa: BLE001 - config absence/parse must never crash registration
|
|
pass
|
|
return None
|
|
|
|
|
|
def relay_platform_identity() -> tuple[str, str]:
|
|
"""Platform + bot id this gateway fronts over the relay (for the handshake hello).
|
|
|
|
Defaults to ``("relay", "")``; overridable via ``GATEWAY_RELAY_PLATFORM`` /
|
|
``GATEWAY_RELAY_BOT_ID`` so one connector can front several platforms.
|
|
"""
|
|
platform = os.environ.get("GATEWAY_RELAY_PLATFORM", "relay").strip() or "relay"
|
|
bot_id = os.environ.get("GATEWAY_RELAY_BOT_ID", "").strip()
|
|
return platform, bot_id
|
|
|
|
|
|
def register_relay_adapter(force: bool = False, url: Optional[str] = None) -> bool:
|
|
"""Register the generic ``relay`` platform via the platform registry.
|
|
|
|
Registers when a relay URL is configured (or ``force=True`` for tests, which
|
|
builds a transport-less adapter — the unit-test posture). Returns True if
|
|
registration happened. Additive: uses the same registry path as plugin
|
|
adapters, so no core dispatch changes are needed.
|
|
|
|
When a URL is present the factory builds a live ``WebSocketRelayTransport``;
|
|
the ``RelayAdapter`` negotiates the real ``CapabilityDescriptor`` at
|
|
``connect()`` time via ``transport.handshake()``.
|
|
"""
|
|
resolved_url = url if url is not None else relay_url()
|
|
if not (force or resolved_url):
|
|
return False
|
|
|
|
from gateway.platform_registry import PlatformEntry, platform_registry
|
|
from gateway.relay.adapter import RelayAdapter
|
|
from gateway.relay.descriptor import CONTRACT_VERSION, CapabilityDescriptor
|
|
|
|
platform, bot_id = relay_platform_identity()
|
|
|
|
def _factory(config):
|
|
# Placeholder descriptor; replaced by the negotiated one at connect time
|
|
# when a transport is present. With no URL (force/test) the adapter is
|
|
# transport-less and keeps the placeholder.
|
|
placeholder = CapabilityDescriptor(
|
|
contract_version=CONTRACT_VERSION,
|
|
platform=platform,
|
|
label="Relay",
|
|
max_message_length=4096,
|
|
supports_draft_streaming=False,
|
|
supports_edit=True,
|
|
supports_threads=False,
|
|
markdown_dialect="plain",
|
|
len_unit="chars",
|
|
)
|
|
transport = None
|
|
if resolved_url:
|
|
from gateway.relay.ws_transport import WebSocketRelayTransport
|
|
|
|
transport = WebSocketRelayTransport(resolved_url, platform, bot_id)
|
|
return RelayAdapter(config, placeholder, transport=transport)
|
|
|
|
platform_registry.register(
|
|
PlatformEntry(
|
|
name="relay",
|
|
label="Relay",
|
|
adapter_factory=_factory,
|
|
check_fn=lambda: True,
|
|
source="builtin",
|
|
emoji="\U0001f50c",
|
|
)
|
|
)
|
|
return True
|