mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-28 01:21:43 +00:00
83c1c201f6
Instead of a blocking first-run questionnaire, show a one-time hint the first time the user hits each behavior fork: 1. First message while the agent is working — appends a hint to the busy-ack explaining the /busy queue vs /busy interrupt knob, phrased to match the mode that was just applied (don't tell a queue-mode user to switch to queue). 2. First tool that runs for >= 30s in the noisiest progress mode (tool_progress: all) — prints a hint about /verbose to cycle display modes (all -> new -> off -> verbose). Gated on /verbose actually being usable on the surface: always shown on CLI; on gateway only shown when display.tool_progress_command is enabled. Each hint is latched in config.yaml under onboarding.seen.<flag>, so it fires exactly once per install across CLI, gateway, and cron, then never again. Users can wipe the section to re-see hints. New: - agent/onboarding.py — is_seen / mark_seen / hint strings, shared by both CLI and gateway. - onboarding.seen in DEFAULT_CONFIG (hermes_cli/config.py) and in load_cli_config defaults (cli.py). No _config_version bump — deep merge handles new keys. Wired: - gateway/run.py: _handle_active_session_busy_message appends the hint after building the ack. progress_callback tracks tool.completed duration and queues the tool-progress hint into the progress bubble. - cli.py: CLI input loop appends the busy-input hint on the first busy Enter; _on_tool_progress appends the tool-progress hint on the first >=30s tool completion. In-memory CLI_CONFIG is also updated so subsequent fires in the same process are suppressed immediately. All writes go through atomic_yaml_write and are wrapped in try/except so onboarding can never break the input/busy-ack paths.
469 lines
17 KiB
Python
469 lines
17 KiB
Python
"""Tests for busy-session acknowledgment when user sends messages during active agent runs.
|
|
|
|
Verifies that users get an immediate status response instead of total silence
|
|
when the agent is working on a task. See PR fix for the @Lonely__MH report.
|
|
"""
|
|
import asyncio
|
|
import time
|
|
from unittest.mock import AsyncMock, MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Minimal stubs so we can import gateway code without heavy deps
|
|
# ---------------------------------------------------------------------------
|
|
import sys, types
|
|
|
|
_tg = types.ModuleType("telegram")
|
|
_tg.constants = types.ModuleType("telegram.constants")
|
|
_ct = MagicMock()
|
|
_ct.SUPERGROUP = "supergroup"
|
|
_ct.GROUP = "group"
|
|
_ct.PRIVATE = "private"
|
|
_tg.constants.ChatType = _ct
|
|
sys.modules.setdefault("telegram", _tg)
|
|
sys.modules.setdefault("telegram.constants", _tg.constants)
|
|
sys.modules.setdefault("telegram.ext", types.ModuleType("telegram.ext"))
|
|
|
|
from gateway.platforms.base import (
|
|
BasePlatformAdapter,
|
|
MessageEvent,
|
|
MessageType,
|
|
SessionSource,
|
|
build_session_key,
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _make_event(text="hello", chat_id="123", platform_val="telegram"):
|
|
"""Build a minimal MessageEvent."""
|
|
source = SessionSource(
|
|
platform=MagicMock(value=platform_val),
|
|
chat_id=chat_id,
|
|
chat_type="private",
|
|
user_id="user1",
|
|
)
|
|
evt = MessageEvent(
|
|
text=text,
|
|
message_type=MessageType.TEXT,
|
|
source=source,
|
|
message_id="msg1",
|
|
)
|
|
return evt
|
|
|
|
|
|
def _make_runner():
|
|
"""Build a minimal GatewayRunner-like object for testing."""
|
|
from gateway.run import GatewayRunner, _AGENT_PENDING_SENTINEL
|
|
|
|
runner = object.__new__(GatewayRunner)
|
|
runner._running_agents = {}
|
|
runner._running_agents_ts = {}
|
|
runner._pending_messages = {}
|
|
runner._busy_ack_ts = {}
|
|
runner._draining = False
|
|
runner.adapters = {}
|
|
runner.config = MagicMock()
|
|
runner.session_store = None
|
|
runner.hooks = MagicMock()
|
|
runner.hooks.emit = AsyncMock()
|
|
runner.pairing_store = MagicMock()
|
|
runner.pairing_store.is_approved.return_value = True
|
|
runner._is_user_authorized = lambda _source: True
|
|
return runner, _AGENT_PENDING_SENTINEL
|
|
|
|
|
|
def _make_adapter(platform_val="telegram"):
|
|
"""Build a minimal adapter mock."""
|
|
adapter = MagicMock()
|
|
adapter._pending_messages = {}
|
|
adapter._send_with_retry = AsyncMock()
|
|
adapter.config = MagicMock()
|
|
adapter.config.extra = {}
|
|
adapter.platform = MagicMock(value=platform_val)
|
|
return adapter
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
class TestBusySessionAck:
|
|
"""User sends a message while agent is running — should get acknowledgment."""
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_handle_message_queue_mode_queues_without_interrupt(self):
|
|
"""Runner queue mode must not interrupt an active agent for text follow-ups."""
|
|
from gateway.run import GatewayRunner
|
|
|
|
runner, _sentinel = _make_runner()
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="follow up in queue mode")
|
|
sk = build_session_key(event.source)
|
|
|
|
running_agent = MagicMock()
|
|
runner._busy_input_mode = "queue"
|
|
runner._running_agents[sk] = running_agent
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
result = await GatewayRunner._handle_message(runner, event)
|
|
|
|
assert result is None
|
|
assert sk in adapter._pending_messages
|
|
assert adapter._pending_messages[sk] is event
|
|
assert sk not in runner._pending_messages
|
|
running_agent.interrupt.assert_not_called()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_sends_ack_when_agent_running(self):
|
|
"""First message during busy session should get a status ack."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="Are you working?")
|
|
sk = build_session_key(event.source)
|
|
|
|
# Simulate running agent
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 21,
|
|
"max_iterations": 60,
|
|
"current_tool": "terminal",
|
|
"last_activity_ts": time.time(),
|
|
"last_activity_desc": "terminal",
|
|
"seconds_since_activity": 1.0,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 600 # 10 min ago
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
result = await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
assert result is True # handled
|
|
# Verify ack was sent
|
|
adapter._send_with_retry.assert_called_once()
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content") or call_kwargs[1].get("content", "")
|
|
if not content and call_kwargs.args:
|
|
# positional args
|
|
content = str(call_kwargs)
|
|
assert "Interrupting" in content or "respond" in content
|
|
assert "/stop" not in content # no need — we ARE interrupting
|
|
|
|
# Verify agent interrupt was called
|
|
agent.interrupt.assert_called_once_with("Are you working?")
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_queue_mode_suppresses_interrupt_and_updates_ack(self):
|
|
"""When busy_input_mode is 'queue', message is queued WITHOUT interrupt."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "queue"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="Add this to queue")
|
|
sk = build_session_key(event.source)
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
agent = MagicMock()
|
|
runner._running_agents[sk] = agent
|
|
|
|
with patch("gateway.run.merge_pending_message_event"):
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
# VERIFY: Agent was NOT interrupted
|
|
agent.interrupt.assert_not_called()
|
|
|
|
# VERIFY: Ack sent with queue-specific wording
|
|
adapter._send_with_retry.assert_called_once()
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content") or call_kwargs[1].get("content", "")
|
|
assert "Queued for the next turn" in content
|
|
assert "respond once the current task finishes" in content
|
|
assert "Interrupting" not in content
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_debounce_suppresses_rapid_acks(self):
|
|
"""Second message within 30s should NOT send another ack."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event1 = _make_event(text="hello?")
|
|
# Reuse the same source so platform mock matches
|
|
event2 = MessageEvent(
|
|
text="still there?",
|
|
message_type=MessageType.TEXT,
|
|
source=event1.source,
|
|
message_id="msg2",
|
|
)
|
|
sk = build_session_key(event1.source)
|
|
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 5,
|
|
"max_iterations": 60,
|
|
"current_tool": None,
|
|
"last_activity_ts": time.time(),
|
|
"last_activity_desc": "api_call",
|
|
"seconds_since_activity": 0.5,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 60
|
|
runner.adapters[event1.source.platform] = adapter
|
|
|
|
# First message — should get ack
|
|
result1 = await runner._handle_active_session_busy_message(event1, sk)
|
|
assert result1 is True
|
|
assert adapter._send_with_retry.call_count == 1
|
|
|
|
# Second message within cooldown — should be queued but no ack
|
|
result2 = await runner._handle_active_session_busy_message(event2, sk)
|
|
assert result2 is True
|
|
assert adapter._send_with_retry.call_count == 1 # still 1, no new ack
|
|
|
|
# But interrupt should still be called for both (since we are in interrupt mode)
|
|
assert agent.interrupt.call_count == 2
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ack_after_cooldown_expires(self):
|
|
"""After 30s cooldown, a new message should send a fresh ack."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="hello?")
|
|
sk = build_session_key(event.source)
|
|
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 10,
|
|
"max_iterations": 60,
|
|
"current_tool": "web_search",
|
|
"last_activity_ts": time.time(),
|
|
"last_activity_desc": "tool",
|
|
"seconds_since_activity": 0.5,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 120
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
# First ack
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
assert adapter._send_with_retry.call_count == 1
|
|
|
|
# Fake that cooldown expired
|
|
runner._busy_ack_ts[sk] = time.time() - 31
|
|
|
|
# Second ack should go through
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
assert adapter._send_with_retry.call_count == 2
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_includes_status_detail(self):
|
|
"""Ack message should include iteration and tool info when available."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="yo")
|
|
sk = build_session_key(event.source)
|
|
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 21,
|
|
"max_iterations": 60,
|
|
"current_tool": "terminal",
|
|
"last_activity_ts": time.time(),
|
|
"last_activity_desc": "terminal",
|
|
"seconds_since_activity": 0.5,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 600 # 10 min
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content", "")
|
|
assert "21/60" in content # iteration
|
|
assert "terminal" in content # current tool
|
|
assert "10 min" in content # elapsed
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_draining_still_works(self):
|
|
"""Draining case should still produce the drain-specific message."""
|
|
runner, sentinel = _make_runner()
|
|
runner._draining = True
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="hello")
|
|
sk = build_session_key(event.source)
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
# Mock the drain-specific methods
|
|
runner._queue_during_drain_enabled = lambda: False
|
|
runner._status_action_gerund = lambda: "restarting"
|
|
|
|
result = await runner._handle_active_session_busy_message(event, sk)
|
|
assert result is True
|
|
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content", "")
|
|
assert "restarting" in content
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_pending_sentinel_no_interrupt(self):
|
|
"""When agent is PENDING_SENTINEL, don't call interrupt (it has no method)."""
|
|
runner, sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="hey")
|
|
sk = build_session_key(event.source)
|
|
|
|
runner._running_agents[sk] = sentinel
|
|
runner._running_agents_ts[sk] = time.time()
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
result = await runner._handle_active_session_busy_message(event, sk)
|
|
assert result is True
|
|
# Should still send ack
|
|
adapter._send_with_retry.assert_called_once()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_no_adapter_falls_through(self):
|
|
"""If adapter is missing, return False so default path handles it."""
|
|
runner, sentinel = _make_runner()
|
|
|
|
event = _make_event(text="hello")
|
|
sk = build_session_key(event.source)
|
|
|
|
# No adapter registered
|
|
runner._running_agents[sk] = MagicMock()
|
|
|
|
result = await runner._handle_active_session_busy_message(event, sk)
|
|
assert result is False # not handled, let default path try
|
|
|
|
|
|
class TestBusySessionOnboardingHint:
|
|
"""First-touch hint appended to the busy-ack the first time it fires."""
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_first_busy_ack_appends_interrupt_hint(self, tmp_path, monkeypatch):
|
|
"""First busy-while-running message gets an extra hint about /busy."""
|
|
import gateway.run as _gr
|
|
|
|
monkeypatch.setattr(_gr, "_hermes_home", tmp_path)
|
|
# mark_seen imports utils.atomic_yaml_write; make sure it resolves
|
|
# against a writable dir by pointing _hermes_home at tmp_path.
|
|
monkeypatch.setattr(_gr, "_load_gateway_config", lambda: {})
|
|
|
|
runner, _sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="ping")
|
|
sk = build_session_key(event.source)
|
|
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 3, "max_iterations": 60,
|
|
"current_tool": None, "last_activity_ts": time.time(),
|
|
"last_activity_desc": "api", "seconds_since_activity": 0.1,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 5
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content", "")
|
|
|
|
# Normal ack body
|
|
assert "Interrupting" in content
|
|
# First-touch hint appended
|
|
assert "First-time tip" in content
|
|
assert "/busy queue" in content
|
|
|
|
# The flag is now persisted to tmp_path/config.yaml
|
|
import yaml
|
|
cfg = yaml.safe_load((tmp_path / "config.yaml").read_text())
|
|
assert cfg["onboarding"]["seen"]["busy_input_prompt"] is True
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_second_busy_ack_omits_hint(self, tmp_path, monkeypatch):
|
|
"""Once the flag is marked, the hint never appears again."""
|
|
import gateway.run as _gr
|
|
import yaml
|
|
|
|
monkeypatch.setattr(_gr, "_hermes_home", tmp_path)
|
|
# Pre-populate the config so is_seen() returns True from the start.
|
|
(tmp_path / "config.yaml").write_text(yaml.safe_dump({
|
|
"onboarding": {"seen": {"busy_input_prompt": True}},
|
|
}))
|
|
monkeypatch.setattr(
|
|
_gr, "_load_gateway_config",
|
|
lambda: yaml.safe_load((tmp_path / "config.yaml").read_text()),
|
|
)
|
|
|
|
runner, _sentinel = _make_runner()
|
|
runner._busy_input_mode = "interrupt"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="ping again")
|
|
sk = build_session_key(event.source)
|
|
|
|
agent = MagicMock()
|
|
agent.get_activity_summary.return_value = {
|
|
"api_call_count": 3, "max_iterations": 60,
|
|
"current_tool": None, "last_activity_ts": time.time(),
|
|
"last_activity_desc": "api", "seconds_since_activity": 0.1,
|
|
}
|
|
runner._running_agents[sk] = agent
|
|
runner._running_agents_ts[sk] = time.time() - 5
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
call_kwargs = adapter._send_with_retry.call_args
|
|
content = call_kwargs.kwargs.get("content", "")
|
|
|
|
assert "Interrupting" in content
|
|
assert "First-time tip" not in content
|
|
assert "/busy queue" not in content
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_queue_mode_hint_points_to_interrupt(self, tmp_path, monkeypatch):
|
|
"""In queue mode the hint should suggest /busy interrupt, not /busy queue."""
|
|
import gateway.run as _gr
|
|
|
|
monkeypatch.setattr(_gr, "_hermes_home", tmp_path)
|
|
monkeypatch.setattr(_gr, "_load_gateway_config", lambda: {})
|
|
|
|
runner, _sentinel = _make_runner()
|
|
runner._busy_input_mode = "queue"
|
|
adapter = _make_adapter()
|
|
|
|
event = _make_event(text="queue me")
|
|
sk = build_session_key(event.source)
|
|
runner.adapters[event.source.platform] = adapter
|
|
|
|
agent = MagicMock()
|
|
runner._running_agents[sk] = agent
|
|
|
|
with patch("gateway.run.merge_pending_message_event"):
|
|
await runner._handle_active_session_busy_message(event, sk)
|
|
|
|
content = adapter._send_with_retry.call_args.kwargs.get("content", "")
|
|
assert "Queued for the next turn" in content
|
|
assert "First-time tip" in content
|
|
assert "/busy interrupt" in content
|
|
# Must NOT tell the user to /busy queue when they're already on queue.
|
|
assert "/busy queue" not in content
|