Files
hermes-agent/gateway/slash_commands_session.py
teknium1 dbcbd9d9db feat(gateway): /branch opens a sibling thread by default; --here keeps this chat (#66023)
On Discord, Telegram, Slack and Matrix a plain `/branch` used to rebind the
CURRENT chat/thread's session key to the clone, ending the original session
on that surface. The user could not keep the original path live while
exploring an alternate one — the opposite of what a branch is for.

Now the handler opens a sibling thread through the adapter's existing
`create_handoff_thread` BEFORE cloning (a failed create never orphans a
branch row), binds the thread's own session key to the clone with the
thread's routing columns written at create time, and leaves the origin key
untouched. `/branch --here` keeps the legacy in-place switch; platforms
without threads, DMs, unknown Discord parents and adapters that cannot open
a thread fall back to in-place with a one-line note. The CLI strips the
flag through the same parser so `--here` never becomes a session title.

Destination source shapes mirror each adapter's inbound key (Discord keys
threads on their own id; Telegram/Slack/Matrix on the parent chat), the
same rules the CLI->platform handoff uses.

Live repro (real gateway + real Slack adapter against a stand-in Slack
Socket Mode/Web API): base ends the origin session and rebinds its key;
fixed posts the thread seed, replies "this chat stays on it", the origin
thread keeps its session and the follow-up typed in the new thread lands on
the branch (parent_session_id = origin).

