Cherry-picked from PR #3695 by binhnt92. Matrix _sync_loop() and Mattermost _ws_loop() were retrying all errors forever, including permanent auth failures (expired tokens, revoked access). Now detects M_UNKNOWN_TOKEN, M_FORBIDDEN, 401/403 and stops instead of spinning. Includes 216 lines of tests.
217 lines
6.5 KiB
Python
217 lines
6.5 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 gateway.platforms.mattermost 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 gateway.platforms.mattermost 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 gateway.platforms.mattermost 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):
|
|
nonlocal sync_count
|
|
sync_count += 1
|
|
return SyncError("M_UNKNOWN_TOKEN: Invalid access token")
|
|
|
|
adapter._client = MagicMock()
|
|
adapter._client.sync = fake_sync
|
|
|
|
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):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
raise RuntimeError("HTTP 401 Unauthorized")
|
|
|
|
adapter._client = MagicMock()
|
|
adapter._client.sync = fake_sync
|
|
|
|
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):
|
|
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
|
|
|
|
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
|