Files
hermes-agent/gateway/run_plugin_rewire.py
teknium1 21d0b12958 feat(plugins): late-loaded plugins wire their platform handlers live (#87770)
A plugin that finished loading after an adapter connected never got its platform
handlers (slash commands, button callbacks, inbound transforms) registered until a
gateway restart, silently. Three pieces, one seam shared by every surface:

1. Discovery listener: PluginManager.on_plugin_loaded(cb) fires from INSIDE
   discover_and_load for the plugins a sweep newly loaded (diff of the loaded set),
   with a per-plugin activation summary (hermes_cli/plugins_activation.py):
   activated_now {gateway_commands, gateway_transforms, hooks, callbacks} vs
   deferred {tools, prompt, mcp_servers}. Every mid-run load path now performs a real
   discover_plugins(force=True): CLI install/enable (via the gateway), Desktop/TUI
   plugins.manage install/toggle/update, dashboard REST install, tool-triggered
   force re-discovery, the new `reload-plugins` control-socket verb. A non-forced
   discover_plugins() short-circuits on _discovered, which is why reload.mcp after
   a mid-run install used to reload the OLD server set.
2. Idempotent re-wire: BasePlatformAdapter.rewire_plugin_handlers() runs only
   factories not yet wired on the live native client (keyed (plugin, qualname);
   a force reload hands back new function objects). Telegram hoists late handlers
   ahead of core's catch-all filters.COMMAND / CallbackQueryHandler (PTB dispatches
   the first match per group) and re-wires on the transient-init rebuild; Slack
   dedupes register_slack_action_handler per AsyncApp. The gateway runner
   subscribes per served profile and re-wires on the loop.
3. Scope limit + honest messaging: handlers only. Tools/prompt stay deferred to
   the next session (prompt-cache invariant), MCP servers to mcp.reload; the CLI
   hint and plugins.manage results (activation, gateway_reloaded,
   restart_required only when no gateway answered) say exactly that.
2026-09-22 09:50:22 -07:00

127 lines
6.5 KiB
Python