Design and first implementation by Angello Picasso (#66014, #66024);
this is a slim port onto the split slash_commands_* layout.

Co-authored-by: Angello Picasso <angello.picasso@devsu.com>
2026-09-20 13:37:10 -07:00

1100 lines
64 KiB
Python

"""Gateway slash commands that rotate, switch, fork or rewrite the session transcript:
/new, /resume, /sessions, /branch, /title, /save, /undo, /retry, /topic, /compress.
Split out of ``gateway/slash_commands.py``; bound onto ``GatewayRunner`` through
``GatewaySlashCommandsMixin``. Origin internals are imported lazily inside the bodies to avoid
the import cycle."""
from __future__ import annotations
import asyncio
import contextlib
import dataclasses
import logging
import os
import shlex
from typing import Optional, Union
from agent.i18n import t
from agent.turn_context import extract_api_content_sidecar
from gateway.config import Platform
from gateway.platforms.base import EphemeralReply
from gateway.platforms.event import MessageEvent, MessageType
from gateway.session import SessionSource, build_session_key, is_shared_multi_user_session
from gateway.session_transcript import TranscriptReadError
from gateway.slash_commands_branch_thread import (
BRANCH_THREAD_PLATFORMS, branch_dest_source, branch_thread_parent, format_thread_ref, parse_branch_args,
)
from gateway.slash_commands_status import HISTORY_UNREADABLE
logger = logging.getLogger("gateway.run") # log-record parity with gateway/run.py
# Bound on the off-loop agent cleanup during /new; past it the reset proceeds and the teardown
# finishes (or leaks) in its worker thread rather than blocking the event loop.
_RESET_CLEANUP_TIMEOUT_S = 30.0
# chat_type values whose session key is per-user (DM-like), incl. the unknown/blank case.
_DM_CHAT_TYPES = {"dm", "direct", "private", ""}
_BRANCH_COPIED_FIELDS = ("content", "tool_calls", "tool_call_id", "finish_reason", "reasoning",
"reasoning_content", "reasoning_details", "codex_reasoning_items",
"codex_message_items", "timestamp")
def _sattr(obj, name: str) -> str:
"""``str(getattr(obj, name) or "")`` — normalized identity field for origin comparisons."""
return str(getattr(obj, name, "") or "")
def _manual_compression_reply_lines(summary: dict, compressor, focus_topic) -> list[str]:
"""Manual /compress confirmation lines, surfacing summariser/aux-model failures.
``_last_compress_aborted`` = no usable summary, messages unchanged. Provider exception text is
force-redacted at this UI boundary even when global redaction is off; an aux model recovered
via main is an info note so the user can fix their config."""
lines = [f"🗜️ {summary['headline']}"]
if focus_topic:
lines.append(t("gateway.compress.focus_line", topic=focus_topic))
lines.append(summary["token_line"])
if summary["note"]:
lines.append(summary["note"])
summary_err = getattr(compressor, "_last_summary_error", None)
if summary_err:
from agent.redact import redact_sensitive_text
summary_err = redact_sensitive_text(summary_err, force=True)
aux_fail_model = getattr(compressor, "_last_aux_model_failure_model", None)
if getattr(compressor, "_last_compress_aborted", False):
lines.append(t("gateway.compress.aborted", error=(summary_err or "unknown error")))
elif aux_fail_model:
aux_err = getattr(compressor, "_last_aux_model_failure_error", None) or "unknown error"
lines.append(t("gateway.compress.aux_failed", model=aux_fail_model, error=aux_err))
return lines
def _compress_preview_reply(history, partial: bool, keep_last, focus_topic, agg_note: str) -> str:
"""``/compress --preview``: report what WOULD be compressed — no agent, no writes."""
from agent.model_metadata import estimate_request_tokens_rough
from hermes_cli.partial_compress import summarize_compress_preview
pv_msgs = [{"role": m.get("role"), "content": m.get("content")} for m in history
if m.get("role") in {"user", "assistant"} and m.get("content")]
report = summarize_compress_preview(pv_msgs, partial, keep_last, focus_topic,
estimate_request_tokens_rough(pv_msgs))
lines = [f"🗜️ {line}" for line in report["lines"]]
if agg_note:
lines.append(agg_note)
return "\n".join(lines)
def _reset_process_scoped_tool_state() -> None:
"""Drop env-passthrough and credential-file state at a conversation boundary (best-effort)."""
with contextlib.suppress(Exception):
from tools.env_passthrough import clear_env_passthrough
clear_env_passthrough()
with contextlib.suppress(Exception):
from tools.credential_files import clear_credential_files
clear_credential_files()
def _branch_row(msg: dict) -> dict:
"""/branch child row; keeps the api_content sidecar so the branch's first turn replays the
parent's exact wire bytes (warm provider prompt cache) instead of a cold prefill."""
row = {k: msg.get(k) for k in _BRANCH_COPIED_FIELDS}
row["role"] = msg.get("role", "user")
row["tool_name"] = msg.get("tool_name") or msg.get("name")
row["api_content"] = extract_api_content_sidecar(msg)
return row
def _strip_resume_name(parts: list[str]) -> str:
"""Join the non-flag /resume tokens; strip literal ``<...>``/``[...]``/quotes typed from the
usage hint (mirrors the CLI)."""
name = " ".join(p for p in parts if p not in {"--all", "--cross-room"}).strip()
if len(name) >= 2 and (name[0], name[-1]) in {("<", ">"), ("[", "]"), ('"', '"'), ("'", "'")}:
name = name[1:-1].strip()
return name
class GatewaySessionCommandsMixin:
"""Session-transcript slash commands (/new, /resume, /sessions, /branch, /title, /save, /undo, /retry, /topic, /compress)."""
# ------------------------------------------------------------------ /new, /reset
async def _cleanup_old_agent_for_reset(self, session_key: str) -> None:
"""Close the old agent's tool resources (sandboxes, browsers, subprocesses) before eviction.
Blocking work on the event loop (confirm-button click) → offloaded with a bounded timeout.
wait_for cancels the await, not the worker thread: a wedged teardown keeps running (or
leaks); the reset proceeds either way."""
_old_agent = self._cached_agent_for(session_key)
if _old_agent is None:
return
try:
await asyncio.wait_for(
self._run_in_executor_with_context(self._cleanup_agent_resources, _old_agent),
timeout=_RESET_CLEANUP_TIMEOUT_S)
except asyncio.TimeoutError:
logger.warning(
"Agent resource cleanup for session %s exceeded %ss during /new reset; proceeding with "
"reset (the worker thread is left to finish on its own). (#35994)",
session_key, _RESET_CLEANUP_TIMEOUT_S)
except Exception as cleanup_exc:
logger.warning(
"Agent resource cleanup for session %s failed during /new reset: %s (#35994)",
session_key, cleanup_exc)
async def _fire_session_reset_hooks(self, source: SessionSource, session_key: str, old_sid,
new_sid) -> None:
"""Session-boundary hooks: plugin finalize (off-loop + bounded — trace exports can block
arbitrarily), then session:end and session:reset."""
platform_value = source.platform.value if source.platform else ""
with contextlib.suppress(Exception):
await self._finalize_session_off_loop(
session_id=old_sid, platform=platform_value, reason="new_session",
old_session_id=old_sid, new_session_id=new_sid)
hook_payload = {"platform": platform_value, "user_id": source.user_id, "session_key": session_key}
await self.hooks.emit("session:end", dict(hook_payload))
await self.hooks.emit("session:reset", dict(hook_payload))
async def _handle_reset_command(self, event: MessageEvent) -> Union[str, EphemeralReply]:
"""Handle /new or /reset command."""
source = event.source
session_key = self._session_key_for_source(source)
self._invalidate_session_run_generation(session_key, reason="session_reset")
# Evict the running-agent slot now that the generation is bumped: the in-flight run's own
# guarded release (old generation) returns False and would leave a zombie slot that silently
# drops all later messages. Idempotent, so the run's finally calling it again is harmless.
self._release_running_agent_state(session_key)
# Snapshot the old entry so on_session_finalize can report the expiring session id.
# Evict the running-agent slot now that the generation is bumped. The in-flight run's own guarded
# release (run_generation=old) will return False and leave its dead agent behind; clearing here
# keeps the slot from becoming a zombie that silently drops all later messages (#28686). Idempotent,
# so the run's finally calling it again is harmless.
old_entry = self.session_store._entries.get(session_key)
await self._cleanup_old_agent_for_reset(session_key)
self._evict_cached_agent(session_key)
# Conversation boundary: ALL conversation-scoped per-session state + security state in one
# funnel call (see _CONVERSATION_SCOPED_STATE in gateway/run.py).
self._clear_conversation_scope(session_key, reason="session_reset")
# In-flight async delegations end WITH the conversation: once the id rotates their
# completions have no live owner. Expire by durable id, routing key as legacy fallback.
with contextlib.suppress(Exception):
from tools.async_delegation import interrupt_for_session
interrupt_for_session(session_key=session_key, reason="session_reset",
parent_session_id=str(getattr(old_entry, "session_id", "") or ""))
_reset_process_scoped_tool_state()
new_entry = await self.async_session_store.reset_session(session_key)
_old_sid = old_entry.session_id if old_entry else None
await self._fire_session_reset_hooks(source, session_key, _old_sid,
new_entry.session_id if new_entry else None)
# Scoped to the profile serving this source so a multiplexed /new banner reports the
# profile's model, not the base config's.
try:
session_info = await asyncio.to_thread(self._reset_notice_session_info, source)
except Exception:
session_info = ""
if new_entry:
default_header = t("gateway.reset.header_default")
else: # no existing session: create one
new_entry = await self.async_session_store.get_or_create_session(source, force_new=True)
default_header = t("gateway.reset.header_new")
header = await asyncio.to_thread(self._telegram_topic_new_header, source) or default_header
_title_arg = event.get_command_args().strip()
if _title_arg and self._session_db and new_entry:
header = await self._reset_titled_header(header, new_entry.session_id, _title_arg)
# Telegram DM topic lane: rebind (chat_id, thread_id) → session_id so the next message uses
# the fresh session instead of switching back to the old one.
if await asyncio.to_thread(self._is_telegram_topic_lane, source) and new_entry is not None:
try:
await asyncio.to_thread(self._record_telegram_topic_binding, source, new_entry)
except Exception:
logger.debug("Failed to rebind Telegram topic after /new", exc_info=True)
_new_sid = new_entry.session_id if new_entry else None
# Plugin on_session_reset hook (new session guaranteed to exist); best-effort.
try:
from hermes_cli.lifecycle import invoke_hook as _invoke_hook
_invoke_hook("on_session_reset", session_id=_new_sid, reason="new_session",
platform=source.platform.value if source.platform else "",
old_session_id=_old_sid, new_session_id=_new_sid)
except Exception:
pass
try:
from hermes_cli.tips import get_random_tip
_tip_line = t("gateway.reset.tip", tip=get_random_tip())
except Exception:
_tip_line = ""
body = f"{header}\n\n{session_info}" if session_info else header
return EphemeralReply(f"{body}{_tip_line}")
async def _reset_titled_header(self, header: str, session_id: str, title_arg: str) -> str:
"""``/new <title>``: titled header on success, else the header plus a rejection note."""
from hermes_state import SessionDB
note = ""
try:
sanitized = SessionDB.sanitize_title(title_arg)
except ValueError as e:
sanitized = None
note = t("gateway.reset.title_rejected", error=str(e))
if sanitized:
try:
await self._session_db.set_session_title(session_id, sanitized)
header = t("gateway.reset.header_titled", title=sanitized)
except ValueError as e:
note = t("gateway.reset.title_error_untitled", error=str(e))
except Exception:
pass
elif not note: # sanitize_title returned empty (whitespace-only / unprintable)
note = t("gateway.reset.title_empty_untitled")
return header + note
# ------------------------------------------------------- origin / ownership guards
def _gateway_session_origin_for_id(self, session_id: str) -> Optional[SessionSource]:
"""Best-effort origin lookup for gateway session IDs."""
lookup = getattr(type(self.session_store), "lookup_by_session_id", None)
if callable(lookup):
entry = lookup(self.session_store, session_id)
return getattr(entry, "origin", None) if entry is not None else None
# Test doubles / older stores lack the public lookup; fail closed when nothing resolves.
entries = getattr(self.session_store, "_entries", {}) or {}
return next((getattr(e, "origin", None) for e in entries.values()
if getattr(e, "session_id", None) == session_id), None)
@staticmethod
def _same_matrix_room(current: SessionSource, origin: Optional[SessionSource]) -> bool:
# thread_id is part of the session key, so another thread of the SAME room is a DIFFERENT
# session; non-threaded rooms compare "" == "".
return (origin is not None and origin.platform == Platform.MATRIX
and current.platform == Platform.MATRIX and origin.chat_id == current.chat_id
and _sattr(current, "thread_id") == _sattr(origin, "thread_id"))
def _same_origin_chat(self, current: SessionSource, origin: Optional[SessionSource]) -> bool:
"""Platform-agnostic counterpart to ``_same_matrix_room``. Per-participant sessions must be
participant-scoped here too, else a co-member could resume another member's live session
(IDOR); only an explicitly shared group/thread shares."""
if origin is None or current is None:
return False
if origin.platform != current.platform or origin.chat_id != current.chat_id:
return False
# thread_id is part of every session key: threads of one chat are DIFFERENT sessions.
if _sattr(current, "thread_id") != _sattr(origin, "thread_id"):
return False
if _sattr(current, "chat_type").lower() in _DM_CHAT_TYPES:
# An equal non-empty chat_id IS the DM key. build_session_key falls back to the
# participant (``user_id_alt or user_id`` — Signal/Feishu key on alt) only without a
# chat_id; mirror that and fail closed on a missing/different participant.
if _sattr(current, "chat_id"):
return True
cur_pid = str(current.user_id_alt or current.user_id or "")
org_pid = str(origin.user_id_alt or origin.user_id or "")
return bool(cur_pid) and cur_pid == org_pid
# Non-DM: a shared key is one session for everyone; a per-user key compares the participant
# it is built from, failing closed when either side lacks one.
if self._is_shared_session_source(current):
return True
cur_pid = current.user_id_alt or current.user_id
org_pid = origin.user_id_alt or origin.user_id
return bool(cur_pid and org_pid) and cur_pid == org_pid
def _is_shared_session_source(self, source: SessionSource) -> bool:
"""Whether *source*'s session key is shared by every participant (not per-user); mirrors
build_session_key's isolation rules so the guards stay in lock-step with the key."""
return is_shared_multi_user_session(
source, group_sessions_per_user=getattr(self.config, "group_sessions_per_user", True),
thread_sessions_per_user=getattr(self.config, "thread_sessions_per_user", False))
def _resume_caller_is_admin(self, source: SessionSource) -> bool:
"""Whether *source* is an EXPLICITLY-configured admin (cross-origin /resume, /sessions).
Stricter than ``SlashAccessPolicy.is_admin()``, which is True for every caller when slash
gating is DISABLED — the default config would make everyone cross-origin-capable (IDOR)."""
try:
from gateway.slash_access import policy_for_source
policy = policy_for_source(self.config, source)
uid = getattr(source, "user_id", None)
return bool(policy.enabled and uid and policy.is_admin(uid))
except Exception:
return False
def _persisted_row_proves_owner(self, source: SessionSource, row: dict) -> bool:
"""Whether a persisted (inactive) session *row* provably belongs to *source*'s session key.
Rows once stored only source + user_id, so the persisted chat/thread origin is compared too
and legacy NULL rows fail closed. The table has no user_id_alt column, so an alt-keyed
(Signal/Feishu) caller is never proven by user_id alone (CWE-639)."""
caller_src = source.platform.value if source.platform else None
row_src = row.get("source")
caller_uid = _sattr(source, "user_id")
if not caller_uid:
return False
row_thread = str(row.get("thread_id") or "")
if not (row_src and caller_src and str(row_src) == str(caller_src)
and row_thread == _sattr(source, "thread_id")):
return False # blank/legacy source cannot prove the platform; other thread = other session
row_uid = str(row.get("user_id") or "")
row_chat = str(row.get("chat_id") or "")
caller_chat = _sattr(source, "chat_id")
caller_keys_on_alt = bool(_sattr(source, "user_id_alt"))
if _sattr(source, "chat_type").lower() in _DM_CHAT_TYPES:
# A no-chat_id DM is keyed PURELY on the participant (alt-keyed caller fails closed).
if caller_keys_on_alt and not (row_chat and caller_chat):
return False
return bool(row_uid) and row_uid == caller_uid and row_chat == caller_chat
# Non-DM: both sides must carry chat_id and match (legacy NULL-chat rows fail closed).
if not (row_chat and caller_chat and row_chat == caller_chat):
return False
# A SHARED group/thread is one session for everyone: same-chat proof suffices (a user-id
# check would block co-members). A per-user key still requires the same owner.
if self._is_shared_session_source(source):
return True
if caller_keys_on_alt:
return False
return bool(row_uid) and row_uid == caller_uid
async def _resume_target_allowed(self, source: SessionSource, target_id: str,
allow_override: bool = False) -> bool:
"""Whether *source* may resume session *target_id* (IDOR guard for every adapter). The live
origin decides when the target is active; otherwise the DB row must PROVE ownership or fail
closed. Admin ``--all`` bypasses."""
if allow_override and self._resume_caller_is_admin(source):
return True
# Only a real SessionSource origin decides; unresolvable/error falls through to DB scoping.
try:
origin = self._gateway_session_origin_for_id(target_id)
except Exception:
origin = None
if isinstance(origin, SessionSource):
return self._same_origin_chat(source, origin)
try:
row = await self._session_db.get_session(target_id) or {}
except Exception:
return False
return self._persisted_row_proves_owner(source, row)
async def _resume_row_visible(self, source: SessionSource, row: dict, allow_all: bool) -> bool:
"""Whether a listing *row* belongs to the caller's origin (blocks cross-origin enumeration of
ids/previews); Matrix is room-scoped, ``--all`` needs a configured admin everywhere."""
if allow_all and self._resume_caller_is_admin(source):
return True
sid = str(row.get("id") or "")
if source.platform == Platform.MATRIX:
return self._same_matrix_room(source, self._gateway_session_origin_for_id(sid))
return await self._resume_target_allowed(source, sid, allow_override=False)
# ------------------------------------------------------------------ /retry, /undo
async def _handle_retry_command(self, event: MessageEvent) -> str:
"""Handle /retry command - re-send the last user message."""
# The canonical projection skips bookkeeping rows (role=user + display_kind) and pure
# handoffs while still recognizing a real ask embedded in a compaction carrier.
from agent.context_compressor import (
history_before_user_originated_turn, retryable_user_text, split_user_originated_turn,
user_originated_turn_view)
source = event.source
session_entry = await self.async_session_store.get_or_create_session(source)
try:
history = await self.async_session_store.load_transcript(session_entry.session_id)
except TranscriptReadError:
return HISTORY_UNREADABLE
last_user_idx = next((i for i in range(len(history) - 1, -1, -1)
if user_originated_turn_view(history[i]) is not None), None)
if last_user_idx is None:
return t("gateway.retry.no_previous")
# Resolve text + scaffold-preserving prefix BEFORE any write; messaging retries cannot
# reconstruct attachments, so media/unknown content is rejected with the session untouched.
try:
truncated, live_view = history_before_user_originated_turn(history, last_user_idx)
last_user_msg = retryable_user_text(live_view.get("content"))
handoff, _ = split_user_originated_turn(history[last_user_idx])
except ValueError as exc:
return f"Cannot retry that message safely: {exc}"
if handoff is not None:
# Composite carrier (one row = retained summary + live ask): the carrier-aware rewind
# archives it and inserts the pure scaffold atomically, reselecting the latest carrier
# on the same snapshot so a concurrent newer turn is never removed for stale text.
try:
# Plain turns keep the existing rewrite path below; #84078 owns its separate
# archive_dropped/prefix-CAS semantics.
rewind_result = await self.async_session_store.rewind_session(
session_entry.session_id, 1, require_retryable_composite=True)
except ValueError as exc:
return f"Cannot retry that message safely: {exc}"
if rewind_result is None:
return "Retry failed; transcript was not changed."
last_user_msg = rewind_result["target_text"]
# active_only preserves the active=0/compacted=1 archive left by in-place compaction.
elif not await self.async_session_store.rewrite_transcript(
session_entry.session_id, truncated, active_only=True, reject_active_turn_lease=True):
return "Retry failed; transcript was not changed."
session_entry.last_prompt_tokens = 0 # transcript was truncated
return await self._handle_message(MessageEvent(
text=last_user_msg, message_type=MessageType.TEXT, source=source,
raw_message=event.raw_message, channel_prompt=event.channel_prompt))
async def _handle_undo_command(self, event: MessageEvent) -> str:
"""Handle /undo [N] — back up N user turns (default 1), soft-deleting the truncated rows and
echoing the backed-up text; evicts the cached agent so the next turn rebuilds from the
active-only transcript."""
source = event.source
n = 1
raw_args = event.get_command_args().strip()
if raw_args:
try:
n = max(1, int(raw_args.split()[0]))
except ValueError:
return t("gateway.undo.invalid_count", arg=raw_args.split()[0])
session_entry = await self.async_session_store.get_or_create_session(source)
result = await self.async_session_store.rewind_session(session_entry.session_id, n)
if result is None:
return t("gateway.undo.nothing")
session_entry.last_prompt_tokens = 0 # transcript was truncated
try:
# The cache is keyed by the profile-namespaced key; a bare build_session_key(source)
# yields ``agent:main:…`` and misses for every secondary profile.
self._evict_cached_agent(self._session_key_for_source(source))
except Exception as e:
logger.debug("undo: cached-agent eviction skipped: %s", e)
target_text = result["target_text"]
preview = target_text[:200] + "..." if len(target_text) > 200 else target_text
return t("gateway.undo.removed", turns=result["turns_undone"],
count=result["rewound_count"], preview=preview)
# --------------------------------------------------------------------- /compress
async def _handle_compress_command(self, event: MessageEvent) -> str:
"""Profile-scoping wrapper around manual /compress: multiplexed gateways resolve credentials
through the fail-closed per-profile secret scope, which slash dispatch (unlike ``_run_agent``)
does not install — unscoped, /compress would raise ``UnscopedSecretError``."""
if not getattr(getattr(self, "config", None), "multiplex_profiles", False):
return await self._handle_compress_command_inner(event)
from gateway.run import _profile_runtime_scope
with _profile_runtime_scope(self._resolve_profile_home_for_source(event.source)):
return await self._handle_compress_command_inner(event)
async def _compress_codex_app_server_session(self, session_key: str, session_id: str) -> str:
"""Manual /compress for codex_app_server sessions: compacts the LIVE cached agent's
app-server thread (``force=True`` bypasses the ``codex_app_server_auto`` gate) and keeps it
cached. A temporary agent or a mirror rewrite cannot shrink the server-side thread.
See #73503.
"""
from gateway.run import _AGENT_PENDING_SENTINEL
agent = self._cached_agent_for(session_key, lockless_fallback=True)
if agent is None or agent is _AGENT_PENDING_SENTINEL or getattr(agent, "_codex_session", None) is None:
return (
"🗜️ Nothing to compact: this session runs on the Codex app-server runtime, whose "
"context lives in a Codex-owned thread that only exists while the agent is active. "
"Send a message first, then /compress — or /reset to start fresh.")
compressor = getattr(agent, "context_compressor", None)
count_before = getattr(compressor, "compression_count", 0)
try:
await self._run_in_executor_with_context(
lambda: agent._compress_context([], "", force=True, task_id=session_id or "default"))
except Exception as exc:
return t("gateway.compress.failed", error=exc)
if getattr(compressor, "compression_count", 0) > count_before:
return (
"🗜️ Codex app-server thread compacted (thread/compact). The transcript mirror is "
"unchanged by design — the app-server now carries the compacted context.")
return (
"⚠️ Codex app-server compaction did not complete — the thread is unchanged. Check the "
"app-server logs, retry /compress, or /reset for a clean session.")
async def _handle_compress_command_inner(self, event: MessageEvent) -> str:
"""Handle /compress -- manually compress conversation context; ``/compress <focus>`` tells
the summariser what to preserve. Flags/positional forms are parsed by the shared core."""
from agent.conversation_compression_manual import MIN_MESSAGES, parse_compress_args
source = event.source
session_entry = await self.async_session_store.get_or_create_session(source)
try:
history = await self.async_session_store.load_transcript(session_entry.session_id)
except TranscriptReadError:
return HISTORY_UNREADABLE
if not history or len(history) < MIN_MESSAGES:
return t("gateway.compress.not_enough")
request = parse_compress_args(event.get_command_args() or "")
_agg_note = t("gateway.compress.aggressive_unsupported") if request.aggressive else ""
if request.aggressive and not request.preview:
return _agg_note
if request.preview:
return _compress_preview_reply(history, request.partial, request.keep_last, request.focus_topic, _agg_note)
try:
return await self._run_manual_compression(source, session_entry, history, request)
except Exception as e:
logger.warning("Manual compress failed: %s", e)
return t("gateway.compress.failed", error=e)
async def _run_manual_compression(self, source, session_entry, history: list, request) -> str:
"""Build a temporary agent, run the shared compress core, persist, and describe the outcome."""
from agent.conversation_compression import finalize_context_engine_compression_notification
from agent.conversation_compression_manual import compress_now, render_compress_result
from gateway.run import _platform_config_key
session_key = self._session_key_for_source(source)
# Platform + stable gateway session key bind this agent (for external context engines) to
# the original conversation, not a default "cli" host.
platform_key = _platform_config_key(source.platform) if source.platform else None
model, runtime_kwargs = self._resolve_session_agent_runtime(source=source, session_key=session_key)
if str(runtime_kwargs.get("api_mode") or "").lower() == "codex_app_server":
# Context lives in the server-side thread of the LIVE cached agent; a temporary agent
# has none (and finally-eviction would destroy the real context).
return await self._compress_codex_app_server_session(session_key, session_entry.session_id)
if not runtime_kwargs.get("api_key"):
return t("gateway.compress.no_provider")
# FULL transcript (tool results included), like auto-compress: user/assistant-only starves
# tool-result pruning and can trip the protect-first/last early-return.
msgs = [m for m in history if m.get("role") in {"user", "assistant", "tool"}]
# Assign, not setdefault (a resolver value would be a stale placeholder); platform only when
# known so None -> "cli" holds.
if platform_key is not None:
runtime_kwargs["platform"] = platform_key
runtime_kwargs["gateway_session_key"] = session_key
# Same reasoning setting as a live turn (session ``/reasoning`` > per-model > global): without it
# the transport applies its default effort — a 400 on non-reasoning models.
runtime_kwargs["reasoning_config"] = self._resolve_session_reasoning_config(source=source, model=model)
tmp_agent = await self._build_manual_compression_agent(session_entry.session_id, model, runtime_kwargs)
try:
# Not a bare run_in_executor: the profile secret scope is a contextvar the default
# executor hop would drop, failing aux-client credential resolution closed.
result = await self._run_in_executor_with_context(
lambda: compress_now(tmp_agent, msgs, request, system_message="", skip_without_window=True,
task_id=session_entry.session_id or "default"))
if result.status == "nothing_to_do":
return t("gateway.compress.nothing_to_do")
if result.status != "compressed":
return "\n".join(render_compress_result(result))
await self._persist_manual_compression(tmp_agent, session_entry, source, result.after_messages)
finalize_context_engine_compression_notification(tmp_agent, committed=True)
compressor = tmp_agent.context_compressor
summary = result.summary
finally:
finalize_context_engine_compression_notification(tmp_agent, committed=False)
self._evict_cached_agent(session_key) # next turn rebuilds the prompt from current files
# Off-loop + bounded: teardown can block on subprocess/network/SQLite.
await self._cleanup_agent_resources_off_loop(tmp_agent, context="manual compression")
return "\n".join(_manual_compression_reply_lines(summary, compressor, request.focus_topic))
async def _build_manual_compression_agent(self, session_id: str, model, runtime_kwargs: dict):
"""Build the throwaway AIAgent that performs a manual /compress rewrite of *session_id*."""
from run_agent import AIAgent
from gateway.run import _GATEWAY_HYGIENE_PLATFORM, _seed_hygiene_system_prompt
from hermes_cli.config import load_config as _load_cfg
from utils import is_truthy_value as _is_truthy
# _compress_context may persist its cached system prompt, and this agent runs outside the
# live session's prompt environment — restore the exact live prompt so provider blocks stay.
session_row = None
get_session = getattr(self._session_db, "get_session", None)
if callable(get_session):
try:
session_row = await get_session(session_id)
except Exception as exc:
logger.warning(
"Manual compression could not restore the system prompt for session %s: %s. "
"Preserving an empty prompt so the live turn rebuilds it with its configured "
"providers.", session_id, exc, exc_info=True)
# compression.checkpoint_required needs the memory provider loaded so _compress_context()
# can write the pre-compression checkpoint; otherwise keep the fast path (no provider init).
_checkpoint_required = _is_truthy(
((_load_cfg() or {}).get("compression") or {}).get("checkpoint_required"),
default=False)
tmp_agent = AIAgent(**runtime_kwargs, model=model, max_iterations=4, quiet_mode=True,
skip_memory=not _checkpoint_required, enabled_toolsets=["memory"],
session_id=session_id,
session_db=getattr(self._session_db, "_db", self._session_db))
_seed_hygiene_system_prompt(tmp_agent, session_row)
# Real platform during construction (context engines bind correctly); afterwards a prompt
# rebuilt by compression is stamped as the provider-less fallback, stale for the next turn.
tmp_agent.platform = _GATEWAY_HYGIENE_PLATFORM
tmp_agent._print_fn = lambda *a, **kw: None
# close() must not end the rotated session the gateway entry now points at.
tmp_agent._end_session_on_close = False
return tmp_agent
async def _persist_manual_compression(self, tmp_agent, session_entry, source, compressed) -> None:
"""Commit a manual /compress result to the session store. Rotation (new continuation id)
writes the compressed messages into the NEW session so the original stays searchable;
persist BEFORE repointing so a failed write is fatal and old history stays reachable.
In-place compaction already archived + inserted rows, and a rewrite would DELETE the
archive; an unchanged id without in-place means rotation FAILED."""
new_session_id = tmp_agent.session_id
if new_session_id != session_entry.session_id:
if not await self.async_session_store.rewrite_transcript(new_session_id, compressed):
raise RuntimeError(
f"failed to persist compressed transcript for session {new_session_id}")
session_entry.session_id = new_session_id
await self.async_session_store._save()
await asyncio.to_thread(self._sync_telegram_topic_binding, source, session_entry,
reason="compress-command")
elif not getattr(tmp_agent, "_last_compaction_in_place", False):
logger.warning(
"Manual /compress: session rotation did not occur (session_id unchanged) and in-place "
"mode is off — preserving original transcript instead of overwriting it (#44794).")
await self.async_session_store.update_session(session_entry.session_key, last_prompt_tokens=0)
# ------------------------------------------------------------------------ /topic
async def _handle_topic_command(self, event: MessageEvent, args: str = "") -> str:
"""Handle /topic for Telegram DM user-managed topic sessions."""
source = event.source
if source.platform != Platform.TELEGRAM or source.chat_type != "dm":
return t("gateway.topic.not_telegram_dm")
if not self._session_db:
return self._session_db_unavailable_reply()
# Defense in depth: /topic mutates SQLite side tables, so re-check the allowlist here.
try:
if not self._is_user_authorized_for_source(source):
return t("gateway.topic.unauthorized")
except Exception:
logger.debug("Topic auth check failed", exc_info=True)
args = event.get_command_args().strip()
if args.lower() in {"help", "?", "-h", "--help"}:
return self._telegram_topic_help_text()
if args.lower() in {"off", "disable", "stop"}:
return await self._disable_telegram_topic_mode_for_chat(source)
if args:
if not source.thread_id:
return t("gateway.topic.restore_needs_topic")
return await self._restore_telegram_topic_session(event, args)
capabilities = await self._get_telegram_topic_capabilities(source)
if capabilities.get("checked"):
blocked_key = None
if capabilities.get("has_topics_enabled") is False:
blocked_key = "gateway.topic.topics_disabled"
elif capabilities.get("allows_users_to_create_topics") is False:
blocked_key = "gateway.topic.topics_user_disallowed"
if blocked_key: # debounced BotFather screenshot
if self._should_send_telegram_capability_hint(source):
await self._send_telegram_topic_setup_image(source)
return t(blocked_key)
profile_name = self._telegram_topic_profile_name(source)
try:
await self._session_db.enable_telegram_topic_mode(
chat_id=str(source.chat_id), user_id=str(source.user_id), profile_name=profile_name,
has_topics_enabled=capabilities.get("has_topics_enabled"),
allows_users_to_create_topics=capabilities.get("allows_users_to_create_topics"))
except Exception as exc:
logger.exception("Failed to enable Telegram topic mode")
return t("gateway.topic.enable_failed", error=exc)
if not source.thread_id:
await self._ensure_telegram_system_topic(source)
return await self._telegram_topic_root_status_message(source)
try:
binding = await self._session_db.get_telegram_topic_binding(
chat_id=str(source.chat_id), thread_id=str(source.thread_id),
profile_name=profile_name)
except Exception:
logger.debug("Failed to read Telegram topic binding", exc_info=True)
binding = None
if not binding:
return t("gateway.topic.thread_ready")
session_id = str(binding.get("session_id") or "")
try:
title = await self._session_db.get_session_title(session_id)
except Exception:
title = None
return t("gateway.topic.bound_status", label=title or t("gateway.topic.untitled_session"),
session_id=session_id)
# ------------------------------------------------------------------ /save, /title
async def _handle_save_command(self, event: MessageEvent) -> str:
"""Handle /save — export the current session and send it as a document."""
import tempfile
from hermes_cli.session_export import (
SAVE_USAGE, default_save_filename, normalize_save_format, render_session_for_save)
parts = event.get_command_args().split()
redact = bool(parts) and parts[-1].lower() in ("redact", "--redact")
if redact:
parts = parts[:-1]
if not parts:
return SAVE_USAGE
try:
fmt = normalize_save_format(parts[0])
except ValueError as e:
return f"{e}\n\n{SAVE_USAGE}"
source = event.source
session_entry = await self.async_session_store.get_or_create_session(source)
session_id = session_entry.session_id
if not self._session_db:
return "Session database not available."
# Never trust path separators from chat input; the filename is only echoed to the platform.
filename = parts[1] if len(parts) > 1 else default_save_filename(session_id, fmt)
filename = os.path.basename(filename) or default_save_filename(session_id, fmt)
export_data = await self._session_db.export_session(session_id)
if not export_data:
return f"No stored messages found for this session ({session_id})."
if redact:
from hermes_cli.session_export_md import redact_session_data
export_data = redact_session_data(export_data)
temp_dir = tempfile.mkdtemp(prefix="hermes_save_")
temp_path = os.path.join(temp_dir, filename)
try:
# Off-loop: render + write scale with transcript size (multi-MB) and would stall the loop.
def _render_and_write() -> None:
rendered = render_session_for_save(export_data, fmt)
with open(temp_path, "w", encoding="utf-8") as f:
f.write(rendered)
await asyncio.to_thread(_render_and_write)
# Profile-aware: under multiplex the requester's bot lives in _profile_adapters, not self.adapters.
adapter = self._delivery_adapter_for(source)
if not adapter:
return "Platform adapter not found to send the document."
await adapter.send_document(chat_id=source.chat_id, file_path=temp_path,
caption=f"Session export: {filename}", file_name=filename)
return "Export complete."
except Exception as e:
logger.warning("Session /save failed: %s", e)
return f"Error exporting session: {e}"
finally:
with contextlib.suppress(Exception):
os.remove(temp_path)
os.rmdir(temp_dir)
async def _handle_title_command(self, event: MessageEvent) -> str:
"""Handle /title command — set or show the current session's title."""
source = event.source
session_entry = await self.async_session_store.get_or_create_session(source)
session_id = session_entry.session_id
if not self._session_db:
return self._session_db_unavailable_reply()
# The session may only exist in session_store so far (first command in a new session).
# The messaging origin is persisted so a later /resume of this titled-but-inactive session
# can prove it belongs to the caller's chat/thread (IDOR scoping).
if await self._session_db.get_session_title(session_id) is None:
with contextlib.suppress(Exception): # may already exist
await self._session_db.create_session(
session_id=session_id,
source=source.platform.value if source.platform else "unknown",
user_id=source.user_id, chat_id=source.chat_id, chat_type=source.chat_type,
thread_id=source.thread_id)
title_arg = event.get_command_args().strip()
if not title_arg:
title = await self._session_db.get_session_title(session_id)
if title:
return t("gateway.title.current_with_title", session_id=session_id, title=title)
return t("gateway.title.current_no_title", session_id=session_id)
try:
from hermes_state import SessionDB
sanitized = SessionDB.sanitize_title(title_arg)
except ValueError as e:
return t("gateway.shared.warn_passthrough", error=e)
if not sanitized:
return t("gateway.title.empty_after_clean")
try:
if not await self._session_db.set_session_title(session_id, sanitized):
return t("gateway.title.not_found")
except ValueError as e:
return t("gateway.shared.warn_passthrough", error=e)
# Mirror the title onto the Telegram forum topic name (auto titles already do this).
try:
await asyncio.to_thread(self._schedule_telegram_topic_title_rename, source, session_id, sanitized)
except Exception:
logger.debug("Failed to rename Telegram topic from /title", exc_info=True)
return t("gateway.title.set_to", title=sanitized)
# -------------------------------------------------------------- /resume, /sessions
async def _list_titled_sessions(self, source, session_key: str, allow_all: bool) -> list[dict]:
"""Titled sessions visible to the caller (origin-scoped unless admin ``--all``)."""
widen = allow_all and self._resume_caller_is_admin(source)
# Rank by lineage activity, not root started_at: a lineage compressed for days is projected
# onto its live tip and must sit where the user last touched it (#114271).
sessions = await self._session_db.list_sessions_rich(
source=source.platform.value if source.platform else None,
session_key=None if widen else session_key, limit=10, order_by_last_active=True)
titled = [s for s in sessions if s.get("title")][:10]
return [s for s in titled if await self._resume_row_visible(source, s, allow_all)]
async def _resolve_resume_target(self, source, session_key: str, name: str, allow_all: bool):
"""``(target_id, name)`` for a numbered choice, session id or title; else the error reply."""
if name.isdigit():
try:
titled = await self._list_titled_sessions(source, session_key, allow_all)
except Exception as e:
logger.debug("Failed to list titled sessions for numeric resume: %s", e)
return t("gateway.resume.list_failed", error=e)
index = int(name)
if index < 1 or index > len(titled):
return t("gateway.resume.out_of_range", index=index)
target = titled[index - 1]
target_id, name = target.get("id"), target.get("title") or name
else: # session id first, then title
session = await self._session_db.get_session(name)
target_id = session["id"] if session else await self._session_db.resolve_session_by_title(name)
if not target_id:
return t("gateway.resume.not_found", name=name)
# Follow compression continuations to the live transcript (matches CLI /resume).
try:
# Follow that chain so gateway /resume matches CLI behavior (#15000).
target_id = await self._session_db.resolve_resume_session_id(target_id)
except Exception as e:
logger.debug("Failed to resolve resume continuation for %s: %s", target_id, e)
return target_id, name
async def _resume_access_denied_reply(self, source, target_id: str, name: str, allow_all: bool,
allow_cross_room: bool) -> Optional[str]:
"""IDOR guard: a session id/title is a routing handle, not authority — bind /resume to the
caller's own room (Matrix) or platform/user/chat (other adapters)."""
if source.platform == Platform.MATRIX:
target_origin = self._gateway_session_origin_for_id(target_id)
if self._same_matrix_room(source, target_origin) or allow_cross_room:
return None
if target_origin is None:
return t("gateway.resume.matrix_blocked_no_origin", name=name)
return t("gateway.resume.matrix_blocked_other_room", name=name,
room=target_origin.chat_name or target_origin.chat_id)
if await self._resume_target_allowed(source, target_id, allow_override=(allow_all or allow_cross_room)):
return None
return t("gateway.resume.blocked_not_owner", name=name)
async def _handle_resume_command(self, event: MessageEvent) -> str:
"""Handle /resume command — list or switch to a previous session."""
if not self._session_db:
return self._session_db_unavailable_reply()
source = await asyncio.to_thread(self._normalize_source_for_session_key, event.source)
session_key = self._session_key_for_source(source)
try:
parts = shlex.split(event.get_command_args().strip())
except ValueError as exc:
return t("gateway.resume.parse_error", error=exc)
allow_all = "--all" in parts
allow_cross_room = "--cross-room" in parts
name = _strip_resume_name(parts)
if not name:
try:
titled = await self._list_titled_sessions(source, session_key, allow_all)
return self._resume_listing_reply(source, titled, allow_all)
except Exception as e:
logger.debug("Failed to list titled sessions: %s", e)
return t("gateway.resume.list_failed", error=e)
resolved = await self._resolve_resume_target(source, session_key, name, allow_all)
if isinstance(resolved, str):
return resolved
target_id, name = resolved
denied = await self._resume_access_denied_reply(source, target_id, name, allow_all, allow_cross_room)
if denied is not None:
return denied
current_entry = await self.async_session_store.get_or_create_session(source)
if current_entry.session_id == target_id:
return t("gateway.resume.already_on", name=name)
self._release_running_agent_state(session_key)
new_entry = await self.async_session_store.switch_session(session_key, target_id)
if not new_entry:
return t("gateway.resume.switch_failed")
# Conversation boundary: all conversation-scoped state + security state in one funnel call.
# Conversation boundary: clear ALL conversation-scoped per-session state (model/reasoning overrides
# #10702, one-turn restores, model notes, last-resolved cache #58403, /queue overflow) + security
# state in one funnel call. See _CONVERSATION_SCOPED_STATE in gateway/run.py.
self._clear_conversation_scope(session_key, reason="resume")
# Evict so the next turn rebuilds with the right session_id — the cached AIAgent's memory
# provider cached _session_id at initialize() and would keep writing to the wrong session.
self._evict_cached_agent(session_key)
title = await self._session_db.get_session_title(target_id) or name
try:
history = await self.async_session_store.load_transcript(target_id)
except TranscriptReadError:
# The resume itself succeeded; only the count is missing — say so rather than "empty".
return t("gateway.resume.resumed_no_count", title=title) + "\n" + HISTORY_UNREADABLE
msg_count = len([m for m in history if m.get("role") == "user"]) if history else 0
if source.platform == Platform.MATRIX and allow_cross_room:
msg_part = f" ({msg_count} message{'s' if msg_count != 1 else ''})" if msg_count else ""
return t("gateway.resume.matrix_cross_room_success", title=title,
room=source.chat_name or source.chat_id, msg_part=msg_part)
if not msg_count:
return t("gateway.resume.resumed_no_count", title=title)
if msg_count == 1:
return t("gateway.resume.resumed_one", title=title, count=msg_count)
return t("gateway.resume.resumed_many", title=title, count=msg_count)
def _resume_listing_reply(self, source, titled: list[dict], allow_all: bool) -> str:
"""Numbered /resume list; a non-admin ``--all`` falls back to same-origin scoping and says so
(sibling of the /sessions notice)."""
scope_note = None
if allow_all and not self._resume_caller_is_admin(source):
scope_note = t("gateway.resume.all_requires_admin")
if not titled:
if source.platform == Platform.MATRIX and not allow_all:
return t("gateway.resume.matrix_no_named_sessions")
base = t("gateway.resume.no_named_sessions")
return f"{base}\n{scope_note}" if scope_note else base
lines = [t("gateway.resume.list_header")]
for idx, s in enumerate(titled[:10], start=1):
title = s["title"]
if source.platform == Platform.MATRIX and allow_all:
origin = self._gateway_session_origin_for_id(str(s.get("id") or ""))
if origin:
title = f"{title} — {origin.chat_name or origin.chat_id}"
preview = s.get("preview", "")[:40]
preview_part = t("gateway.resume.list_preview_suffix", preview=preview) if preview else ""
lines.append(t("gateway.resume.list_item_numbered", index=idx, title=title, preview_part=preview_part))
if scope_note:
lines.append(scope_note)
lines.append(t("gateway.resume.list_footer_numbered"))
return "\n".join(lines)
async def _handle_sessions_command(self, event: MessageEvent) -> str:
"""Handle /sessions — list previous sessions for gateway chats."""
if not self._session_db:
return self._session_db_unavailable_reply()
from hermes_cli.session_listing import (
format_gateway_session_listing, parse_session_listing_args, query_session_listing)
try:
include_all, include_unnamed, target, search_query = parse_session_listing_args(
event.get_command_args().strip())
except ValueError as exc:
return t("gateway.resume.parse_error", error=exc)
if search_query == "":
return "Usage: `/sessions search <query>`"
if target:
return await self._handle_resume_command(dataclasses.replace(event, text=f"/resume {target}"))
source = await asyncio.to_thread(self._normalize_source_for_session_key, event.source)
session_key = self._session_key_for_source(source)
# `/sessions all` is admin-only like `/resume --all` (else any caller could enumerate other
# origins' ids/titles/previews); a non-admin gets explicit feedback, not a silent narrowing.
cross_origin = include_all and self._resume_caller_is_admin(source)
scope_notice = None
if include_all and not cross_origin:
scope_notice = "_Note: `all` (cross-chat listing) requires a configured admin; showing this chat's sessions only._"
current_entry = await self.async_session_store.get_or_create_session(source)
rows = await asyncio.to_thread(
query_session_listing, getattr(self._session_db, "_db", self._session_db),
source=source.platform.value if source.platform else None,
session_key=None if cross_origin else session_key,
current_session_id=current_entry.session_id, include_current_session=True,
include_all_sources=cross_origin, include_unnamed=include_unnamed,
search_query=search_query,
# Search filters in SQL: over-fetch so origin-invisible matches don't consume the page.
limit=50 if search_query else 10, exclude_sources=["tool"])
if not cross_origin:
rows = [row for row in rows if await self._resume_row_visible(source, row, allow_all=False)]
rows = rows[:10]
if search_query:
title = f"Sessions matching “{search_query}”"
else:
title = "Sessions" if include_unnamed else "Named Sessions"
return format_gateway_session_listing(rows, include_source=cross_origin, title=title,
notice=scope_notice)
# ----------------------------------------------------------------------- /branch
async def _handle_branch_command(self, event: MessageEvent) -> str:
"""Handle /branch [--here] [name] — fork the current session into an independent copy.
Thread-capable platforms (Discord/Telegram/Slack/Matrix) open a NEW sibling thread bound
to the clone and leave this chat on the original session; ``--here`` (and every platform
without threads) switches the current chat onto the clone instead (#66023).
"""
import json as _json
import uuid as _uuid
from datetime import datetime as _dt
if not self._session_db:
return self._session_db_unavailable_reply()
source = event.source
session_key = self._session_key_for_source(source)
current_entry = await self.async_session_store.get_or_create_session(source)
try:
history = await self.async_session_store.load_transcript(current_entry.session_id)
except TranscriptReadError:
return HISTORY_UNREADABLE
if not history:
return t("gateway.branch.no_conversation")
new_session_id = f"{_dt.now().strftime('%Y%m%d_%H%M%S')}_{_uuid.uuid4().hex[:6]}"
stay_here, branch_title = parse_branch_args(event.get_command_args())
if not branch_title:
current_title = await self._session_db.get_session_title(current_entry.session_id)
branch_title = await self._session_db.get_next_title_in_lineage(current_title or "branch")
parent_session_id = current_entry.session_id
# The thread is created BEFORE the clone so a failed create never orphans a branch row;
# ``None`` = branch in place (--here, no threads here, or the adapter could not open one).
dest_source = None if stay_here else await self._branch_open_thread(source, branch_title)
in_place = dest_source is None
if in_place:
dest_source = source
dest_key = session_key if in_place else self._session_key_for_source(dest_source)
# Full origin (same shape as the reset path in gateway/session.py); the live entry's origin
# may hold richer metadata than the triggering event's source (#82633). A thread branch
# is routed by the NEW thread, so its origin is the destination.
_branch_origin_json = None
with contextlib.suppress(Exception):
_origin = (current_entry.origin or source) if in_place else dest_source
_branch_origin_json = _json.dumps(_origin.to_dict())
# ``_branched_from`` keeps the branch visible in /resume and /sessions after the parent is
# reopened and re-ended. ALL routing columns go in at CREATE time: a crash before
# switch_session() records the peer would otherwise leave the branch unroutable.
try:
await self._session_db.create_session(
session_id=new_session_id,
source=source.platform.value if source.platform else "gateway",
model=(self.config.get("model", {}) or {}).get("default") if isinstance(self.config, dict) else None,
model_config={"_branched_from": parent_session_id},
parent_session_id=parent_session_id, user_id=dest_source.user_id,
session_key=dest_key, chat_id=dest_source.chat_id, chat_type=dest_source.chat_type,
thread_id=dest_source.thread_id, origin_json=_branch_origin_json,
display_name=current_entry.display_name)
except Exception as e:
logger.error("Failed to create branch session: %s", e)
return t("gateway.branch.create_failed", error=e)
# Chunked transactions; best-effort — a failed copy still yields a usable (partial) branch.
with contextlib.suppress(Exception):
# Copy conversation history to the new session in bounded-chunk transactions (see #23254): one
# txn per row was the removed write-amplification pattern, and a history can be hundreds of
# rows.
await self._session_db.append_messages_batch(
new_session_id, [_branch_row(msg) for msg in history], chunk_rows=500)
with contextlib.suppress(Exception):
await self._session_db.set_session_title(new_session_id, branch_title)
if not in_place:
# Materialize the thread's own entry, then point IT at the clone; ``session_key`` (this
# chat) is never touched, so the original conversation stays live here.
await self.async_session_store.get_or_create_session(dest_source)
new_entry = await self.async_session_store.switch_session(dest_key, new_session_id)
if not new_entry:
return t("gateway.branch.switch_failed")
self._clear_session_boundary_security_state(dest_key)
self._evict_cached_agent(dest_key)
msg_count = len([m for m in history if m.get("role") == "user"])
if in_place:
key = "gateway.branch.branched_one" if msg_count == 1 else "gateway.branch.branched_many"
reply = t(key, title=branch_title, count=msg_count, parent=parent_session_id, new=new_session_id)
if not stay_here and source.platform in BRANCH_THREAD_PLATFORMS:
reply += "\n" + t("gateway.branch.thread_fallback")
return reply
key = "gateway.branch.branched_thread_one" if msg_count == 1 else "gateway.branch.branched_thread_many"
return t(key, title=branch_title, count=msg_count, parent=parent_session_id, new=new_session_id,
thread=format_thread_ref(source.platform, dest_source.thread_id))
async def _branch_open_thread(self, source: SessionSource, title: str) -> Optional[SessionSource]:
"""Open the sibling thread a plain ``/branch`` clones into; the destination source, or
None when this chat cannot host one (in-place fallback)."""
parent_id = branch_thread_parent(source)
adapter = self._delivery_adapter_for(source) if parent_id else None
if adapter is None:
return None
try:
thread_id = await adapter.create_handoff_thread(parent_id, title)
except Exception:
logger.warning("Branch: create_handoff_thread failed on %s; branching in place",
source.platform.value, exc_info=True)
return None
if not thread_id:
return None
# Discord only answers un-mentioned follow-ups in threads it has participated in.
threads = getattr(adapter, "_threads", None)
if threads is not None:
threads.mark(str(thread_id))
return branch_dest_source(source, parent_id=parent_id, thread_id=str(thread_id), title=title)