mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-07-04 10:52:17 +02:00
feat(webhooks): durable retrying delivery for final webhooks (#478)
* feat(webhooks): durable retrying delivery for final webhooks
Final webhook nodes were fired inline with a single best-effort httpx POST
(run_integrations._execute_webhook_node). On a transient error the failure was
swallowed at three levels, so ARQ never retried and the final call report was
permanently lost -- leaving downstream receivers stuck (e.g. a CRM showing a
call as still "in conversation").
Replace the one-shot POST with a durable, idempotent delivery pipeline modelled
on the campaign retry pattern (persisted row + scheduled_for + bounded attempts):
- New webhook_deliveries table (WebhookDeliveryModel) is the source of truth.
Payload is rendered once and frozen so retries are deterministic; secrets are
not stored -- the credential is referenced by uuid and re-resolved at send time.
- run_integrations now persists a delivery row and enqueues deliver_webhook with
a deterministic ARQ job id instead of sending inline.
- deliver_webhook (new ARQ task) sends the request and:
* 2xx -> succeeded
* transient -> retry with capped exponential backoff (RequestError /
5xx / 408 / 425 / 429), up to max_attempts then dead_letter
* permanent 4xx -> dead_letter immediately (no pointless looping)
It is idempotent: a non-pending delivery is a no-op, so a duplicate enqueue or
sweeper re-injection can't double-send.
- sweep_webhook_deliveries cron (every 5 min) re-enqueues overdue pending
deliveries so nothing is lost to a worker restart / Redis flush.
- Stable X-Dograh-Delivery-Id / Workflow-Run-Id / Attempt headers let receivers
dedupe retried deliveries.
- enqueue_job now forwards ARQ job options (_job_id, _defer_by); failures log
repr(e) so empty-message errors like ConnectTimeout are diagnosable.
Config via DEFAULT_WEBHOOK_DELIVERY_CONFIG (env-overridable): max_attempts=5,
base_delay=30s, max_delay=600s, timeout=30s.
Tests cover payload rendering, persist+enqueue, success, transient retry,
retryable 5xx, permanent 4xx dead-letter, attempt exhaustion, and idempotency.
Migration verified to apply/rollback against Postgres; table/enum/indexes confirmed.
* fix(webhooks): atomic claim, safe success-recording, sweep paging, migration cleanup
Address review feedback on the webhook delivery pipeline:
- deliver_webhook now atomically claims a delivery (conditional UPDATE that
leases scheduled_for) before sending, so concurrent ARQ executions can't
double-send (the prior status=='pending' read was non-atomic).
- Recording success is moved out of the dead-letter try-block: if the receiver
accepted the payload (2xx) but the success DB-write fails, the row is left
pending for the sweeper to reconcile instead of being dead-lettered.
- The sweep keyset-paginates by id so a backlog over the page size is fully
drained, and logs the true re-enqueued total.
- Migration downgrade drops the enum via op.execute(DROP TYPE IF EXISTS ...)
instead of the deprecated op.get_bind().
* fix(webhooks): idempotent delivery creation and drop secret custom headers
Address the remaining review feedback:
- Add a (workflow_run_id, webhook_node_id) unique constraint and make
create_webhook_delivery a get-or-create returning (delivery, created). A
retried run_integrations now reuses the existing row instead of creating and
sending a duplicate final webhook; only a freshly-created row is enqueued.
- Stop persisting secret-looking custom headers (Authorization, X-API-Key,
Cookie, ...) in plaintext on the delivery row: they are dropped with a warning
pointing at the credential store (which is re-resolved securely at send time).
Non-secret custom headers are unaffected.
* fix(webhooks): harden idempotency key, secret-header match, sweep reclaim id
Address follow-up review feedback:
- webhook_node_id is now NOT NULL so a NULL can't slip past the
(workflow_run_id, webhook_node_id) unique constraint and create duplicates.
- Secret-header filtering matches normalized markers (auth/token/secret/cookie/
api-key/...) instead of an exact name list, catching variants like
X-Custom-Auth-Token while leaving benign headers (e.g. X-Idempotency-Key).
- The sweeper re-enqueues with a reclaim-specific job id (the lease timestamp)
so reconciling a delivered-but-unrecorded row isn't deduped against the
original attempt's already-completed ARQ job. The atomic claim still ensures
at most one send.
* fix(webhooks): scope delivery rows to workflow org
---------
Co-authored-by: Abhishek Kumar <abhishek@a6k.me>
This commit is contained in:
parent
3a770a6538
commit
fd0d144b08
12 changed files with 1360 additions and 141 deletions
|
|
@ -12,7 +12,7 @@ from api.tasks.function_names import FunctionNames
|
|||
setup_logging()
|
||||
|
||||
# Now import ARQ and task dependencies
|
||||
from arq import create_pool
|
||||
from arq import create_pool, cron
|
||||
from arq.connections import ArqRedis, RedisSettings
|
||||
|
||||
parsed_url = urlparse(REDIS_URL)
|
||||
|
|
@ -46,6 +46,7 @@ from api.tasks.campaign_tasks import (
|
|||
from api.tasks.knowledge_base_processing import process_knowledge_base_document
|
||||
from api.tasks.run_integrations import run_integrations_post_workflow_run
|
||||
from api.tasks.s3_upload import upload_voicemail_audio_to_s3
|
||||
from api.tasks.webhook_delivery import deliver_webhook, sweep_webhook_deliveries
|
||||
from api.tasks.workflow_completion import process_workflow_completion
|
||||
|
||||
|
||||
|
|
@ -57,8 +58,18 @@ class WorkerSettings:
|
|||
sync_campaign_source,
|
||||
process_campaign_batch,
|
||||
process_knowledge_base_document,
|
||||
deliver_webhook,
|
||||
]
|
||||
cron_jobs = [
|
||||
# Safety net for webhook deliveries whose ARQ job was lost (worker
|
||||
# restart / Redis flush): re-enqueue any pending delivery that is overdue.
|
||||
cron(
|
||||
sweep_webhook_deliveries,
|
||||
minute=set(range(0, 60, 5)),
|
||||
second=0,
|
||||
run_at_startup=True,
|
||||
),
|
||||
]
|
||||
cron_jobs = []
|
||||
redis_settings = REDIS_SETTINGS
|
||||
max_jobs = 10
|
||||
|
||||
|
|
@ -107,6 +118,8 @@ async def get_arq_redis() -> ArqRedis:
|
|||
return _redis_pool
|
||||
|
||||
|
||||
async def enqueue_job(function_name: FunctionNames, *args):
|
||||
async def enqueue_job(function_name: FunctionNames, *args, **kwargs):
|
||||
redis = await get_arq_redis()
|
||||
await redis.enqueue_job(function_name, *args)
|
||||
# kwargs forwards ARQ job options (e.g. _job_id, _defer_by) used for
|
||||
# deterministic, backed-off webhook delivery retries.
|
||||
return await redis.enqueue_job(function_name, *args, **kwargs)
|
||||
|
|
|
|||
|
|
@ -5,3 +5,4 @@ class FunctionNames:
|
|||
SYNC_CAMPAIGN_SOURCE = "sync_campaign_source"
|
||||
PROCESS_CAMPAIGN_BATCH = "process_campaign_batch"
|
||||
PROCESS_KNOWLEDGE_BASE_DOCUMENT = "process_knowledge_base_document"
|
||||
DELIVER_WEBHOOK = "deliver_webhook"
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
"""Execute integrations (QA analysis, webhooks) after workflow run completion."""
|
||||
|
||||
import random
|
||||
from datetime import UTC, datetime
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
import httpx
|
||||
from loguru import logger
|
||||
from pipecat.utils.enums import EndTaskReason
|
||||
from pipecat.utils.run_context import set_current_org_id, set_current_run_id
|
||||
from pydantic import ValidationError
|
||||
|
||||
from api.constants import BACKEND_API_ENDPOINT
|
||||
from api.constants import BACKEND_API_ENDPOINT, DEFAULT_WEBHOOK_DELIVERY_CONFIG
|
||||
from api.db import db_client
|
||||
from api.db.models import WorkflowRunModel
|
||||
from api.enums import OrganizationConfigurationKey
|
||||
|
|
@ -26,7 +26,7 @@ from api.services.workflow.dto import (
|
|||
WebhookRFNode,
|
||||
)
|
||||
from api.services.workflow.qa import run_per_node_qa_analysis
|
||||
from api.utils.credential_auth import build_auth_header
|
||||
from api.tasks.function_names import FunctionNames
|
||||
from api.utils.recording_artifacts import get_recording_storage_key
|
||||
from api.utils.template_renderer import render_template
|
||||
|
||||
|
|
@ -315,13 +315,15 @@ async def run_integrations_post_workflow_run(_ctx, workflow_run_id: int):
|
|||
|
||||
webhook_data = webhook_node.data
|
||||
try:
|
||||
await _execute_webhook_node(
|
||||
await _enqueue_webhook_delivery(
|
||||
webhook_data=webhook_data,
|
||||
render_context=render_context,
|
||||
organization_id=organization_id,
|
||||
workflow_run_id=workflow_run_id,
|
||||
webhook_node_id=str(node_id),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"Failed to execute webhook '{webhook_data.name}': {e}")
|
||||
logger.warning(f"Failed to enqueue webhook '{webhook_data.name}': {e}")
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Error running integrations: {e}", exc_info=True)
|
||||
|
|
@ -387,98 +389,140 @@ def _build_render_context(
|
|||
return context
|
||||
|
||||
|
||||
async def _execute_webhook_node(
|
||||
webhook_data: WebhookNodeData,
|
||||
render_context: Dict[str, Any],
|
||||
organization_id: int,
|
||||
) -> bool:
|
||||
def _build_webhook_payload(
|
||||
webhook_data: WebhookNodeData, render_context: Dict[str, Any]
|
||||
) -> Any:
|
||||
"""Render the webhook payload once, so retries are deterministic.
|
||||
|
||||
Always surfaces the call disposition on the outgoing payload, even when the
|
||||
template author didn't reference it. Fill only if absent so a template that
|
||||
sets it explicitly keeps its own value.
|
||||
"""
|
||||
Execute a single webhook node.
|
||||
|
||||
Args:
|
||||
webhook_data: The validated webhook node data
|
||||
render_context: Context for template rendering
|
||||
organization_id: For credential lookup
|
||||
|
||||
Returns:
|
||||
True if successful, False otherwise
|
||||
"""
|
||||
webhook_name = webhook_data.name
|
||||
|
||||
if not webhook_data.enabled:
|
||||
logger.debug(f"Webhook '{webhook_name}' is disabled, skipping")
|
||||
return True
|
||||
|
||||
url = webhook_data.endpoint_url
|
||||
if not url:
|
||||
logger.warning(f"Webhook '{webhook_name}' has no endpoint URL")
|
||||
return False
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
|
||||
credential_uuid = webhook_data.credential_uuid
|
||||
if credential_uuid:
|
||||
credential = await db_client.get_credential_by_uuid(
|
||||
credential_uuid, organization_id
|
||||
)
|
||||
if credential:
|
||||
auth_header = build_auth_header(credential)
|
||||
headers.update(auth_header)
|
||||
logger.debug(f"Applied credential '{credential.name}' to webhook")
|
||||
else:
|
||||
logger.warning(
|
||||
f"Credential {credential_uuid} not found for webhook '{webhook_name}'"
|
||||
)
|
||||
|
||||
for h in webhook_data.custom_headers or []:
|
||||
if h.key and h.value:
|
||||
headers[h.key] = h.value
|
||||
|
||||
payload = render_template(webhook_data.payload_template or {}, render_context)
|
||||
|
||||
# Always surface the call disposition on the outgoing payload, even when the
|
||||
# template author didn't reference it. Fill only if absent so a template that
|
||||
# sets it explicitly keeps its own value.
|
||||
if isinstance(payload, dict):
|
||||
gathered_context = render_context.get("gathered_context") or {}
|
||||
payload.setdefault(
|
||||
"call_disposition", gathered_context.get("call_disposition", "")
|
||||
)
|
||||
|
||||
return payload
|
||||
|
||||
|
||||
# Substrings that mark a header as likely carrying a secret. Matched against the
|
||||
# normalized key so variants are caught too (e.g. ``X-Custom-Auth-Token``,
|
||||
# ``My-Api-Key``), not just exact names. Their values are NOT persisted on the
|
||||
# delivery row (which would store them in plaintext); secrets belong in the
|
||||
# credential store, re-resolved at send time. Bare "key" is intentionally absent
|
||||
# to avoid dropping benign headers like ``X-Idempotency-Key``.
|
||||
_SECRET_HEADER_MARKERS = (
|
||||
"authorization",
|
||||
"auth",
|
||||
"token",
|
||||
"secret",
|
||||
"password",
|
||||
"passwd",
|
||||
"cookie",
|
||||
"credential",
|
||||
"api-key",
|
||||
"apikey",
|
||||
"api_key",
|
||||
"access-key",
|
||||
)
|
||||
|
||||
|
||||
def _looks_like_secret_header(key: str) -> bool:
|
||||
normalized = key.strip().lower()
|
||||
return any(marker in normalized for marker in _SECRET_HEADER_MARKERS)
|
||||
|
||||
|
||||
def _safe_custom_headers(
|
||||
webhook_data: WebhookNodeData, webhook_name: str
|
||||
) -> list[dict]:
|
||||
"""Custom headers to persist, with secret-looking ones dropped.
|
||||
|
||||
Persisting arbitrary header values would store credentials (Authorization,
|
||||
X-API-Key, ...) in plaintext on the delivery row. Drop those and tell the
|
||||
operator to use a credential instead.
|
||||
"""
|
||||
safe = []
|
||||
for h in webhook_data.custom_headers or []:
|
||||
if not (h.key and h.value):
|
||||
continue
|
||||
if _looks_like_secret_header(h.key):
|
||||
logger.warning(
|
||||
f"Webhook '{webhook_name}' custom header '{h.key}' looks like a "
|
||||
f"secret; it will not be stored or sent. Use a credential instead."
|
||||
)
|
||||
continue
|
||||
safe.append({"key": h.key, "value": h.value})
|
||||
return safe
|
||||
|
||||
|
||||
async def _enqueue_webhook_delivery(
|
||||
webhook_data: WebhookNodeData,
|
||||
render_context: Dict[str, Any],
|
||||
organization_id: int,
|
||||
workflow_run_id: int,
|
||||
webhook_node_id: str,
|
||||
) -> None:
|
||||
"""Persist a durable delivery record and enqueue its first send attempt.
|
||||
|
||||
The actual HTTP request is performed by the ``deliver_webhook`` task, which
|
||||
retries transient failures with backoff and dead-letters exhausted/permanent
|
||||
ones. This replaces the previous one-shot, best-effort inline POST that lost
|
||||
the webhook entirely on a single network error.
|
||||
|
||||
Idempotent on ``(workflow_run_id, webhook_node_id)``: a retried run reuses the
|
||||
existing delivery row and does not enqueue a second send.
|
||||
"""
|
||||
webhook_name = webhook_data.name
|
||||
|
||||
if not webhook_data.enabled:
|
||||
logger.debug(f"Webhook '{webhook_name}' is disabled, skipping")
|
||||
return
|
||||
|
||||
url = webhook_data.endpoint_url
|
||||
if not url:
|
||||
logger.warning(f"Webhook '{webhook_name}' has no endpoint URL")
|
||||
return
|
||||
|
||||
payload = _build_webhook_payload(webhook_data, render_context)
|
||||
|
||||
# Persist non-secret request definition. The credential is stored by reference
|
||||
# (uuid) and re-resolved at send time so secrets never land in this row.
|
||||
custom_headers = _safe_custom_headers(webhook_data, webhook_name)
|
||||
method = (webhook_data.http_method or "POST").upper()
|
||||
|
||||
logger.info(f"Executing webhook '{webhook_name}': {method}")
|
||||
delivery, created = await db_client.create_webhook_delivery(
|
||||
workflow_run_id=workflow_run_id,
|
||||
organization_id=organization_id,
|
||||
endpoint_url=url,
|
||||
payload=payload,
|
||||
max_attempts=DEFAULT_WEBHOOK_DELIVERY_CONFIG["max_attempts"],
|
||||
http_method=method,
|
||||
webhook_name=webhook_name,
|
||||
custom_headers=custom_headers or None,
|
||||
credential_uuid=webhook_data.credential_uuid,
|
||||
webhook_node_id=webhook_node_id,
|
||||
)
|
||||
|
||||
try:
|
||||
async with httpx.AsyncClient() as client:
|
||||
if method in ("POST", "PUT", "PATCH"):
|
||||
response = await client.request(
|
||||
method=method,
|
||||
url=url,
|
||||
json=payload,
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
else: # GET, DELETE
|
||||
response = await client.request(
|
||||
method=method,
|
||||
url=url,
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
response.raise_for_status()
|
||||
logger.info(f"Webhook '{webhook_name}' succeeded: {response.status_code}")
|
||||
return True
|
||||
|
||||
except httpx.HTTPStatusError as e:
|
||||
logger.warning(
|
||||
f"Webhook '{webhook_name}' failed: {e.response.status_code} - {e.response.text[:200]}"
|
||||
if not created:
|
||||
logger.info(
|
||||
f"Webhook '{webhook_name}' delivery already exists for run "
|
||||
f"{workflow_run_id} node {webhook_node_id}; not re-enqueuing"
|
||||
)
|
||||
return False
|
||||
except httpx.RequestError as e:
|
||||
logger.warning(f"Webhook '{webhook_name}' request error: {e}")
|
||||
return False
|
||||
except Exception as e:
|
||||
logger.error(f"Webhook '{webhook_name}' unexpected error: {e}")
|
||||
return False
|
||||
return
|
||||
|
||||
# Lazy import avoids a circular import (arq imports this module at load time).
|
||||
from api.tasks.arq import enqueue_job
|
||||
|
||||
await enqueue_job(
|
||||
FunctionNames.DELIVER_WEBHOOK,
|
||||
delivery.id,
|
||||
_job_id=f"webhook-delivery-{delivery.id}-0",
|
||||
)
|
||||
logger.info(
|
||||
f"Enqueued webhook '{webhook_name}' delivery {delivery.delivery_uuid} "
|
||||
f"for run {workflow_run_id}"
|
||||
)
|
||||
|
|
|
|||
266
api/tasks/webhook_delivery.py
Normal file
266
api/tasks/webhook_delivery.py
Normal file
|
|
@ -0,0 +1,266 @@
|
|||
"""Durable, retrying delivery of outbound webhooks.
|
||||
|
||||
A workflow's final webhook must survive a transient network error. Rather than
|
||||
firing the HTTP POST inline and forgetting it, ``run_integrations`` persists a
|
||||
``WebhookDeliveryModel`` row and enqueues :func:`deliver_webhook`. This task sends
|
||||
the request and, on a *transient* failure, schedules the next attempt with
|
||||
exponential backoff -- up to ``max_attempts``, after which the delivery is parked
|
||||
as ``dead_letter`` for inspection. Permanent failures (most 4xx) dead-letter
|
||||
immediately instead of looping.
|
||||
|
||||
A periodic :func:`sweep_webhook_deliveries` cron re-enqueues any ``pending``
|
||||
delivery whose attempt is overdue, so deliveries survive worker restarts / lost
|
||||
ARQ jobs. The DB row is the source of truth; this task is idempotent and only
|
||||
acts on a delivery that is still ``pending``.
|
||||
"""
|
||||
|
||||
from datetime import UTC, datetime, timedelta
|
||||
from typing import Optional
|
||||
|
||||
import httpx
|
||||
from loguru import logger
|
||||
from pipecat.utils.run_context import set_current_run_id
|
||||
|
||||
from api.constants import DEFAULT_WEBHOOK_DELIVERY_CONFIG
|
||||
from api.db import db_client
|
||||
from api.db.models import WebhookDeliveryModel
|
||||
from api.tasks.function_names import FunctionNames
|
||||
from api.utils.credential_auth import build_auth_header
|
||||
|
||||
# HTTP statuses that are worth retrying even though the server answered.
|
||||
_RETRYABLE_STATUS_CODES = {408, 425, 429, 500, 502, 503, 504}
|
||||
|
||||
|
||||
def _delivery_job_id(delivery_id: int, attempt_count: int) -> str:
|
||||
"""Deterministic ARQ job id so duplicate enqueues (task re-enqueue + sweeper)
|
||||
collapse to one job instead of double-sending."""
|
||||
return f"webhook-delivery-{delivery_id}-{attempt_count}"
|
||||
|
||||
|
||||
def _backoff_seconds(attempt: int) -> int:
|
||||
"""Exponential backoff (capped) for the next attempt after `attempt` failures."""
|
||||
base = DEFAULT_WEBHOOK_DELIVERY_CONFIG["base_delay_seconds"]
|
||||
cap = DEFAULT_WEBHOOK_DELIVERY_CONFIG["max_delay_seconds"]
|
||||
return min(base * (2 ** (attempt - 1)), cap)
|
||||
|
||||
|
||||
async def _enqueue_delivery(
|
||||
delivery_id: int,
|
||||
attempt_count: int,
|
||||
defer_by: int = 0,
|
||||
reclaim_token: Optional[int] = None,
|
||||
):
|
||||
"""Enqueue a delivery attempt with a dedup-safe job id.
|
||||
|
||||
The normal (task self-retry) path uses a deterministic id so a retry and a
|
||||
sweeper pass for the *same* attempt collapse to one job. The sweeper passes a
|
||||
``reclaim_token`` (the lease timestamp) to get a distinct id, so reconciling a
|
||||
delivered-but-unrecorded row is not deduped against the original attempt's
|
||||
already-completed job. The atomic claim still guarantees at most one send.
|
||||
"""
|
||||
from api.tasks.arq import enqueue_job # lazy import avoids circular import
|
||||
|
||||
if reclaim_token is not None:
|
||||
job_id = f"webhook-delivery-reclaim-{delivery_id}-{reclaim_token}"
|
||||
else:
|
||||
job_id = _delivery_job_id(delivery_id, attempt_count)
|
||||
|
||||
await enqueue_job(
|
||||
FunctionNames.DELIVER_WEBHOOK,
|
||||
delivery_id,
|
||||
_job_id=job_id,
|
||||
_defer_by=defer_by,
|
||||
)
|
||||
|
||||
|
||||
async def _build_headers(delivery: WebhookDeliveryModel, attempt: int) -> dict:
|
||||
"""Assemble request headers, re-resolving credential auth at send time so
|
||||
secrets are never persisted on the delivery row and rotation is honoured."""
|
||||
headers = {"Content-Type": "application/json"}
|
||||
|
||||
if delivery.credential_uuid:
|
||||
credential = await db_client.get_credential_by_uuid(
|
||||
delivery.credential_uuid, delivery.organization_id
|
||||
)
|
||||
if credential:
|
||||
headers.update(build_auth_header(credential))
|
||||
else:
|
||||
logger.warning(
|
||||
f"Credential {delivery.credential_uuid} not found for webhook "
|
||||
f"'{delivery.webhook_name}' (delivery {delivery.id})"
|
||||
)
|
||||
|
||||
for h in delivery.custom_headers or []:
|
||||
key, value = h.get("key"), h.get("value")
|
||||
if key and value:
|
||||
headers[key] = value
|
||||
|
||||
# Stable idempotency signal so the receiver can dedupe retried deliveries.
|
||||
headers["X-Dograh-Delivery-Id"] = delivery.delivery_uuid
|
||||
headers["X-Dograh-Workflow-Run-Id"] = str(delivery.workflow_run_id)
|
||||
headers["X-Dograh-Delivery-Attempt"] = str(attempt)
|
||||
return headers
|
||||
|
||||
|
||||
async def _handle_transient_failure(
|
||||
delivery: WebhookDeliveryModel,
|
||||
attempt: int,
|
||||
error: str,
|
||||
status_code: Optional[int],
|
||||
) -> None:
|
||||
"""Schedule a backed-off retry, or dead-letter once attempts are exhausted."""
|
||||
if attempt >= delivery.max_attempts:
|
||||
await db_client.mark_webhook_delivery_dead_letter(
|
||||
delivery.id, attempt, error, status_code
|
||||
)
|
||||
return
|
||||
|
||||
delay = _backoff_seconds(attempt)
|
||||
scheduled_for = datetime.now(UTC) + timedelta(seconds=delay)
|
||||
await db_client.schedule_webhook_delivery_retry(
|
||||
delivery_id=delivery.id,
|
||||
attempt_count=attempt,
|
||||
scheduled_for=scheduled_for,
|
||||
last_error=error,
|
||||
last_status_code=status_code,
|
||||
)
|
||||
await _enqueue_delivery(delivery.id, attempt_count=attempt, defer_by=delay)
|
||||
logger.warning(
|
||||
f"Webhook '{delivery.webhook_name}' delivery {delivery.id} attempt {attempt} "
|
||||
f"failed ({error}); retrying in {delay}s "
|
||||
f"(attempt {attempt + 1}/{delivery.max_attempts})"
|
||||
)
|
||||
|
||||
|
||||
async def deliver_webhook(_ctx, delivery_id: int) -> None:
|
||||
"""Send one webhook delivery attempt and record the outcome.
|
||||
|
||||
Concurrency-safe: the delivery is atomically *claimed* before the HTTP
|
||||
request (a conditional update only one worker can win), so a duplicate
|
||||
enqueue or sweeper re-injection cannot double-send. A claim that returns
|
||||
nothing means another worker owns it, or it is no longer pending/due -- a
|
||||
no-op.
|
||||
"""
|
||||
# Lease long enough to outlast a full attempt so the sweeper does not reclaim
|
||||
# a delivery that is still in flight.
|
||||
lease_seconds = DEFAULT_WEBHOOK_DELIVERY_CONFIG["timeout_seconds"] + 60
|
||||
delivery = await db_client.claim_webhook_delivery(delivery_id, lease_seconds)
|
||||
if delivery is None:
|
||||
logger.debug(
|
||||
f"Webhook delivery {delivery_id} not claimable "
|
||||
f"(already claimed, not pending, or not yet due); skipping"
|
||||
)
|
||||
return
|
||||
|
||||
set_current_run_id(str(delivery.workflow_run_id))
|
||||
attempt = delivery.attempt_count + 1
|
||||
method = (delivery.http_method or "POST").upper()
|
||||
timeout = DEFAULT_WEBHOOK_DELIVERY_CONFIG["timeout_seconds"]
|
||||
|
||||
try:
|
||||
headers = await _build_headers(delivery, attempt)
|
||||
|
||||
async with httpx.AsyncClient() as client:
|
||||
if method in ("POST", "PUT", "PATCH"):
|
||||
response = await client.request(
|
||||
method=method,
|
||||
url=delivery.endpoint_url,
|
||||
json=delivery.payload,
|
||||
headers=headers,
|
||||
timeout=timeout,
|
||||
)
|
||||
else: # GET, DELETE
|
||||
response = await client.request(
|
||||
method=method,
|
||||
url=delivery.endpoint_url,
|
||||
headers=headers,
|
||||
timeout=timeout,
|
||||
)
|
||||
|
||||
response.raise_for_status()
|
||||
except httpx.HTTPStatusError as e:
|
||||
status_code = e.response.status_code
|
||||
error = f"HTTP {status_code}: {e.response.text[:200]}"
|
||||
if status_code in _RETRYABLE_STATUS_CODES:
|
||||
await _handle_transient_failure(delivery, attempt, error, status_code)
|
||||
else:
|
||||
# Permanent (auth/validation/not-found): retrying won't help. Park it.
|
||||
await db_client.mark_webhook_delivery_dead_letter(
|
||||
delivery.id, attempt, error, status_code
|
||||
)
|
||||
return
|
||||
except httpx.RequestError as e:
|
||||
# Connect/read timeouts, DNS, connection resets -- the transient class that
|
||||
# previously lost the webhook entirely. str(e) is often empty, so use repr.
|
||||
await _handle_transient_failure(delivery, attempt, repr(e), None)
|
||||
return
|
||||
except Exception as e:
|
||||
# Unexpected (e.g. a bug): don't loop on it, surface as dead-letter.
|
||||
logger.error(
|
||||
f"Webhook '{delivery.webhook_name}' delivery {delivery.id} "
|
||||
f"unexpected error: {e!r}"
|
||||
)
|
||||
await db_client.mark_webhook_delivery_dead_letter(
|
||||
delivery.id, attempt, repr(e), None
|
||||
)
|
||||
return
|
||||
|
||||
# The receiver accepted the payload (2xx). Recording success must NOT be able
|
||||
# to dead-letter an already-delivered webhook: if this DB write fails, log and
|
||||
# leave the row claimed-but-pending so the sweeper reconciles it once the
|
||||
# lease expires (the receiver dedups the re-send via X-Dograh-Delivery-Id).
|
||||
try:
|
||||
await db_client.mark_webhook_delivery_succeeded(
|
||||
delivery.id, attempt, response.status_code
|
||||
)
|
||||
logger.info(
|
||||
f"Webhook '{delivery.webhook_name}' delivery {delivery.id} succeeded: "
|
||||
f"{response.status_code} (attempt {attempt})"
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"Webhook '{delivery.webhook_name}' delivery {delivery.id} was "
|
||||
f"delivered ({response.status_code}) but recording success failed; "
|
||||
f"leaving it for the sweeper to reconcile after the lease expires: {e!r}"
|
||||
)
|
||||
|
||||
|
||||
async def sweep_webhook_deliveries(_ctx) -> None:
|
||||
"""Safety net: re-enqueue pending deliveries whose attempt is overdue.
|
||||
|
||||
Handles ARQ jobs lost to a worker restart or Redis flush. Re-enqueuing uses the
|
||||
same deterministic job id, so if the original deferred job still exists this is a
|
||||
no-op; it only re-injects genuinely lost work. ``deliver_webhook`` is idempotent.
|
||||
"""
|
||||
page_size = 100
|
||||
after_id = 0
|
||||
total = 0
|
||||
while True:
|
||||
# Re-enqueuing does not change a row's due state, so we cannot page by
|
||||
# re-querying the first rows (we'd loop on the same page). Page by id
|
||||
# instead to drain the whole backlog -- e.g. after a prolonged outage.
|
||||
due = await db_client.get_due_webhook_deliveries(
|
||||
now=datetime.now(UTC), limit=page_size, after_id=after_id
|
||||
)
|
||||
if not due:
|
||||
break
|
||||
for delivery in due:
|
||||
# A reclaim token (the current lease timestamp) gives this a fresh job
|
||||
# id so it is not deduped against the original attempt's completed job
|
||||
# -- otherwise a delivered-but-unrecorded row could sit until ARQ's
|
||||
# result retention clears.
|
||||
reclaim_token = (
|
||||
int(delivery.scheduled_for.timestamp()) if delivery.scheduled_for else 0
|
||||
)
|
||||
await _enqueue_delivery(
|
||||
delivery.id,
|
||||
attempt_count=delivery.attempt_count,
|
||||
reclaim_token=reclaim_token,
|
||||
)
|
||||
total += len(due)
|
||||
after_id = due[-1].id
|
||||
if len(due) < page_size:
|
||||
break
|
||||
|
||||
if total:
|
||||
logger.info(f"Webhook delivery sweep: re-enqueued {total} due deliveries")
|
||||
Loading…
Add table
Add a link
Reference in a new issue