mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-25 00:51:20 +00:00
a266238e1e
Four fixes for the Weixin/WeChat adapter, synthesized from the best aspects of community PRs #8407, #8521, #8360, #7695, #8308, #8525, #7531, #8144, #8251. 1. Streaming cursor (▉) stuck permanently — WeChat doesn't support message editing, so the cursor appended during streaming can never be removed. Add SUPPORTS_MESSAGE_EDITING = False to WeixinAdapter and check it in gateway/run.py to use an empty cursor for non-edit platforms. (Fixes #8307, #8326) 2. Media upload failures — two bugs in _send_file(): a) upload_full_url path used PUT (404 on WeChat CDN); now uses POST. b) aes_key was base64(raw_bytes) but the iLink API expects base64(hex_string); images showed as grey boxes. (Fixes #8352, #7529) Also: unified both upload paths into _upload_ciphertext(), preferring upload_full_url. Added send_video/send_voice methods and voice_item media builder for audio/.silk files. Added video_md5 field. 3. Markdown links stripped — WeChat can't render [text](url), so format_message() now converts them to 'text (url)' plaintext. Code blocks are preserved. (Fixes #7617) 4. Blank message prevention — three guards: a) _split_text_for_weixin_delivery('') returns [] not [''] b) send() filters empty/whitespace chunks before _send_text_chunk c) _send_message() raises ValueError for empty text as safety net Community credit: joei4cm (#8407), lyonDan (#8521), SKFDJKLDG (#8360), tomqiaozc (#7695), joshleeeeee (#8308), luoxiao6645(#8525), longsizhuo (#7531), Astral-Yang (#8144), QingWei-Li (#8251).
522 lines
19 KiB
Python
522 lines
19 KiB
Python
"""Tests for the Weixin platform adapter."""
|
|
|
|
import asyncio
|
|
import json
|
|
import os
|
|
from unittest.mock import AsyncMock, patch
|
|
|
|
from gateway.config import PlatformConfig
|
|
from gateway.config import GatewayConfig, HomeChannel, Platform, _apply_env_overrides
|
|
from gateway.platforms import weixin
|
|
from gateway.platforms.weixin import ContextTokenStore, WeixinAdapter
|
|
from tools.send_message_tool import _parse_target_ref, _send_to_platform
|
|
|
|
|
|
def _make_adapter() -> WeixinAdapter:
|
|
return WeixinAdapter(
|
|
PlatformConfig(
|
|
enabled=True,
|
|
token="test-token",
|
|
extra={"account_id": "test-account"},
|
|
)
|
|
)
|
|
|
|
|
|
class TestWeixinFormatting:
|
|
def test_format_message_preserves_markdown_and_rewrites_headers(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = "# Title\n\n## Plan\n\nUse **bold** and [docs](https://example.com)."
|
|
|
|
assert (
|
|
adapter.format_message(content)
|
|
== "【Title】\n\n**Plan**\n\nUse **bold** and docs (https://example.com)."
|
|
)
|
|
|
|
def test_format_message_rewrites_markdown_tables(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = (
|
|
"| Setting | Value |\n"
|
|
"| --- | --- |\n"
|
|
"| Timeout | 30s |\n"
|
|
"| Retries | 3 |\n"
|
|
)
|
|
|
|
assert adapter.format_message(content) == (
|
|
"- Setting: Timeout\n"
|
|
" Value: 30s\n"
|
|
"- Setting: Retries\n"
|
|
" Value: 3"
|
|
)
|
|
|
|
def test_format_message_preserves_fenced_code_blocks(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = "## Snippet\n\n```python\nprint('hi')\n```"
|
|
|
|
assert adapter.format_message(content) == "**Snippet**\n\n```python\nprint('hi')\n```"
|
|
|
|
def test_format_message_returns_empty_string_for_none(self):
|
|
adapter = _make_adapter()
|
|
|
|
assert adapter.format_message(None) == ""
|
|
|
|
|
|
class TestWeixinChunking:
|
|
def test_split_text_splits_short_chatty_replies_into_separate_bubbles(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = adapter.format_message("第一行\n第二行\n第三行")
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == ["第一行", "第二行", "第三行"]
|
|
|
|
def test_split_text_keeps_structured_table_block_together(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = adapter.format_message(
|
|
"- Setting: Timeout\n Value: 30s\n- Setting: Retries\n Value: 3"
|
|
)
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == ["- Setting: Timeout\n Value: 30s\n- Setting: Retries\n Value: 3"]
|
|
|
|
def test_split_text_keeps_four_line_structured_blocks_together(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = adapter.format_message(
|
|
"今天结论：\n"
|
|
"- 留存下降 3%\n"
|
|
"- 转化上涨 8%\n"
|
|
"- 主要问题在首日激活"
|
|
)
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == ["今天结论：\n- 留存下降 3%\n- 转化上涨 8%\n- 主要问题在首日激活"]
|
|
|
|
def test_split_text_keeps_heading_with_body_together(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = adapter.format_message("## 结论\n这是正文")
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == ["**结论**\n这是正文"]
|
|
|
|
def test_split_text_keeps_short_reformatted_table_in_single_chunk(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = adapter.format_message(
|
|
"| Setting | Value |\n"
|
|
"| --- | --- |\n"
|
|
"| Timeout | 30s |\n"
|
|
"| Retries | 3 |\n"
|
|
)
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == [content]
|
|
|
|
def test_split_text_keeps_complete_code_block_together_when_possible(self):
|
|
adapter = _make_adapter()
|
|
adapter.MAX_MESSAGE_LENGTH = 80
|
|
|
|
content = adapter.format_message(
|
|
"## Intro\n\nShort paragraph.\n\n```python\nprint('hello world')\nprint('again')\n```\n\nTail paragraph."
|
|
)
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert len(chunks) >= 2
|
|
assert any(
|
|
"```python\nprint('hello world')\nprint('again')\n```" in chunk
|
|
for chunk in chunks
|
|
)
|
|
assert all(chunk.count("```") % 2 == 0 for chunk in chunks)
|
|
|
|
def test_split_text_safely_splits_long_code_blocks(self):
|
|
adapter = _make_adapter()
|
|
adapter.MAX_MESSAGE_LENGTH = 70
|
|
|
|
lines = "\n".join(f"line_{idx:02d} = {idx}" for idx in range(10))
|
|
content = adapter.format_message(f"```python\n{lines}\n```")
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert len(chunks) > 1
|
|
assert all(len(chunk) <= adapter.MAX_MESSAGE_LENGTH for chunk in chunks)
|
|
assert all(chunk.count("```") >= 2 for chunk in chunks)
|
|
|
|
def test_split_text_can_restore_legacy_multiline_splitting_via_config(self):
|
|
adapter = WeixinAdapter(
|
|
PlatformConfig(
|
|
enabled=True,
|
|
extra={
|
|
"account_id": "acct",
|
|
"token": "***",
|
|
"split_multiline_messages": True,
|
|
},
|
|
)
|
|
)
|
|
|
|
content = adapter.format_message("第一行\n第二行\n第三行")
|
|
chunks = adapter._split_text(content)
|
|
|
|
assert chunks == ["第一行", "第二行", "第三行"]
|
|
|
|
|
|
class TestWeixinConfig:
|
|
def test_apply_env_overrides_configures_weixin(self):
|
|
config = GatewayConfig()
|
|
|
|
with patch.dict(
|
|
os.environ,
|
|
{
|
|
"WEIXIN_ACCOUNT_ID": "bot-account",
|
|
"WEIXIN_TOKEN": "bot-token",
|
|
"WEIXIN_BASE_URL": "https://ilink.example.com/",
|
|
"WEIXIN_CDN_BASE_URL": "https://cdn.example.com/c2c/",
|
|
"WEIXIN_DM_POLICY": "allowlist",
|
|
"WEIXIN_SPLIT_MULTILINE_MESSAGES": "true",
|
|
"WEIXIN_ALLOWED_USERS": "wxid_1,wxid_2",
|
|
"WEIXIN_HOME_CHANNEL": "wxid_1",
|
|
"WEIXIN_HOME_CHANNEL_NAME": "Primary DM",
|
|
},
|
|
clear=True,
|
|
):
|
|
_apply_env_overrides(config)
|
|
|
|
platform_config = config.platforms[Platform.WEIXIN]
|
|
assert platform_config.enabled is True
|
|
assert platform_config.token == "bot-token"
|
|
assert platform_config.extra["account_id"] == "bot-account"
|
|
assert platform_config.extra["base_url"] == "https://ilink.example.com"
|
|
assert platform_config.extra["cdn_base_url"] == "https://cdn.example.com/c2c"
|
|
assert platform_config.extra["dm_policy"] == "allowlist"
|
|
assert platform_config.extra["split_multiline_messages"] == "true"
|
|
assert platform_config.extra["allow_from"] == "wxid_1,wxid_2"
|
|
assert platform_config.home_channel == HomeChannel(Platform.WEIXIN, "wxid_1", "Primary DM")
|
|
|
|
def test_get_connected_platforms_includes_weixin_with_token(self):
|
|
config = GatewayConfig(
|
|
platforms={
|
|
Platform.WEIXIN: PlatformConfig(
|
|
enabled=True,
|
|
token="bot-token",
|
|
extra={"account_id": "bot-account"},
|
|
)
|
|
}
|
|
)
|
|
|
|
assert config.get_connected_platforms() == [Platform.WEIXIN]
|
|
|
|
def test_get_connected_platforms_requires_account_id(self):
|
|
config = GatewayConfig(
|
|
platforms={
|
|
Platform.WEIXIN: PlatformConfig(
|
|
enabled=True,
|
|
token="bot-token",
|
|
)
|
|
}
|
|
)
|
|
|
|
assert config.get_connected_platforms() == []
|
|
|
|
|
|
class TestWeixinStatePersistence:
|
|
def test_save_weixin_account_preserves_existing_file_on_replace_failure(self, tmp_path, monkeypatch):
|
|
account_path = tmp_path / "weixin" / "accounts" / "acct.json"
|
|
account_path.parent.mkdir(parents=True, exist_ok=True)
|
|
original = {"token": "old-token", "base_url": "https://old.example.com"}
|
|
account_path.write_text(json.dumps(original), encoding="utf-8")
|
|
|
|
def _boom(_src, _dst):
|
|
raise OSError("disk full")
|
|
|
|
monkeypatch.setattr("utils.os.replace", _boom)
|
|
|
|
try:
|
|
weixin.save_weixin_account(
|
|
str(tmp_path),
|
|
account_id="acct",
|
|
token="new-token",
|
|
base_url="https://new.example.com",
|
|
user_id="wxid_new",
|
|
)
|
|
except OSError:
|
|
pass
|
|
else:
|
|
raise AssertionError("expected save_weixin_account to propagate replace failure")
|
|
|
|
assert json.loads(account_path.read_text(encoding="utf-8")) == original
|
|
|
|
def test_context_token_persist_preserves_existing_file_on_replace_failure(self, tmp_path, monkeypatch):
|
|
token_path = tmp_path / "weixin" / "accounts" / "acct.context-tokens.json"
|
|
token_path.parent.mkdir(parents=True, exist_ok=True)
|
|
token_path.write_text(json.dumps({"user-a": "old-token"}), encoding="utf-8")
|
|
|
|
def _boom(_src, _dst):
|
|
raise OSError("disk full")
|
|
|
|
monkeypatch.setattr("utils.os.replace", _boom)
|
|
|
|
store = ContextTokenStore(str(tmp_path))
|
|
with patch.object(weixin.logger, "warning") as warning_mock:
|
|
store.set("acct", "user-b", "new-token")
|
|
|
|
assert json.loads(token_path.read_text(encoding="utf-8")) == {"user-a": "old-token"}
|
|
warning_mock.assert_called_once()
|
|
|
|
def test_save_sync_buf_preserves_existing_file_on_replace_failure(self, tmp_path, monkeypatch):
|
|
sync_path = tmp_path / "weixin" / "accounts" / "acct.sync.json"
|
|
sync_path.parent.mkdir(parents=True, exist_ok=True)
|
|
sync_path.write_text(json.dumps({"get_updates_buf": "old-sync"}), encoding="utf-8")
|
|
|
|
def _boom(_src, _dst):
|
|
raise OSError("disk full")
|
|
|
|
monkeypatch.setattr("utils.os.replace", _boom)
|
|
|
|
try:
|
|
weixin._save_sync_buf(str(tmp_path), "acct", "new-sync")
|
|
except OSError:
|
|
pass
|
|
else:
|
|
raise AssertionError("expected _save_sync_buf to propagate replace failure")
|
|
|
|
assert json.loads(sync_path.read_text(encoding="utf-8")) == {"get_updates_buf": "old-sync"}
|
|
|
|
|
|
class TestWeixinSendMessageIntegration:
|
|
def test_parse_target_ref_accepts_weixin_ids(self):
|
|
assert _parse_target_ref("weixin", "wxid_test123") == ("wxid_test123", None, True)
|
|
assert _parse_target_ref("weixin", "filehelper") == ("filehelper", None, True)
|
|
assert _parse_target_ref("weixin", "group@chatroom") == ("group@chatroom", None, True)
|
|
|
|
@patch("tools.send_message_tool._send_weixin", new_callable=AsyncMock)
|
|
def test_send_to_platform_routes_weixin_media_to_native_helper(self, send_weixin_mock):
|
|
send_weixin_mock.return_value = {"success": True, "platform": "weixin", "chat_id": "wxid_test123"}
|
|
config = PlatformConfig(enabled=True, token="bot-token", extra={"account_id": "bot-account"})
|
|
|
|
result = asyncio.run(
|
|
_send_to_platform(
|
|
Platform.WEIXIN,
|
|
config,
|
|
"wxid_test123",
|
|
"hello",
|
|
media_files=[("/tmp/demo.png", False)],
|
|
)
|
|
)
|
|
|
|
assert result["success"] is True
|
|
send_weixin_mock.assert_awaited_once_with(
|
|
config,
|
|
"wxid_test123",
|
|
"hello",
|
|
media_files=[("/tmp/demo.png", False)],
|
|
)
|
|
|
|
|
|
class TestWeixinChunkDelivery:
|
|
def _connected_adapter(self) -> WeixinAdapter:
|
|
adapter = _make_adapter()
|
|
adapter._session = object()
|
|
adapter._token = "test-token"
|
|
adapter._base_url = "https://weixin.example.com"
|
|
adapter._token_store.get = lambda account_id, chat_id: "ctx-token"
|
|
return adapter
|
|
|
|
@patch("gateway.platforms.weixin.asyncio.sleep", new_callable=AsyncMock)
|
|
@patch("gateway.platforms.weixin._send_message", new_callable=AsyncMock)
|
|
def test_send_waits_between_multiple_chunks(self, send_message_mock, sleep_mock):
|
|
adapter = self._connected_adapter()
|
|
adapter.MAX_MESSAGE_LENGTH = 12
|
|
|
|
# Use double newlines so _pack_markdown_blocks splits into 3 blocks
|
|
result = asyncio.run(adapter.send("wxid_test123", "first\n\nsecond\n\nthird"))
|
|
|
|
assert result.success is True
|
|
assert send_message_mock.await_count == 3
|
|
assert sleep_mock.await_count == 2
|
|
|
|
@patch("gateway.platforms.weixin.asyncio.sleep", new_callable=AsyncMock)
|
|
@patch("gateway.platforms.weixin._send_message", new_callable=AsyncMock)
|
|
def test_send_retries_failed_chunk_before_continuing(self, send_message_mock, sleep_mock):
|
|
adapter = self._connected_adapter()
|
|
adapter.MAX_MESSAGE_LENGTH = 12
|
|
calls = {"count": 0}
|
|
|
|
async def flaky_send(*args, **kwargs):
|
|
calls["count"] += 1
|
|
if calls["count"] == 2:
|
|
raise RuntimeError("temporary iLink failure")
|
|
|
|
send_message_mock.side_effect = flaky_send
|
|
|
|
# Use double newlines so _pack_markdown_blocks splits into 3 blocks
|
|
result = asyncio.run(adapter.send("wxid_test123", "first\n\nsecond\n\nthird"))
|
|
|
|
assert result.success is True
|
|
# 3 chunks, but chunk 2 fails once and retries → 4 _send_message calls total
|
|
assert send_message_mock.await_count == 4
|
|
# The retried chunk should reuse the same client_id for deduplication
|
|
first_try = send_message_mock.await_args_list[1].kwargs
|
|
retry = send_message_mock.await_args_list[2].kwargs
|
|
assert first_try["text"] == retry["text"]
|
|
assert first_try["client_id"] == retry["client_id"]
|
|
|
|
|
|
class TestWeixinRemoteMediaSafety:
|
|
def test_download_remote_media_blocks_unsafe_urls(self):
|
|
adapter = _make_adapter()
|
|
|
|
with patch("tools.url_safety.is_safe_url", return_value=False):
|
|
try:
|
|
asyncio.run(adapter._download_remote_media("http://127.0.0.1/private.png"))
|
|
except ValueError as exc:
|
|
assert "Blocked unsafe URL" in str(exc)
|
|
else:
|
|
raise AssertionError("expected ValueError for unsafe URL")
|
|
|
|
|
|
class TestWeixinMarkdownLinks:
|
|
"""Markdown links should be converted to plaintext since WeChat can't render them."""
|
|
|
|
def test_format_message_converts_markdown_links_to_plain_text(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = "Check [the docs](https://example.com) and [GitHub](https://github.com) for details"
|
|
assert (
|
|
adapter.format_message(content)
|
|
== "Check the docs (https://example.com) and GitHub (https://github.com) for details"
|
|
)
|
|
|
|
def test_format_message_preserves_links_inside_code_blocks(self):
|
|
adapter = _make_adapter()
|
|
|
|
content = "See below:\n\n```\n[link](https://example.com)\n```\n\nDone."
|
|
result = adapter.format_message(content)
|
|
assert "[link](https://example.com)" in result
|
|
|
|
|
|
class TestWeixinBlankMessagePrevention:
|
|
"""Regression tests for the blank-bubble bugs.
|
|
|
|
Three separate guards now prevent a blank WeChat message from ever being
|
|
dispatched:
|
|
|
|
1. ``_split_text_for_weixin_delivery("")`` returns ``[]`` — not ``[""]``.
|
|
2. ``send()`` filters out empty/whitespace-only chunks before calling
|
|
``_send_text_chunk``.
|
|
3. ``_send_message()`` raises ``ValueError`` for empty text as a last-resort
|
|
safety net.
|
|
"""
|
|
|
|
def test_split_text_returns_empty_list_for_empty_string(self):
|
|
adapter = _make_adapter()
|
|
assert adapter._split_text("") == []
|
|
|
|
def test_split_text_returns_empty_list_for_empty_string_split_per_line(self):
|
|
adapter = WeixinAdapter(
|
|
PlatformConfig(
|
|
enabled=True,
|
|
extra={
|
|
"account_id": "acct",
|
|
"token": "test-tok",
|
|
"split_multiline_messages": True,
|
|
},
|
|
)
|
|
)
|
|
assert adapter._split_text("") == []
|
|
|
|
@patch("gateway.platforms.weixin._send_message", new_callable=AsyncMock)
|
|
def test_send_empty_content_does_not_call_send_message(self, send_message_mock):
|
|
adapter = _make_adapter()
|
|
adapter._session = object()
|
|
adapter._token = "test-token"
|
|
adapter._base_url = "https://weixin.example.com"
|
|
adapter._token_store.get = lambda account_id, chat_id: "ctx-token"
|
|
|
|
result = asyncio.run(adapter.send("wxid_test123", ""))
|
|
# Empty content → no chunks → no _send_message calls
|
|
assert result.success is True
|
|
send_message_mock.assert_not_awaited()
|
|
|
|
def test_send_message_rejects_empty_text(self):
|
|
"""_send_message raises ValueError for empty/whitespace text."""
|
|
import pytest
|
|
with pytest.raises(ValueError, match="text must not be empty"):
|
|
asyncio.run(
|
|
weixin._send_message(
|
|
AsyncMock(),
|
|
base_url="https://example.com",
|
|
token="tok",
|
|
to="wxid_test",
|
|
text="",
|
|
context_token=None,
|
|
client_id="cid",
|
|
)
|
|
)
|
|
|
|
|
|
class TestWeixinStreamingCursorSuppression:
|
|
"""WeChat doesn't support message editing — cursor must be suppressed."""
|
|
|
|
def test_supports_message_editing_is_false(self):
|
|
adapter = _make_adapter()
|
|
assert adapter.SUPPORTS_MESSAGE_EDITING is False
|
|
|
|
|
|
class TestWeixinMediaBuilder:
|
|
"""Media builder uses base64(hex_key), not base64(raw_bytes) for aes_key."""
|
|
|
|
def test_image_builder_aes_key_is_base64_of_hex(self):
|
|
import base64
|
|
adapter = _make_adapter()
|
|
media_type, builder = adapter._outbound_media_builder("photo.jpg")
|
|
assert media_type == weixin.MEDIA_IMAGE
|
|
|
|
fake_hex_key = "0123456789abcdef0123456789abcdef"
|
|
expected_aes = base64.b64encode(fake_hex_key.encode("ascii")).decode("ascii")
|
|
item = builder(
|
|
encrypt_query_param="eq",
|
|
aes_key_for_api=expected_aes,
|
|
ciphertext_size=1024,
|
|
plaintext_size=1000,
|
|
filename="photo.jpg",
|
|
rawfilemd5="abc123",
|
|
)
|
|
assert item["image_item"]["media"]["aes_key"] == expected_aes
|
|
|
|
def test_video_builder_includes_md5(self):
|
|
adapter = _make_adapter()
|
|
media_type, builder = adapter._outbound_media_builder("clip.mp4")
|
|
assert media_type == weixin.MEDIA_VIDEO
|
|
|
|
item = builder(
|
|
encrypt_query_param="eq",
|
|
aes_key_for_api="fakekey",
|
|
ciphertext_size=2048,
|
|
plaintext_size=2000,
|
|
filename="clip.mp4",
|
|
rawfilemd5="deadbeef",
|
|
)
|
|
assert item["video_item"]["video_md5"] == "deadbeef"
|
|
|
|
def test_voice_builder_for_audio_files(self):
|
|
adapter = _make_adapter()
|
|
media_type, builder = adapter._outbound_media_builder("note.mp3")
|
|
assert media_type == weixin.MEDIA_VOICE
|
|
|
|
item = builder(
|
|
encrypt_query_param="eq",
|
|
aes_key_for_api="fakekey",
|
|
ciphertext_size=512,
|
|
plaintext_size=500,
|
|
filename="note.mp3",
|
|
rawfilemd5="abc",
|
|
)
|
|
assert item["type"] == weixin.ITEM_VOICE
|
|
assert "voice_item" in item
|
|
|
|
def test_voice_builder_for_silk_files(self):
|
|
adapter = _make_adapter()
|
|
media_type, builder = adapter._outbound_media_builder("recording.silk")
|
|
assert media_type == weixin.MEDIA_VOICE
|