mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-29 06:31:32 +00:00
Second migration of an existing built-in platform adapter after Discord (PR #30591) — follows the same shape established by IRC / Teams / LINE / Google Chat / SimpleX and the playbook in `references/platform-plugin-migration.md`. Advances the umbrella refactor in #3823. Matches Discord's parity bar — adapter under `plugins/platforms/mattermost/` with the standard `__init__.py` / `adapter.py` / `plugin.yaml` shell, `register(ctx)` entry point, **no back-compat shim** at the old import path, and full parity for all five hooks Discord uses plus the `apply_yaml_config_fn` hook (mattermost is the second consumer of #25443 after Discord): * `standalone_sender_fn` — out-of-process cron delivery via Mattermost REST API. Picks up the thread_id + media_files capabilities the legacy `_send_mattermost` lacked (parity with Discord's `_standalone_send`). * `setup_fn` — interactive `hermes setup gateway` wizard. * `apply_yaml_config_fn` — translates `config.yaml` `mattermost:` keys (`require_mention`, `free_response_channels`, `allowed_channels`) into `MATTERMOST_*` env vars (replaces the hardcoded block in `gateway/config.py`). * `is_connected` — declares connection state from `MATTERMOST_TOKEN` + `MATTERMOST_URL`. * `check_fn` — verifies aiohttp is installed and both required env vars are set. * plus `allowed_users_env`, `allow_all_env`, `cron_deliver_env_var`, `max_message_length` (4000 — Mattermost practical limit), `emoji`, `required_env`, `install_hint`. Files ----- * `gateway/platforms/mattermost.py` (873 LOC) → `plugins/platforms/mattermost/adapter.py` (git rename, R071) + appended `register()` block, hook helpers, and `_standalone_send` with media upload + thread_id support. * New `plugins/platforms/mattermost/{__init__.py, plugin.yaml}` with `requires_env` / `optional_env` declarations covering MATTERMOST_URL, MATTERMOST_TOKEN, MATTERMOST_ALLOWED_USERS, MATTERMOST_ALLOW_ALL_USERS, MATTERMOST_HOME_CHANNEL, MATTERMOST_REPLY_MODE, MATTERMOST_REQUIRE_MENTION, MATTERMOST_FREE_RESPONSE_CHANNELS, MATTERMOST_ALLOWED_CHANNELS. * `gateway/config.py`: delete 17-LOC `mattermost_cfg` YAML→env bridge (moved into plugin's `_apply_yaml_config`). * `gateway/run.py::_create_adapter`: delete `Platform.MATTERMOST elif` — replaced by the existing generic plugin-registry-first dispatch. * `tools/send_message_tool.py`: delete `_send_mattermost` (22 LOC) + `Platform.MATTERMOST elif` in `_send_to_platform` — the `else` branch already routes plugin platforms through `_send_via_adapter`, which hits the registry's `standalone_sender_fn`. * `hermes_cli/setup.py`: delete `_setup_mattermost` (44 LOC) — replaced by the plugin's `interactive_setup`. * `hermes_cli/gateway.py`: delete `_PLATFORMS["mattermost"]` dict entry (3 LOC) — plugin's `setup_fn` is dispatched via the plugin path in `_configure_platform`. * Consumer rewrite: 5 test files (test_mattermost.py, test_media_download_retry.py, test_send_multiple_images.py, test_stream_consumer.py, test_ws_auth_retry.py) get `gateway.platforms.mattermost` → `plugins.platforms.mattermost.adapter` with the bulk-rewrite recipe from the platform-plugin-migration playbook. Single `mock.patch` string in test_stream_consumer.py also repointed. * `tests/tools/test_send_message_missing_platforms.py`: thin `(token, extra, chat_id, message)` compat shim around the plugin's `_standalone_send(pconfig, …)` so existing test bodies continue to work without rewriting every signature. Validation ---------- * Plugin discovery: mattermost registers from `plugins/platforms/mattermost/` alongside discord / teams / irc / line / google_chat / simplex. All 9 hooks present (setup_fn, standalone_sender_fn, apply_yaml_config_fn, is_connected, check_fn, allowed_users_env, allow_all_env, cron_deliver_env_var, max_message_length=4000). * Mattermost-touching tests: 62/62 pass (`test_mattermost.py` + `test_send_message_missing_platforms.py`). * Targeted selectors (mattermost or platform_registry or stream_consumer or ws_auth_retry or media_download_retry or send_multiple_images or send_message_tool or platform_connected): 433/433 pass. * Full sweep (`scripts/run_tests.sh tests/gateway/ tests/cron/ tests/tools/test_send_message_tool.py tests/tools/test_send_message_missing_platforms.py tests/integration/`): **6220/6220 pass in 47.8s, 0 failures**. * Lint: ruff clean on all touched files. * Git identity verified: kshitijk4poor. * Rename detection: R071 (similarity dropped from a hypothetical R09x by the ~320-line appended register block — ~36% growth over the 873-LoC base, vs Discord's 5101 LoC base which kept R091). Closes part of #3823.
228 lines
7.2 KiB
Python
228 lines
7.2 KiB
Python
"""Tests for auth-aware retry in Mattermost WS and Matrix sync loops.
|
|
|
|
Both Mattermost's _ws_loop and Matrix's _sync_loop previously caught all
|
|
exceptions with a broad ``except Exception`` and retried forever. Permanent
|
|
auth failures (401, 403, M_UNKNOWN_TOKEN) would loop indefinitely instead
|
|
of stopping. These tests verify that auth errors now stop the reconnect.
|
|
"""
|
|
|
|
import asyncio
|
|
from unittest.mock import AsyncMock, MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Mattermost: _ws_loop auth-aware retry
|
|
# ---------------------------------------------------------------------------
|
|
|
|
class TestMattermostWSAuthRetry:
|
|
"""gateway/platforms/mattermost.py — _ws_loop()"""
|
|
|
|
def test_401_handshake_stops_reconnect(self):
|
|
"""A WSServerHandshakeError with status 401 should stop the loop."""
|
|
import aiohttp
|
|
|
|
exc = aiohttp.WSServerHandshakeError(
|
|
request_info=MagicMock(),
|
|
history=(),
|
|
status=401,
|
|
message="Unauthorized",
|
|
headers=MagicMock(),
|
|
)
|
|
|
|
from plugins.platforms.mattermost.adapter import MattermostAdapter
|
|
adapter = MattermostAdapter.__new__(MattermostAdapter)
|
|
adapter._closing = False
|
|
|
|
call_count = 0
|
|
|
|
async def fake_connect():
|
|
nonlocal call_count
|
|
call_count += 1
|
|
raise exc
|
|
|
|
adapter._ws_connect_and_listen = fake_connect
|
|
|
|
asyncio.run(adapter._ws_loop())
|
|
|
|
# Should have attempted once and stopped, not retried
|
|
assert call_count == 1
|
|
|
|
def test_403_handshake_stops_reconnect(self):
|
|
"""A WSServerHandshakeError with status 403 should stop the loop."""
|
|
import aiohttp
|
|
|
|
exc = aiohttp.WSServerHandshakeError(
|
|
request_info=MagicMock(),
|
|
history=(),
|
|
status=403,
|
|
message="Forbidden",
|
|
headers=MagicMock(),
|
|
)
|
|
|
|
from plugins.platforms.mattermost.adapter import MattermostAdapter
|
|
adapter = MattermostAdapter.__new__(MattermostAdapter)
|
|
adapter._closing = False
|
|
|
|
call_count = 0
|
|
|
|
async def fake_connect():
|
|
nonlocal call_count
|
|
call_count += 1
|
|
raise exc
|
|
|
|
adapter._ws_connect_and_listen = fake_connect
|
|
|
|
asyncio.run(adapter._ws_loop())
|
|
assert call_count == 1
|
|
|
|
def test_transient_error_retries(self):
|
|
"""A transient ConnectionError should retry (not stop immediately)."""
|
|
from plugins.platforms.mattermost.adapter import MattermostAdapter
|
|
adapter = MattermostAdapter.__new__(MattermostAdapter)
|
|
adapter._closing = False
|
|
|
|
call_count = 0
|
|
|
|
async def fake_connect():
|
|
nonlocal call_count
|
|
call_count += 1
|
|
if call_count >= 2:
|
|
# Stop the loop after 2 attempts
|
|
adapter._closing = True
|
|
return
|
|
raise ConnectionError("connection reset")
|
|
|
|
adapter._ws_connect_and_listen = fake_connect
|
|
|
|
async def run():
|
|
with patch("asyncio.sleep", new_callable=AsyncMock):
|
|
await adapter._ws_loop()
|
|
|
|
asyncio.run(run())
|
|
|
|
# Should have retried at least once
|
|
assert call_count >= 2
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Matrix: _sync_loop auth-aware retry
|
|
# ---------------------------------------------------------------------------
|
|
|
|
class TestMatrixSyncAuthRetry:
|
|
"""gateway/platforms/matrix.py — _sync_loop()"""
|
|
|
|
def test_unknown_token_sync_error_stops_loop(self):
|
|
"""A SyncError with M_UNKNOWN_TOKEN should stop syncing."""
|
|
import types
|
|
nio_mock = types.ModuleType("nio")
|
|
|
|
class SyncError:
|
|
def __init__(self, message):
|
|
self.message = message
|
|
|
|
nio_mock.SyncError = SyncError
|
|
|
|
from gateway.platforms.matrix import MatrixAdapter
|
|
adapter = MatrixAdapter.__new__(MatrixAdapter)
|
|
adapter._closing = False
|
|
|
|
sync_count = 0
|
|
|
|
async def fake_sync(timeout=30000, since=None):
|
|
nonlocal sync_count
|
|
sync_count += 1
|
|
return SyncError("M_UNKNOWN_TOKEN: Invalid access token")
|
|
|
|
adapter._client = MagicMock()
|
|
adapter._client.sync = fake_sync
|
|
adapter._client.sync_store = MagicMock()
|
|
adapter._client.sync_store.get_next_batch = AsyncMock(return_value=None)
|
|
adapter._pending_megolm = []
|
|
adapter._joined_rooms = set()
|
|
|
|
async def run():
|
|
import sys
|
|
sys.modules["nio"] = nio_mock
|
|
try:
|
|
await adapter._sync_loop()
|
|
finally:
|
|
del sys.modules["nio"]
|
|
|
|
asyncio.run(run())
|
|
assert sync_count == 1
|
|
|
|
def test_exception_with_401_stops_loop(self):
|
|
"""An exception containing '401' should stop syncing."""
|
|
from gateway.platforms.matrix import MatrixAdapter
|
|
adapter = MatrixAdapter.__new__(MatrixAdapter)
|
|
adapter._closing = False
|
|
|
|
call_count = 0
|
|
|
|
async def fake_sync(timeout=30000, since=None):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
raise RuntimeError("HTTP 401 Unauthorized")
|
|
|
|
adapter._client = MagicMock()
|
|
adapter._client.sync = fake_sync
|
|
adapter._client.sync_store = MagicMock()
|
|
adapter._client.sync_store.get_next_batch = AsyncMock(return_value=None)
|
|
adapter._pending_megolm = []
|
|
adapter._joined_rooms = set()
|
|
|
|
async def run():
|
|
import types
|
|
nio_mock = types.ModuleType("nio")
|
|
nio_mock.SyncError = type("SyncError", (), {})
|
|
|
|
import sys
|
|
sys.modules["nio"] = nio_mock
|
|
try:
|
|
await adapter._sync_loop()
|
|
finally:
|
|
del sys.modules["nio"]
|
|
|
|
asyncio.run(run())
|
|
assert call_count == 1
|
|
|
|
def test_transient_error_retries(self):
|
|
"""A transient error should retry (not stop immediately)."""
|
|
from gateway.platforms.matrix import MatrixAdapter
|
|
adapter = MatrixAdapter.__new__(MatrixAdapter)
|
|
adapter._closing = False
|
|
|
|
call_count = 0
|
|
|
|
async def fake_sync(timeout=30000, since=None):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
if call_count >= 2:
|
|
adapter._closing = True
|
|
return MagicMock() # Normal response
|
|
raise ConnectionError("network timeout")
|
|
|
|
adapter._client = MagicMock()
|
|
adapter._client.sync = fake_sync
|
|
adapter._client.sync_store = MagicMock()
|
|
adapter._client.sync_store.get_next_batch = AsyncMock(return_value=None)
|
|
adapter._pending_megolm = []
|
|
adapter._joined_rooms = set()
|
|
|
|
async def run():
|
|
import types
|
|
nio_mock = types.ModuleType("nio")
|
|
nio_mock.SyncError = type("SyncError", (), {})
|
|
|
|
import sys
|
|
sys.modules["nio"] = nio_mock
|
|
try:
|
|
with patch("asyncio.sleep", new_callable=AsyncMock):
|
|
await adapter._sync_loop()
|
|
finally:
|
|
del sys.modules["nio"]
|
|
|
|
asyncio.run(run())
|
|
assert call_count >= 2
|