Files
CrimsonandGitHub c48bb246b5 feat(Stripe): EN-470 Add balance.available webhooks to Stripe connector (#590)
* 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
2025-11-21 10:25:52 +00:00

123 lines
3.9 KiB
Go

package client
import (
"context"
"fmt"
"time"
"github.com/formancehq/payments/internal/connectors/metrics"
"github.com/formancehq/payments/internal/models"
"github.com/stripe/stripe-go/v80"
)
const (
expandSource = "data.source"
expandSourceCharge = "data.source.charge"
expandSourceDispute = "data.source.dispute"
expandSourcePayout = "data.source.payout"
expandSourceRefund = "data.source.refund"
expandSourceTransfer = "data.source.transfer"
expandSourcePaymentIntent = "data.source.payment_intent"
expandSourceRefundPaymentIntent = "data.source.refund.payment_intent"
)
func (c *client) GetPayments(
ctx context.Context,
accountID string,
timeline Timeline,
pageSize int64,
) (results []*stripe.BalanceTransaction, _ Timeline, hasMore bool, err error) {
results = make([]*stripe.BalanceTransaction, 0, int(pageSize))
timer := time.NewTimer((models.ActivityStartToCloseTimeoutMinutesLong - 1) * time.Minute)
defer timer.Stop()
for {
select {
case <-ctx.Done():
// if the app is shutting down
return results, timeline, false, fmt.Errorf("context closed before first payment found")
case <-timer.C:
// after the timer expires let's save the state to prevent workflow timeout
return results, timeline, true, nil
default: //fallthrough
}
if timeline.IsCaughtUp() {
break
}
var oldest interface{}
oldest, timeline, hasMore, err = scanForOldest(timeline, pageSize, func(params stripe.ListParams) (stripe.ListContainer, error) {
if accountID != "" {
params.StripeAccount = &accountID
}
params.Context = metrics.OperationContext(ctx, "list_transactions_scan")
transactionParams := &stripe.BalanceTransactionListParams{ListParams: params}
expandBalanceTransactionParams(transactionParams)
itr := c.balanceTransactionClient.List(transactionParams)
return itr.BalanceTransactionList(), wrapSDKErr(itr.Err())
})
if err != nil {
return results, timeline, false, err
}
if hasMore {
continue
}
if oldest == nil {
return results, timeline, false, err
}
results = append(results, oldest.(*stripe.BalanceTransaction))
}
filters := stripe.ListParams{
Context: metrics.OperationContext(ctx, "list_transactions"),
Limit: limit(pageSize, len(results)),
EndingBefore: &timeline.LatestID,
Single: true, // turn off autopagination
}
if accountID != "" {
filters.StripeAccount = &accountID
}
params := &stripe.BalanceTransactionListParams{
ListParams: filters,
}
expandBalanceTransactionParams(params)
itr := c.balanceTransactionClient.List(params)
data := reverseTransactions(itr.BalanceTransactionList().Data)
results = append(results, data...)
if len(results) == 0 {
return results, timeline, itr.BalanceTransactionList().ListMeta.HasMore, wrapSDKErr(itr.Err())
}
timeline.LatestID = results[len(results)-1].ID
c.logger.WithField("account", accountID).WithField("latest_id", timeline.LatestID).Debugf("set latest id after batch with %d entries", len(results))
return results, timeline, itr.BalanceTransactionList().ListMeta.HasMore, wrapSDKErr(itr.Err())
}
func expandBalanceTransactionParams(params *stripe.BalanceTransactionListParams) {
params.AddExpand(expandSource)
params.AddExpand(expandSourceCharge)
params.AddExpand(expandSourceDispute)
params.AddExpand(expandSourcePayout)
params.AddExpand(expandSourceRefund)
params.AddExpand(expandSourceTransfer)
params.AddExpand(expandSourcePaymentIntent)
params.AddExpand(expandSourceRefundPaymentIntent)
}
// Stripe now returns data in reverse chronological order no matter which params we provide so we need to reverse the slice
func reverseTransactions(in []*stripe.BalanceTransaction) []*stripe.BalanceTransaction {
out := make([]*stripe.BalanceTransaction, len(in))
copy(out, in)
for i, j := 0, len(out)-1; i < j; i, j = i+1, j-1 {
out[i], out[j] = out[j], out[i]
}
return out
}