mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-06 10:47:12 +08:00
6b76ea4707
The YAML-to-env-var bridge in load_gateway_config() mapped every Discord and Telegram config key (require_mention, auto_thread, reactions, etc.) except reply_to_mode. Users setting discord.reply_to_mode or telegram.reply_to_mode in ~/.hermes/config.yaml got no effect — the adapter only read the env var, which nothing populated from YAML. Add the missing bridge for both platforms, following the existing pattern. Top-level <platform>.reply_to_mode preferred, falls back to <platform>.extra.reply_to_mode, env var never overwritten. Handles YAML 1.1 bare `off` → Python False coercion. This is a re-submission of the work from #9837 and #13930, which both implemented the same fix but neither landed (see co-authors below). Co-authored-by: Matteo De Agazio <hypnosis.mda@gmail.com> Co-authored-by: ishardo <239075732+ishardo@users.noreply.github.com>
463 lines
18 KiB
Python
463 lines
18 KiB
Python
"""Tests for Discord reply_to_mode functionality.
|
|
|
|
Covers the threading behavior control for multi-chunk replies:
|
|
- "off": Never reply-reference to original message
|
|
- "first": Only first chunk uses reply reference (default)
|
|
- "all": All chunks reply-reference the original message
|
|
|
|
Also covers reply_to_text extraction from incoming messages.
|
|
"""
|
|
import os
|
|
import sys
|
|
from datetime import datetime, timezone
|
|
from types import SimpleNamespace
|
|
from unittest.mock import MagicMock, AsyncMock, patch
|
|
|
|
import pytest
|
|
|
|
from gateway.config import PlatformConfig, GatewayConfig, Platform, _apply_env_overrides, load_gateway_config
|
|
|
|
|
|
def _ensure_discord_mock():
|
|
"""Install a mock discord module when discord.py isn't available."""
|
|
if "discord" in sys.modules and hasattr(sys.modules["discord"], "__file__"):
|
|
return
|
|
|
|
discord_mod = MagicMock()
|
|
discord_mod.Intents.default.return_value = MagicMock()
|
|
discord_mod.Client = MagicMock
|
|
discord_mod.File = MagicMock
|
|
discord_mod.DMChannel = type("DMChannel", (), {})
|
|
discord_mod.Thread = type("Thread", (), {})
|
|
discord_mod.ForumChannel = type("ForumChannel", (), {})
|
|
discord_mod.ui = SimpleNamespace(View=object, button=lambda *a, **k: (lambda fn: fn), Button=object)
|
|
discord_mod.ButtonStyle = SimpleNamespace(success=1, primary=2, secondary=2, danger=3, green=1, grey=2, blurple=2, red=3)
|
|
discord_mod.Color = SimpleNamespace(orange=lambda: 1, green=lambda: 2, blue=lambda: 3, red=lambda: 4, purple=lambda: 5)
|
|
discord_mod.Interaction = object
|
|
discord_mod.Embed = MagicMock
|
|
discord_mod.app_commands = SimpleNamespace(
|
|
describe=lambda **kwargs: (lambda fn: fn),
|
|
choices=lambda **kwargs: (lambda fn: fn),
|
|
Choice=lambda **kwargs: SimpleNamespace(**kwargs),
|
|
)
|
|
|
|
ext_mod = MagicMock()
|
|
commands_mod = MagicMock()
|
|
commands_mod.Bot = MagicMock
|
|
ext_mod.commands = commands_mod
|
|
|
|
sys.modules.setdefault("discord", discord_mod)
|
|
sys.modules.setdefault("discord.ext", ext_mod)
|
|
sys.modules.setdefault("discord.ext.commands", commands_mod)
|
|
|
|
|
|
_ensure_discord_mock()
|
|
|
|
from gateway.platforms.discord import DiscordAdapter # noqa: E402
|
|
|
|
|
|
@pytest.fixture()
|
|
def adapter_factory():
|
|
"""Factory to create DiscordAdapter with custom reply_to_mode."""
|
|
def create(reply_to_mode: str = "first"):
|
|
config = PlatformConfig(enabled=True, token="test-token", reply_to_mode=reply_to_mode)
|
|
return DiscordAdapter(config)
|
|
return create
|
|
|
|
|
|
class TestReplyToModeConfig:
|
|
"""Tests for reply_to_mode configuration loading."""
|
|
|
|
def test_default_mode_is_first(self, adapter_factory):
|
|
adapter = adapter_factory()
|
|
assert adapter._reply_to_mode == "first"
|
|
|
|
def test_off_mode(self, adapter_factory):
|
|
adapter = adapter_factory(reply_to_mode="off")
|
|
assert adapter._reply_to_mode == "off"
|
|
|
|
def test_first_mode(self, adapter_factory):
|
|
adapter = adapter_factory(reply_to_mode="first")
|
|
assert adapter._reply_to_mode == "first"
|
|
|
|
def test_all_mode(self, adapter_factory):
|
|
adapter = adapter_factory(reply_to_mode="all")
|
|
assert adapter._reply_to_mode == "all"
|
|
|
|
def test_invalid_mode_stored_as_is(self, adapter_factory):
|
|
"""Invalid modes are stored but send() handles them gracefully."""
|
|
adapter = adapter_factory(reply_to_mode="invalid")
|
|
assert adapter._reply_to_mode == "invalid"
|
|
|
|
def test_none_mode_defaults_to_first(self):
|
|
config = PlatformConfig(enabled=True, token="test-token")
|
|
adapter = DiscordAdapter(config)
|
|
assert adapter._reply_to_mode == "first"
|
|
|
|
def test_empty_string_mode_defaults_to_first(self):
|
|
config = PlatformConfig(enabled=True, token="test-token", reply_to_mode="")
|
|
adapter = DiscordAdapter(config)
|
|
assert adapter._reply_to_mode == "first"
|
|
|
|
|
|
def _make_discord_adapter(reply_to_mode: str = "first"):
|
|
"""Create a DiscordAdapter with mocked client and channel for send() tests."""
|
|
config = PlatformConfig(enabled=True, token="test-token", reply_to_mode=reply_to_mode)
|
|
adapter = DiscordAdapter(config)
|
|
|
|
# Mock the Discord client and channel.
|
|
# ref_message.to_reference() → a distinct sentinel: the adapter now wraps
|
|
# the fetched Message via to_reference(fail_if_not_exists=False) so a
|
|
# deleted target degrades to "send without reply chip" instead of a 400.
|
|
mock_channel = AsyncMock()
|
|
ref_message = MagicMock()
|
|
ref_reference = MagicMock(name="MessageReference")
|
|
ref_message.to_reference = MagicMock(return_value=ref_reference)
|
|
mock_channel.fetch_message = AsyncMock(return_value=ref_message)
|
|
|
|
sent_msg = MagicMock()
|
|
sent_msg.id = 42
|
|
mock_channel.send = AsyncMock(return_value=sent_msg)
|
|
|
|
mock_client = MagicMock()
|
|
mock_client.get_channel = MagicMock(return_value=mock_channel)
|
|
|
|
adapter._client = mock_client
|
|
# Return the reference sentinel alongside so tests can assert identity.
|
|
adapter._test_expected_reference = ref_reference
|
|
return adapter, mock_channel, ref_reference
|
|
|
|
|
|
class TestSendWithReplyToMode:
|
|
"""Tests for send() method respecting reply_to_mode."""
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_off_mode_no_reply_reference(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("off")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["chunk1", "chunk2", "chunk3"]
|
|
|
|
await adapter.send("12345", "test content", reply_to="999")
|
|
|
|
# Should never try to fetch the reference message
|
|
channel.fetch_message.assert_not_called()
|
|
# All chunks sent without reference
|
|
for call in channel.send.call_args_list:
|
|
assert call.kwargs.get("reference") is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_first_mode_only_first_chunk_references(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("first")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["chunk1", "chunk2", "chunk3"]
|
|
|
|
await adapter.send("12345", "test content", reply_to="999")
|
|
|
|
# Should fetch the reference message
|
|
channel.fetch_message.assert_called_once_with(999)
|
|
calls = channel.send.call_args_list
|
|
assert len(calls) == 3
|
|
assert calls[0].kwargs.get("reference") is ref_msg
|
|
assert calls[1].kwargs.get("reference") is None
|
|
assert calls[2].kwargs.get("reference") is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_all_mode_all_chunks_reference(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("all")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["chunk1", "chunk2", "chunk3"]
|
|
|
|
await adapter.send("12345", "test content", reply_to="999")
|
|
|
|
channel.fetch_message.assert_called_once_with(999)
|
|
calls = channel.send.call_args_list
|
|
assert len(calls) == 3
|
|
for call in calls:
|
|
assert call.kwargs.get("reference") is ref_msg
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_no_reply_to_param_no_reference(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("all")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["chunk1", "chunk2"]
|
|
|
|
await adapter.send("12345", "test content", reply_to=None)
|
|
|
|
channel.fetch_message.assert_not_called()
|
|
for call in channel.send.call_args_list:
|
|
assert call.kwargs.get("reference") is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_single_chunk_respects_first_mode(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("first")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["single chunk"]
|
|
|
|
await adapter.send("12345", "test", reply_to="999")
|
|
|
|
calls = channel.send.call_args_list
|
|
assert len(calls) == 1
|
|
assert calls[0].kwargs.get("reference") is ref_msg
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_single_chunk_off_mode(self):
|
|
adapter, channel, ref_msg = _make_discord_adapter("off")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["single chunk"]
|
|
|
|
await adapter.send("12345", "test", reply_to="999")
|
|
|
|
channel.fetch_message.assert_not_called()
|
|
calls = channel.send.call_args_list
|
|
assert len(calls) == 1
|
|
assert calls[0].kwargs.get("reference") is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_invalid_mode_falls_back_to_first_behavior(self):
|
|
"""Invalid mode behaves like 'first' — only first chunk gets reference."""
|
|
adapter, channel, ref_msg = _make_discord_adapter("banana")
|
|
adapter.truncate_message = lambda content, max_len, **kw: ["chunk1", "chunk2"]
|
|
|
|
await adapter.send("12345", "test", reply_to="999")
|
|
|
|
calls = channel.send.call_args_list
|
|
assert len(calls) == 2
|
|
assert calls[0].kwargs.get("reference") is ref_msg
|
|
assert calls[1].kwargs.get("reference") is None
|
|
|
|
|
|
class TestConfigSerialization:
|
|
"""Tests for reply_to_mode serialization (shared with Telegram)."""
|
|
|
|
def test_to_dict_includes_reply_to_mode(self):
|
|
config = PlatformConfig(enabled=True, token="test", reply_to_mode="all")
|
|
result = config.to_dict()
|
|
assert result["reply_to_mode"] == "all"
|
|
|
|
def test_from_dict_loads_reply_to_mode(self):
|
|
data = {"enabled": True, "token": "***", "reply_to_mode": "off"}
|
|
config = PlatformConfig.from_dict(data)
|
|
assert config.reply_to_mode == "off"
|
|
|
|
def test_from_dict_defaults_to_first(self):
|
|
data = {"enabled": True, "token": "***"}
|
|
config = PlatformConfig.from_dict(data)
|
|
assert config.reply_to_mode == "first"
|
|
|
|
|
|
class TestEnvVarOverride:
|
|
"""Tests for DISCORD_REPLY_TO_MODE environment variable override."""
|
|
|
|
def _make_config(self):
|
|
config = GatewayConfig()
|
|
config.platforms[Platform.DISCORD] = PlatformConfig(enabled=True, token="test")
|
|
return config
|
|
|
|
def test_env_var_sets_off_mode(self):
|
|
config = self._make_config()
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": "off"}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "off"
|
|
|
|
def test_env_var_sets_all_mode(self):
|
|
config = self._make_config()
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": "all"}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "all"
|
|
|
|
def test_env_var_case_insensitive(self):
|
|
config = self._make_config()
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": "ALL"}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "all"
|
|
|
|
def test_env_var_invalid_value_ignored(self):
|
|
config = self._make_config()
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": "banana"}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "first"
|
|
|
|
def test_env_var_empty_value_ignored(self):
|
|
config = self._make_config()
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": ""}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "first"
|
|
|
|
def test_env_var_creates_platform_config_if_missing(self):
|
|
"""DISCORD_REPLY_TO_MODE creates PlatformConfig even without DISCORD_BOT_TOKEN."""
|
|
config = GatewayConfig()
|
|
assert Platform.DISCORD not in config.platforms
|
|
with patch.dict(os.environ, {"DISCORD_REPLY_TO_MODE": "off"}, clear=False):
|
|
_apply_env_overrides(config)
|
|
assert Platform.DISCORD in config.platforms
|
|
assert config.platforms[Platform.DISCORD].reply_to_mode == "off"
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
# Tests for reply_to_text extraction in _handle_message
|
|
# ------------------------------------------------------------------
|
|
|
|
# Build FakeDMChannel as a subclass of the real discord.DMChannel when the
|
|
# library is installed — this guarantees isinstance() checks pass in
|
|
# production code regardless of test ordering or monkeypatch state.
|
|
try:
|
|
import discord as _discord_lib
|
|
_DMChannelBase = _discord_lib.DMChannel
|
|
except (ImportError, AttributeError):
|
|
_DMChannelBase = object
|
|
|
|
|
|
class FakeDMChannel(_DMChannelBase):
|
|
"""Minimal DM channel stub (skips mention / channel-allow checks)."""
|
|
def __init__(self, channel_id: int = 100, name: str = "dm"):
|
|
# Do NOT call super().__init__() — real DMChannel requires State
|
|
self.id = channel_id
|
|
self.name = name
|
|
|
|
|
|
def _make_message(*, content: str = "hi", reference=None):
|
|
"""Build a mock Discord message for _handle_message tests."""
|
|
author = SimpleNamespace(id=42, display_name="TestUser", name="TestUser")
|
|
return SimpleNamespace(
|
|
id=999,
|
|
content=content,
|
|
mentions=[],
|
|
attachments=[],
|
|
reference=reference,
|
|
created_at=datetime.now(timezone.utc),
|
|
channel=FakeDMChannel(),
|
|
author=author,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def reply_text_adapter(monkeypatch):
|
|
"""DiscordAdapter wired for _handle_message → handle_message capture."""
|
|
config = PlatformConfig(enabled=True, token="fake-token")
|
|
adapter = DiscordAdapter(config)
|
|
adapter._client = SimpleNamespace(user=SimpleNamespace(id=999))
|
|
adapter._text_batch_delay_seconds = 0
|
|
adapter.handle_message = AsyncMock()
|
|
return adapter
|
|
|
|
|
|
class TestReplyToText:
|
|
"""Tests for reply_to_text populated by _handle_message."""
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_no_reference_both_none(self, reply_text_adapter):
|
|
message = _make_message(reference=None)
|
|
|
|
await reply_text_adapter._handle_message(message)
|
|
|
|
event = reply_text_adapter.handle_message.await_args.args[0]
|
|
assert event.reply_to_message_id is None
|
|
assert event.reply_to_text is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_reference_without_resolved(self, reply_text_adapter):
|
|
ref = SimpleNamespace(message_id=555, resolved=None)
|
|
message = _make_message(reference=ref)
|
|
|
|
await reply_text_adapter._handle_message(message)
|
|
|
|
event = reply_text_adapter.handle_message.await_args.args[0]
|
|
assert event.reply_to_message_id == "555"
|
|
assert event.reply_to_text is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_reference_with_resolved_content(self, reply_text_adapter):
|
|
resolved_msg = SimpleNamespace(content="original message text")
|
|
ref = SimpleNamespace(message_id=555, resolved=resolved_msg)
|
|
message = _make_message(reference=ref)
|
|
|
|
await reply_text_adapter._handle_message(message)
|
|
|
|
event = reply_text_adapter.handle_message.await_args.args[0]
|
|
assert event.reply_to_message_id == "555"
|
|
assert event.reply_to_text == "original message text"
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_reference_with_empty_resolved_content(self, reply_text_adapter):
|
|
"""Empty string content should become None, not leak as empty string."""
|
|
resolved_msg = SimpleNamespace(content="")
|
|
ref = SimpleNamespace(message_id=555, resolved=resolved_msg)
|
|
message = _make_message(reference=ref)
|
|
|
|
await reply_text_adapter._handle_message(message)
|
|
|
|
event = reply_text_adapter.handle_message.await_args.args[0]
|
|
assert event.reply_to_message_id == "555"
|
|
assert event.reply_to_text is None
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_reference_with_deleted_message(self, reply_text_adapter):
|
|
"""Deleted messages lack .content — getattr guard should return None."""
|
|
resolved_deleted = SimpleNamespace(id=555)
|
|
ref = SimpleNamespace(message_id=555, resolved=resolved_deleted)
|
|
message = _make_message(reference=ref)
|
|
|
|
await reply_text_adapter._handle_message(message)
|
|
|
|
event = reply_text_adapter.handle_message.await_args.args[0]
|
|
assert event.reply_to_message_id == "555"
|
|
assert event.reply_to_text is None
|
|
|
|
|
|
class TestYamlConfigLoading:
|
|
"""Tests for reply_to_mode loaded from config.yaml discord section."""
|
|
|
|
def _write_config(self, tmp_path, content: str):
|
|
hermes_home = tmp_path / ".hermes"
|
|
hermes_home.mkdir()
|
|
(hermes_home / "config.yaml").write_text(content, encoding="utf-8")
|
|
return hermes_home
|
|
|
|
def test_top_level_reply_to_mode_off(self, tmp_path, monkeypatch):
|
|
"""YAML 1.1 parses bare 'off' as boolean False — must map back to 'off'."""
|
|
hermes_home = self._write_config(tmp_path, "discord:\n reply_to_mode: off\n")
|
|
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
|
monkeypatch.delenv("DISCORD_REPLY_TO_MODE", raising=False)
|
|
|
|
load_gateway_config()
|
|
|
|
assert os.environ.get("DISCORD_REPLY_TO_MODE") == "off"
|
|
|
|
def test_top_level_reply_to_mode_all(self, tmp_path, monkeypatch):
|
|
hermes_home = self._write_config(tmp_path, "discord:\n reply_to_mode: all\n")
|
|
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
|
monkeypatch.delenv("DISCORD_REPLY_TO_MODE", raising=False)
|
|
|
|
load_gateway_config()
|
|
|
|
assert os.environ.get("DISCORD_REPLY_TO_MODE") == "all"
|
|
|
|
def test_extra_reply_to_mode_off(self, tmp_path, monkeypatch):
|
|
"""discord.extra.reply_to_mode is also honoured."""
|
|
hermes_home = self._write_config(
|
|
tmp_path, "discord:\n extra:\n reply_to_mode: \"off\"\n"
|
|
)
|
|
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
|
monkeypatch.delenv("DISCORD_REPLY_TO_MODE", raising=False)
|
|
|
|
load_gateway_config()
|
|
|
|
assert os.environ.get("DISCORD_REPLY_TO_MODE") == "off"
|
|
|
|
def test_env_var_takes_precedence_over_yaml(self, tmp_path, monkeypatch):
|
|
"""Existing DISCORD_REPLY_TO_MODE env var is not overwritten by YAML."""
|
|
hermes_home = self._write_config(tmp_path, "discord:\n reply_to_mode: all\n")
|
|
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
|
monkeypatch.setenv("DISCORD_REPLY_TO_MODE", "first")
|
|
|
|
load_gateway_config()
|
|
|
|
assert os.environ.get("DISCORD_REPLY_TO_MODE") == "first"
|
|
|
|
def test_top_level_takes_precedence_over_extra(self, tmp_path, monkeypatch):
|
|
"""discord.reply_to_mode wins over discord.extra.reply_to_mode."""
|
|
hermes_home = self._write_config(
|
|
tmp_path,
|
|
"discord:\n reply_to_mode: all\n extra:\n reply_to_mode: \"off\"\n",
|
|
)
|
|
monkeypatch.setenv("HERMES_HOME", str(hermes_home))
|
|
monkeypatch.delenv("DISCORD_REPLY_TO_MODE", raising=False)
|
|
|
|
load_gateway_config()
|
|
|
|
assert os.environ.get("DISCORD_REPLY_TO_MODE") == "all"
|