Skip to content

The agent that grows with you

fix(gateway): log a parked-profile refusal that was not delivered

unsupportedpastels8ce2a4f876e0
diff --git a/gateway/parked_route_refusal.py b/gateway/parked_route_refusal.py
index 988e37b9044..59d1cae9264 100644
--- a/gateway/parked_route_refusal.py
+++ b/gateway/parked_route_refusal.py
@@ -76,7 +76,7 @@ def drop_rejected_route(adapter, source):
return
logger.warning(
'[%s] Refusing inbound event for %s: routed profile %r on %s is parked (reason=profile_parked); '
- 'nothing was admitted, the sender was asked to resend', name, chat_id, profile, platform)
+ 'nothing was admitted, a resend notice to the sender is scheduled', name, chat_id, profile, platform)
try:
task = asyncio.get_running_loop().create_task(_send_refusal(adapter, source))
except RuntimeError:
@@ -92,8 +92,13 @@ async def _send_refusal(adapter, source):
"""Reply in the sender's chat and thread, as the runner's own notices do."""
try:
metadata = adapter.gateway_runner._thread_metadata_for_source(source)
- await adapter.send(source.chat_id, PARKED_ROUTE_NOTICE, reply_to=getattr(source, 'message_id', None),
- metadata=metadata)
+ result = await adapter.send(source.chat_id, PARKED_ROUTE_NOTICE, reply_to=getattr(source, 'message_id', None),
+ metadata=metadata)
+ if getattr(result, 'success', True) is False:
+ # Safe fields only: the raw ``error`` can echo tokens or message content.
+ logger.warning('[%s] The parked-profile refusal to %s was not delivered (error_kind=%s, retryable=%s)',
+ getattr(adapter, 'name', '?'), getattr(source, 'chat_id', '?'),
+ getattr(result, 'error_kind', None), getattr(result, 'retryable', None))
except Exception:
logger.warning('[%s] Could not send the parked-profile refusal to %s',
getattr(adapter, 'name', '?'), getattr(source, 'chat_id', '?'), exc_info=True)
diff --git a/tests/gateway/test_parked_route_refusal_send.py b/tests/gateway/test_parked_route_refusal_send.py
new file mode 100644
index 00000000000..4c0e7f6f695
--- /dev/null
+++ b/tests/gateway/test_parked_route_refusal_send.py
@@ -0,0 +1,62 @@
+"""A parked-profile refusal whose send fails is logged, with safe fields only.
+
+``adapter.send`` reports most failures as ``SendResult(success=False)``, not by raising, so the
+refusal must read the result: an unsent notice is a WARNING naming the failure kind, never the
+message text or the platform's raw error (which can echo tokens or content).
+"""
+import asyncio
+import logging
+from types import SimpleNamespace
+
+import pytest
+
+from gateway.config import Platform
+from gateway.parked_route_refusal import PARKED_ROUTE_NOTICE, drop_rejected_route
+from gateway.platforms.base import SendResult
+
+SECRET = 'xoxb-not-a-real-token'
+
+
+class _Bot:
+ name = 'Slack'
+
+ def __init__(self, result):
+ self._result, self.sent, self._background_tasks = result, [], set()
+ self.gateway_runner = SimpleNamespace(
+ session_runtime_descriptor={'parked_profiles': {'beta': 'test park'}},
+ _thread_metadata_for_source=lambda source: None)
+
+ async def send(self, chat_id, text, reply_to=None, metadata=None):
+ self.sent.append((chat_id, text, reply_to))
+ return self._result
+
+
+async def _refuse(bot):
+ source = SimpleNamespace(platform=Platform.SLACK, chat_id='C', message_id='m1',
+ _rejected_route_profile='beta')
+ drop_rejected_route(bot, source)
+ await asyncio.gather(*list(bot._background_tasks))
+
+
+async def test_an_unsuccessful_refusal_send_is_logged_without_text_or_raw_error(caplog):
+ bot = _Bot(SendResult(success=False, error=f'invalid_auth for {SECRET}', error_kind='forbidden'))
+ with caplog.at_level(logging.WARNING, logger='gateway.parked_route_refusal'):
+ await _refuse(bot)
+ assert len(bot.sent) == 1
+ failures = [r.getMessage() for r in caplog.records if 'not delivered' in r.getMessage()]
+ assert failures, f'a failed refusal send was not logged: {[r.getMessage() for r in caplog.records]}'
+ assert 'error_kind=forbidden' in failures[0] and ' to C ' in failures[0], failures[0]
+ assert all(r.levelno == logging.WARNING for r in caplog.records if 'not delivered' in r.getMessage())
+ logged = caplog.text
+ assert SECRET not in logged and PARKED_ROUTE_NOTICE not in logged
+ assert 'was asked to resend' not in logged, 'the refusal is logged as delivered before it was sent'
+
+
+async def test_a_successful_refusal_send_logs_no_failure(caplog):
+ bot = _Bot(SendResult(success=True, message_id='n1'))
+ with caplog.at_level(logging.WARNING, logger='gateway.parked_route_refusal'):
+ await _refuse(bot)
+ assert len(bot.sent) == 1
+ assert not [r for r in caplog.records if 'not delivered' in r.getMessage()]