返回提示词目录第 1355 页

实现安全可靠的事件回调接口

沿用现有项目实现签名验证与异步事件处理,加入幂等、乱序防护和失败重试并报告测试结果。

完整提示词

<context>
Webhook endpoints are public URLs that move money, permissions or data, so they fail in costly ways: a framework parses the JSON before the signature is checked and the raw bytes are gone, so verification never works and someone disables it; a forged or replayed request is accepted; the provider retries after a slow response and the order ships twice; events arrive out of order and an old "subscription.updated" overwrites a newer one; one failing event blocks the endpoint and the provider disables it. A good handler verifies first, acknowledges fast, processes exactly once per event id, and treats the payload as a hint to fetch current state when order matters.
</context>

<task>
Implement a webhook receiver for {{provider}}.
{{#stack}}
Stack: {{stack}}
{{/stack}}
If no stack is given, detect the language, framework and job queue from the repo and follow their conventions.

Events to handle:
<events>
{{events}}
</events>

{{#signature_scheme}}
Signature scheme from the provider's docs:
<signature_scheme>
{{signature_scheme}}
</signature_scheme>
{{/signature_scheme}}

1. Establish the signature scheme: header names, algorithm, exactly which bytes are signed (often a timestamp plus the raw body), encoding, the event id field and any timestamp tolerance. Use the scheme given above; if none was given and you know the provider's documented scheme (for example Stripe's `Stripe-Signature` header with a timestamp and HMAC-SHA256, or GitHub's `X-Hub-Signature-256` HMAC-SHA256 of the raw body with the `X-GitHub-Delivery` id), state it and tell the user to confirm it against the current docs. If the provider's official SDK is already a dependency and has a verification helper, use it. If you do not know the scheme, stop and ask for it.
2. Read the existing routing, auth middleware, body parsing, job queue, database access and error handling in the repo, and reuse them.
3. Build the endpoint:
   - Read the raw request body before any JSON parsing, and verify the signature over those exact bytes with a constant-time comparison. Reject with 400 or 401 and no detail on failure.
   - Enforce the timestamp tolerance where the scheme signs a timestamp, to block replays.
   - Support more than one active secret so the secret can be rotated without downtime.
   - Enforce a body size limit and accept only the expected content type.
   - Exempt the route from CSRF protection and session auth, and from any middleware that consumes the body.
4. Make processing idempotent and fast:
   - Record the event id in a table with a unique constraint; if it already exists, acknowledge with 2xx and do nothing.
   - Persist the event and enqueue the work, then return 2xx quickly (well within the provider's timeout); do the real work in a background job. Storing and enqueueing are two writes: enqueue through an outbox or the same transaction where the queue allows it, or add a sweeper that picks up stored events still unprocessed after a few minutes, so a failed enqueue never loses an acknowledged event.
   - In the job, handle each listed event type in its own function; ignore and log unknown types with 2xx so new provider events do not cause retries.
   - Guard against out-of-order delivery: compare the event's created time or object version with what is stored, or fetch the current object from the provider's API before acting when order matters.
   - Make the side effects themselves idempotent (upserts, state checks, idempotency keys on outbound calls).
5. Handle failures: return 5xx only when the event could not be stored (so the provider retries); retry the background job with backoff; send events that keep failing to a dead-letter state with the error, and provide a way to replay a stored event.
6. Write tests: valid signature accepted, tampered body rejected, wrong secret rejected, stale timestamp rejected, the same event delivered twice processed once, out-of-order events handled, unknown event type acknowledged, and the background job's happy path and failure for each handled event. Build test signatures with a test secret, never a real one.
7. Run the tests and the linter, and report the real results.
</task>

<constraints>
- Never log the raw signature, the secret or full payloads that contain personal or payment data; log the event id and type.
- Do not trust any field in the payload for authorization beyond what the verified signature covers.
- Do not invent provider headers, event names or fields. Use only what the docs or the user gave, or say what you assumed and that it needs checking.
{{> guardrails/scope-discipline}}
{{> guardrails/verify-before-done}}
</constraints>

<output_format>
## Signature scheme
What is signed, the headers, algorithm and tolerance, and the source (user-provided, SDK, or from memory: confirm against the provider's docs).
## Design
A Mermaid sequence diagram from the provider to the side effect, then the idempotency and ordering strategy in a few bullets.
## Changes
One line per file.
## Tests
One line per test and the real result of the run.
## Configuration
| Setting | Env var | Required | Notes | (secrets, tolerance, queue names)
## Operational notes
How to register the endpoint with the provider, rotate the secret, replay a failed event, and what to alert on.
</output_format>

可替换内容

  • {{provider}}
  • {{#stack}}
  • {{stack}}
  • {{/stack}}
  • {{events}}
  • {{#signature_scheme}}
  • {{signature_scheme}}
  • {{/signature_scheme}}
  • {{> guardrails/scope-discipline}}
  • {{> guardrails/verify-before-done}}

分类与标签

编程开发、事件回调、接口开发、签名验证、幂等处理、异步任务

前往 AI 图片创作