Files
hermes-agent/gateway/run_startup.py
Teknium 9bcbe7b5df feat(i18n): pluggable, layered language packs across core, Desktop and TUI (#126296)
* feat(i18n): layered catalogs — plugin packs and user overlay over bundled locales

* feat(tui): i18n layer — en catalog, nanostore runtime, RPC pack loader, _keys.tui.json emitter

ui-tui/src/i18n/: en.ts (facade over topical siblings under en/), types.ts
(Translations + dotted TranslationKey derived from en), runtime.ts ($locale/
$catalog atoms, translateFrom active→en→key, pack merge with string→fn
wrapping for {0}/{1} placeholders), loader.ts (display.language →
i18n.catalog {lang, surface:'tui'}, English when the method is missing),
useT()/useLocale() hooks, t() for non-React code. useConfigSync feeds the
loader from the existing config.get full hydration. `npm run i18n:keys`
writes locales/_keys.tui.json (sorted flat key list) and runs before build.

* feat(plugins): provides_locales manifest field, ctx.register_locale/register_locale_dir, manifest-only language packs

* chore(tui): split en catalog siblings by lane (slash sibling)

* feat(plugins): validate language packs — parse, text-only, key-subset WARN against en / _keys exports

* feat(tui_gateway): i18n.languages / i18n.catalog RPC + regenerated contracts

* feat(config): display.language accepts any supported_languages() id, refuses unknown ids with the list

* docs(i18n): language packs user guide, pluggable display.language, plugin developer section, AGENTS notes

* feat(plugins): report language-pack layers in the mid-run activation summary

* feat(tui): wire status bar, composer placeholders, hotkey help and approval/clarify/confirm prompts through i18n

StatusRule maps compared state values (ready/running…/summoning) to catalog
text at render via displayStatus(); hotkeys()/placeholder() resolve lazily so
a pack that arrives after boot applies. Catalog grows to 81 keys.

* feat(desktop): pluggable app locales — registry, host.i18n.registerAppLocale, backend packs, keys emitter

- Locale widens to string (BundledLocale keeps the union); TRANSLATIONS stays
  the bundled record and every consumer resolves through the registry.
- src/i18n/registry.ts: registerAppLocale(id, {endonym, rtl, translations})
  layers partial packs (nested or flat dotted) over bundled/en via
  mergeTranslations; a string over a function-valued en entry becomes a
  positional {0}/{1} formatter; $appLocaleVersion bumps so translators
  re-render; per-source disposers + replaceAppLocaleSource for atomic swaps.
- Backend packs: i18n.languages + i18n.catalog {surface:'desktop'} feed the
  registry as source 'backend' (method-not-found is silent); re-synced on
  socket open, display.language change and profile switch. A saved pack-only
  language is promoted once its pack registers.
- SDK: host.i18n.registerAppLocale / languageOptions; ctx.i18n.registerAppLocale
  tracked for unload. Docs in the desktop plugin SDK guide + skill reference.
- Language switcher lists bundled ∪ registered ∪ backend, endonym-only; RTL
  from the registry (applyDocumentLocale takes rtl).
- npm run i18n:keys emits locales/_keys.desktop.json (wired into build).

* i18n(cli): route /topup + /subscription copy through t() (cli.billing.*, cli.subscription.*)

Module-level copy tables and modal choice tuples in cli_billing_mixin.py froze
English at import, before display.language was known. They are now key tables /
builder functions evaluated at call time; every user-facing line in the /usage
balance block, /subscription and the five /topup screens reads the catalog.
Choice VALUES stay English identifiers. Fragment-assembled status lines
(Plan: … → cancels · $x left · renews …) become full templates.

* i18n(gateway): exec-approval card contract + base/run/run_busy/run_inbound replies through t()

- base_exec_approval: EA_* English constants stay; add ea_header_text()/ea_reason_label_text()/
  ea_smart_deny_line_text()/ea_default_reason_text()/ea_action_labels()/approval_timed_out_notice()
  accessors; deadline + timed-out notice resolve via gateway.exec_approval.*
- BasePlatformAdapter._EA_HEADER/_EA_REASON_LABEL/_EA_SMART_DENY_LINE/_EA_ACTION_LABELS become
  properties (adapters still shadow them with markup class attrs)
- run.py: provider error replies table holds catalog keys; _CONTEXT_OVERFLOW_REPLY -> _context_overflow_reply()
- run_busy/run_inbound: typed approval + slash-confirm matchers accept English ∪ approval.inputs.* (t())
- locales/en.yaml: gateway.exec_approval/busy/errors/... namespaces

* i18n(cli): wire modal, loops, agent-setup mixins through t() (cli.* keys)

* i18n(platforms): route Slack, Matrix and Feishu user-facing text through t()

Exec-approval markup overrides (_EA_HEADER/_EA_REASON_LABEL/_EA_SMART_DENY_LINE/
_EA_ACTION_LABELS) become per-call properties over the shared
gateway.exec_approval.* contract keys, so Slack's 3000-char section budget
measures the resolved template. Slack _APPROVAL_DECISIONS/_CONFIRM_DECISIONS,
Feishu _APPROVAL_LABEL_MAP and Matrix _EA_LEGEND/_EA_TYPED_HINT turn into
key tables resolved at click time; the Matrix typed hints become whole
sentences per offered tier instead of spliced fragments. Slack button labels
are cut to 75 chars and select placeholders to 150 after translation; the
model-facing clarify fallback answer ('choice N') stays English while the
card copy localizes.

locales/en.yaml gains the gateway.exec_approval.* contract keys plus the
platform.shared.* / platform.slack.* / platform.matrix.* / platform.feishu.*
namespaces (and the keys for the other adapters wired in follow-up commits).

* i18n(gateway): run_turn / run_turn_runner / approval-settle copy through t()

- status hints, proxy errors, background task notices, progress heartbeats, session info lines
- tool progress chrome (tool_head/tool_pending/tool_preview/tool_verbose) shared by base.format_tool_event
- run_turn_runner:1406 Chinese clarify placeholder -> gateway.clarify.native_stream_placeholder (zh text kept in zh.yaml)
- _UNEXPECTED_SILENCE_REPLY/_CLARIFY_EXPIRED_NOTICE -> accessor functions

* i18n(platforms): route Google Chat and Teams user-facing text through t()

Google Chat clarify card, typing placeholder, orphan-card labels and the whole
/setup-files reply set (module constants become platform.google_chat.setup_files.*
keys resolved at reply time). The attachment-fallback notice that shipped
hardcoded in Spanish is keyed with an English en value; es.yaml carries the
original Spanish text for those four keys.

Teams approval card header/reason use the gateway.exec_approval.* contract,
_APPROVAL_LABELS becomes a key table resolved at click time, and the meeting
summary writer resolves its section headings/fallbacks per render.

* i18n(platforms): route LINE, WeCom, email, DingTalk, IRC and Home Assistant text through t()

LINE default copy constants become catalog keys resolved in __init__ (the
LINE_*_TEXT / extra.* operator overrides still win); the busy-ack bypass
matcher keys on the leading emoji marker only, so it keeps firing once the
gateway busy heads are localized. WeCom media size/format notices that shipped
hardcoded in Chinese are keyed with English en values and zh.yaml carries the
original Chinese text. DingTalk emotion bubbles resolve per send.

* i18n(cli): route /model switch output and -q status lines through t() (cli.model.*, cli.single_query.*)

Switch-summary labels shared with the gateway reuse gateway.model.* keys
(provider/context/max-output/capabilities/prompt-caching); CLI-only variants
(glyph or no-backtick forms) live under cli.model.*. The hand-padded /model usage
block becomes a (form, description-key) table padded at render time so the
command syntax stays fixed while descriptions translate. -q 'Error:' reuses
gateway.model.error_prefix.

* i18n(cli): route TUI panel/hint/placeholder copy through t() (cli.tui.*)

_APPROVAL_CHOICE_LABELS and _TUI_MODAL_HINTS become key tables resolved at
render time; vault/sudo panel bodies are one catalog value per panel split on
newline; inline plurals use <key>_one/<key>_other. Adds the cli.* namespace
(shared/tui/voice/render/subagents/dock) to locales/en.yaml.

* i18n(cli): voice/wake-word CLI copy through t() (cli.voice.*)

RuntimeError texts raised in _voice_start_recording are human copy (callers
print {e}) and are keyed; the Termux requirement-check match stays English.
Wake state ids stay internal, only their labels localize.

* i18n(cli): live-work dock, subagent monitor and render copy through t()

cli.subagents.* / cli.dock.* / cli.render.*; count fragments pluralize via
_one/_other keys, verdict table holds keys resolved at paint time so width
clipping measures the translated text.

* i18n(gateway): unauthorized/pairing, voice, topics, shutdown, startup, notifications, kanban pings through t()

* i18n(cli): move tips + composer placeholders into the catalog (tips.tNNN / tips.placeholder.pNN)

get_random_tip()/get_random_composer_placeholder() pick a key from the English catalog
(the parity baseline, probed once per process) and resolve it through t() for the active
language, so language packs translate tips like any other string. Also lands the cli.*
en.yaml namespace consumed by the CLI info/help/error-copy wiring in the next commit.

* i18n(cli): wire chat-turn + session mixins through t(); kanban log trimmer matches t() output

* test(cli): assert TUI/dock/voice copy via t(key); prove labels resolve at render time

Pinned-English assertions in the approval-UI, live-work dock and voice tests now
go through the catalog. New test swaps the catalog after import and checks the
approval panel + hint row follow it (the reason _APPROVAL_CHOICE_LABELS and
_TUI_MODAL_HINTS became key tables).

* i18n(cli): route CLI info/help/error copy through t() (cli.* namespace)

cli_info_mixin: /help consumes CommandDef.describe() (added to commands.py: slash.<name>.description
with fallback to .description), section titles/skill/quick-command headers, /tools, /toolsets,
/usage labels, /context, /whoami, /insights, /gateway status, tool-progress labels, bang-shell
denials, MCP config-watch + /reload-mcp confirm/reload lines, /reload-skills, and the session-store
warning all read the catalog at call time (module-level label tables became functions so the
active language is honoured after startup). cli.py: worktree cleanup, tirith warning, show_config
(labels re-padded at print time), quick/plugin/skill slash-command errors, ambiguous-command hint,
stdin error, gateway start, profile warning. cli_chat_error_copy / cli_unknown_command /
cli_output / cli_init_mixin: chat error panel copy, did-you-mean lines, n-more / yes-no prompt
(localized affirmative initial alongside 'y'), unknown-toolsets warning.

* i18n(w1a): wire agent display/explainers/approval + slash registry/help through t()

- hermes_cli/commands.py: CommandDef.describe() resolves slash.<name>.description
  at call time; category labels via slash.category.*; help/alias/usage suffixes
  via slash.shared.*; gateway_help_lines and commands_platforms/slash_exec use them.
- agent/display.py: display.verb.* resolved at call time via get_tool_verb();
  bridge/spinner/thinking-verb/cute-row/failure/preview/diff text via display.*.
- agent/turn_explainers.py: exit-reason / persistence-cause tables become call-time
  lookups (explainer.exit.*, explainer.persistence.*, explainer.file_mutation.*).
- agent/background_review.py, session_activity.py, context_breakdown.py,
  status_output.py: review summaries, iteration progress, context notices.
- tools/approval.py, approval_context.py: approval.summary.*, approval.noun.*,
  approval.window.* pluralized keys.
- gateway/slash_commands*.py: remaining raw strings (busy, whoami, platform,
  bundles, memory, skills, approvals, set_home, diff, update, debug, profile,
  heartbeat, refine, review, subgoal, loop, retry, compress codex path, save,
  sessions, model guard/errors, agents rows, topup, login). HISTORY_UNREADABLE
  keeps its English constant; callers use history_unreadable() ->
  gateway.shared.history_unreadable.
- locales/en.yaml: new approval/display/explainer/slash blocks + gateway leftovers.

* i18n(telegram): route adapter chat copy through t()

Approval card (header/reason/smart-deny as HTML-escaped properties), inline
button labels, callback toasts (cut at Telegram's 200-char cap), model/choice
pickers, clarify/update/slash-confirm prompts, gmail-triage labels and the
inbound-media failure notice now come from the catalog. _UNAUTHORIZED is a
lazy _unauthorized() so the import no longer binds a language. The command
menu carries a language+payload fingerprint (forum scopes re-register on
change) and BotCommand descriptions are cut at 256.

Adds gateway.exec_approval.* (WAVE2 contract), platform.telegram.*,
platform.discord.* and the slash.*.description keys the Discord table shares
with the CLI registry to locales/en.yaml.

* i18n(gateway/platforms): whatsapp_cloud, yuanbao, weixin, signal, api_server copy through t()

- whatsapp_cloud: clarify list/buttons, approve/deny + slash-confirm labels via platform.whatsapp.* (t()-then-truncate at 20/24/72 caps); _EA_HEADER becomes a property wrapping ea_header_text()
- yuanbao: SLOW_RESPONSE_MESSAGE -> slow_response_message() (platform.yuanbao.slow_response_notice; zh keeps the original text); cron-wrapper markers centralized as module constants for strip_cron_wrapper
- api_server: PROVIDER_AUTH_FAILED_LABEL/PROVIDER_RATE_LIMITED_LABEL stay English for run.py matchers; user_text() renders via t()
- signal/_format_wait, weixin voice caption, openai_routes transformed notice
- run_turn: second _UNEXPECTED_SILENCE_REPLY consumer -> accessor

* i18n(discord): route adapter chat copy through t()

Native slash-command table becomes _NATIVE_SLASH_COMMAND_SPECS holding catalog
keys; _native_slash_commands() resolves descriptions, parameter descriptions
and Choice names for the active language, each cut at Discord's 100-char cap,
and the app-command sync fingerprint now includes get_language() so a
display.language change re-syncs. Exec-approval card (gateway.exec_approval.*
contract), slash-confirm / clarify / update views, model+choice pickers,
thread creation, forum titles, voice acks, the response-truncation notice,
the unauthorized-slash security alert and the media upload-size notices all
read from platform.discord.*. Decorator-declared button labels are relabelled
in __init__ (80-char cap); embed titles cut at 256, select placeholders at
150, option label/description at 100. _UNAUTHORIZED is a lazy _unauthorized().

* i18n(cli): wire status-bar, stream, terminal mixins + terminal_input through t(); rename kwargs that shadow t(key)

* i18n: wire hermes_cli/cli_commands_mixin.py slash-command copy through t()

- 431 new leaves under cli.commands.<cmd>.* in locales/en.yaml; 12 rows reuse
  existing gateway.* keys (rollback, diff, resume, branch, btw, model, reasoning)
  via a _gt() helper so CLI and gateway replies stay identical.
- Module-level English tables (_BUSY_MODE_*, _REASONING_TOGGLES, _HATCH_PROGRESS,
  _DIFF_LABELS, _LOCAL_ENGINE_LINES) become call-time catalog lookups keyed by id.
- Verb tables (Enabling/Disabling, Paused/Resumed/Triggered, planned/done,
  Updating/Generating) are one full template per variant; plurals use
  <key>_one/<key>_other via _tn(); hand-padded column labels (/snapshot list)
  translate the value and re-pad at the call site.
- Multi-line usage blocks are single catalog values split with _lines().
- Model-facing system notes and DB-stored reasons stay English (EXCLUDED).

* tests: assert /handoff, /worktree, /login CLI copy via t(key) instead of pinned English

* test(i18n): pin Telegram/Discord adapter catalog wiring

Lazy unauthorized notice, exec-approval contract keys, HTML escaping before
Telegram <b> wrapping, 200-char toast / 256-char BotCommand caps, Discord
100-char app-command text and 80-char button caps, and language-bearing
command-menu fingerprints on both platforms.

* i18n: reconcile cli.shared on/off vs enabled/disabled after lane merge

* i18n: describe() in TUI-gateway slash listings; localize TUI exit resume hint

* i18n(tr): translate bundled catalog + tui pack

* i18n(ja): translate bundled catalog + tui pack

* i18n(ko): translate bundled catalog + tui pack

* i18n(zh): translate bundled catalog + tui pack

* i18n(fr): translate bundled catalog + tui pack

* i18n(af): translate bundled catalog + tui pack

* i18n(uk): translate bundled catalog + tui pack

* i18n(ar): translate bundled catalog + tui pack

* i18n(pt): translate bundled catalog + tui pack

* i18n(it): translate bundled catalog + tui pack

* i18n(es): translate bundled catalog + tui pack

* i18n(zh-hant): translate bundled catalog + tui pack

* i18n(ru): translate bundled catalog + tui pack

* i18n(hu): translate bundled catalog + tui pack

* i18n(hu): translate pre-existing English-valued leftovers (kanban wake, /context, /status, fast labels)

* i18n(de): translate bundled catalog + tui pack

* i18n(ga): translate bundled catalog + tui pack

* test(i18n): fixture matches _normalize_lang(lang, home) signature

* i18n(tui): scaffold userMessages/slashCmd en siblings

* i18n(tui): wire secure prompts + content tables

* feat(tui): i18n — wire billing, subscription, connection-setup and journey overlays

Adds en siblings billing.ts / subscription.ts / connection.ts (namespaces
billing, subscription, connection, journey) and routes every user-facing
literal in billingOverlay, subscriptionOverlay, connectionSetupOverlay and
journey through useT()/messages(). Module-level label tables became lazy
(scopeStillDeniedResult(), verbOf(T, action)); auto-reload rows dispatch on
stable ids instead of label text. Regenerates locales/_keys.tui.json.

* i18n(tui): wire slash ops/wake replies

* i18n(tui): wire pickers (modelPicker, activeSessionSwitcher, petPicker)

* i18n(tui): wire slash core/debug/setup replies

* i18n(tui): wire hubs (agents overlay/panel/controls, skills, plugins)

* i18n(tui): wire slash session/topup/subscription replies

* i18n(tui): wire chat bits (branding, thinking, messageLine, loaders, todo, queued, banner, entry)

* i18n(tui): register t3 siblings (pickers, hubs, secure, content, chatBits) and regenerate keys

* i18n(tui): wire userMessages copy through the userMessages namespace

* i18n(tui): lazy-copy test for userMessages, regenerate _keys.tui.json

* i18n(tui): wire session/gateway/lib text through the TUI catalog (lane t2)

Adds en siblings session.ts, gatewayMsg.ts, libText.ts (namespaces session,
gatewayMsg, libText) and routes user-facing literals in app/{useMainApp,
useSessionLifecycle,useInputHandlers,turnController,createServerRequestHandler,
setupHandoff,createGatewayEventHandler}.ts, gatewayClient displayed reasons,
lib/*, domain/*, hooks/* through t()/messages(). Status-bar state values that
code compares against, backend-matched strings, log lines, model-bound text,
and machine 'error:' prefixes stay literal. Regenerates locales/_keys.tui.json
(232 keys).

* i18n: serve bundled locales/<lang>.tui.yaml under overlay/packs; TUI pack parity test; regen _keys.tui.json (1250)

* i18n: translate pre-existing English stubs in bundled locales (424 leaves, 14 locales)

* tui: i18n-export-en script (English templates for pack translators)

* docs(i18n): bundled TUI packs are the bottom layer of the tui surface

* i18n(ru): translate TUI pack

* i18n(ar): translate TUI pack

* i18n(es): translate TUI pack

* i18n(pt): translate TUI pack

* i18n(ko): translate TUI pack

* i18n(de): translate TUI pack

* i18n(ja): translate TUI pack

* i18n(fr): translate TUI pack

* i18n(tr): translate TUI pack

* i18n(it): translate TUI pack

* i18n(zh): translate TUI pack

* i18n(zh-hant): translate TUI pack

* i18n(hu): translate TUI pack

* i18n(uk): translate TUI pack

1,169 missing keys translated; 81 pre-existing kept byte-identical. Parity OK missing=0 extra=0 placeholder_mismatch=0 empty=0.

Deliberately identical to en: chatBits.branding.mcpSummary ({0} MCP), chatBits.thinking.agentsHint ((/agents)), session.main.voiceStt (◉ STT), session.main.voiceTtsSuffix ( [tts]), slashCmd.core.help.tuiSection (TUI), slashCmd.core.history.hermesTag (Hermes #{0}), slashCmd.debug.heapdump.heapPath (heapdump: {0}), slashCmd.debug.mem.rss (rss), subscription.stepUp.title (Remote Spending — product feature name, as in core catalog), content.faces.* (glyph-only kaomoji).

* i18n(ga): translate TUI pack

* i18n(af): translate TUI pack

* plugin_guard: locale catalogs in language packs step down the agent-config family

A translated status line such as "Updating AGENTS.md" in locales/<lang>.yaml is UI text the loader
reads as a string leaf; it cannot edit a file. The bundled en.yaml itself tripped agent_config_mod
at critical, making any faithful language pack uninstallable. Injection shapes keep full severity.

* plugin_validate_locales: read key exports with utf-8-sig (Windows footgun lint)

* i18n(relay): route relay adapter prompt copy through t(); drop dead import-bound approval header

Adds platform.relay.* (5 keys) to en and all 16 bundled locales, reusing the sibling platform
translations for the confirm buttons and the Other option.

* ci: fix TUI import order, MDX table pipe, main's overflow-warning wording in all locales; fresh-install fixture carries the i18n kernel

- ui-tui/src/i18n/en.ts: perfectionist/sort-imports (slash before slashCmd)
- docs plugins/index.md: escape the | inside the provides_locales table cell (MDX parsed <id> as JSX)
- display.notice.uncompressed_context_overflow: adopt main's wording (names compression.enabled: false
  and /compact) in en + 16 locales; the guardrail test pins that phrase
- tests/scripts/test_fresh_source_install.py: the installer tail now resolves CLI text through
  agent.i18n, so the fixture tree carries the i18n kernel + en.yaml (not the agent runtime)

* docs(desktop-plugin-sdk): double-backtick the template-literal example (MDX evaluated ${n})

* test(e2e): display.language is validated against the live language set; exclude it from the arbitrary-string set property

* commands: keep the localized COMMANDS/COMMANDS_BY_CATEGORY module __getattr__ after the compat block removal

* build: never write locales/_keys.*.json from the desktop/TUI builds; regenerate the committed desktop key export

The desktop build regenerated locales/_keys.desktop.json in the checkout, so a
hermes update that rebuilt the app left the tree dirty (Desktop update E2E:
'M locales/_keys.desktop.json'). The key exports are committed artifacts pinned
to en.ts by apps/desktop/scripts/i18n-keys.test.mjs and ui-tui i18n:keys:check;
builds read them, never write them. Regenerated after main's new desktop strings.

* test: unbreak two main-red timing tests the PR merge-ref inherits

- test_local_runtime racing fake publishes the modern state record (legacy pid-only
  records are rejected since 65ff3ad353; main has been red on this test since)
- test_run_progress_topics ManyProgressLinesAgent waits for the first bubble instead of
  a fixed 0.35s, which a loaded CI runner does not always meet

* chore(i18n): regenerate desktop key catalog for main's new strings (model pricing, copy changelog)

* test(e2e): torture-chamber fd monitor confirms a deleted sidecar is still held before calling it a leak

SQLite's WAL last-close unlinks -shm before closing its descriptor (unixShmUnmap, then
unixShmPurge), so a healthy close shows a (deleted) -shm for microseconds; the 20ms poll
occasionally caught that window on the short-lived opener and failed the episode.

* chore(i18n): regenerate desktop key catalog for main's telemetry/consent strings

* chore(i18n): regenerate desktop key catalog after main sync

---------

Co-authored-by: Teknium <teknium@nousresearch.com>
2026-09-28 14:16:18 -07:00

1834 lines
105 KiB
Python

"""Startup sequence, resume/restore and handoff methods for GatewayRunner.
Split out of ``gateway/run.py``; bound onto ``GatewayRunner`` via the MRO.
``gateway.run`` internals are imported lazily inside method bodies (import cycle),
so ``patch("gateway.run.X")`` keeps intercepting them at call time.
"""
from __future__ import annotations
import asyncio
import dataclasses
import faulthandler
import logging
import os
import signal
import time
from contextlib import nullcontext, suppress
from contextvars import copy_context
from pathlib import Path
from agent.i18n import t
from gateway.config import Platform
from gateway.delivery import looks_like_telegram_private_chat_id
from gateway.platforms.base import BasePlatformAdapter
from gateway.platforms.event import MessageEvent, MessageType
from gateway.session import SessionSource, build_session_key
from gateway.restart import (
DEFAULT_GATEWAY_CRON_DRAIN_TIMEOUT, GATEWAY_FATAL_CONFIG_EXIT_CODE, is_global_startup_conflict
)
from gateway.run_shutdown import _log_suppressed, _send_error
from gateway.shutdown_watchdog import (
DEFAULT_HEARTBEAT_INTERVAL_S, DEFAULT_LOOP_WATCHDOG_INTERVAL_S,
DEFAULT_LOOP_WATCHDOG_MAX_STRIKES, DEFAULT_LOOP_WATCHDOG_TIMEOUT_S, loop_heartbeat_forever,
)
from typing import Any, Dict, Optional, Tuple
# Log-record parity with the origin module.
logger = logging.getLogger("gateway.run")
class GatewayStartupMixin:
"""Startup sequence, resume/restore and handoff methods for GatewayRunner."""
@staticmethod
def _log_agent_budget() -> None:
"""Report the ENFORCED per-turn budget: ``agent.max_turns`` is bridged into
``HERMES_MAX_ITERATIONS`` before this runs, so the env slot already carries the config value;
resolve it the same way the turn loop does (``none``/``unlimited`` spellings included) instead of
``int()`` on the raw string with an invented ``500`` default (#116888)."""
from hermes_cli.config import TURN_LIMIT_UNLIMITED, resolve_turn_limit
limit = resolve_turn_limit(os.getenv("HERMES_MAX_ITERATIONS"))
logger.info("Agent budget: max_iterations=%s (agent.max_turns from config.yaml, else the HERMES_MAX_ITERATIONS bridge)",
"unlimited" if limit == TURN_LIMIT_UNLIMITED else limit)
# A configured platform failed non-retryably this boot and is parked: every "we are serving"
# status stamp (startup, drain release, scale-to-zero wake) must say ``degraded``, not ``running``.
_startup_parked_platforms: bool = False
def _serving_state(self) -> str:
return "degraded" if self._startup_parked_platforms else "running"
async def _run_startup_resume_event(
self, adapter: BasePlatformAdapter, event: MessageEvent, session_key: str,
) -> None:
"""Dispatch one synthetic startup resume and wait for its agent turn (inbound stays queued
until it finishes, else a user message can race it)."""
from gateway.run import _AGENT_PENDING_SENTINEL
try:
await adapter.handle_message(event)
session_tasks = getattr(adapter, "_session_tasks", {})
task = session_tasks.get(session_key) if isinstance(session_tasks, dict) else None
if task is not None:
await asyncio.shield(task)
finally:
# Release the pre-claimed slot if handle_message raised before _handle_message took ownership.
_pre_state = self._peek_session_state(session_key)
if (_pre_state.turn.agent if _pre_state else None) is _AGENT_PENDING_SENTINEL:
self._release_running_agent_state(session_key)
def _queue_startup_restore_event(self, event: MessageEvent) -> None:
queue = getattr(self, "_startup_restore_queue", None)
if queue is None:
queue = self._startup_restore_queue = []
queue.append(event)
with suppress(Exception):
source = event.source
logger.info(
"Queued inbound message during gateway startup restore: platform=%s chat=%s",
source.platform.value if source and source.platform else "unknown",
source.chat_id if source else "unknown",
)
async def _drain_startup_restore_queue(self) -> int:
"""Replay inbound messages queued while startup auto-resume ran."""
drained = 0
queue = getattr(self, "_startup_restore_queue", None) or []
while queue:
event = queue.pop(0)
try:
source = getattr(event, "source", None)
adapter = self._intake_adapter_for(source)
if adapter is None:
logger.debug(
"Dropping startup-restore queued message: adapter unavailable for %s",
getattr(getattr(source, "platform", None), "value", None),
)
continue
# Mark the replay so _handle_message does not re-queue it while the restore gate is closed.
with suppress(Exception):
setattr(event, "_hermes_startup_restore_replay", True)
await adapter.handle_message(event)
except Exception:
# One bad replay must not abort the drain: the remaining queued
# events still deserve their turn, and a raise here used to skip
# the gate release in _finish_startup_restore entirely.
logger.warning("Startup-restore queued replay failed; continuing drain", exc_info=True)
continue
drained += 1
return drained
@staticmethod
def _start_free_tier_bootstrap() -> None:
"""One bootstrap per process. `run_bootstrap` already records its own failure in the boot record
and never raises, so this is a plain call; it exists as a method so tests can seam it."""
from hermes_cli.free_tier_bootstrap import run_bootstrap
run_bootstrap(announce=False)
def _start_startup_warmup(self) -> None:
"""Kick off the boot turn-machinery warm-up so it overlaps the network-bound platform
connects; ``_finish_startup_restore`` awaits it (bounded)."""
from gateway.run import _startup_warmup_timeout_secs
if _startup_warmup_timeout_secs() <= 0:
self._startup_warmup_task = None
return
self._startup_warmup_task = asyncio.ensure_future(self._warm_turn_prerequisites())
async def _run_boot_probe_in_launch_scope(self, fn):
"""Run a boot-time probe on the default executor under the LAUNCH profile's scope when
multiplexing (the ``_discover_gateway_mcp_tools`` shape). Boot probes (``check_fn``s, the
free-tier bootstrap) read profile-scoped secrets; an unscoped read under multiplex fails
closed, so routing overrides resolve as absent and default routing applies. ``copy_context``
carries the contextvars across the executor hop; single-profile keeps environ semantics."""
loop = asyncio.get_running_loop()
if getattr(self.config, "multiplex_profiles", False):
from gateway.run import _async_profile_runtime_scope
from hermes_constants import get_hermes_home
try:
async with _async_profile_runtime_scope(get_hermes_home()):
return await loop.run_in_executor(None, copy_context().run, fn)
except Exception:
# Same fallback as load_gateway_config_for_runner: a scope that cannot be built must not
# abort startup; the probe runs unscoped as it did before.
logger.debug("multiplex launch-scope entry failed for boot probe %s; running unscoped",
getattr(fn, "__name__", fn), exc_info=True)
return await loop.run_in_executor(None, copy_context().run, fn)
async def _run_free_tier_bootstrap(self) -> None:
"""The free-tier bootstrap mints the Portal identity through the same profile-scoped routing
overrides the warm-up resolves, so it takes the same launch-profile binding."""
await self._run_boot_probe_in_launch_scope(self._start_free_tier_bootstrap)
async def _warm_turn_prerequisites(self) -> None:
"""Initialize turn machinery on an executor thread before the gate opens. Never raises: a
failed warm-up degrades to lazy init and must not block startup."""
from gateway.run import _warm_turn_machinery_sync
with _log_suppressed(
logging.WARNING, "Turn-machinery warm-up failed; first inbound turn will initialize lazily",
exc_info=True,
):
t0 = time.monotonic()
tool_count = await self._run_boot_probe_in_launch_scope(_warm_turn_machinery_sync)
logger.info(
"Turn machinery warmed in %.1fs (%d tool schema(s) materialized)",
time.monotonic() - t0, tool_count,
)
async def _await_startup_warmup(self) -> None:
"""Bounded wait for the boot warm-up. On timeout the gate opens anyway (availability outranks
prompt completeness for a WEDGED init); the warm-up continues and a late failure is logged."""
from gateway.run import _startup_warmup_timeout_secs
task = getattr(self, "_startup_warmup_task", None)
if task is None or task.done():
return
timeout = _startup_warmup_timeout_secs()
if timeout <= 0:
return
await self._wait_bounded_or_release(
{task}, timeout,
"Turn-machinery warm-up still running after %.0fs; opening inbound gate anyway — the "
"first turn may see lazily initialized machinery (#99373). Warm-up continues in the background.",
"boot turn-machinery warm-up failed after gate release", level=logging.DEBUG,
)
async def _wait_bounded_or_release(
self, tasks: set, timeout: float, warn_fmt: str, late_msg: str, *,
level: int = logging.WARNING, track: bool = False,
) -> set:
"""``asyncio.wait`` (which, unlike wait_for/gather+timeout, does NOT cancel on timeout) with
the gate-release warning + late-failure callback every boot gate uses. Returns ``done``.
``warn_fmt`` takes ``%.0fs`` (timeout) and optionally ``%d`` (pending count). A non-positive
``timeout`` opts out of the bound ("wait forever")."""
if timeout <= 0:
await asyncio.gather(*tasks, return_exceptions=True)
return set(tasks)
done, pending = await asyncio.wait(tasks, timeout=timeout)
if pending:
args = (timeout, len(pending)) if warn_fmt.count("%") > 1 else (timeout,)
await asyncio.to_thread(logger.warning, warn_fmt, *args)
late = self._late_failure_callback(late_msg, level=level)
for task in pending:
task.add_done_callback(late)
if track:
self._retain_background_task(task)
return done
async def _finish_startup_restore(self) -> None:
"""Wait (BOUNDED by ``_startup_restore_drain_timeout_secs``) for startup auto-resume, then
release + drain inbound. On timeout the gate opens and resume turns finish in the background
(NOT cancelled) — safe because ``_schedule_resume_pending_sessions`` claims each
``_running_agents`` slot SYNCHRONOUSLY first, so drained inbound queues behind."""
from gateway.run import _startup_restore_drain_timeout_secs
drained = 0
try:
tasks = list(getattr(self, "_startup_restore_tasks", []) or [])
if tasks:
# Tasks outliving the gate get a late-failure callback (their done-callback only discards them).
done = await self._wait_bounded_or_release(
set(tasks), _startup_restore_drain_timeout_secs(),
"Startup-restore gate released after %.0fs with %d boot auto-resume turn(s) "
"still running; draining inbound queue now (resume slots already claimed, so no "
"duplicate agents). Slow turn(s) continue in the background.",
"background startup auto-resume task failed after gate release", level=logging.DEBUG,
)
report = self._late_failure_callback("startup auto-resume task failed", level=logging.DEBUG)
for task in done:
report(task)
self._startup_restore_tasks = []
# Warm the turn machinery BEFORE the queue drains: inbound turns must not build skeleton prompts.
await self._await_startup_warmup()
drained = await self._drain_startup_restore_queue()
finally:
# The inbound gate must open no matter what raised above it (bounded wait, warm-up,
# drain): a stuck _startup_restore_in_progress would queue every non-internal inbound
# forever (run_inbound.py reads this flag first). See #116514.
self._startup_restore_in_progress = False
if drained:
logger.info("Drained %d inbound message(s) queued during startup restore", drained)
@staticmethod
def _late_failure_callback(message: str, *, level: int = logging.WARNING):
"""Done-callback for boot-path tasks that outlive the startup-restore gate: surface a late
failure otherwise swallowed once the task leaves ``_background_tasks``. Cancellation is
expected (shutdown), not an error."""
def _report(task: "asyncio.Task") -> None:
if task.cancelled():
return
exc = task.exception()
if exc is not None:
logger.log(level, message, exc_info=(type(exc), exc, exc.__traceback__))
return _report
async def _await_startup_boot_sends(self, *, planned_restart_notification_pending: bool) -> None:
"""Run boot-path sends without letting them pin the inbound restore gate (one Telegram
flood-control sleep must not freeze inbound on every platform): same bounded wait as the
resume gate, sends finish in the background on timeout. The ledger claim + ``resume_pending``
clear run INLINE before the send task exists — deferring it let a hung notification expire the
gate with zero rows claimed, so answered turns were replayed AND redelivered.
``_send_restart_notification`` and ``_redeliver_pending_obligations`` used to be awaited inline
*before* ``_finish_startup_restore`` released the gate. See #91969.
"""
from gateway.run import _startup_restore_drain_timeout_secs
claimed = await self._claim_pending_obligations()
async def _boot_sends() -> None:
await self._send_restart_notification()
if planned_restart_notification_pending:
await self._replay_pending_planned_restart_notification()
await self._redeliver_claimed_obligations(claimed)
boot_task = asyncio.create_task(_boot_sends())
timeout = _startup_restore_drain_timeout_secs()
if timeout <= 0:
await boot_task # unbounded: a failing send surfaces here (unlike the gate path)
return
await self._wait_bounded_or_release(
{boot_task}, timeout,
"Boot-path sends still running after %.0fs; releasing inbound gate so other platforms are not "
"frozen. Restart notification / obligation redelivery continue in the background.",
"background boot-path send failed after gate release: see traceback", track=True,
)
async def _clear_resume_pending_for_claimed_obligations(
self, claimed: list, *, require_success: bool = False
) -> list:
"""Clear resume flags and return rows safe to redeliver. Startup recovery is best-effort;
runtime reconnect recovery (``require_success``) is stricter: if the session-store write
fails the response must not be sent, or the turn could be resumed too."""
sendable = []
for row in claimed:
session_key = row.get("session_key") or ""
if not session_key:
sendable.append(row)
continue
try:
await self.async_session_store.clear_resume_pending(session_key)
except Exception:
logger.debug("clear_resume_pending failed for %s", session_key, exc_info=True)
if require_success:
continue
sendable.append(row)
return sendable
async def _claim_pending_obligations(self) -> list:
"""Claim recoverable delivery-ledger rows and clear their ``resume_pending`` flags (pure DB
work, no sends). Must run INLINE BEFORE ``_schedule_resume_pending_sessions`` and the
abandonable boot-send task: these sessions already produced their answer, so the resume path
must not re-run (re-pay for) the turn however long the sends take. Mid-send / rejected rows
carry a visible recovered-reply marker (gateway/delivery_ledger.py). Returns the rows.
A session with a recoverable obligation already produced its answer — the turn completed and only
delivery is owed — so clearing ``resume_pending`` here prevents the resume path from re-running (and
re-paying for) a turn whose output we hold, regardless of how long the sends ahead of redelivery
take (#91969). Flood-refused rows adopted inside their wait come back flagged ``adopted``: their
flags are cleared here too, and ``_redeliver_claimed_obligations`` leaves them to the timer.
"""
try:
from gateway.delivery_ledger import ledger_enabled, sweep_recoverable
if not await asyncio.to_thread(ledger_enabled):
return []
# Claim only rows whose exact transport owner is connected: platform-only filtering would spend
# a disconnected bot's retry budget because another bot on that platform is online.
_profile_adapters = getattr(self, "_profile_adapters", None) or {}
_pval = lambda p: getattr(p, "value", str(p)) # noqa: E731
_deliverable_targets = {(_pval(p), "default") for p in self.adapters}
# Legacy rows (no adapter_profile) are unambiguous only without multiplexing; else fail closed.
if not _profile_adapters:
_deliverable_targets.update((_pval(p), None) for p in self.adapters)
for _profile, _adapters in _profile_adapters.items():
_deliverable_targets.update((_pval(p), _profile) for p in _adapters)
claimed = await asyncio.to_thread(
sweep_recoverable, None,
deliverable_platforms={platform for platform, _ in _deliverable_targets},
deliverable_targets=_deliverable_targets,
)
except Exception:
logger.debug("delivery ledger sweep failed", exc_info=True)
return []
if not claimed:
return []
# Clear resume_pending for EVERY claimed row before any send: the answer is in the ledger.
# Claiming already spent one of the row's redelivery attempts — the answer is in the ledger, so the
# resume path must never re-run these turns (#91969).
await self._clear_resume_pending_for_claimed_obligations(claimed)
return claimed
@staticmethod
async def _release_runtime_claim_quiet(obligation_id, log_fmt: str, error: str = "send_path_degraded") -> None:
"""Release an unsent runtime delivery-ledger claim; log-only on failure. ``error`` is what the row
goes back to ``failed`` with: the claim's own pre-claim error when the caller knows it, so a
flood-refused row keeps its ``flood_control:<seconds>`` and stays on the flood timer's list (the
release re-stamps ``updated_at``, so it waits the platform's figure once more); else
``send_path_degraded``."""
from gateway.delivery_ledger import release_runtime_claim
try:
await asyncio.to_thread(release_runtime_claim, obligation_id, error)
except Exception:
logger.debug(log_fmt, obligation_id, exc_info=True)
def _schedule_flood_redelivery(self, platform, *, profile: Optional[str] = None) -> None:
"""Wake one deadline-driven ledger worker per bot identity, never sleep in a send."""
from gateway.delivery_ledger import flood_retry_delay, pending_retries
target = platform if isinstance(platform, Platform) else Platform(str(platform))
key = (target.value, profile or "default")
pending = getattr(self, "_flood_redelivery_tasks", None)
if pending is None:
pending = self._flood_redelivery_tasks = {}
self._flood_redelivery_wakes = {}
wakes = self._flood_redelivery_wakes
if key in pending:
# Remember refusals arriving during a threaded SELECT or a send. An empty stale
# snapshot cannot retire this worker until it has observed the wake.
wakes[key].set()
return None
wake = wakes[key] = asyncio.Event()
async def _redeliver_after_wait():
try:
while getattr(self, "_running", False):
wake.clear()
waiting = await asyncio.to_thread(pending_retries)
deadlines = [r["not_before"] for r in waiting
if (r["platform"], r["profile"]) == key]
if not deadlines:
if wake.is_set():
continue
return
delay = flood_retry_delay(min(deadlines) - time.time())
try:
await asyncio.wait_for(wake.wait(), timeout=delay)
continue # A shorter sibling may now be due first.
except asyncio.TimeoutError:
pass
if getattr(self, "_running", False):
await self._redeliver_failed_obligations_for_platform(target, profile=profile)
finally:
pending.pop(key, None)
wakes.pop(key, None)
task = asyncio.create_task(_redeliver_after_wait(), name="flood-redelivery:%s:%s" % key)
pending[key] = task
# The gateway's ordinary shutdown drain must cancel sleeping timers too.
background = getattr(self, "_background_tasks", None)
if background is not None:
self._track_task_in(background, task)
async def _arm_flood_timers_for_waiting_rows(self) -> None:
"""Recover adopted, newly refused/rejected and unsent released rows without blocking the loop."""
from gateway.delivery_ledger import pending_retries
for row in await asyncio.to_thread(pending_retries):
self._schedule_flood_redelivery(row["platform"], profile=row["profile"])
async def _redeliver_claimed_obligations(self, claimed: list) -> int:
"""Redeliver final responses for claimed rows (network half of the split): runs inside the
bounded boot-send task, so a flood-limited send can be abandoned by the restore gate without
reopening the turn-replay window. Returns the redelivered count."""
# No early return on an empty claim: the boot sweep may have ADOPTED flood-refused rows that are
# not due yet, and those still need their timer armed below.
try:
from gateway.delivery_ledger import RECOVERED_MARKER, mark_delivered, mark_failed
except Exception:
logger.debug("delivery ledger import failed", exc_info=True)
return 0
redelivered = 0
for row in claimed:
if row.get("adopted"):
# Adopted at boot inside its flood wait: its resume flag is cleared with the others, and
# the timer armed below sends it once the platform's deadline has passed.
continue
adapter = await self._obligation_adapter(row)
if adapter is None:
continue
content = row["content"]
if row.get("needs_marker"):
content = row.get("marker", RECOVERED_MARKER) + content
metadata = {"thread_id": row["thread_id"]} if row.get("thread_id") else None
try:
result = await adapter.send(chat_id=row["chat_id"], content=content, metadata=metadata)
except Exception as send_err:
logger.warning("obligation %s: redelivery send raised: %s", row["obligation_id"], send_err)
result = None
with _log_suppressed(logging.DEBUG, "delivery ledger update failed", exc_info=True):
if result is not None and getattr(result, "success", False):
await asyncio.to_thread(mark_delivered, row["obligation_id"])
redelivered += 1
logger.info(
"Redelivered recovered final response to %s:%s (obligation %s, attempt %d)",
row["platform"], row["chat_id"], row["obligation_id"], row["attempts"],
)
else:
await asyncio.to_thread(
mark_failed, row["obligation_id"], str(getattr(result, "error", "") or "send failed")
)
# Whatever is still waiting on a flood penalty or a retry backoff (adopted at boot, skipped as not
# yet due, refused again just now) gets a timer, so no rejected reply waits for the next restart.
with _log_suppressed(logging.DEBUG, "arming flood redelivery timers failed", exc_info=True):
await self._arm_flood_timers_for_waiting_rows()
return redelivered
async def _obligation_adapter(self, row: dict):
"""Resolve the adapter for a claimed ledger row, or None when it cannot be delivered now."""
try:
platform = Platform(row["platform"])
except Exception:
logger.debug("obligation %s: unknown platform %r", row["obligation_id"], row.get("platform"))
return None
if "profile" in row:
adapter = self._authorization_adapter(platform, row.get("profile"))
else:
# Startup rows preserve the historical default-adapter route.
adapter = self.adapters.get(platform)
# A claim (runtime or boot) whose adapter vanished before dispatch was never sent: release it
# without spending an attempt so the reconnect sweep, which only takes 'failed' rows, delivers it
# instead of it waiting 'attempting' for the next restart.
# Only a flood row keeps its error (the platform's wait must be honoured); any other row
# becomes reconnect-only, or the redelivery timer would claim and release it until the
# adapter is back.
if adapter is None:
from gateway.delivery_ledger import is_flood_error
last_error = row.get("last_error")
await self._release_runtime_claim_quiet(
row["obligation_id"], "failed to release undispatched runtime obligation %s",
error=last_error if is_flood_error(last_error) else "send_path_degraded",
)
return adapter
async def _redeliver_pending_obligations(self) -> int:
"""Claim + redeliver in one call. Stable shape for tests/external callers; the startup path
calls the halves separately so the DB half runs inline before the abandonable send task."""
return await self._redeliver_claimed_obligations(await self._claim_pending_obligations())
async def _redeliver_failed_obligations_for_platform(
self, platform: Platform, *, profile: Optional[str] = None,
) -> int:
"""Replay one adapter identity's transient failures after reconnect: the startup sweep cannot
claim live-owner rows, so ``send_path_degraded`` responses would otherwise stay failed until
the next restart. Best-effort; reuses the startup redelivery contract."""
try:
from gateway.delivery_ledger import ledger_enabled, sweep_failed_for_runtime
if not await asyncio.to_thread(ledger_enabled):
return 0
claimed = await asyncio.to_thread(sweep_failed_for_runtime, platform.value, profile=profile)
except Exception:
logger.debug(
"runtime delivery ledger sweep failed after %s reconnect", platform.value, exc_info=True,
)
return 0
if not claimed:
return 0
# Clear before any send so the reconnect path cannot both redeliver AND resume the same turn.
sendable = await self._clear_resume_pending_for_claimed_obligations(claimed, require_success=True)
sendable_ids = {row["obligation_id"] for row in sendable}
for row in claimed:
if row["obligation_id"] not in sendable_ids:
await self._release_runtime_claim_quiet(
row["obligation_id"], "failed to release runtime delivery claim %s",
error=row.get("last_error") or "send_path_degraded",
)
return await self._redeliver_claimed_obligations(sendable)
def _resume_pending_candidates(self, platform=None) -> Optional[list]:
"""Snapshot resume-pending entries (optionally scoped to ``platform``); None when
enumeration failed or the restart-loop breaker tripped for this boot."""
try:
with self.session_store._lock: # noqa: SLF001 — snapshot under lock
self.session_store._ensure_loaded_locked() # noqa: SLF001
candidates = [
entry for entry in self.session_store._entries.values() # noqa: SLF001
if entry.resume_pending
and not entry.suspended
and entry.origin is not None
and entry.resume_reason in self._AUTO_RESUME_REASONS
and (platform is None or entry.origin.platform == platform)
]
except Exception as exc:
logger.warning("Failed to enumerate resume-pending sessions: %s", exc)
return None
# Restart-loop breaker: only boots WITH restart-interrupted sessions count; when tripped, skip
# auto-resume for THIS boot only (inbound still served; sessions stay resume_pending).
if candidates:
try:
from gateway import restart_loop_guard as _rlg
_max_restarts, _window, _max_gap = self._restart_loop_guard_config()
if _rlg.check_and_record(_max_restarts, _window, max_gap_seconds=_max_gap):
return None
except Exception as exc: # noqa: BLE001 — breaker must fail OPEN
logger.debug("Restart-loop guard check skipped: %s", exc)
return candidates
def _resume_owner_authorized(self, session_key: str, source) -> bool:
"""Validate the session owner against the CURRENT allowlist: a session created before the
allowlist existed (or whose owner was since removed) must not silently receive a full agent
response just because it carries a resume marker."""
try:
if self._is_user_authorized_for_source(source):
return True
logger.warning(
"Skipping auto-resume for %s: session owner is no "
"longer authorized under the current allowlist", session_key,
)
except Exception as exc:
logger.warning("Skipping auto-resume for %s: authorization check failed: %s", session_key, exc)
return False
def _schedule_resume_pending_sessions(self, platform=None) -> int:
"""Auto-continue fresh restart-interrupted sessions: synthesize an empty-text turn (the
``_is_resume_pending`` injection path owns the wording). Sessions whose adapter is offline stay
``resume_pending`` for the reconnect watcher, which re-calls this scoped to that ``platform``;
sessions with a running agent are skipped so none is resumed twice."""
from gateway.run import (
_AGENT_PENDING_SENTINEL, _auto_continue_freshness_window, _is_fresh_gateway_interruption,
)
window = _auto_continue_freshness_window()
candidates = self._resume_pending_candidates(platform)
if candidates is None:
return 0
scheduled = 0
for entry in candidates:
# Epoch math: the marker was stamped naive-local by the previous process, possibly
# on the other side of a DST change; wall-clock subtraction is off by the shift.
marker = entry.last_resume_marked_at or entry.updated_at
if not _is_fresh_gateway_interruption(marker, window_secs=window):
continue
# Already being resumed (e.g. scheduled at startup, still in-flight) — no second turn.
if self._is_session_running(entry.session_key):
continue
source = self._restored_source(entry)
adapter = self._delivery_adapter_for(source)
if adapter is None:
logger.debug(
"Skipping auto-resume for %s: adapter not ready for %s", entry.session_key,
getattr(source.platform, "value", source.platform),
)
continue
if not self._resume_owner_authorized(entry.session_key, source):
continue
# Claim the slot *before* spawning so an inbound message arriving before the task's first
# await queues instead of building a duplicate AIAgent.
_resume_state = self._session_state(entry.session_key)
_resume_state.turn.agent = _AGENT_PENDING_SENTINEL
_resume_state.turn.started_ts = time.time()
self._persist_active_agents()
# Empty-text internal event: the _is_resume_pending branch prepends the reason-aware note.
event = MessageEvent(text="", message_type=MessageType.TEXT, source=source, internal=True)
task = self._retain_background_task(
asyncio.create_task(self._run_startup_resume_event(adapter, event, entry.session_key))
)
if getattr(self, "_startup_restore_in_progress", False):
tasks = getattr(self, "_startup_restore_tasks", None)
if tasks is None:
tasks = self._startup_restore_tasks = []
tasks.append(task)
scheduled += 1
if scheduled:
logger.info("Scheduled auto-resume for %d restart-interrupted session(s)", scheduled)
return scheduled
def _startup_should_abort(self) -> bool:
return self._restart_requested or self._draining or self._shutdown_event.is_set()
async def _startup_teardown_adapter(self, adapter, platform) -> None:
"""Cancel an adapter's background tasks (best-effort) then disconnect it."""
with _log_suppressed(logging.DEBUG, "✗ %s background-task cancel error: %s", platform.value):
await adapter.cancel_background_tasks()
await self._safe_adapter_disconnect(adapter, platform)
def _startup_retry_entry(self, platform, adapter, platform_config, *, queued: bool = True) -> dict:
"""``_failed_platforms`` entry for a platform that failed at startup (first retry in 30s)."""
return self._reconnect_queue_entry(platform, adapter, platform_config, attempts=1, delay=30, queued=queued)
async def _abort_startup_if_shutdown_requested(
self, adapter: Optional[BasePlatformAdapter] = None, platform: Optional[Platform] = None
) -> bool:
"""Clean up and exit startup when restart/shutdown begins mid-startup."""
if not self._startup_should_abort():
return False
if adapter is not None and platform is not None:
await self._startup_teardown_adapter(adapter, platform)
stop_task = self._stop_task
current_task = asyncio.current_task()
if stop_task is not None and stop_task is not current_task:
await stop_task
elif not self._shutdown_event.is_set():
await self.stop(
restart=self._restart_requested, detached_restart=self._restart_detached,
service_restart=self._restart_via_service,
)
return True
def _start_loop_liveness_guards(self, loop: asyncio.AbstractEventLoop) -> None:
"""Arm the selector floor and out-of-loop watchdog before adapters. Disabled entirely with
``gateway.loop_watchdog: false`` in config.yaml (config-only knob).
See #69089.
"""
from gateway.shutdown_watchdog import _arm_loop_floor_timer, start_loop_liveness_watchdog
config = getattr(self, "config", None)
if config is not None and not getattr(config, "loop_watchdog", True):
return
if getattr(self, "_loop_floor_timer_handle", None) is None:
with _log_suppressed(logging.DEBUG, "Failed to arm gateway loop floor timer", exc_info=True):
self._loop_floor_timer_handle = _arm_loop_floor_timer(loop)
watchdog = getattr(self, "_loop_liveness_watchdog", None)
if watchdog is None or not watchdog.is_alive():
try:
# getattr defaults cover config=None test paths; loaded values are already clamped.
self._loop_liveness_watchdog = start_loop_liveness_watchdog(
loop,
probe_interval=float(getattr(
config, "loop_watchdog_probe_interval_s", DEFAULT_LOOP_WATCHDOG_INTERVAL_S
)),
probe_timeout=float(getattr(
config, "loop_watchdog_probe_timeout_s", DEFAULT_LOOP_WATCHDOG_TIMEOUT_S
)),
max_strikes=int(getattr(
config, "loop_watchdog_max_strikes", DEFAULT_LOOP_WATCHDOG_MAX_STRIKES
)),
)
except Exception:
logger.debug("Failed to start gateway loop liveness watchdog", exc_info=True)
def _stop_loop_liveness_guards(self) -> None:
"""Disarm lifetime liveness guards before shutdown can load the loop — including the
heartbeat writer, which would otherwise make a draining gateway look healthy to probes."""
for attr, method, what in (
("_loop_liveness_watchdog", "stop", "stop gateway loop liveness watchdog"),
("_loop_floor_timer_handle", "cancel", "cancel gateway loop floor timer"),
("_loop_heartbeat_task", "cancel", "cancel gateway loop heartbeat task"),
):
guard = getattr(self, attr, None)
setattr(self, attr, None)
if guard is not None:
with _log_suppressed(logging.DEBUG, "Failed to %s", what, exc_info=True):
getattr(guard, method)()
async def _consume_clean_shutdown_marker(self, marker_path) -> int:
"""Discard orphan turn markers before consuming a clean-exit receipt. Raises (fail closed):
continuing with the old receipt would let a later unclean exit masquerade as clean."""
discarded = await self.async_session_store.discard_active_turn_markers()
marker_path.unlink()
return discarded
async def _recover_unclean_sessions(self) -> tuple[int, int]:
"""Recover only the turns the dead process left marked: one whose reply is already in the
transcript is owed delivery, not a new answer; any other resumes once. An unmarked session
finished its turn (the marker is held until the reply is ledgered), so nothing re-runs it —
the old 120 s recency sweep re-answered every recently active chat. Returns (resumed,
ledgered)."""
from gateway.run import _float_env
resumed = ledgered = 0
max_age = max(60 * 60, int(max(1.0, _float_env("HERMES_AGENT_TIMEOUT", 1800)) * 2))
with _log_suppressed(logging.WARNING, "Crash-left reply recovery on startup failed: %s"):
ledgered = await self._ledger_crash_left_replies(max_age)
with _log_suppressed(logging.WARNING, "Exact active-turn recovery on startup failed: %s"):
resumed = await self.async_session_store.recover_interrupted_turns(max_age_seconds=max_age)
return resumed, ledgered
async def _ledger_crash_left_replies(self, max_age_seconds: int) -> int:
"""Settle every marked turn whose final reply was persisted and clear its marker, so
auto-resume does not regenerate it: a reply live delivery would have suppressed is owed
nothing, any other goes to the delivery ledger for the boot sweep. Without the ledger a
presentable reply stays marked and resumes."""
from gateway.delivery_ledger import compute_obligation_id, ledger_enabled, record_crash_left_reply
ledger_on = await asyncio.to_thread(ledger_enabled)
cutoff = time.time() - max_age_seconds # older markers are cleared, never acted on
with self.session_store._lock: # noqa: SLF001 — snapshot under lock
self.session_store._ensure_loaded_locked() # noqa: SLF001
marked = [
(e.session_key, e.session_id, e.active_turn_token, e.active_turn_started_at, e.origin,
e.transport_profile)
for e in self.session_store._entries.values() # noqa: SLF001
if e.active_turn_token and e.active_turn_started_at and e.origin and not e.suspended
]
ledgered = 0
for key, session_id, token, started_at, origin, profile in marked:
started = started_at.timestamp() # aware UTC marker; a pre-upgrade naive one reads as local
if started < cutoff:
continue
text = self._crash_left_reply(await self.async_session_store.load_transcript(session_id),
started, origin)
if text is None or (text and not ledger_on):
continue # no final reply to deliver: the turn resumes
if text:
await asyncio.to_thread(
record_crash_left_reply,
obligation_id=compute_obligation_id(key, f"crash:{token}", text), session_key=key,
platform=str(getattr(origin.platform, "value", origin.platform)), chat_id=origin.chat_id,
thread_id=origin.thread_id, content=text, since=started, adapter_profile=profile)
if await self.async_session_store.clear_turn_active(key, token) and text:
ledgered += 1
return ledgered
def _crash_left_reply(self, history: list, started: float, origin) -> Optional[str]:
"""What a crash-left turn owes, judged as live delivery would have: ``None`` when it never
persisted a final reply after *started*; ``""`` when nothing would have been presented (a
silence marker on a machinery turn or on a turn the adapter reported as not addressed to the
bot, a muted diagnostic wake); else the text to send, with any other bare silence marker
replaced by the same notice the live path sends."""
from gateway.platforms.base import _strip_media_directives
from gateway.response_filters import (
is_intentional_silence_response, is_machinery_display_kind, silence_allowed,
)
from gateway.run import _sanitize_gateway_final_response
from gateway.run_turn import _unexpected_silence_reply
from gateway.warning_notifications import diagnostic_turn_muted
from hermes_cli.timefmt import coerce_epoch
visible = [m for m in history if m.get("role") not in ("session_meta", "system")]
last = visible[-1] if visible else {}
if (last.get("role") != "assistant" or last.get("tool_calls") or not isinstance(last.get("content"), str)
or (coerce_epoch(last.get("timestamp")) or 0) < started):
return None
prompt = next((m for m in reversed(visible) if m.get("role") == "user"), {})
if is_machinery_display_kind(prompt.get("display_kind")):
try: # the owning profile's display policy, as the adapter reads it at delivery
scope = self._media_delivery_scope_for_source(origin)
except Exception:
logger.debug("Crash-left reply: no routed scope for %s", origin.chat_id, exc_info=True)
scope = nullcontext()
with scope:
if diagnostic_turn_muted(prompt.get("display_metadata"), origin.platform):
return ""
if is_intentional_silence_response(last["content"]):
silent_ok = silence_allowed(
prompt.get("display_kind"), (prompt.get("display_metadata") or {}).get("reply_expected"))
return "" if silent_ok else _unexpected_silence_reply()
return _strip_media_directives(_sanitize_gateway_final_response(origin.platform, last["content"])).strip() or None
@staticmethod
def _start_hosted_room_worker_sync():
"""Start the local Group Chat worker without importing the dashboard."""
import tui_gateway.server # noqa: F401
from tui_gateway import methods_groups
service = methods_groups.get_hosted_room_service()
if service is None:
service = methods_groups.start_hosted_room_service()
if service is None:
raise RuntimeError("Group Chat worker has no bound session backend")
status = service.runtime.status()
if not status.get("running") or status.get("stopping"):
raise RuntimeError("Group Chat worker did not start")
return service
async def _ensure_hosted_room_worker(self):
return await asyncio.to_thread(self._start_hosted_room_worker_sync)
async def _hosted_room_worker_watcher(self, interval: float = 1.0) -> None:
"""Keep the room worker alive for the messaging gateway lifetime."""
while self._running:
await self._ensure_hosted_room_worker()
await asyncio.sleep(interval)
async def _stop_hosted_room_worker(self, timeout: float = 5.0) -> bool:
"""Pause room execution durably without interrupting accepted turns."""
from tui_gateway import methods_groups
return await asyncio.to_thread(methods_groups.stop_hosted_room_service, timeout=timeout)
def _start_loop_heartbeat_task(self) -> None:
"""Start the loop-liveness heartbeat task (idempotent, best-effort). An asyncio task so a
frozen loop stops refreshing ``state/gateway.heartbeat``; cancelled with the others in stop().
See #66892.
"""
with _log_suppressed(logging.DEBUG, "Failed to start gateway loop heartbeat", exc_info=True):
_existing_hb = getattr(self, "_loop_heartbeat_task", None)
if _existing_hb is not None and not _existing_hb.done():
return
task = self._loop_heartbeat_task = asyncio.create_task(
loop_heartbeat_forever(
interval_s=DEFAULT_HEARTBEAT_INTERVAL_S,
start_time=getattr(self, "_gateway_started_at", 0.0),
)
)
# PERMANENT watcher tag so the scale-to-zero idle check doesn't count it as busy forever.
task._hermes_supervised_watcher = True # type: ignore[attr-defined]
_bg = getattr(self, "_background_tasks", None)
if _bg is not None:
self._track_task_in(_bg, task)
def _open_faulthandler_log(self):
"""Open (append) ``<log_dir>/gateway_faulthandler.log``, creating the directory."""
from gateway.run import get_hermes_home
log_dir = getattr(self.config, "log_dir", None) or os.path.join(str(get_hermes_home()), "logs")
os.makedirs(log_dir, exist_ok=True)
return open(os.path.join(log_dir, "gateway_faulthandler.log"), "a", encoding="utf-8") # windows-footgun: ok (append log writer, not a read)
def _start_install_faulthandler(self) -> None:
"""Enable faulthandler (stderr or a log file) plus the SIGUSR2 stack-dump hook."""
# sys.stderr may be None (Windows VBS / pythonw / detached service): fall back to a log file.
try:
# Enable faulthandler for stack dumps on freezes/crashes (#70344). Falls back to a log file when
# sys.stderr is None (Windows VBS / pythonw / detached service) — otherwise the gateway would
# die here and take every adapter offline. See #71671.
faulthandler.enable()
except (RuntimeError, ValueError, OSError):
with _log_suppressed(logging.DEBUG, "faulthandler.enable() unavailable", exc_info=True):
faulthandler.enable(file=self._open_faulthandler_log(), all_threads=True)
# SIGUSR2 stack dump to file for service managers that drop stderr; POSIX-only.
# chain=False: SIGUSR2's default disposition is "terminate", so chaining to it
# dumps the stacks and then kills the gateway the operator was trying to inspect.
_sigusr2 = getattr(signal, "SIGUSR2", None)
if _sigusr2 is not None and hasattr(faulthandler, "register"):
with _log_suppressed(logging.DEBUG, "Could not set up faulthandler file logging", exc_info=True):
faulthandler.register(
_sigusr2, file=self._open_faulthandler_log(), all_threads=True, chain=False,
)
async def _start_log_startup_environment(self) -> None:
"""Bind the gateway loop, disarm the startup watchdog, and log the startup environment."""
try:
self._gateway_loop = asyncio.get_running_loop()
except RuntimeError:
self._gateway_loop = None
if self._gateway_loop is not None:
self._start_loop_liveness_guards(self._gateway_loop)
# Loop live: the loop-liveness watchdog takes over from the startup watchdog. Disarm even
# when loop guards are config-disabled; only inside this branch (no live loop = stay armed).
with _log_suppressed(logging.DEBUG, "Startup watchdog disarm failed", exc_info=True):
from hermes_startup_watchdog import disarm_startup_watchdog
disarm_startup_watchdog()
logger.info("Session storage: %s", self.config.sessions_dir)
self._start_log_systemd_timing_alignment()
self._start_log_retired_session_reset()
self._log_agent_budget()
# Warn prominently when redaction is opted out; the redactor snapshots its state at import time,
# so this line is the source of truth for the process lifetime.
with suppress(Exception):
# Redaction status: ON by default (#17691).
_redact_raw = os.getenv("HERMES_REDACT_SECRETS", "true")
if _redact_raw.lower() in {"1", "true", "yes", "on"}:
logger.info(
"Secret redaction: ENABLED (tool output, logs, and chat "
"responses are scrubbed before delivery)"
)
else:
logger.warning(
"Secret redaction: DISABLED (HERMES_REDACT_SECRETS=%s). API keys and tokens may appear "
"verbatim in chat output, session JSONs, and logs. Set security.redact_secrets: true "
"in config.yaml to re-enable.", _redact_raw,
)
with suppress(Exception):
from hermes_cli.profiles import get_active_profile_name
_profile = get_active_profile_name() # launch profile, pre-identity (boot log)
if _profile and _profile != "default":
logger.info("Active profile: %s", _profile)
try:
from gateway.status import write_runtime_status
persisted = await asyncio.to_thread(
write_runtime_status,
gateway_state="starting",
exit_reason=None,
clear_profile_platforms=True,
reload_existing=True,
wait_timeout=2.0,
)
if not persisted:
logger.warning("Timed out persisting initial gateway runtime status")
except Exception:
logger.debug("Initial gateway runtime-status write failed", exc_info=True)
with _log_suppressed(logging.DEBUG, "gateway health OTLP export startup failed", exc_info=True):
from hermes_cli.config import load_config
from agent.monitoring.gateway_health_export import start_gateway_health_export
self._gateway_health_export_runtime = start_gateway_health_export(load_config())
if getattr(self._gateway_health_export_runtime, "enabled", False):
logger.info("Gateway health OTLP export: enabled")
# Supply-chain advisories: log only (never block startup or surface to users; only the operator can act).
with _log_suppressed(logging.DEBUG, "security advisory check failed at gateway startup", exc_info=True):
from hermes_cli.security_advisories import detect_compromised, gateway_log_message
_adv_msg = gateway_log_message(detect_compromised())
if _adv_msg:
logger.warning("%s", _adv_msg)
logger.warning("Run `hermes doctor` on the gateway host for full remediation steps.")
def _start_log_retired_session_reset(self) -> None:
"""Warn per served profile whose config still declares an idle/daily ``session_reset``,
unless the plugin that honours it is enabled. Never raises."""
with _log_suppressed(logging.DEBUG, "retired session_reset check failed", exc_info=True):
from gateway.config_loader import read_yaml_layers
from hermes_cli.profiles import profiles_to_serve
from hermes_cli.session_reset_retirement import format_notice, reset_plugin_enabled, retired_reset_policy
hits = [(name, found) for name, home in profiles_to_serve(bool(self.config.multiplex_profiles))
if (found := retired_reset_policy(read_yaml_layers(home)))]
if hits and not reset_plugin_enabled():
for name, (path, mode) in hits:
logger.warning("Profile %s: %s", name, format_notice(path, mode))
def _start_log_systemd_timing_alignment(self) -> None:
"""Warn when systemd's TimeoutStopSec does not cover the drain window (a unit file from before
an upgrade may encode the old default, so SIGKILL hits mid-drain). Never raises."""
with _log_suppressed(logging.DEBUG, "check_systemd_timing_alignment failed: %s"):
from gateway.shutdown_forensics import check_systemd_timing_alignment
_alignment = check_systemd_timing_alignment(
self._restart_drain_timeout,
getattr(self, "_cron_drain_timeout", DEFAULT_GATEWAY_CRON_DRAIN_TIMEOUT),
)
if _alignment is not None and _alignment.get("mismatch"):
logger.warning(
"Stale systemd unit detected: %s has TimeoutStopSec=%.0fs but drain_timeout=%.0fs "
"cron_drain_timeout=%.0fs (expected >=%.0fs). systemd may SIGKILL the gateway "
"mid-drain. Run `hermes gateway install --force` to regenerate the unit, or shorten "
"agent.restart_drain_timeout / agent.cron_drain_timeout.",
_alignment.get("unit", "(unknown)"), _alignment["timeout_stop_sec"],
_alignment["drain_timeout"],
_alignment.get("cron_drain_timeout", DEFAULT_GATEWAY_CRON_DRAIN_TIMEOUT),
_alignment["expected_min"],
)
# Builtin platforms whose ``<P>_ALLOWED_USERS`` / ``<P>_ALLOW_ALL_USERS`` env vars count as an
# allowlist / open-access opt-in; plugin platforms are appended at check time.
_ALLOWLIST_ENV_PLATFORMS = (
"TELEGRAM", "DISCORD", "WHATSAPP", "WHATSAPP_CLOUD", "SLACK", "SIGNAL", "EMAIL", "SMS",
"MATTERMOST", "MATRIX", "DINGTALK", "FEISHU", "WECOM", "WECOM_CALLBACK", "WEIXIN",
"BLUEBUBBLES", "QQ", "YUANBAO",
)
_BUILTIN_ALLOWED_USERS_VARS = tuple(f"{p}_ALLOWED_USERS" for p in _ALLOWLIST_ENV_PLATFORMS) + (
"SIGNAL_GROUP_ALLOWED_USERS", "TELEGRAM_GROUP_ALLOWED_USERS",
"TELEGRAM_GROUP_ALLOWED_CHATS", "GATEWAY_ALLOWED_USERS",
)
_BUILTIN_ALLOW_ALL_VARS = tuple(f"{p}_ALLOW_ALL_USERS" for p in _ALLOWLIST_ENV_PLATFORMS)
def _start_check_access_policy(self) -> bool:
"""Warn about missing allowlists; return True when startup must be refused."""
from gateway.run import (
_OWN_POLICY_OPEN_ENV, _own_policy_open_startup_violation, _write_runtime_status_quiet
)
# Plugin platforms declare their own allowed_users_env / allow_all_env.
allowed_vars = list(self._BUILTIN_ALLOWED_USERS_VARS)
allow_all_vars = ["GATEWAY_ALLOW_ALL_USERS", *self._BUILTIN_ALLOW_ALL_VARS]
with suppress(Exception):
from gateway.platform_registry import platform_registry
entries = platform_registry.plugin_entries()
allowed_vars += [e.allowed_users_env for e in entries if e.allowed_users_env]
allow_all_vars += [e.allow_all_env for e in entries if e.allow_all_env]
# An API-server/webhook/local-only gateway has no messaging sender to gate, so the
# reminder would be unactionable monitoring noise (#115439).
non_messaging = {Platform.LOCAL, Platform.API_SERVER, Platform.WEBHOOK}
has_messaging = any(
cfg.enabled and platform not in non_messaging for platform, cfg in self.config.platforms.items()
)
if has_messaging and not any(os.getenv(v) for v in allowed_vars) and not any(
os.getenv(v, "").lower() in {"true", "1", "yes"} for v in allow_all_vars
):
logger.warning(
"No env user allowlists configured. Messaging platforms default to pairing/allowlist "
"policies and will deny unknown senders unless you configure platform allowlists (e.g., "
"TELEGRAM_ALLOWED_USERS=your_id) or explicitly opt in with GATEWAY_ALLOW_ALL_USERS=true "
"plus dm_policy/group_policy: open on the platform."
)
reason = _own_policy_open_startup_violation(self.config)
if reason:
platform_value = reason.split(":", 1)[0]
allow_all_env = next(
(env[2] for p, env in _OWN_POLICY_OPEN_ENV.items() if p.value == platform_value), None
)
logger.error(
"Refusing to start: %s has dm_policy/group_policy set to 'open' "
"but neither GATEWAY_ALLOW_ALL_USERS nor %s is enabled.", platform_value,
allow_all_env or "a platform allow-all flag",
)
_write_runtime_status_quiet(gateway_state="startup_failed", exit_reason=reason)
self._request_clean_exit(reason)
return True
return False
@staticmethod
def _start_register_plugins_relay_hooks() -> None:
"""Plugin discovery, relay registration and shell-hook/webhook registration. Never raises."""
# Discover plugins before shell hooks (plugin block decisions win ties). Explicit: the gateway
# lazily imports run_agent, so model_tools' discover_plugins() side-effect may not have run.
with _log_suppressed(logging.WARNING, "plugin discovery failed at gateway startup", exc_info=True):
from hermes_cli.plugins import discover_plugins
discover_plugins()
# Relay entrypoints share the effective profile opt-out, including when a
# deployment injects a URL. No URL or explicitly disabled -> no side effects.
try:
from gateway.relay import (
register_relay_adapter, relay_url, self_provision_relay, send_relay_policy
)
# Relay self-provision sets GATEWAY_RELAY_* in os.environ BEFORE registration reads them.
self_provision_relay()
if register_relay_adapter():
logger.info("relay adapter registered (connector at %s)", relay_url())
# Declare the relevance policy to the connector so the SAME behavior governs relay delivery.
send_relay_policy()
except Exception:
logger.warning("relay adapter registration failed at gateway startup", exc_info=True)
GatewayStartupMixin._register_launch_profile_config_hooks()
@staticmethod
def _register_launch_profile_config_hooks() -> None:
"""The launch profile's ``hooks:`` block, registered under ITS runtime scope when multiplexing.
Startup runs before any turn scope exists and ``get_secret`` fails closed outside a scope
while multiplexing is on, so the launch profile needs the scope secondaries already get
(``_start_secondary_profile_adapters``) or its ``secret_env`` targets cannot resolve.
"""
from agent.secret_scope import is_multiplex_active
if not is_multiplex_active():
GatewayStartupMixin._register_config_hooks(
"shell-hook/webhook registration failed at gateway startup", level=logging.WARNING)
return
from gateway.run import _profile_runtime_scope
from hermes_constants import get_process_hermes_home
with _profile_runtime_scope(get_process_hermes_home()):
GatewayStartupMixin._register_config_hooks(
"shell-hook/webhook registration failed at gateway startup", level=logging.WARNING)
@staticmethod
def _register_config_hooks(fail_fmt: str, *fail_args, level: int = logging.DEBUG) -> None:
"""Register declarative shell hooks + outbound webhooks from the CURRENT scope's config.
Gateway has no TTY, so consent must come from --accept-hooks, HERMES_ACCEPT_HOOKS, or
hooks_auto_accept: true; ``accept_hooks=False`` lets register_from_config resolve env + config.
Never raises (logged at ``level``).
"""
try:
from hermes_cli.config import load_config
from agent.shell_hooks import register_from_config
from agent.outbound_webhooks import register_from_config as register_outbound_webhooks
_hooks_cfg = load_config()
register_from_config(_hooks_cfg, accept_hooks=False)
register_outbound_webhooks(_hooks_cfg)
except Exception:
logger.log(level, fail_fmt, *fail_args, exc_info=True)
def _recover_secondary_process_checkpoints(self, process_registry) -> int:
"""Replay every SERVED secondary profile's ``processes.json`` under its own scope.
The launch profile's file was already read by ``recover_from_checkpoint`` above."""
if not getattr(self.config, "multiplex_profiles", False):
return 0
from gateway.run import _multiplex_profile_homes, _profile_runtime_scope
from hermes_constants import get_hermes_home
launch_home = get_hermes_home().resolve()
recovered = 0
for profile_name, profile_home in _multiplex_profile_homes(self.config):
if Path(profile_home).resolve() == launch_home:
continue
try:
with _profile_runtime_scope(Path(profile_home), {}):
recovered += process_registry.recover_from_checkpoint()
except Exception:
logger.warning("Process checkpoint recovery for profile %r failed", profile_name, exc_info=True)
return recovered
async def _start_recover_previous_run(self) -> None:
"""Plugins, relay, hooks, then crash/clean-exit recovery of processes and sessions."""
from gateway.run import _hermes_home
self._start_register_plugins_relay_hooks()
# Plugins that load later (force re-discovery, install/enable nudge) re-wire live adapters (#87770).
with _log_suppressed(logging.WARNING, "plugin re-wire subscription failed", exc_info=True):
from hermes_cli.plugins import get_plugin_manager
self._subscribe_plugin_rewire(get_plugin_manager())
self.hooks.discover_and_load()
# Recover background processes from checkpoint (crash recovery). ``_checkpoint_path`` is
# scope-relative, so a served secondary's turn wrote ITS home's processes.json; recover each
# served profile's file under its scope or those processes are never re-adopted.
with _log_suppressed(logging.WARNING, "Process checkpoint recovery: %s"):
from tools.process_registry import process_registry
recovered = process_registry.recover_from_checkpoint()
recovered += self._recover_secondary_process_checkpoints(process_registry)
if recovered:
logger.info("Recovered %s background process(es) from previous run", recovered)
# Recover the turns the last process left marked (in flight, or reply not yet ledgered).
# SKIP after a clean exit — the previous process already drained.
_clean_marker = _hermes_home / ".clean_shutdown"
if _clean_marker.exists():
logger.info("Previous gateway exited cleanly — skipping session suspension")
try:
discarded = await self._consume_clean_shutdown_marker(_clean_marker)
except Exception as exc:
logger.error(
"Clean-start marker cleanup failed; refusing startup so the "
"clean-exit receipt cannot mask a later unclean exit: %s", exc,
)
raise RuntimeError("clean-start recovery cleanup failed") from exc
if discarded:
logger.info("Discarded %d orphan active-turn marker(s) after clean shutdown", discarded)
else:
resumed, ledgered = await self._recover_unclean_sessions()
if resumed + ledgered:
logger.info(
"Recovered %d interrupted turn(s) from previous run (%d to resume, %d reply(ies) "
"owed delivery)", resumed + ledgered, resumed, ledgered,
)
# Stuck-loop detection: a session active across 3+ consecutive restarts is auto-suspended.
with _log_suppressed(logging.DEBUG, "Stuck-loop detection failed: %s"):
# Auto-suspend it so the user gets a clean slate on the next message. See #7536.
stuck = self._suspend_stuck_loop_sessions()
if stuck:
logger.warning("Auto-suspended %d stuck-loop session(s)", stuck)
async def _start_prefilter_platforms(self) -> Tuple[bool, int, list, list]:
"""Create + wire an adapter per enabled platform (no connects). Returns
(aborted, enabled_platform_count, multiplex_skipped_platforms, pending_connects)."""
from gateway.run import _platform_has_bot_credential
enabled_platform_count = 0
_multiplex_on = self._multiplex_on()
_multiplex_skipped_platforms: list[Platform] = []
_pending_connects = [] # (platform, platform_config, adapter); connected concurrently later
for platform, platform_config in self.config.platforms.items():
if await self._abort_startup_if_shutdown_requested():
return True, enabled_platform_count, _multiplex_skipped_platforms, _pending_connects
if not platform_config.enabled:
continue
# Multiplex: a platform enabled in the shared config.yaml may hold its token only in a
# secondary profile's .env; an empty primary would queue a reconnect loop that never heals.
# Starting that primary adapter with an empty token fails immediately and queues an infinite
# reconnect loop that can never heal (#64674). Secondary profiles still start their own adapters
# under _profile_runtime_scope with the real token -- skip the empty primary instead of failing
# loudly.
if _multiplex_on and not _platform_has_bot_credential(platform, platform_config):
logger.info(
"Skipping %s on default profile: no bot credential in this "
"profile's secrets. Secondary multiplexed profiles that "
"provide the token will still connect.", platform.value,
)
_multiplex_skipped_platforms.append(platform)
continue
enabled_platform_count += 1
adapter = self._create_adapter(platform, platform_config)
if not adapter:
# Distinguish between missing builtin deps and missing plugin
if platform.value in {m.value for m in Platform.__members__.values()}:
logger.warning("No adapter available for %s", platform.value)
else:
logger.warning(
"No adapter for '%s' -- is the plugin installed? "
"(platform is enabled in config.yaml but no plugin registered it)", platform.value,
)
continue
# Under multiplexing the default profile needs the same whole-handler runtime scope as a
# secondary (authorization and prompt rendering run before the agent-turn scope).
self._wire_adapter_handlers(adapter)
_pending_connects.append((platform, platform_config, adapter))
return False, enabled_platform_count, _multiplex_skipped_platforms, _pending_connects
async def _start_connect_pending(self, _pending_connects: list) -> Optional[list]:
"""Connect the pre-filtered adapters concurrently. Returns the raw per-platform results, or
None when a restart/shutdown aborted startup mid-connect (adapters already torn down)."""
async def _connect_one_startup(p, p_cfg, adp):
"""Connect a single platform; never let one block the others (#83791)."""
if await self._abort_startup_if_shutdown_requested(adp, p):
return (p, adp, p_cfg, "aborted", None)
logger.info("Connecting to %s...", p.value)
self._update_platform_runtime_status(
p.value, platform_state="connecting", error_code=None, error_message=None,
)
try:
ok = await self._connect_initial_adapter_with_timeout(adp, p)
except Exception as _exc: # noqa: BLE001 - surfaced below as a retryable error
return (p, adp, p_cfg, "exception", _exc)
return (p, adp, p_cfg, "ok" if ok else "failed", None)
if not _pending_connects:
return []
# Abort-aware concurrent wait: a restart/shutdown mid-connect cancels pending connects, tears down
# completed ones, and aborts startup.
_task_map = {
asyncio.ensure_future(_connect_one_startup(p, c, a)): (p, c, a) for (p, c, a) in _pending_connects
}
_pending_tasks = set(_task_map)
while _pending_tasks:
_done, _pending_tasks = await asyncio.wait(_pending_tasks, timeout=0.05)
if _pending_tasks and self._startup_should_abort():
break
else:
return [_t.exception() or _t.result() for _t in _task_map]
# Settle in-flight connects FIRST so a completed adapter's disconnect cannot unblock a sibling.
for _t in _pending_tasks:
_t.cancel()
await asyncio.gather(*_pending_tasks, return_exceptions=True)
# Then tear down adapters whose connect succeeded — never registered, so stop() won't reach them.
_connected_ok = [
_t for _t in _task_map
if _t not in _pending_tasks and not _t.cancelled() and _t.exception() is None and _t.result()[3] == "ok"
]
for _t in [*_pending_tasks, *_connected_ok]:
await self._startup_teardown_adapter(_task_map[_t][2], _task_map[_t][0])
await self._abort_startup_if_shutdown_requested()
return None
def _startup_queue_transient_failure(
self, platform, adapter, platform_config, message: str, startup_retryable_errors: list
) -> None:
"""Mark a platform ``retrying`` with ``message`` and queue it in ``_failed_platforms``."""
self._update_platform_runtime_status(
platform.value, platform_state="retrying", error_code=None, error_message=message,
)
startup_retryable_errors.append(f"{platform.value}: {message}")
self._failed_platforms[platform] = self._startup_retry_entry(platform, adapter, platform_config)
async def _start_aggregate_connect_results(
self, _raw: list, startup_retryable_errors: list, startup_nonretryable_errors: list
) -> int:
"""Apply connect outcomes to shared state single-threaded (exactly as the original serial
loop did); returns the connected adapter count."""
connected_count = 0
for _item in _raw:
if isinstance(_item, Exception):
# Unexpected escape from _connect_one_startup (shouldn't happen); log and skip.
logger.error("Unexpected startup connect error: %s", _item)
continue
platform, adapter, platform_config, outcome, exc = _item
if outcome == "aborted":
continue
if outcome == "exception":
logger.error("\u2717 %s error: %s", platform.value, exc)
# An adapter that raised mid-connect may still hold a ClientSession/subprocess; treat
# unexpected exceptions as transient and queue for retry.
await self._safe_adapter_disconnect(adapter, platform)
self._startup_queue_transient_failure(
platform, adapter, platform_config, str(exc), startup_retryable_errors
)
continue
if outcome == "ok":
self._publish_primary_adapter(platform, adapter)
connected_count += 1
# connect() may return True on a degraded (unconfirmed) receive path; don't stamp "connected".
_degraded = adapter.send_path_degraded
self._update_platform_runtime_status(
platform.value, platform_state="retrying" if _degraded else "connected", error_code=None,
error_message=adapter.DEGRADED_STATUS_MESSAGE if _degraded else None,
)
logger.info("\u2713 %s connected%s", platform.value, " (degraded)" if _degraded else "")
continue
# outcome == "failed"
logger.warning("\u2717 %s failed to connect", platform.value)
# A failed connect() may have allocated ClientSessions / poll tasks / subprocesses.
await self._safe_adapter_disconnect(adapter, platform)
if not adapter.has_fatal_error:
# No fatal error info means likely a transient issue -- queue for retry
self._startup_queue_transient_failure(
platform, adapter, platform_config, "failed to connect", startup_retryable_errors
)
continue
# A live foreign token holder is an ownership conflict, not a blip: retryable only for
# MID-RUN reconnects; at startup route it non-retryable so the gateway exits 78, not deaf.
_retryable = adapter.fatal_error_retryable and not is_global_startup_conflict(adapter.fatal_error_code)
self._update_platform_runtime_status(
platform.value, platform_state="retrying" if _retryable else "fatal",
error_code=adapter.fatal_error_code, error_message=adapter.fatal_error_message,
)
target = startup_retryable_errors if _retryable else startup_nonretryable_errors
target.append(f"{platform.value}: {adapter.fatal_error_message}")
if _retryable:
self._failed_platforms[platform] = self._startup_retry_entry(
platform, adapter, platform_config, queued=False
)
return connected_count
def _startup_fail_fatal_config(self, reason: str) -> None:
"""Record a fatal-config startup failure (exit 78) and request a clean exit."""
from gateway.run import _write_runtime_status_quiet
_write_runtime_status_quiet(gateway_state="startup_failed", exit_reason=reason)
self._exit_code = GATEWAY_FATAL_CONFIG_EXIT_CODE
self._request_clean_exit(reason)
self._startup_restore_in_progress = False
async def _start_secondary_profiles(
self, connected_count: int, _multiplex_skipped_platforms: list
) -> Tuple[bool, int]:
"""Bring up multiplexed secondary-profile adapters. Returns (aborted, connected_count)."""
from gateway.run import MultiplexConfigError
from tools.process_registry import process_registry as _pr
# The launch profile's durable completions replay here, not at import (#123265); the
# secondaries' ledgers are replayed by _restore_secondary_completion_ledgers below.
_pr.restore_completions()
# Secondary-profile adapters connect under their own home + credential scope.
try:
connected_count += await self._start_secondary_profile_adapters()
except MultiplexConfigError as e:
# Invalid multiplexer config — abort cleanly rather than run a half-wired gateway.
logger.error("Gateway multiplexer config error: %s", str(e))
self._startup_fail_fatal_config(str(e))
return True, connected_count
except Exception as e:
logger.error("Secondary-profile adapter startup failed: %s", e, exc_info=True)
finally:
# Startup authority is one phase: from here on every adapter retry is non-evicting.
self._platform_lock_takeover_on_start = False
# A platform skipped on the primary should have been picked up by a secondary owning the token;
# if none did, the platform is enabled in config.yaml yet silently unserved — surface it loudly so
# the operator sees a config problem instead of a quiet dead channel (#64674 follow-up).
for _skipped in _multiplex_skipped_platforms:
if not any(_skipped in _profile_map for _profile_map in self._profile_adapters.values()):
logger.warning(
"%s is enabled but no profile (default or secondary) provided a bot credential for it — "
"the platform is not being served. Add its token to the profile that should "
"own it, or disable the platform.", _skipped.value,
)
# The mirror image: a SECONDARY enabled shared ingress (WhatsApp/Relay) that only the default can run.
for _line in self._unserved_shared_ingress_warnings():
logger.warning(_line)
return False, connected_count
def _start_handle_no_connections(
self, connected_count: int, enabled_platform_count: int, startup_retryable_errors: list,
startup_nonretryable_errors: list,
) -> bool:
"""Log/degrade when a configured platform failed to start; return True when startup must exit.
The SHARED gate for every platform, not the api_server path: a configured platform that never
came up must leave a loud, observable trace (ERROR + a ``degraded`` runtime state) even while
sibling platforms serve normally. One WARNING next to "Gateway running with N platform(s)" let
a gateway with no API server at all look healthy for half an hour (api_server lost the bind
race against the gateway it was replacing, and nothing retried).
"""
from gateway.run import _write_runtime_status_quiet
if connected_count != 0:
if startup_nonretryable_errors:
# Parked fatal failures never heal on their own, so the platforms still serving must
# not be reported as a healthy run. Retryable peers are deliberately left alone: the
# reconnect watcher recovers them and their platform entry already says "retrying".
self._startup_parked_platforms = True
logger.error(
"%d configured platform(s) failed to start and are parked (fix the reported error, "
"then `hermes gateway restart`): %s. The gateway is DEGRADED — it serves the "
"remaining platform(s) with those unserved.",
len(startup_nonretryable_errors), "; ".join(startup_nonretryable_errors),
)
return False
if startup_nonretryable_errors and not startup_retryable_errors:
reason = "; ".join(startup_nonretryable_errors)
logger.error("Gateway hit a non-retryable startup conflict: %s", reason)
self._startup_fail_fatal_config(reason)
return True
if startup_nonretryable_errors:
# Mixed (some fatal, some transient): exiting 78 would take the gateway PERMANENTLY down
# over a blip. Log the fatal side loudly and fall through to the degraded/retry path.
self._startup_parked_platforms = True
logger.error(
# WhatsApp enabled but never paired) while others hit merely transient errors (e.g. Telegram
# TimedOut during polling startup). Exiting with GATEWAY_FATAL_CONFIG_EXIT_CODE here is
# wrong in both supervision worlds: under supervisors that honor the exit-78 contract
# (systemd RestartPreventExitStatus, s6 finish→125 since #51228) the gateway goes
# PERMANENTLY down over a network blip; under anything else it crash-loops. Either way the
# retryable platforms never get their retry. Log the fatal side loudly, then fall through to
# the degraded/retry path below: the reconnect watcher recovers the retryable platforms; the
# non-retryable ones remain fatal-parked and visible in runtime status.
"%d platform(s) fatally misconfigured and parked: %s. "
"Staying alive so retryable platforms can recover.",
len(startup_nonretryable_errors), "; ".join(startup_nonretryable_errors),
)
if enabled_platform_count <= 0:
logger.warning("No messaging platforms enabled.")
logger.info("Gateway will continue running for cron job execution.")
return False
if startup_retryable_errors:
# All retryable: stay alive (cron runs, watcher recovers) rather than systemd restart-loop.
logger.warning(
"Gateway started with no connected platforms — %d platform(s) queued for retry: %s",
len(self._failed_platforms), "; ".join(startup_retryable_errors),
)
_write_runtime_status_quiet(gateway_state="degraded", exit_reason=None)
# No adapter for any enabled platform: fleet nodes share one config.yaml but hold a subset of
# credentials, so degrade gracefully.
logger.warning(
# Fall through to the normal "running" state — reconnect watcher takes it from here. In fleet
# deployments the same config.yaml is shared across nodes that may only have credentials for a
# subset of platforms. Rather than failing hard, degrade gracefully and allow cron jobs to run
# (#5196).
"No adapter could be created for any of the %d configured platform(s). "
"Check that required dependencies are installed and credentials are set. "
"Gateway will continue for cron job execution.", enabled_platform_count,
)
return False
async def _start_post_connect_services(self, connected_count: int) -> None:
"""Room worker, heartbeat, gateway:startup hook, channel directory, /update notice."""
from gateway.run import _hermes_home
try:
await self._ensure_hosted_room_worker()
except Exception:
logger.error(
"Group Chat worker failed to start; mutating Group Chat commands "
"will fail closed until supervision recovers it", exc_info=True,
)
self._spawn_supervised(self._hosted_room_worker_watcher, "hosted_room_worker")
self._start_loop_heartbeat_task()
from gateway.run_heartbeat_restore import restore_heartbeat_watches
self._start_heartbeat_poller() # Keep retrying even when the first scan is empty.
await restore_heartbeat_watches(self)
hook_count = len(self.hooks.loaded_hooks)
if hook_count:
logger.info("%s hook(s) loaded", hook_count)
await self.hooks.emit("gateway:startup", {"platforms": [p.value for p in self.adapters]})
if connected_count > 0:
logger.info("Gateway running with %s platform(s)", connected_count)
# Initial channel directory for send_message name resolution
with _log_suppressed(logging.WARNING, "Channel directory build failed: %s"):
from gateway.channel_directory import build_channel_directory
directory = await build_channel_directory(self.adapters)
ch_count = sum(len(chs) for chs in directory.get("platforms", {}).values())
logger.info("Channel directory built: %d target(s)", ch_count)
# Restarting after a /update still in progress: keep watching so we notify when it finishes.
notified = await self._send_update_notification()
if not notified and any(
(_hermes_home / name).exists()
for name in (".update_pending.json", ".update_pending.claimed.json")
):
self._schedule_update_notification_watch()
async def _start_finish_wiring(self, connected_count: int) -> None:
"""Post-connect wiring: services, boot notifications, startup restore, recovered watchers."""
from gateway.run import _planned_restart_notification_pending, _restart_notification_pending
await self._start_post_connect_services(connected_count)
# Let fresh adapters settle before lifecycle sends (helps Discord thread deliveries).
if connected_count > 0:
await asyncio.sleep(1.0)
# Before _send_restart_notification() unlinks the marker: did we boot from a chat /restart?
# One-shot signal for _is_stale_restart_redelivery.
if _restart_notification_pending():
self._booted_from_restart = True
# Boot-path adapter.send() calls must not pin the inbound restore gate (a Telegram flood-
# control sleep here once froze every platform).
# Restart notification, home-channel startup notice, and obligation redelivery all call
# adapter.send(). Bound them the same way _finish_startup_restore bounds resume turns. See #91969.
await self._await_startup_boot_sends(
planned_restart_notification_pending=_planned_restart_notification_pending(),
)
# Auto-resume restart-interrupted sessions (ledger-answered ones were cleared above); a failed
# auto-resume stays visible on the next user message.
self._schedule_resume_pending_sessions()
await self._finish_startup_restore()
# Surface state.db init failures to messaging platforms before the user loses data.
# See #88235.
await self._send_session_db_warning_notifications()
# Resume recovered process watchers. Detach the batch atomically (fresh list, not clear(): a
# concurrent append during the yield must not be lost); yield every 100 to keep the loop live.
with _log_suppressed(logging.ERROR, "Recovered watcher setup error: %s"):
from tools.process_registry import process_registry
watchers = process_registry.pending_watchers
process_registry.pending_watchers = []
for i, watcher in enumerate(watchers):
self._spawn_supervised(
lambda w=watcher: self._run_process_watcher(w),
f"process_watcher:{watcher.get('session_id')}", restart=False,
)
logger.info("Resumed watcher for recovered process %s", watcher.get("session_id"))
if i % 100 == 99:
await asyncio.sleep(0)
# Long-lived supervised watchers spawned at the end of start(), in order; supervised name = method
# name minus the leading underscore.
_PRE_RECONNECT_WATCHERS = (
"_session_housekeeping_watcher", "_model_catalog_refresh_watcher", "_session_stall_watcher",
"_kanban_notifier_watcher", "_kanban_dispatcher_watcher",
)
_POST_RECONNECT_WATCHERS = (
"_handoff_watcher", "_async_delegation_watcher", "_loop_wakeup_watcher", "_profile_reconcile_watcher",
)
def _start_spawn_background_watchers(self) -> None:
"""Spawn the long-lived supervised background watchers."""
for method in self._PRE_RECONNECT_WATCHERS:
self._spawn_supervised(getattr(self, method), method[1:])
if self._failed_platforms:
logger.info(
"Starting reconnection watcher for %d failed platform(s): %s",
len(self._failed_platforms), ", ".join(p.value for p in self._failed_platforms),
)
# Supervised: an escaping exception is restarted with backoff instead of stranding queued
# platforms (the ensure hook only runs on a NEW fatal). ``on_spawn`` keeps the handle current.
self._spawn_reconnect_watcher()
for method in self._POST_RECONNECT_WATCHERS:
self._spawn_supervised(getattr(self, method), method[1:])
# Scale-to-zero watcher ONLY when opted in, messaging is relay-only/absent, and a wakeUrl exists.
try:
if self._scale_to_zero_should_arm():
logger.info(
"scale-to-zero: armed (idle timeout %.0fs) — watching for idle",
self._scale_to_zero_idle_timeout_seconds(),
)
self._spawn_supervised(self._scale_to_zero_watcher, "scale_to_zero_watcher")
else:
# Say WHY an OPTED-IN instance didn't arm (non-opted stays silent).
self._log_scale_to_zero_not_armed_reason()
except Exception: # noqa: BLE001 - arming must never block startup
logger.debug("scale-to-zero: arm check failed at startup", exc_info=True)
# Drain-control watcher: reconciles new-turn acceptance with the dashboard's ``.drain_request.json``
# marker (prior-instantiation markers are ignored via epoch).
self._spawn_supervised(self._drain_control_watcher, "drain_control_watcher")
@staticmethod
async def _start_flush_runtime_status() -> None:
"""Bound startup on the latest diagnostic snapshot, never on filesystem health."""
try:
from gateway.status import flush_runtime_status_async
if not await flush_runtime_status_async(timeout=2.0):
logger.warning("Timed out flushing final startup runtime status")
except Exception:
logger.debug("Final startup runtime-status flush failed", exc_info=True)
async def start(self) -> bool:
"""Start the gateway and all configured platform adapters."""
try:
return await self._start_impl()
finally:
# Every startup path (early aborts included) ends here: bound startup on the latest
# diagnostic snapshot once, instead of flushing at each return.
await self._start_flush_runtime_status()
async def _start_impl(self) -> bool:
logger.info("Starting Hermes Gateway...")
self._start_install_faulthandler()
await self._start_log_startup_environment()
if await self._abort_startup_if_shutdown_requested():
return True
if self._start_check_access_policy():
return True
await self._start_recover_previous_run()
# The gateway is a boot owner of the Nous free tier, beside `cmd_chat` and `hermes serve`: every
# demand-time site (provider resolution, /login, the connector token) is a read that needs the
# identity to already exist. Blocking here, before any adapter connects, is what keeps a fast
# first DM from arriving with nothing to resolve. With the launch gate unset this is a local
# inventory and no network.
await self._run_free_tier_bootstrap()
# Serialize startup restore against inbound: adapters receive as soon as they connect, so inbound
# queues until every synthetic resume turn has finished.
self._startup_restore_in_progress = True
self._startup_restore_queue = []
self._startup_restore_tasks = []
# Fresh boot: the gate opens while the turn machinery is still cold (skeleton prompts). Warm NOW
# to overlap the connects; _finish_startup_restore awaits it (bounded).
self._start_startup_warmup()
startup_nonretryable_errors: list[str] = []
startup_retryable_errors: list[str] = []
self._startup_parked_platforms = False # fresh boot: no platform has failed yet
(
_aborted, enabled_platform_count, _multiplex_skipped_platforms, _pending_connects
) = await self._start_prefilter_platforms()
if _aborted:
return True
if await self._abort_startup_if_shutdown_requested():
return True
_raw = await self._start_connect_pending(_pending_connects)
if _raw is None:
return True
connected_count = await self._start_aggregate_connect_results(
_raw, startup_retryable_errors, startup_nonretryable_errors
)
if await self._abort_startup_if_shutdown_requested():
return True
_aborted, connected_count = await self._start_secondary_profiles(
connected_count, _multiplex_skipped_platforms
)
if _aborted:
return True
if self._start_handle_no_connections(
connected_count, enabled_platform_count, startup_retryable_errors, startup_nonretryable_errors
):
return True
if await self._abort_startup_if_shutdown_requested():
return True
self.delivery_router.adapters = self.adapters
self._wire_teams_pipeline_runtime()
self._running = True
self._install_plugin_message_injector()
# A boot that could not start every configured platform is not a normal run: stamp ``degraded``
# so ``gateway status`` / /api/status / the health snapshot surface it, instead of only a log
# line next to "Gateway running with N platform(s)".
self._update_runtime_status(self._serving_state())
await self._start_finish_wiring(connected_count)
self._start_spawn_background_watchers()
from hermes_cli.observability.shared_metrics_startup import record_process_ready
record_process_ready("gateway_boot", background=True)
logger.info("Press Ctrl+C to stop")
return True
@dataclasses.dataclass
class _HandoffDestination:
"""Resolved destination for one handoff row."""
platform: Platform
platform_name: str
transport: Any
home: Any
home_chat_id: str
effective_thread_id: Optional[str]
source: SessionSource
handoff_config: Any
def _handoff_resolve_scope(self, profile_name: Optional[str]):
"""Return (config, adapters) for the profile that queued the handoff. For a secondary
profile the watcher already entered _profile_runtime_scope, so a fresh load resolves THAT
profile's config; fail closed — self.config would deliver to the WRONG chat."""
from gateway.run import load_gateway_config
if not profile_name or profile_name == "default":
return self.config, self.adapters
secondary = (self._profile_adapters or {}).get(profile_name)
if not secondary:
raise RuntimeError(f"profile '{profile_name}' has no live adapters in this gateway")
try:
return load_gateway_config(), secondary
except Exception as exc:
logger.error(
"Handoff: could not load config for profile %s; failing the handoff instead of "
"delivering via the primary's config", profile_name, exc_info=True,
)
raise RuntimeError(f"could not load config for profile '{profile_name}': {exc}") from exc
async def _handoff_resolve_destination(
self, row: Dict[str, Any], profile_name: Optional[str]
) -> "GatewayStartupMixin._HandoffDestination":
"""Resolve platform, transport, home channel, thread and destination source for a row."""
from gateway.delivery import resolve_delivery_transport
cli_session_id = row["id"]
platform_name = (row.get("handoff_platform") or "").strip().lower()
if not platform_name:
raise RuntimeError("handoff_platform is empty")
try:
platform = Platform(platform_name)
except (ValueError, KeyError):
raise RuntimeError(f"unknown platform '{platform_name}'")
handoff_config, handoff_adapters = self._handoff_resolve_scope(profile_name)
# Alias-aware transport: a relay-fronted gateway registers ONE Platform.RELAY adapter fronting
# N logical platforms, so a literal adapters.get() would miss a deliverable one.
transport = resolve_delivery_transport(platform, handoff_config, handoff_adapters)
if not transport:
raise RuntimeError(f"platform '{platform_name}' is not active in this gateway")
home = handoff_config.get_home_channel(platform)
if not home or not home.chat_id:
raise RuntimeError(
f"no home channel configured for {platform_name}; run /sethome on the desired chat first"
)
home_chat_id = str(home.chat_id)
# Fresh thread for the handoff's own scrollback; None when unsupported or creation failed.
cli_title = row.get("title") or cli_session_id[:8]
try:
new_thread_id = await transport.adapter.create_handoff_thread(
home_chat_id, t("gateway.startup.handoff_thread_title", title=cli_title),
)
except Exception as exc:
logger.debug("Handoff: create_handoff_thread raised on %s: %s", platform_name, exc, exc_info=True)
new_thread_id = None
effective_thread_id = new_thread_id or (str(home.thread_id) if home.thread_id else None)
# Telegram private-chat DM topics use the DM-topic source shape (user_id == chat_id) so the
# synthetic turn binds the same key later inbound turns arrive on (`dm`, not `thread`).
is_telegram_private_chat = (
platform == Platform.TELEGRAM and looks_like_telegram_private_chat_id(home_chat_id)
)
is_thread = bool(new_thread_id) and not is_telegram_private_chat
chat_type = "thread" if is_thread else "dm"
scope_id = None
if platform == Platform.TELEGRAM and not is_telegram_private_chat:
# The Telegram adapter keys forum-topic replies ``group:<chat>:<topic>`` (never
# ``thread``); bind the handoff on the same slot.
chat_type = "group"
if platform == Platform.SLACK:
# Slack keys a thread reply on the parent channel's type ("dm" for a D… channel, else
# "group") plus the workspace id — never on a "thread" slot. Mirror the adapter's inbound
# source shape or the first reply after a restart lands on a different key (#111896).
chat_type = "dm" if home_chat_id.startswith("D") else "group"
scope_for_chat = getattr(transport.adapter, "scope_id_for_chat", None)
scope_id = home.scope_id or (scope_for_chat(home_chat_id) if callable(scope_for_chat) else None)
if platform == Platform.MATRIX:
# Matrix likewise keys an in-thread reply on the ROOM's type (#112918); the adapter's
# get_chat_info reports "dm"/"group" for the home room.
chat_type = "dm" if await self._handoff_home_is_dm(transport.adapter, home_chat_id) else "group"
# Discord builds in-thread messages with ``chat_id == thread id``: key on the thread's OWN id.
dest_source = SessionSource(
platform=platform,
chat_id=str(effective_thread_id) if (
is_thread and platform == Platform.DISCORD and effective_thread_id
) else home_chat_id,
chat_name=home.name,
chat_type=chat_type,
user_id=home_chat_id if is_telegram_private_chat else "system:handoff",
user_name="Handoff", thread_id=effective_thread_id, profile=profile_name,
scope_id=scope_id,
)
return self._HandoffDestination(
platform=platform, platform_name=platform_name, transport=transport, home=home,
home_chat_id=home_chat_id, effective_thread_id=effective_thread_id, source=dest_source,
handoff_config=handoff_config,
)
@staticmethod
async def _handoff_home_is_dm(adapter, home_chat_id: str) -> bool:
"""Whether the home chat is a DM by the adapter's own ``get_chat_info`` (``type: "dm"``);
unknown/failed → not a DM, the common handoff target."""
try:
info = await adapter.get_chat_info(home_chat_id)
except Exception:
logger.debug("Handoff: get_chat_info failed for %s", home_chat_id, exc_info=True)
return False
return isinstance(info, dict) and info.get("type") == "dm"
def _handoff_session_key(self, dest, profile_name: Optional[str]) -> str:
"""Destination session_key by the adapters' own rules. Thread keys omit user_id so the next
message shares it. Namespaced to the queuing profile (else a multiplexed gateway builds
``agent:main:...`` while the profile's adapter routes on ``agent:<profile>:...``); the store
resolver is only the root fallback. The isinstance check is load-bearing: a Mock store returns
a truthy MagicMock."""
platform_cfg = dest.handoff_config.platforms.get(dest.platform)
extra = platform_cfg.extra if platform_cfg else {}
handoff_profile = profile_name if (profile_name and profile_name != "default") else None
if handoff_profile is None:
try:
store = getattr(self.async_session_store, "_store", self.async_session_store)
resolver = getattr(store, "_resolve_profile_for_key", None)
# Resolve the bound text channel's channel_prompt so voice input gets the same per-channel
# context as typed messages (#50149).
if callable(resolver):
resolved = resolver(dest.source)
if isinstance(resolved, str) and resolved.strip():
handoff_profile = resolved
except Exception:
logger.debug("Handoff: could not resolve profile namespace", exc_info=True)
return build_session_key(
dest.source, group_sessions_per_user=extra.get("group_sessions_per_user", True),
thread_sessions_per_user=extra.get("thread_sessions_per_user", False), profile=handoff_profile,
)
async def _process_handoff(self, row: Dict[str, Any], profile_name: Optional[str] = None) -> None:
"""Execute one handoff row; raises on failure (caller marks failed). ``profile_name`` (None =
root) is the profile whose store queued it — load-bearing under multiplex: secondaries live in
``_profile_adapters`` and the key must be namespaced ``agent:<profile>:...`` or nobody reads it."""
cli_session_id = row["id"]
dest = await self._handoff_resolve_destination(row, profile_name)
session_key = self._handoff_session_key(dest, profile_name)
# Ensure a session_store entry exists for this key; switch_session then re-points it.
await self.async_session_store.get_or_create_session(dest.source)
# switch_session ends the prior session and reopens the CLI session under the new key.
switched = await self.async_session_store.switch_session(
session_key, cli_session_id, preserve_prompt_pin=False,
)
if switched is None:
raise RuntimeError(f"could not switch session key {session_key} → {cli_session_id}")
# Evict the cached AIAgent (rebuild against the CLI session_id, like /resume) and clear stale
# running-agent state so the synthetic turn isn't queued behind it.
self._evict_cached_agent(session_key)
self._release_running_agent_state(session_key)
cli_title = row.get("title") or cli_session_id[:8]
synthetic_event = MessageEvent(
text=(
f"[Session was just handed off from CLI (\"{cli_title}\") to this "
f"channel. The full prior conversation history is loaded above. "
f"Briefly confirm you're working here and summarize what we were "
f"working on, so the user can continue from this device.]"
),
source=dest.source,
internal=True,
)
logger.info(
"Handoff: dispatching synthetic turn for CLI session %s → %s "
"(home=%s, thread=%s, session_key=%s)",
cli_session_id, dest.platform_name, dest.home.chat_id, dest.effective_thread_id, session_key,
)
# Inline _handle_message keeps success/failure observable (handle_message would detach it).
response_text = await self._handle_message(synthetic_event)
if not response_text:
# Streaming may have delivered inline; the agent ran without raising — success.
return
# Reply into the new thread (else the home channel) via the resolved transport, so a relay-fronted
# logical platform is stamped on the outbound frame.
send_metadata = {"thread_id": dest.effective_thread_id} if dest.effective_thread_id else None
try:
result = await dest.transport.send(
dest.platform, str(dest.home.chat_id), response_text, send_metadata,
)
except Exception as exc:
raise RuntimeError(f"adapter.send failed: {exc}") from exc
if not getattr(result, "success", True):
raise RuntimeError(f"adapter.send failed: {_send_error(result)}")