Files
hermes-webui/api/session_ops.py
T
4d03578192 fix(#6611): make regeneration start atomic (#6677)
* fix(#6611): make regeneration transaction canonical

* fix(#6611): close cross-provider regeneration blockers

* fix(#6611): harden regeneration transaction boundaries

* fix(#6611): bind canonical context and fork lineage

* fix(#6611): restore active turn token stamping

* test(#6611): make regeneration regressions CI portable

* test(#6611): preserve the tracked regeneration error fixture

* fix(#6611): preserve extracted session harness contracts

* fix(regeneration): preserve concurrent and imported turn ownership (#6611)

* fix(regeneration): honor imported turn ownership safely (#6611)

* test(regeneration): cover both session lock outcomes (#6611)

* test(regeneration): clear unused transaction fixtures (#6611)

* fix(#6611): consume public active-turn marker

* ci: re-trigger (Playwright install hung ~2.5h on GH runners, warm-cache retry)

---------

Co-authored-by: nesquena-hermes <nesquena+hermes@gmail.com>
Co-authored-by: n <a@n>
2026-08-19 11:11:53 +00:00

1007 lines
41 KiB
Python

"""Session-mutation operations for slash commands (/retry, /undo) and
read-only aggregators (/status, /usage). Operates on the webui's own
JSON Session store (api/models.py), not on hermes-agent's SQLite.
Behavior parity reference: gateway/run.py:_handle_*_command in
the hermes-agent repo.
"""
from __future__ import annotations
import json
import logging
import uuid
import copy
import hashlib
import math
from dataclasses import dataclass
from contextlib import nullcontext
from bisect import bisect_left
from typing import Any
from api.config import LOCK, _get_session_agent_lock
from api.models import get_session, SESSIONS
from api.agent_sessions import normalize_agent_session_source
logger = logging.getLogger(__name__)
AUTO_TITLE_LABELS = {'untitled', 'new chat'}
class RegenerationUnavailable(Exception):
def __init__(self, code: str, status: int = 409, message: str | None = None):
super().__init__(message or code)
self.code = code
self.status = status
def _regeneration_source_class(value):
raw = str(value or "").strip().lower()
if not raw:
return ""
if raw == "fork":
return "fork"
normalized = normalize_agent_session_source(raw).get("session_source")
return str(normalized or raw).strip().lower()
def _regeneration_source_allowed(value):
return _regeneration_source_class(value) in {"webui", "fork"}
def _selected_regeneration_turn_owned(session, row) -> bool:
"""Accept only a final row whose provenance proves WebUI ownership."""
if getattr(session, "read_only", False) or not isinstance(row, dict):
return False
session_source = _regeneration_source_class(getattr(session, "session_source", None))
imported_session = bool(
getattr(session, "is_cli_session", False)
or session_source not in {"", "webui", "fork"}
)
raw_sources = (
getattr(session, "raw_source", None),
getattr(session, "source_tag", None),
)
row_source = row.get("_source") or row.get("source")
if session_source == "fork":
if any(source and not _regeneration_source_allowed(source) for source in raw_sources):
return False
if row_source and not _regeneration_source_allowed(row_source):
return False
return bool(
getattr(session, "parent_session_id", None)
and row.get("_fork_child_turn") == getattr(session, "session_id", None)
)
if imported_session:
token = row.get("_active_turn_token")
if not isinstance(token, str) or not token.strip() or ":" not in token:
return False
stream_id, started_at = token.rsplit(":", 1)
try:
started = float(started_at)
except (TypeError, ValueError):
return False
from api.process_event_utils import build_active_turn_token
if not math.isfinite(started) or started <= 0:
return False
if build_active_turn_token(stream_id, started) != token:
return False
else:
if any(source and not _regeneration_source_allowed(source) for source in raw_sources):
return False
if row_source and not _regeneration_source_allowed(row_source):
return False
return True
@dataclass(frozen=True)
class RegenerationTurn:
user_index: int
assistant_index: int
message: dict
message_text: str
attachments: list
source: str
message_count: int
revision: str
row_digest: str
@dataclass(frozen=True)
class RegenerationPlan:
canonical_rows: list
canonical_context: list
turn: RegenerationTurn
revision: str
row_digest: str
message_count: int
truncation_boundary: int
def plan_regeneration(session, *, expected_revision=None, lock_held=False):
"""Prepare one canonical display/context pair for a locked regeneration."""
lock_context = nullcontext() if lock_held else _get_session_agent_lock(session.session_id)
with lock_context:
rows, context = regeneration_state(session)
revision = regeneration_revision_for(rows, session=session, context=context)
if expected_revision is not None and expected_revision != revision:
raise RegenerationUnavailable("stale_regeneration_revision")
turn = resolve_regeneration_turn(
rows, session=session, expected_revision=revision,
lock_held=True, context=context,
)
return RegenerationPlan(
canonical_rows=copy.deepcopy(rows),
canonical_context=copy.deepcopy(context),
turn=turn,
revision=revision,
row_digest=turn.row_digest,
message_count=len(rows),
truncation_boundary=turn.user_index + 1,
)
def apply_regeneration_plan(
session,
plan: RegenerationPlan,
*,
return_context_user: bool = False,
):
"""Install the prepared pair and truncate it without a second authority read."""
def _result(success, context_user=None):
return (success, context_user) if return_context_user else success
if not isinstance(plan, RegenerationPlan):
return _result(False)
rows = copy.deepcopy(plan.canonical_rows)
context = copy.deepcopy(plan.canonical_context)
if len(rows) != plan.message_count or plan.truncation_boundary != plan.turn.user_index + 1:
return _result(False)
if regeneration_revision_for(rows, session=session, context=context) != plan.revision:
return _result(False)
session.messages = rows
session.context_messages = context
current = session.messages[plan.turn.user_index]
if not isinstance(current, dict) or current.get("role") != "user":
return _result(False)
truncate_session_at_keep(session, plan.truncation_boundary)
prepared_context, context_boundary_index = truncate_context_for_display_keep(
context,
rows,
plan.truncation_boundary,
return_boundary_index=True,
)
session.context_messages = prepared_context if prepared_context or not context else context[: plan.truncation_boundary]
retained_context_user = None
if context_boundary_index is not None:
for context_row in reversed(session.context_messages[: context_boundary_index + 1]):
if isinstance(context_row, dict) and context_row.get("role") == "user":
retained_context_user = context_row
break
return _result(True, retained_context_user)
def snapshot_regeneration_state(session):
return copy.deepcopy(session.__dict__)
def restore_regeneration_state(session, snapshot):
session.__dict__.clear()
session.__dict__.update(copy.deepcopy(snapshot))
def regeneration_revision_for(rows, *, session=None, context=None) -> str:
"""Hash the canonical writable transcript and its aligned context."""
payload = json.dumps(
{
"session_id": str(getattr(session, "session_id", "") or "") if session is not None else "",
"messages": list(rows or []),
"context_messages": list(context or []),
"truncation_watermark": getattr(session, "truncation_watermark", None) if session is not None else None,
"truncation_boundary": getattr(session, "truncation_boundary", None) if session is not None else None,
},
sort_keys=True,
separators=(",", ":"),
default=str,
)
return hashlib.sha256(payload.encode("utf-8")).hexdigest()
def regeneration_transcript(session, *, state_messages=None):
"""Return the state.db-reconciled transcript used by every authority consumer."""
if state_messages is None:
return regeneration_state(session)[0]
from api.models import reconciled_state_db_messages_for_session
return reconciled_state_db_messages_for_session(session, state_messages=state_messages)
def regeneration_context(session):
return regeneration_state(session)[1]
def regeneration_state(session):
"""Read one immutable state.db snapshot and reconcile both transcript views."""
from api.models import (
get_state_db_session_messages,
reconciled_state_db_messages_for_session,
)
state_messages = get_state_db_session_messages(
getattr(session, "session_id", None),
profile=getattr(session, "profile", None),
)
return (
reconciled_state_db_messages_for_session(
session,
state_messages=state_messages,
),
reconciled_state_db_messages_for_session(
session,
prefer_context=True,
state_messages=state_messages,
),
)
def regeneration_revision(session) -> str:
rows, context = regeneration_state(session)
return regeneration_revision_for(
rows,
session=session,
context=context,
)
def regeneration_authority(
session,
rows=None,
*,
context=None,
full_transcript=True,
canonical_state=None,
):
"""Mint a revision only for a complete, writable, canonical transcript."""
if not full_transcript:
return None
if getattr(session, "active_stream_id", None) or getattr(session, "pending_user_message", None):
return None
canonical_rows, canonical_context = canonical_state or regeneration_state(session)
rows = list(canonical_rows if rows is None else rows)
if not rows:
return None
if rows != canonical_rows:
return None
if context is not None and list(context or []) != canonical_context:
return None
try:
resolve_regeneration_turn(
canonical_rows,
session=session,
context=canonical_context,
)
except RegenerationUnavailable:
return None
return regeneration_revision_for(
canonical_rows,
session=session,
context=canonical_context,
)
def resolve_regeneration_turn(
rows,
*,
session=None,
expected_revision=None,
lock_held=False,
context=None,
):
"""Select the current session's final complete local exchange under its lock."""
legacy_session_call = session is None and not isinstance(rows, (list, tuple))
legacy_context = None
if legacy_session_call:
session = rows
rows, legacy_context = regeneration_state(session)
lock_context = (
_get_session_agent_lock(session.session_id)
if legacy_session_call and not lock_held
else nullcontext()
)
with lock_context:
rows = list(rows or [])
if context is None:
context = legacy_context
if context is None:
_, context = regeneration_state(session)
context = list(context)
revision = regeneration_revision_for(rows, session=session, context=context)
if expected_revision is not None and expected_revision != revision:
raise RegenerationUnavailable("stale_regeneration_revision")
if getattr(session, "active_stream_id", None):
raise RegenerationUnavailable("session_active")
if getattr(session, "pending_user_message", None):
raise RegenerationUnavailable("session_active")
assistant_index = next(
(
index
for index in range(len(rows) - 1, -1, -1)
if isinstance(rows[index], dict)
and rows[index].get("role") == "assistant"
and _assistant_message_has_final_visible_text(rows[index])
),
None,
)
if assistant_index is not None:
index = next(
(
candidate
for candidate in range(assistant_index - 1, -1, -1)
if isinstance(rows[candidate], dict)
and rows[candidate].get("role") == "user"
),
None,
)
else:
index = None
if index is not None:
if any(
isinstance(row, dict) and row.get("role") == "user"
for row in rows[assistant_index + 1:]
):
raise RegenerationUnavailable("no_regenerable_turn", 400)
if any(
isinstance(row, dict) and row.get("role") in {"assistant", "tool"}
for row in rows[assistant_index + 1:]
):
raise RegenerationUnavailable("no_regenerable_turn", 400)
row = rows[index]
if not _selected_regeneration_turn_owned(session, row):
raise RegenerationUnavailable("regeneration_read_only", 403)
content = _extract_text(row.get("content", ""))
if content:
row_digest = hashlib.sha256(
json.dumps(
row,
sort_keys=True,
separators=(",", ":"),
default=str,
).encode("utf-8")
).hexdigest()
return RegenerationTurn(
index,
assistant_index,
copy.deepcopy(row),
content,
copy.deepcopy(row.get("attachments") or []),
str(row.get("_source") or "webui"),
len(rows),
revision,
row_digest,
)
raise RegenerationUnavailable("no_regenerable_turn", 400)
def _assistant_message_has_final_visible_text(message) -> bool:
from api.streaming import _assistant_message_has_final_visible_text as _has_final_text
return _has_final_text(message)
def _live_active_stream_id(session) -> str | None:
"""Return session.active_stream_id ONLY if that stream is live in THIS
process; else None.
After a restart/crash the persisted active_stream_id survives in the
session JSON but the in-memory STREAMS / ACTIVE_RUNS that actually drive a
live turn were wiped. Exposing that dead id (e.g. via /api/session/status to
the hidden-tab poller) would make a client attach its renderer to a stream
that never emits — a permanent fake "thinking" state. Liveness test mirrors
routes._clear_stale_stream_state: live iff present in STREAMS (open SSE
channel) or ACTIVE_RUNS (worker bookkeeping) — except that a
``phase="cancelling"`` run is excluded on both paths, because the worker may
still be unwinding while the client already reached a terminal state for
that stream.
"""
stream_id = getattr(session, 'active_stream_id', None)
if not stream_id:
return None
try:
from api import config as _cfg
with _cfg.ACTIVE_RUNS_LOCK:
_active_run_present = stream_id in (_cfg.ACTIVE_RUNS or {})
_active_run_entry = (_cfg.ACTIVE_RUNS or {}).get(stream_id)
if _active_run_present and not _cfg.active_run_is_attachable(_active_run_entry):
return None
with _cfg.STREAMS_LOCK:
if stream_id in _cfg.STREAMS:
return stream_id
if _active_run_present:
return stream_id
except Exception:
# On any introspection failure, fail SAFE (report no live stream) rather
# than surfacing a possibly-stale id.
return None
return None
def session_has_manual_title(session) -> bool:
"""Return whether adaptive title refresh should leave this title alone."""
return getattr(session, 'manual_title', False) is True
def apply_session_title_rename(session, raw_title) -> str:
"""Apply user-driven rename semantics to a Session object.
Non-empty custom titles are protected from adaptive refresh. Clearing the
title, or resetting it to an automatic label, removes that protection so the
normal auto-title path can run again.
"""
title = str(raw_title or '').strip()[:80]
if not title:
title = 'Untitled'
manual_title = title.strip().casefold() not in AUTO_TITLE_LABELS
session.title = title
session.manual_title = manual_title
session.llm_title_generated = False
return title
def mark_session_title_generated(session) -> None:
"""Mark a session title as generated by the title model."""
session.llm_title_generated = True
session.manual_title = False
def _truncate_at_last_user(messages):
history = messages or []
last_user_idx = None
for i in range(len(history) - 1, -1, -1):
if isinstance(history[i], dict) and history[i].get('role') == 'user':
last_user_idx = i
break
if last_user_idx is None:
return None
return history[:last_user_idx]
def _truncation_watermark_for(messages):
history = list(messages or [])
if not history:
return 0.0
try:
return float(history[-1].get('timestamp') or 0)
except (AttributeError, TypeError, ValueError):
return 0.0
def _stamp_intentional_shrink_generation(session, old_message_count: int, new_message_count: int) -> bool:
"""Stamp a new generation only when the visible message list shrinks."""
if new_message_count >= old_message_count:
return False
session.intentional_shrink_generation = uuid.uuid4().hex
return True
def truncate_context_for_display_keep(
context_messages: list | None,
full_messages: list | None,
keep: int,
*,
return_boundary_index: bool = False,
) -> list:
"""Align model context with display prefix ``full_messages[:keep]``."""
def _result(rows, boundary_index=None):
return (rows, boundary_index) if return_boundary_index else rows
if keep <= 0:
return _result([])
ctx = context_messages if isinstance(context_messages, list) else []
msgs = full_messages if isinstance(full_messages, list) else []
if not ctx:
return _result([])
if len(msgs) == 0:
return _result([])
# Only the perfectly-parallel case (display and context row-for-row) can be
# sliced at the raw display index. When the two arrays differ in length —
# in EITHER direction — they have diverged and need alignment:
# * context LONGER than display → an injected summary/system prefix, etc.
# * context SHORTER than display → large-session context trimming dropped
# turns from the model context that the display still shows.
# The shorter-context case is the one that broke forked large sessions: the
# old ``len(ctx) <= len(msgs)`` guard short-circuited to ``ctx[:keep]``,
# slicing the shorter context at the display index (landing mid-turn, e.g.
# on an assistant tool_call whose result was past the cut). Fall through to
# the signature matcher for both divergent cases so the cut lands on a real
# turn boundary. Any residual dangling tool_use in the persisted context is
# made wire-safe on the send path (streaming: ``_sanitize_messages_for_api``
# strips unanswered tool_calls; gateway: it forwards no tool_calls/tool rows
# at all), so we do not re-do that trimming here.
if len(ctx) == len(msgs):
return _result(ctx[:keep], min(keep, len(ctx)) - 1)
def _row_signature(row: Any) -> tuple[str, ...] | None:
if not isinstance(row, dict):
return None
tool_calls = row.get('tool_calls')
tool_calls_sig = json.dumps(tool_calls, sort_keys=True, default=str) if tool_calls else ''
return (
str(row.get('role') or ''),
str(row.get('content') or ''),
str(row.get('tool_call_id') or ''),
str(row.get('tool_use_id') or ''),
str(row.get('tool_name') or row.get('name') or ''),
tool_calls_sig,
)
# Materialize signatures once. The matcher deliberately keeps the original
# rows in ``ctx``; these records are only an alignment index. A signature
# failure is deferred because the old matcher may return before reaching it.
context_records = []
deferred_signature_positions: list[int] = []
for idx, row in enumerate(ctx):
try:
row_signature = _row_signature(row)
except Exception:
row_signature = None
deferred_signature_positions.append(idx)
context_records.append((row, row_signature))
message_signatures = [_row_signature(message) for message in msgs]
id_positions: dict[Any, list[int]] = {}
signature_positions: dict[tuple[str, ...], list[int]] = {}
signature_no_id_positions: dict[tuple[str, ...], list[int]] = {}
signature_no_timestamp_positions: dict[tuple[str, ...], list[int]] = {}
signature_no_id_no_timestamp_positions: dict[tuple[str, ...], list[int]] = {}
signature_timestamp_positions: dict[
tuple[tuple[str, ...], Any], list[int]
] = {}
signature_timestamp_no_id_positions: dict[
tuple[tuple[str, ...], Any], list[int]
] = {}
unsafe_id_positions: list[int] = []
unsafe_timestamp_positions: dict[tuple[str, ...], list[int]] = {}
unsafe_timestamp_no_id_positions: dict[tuple[str, ...], list[int]] = {}
def _safe_raw_value(value: Any) -> bool:
# Keep dict lookup semantics aligned with the old explicit ``==`` scan:
# only ordinary built-in metadata values may use the raw-value indexes.
# In particular, custom objects and non-reflexive NaN values can make a
# dict find a key that the old equality check rejected.
if value is None:
return True
if type(value) not in (str, int, float):
return False
try:
hash(value)
return value == value
except Exception:
return False
for idx, (context_row, context_sig) in enumerate(context_records):
if context_sig is not None:
signature_positions.setdefault(context_sig, []).append(idx)
if not isinstance(context_row, dict):
continue
context_id = context_row.get('id')
context_ts = context_row.get('timestamp')
if context_sig is not None:
if context_id is None:
signature_no_id_positions.setdefault(context_sig, []).append(idx)
if context_ts is None:
signature_no_timestamp_positions.setdefault(context_sig, []).append(idx)
if context_id is None and context_ts is None:
signature_no_id_no_timestamp_positions.setdefault(
context_sig, []
).append(idx)
if context_id is not None and _safe_raw_value(context_id):
id_positions.setdefault(context_id, []).append(idx)
elif context_id is not None:
unsafe_id_positions.append(idx)
if (
context_sig is not None
and context_ts is not None
and _safe_raw_value(context_ts)
):
timestamp_key = (context_sig, context_ts)
signature_timestamp_positions.setdefault(timestamp_key, []).append(idx)
if context_id is None:
signature_timestamp_no_id_positions.setdefault(
timestamp_key, []
).append(idx)
elif context_sig is not None and context_ts is not None:
unsafe_timestamp_positions.setdefault(context_sig, []).append(idx)
if context_id is None:
unsafe_timestamp_no_id_positions.setdefault(
context_sig, []
).append(idx)
def _first_at_or_after(positions: list[int] | None, start_idx: int) -> int | None:
if not positions:
return None
offset = bisect_left(positions, start_idx)
return positions[offset] if offset < len(positions) else None
def _lazy_first_match_from(
message: Any,
start_idx: int,
) -> tuple[int | None, int | None]:
"""Match exactly as the original ordered scan did."""
msg_sig = _row_signature(message)
if msg_sig is None:
return None, None
weak_matches: list[int] = []
for idx in range(start_idx, len(ctx)):
context_row = ctx[idx]
context_sig = _row_signature(context_row)
if context_sig is None or not isinstance(context_row, dict):
continue
context_id = context_row.get('id')
msg_id = message.get('id')
if context_id is not None and msg_id is not None:
if context_id == msg_id:
return idx, None
continue
if context_sig != msg_sig:
continue
context_ts = context_row.get('timestamp')
msg_ts = message.get('timestamp')
if context_ts is not None and msg_ts is not None:
if context_ts == msg_ts:
return idx, None
continue
weak_matches.append(idx)
if len(weak_matches) > 1:
return None, weak_matches[0]
return (weak_matches[0], None) if len(weak_matches) == 1 else (None, None)
def _first_match_from(
message_idx: int,
message: Any,
start_idx: int,
) -> tuple[int | None, int | None]:
msg_sig = message_signatures[message_idx]
if msg_sig is None:
return None, None
msg_id = message.get('id')
msg_ts = message.get('timestamp')
deferred_reachable = _first_at_or_after(
deferred_signature_positions, start_idx
) is not None
unsafe_id_reachable = (
msg_id is not None
and _first_at_or_after(unsafe_id_positions, start_idx) is not None
)
unsafe_timestamp_candidates = (
unsafe_timestamp_no_id_positions.get(msg_sig, [])
if msg_id is not None
else unsafe_timestamp_positions.get(msg_sig, [])
)
unsafe_timestamp_reachable = (
msg_ts is not None
and _first_at_or_after(unsafe_timestamp_candidates, start_idx) is not None
)
if not _safe_raw_value(msg_id) or not _safe_raw_value(msg_ts):
return _lazy_first_match_from(message, start_idx)
if deferred_reachable or unsafe_id_reachable or unsafe_timestamp_reachable:
return _lazy_first_match_from(message, start_idx)
exact_positions: list[int] = []
if msg_id is not None:
id_idx = _first_at_or_after(id_positions.get(msg_id), start_idx)
if id_idx is not None:
exact_positions.append(id_idx)
if msg_ts is not None:
timestamp_key = (msg_sig, msg_ts)
if msg_id is not None:
timestamp_positions = signature_timestamp_no_id_positions.get(
timestamp_key, []
)
else:
timestamp_positions = signature_timestamp_positions.get(
timestamp_key, []
)
timestamp_idx = _first_at_or_after(timestamp_positions, start_idx)
if timestamp_idx is not None:
exact_positions.append(timestamp_idx)
exact_idx = min(exact_positions, default=None)
if msg_id is not None and msg_ts is not None:
weak_candidates = signature_no_id_no_timestamp_positions.get(msg_sig)
elif msg_id is not None:
weak_candidates = signature_no_id_positions.get(msg_sig)
elif msg_ts is not None:
weak_candidates = signature_no_timestamp_positions.get(msg_sig)
else:
weak_candidates = signature_positions.get(msg_sig)
weak_start = bisect_left(weak_candidates, start_idx) if weak_candidates else 0
weak_positions = weak_candidates[weak_start:weak_start + 2] if weak_candidates else []
second_weak_idx = weak_positions[1] if len(weak_positions) > 1 else None
if second_weak_idx is not None and (
exact_idx is None or second_weak_idx < exact_idx
):
return None, weak_positions[0]
if exact_idx is not None:
return exact_idx, None
return (weak_positions[0], None) if len(weak_positions) == 1 else (None, None)
matches = [None] * len(msgs)
ambiguous_matches = [None] * len(msgs)
next_ctx_idx = 0
for msg_idx, message in enumerate(msgs):
match_idx, ambiguous_idx = _first_match_from(msg_idx, message, next_ctx_idx)
matches[msg_idx] = match_idx
ambiguous_matches[msg_idx] = ambiguous_idx
if match_idx is not None:
next_ctx_idx = match_idx + 1
# Cut at the first unkept display turn, or fallback to the last kept turn
# if the boundary is not directly alignable.
if keep < len(msgs):
last_kept = None
if keep > 0:
last_kept = matches[keep - 1]
first_unkept = matches[keep]
if first_unkept is not None:
if (
last_kept is not None
and isinstance(msgs[keep - 1], dict)
and msgs[keep - 1].get('role') == 'user'
):
return _result(ctx[:last_kept + 1], last_kept)
return _result(ctx[:first_unkept], first_unkept - 1)
if last_kept is not None:
ambiguous_first_unkept = ambiguous_matches[keep]
if (
ambiguous_first_unkept is not None
and isinstance(msgs[keep - 1], dict)
and msgs[keep - 1].get('role') != 'user'
):
return _result(ctx[:ambiguous_first_unkept], ambiguous_first_unkept - 1)
return _result(ctx[:last_kept + 1], last_kept)
# Both boundary rows were ambiguous/unmatched (common in large sessions
# where context rows have lost their id/timestamp so the matcher can't
# disambiguate structurally-identical rows). Only for the shorter-context
# case: cut just past the LAST display row in the kept prefix that
# resolved to a context index — preferring an exact match but accepting
# an ambiguous (weak) one, mirroring how the sibling branches above fold
# ``ambiguous_matches`` into the boundary. Accepting the weak match keeps
# the forked boundary turn's own context (often exactly that ambiguous
# row) instead of dropping back to an earlier exact match. It still errs
# toward UNDER-keeping rather than slicing at the raw display index,
# which would over-keep and mis-attribute later context rows to the kept
# display turns. The context-longer case (injected summary prefix) is
# left to the #5096 fallback below, which preserves that prefix.
if len(ctx) < len(msgs):
for i in range(keep - 1, -1, -1):
resolved = matches[i] if matches[i] is not None else ambiguous_matches[i]
if resolved is not None:
return _result(ctx[:resolved + 1], resolved)
# Final fallback preserves #5096 behavior when alignment is unreliable
# (no display row resolved to a context index, or keep >= len(msgs)).
prefix_len = max(0, len(ctx) - len(msgs))
prefix = ctx[:prefix_len]
suffix = ctx[prefix_len:]
result = prefix + suffix[:keep]
return _result(result, len(result) - 1 if result else None)
def truncate_session_at_keep(session, keep: int) -> tuple[int, int]:
"""Truncate display + context; set watermark/boundary. Returns old counts."""
full_messages = list(session.messages or [])
old_msg_count = len(full_messages)
old_ctx_count = len(getattr(session, 'context_messages', None) or [])
session.messages = full_messages[:keep]
_stamp_intentional_shrink_generation(session, old_msg_count, len(session.messages))
if isinstance(getattr(session, 'context_messages', None), list):
session.context_messages = truncate_context_for_display_keep(
session.context_messages,
full_messages,
keep,
)
session.truncation_watermark = _truncation_watermark_for(session.messages)
session.truncation_boundary = session.truncation_watermark
return old_msg_count, old_ctx_count
def retry_last(session_id: str) -> dict[str, Any]:
"""Truncate the session to before the last user message, return its text.
Mirrors gateway/run.py:_handle_retry_command. Caller (webui frontend)
is expected to put the returned text back in the composer and call
send() to resume the conversation -- the agent's gateway calls its own
_handle_message; the webui has no equivalent in-process pipeline.
Raises:
KeyError: session not found
ValueError: no user message in transcript
"""
# Acquire the per-session agent lock as the outermost lock so that the
# read-modify-write of s.messages is serialised with the periodic
# checkpoint thread, cancel_stream, and all other session writers.
# Lock ordering: _agent_lock → LOCK → _write_session_index (LOCK).
with _get_session_agent_lock(session_id):
# get_session() and Session.save() both acquire the module-level LOCK
# internally (the latter via _write_session_index()), and LOCK is a
# non-reentrant threading.Lock — so they MUST be called outside our
# own `with LOCK:` block to avoid self-deadlocking.
#
# The race we close is the read-modify-write of s.messages: two
# concurrent /api/session/retry calls could otherwise both compute the
# same last_user_idx from the same history and double-truncate. We
# serialize just the in-memory mutation; persistence happens inside
# the per-session lock so the checkpoint thread cannot race us.
#
# Stale-object guard: on a cache miss, two concurrent get_session()
# calls can each load and cache a *different* Session instance for the
# same session_id (the second store clobbers the first). Re-bind to
# the canonical cached instance inside the lock so the mutation lands
# on the object the next reader will see, not a stale parallel copy.
s = get_session(session_id) # raises KeyError if missing
with LOCK:
s = SESSIONS.get(session_id, s)
history = s.messages or []
last_user_idx = None
for i in range(len(history) - 1, -1, -1):
if history[i].get('role') == 'user':
last_user_idx = i
break
if last_user_idx is None:
raise ValueError('No previous message to retry.')
last_user_text = _extract_text(history[last_user_idx].get('content', ''))
removed_count = len(history) - last_user_idx
s.messages = history[:last_user_idx]
_stamp_intentional_shrink_generation(s, len(history), len(s.messages))
s.truncation_watermark = _truncation_watermark_for(s.messages)
# Persist the original truncate cutoff so empty-sidecar recovery
# can distinguish legitimate prefix from deleted suffix.
s.truncation_boundary = s.truncation_watermark
if isinstance(getattr(s, 'context_messages', None), list) and s.context_messages:
truncated_context = _truncate_at_last_user(s.context_messages)
if truncated_context is not None:
s.context_messages = truncated_context
s.save()
return {'last_user_text': last_user_text, 'removed_count': removed_count}
def undo_last(session_id: str) -> dict[str, Any]:
"""Remove the most recent user message and everything after it.
Mirrors gateway/run.py:_handle_undo_command. Returns a preview of the
removed text so the UI can confirm to the user.
Raises:
KeyError: session not found
ValueError: no user message in transcript
"""
# Acquire the per-session agent lock as the outermost lock so that the
# read-modify-write of s.messages is serialised with the periodic
# checkpoint thread, cancel_stream, and all other session writers.
# Lock ordering: _agent_lock → LOCK → _write_session_index (LOCK).
with _get_session_agent_lock(session_id):
s = get_session(session_id) # acquires LOCK transiently
with LOCK:
# Stale-object guard — see retry_last for the rationale.
s = SESSIONS.get(session_id, s)
history = s.messages or []
last_user_idx = None
for i in range(len(history) - 1, -1, -1):
if history[i].get('role') == 'user':
last_user_idx = i
break
if last_user_idx is None:
raise ValueError('Nothing to undo.')
removed_text = _extract_text(history[last_user_idx].get('content', ''))
removed_count = len(history) - last_user_idx
s.messages = history[:last_user_idx]
_stamp_intentional_shrink_generation(s, len(history), len(s.messages))
s.truncation_watermark = _truncation_watermark_for(s.messages)
# Persist the original truncate cutoff.
s.truncation_boundary = s.truncation_watermark
if isinstance(getattr(s, 'context_messages', None), list) and s.context_messages:
truncated_context = _truncate_at_last_user(s.context_messages)
if truncated_context is not None:
s.context_messages = truncated_context
s.save() # outside LOCK -- save() re-acquires LOCK via _write_session_index()
preview = (removed_text[:40] + '...') if len(removed_text) > 40 else removed_text
return {
'removed_count': removed_count,
'removed_preview': preview,
}
def session_status(session_id: str) -> dict[str, Any]:
"""Return a snapshot of session state for /status.
Webui equivalent of gateway/run.py:_handle_status_command. The agent's
"agent_running" comes from `session_key in self._running_agents`; the
webui equivalent is whether the session has an active stream
(active_stream_id is set).
"""
s = get_session(session_id)
inp = int(s.input_tokens or 0)
out = int(s.output_tokens or 0)
profile = getattr(s, 'profile', None) or 'default'
try:
from api.profiles import get_hermes_home_for_profile
hermes_home = str(get_hermes_home_for_profile(profile))
except Exception:
hermes_home = ''
return {
'session_id': s.session_id,
'title': s.title,
'model': s.model,
'profile': profile,
'hermes_home': hermes_home,
'workspace': s.workspace,
'personality': s.personality,
'message_count': len(s.messages or []),
'created_at': s.created_at,
'updated_at': s.updated_at,
'agent_running': bool(getattr(s, 'active_stream_id', None)),
# Expose the stream id itself (not just the agent_running bool) so a
# hidden-tab poller can attach the live renderer to a server-initiated
# turn (self-wake / cron / restart hook) without opening the persistent
# per-session SSE while the tab is hidden. See messages.js hidden-tab
# active-stream poll. Additive field — existing consumers ignore it.
#
# CRITICAL: only expose a stream id that is actually LIVE in this
# process. After a restart/crash the persisted active_stream_id is stale
# (the in-memory STREAMS/ACTIVE_RUNS were wiped) — handing that dead id
# to the poller would make it attach a renderer to a stream that never
# produces tokens (a permanent fake "thinking" state). Mirror
# _clear_stale_stream_state's liveness test: a stream counts as live
# only if it's in STREAMS (SSE channel open) or ACTIVE_RUNS (worker
# bookkeeping). Otherwise report None so the poller waits for a REAL
# server_turn_started instead of latching a ghost.
'active_stream_id': _live_active_stream_id(s),
'input_tokens': inp,
'output_tokens': out,
'total_tokens': inp + out,
'estimated_cost': s.estimated_cost,
}
def session_usage(session_id: str) -> dict[str, Any]:
"""Return token usage and cost for /usage.
Mirrors gateway/run.py:_handle_usage_command's basic counters. The
agent shows additional fields (rate-limit headroom etc.) that depend
on provider API responses we don't have in webui -- those are deferred.
"""
s = get_session(session_id)
inp = int(s.input_tokens or 0)
out = int(s.output_tokens or 0)
return {
'input_tokens': inp,
'output_tokens': out,
'total_tokens': inp + out,
'estimated_cost': s.estimated_cost,
'model': s.model,
}
def _extract_text(content: Any) -> str:
"""Flatten message content to plain text. Agent stores either a string
or a list of {type, text|...} parts; webui needs the user-typed text."""
if isinstance(content, str):
return content
if isinstance(content, list):
parts = []
for p in content:
if not isinstance(p, dict):
continue
part_type = str(p.get('type') or '').lower()
if part_type not in ('', 'text', 'input_text', 'output_text'):
continue
part_text = (
p.get('text')
or p.get('content')
or p.get('input_text')
or p.get('output_text')
or ''
)
parts.append(str(part_text))
return ' '.join(parts)
return str(content)