d63e380324
Every PLUGIN-COMPAT __getattr__ now calls hermes_cli.plugin_compat.warn_once(facade, name, target) before
resolving, emitting a HermesPluginCompatWarning (FutureWarning) once per process per name: old path, new
path, removal target. Importing a facade for its live API stays silent; only resolving a moved name warns.
COMPAT_MANIFEST.md documents the warning and how to silence it during migration.
Verified the runtime never routes through a pointer: every entry point (run_agent, cli, hermes_cli.main,
gateway.run, tui_gateway.server, web_server, model_tools + tool discovery, hermes_state, cron.scheduler,
browser_tool, mcp_tool, kanban, auth) imports clean and `hermes doctor` runs end to end with the warning
promoted to an error.
Also restores the check_compat_pointers CI step to .github/workflows/lint.yml, which a0be177aac dropped
when the compat layer was regenerated (the lint script itself was present; the workflow step was not).
hermes_cli/plugin_compat.py, tests/test_plugin_compat_warning.py and the two-line insert per facade are
part of the compat layer and go away with it.
107 lines
4.2 KiB
Python
107 lines
4.2 KiB
Python
"""Adapter-driven dispatch of structured stream events (gateway/stream_events.py).
|
|
|
|
Message events flow into the consumer; tool events are formatted by the adapter (None
|
|
= eat it on platforms without tool chrome) and enqueued onto the same tool-progress
|
|
queue the gateway drains, so the two paths never race. Synchronous: callable from
|
|
the agent's worker thread.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import Any, Callable, Optional
|
|
|
|
from gateway.stream_events import (
|
|
Commentary, GatewayNotice, LongToolHint, MessageChunk, MessageStop, StreamEvent, ToolCallChunk,
|
|
)
|
|
|
|
logger = logging.getLogger("gateway.stream_events")
|
|
|
|
|
|
class GatewayEventDispatcher:
|
|
"""Route typed stream events through an adapter onto a delivery sink.
|
|
|
|
sink: the GatewayStreamConsumer, or None when streaming is disabled (message
|
|
events dropped; the final still goes out normally). enqueue_tool_line: None
|
|
when tool progress is disabled. tool_mode: "all"/"new"/"verbose"/"off";
|
|
preview_max_len: ``tool_preview_length`` (0 = no cap in verbose).
|
|
on_long_tool / on_notice: the gateway owns the "surface this here?" decision.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
adapter: Any,
|
|
sink: Any = None,
|
|
*,
|
|
enqueue_tool_line: Optional[Callable[[Any], None]] = None,
|
|
tool_mode: str = "all",
|
|
preview_max_len: int = 40,
|
|
on_long_tool: Optional[Callable[[LongToolHint], None]] = None,
|
|
on_notice: Optional[Callable[[GatewayNotice], None]] = None,
|
|
) -> None:
|
|
self.adapter = adapter
|
|
self.sink = sink
|
|
self._enqueue_tool_line = enqueue_tool_line
|
|
self.tool_mode = tool_mode or "all"
|
|
self.preview_max_len = preview_max_len
|
|
self._on_long_tool = on_long_tool
|
|
self._on_notice = on_notice
|
|
self._last_tool: Optional[str] = None # "new"-mode dedup
|
|
|
|
def dispatch(self, event: StreamEvent) -> None:
|
|
"""Route a single event. Never raises into the agent's worker thread."""
|
|
try:
|
|
self._dispatch(event)
|
|
except Exception: # presentation must never break the agent loop
|
|
logger.debug("stream-event dispatch error", exc_info=True)
|
|
|
|
def _dispatch(self, event: StreamEvent) -> None:
|
|
# ToolCallFinished: no chrome on completion (only "started" is rendered);
|
|
# completion only drives onboarding hints (LongToolHint).
|
|
if isinstance(event, (MessageChunk, MessageStop, Commentary)):
|
|
if self.sink is not None:
|
|
self.adapter.render_message_event(event, self.sink)
|
|
elif isinstance(event, ToolCallChunk):
|
|
self._dispatch_tool_call(event)
|
|
elif isinstance(event, LongToolHint) and self._on_long_tool is not None:
|
|
self._on_long_tool(event)
|
|
elif isinstance(event, GatewayNotice) and self._on_notice is not None:
|
|
self._on_notice(event)
|
|
|
|
def _dispatch_tool_call(self, event: ToolCallChunk) -> None:
|
|
if self.tool_mode == "off" or self._enqueue_tool_line is None:
|
|
return
|
|
if self.tool_mode == "new" and event.tool_name == self._last_tool:
|
|
return
|
|
self._last_tool = event.tool_name
|
|
line = self.adapter.format_tool_event(
|
|
event, mode=self.tool_mode, preview_max_len=self.preview_max_len,
|
|
)
|
|
if line: # None/"" == adapter chose to eat this event
|
|
self._enqueue_tool_line(line)
|
|
|
|
|
|
__all__ = ["GatewayEventDispatcher"]
|
|
|
|
|
|
# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
|
|
# Names external plugins imported from this module before the Sep 2026 decomposition.
|
|
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
|
|
# The whole block is removed by reverting the commit that added it.
|
|
|
|
|
|
_PLUGIN_COMPAT_LAZY = {
|
|
'ToolCallFinished': ('gateway.stream_events', 'ToolCallFinished'),
|
|
}
|
|
|
|
|
|
def __getattr__(name): # PEP 562 — lazy so no import cycles
|
|
target = _PLUGIN_COMPAT_LAZY.get(name)
|
|
if target is None:
|
|
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
import importlib
|
|
from hermes_cli.plugin_compat import warn_once
|
|
warn_once(__name__, name, *target)
|
|
return getattr(importlib.import_module(target[0]), target[1])
|
|
# ---- END PLUGIN-COMPAT ----
|