fix: Persist inbound stripe webhooks #2972
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ancorcruz
force-pushed
the
fix/persisted-webhooks
branch
2 times, most recently
from
c083548 to
d3e6956
Compare
nudded
reviewed
Dec 18, 2024
nudded
reviewed
Dec 18, 2024
ancorcruz
force-pushed
the
fix/persisted-webhooks
branch
from
8fb4b83 to
eb955bc
Compare
nudded
reviewed
Dec 20, 2024
vincent-pochet
approved these changes
Dec 23, 2024
skip failed and processed.
in pending or processing status...
retriable is defined as inbound webhooks in: - processing status, and with processing_at earlier than 2 hours ago - pending status, and created_at earlier than 2 hours ago
only contruct event as paylaoad is already validated.
Co-authored-by: Vincent Pochet <[email protected]>
ancorcruz
force-pushed
the
fix/persisted-webhooks
branch
from
e2becd3 to
e9c1268
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Currently, when our application receives webhooks from third-party services (e.g., Stripe, GoCardless, Adyen), their payloads are immediately queued in Sidekiq for background processing. While this approach works in most cases, it introduces a critical reliability issue, especially in self-hosted environments where Sidekiq may lose jobs if workers are abruptly terminated or overloaded.
This unreliability has led to issues like pending transactions that are never resolved despite receiving valid webhooks. For example, a reported issue involved a wallet credit purchase where the payment settled on Stripe, the webhook was received, but the transaction remained pending indefinitely until manually resolved.
To address this, we aim to ensure that no webhook payload is lost and processing remains consistent, even under adverse conditions.
Description
This PR introduces a robust mechanism for handling inbound webhooks by persisting them in the database before processing. Key changes include:
Database Persistence:
inbound_webhookstable immediately upon receipt. This ensures all webhook payloads are safely persisted in a reliable system before processing.Background Processing:
InboundWebhooks::CreateServiceis introduced to persist the webhook and enqueue it for processing.InboundWebhooks::ProcessJobSidekiq worker processes the persisted webhooks, invoking theInboundWebhooks::ProcessServiceInboundWebhooks::ProcessServiceprocesses the persisted webhooks invoking the appropriate payment provider service.Retry Mechanisms:
Controller Update:
WebhooksControlleractions (stripe, adyen, and gocardless) now use the InboundWebhooks::CreateService and respond with 200 OK once the webhook is persisted successfully.Backward Compatibility:
Key Changes
InboundWebhookActiveRecord model to persist webhook payloads with fields such assource,event_type,payload,status.InboundWebhooks::CreateServiceto handle webhook persistence and Sidekiq job enqueueing.InboundWebhooks::ProcessJobto process persisted webhooks from Sidekiq queue.InboundWebhooks::ProcessServiceto call the respective provider's handle incoming webhook service.PaymentProviders::Stripe::HandleIncomingWebhookServiceto process webhooks from the database instead of relying solely on direct Sidekiq queues.WebhooksController#stripeaction to integrate with the new service and workflow.Benefits
Reliability: Ensures no webhook is lost, even if Sidekiq workers fail.
Resilience: Provides a retry mechanism for failed webhook processing.
Transparency: Makes webhook processing traceable with statuses (pending, processing, processed, failed).