mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-18 04:41:56 +00:00
00ce5f04d9
Builds on @kshitijk4poor's CLI handoff stub. The original PR's flow
deferred everything to whenever a real user happened to message the
target platform; this rewrites it so the gateway picks up handoffs
immediately and the destination chat just starts working.
State machine on sessions table replaces the boolean flag:
None -> 'pending' -> 'running' -> ('completed' | 'failed')
plus handoff_error for failure reasons. CLI request_handoff /
get_handoff_state / list_pending_handoffs / claim_handoff /
complete_handoff / fail_handoff helpers wrap the transitions.
CLI side (cli.py): /handoff <platform> validates the platform's home
channel via load_gateway_config, refuses if the agent is mid-turn,
flips the row to 'pending', and poll-blocks (60s) on terminal state.
On 'completed' it prints the /resume hint and exits the CLI like
/quit. On 'failed' or timeout it surfaces the reason and the CLI
session stays intact.
Gateway side (gateway/run.py): new _handoff_watcher background task
scans state.db every 2s, atomically claims pending rows, and runs
_process_handoff for each. _process_handoff:
1. Resolves the platform's home channel.
2. Asks the adapter for a fresh thread via the new
create_handoff_thread(parent_chat_id, name) capability so the
handed-off conversation gets its own scrollback. Adapters that
don't support threads (or fail) return None and the watcher
falls back to the home channel directly.
3. Constructs a SessionSource keyed as 'thread' when a thread was
created, 'dm' otherwise, then session_store.switch_session
re-binds the destination key to the CLI session_id. The full
role-aware transcript replays via load_transcript on the next
turn (no flat-text injection into context_prompt).
4. Forges a synthetic MessageEvent(internal=True) with the handoff
notice and dispatches through _handle_message; the agent runs
against the loaded transcript and adapter.send delivers the
reply.
5. Marks the row 'completed' on success, 'failed' (+error) on any
exception.
Adapter capability (gateway/platforms/base.py): create_handoff_thread
default returns None. Three overrides:
- Telegram (gateway/platforms/telegram.py): wraps _create_dm_topic
so DM topics (Bot API 9.4+) and forum supergroups both work.
- Discord (gateway/platforms/discord.py): parent.create_thread on
text channels with a seed-message + message.create_thread
fallback for permission edge cases. Skips DMs and other
non-thread-capable parents.
- Slack (gateway/platforms/slack.py): posts a seed message and
returns its ts as the thread anchor — Slack threads are
message-anchored.
In thread mode, build_session_key keys the destination without
user_id (thread_sessions_per_user defaults to False) so the synthetic
turn and any later real-user message in the thread share the same
session_key — seamless takeover without race.
CommandDef stays cli_only=True (handoff is initiated from the CLI;
gateway exposes /resume for the reverse direction).
Removed the original PR's _handle_message_with_agent handoff hook
(transcript-as-text injection into context_prompt) and the
send_message_tool notification — both replaced by the watcher path.
Tests rewritten around the new state machine: 13/13 pass.
E2E-validated thread + no-thread paths and the failure path against
real worktree imports with mocked adapters.
202 lines
7 KiB
Python
202 lines
7 KiB
Python
"""Tests for session handoff (CLI to gateway platform).
|
|
|
|
The handoff state machine lives on the ``sessions`` table:
|
|
|
|
None → "pending" → "running" → ("completed" | "failed")
|
|
|
|
CLI side calls ``request_handoff`` and poll-waits on ``get_handoff_state``.
|
|
Gateway side iterates ``list_pending_handoffs``, calls ``claim_handoff`` to
|
|
flip pending → running, and finishes with ``complete_handoff`` or
|
|
``fail_handoff``.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import time
|
|
|
|
import pytest
|
|
|
|
from hermes_state import SessionDB
|
|
|
|
|
|
class TestHandoffStateDB:
|
|
"""Test the handoff schema + helper methods on SessionDB."""
|
|
|
|
@pytest.fixture
|
|
def db(self, tmp_path, monkeypatch):
|
|
home = tmp_path / ".hermes"
|
|
home.mkdir()
|
|
monkeypatch.setenv("HERMES_HOME", str(home))
|
|
return SessionDB(db_path=home / "state.db")
|
|
|
|
def _make_session(self, db, session_id, source="cli", title=None):
|
|
"""Insert a session row directly for testing."""
|
|
def _do(conn):
|
|
conn.execute(
|
|
"INSERT OR IGNORE INTO sessions (id, source, title, started_at) "
|
|
"VALUES (?, ?, ?, ?)",
|
|
(session_id, source, title, time.time()),
|
|
)
|
|
db._execute_write(_do)
|
|
|
|
def test_columns_exist(self, db):
|
|
db._conn.execute(
|
|
"SELECT handoff_state, handoff_platform, handoff_error "
|
|
"FROM sessions LIMIT 0"
|
|
)
|
|
|
|
def test_request_handoff_marks_pending(self, db):
|
|
sid = "sess-1"
|
|
self._make_session(db, sid)
|
|
|
|
assert db.request_handoff(sid, "telegram") is True
|
|
|
|
state = db.get_handoff_state(sid)
|
|
assert state == {
|
|
"state": "pending",
|
|
"platform": "telegram",
|
|
"error": None,
|
|
}
|
|
|
|
def test_request_handoff_rejects_in_flight(self, db):
|
|
sid = "sess-2"
|
|
self._make_session(db, sid)
|
|
|
|
assert db.request_handoff(sid, "telegram") is True
|
|
# Still pending → reject re-request
|
|
assert db.request_handoff(sid, "discord") is False
|
|
|
|
# And after gateway claims it (running) → still rejected
|
|
assert db.claim_handoff(sid) is True
|
|
assert db.request_handoff(sid, "discord") is False
|
|
|
|
def test_request_handoff_after_terminal_state_resets_error(self, db):
|
|
sid = "sess-3"
|
|
self._make_session(db, sid)
|
|
db.request_handoff(sid, "telegram")
|
|
db.claim_handoff(sid)
|
|
db.fail_handoff(sid, "earlier failure")
|
|
|
|
# User retries — should be allowed and clear the prior error.
|
|
assert db.request_handoff(sid, "discord") is True
|
|
state = db.get_handoff_state(sid)
|
|
assert state["state"] == "pending"
|
|
assert state["platform"] == "discord"
|
|
assert state["error"] is None
|
|
|
|
def test_list_pending_handoffs_excludes_running_and_terminal(self, db):
|
|
a, b, c, d = "sess-a", "sess-b", "sess-c", "sess-d"
|
|
for sid in (a, b, c, d):
|
|
self._make_session(db, sid)
|
|
|
|
db.request_handoff(a, "telegram")
|
|
db.request_handoff(b, "discord")
|
|
db.request_handoff(c, "telegram")
|
|
db.claim_handoff(c) # c is now running, not pending
|
|
db.request_handoff(d, "slack")
|
|
db.claim_handoff(d)
|
|
db.complete_handoff(d) # d is terminal
|
|
|
|
pending = db.list_pending_handoffs()
|
|
ids = [r["id"] for r in pending]
|
|
assert set(ids) == {a, b}
|
|
|
|
def test_claim_handoff_is_atomic(self, db):
|
|
sid = "sess-claim"
|
|
self._make_session(db, sid)
|
|
db.request_handoff(sid, "telegram")
|
|
|
|
# First claim wins
|
|
assert db.claim_handoff(sid) is True
|
|
# Second claim is a no-op (state is now "running", not "pending")
|
|
assert db.claim_handoff(sid) is False
|
|
assert db.get_handoff_state(sid)["state"] == "running"
|
|
|
|
def test_complete_handoff_clears_error(self, db):
|
|
sid = "sess-complete"
|
|
self._make_session(db, sid)
|
|
db.request_handoff(sid, "telegram")
|
|
db.claim_handoff(sid)
|
|
db.fail_handoff(sid, "transient")
|
|
# User retries; mock the watcher path
|
|
db.request_handoff(sid, "telegram")
|
|
db.claim_handoff(sid)
|
|
db.complete_handoff(sid)
|
|
|
|
state = db.get_handoff_state(sid)
|
|
assert state["state"] == "completed"
|
|
assert state["error"] is None
|
|
|
|
def test_fail_handoff_records_reason(self, db):
|
|
sid = "sess-fail"
|
|
self._make_session(db, sid)
|
|
db.request_handoff(sid, "telegram")
|
|
db.claim_handoff(sid)
|
|
db.fail_handoff(sid, "no home channel for telegram")
|
|
|
|
state = db.get_handoff_state(sid)
|
|
assert state["state"] == "failed"
|
|
assert state["error"] == "no home channel for telegram"
|
|
|
|
def test_fail_handoff_truncates_long_reasons(self, db):
|
|
sid = "sess-fail-long"
|
|
self._make_session(db, sid)
|
|
db.request_handoff(sid, "telegram")
|
|
db.claim_handoff(sid)
|
|
|
|
# 1000-character error string
|
|
big_err = "x" * 1000
|
|
db.fail_handoff(sid, big_err)
|
|
|
|
state = db.get_handoff_state(sid)
|
|
assert len(state["error"]) <= 500
|
|
|
|
def test_get_handoff_state_for_unknown_session(self, db):
|
|
assert db.get_handoff_state("does-not-exist") is None
|
|
|
|
def test_full_pending_to_completed_flow(self, db):
|
|
"""End-to-end sequence the CLI + gateway watcher follow."""
|
|
sid = "sess-flow"
|
|
self._make_session(db, sid, title="my session")
|
|
db.append_message(sid, "user", "Hello")
|
|
db.append_message(sid, "assistant", "Hi there!")
|
|
|
|
# CLI: request handoff
|
|
assert db.request_handoff(sid, "telegram") is True
|
|
assert db.get_handoff_state(sid)["state"] == "pending"
|
|
|
|
# Gateway watcher: discover + claim
|
|
pending = db.list_pending_handoffs()
|
|
assert len(pending) == 1
|
|
assert pending[0]["id"] == sid
|
|
assert db.claim_handoff(sid) is True
|
|
assert db.get_handoff_state(sid)["state"] == "running"
|
|
|
|
# Gateway uses get_messages to load the transcript (real flow uses
|
|
# session_store.switch_session which reads the same table).
|
|
messages = db.get_messages(sid)
|
|
assert [m["role"] for m in messages] == ["user", "assistant"]
|
|
|
|
# Gateway: mark completed
|
|
db.complete_handoff(sid)
|
|
assert db.get_handoff_state(sid)["state"] == "completed"
|
|
assert db.list_pending_handoffs() == []
|
|
|
|
|
|
class TestHandoffCommandRegistration:
|
|
"""Slash-command surface checks."""
|
|
|
|
def test_command_registered(self):
|
|
from hermes_cli.commands import resolve_command
|
|
cmd = resolve_command("handoff")
|
|
assert cmd is not None
|
|
assert cmd.name == "handoff"
|
|
assert cmd.category == "Session"
|
|
|
|
def test_command_is_cli_only(self):
|
|
"""`/handoff` is initiated from the CLI; gateway shouldn't expose it."""
|
|
from hermes_cli.commands import resolve_command, GATEWAY_KNOWN_COMMANDS
|
|
cmd = resolve_command("handoff")
|
|
assert cmd is not None
|
|
assert cmd.cli_only is True
|
|
assert "handoff" not in GATEWAY_KNOWN_COMMANDS
|