mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-25 00:51:20 +00:00
607be54a24
Extend forum support from PR #10145: - REST path (_send_discord): forum thread creation now uploads media files as multipart attachments on the starter message in a single call. Previously media files were silently dropped on the forum path. - Websocket media paths (_send_file_attachment, send_voice, send_image, send_animation — covers send_image_file, send_video, send_document transitively): forum channels now go through a new _forum_post_file helper that creates a thread with the file as starter content, instead of failing via channel.send(file=...) which forums reject. - _send_to_forum chunk follow-up failures are collected into raw_response['warnings'] so partial-send outcomes surface. - Process-local probe cache (_DISCORD_CHANNEL_TYPE_PROBE_CACHE) avoids GET /channels/{id} on every uncached send after the first. - Dedup of TestSendDiscordMedia that the PR merge-resolution left behind. - Docs: Forum Channels section under website/docs/user-guide/messaging/discord.md. Tests: 117 passed (22 new for forum+media, probe cache, warnings).
388 lines
14 KiB
Python
388 lines
14 KiB
Python
from types import SimpleNamespace
|
|
from unittest.mock import AsyncMock, MagicMock
|
|
import sys
|
|
|
|
import pytest
|
|
|
|
from gateway.config import PlatformConfig
|
|
|
|
|
|
def _ensure_discord_mock():
|
|
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.mark.asyncio
|
|
async def test_send_retries_without_reference_when_reply_target_is_system_message():
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
reference_obj = object()
|
|
ref_msg = SimpleNamespace(id=99, to_reference=MagicMock(return_value=reference_obj))
|
|
sent_msg = SimpleNamespace(id=1234)
|
|
send_calls = []
|
|
|
|
async def fake_send(*, content, reference=None):
|
|
send_calls.append({"content": content, "reference": reference})
|
|
if len(send_calls) == 1:
|
|
raise RuntimeError(
|
|
"400 Bad Request (error code: 50035): Invalid Form Body\n"
|
|
"In message_reference: Cannot reply to a system message"
|
|
)
|
|
return sent_msg
|
|
|
|
channel = SimpleNamespace(
|
|
fetch_message=AsyncMock(return_value=ref_msg),
|
|
send=AsyncMock(side_effect=fake_send),
|
|
)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
result = await adapter.send("555", "hello", reply_to="99")
|
|
|
|
assert result.success is True
|
|
assert result.message_id == "1234"
|
|
assert channel.fetch_message.await_count == 1
|
|
assert channel.send.await_count == 2
|
|
ref_msg.to_reference.assert_called_once_with(fail_if_not_exists=False)
|
|
assert send_calls[0]["reference"] is reference_obj
|
|
assert send_calls[1]["reference"] is None
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_retries_without_reference_when_reply_target_is_deleted():
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
reference_obj = object()
|
|
ref_msg = SimpleNamespace(id=99, to_reference=MagicMock(return_value=reference_obj))
|
|
sent_msgs = [SimpleNamespace(id=1001), SimpleNamespace(id=1002)]
|
|
send_calls = []
|
|
|
|
async def fake_send(*, content, reference=None):
|
|
send_calls.append({"content": content, "reference": reference})
|
|
if len(send_calls) == 1:
|
|
raise RuntimeError(
|
|
"400 Bad Request (error code: 10008): Unknown Message"
|
|
)
|
|
return sent_msgs[len(send_calls) - 2]
|
|
|
|
channel = SimpleNamespace(
|
|
fetch_message=AsyncMock(return_value=ref_msg),
|
|
send=AsyncMock(side_effect=fake_send),
|
|
)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
long_text = "A" * (adapter.MAX_MESSAGE_LENGTH + 50)
|
|
result = await adapter.send("555", long_text, reply_to="99")
|
|
|
|
assert result.success is True
|
|
assert result.message_id == "1001"
|
|
assert channel.fetch_message.await_count == 1
|
|
assert channel.send.await_count == 3
|
|
ref_msg.to_reference.assert_called_once_with(fail_if_not_exists=False)
|
|
assert send_calls[0]["reference"] is reference_obj
|
|
assert send_calls[1]["reference"] is None
|
|
assert send_calls[2]["reference"] is None
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_does_not_retry_on_unrelated_errors():
|
|
"""Regression guard: errors unrelated to the reply reference (e.g. 50013
|
|
Missing Permissions) must NOT trigger the no-reference retry path — they
|
|
should propagate out of the per-chunk loop and surface as a failed
|
|
SendResult so the caller sees the real problem instead of a silent retry.
|
|
"""
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
reference_obj = object()
|
|
ref_msg = SimpleNamespace(id=99, to_reference=MagicMock(return_value=reference_obj))
|
|
send_calls = []
|
|
|
|
async def fake_send(*, content, reference=None):
|
|
send_calls.append({"content": content, "reference": reference})
|
|
raise RuntimeError(
|
|
"403 Forbidden (error code: 50013): Missing Permissions"
|
|
)
|
|
|
|
channel = SimpleNamespace(
|
|
fetch_message=AsyncMock(return_value=ref_msg),
|
|
send=AsyncMock(side_effect=fake_send),
|
|
)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
result = await adapter.send("555", "hello", reply_to="99")
|
|
|
|
# Outer except in adapter.send() wraps propagated errors as SendResult.
|
|
assert result.success is False
|
|
assert "50013" in (result.error or "")
|
|
# Only the first attempt happens — no reference-retry replay.
|
|
assert channel.send.await_count == 1
|
|
assert send_calls[0]["reference"] is reference_obj
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Forum channel tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
import discord as _discord_mod # noqa: E402 — imported after _ensure_discord_mock
|
|
|
|
|
|
class TestIsForumParent:
|
|
def test_none_returns_false(self):
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
assert adapter._is_forum_parent(None) is False
|
|
|
|
def test_forum_channel_class_instance(self):
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
forum_cls = getattr(_discord_mod, "ForumChannel", None)
|
|
if forum_cls is None:
|
|
# Re-create a type for the mock
|
|
forum_cls = type("ForumChannel", (), {})
|
|
_discord_mod.ForumChannel = forum_cls
|
|
ch = forum_cls()
|
|
assert adapter._is_forum_parent(ch) is True
|
|
|
|
def test_type_value_15(self):
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
ch = SimpleNamespace(type=15)
|
|
assert adapter._is_forum_parent(ch) is True
|
|
|
|
def test_regular_channel_returns_false(self):
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
ch = SimpleNamespace(type=0)
|
|
assert adapter._is_forum_parent(ch) is False
|
|
|
|
def test_thread_returns_false(self):
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
ch = SimpleNamespace(type=11) # public thread
|
|
assert adapter._is_forum_parent(ch) is False
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_to_forum_creates_thread_post():
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
# thread object has no 'send' so _send_to_forum uses thread.thread
|
|
thread_ch = SimpleNamespace(id=555, send=AsyncMock(return_value=SimpleNamespace(id=600)))
|
|
thread = SimpleNamespace(
|
|
id=555,
|
|
message=SimpleNamespace(id=500),
|
|
thread=thread_ch,
|
|
)
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.name = "ideas"
|
|
forum_channel.create_thread = AsyncMock(return_value=thread)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: forum_channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
result = await adapter.send("999", "Hello forum!")
|
|
|
|
assert result.success is True
|
|
assert result.message_id == "500"
|
|
forum_channel.create_thread.assert_awaited_once()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_to_forum_sends_remaining_chunks():
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
# Force a small max message length so the message splits
|
|
adapter.MAX_MESSAGE_LENGTH = 20
|
|
|
|
chunk_msg_1 = SimpleNamespace(id=500)
|
|
chunk_msg_2 = SimpleNamespace(id=501)
|
|
thread_ch = SimpleNamespace(
|
|
id=555,
|
|
send=AsyncMock(return_value=chunk_msg_2),
|
|
)
|
|
# thread object has no 'send' so _send_to_forum uses thread.thread
|
|
thread = SimpleNamespace(
|
|
id=555,
|
|
message=chunk_msg_1,
|
|
thread=thread_ch,
|
|
)
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.name = "ideas"
|
|
forum_channel.create_thread = AsyncMock(return_value=thread)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: forum_channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
result = await adapter.send("999", "A" * 50)
|
|
|
|
assert result.success is True
|
|
assert result.message_id == "500"
|
|
# Should have sent at least one follow-up chunk
|
|
assert thread_ch.send.await_count >= 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_to_forum_create_thread_failure():
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.name = "ideas"
|
|
forum_channel.create_thread = AsyncMock(side_effect=Exception("rate limited"))
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: forum_channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
result = await adapter.send("999", "Hello forum!")
|
|
|
|
assert result.success is False
|
|
assert "rate limited" in result.error
|
|
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Forum follow-up chunk failure reporting + media on forum paths
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_send_to_forum_follow_up_chunk_failures_collected_as_warnings():
|
|
"""Partial-send chunk failures surface in raw_response['warnings']."""
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
adapter.MAX_MESSAGE_LENGTH = 20
|
|
|
|
chunk_msg_1 = SimpleNamespace(id=500)
|
|
# Every follow-up chunk fails — we should collect a warning per failure
|
|
thread_ch = SimpleNamespace(
|
|
id=555,
|
|
send=AsyncMock(side_effect=Exception("rate limited")),
|
|
)
|
|
thread = SimpleNamespace(id=555, message=chunk_msg_1, thread=thread_ch)
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.name = "ideas"
|
|
forum_channel.create_thread = AsyncMock(return_value=thread)
|
|
adapter._client = SimpleNamespace(
|
|
get_channel=lambda _chat_id: forum_channel,
|
|
fetch_channel=AsyncMock(),
|
|
)
|
|
|
|
# Long enough to produce multiple chunks
|
|
result = await adapter.send("999", "A" * 60)
|
|
|
|
# Starter message (first chunk) was delivered via create_thread, so send is
|
|
# successful overall — but follow-up chunks all failed and are reported.
|
|
assert result.success is True
|
|
assert result.message_id == "500"
|
|
warnings = (result.raw_response or {}).get("warnings") or []
|
|
assert len(warnings) >= 1
|
|
assert all("rate limited" in w for w in warnings)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_forum_post_file_creates_thread_with_attachment():
|
|
"""_forum_post_file routes file-bearing sends to create_thread with file kwarg."""
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
thread_ch = SimpleNamespace(id=777, send=AsyncMock())
|
|
thread = SimpleNamespace(id=777, message=SimpleNamespace(id=800), thread=thread_ch)
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.name = "ideas"
|
|
forum_channel.create_thread = AsyncMock(return_value=thread)
|
|
|
|
# discord.File is a real class; build a MagicMock that looks like one
|
|
fake_file = SimpleNamespace(filename="photo.png")
|
|
|
|
result = await adapter._forum_post_file(
|
|
forum_channel,
|
|
content="here is a photo",
|
|
file=fake_file,
|
|
)
|
|
|
|
assert result.success is True
|
|
assert result.message_id == "800"
|
|
forum_channel.create_thread.assert_awaited_once()
|
|
call_kwargs = forum_channel.create_thread.await_args.kwargs
|
|
assert call_kwargs["file"] is fake_file
|
|
assert call_kwargs["content"] == "here is a photo"
|
|
# Thread name derived from content's first line
|
|
assert call_kwargs["name"] == "here is a photo"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_forum_post_file_uses_filename_when_no_content():
|
|
"""Thread name falls back to file.filename when no content is provided."""
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
thread = SimpleNamespace(id=1, message=SimpleNamespace(id=2), thread=SimpleNamespace(id=1, send=AsyncMock()))
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 10
|
|
forum_channel.name = "forum"
|
|
forum_channel.create_thread = AsyncMock(return_value=thread)
|
|
|
|
fake_file = SimpleNamespace(filename="voice-message.ogg")
|
|
result = await adapter._forum_post_file(forum_channel, content="", file=fake_file)
|
|
|
|
assert result.success is True
|
|
call_kwargs = forum_channel.create_thread.await_args.kwargs
|
|
# Content was empty → thread name derived from filename
|
|
assert call_kwargs["name"] == "voice-message.ogg"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_forum_post_file_creation_failure():
|
|
"""_forum_post_file returns a failed SendResult when create_thread raises."""
|
|
adapter = DiscordAdapter(PlatformConfig(enabled=True, token="***"))
|
|
|
|
forum_channel = _discord_mod.ForumChannel()
|
|
forum_channel.id = 999
|
|
forum_channel.create_thread = AsyncMock(side_effect=Exception("missing perms"))
|
|
|
|
result = await adapter._forum_post_file(
|
|
forum_channel,
|
|
content="hi",
|
|
file=SimpleNamespace(filename="x.png"),
|
|
)
|
|
|
|
assert result.success is False
|
|
assert "missing perms" in (result.error or "")
|