Refactor response handling in TributeService for improved clarity and consistency
- Introduced helper functions for generating standardized JSON responses, enhancing readability and maintainability. - Updated response handling for various error conditions to return structured JSON instead of plain text. - Acknowledged missing user ID with an "ignored" status to prevent unnecessary retries, improving webhook processing reliability.
This commit is contained in:
@@ -65,18 +65,30 @@ class TributeService:
|
|||||||
subscription_service = self.subscription_service
|
subscription_service = self.subscription_service
|
||||||
referral_service = self.referral_service
|
referral_service = self.referral_service
|
||||||
|
|
||||||
|
def ok(data: Optional[dict] = None) -> web.Response:
|
||||||
|
payload = {"status": "ok"}
|
||||||
|
if data:
|
||||||
|
payload.update(data)
|
||||||
|
return web.json_response(payload, status=200)
|
||||||
|
|
||||||
|
def ignored(reason: str) -> web.Response:
|
||||||
|
return web.json_response({"status": "ignored", "reason": reason}, status=200)
|
||||||
|
|
||||||
|
def bad_request(reason: str) -> web.Response:
|
||||||
|
return web.json_response({"status": "error", "reason": reason}, status=400)
|
||||||
|
|
||||||
if settings.TRIBUTE_API_KEY:
|
if settings.TRIBUTE_API_KEY:
|
||||||
if not signature_header:
|
if not signature_header:
|
||||||
return web.Response(status=403, text="no_signature")
|
return web.json_response({"status": "error", "reason": "no_signature"}, status=403)
|
||||||
expected_sig = hmac.new(settings.TRIBUTE_API_KEY.encode(), raw_body,
|
expected_sig = hmac.new(settings.TRIBUTE_API_KEY.encode(), raw_body,
|
||||||
hashlib.sha256).hexdigest()
|
hashlib.sha256).hexdigest()
|
||||||
if not hmac.compare_digest(expected_sig, signature_header):
|
if not hmac.compare_digest(expected_sig, signature_header):
|
||||||
return web.Response(status=403, text="invalid_signature")
|
return web.json_response({"status": "error", "reason": "invalid_signature"}, status=403)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
payload = json.loads(raw_body.decode())
|
payload = json.loads(raw_body.decode())
|
||||||
except Exception:
|
except Exception:
|
||||||
return web.Response(status=400, text="bad_request")
|
return bad_request("invalid_json")
|
||||||
|
|
||||||
logging.info(
|
logging.info(
|
||||||
"Tribute webhook data: %s",
|
"Tribute webhook data: %s",
|
||||||
@@ -91,7 +103,8 @@ class TributeService:
|
|||||||
# Mandatory routing fields
|
# Mandatory routing fields
|
||||||
user_id = data.get("telegram_user_id")
|
user_id = data.get("telegram_user_id")
|
||||||
if not user_id:
|
if not user_id:
|
||||||
return web.Response(status=400, text="missing_telegram_user_id")
|
# Permanent format issue — acknowledge to avoid retries
|
||||||
|
return ignored("missing_telegram_user_id")
|
||||||
|
|
||||||
period_val = data.get("period")
|
period_val = data.get("period")
|
||||||
months = convert_period_to_months(period_val)
|
months = convert_period_to_months(period_val)
|
||||||
@@ -221,7 +234,8 @@ class TributeService:
|
|||||||
|
|
||||||
else:
|
else:
|
||||||
await session.commit()
|
await session.commit()
|
||||||
return web.Response(status=200, text="ok")
|
# Acknowledge to Tribute that webhook was received and processed/accepted
|
||||||
|
return ok({"event": event_name or "unknown"})
|
||||||
|
|
||||||
async def _handle_tribute_cancellation(self, session, user_id: int, bot: Bot, i18n: JsonI18n):
|
async def _handle_tribute_cancellation(self, session, user_id: int, bot: Bot, i18n: JsonI18n):
|
||||||
"""Handle tribute subscription cancellation - set subscription to 1 day grace period"""
|
"""Handle tribute subscription cancellation - set subscription to 1 day grace period"""
|
||||||
|
|||||||
Reference in New Issue
Block a user