mirror of
https://github.com/hanzo-fi/payments.git
synced 2026-10-30 20:31:20 +00:00
* Implement Balances Webhooks in Stripe to reduce polling workflows * Create webhooks on install * Remove webhook at uninstall time * Add verifyWebhook function to Stripe * Pin APIVersion in Stripe Webhook Create call * Default to root account when receiving balance.update webhook * Only make call do delete webhooks if webhooks were setup to begin with * Set up two webhook endpoints - one for connect and one for root account * Use event.Created to determine balance time in Stripe webhooks * Start recording root account ID instead of dummy 'root' value * Create unit test for Stripe create webhooks * Add tests for Stripe Translate webhook * Share logic between Stripe balance polling and webhook handle * Use supported webhooks map * Update existing stripe webhooks instead of creating new ones at app start time * Run install sequence for each connector at app start of payments api pods * Turn of balances periodically for Stripe * Add nil checks for balance.Available * Remove potentially sensitive information from error message * Add migration tool to remove FETCH BALANCES schedules from stripe
134 lines
4.3 KiB
Go
134 lines
4.3 KiB
Go
package stripe
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/formancehq/payments/internal/connectors/plugins/public/stripe/client"
|
|
"github.com/formancehq/payments/internal/models"
|
|
"github.com/stripe/stripe-go/v80"
|
|
"github.com/stripe/stripe-go/v80/webhook"
|
|
)
|
|
|
|
type TranslateWebhookFunc func(context.Context, string, *stripe.Event) ([]models.WebhookResponse, error)
|
|
|
|
var (
|
|
webhookRelatedAccountIDKey = "webhook_related_account_id"
|
|
|
|
supportedWebhooks = map[stripe.EventType]TranslateWebhookFunc{
|
|
stripe.EventTypeBalanceAvailable: translateBalanceWebhook,
|
|
}
|
|
)
|
|
|
|
func (p *Plugin) createWebhooks(ctx context.Context, req models.CreateWebhooksRequest) ([]models.PSPWebhookConfig, error) {
|
|
results, err := p.client.CreateWebhookEndpoints(ctx, req.WebhookBaseUrl)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
configs := make([]models.PSPWebhookConfig, 0, len(results))
|
|
for _, result := range results {
|
|
urlPath := strings.TrimPrefix(result.URL, req.WebhookBaseUrl)
|
|
|
|
metadata := map[string]string{
|
|
"secret": result.Secret,
|
|
"enabled_events": strings.Join(result.EnabledEvents, ","),
|
|
}
|
|
|
|
// if it's not a StripeConnect enabled webhook let's embed the root account ID so we can associate events with it
|
|
if !strings.Contains(urlPath, client.StripeConnectUrlPrefix) {
|
|
metadata[webhookRelatedAccountIDKey] = p.client.GetRootAccountID()
|
|
}
|
|
configs = append(configs, models.PSPWebhookConfig{
|
|
Name: result.ID,
|
|
URLPath: urlPath,
|
|
Metadata: metadata,
|
|
})
|
|
}
|
|
return configs, nil
|
|
}
|
|
|
|
func (p *Plugin) extractWebhookEvent(config *models.WebhookConfig, wh models.PSPWebhook) (evt stripe.Event, err error) {
|
|
if config == nil || config.Metadata == nil {
|
|
return evt, fmt.Errorf("config metadata missing for this webhook: %w", models.ErrWebhookVerification)
|
|
}
|
|
|
|
secret, ok := config.Metadata["secret"]
|
|
if !ok {
|
|
return evt, fmt.Errorf("secret missing from config: %w", models.ErrWebhookVerification)
|
|
}
|
|
|
|
payload := wh.Body
|
|
headers, ok := wh.Headers["Stripe-Signature"]
|
|
if !ok || len(headers) != 1 {
|
|
return evt, fmt.Errorf("stripe signature header not found: %w", models.ErrWebhookVerification)
|
|
}
|
|
|
|
// Pass the request body and Stripe-Signature header to ConstructEvent, along
|
|
// with the webhook signing key.
|
|
event, err := webhook.ConstructEvent(payload, headers[0], secret)
|
|
if err != nil {
|
|
return evt, fmt.Errorf("error verifying webhook signature: %w: %w", err, models.ErrWebhookVerification)
|
|
}
|
|
return event, nil
|
|
}
|
|
|
|
func (p *Plugin) verifyWebhook(ctx context.Context, req models.VerifyWebhookRequest) (*string, error) {
|
|
event, err := p.extractWebhookEvent(req.Config, req.Webhook)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error verifying webhook: %w", err)
|
|
}
|
|
return &event.ID, nil
|
|
}
|
|
|
|
func (p *Plugin) translateWebhook(ctx context.Context, req models.TranslateWebhookRequest) ([]models.WebhookResponse, error) {
|
|
event, err := p.extractWebhookEvent(req.Config, req.Webhook)
|
|
if err != nil {
|
|
return []models.WebhookResponse{}, fmt.Errorf("error translating webhook: %w", err)
|
|
}
|
|
|
|
// an account reference is only present if it's a StripeConnect account
|
|
accountReference := event.Account
|
|
if accountReference == "" {
|
|
accountID, ok := req.Config.Metadata[webhookRelatedAccountIDKey]
|
|
if !ok {
|
|
return []models.WebhookResponse{}, fmt.Errorf("webhook config %q did not contain root account ID for handling Stripe Connect eventID=%s", req.Config.Name, event.ID)
|
|
}
|
|
accountReference = accountID
|
|
}
|
|
|
|
fn, ok := supportedWebhooks[event.Type]
|
|
if !ok {
|
|
return []models.WebhookResponse{}, fmt.Errorf("unhandled event type: %q", event.Type)
|
|
}
|
|
return fn(ctx, accountReference, &event)
|
|
}
|
|
|
|
func translateBalanceWebhook(
|
|
ctx context.Context,
|
|
accountRef string,
|
|
evt *stripe.Event,
|
|
) ([]models.WebhookResponse, error) {
|
|
var balance stripe.Balance
|
|
err := json.Unmarshal(evt.Data.Raw, &balance)
|
|
if err != nil {
|
|
return []models.WebhookResponse{}, fmt.Errorf("failed to parse %q webhook JSON: %w", evt.Type, err)
|
|
}
|
|
responses := make([]models.WebhookResponse, 0, len(balance.Available))
|
|
|
|
eventCreatedAt := time.Unix(evt.Created, 0)
|
|
for _, available := range balance.Available {
|
|
if available == nil {
|
|
continue
|
|
}
|
|
pspBalance := toPSPBalance(accountRef, eventCreatedAt, available)
|
|
responses = append(responses, models.WebhookResponse{
|
|
Balance: &pspBalance,
|
|
})
|
|
}
|
|
return responses, nil
|
|
}
|