"""Late plugin loads re-wire the running adapters (#87770).
A plugin that finishes loading after an adapter connected — a tool-triggered force re-discovery, or
``hermes plugins install/enable`` / the Desktop / ``plugins.manage`` nudging the gateway over the control
socket — used to leave its platform handlers (slash commands, button callbacks, inbound transforms)
silently unwired until a restart. The runner subscribes to ``PluginManager.on_plugin_loaded`` per served
profile and calls every live adapter's idempotent ``rewire_plugin_handlers()`` on the event loop.
Scope is handlers only: a mid-run-loaded plugin's tools and system-prompt sections stay deferred to the
next session (prompt-cache invariant; same as ``/skills install``).
"""
from __future__ import annotations
import asyncio
import contextlib
import logging
from pathlib import Path
from typing import Any, Callable, Dict, Optional
logger = logging.getLogger(__name__)
class GatewayPluginRewireMixin:
"""Subscribe once per plugin manager; re-wire that profile's adapters on every loaded event."""
_plugin_rewire_unsubscribe: Optional[Dict[str, Callable[[], None]]] = None
def _subscribe_plugin_rewire(self, manager: Any, profile_name: Optional[str] = None,
profile_home: Optional[Path] = None) -> None:
"""Idempotent per manager scope: a served-profile rescan re-enters ``_load_secondary_profile_config``
and must not stack a second listener (two listeners = two re-wire passes, still deduped, but noise)."""
subs = self._plugin_rewire_unsubscribe
if subs is None:
subs = self._plugin_rewire_unsubscribe = {}
scope = str(getattr(manager, "scope_key", "") or id(manager))
if scope in subs:
return
try:
loop = asyncio.get_running_loop()
except RuntimeError:
loop = None
def _on_loaded(_names) -> None:
# Fires on the discovering thread (tool worker, control-socket executor, or the loop itself):
# adapters own PTB/Bolt handler tables, so always hop onto the gateway loop.
if loop is None or loop.is_closed():
return
loop.call_soon_threadsafe(self._rewire_plugin_handlers, profile_name, profile_home)
subs[scope] = manager.on_plugin_loaded(_on_loaded)
def _rewire_plugin_handlers(self, profile_name: Optional[str] = None,
profile_home: Optional[Path] = None) -> int:
"""Call ``rewire_plugin_handlers()`` on every live adapter of one profile (``None`` = the launch
profile's ``self.adapters``); a secondary's adapters read their own manager, so bind its scope.
Returns the number of adapters re-wired."""
if profile_name is None:
adapters = dict(getattr(self, "adapters", None) or {})
else:
adapters = dict((getattr(self, "_profile_adapters", None) or {}).get(profile_name) or {})
if not adapters:
return 0
from gateway.run import _profile_runtime_scope
scope = (_profile_runtime_scope(profile_home, hydrate_secrets=False)
if profile_home is not None else contextlib.nullcontext())
count = 0
with scope:
for platform, adapter in adapters.items():
try:
adapter.rewire_plugin_handlers()
count += 1
except Exception:
logger.warning("[%s] plugin handler re-wire failed", getattr(platform, "value", platform),
exc_info=True)
logger.info("Re-wired plugin handlers on %d adapter(s)%s", count,
f" for profile '{profile_name}'" if profile_name else "")
return count
def reload_plugins_verb(runner: Any, loop: asyncio.AbstractEventLoop) -> Callable[..., dict]:
"""Control-socket ``reload-plugins``: force re-discovery under the requested home's scope so a plugin
installed/enabled by another process (CLI, Desktop, ``plugins.manage``) loads now; the loaded event
then re-wires that profile's adapters. Only the gateway home and served profile homes are accepted.
Answer: ``{"reloaded", "home", "plugins", "activations", "adapters_rewired"}``. Runs on the socket executor thread
(discovery is blocking); the count is read on the loop AFTER the re-wire callback (FIFO), so a
truthful "active now" reaches the caller."""
def _handler(params: Optional[dict] = None) -> dict:
from hermes_constants import get_hermes_home, hermes_home_key
from hermes_cli.plugins import discover_plugins, get_plugin_manager
from hermes_cli.plugins_activation import activation_summaries
from gateway.run import _profile_runtime_scope
params = params or {}
gateway_home = Path(get_hermes_home())
requested = Path(str(params.get("home") or gateway_home)).expanduser()
req_key = hermes_home_key(requested)
profile_name: Optional[str] = None
if req_key != hermes_home_key(gateway_home):
served = (getattr(runner, "_served_profile_homes", None) or {}).items()
profile_name = next((str(n) for n, h in served if hermes_home_key(h) == req_key), None)
if profile_name is None:
return {"reloaded": False, "error": "home is not served by this gateway", "home": str(requested)}
if profile_name == (getattr(runner, "_primary_profile_name", None) or "default"):
profile_name = None
scope = (_profile_runtime_scope(requested, hydrate_secrets=False) if profile_name
else contextlib.nullcontext())
with scope:
discover_plugins(force=True)
manager = get_plugin_manager()
names, activations = sorted(manager._plugins), activation_summaries(manager)
try:
rewired = asyncio.run_coroutine_threadsafe(_count_adapters(runner, profile_name), loop).result(timeout=5.0)
except Exception:
rewired = None
return {"reloaded": True, "home": str(requested), "plugins": names, "activations": activations,
"adapters_rewired": rewired}
return _handler
async def _count_adapters(runner: Any, profile_name: Optional[str]) -> int:
"""Live adapters for the profile; scheduled after the loaded-event callback, so they are re-wired."""
if profile_name is None:
return len(getattr(runner, "adapters", None) or {})
return len((getattr(runner, "_profile_adapters", None) or {}).get(profile_name) or {})