Files
probo/pkg/webhook/sender.go
Sacha Al Himdani ae6e6b665b Add failed status to webhook data
Signed-off-by: Sacha Al Himdani <sacha@getprobo.com>
2026-02-13 18:28:27 +01:00

368 lines
9.9 KiB
Go

// Copyright (c) 2025 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package webhook
import (
"bytes"
"context"
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"strconv"
"sync"
"time"
"go.gearno.de/kit/httpclient"
"go.gearno.de/kit/log"
"go.gearno.de/kit/pg"
"go.probo.inc/probo/pkg/coredata"
"go.probo.inc/probo/pkg/crypto/cipher"
"go.probo.inc/probo/pkg/gid"
)
type (
Sender struct {
pg *pg.Client
logger *log.Logger
httpClient *http.Client
encryptionKey cipher.EncryptionKey
cache sync.Map
interval time.Duration
timeout time.Duration
}
cachedSecret struct {
encryptedSecret []byte
plaintext string
}
Config struct {
Interval time.Duration
Timeout time.Duration
EncryptionKey cipher.EncryptionKey
}
)
const maxResponseBodySize = 64 * 1024 // 64KB
func NewSender(pg *pg.Client, logger *log.Logger, cfg Config) *Sender {
if cfg.Interval <= 0 {
cfg.Interval = 5 * time.Second
}
if cfg.Timeout <= 0 {
cfg.Timeout = 30 * time.Second
}
return &Sender{
pg: pg,
logger: logger,
httpClient: httpclient.DefaultPooledClient(httpclient.WithLogger(logger)),
encryptionKey: cfg.EncryptionKey,
interval: cfg.Interval,
timeout: cfg.Timeout,
}
}
func (s *Sender) Run(ctx context.Context) error {
for {
select {
case <-ctx.Done():
return ctx.Err()
case <-time.After(s.interval):
if err := s.processEvents(ctx); err != nil {
s.logger.ErrorCtx(ctx, "cannot process webhook events", log.Error(err))
}
}
}
}
func (s *Sender) processEvents(ctx context.Context) error {
for {
webhookData, err := s.claimNextWebhookData(ctx)
if err != nil {
if errors.Is(err, coredata.ErrResourceNotFound) {
return nil
}
return fmt.Errorf("cannot claim next webhook data: %w", err)
}
s.processWebhookData(ctx, webhookData)
}
}
func (s *Sender) claimNextWebhookData(ctx context.Context) (*coredata.WebhookData, error) {
var webhookData coredata.WebhookData
err := s.pg.WithTx(ctx, func(tx pg.Conn) error {
if err := webhookData.LoadNextPendingForUpdate(ctx, tx); err != nil {
return fmt.Errorf("cannot load next pending webhook data: %w", err)
}
scope := coredata.NewScopeFromObjectID(webhookData.ID)
webhookData.Status = coredata.WebhookDataStatusProcessing
if err := webhookData.UpdateStatus(ctx, tx, scope); err != nil {
return fmt.Errorf("cannot update webhook data to processing: %w", err)
}
return nil
})
if err != nil {
return nil, err
}
return &webhookData, nil
}
func (s *Sender) processWebhookData(ctx context.Context, webhookData *coredata.WebhookData) {
scope := coredata.NewScopeFromObjectID(webhookData.ID)
var configs coredata.WebhookConfigurations
err := s.pg.WithConn(ctx, func(conn pg.Conn) error {
return configs.LoadMatchingByOrganizationIDAndEventType(
ctx, conn, scope, webhookData.OrganizationID, webhookData.EventType,
)
})
if err != nil {
s.logger.ErrorCtx(ctx, "cannot load matching webhook configurations",
log.Error(err),
log.String("webhook_data_id", webhookData.ID.String()),
)
s.markWebhookData(ctx, webhookData, scope, coredata.WebhookDataStatusFailed)
return
}
for _, config := range configs {
s.deliverToConfiguration(ctx, webhookData, config, scope)
}
s.markWebhookData(ctx, webhookData, scope, coredata.WebhookDataStatusProcessed)
}
func (s *Sender) markWebhookData(ctx context.Context, webhookData *coredata.WebhookData, scope coredata.Scoper, status coredata.WebhookDataStatus) {
now := time.Now()
webhookData.Status = status
webhookData.ProcessedAt = &now
err := s.pg.WithConn(ctx, func(conn pg.Conn) error {
return webhookData.UpdateStatus(ctx, conn, scope)
})
if err != nil {
s.logger.ErrorCtx(ctx, "cannot update webhook data status",
log.Error(err),
log.String("webhook_data_id", webhookData.ID.String()),
log.String("target_status", status.String()),
)
}
}
func (s *Sender) deliverToConfiguration(
ctx context.Context,
webhookData *coredata.WebhookData,
config *coredata.WebhookConfiguration,
scope coredata.Scoper,
) {
eventID := gid.New(webhookData.ID.TenantID(), coredata.WebhookEventEntityType)
signingSecret, err := s.getSigningSecret(config.ID.String(), config.EncryptedSigningSecret)
if err != nil {
s.logger.ErrorCtx(ctx, "cannot get signing secret",
log.Error(err),
log.String("webhook_data_id", webhookData.ID.String()),
log.String("configuration_id", config.ID.String()),
)
s.recordEvent(ctx, eventID, webhookData, config, scope, coredata.WebhookEventStatusFailed, nil)
return
}
response, sendErr := s.doHTTPCall(ctx, eventID, config.EndpointURL, webhookData, config.ID, signingSecret)
eventStatus := coredata.WebhookEventStatusSucceeded
if sendErr != nil {
eventStatus = coredata.WebhookEventStatusFailed
s.logger.ErrorCtx(ctx, "error delivering webhook",
log.Error(sendErr),
log.String("webhook_data_id", webhookData.ID.String()),
)
}
s.recordEvent(ctx, eventID, webhookData, config, scope, eventStatus, response)
}
func (s *Sender) getSigningSecret(webhookConfigurationID string, encryptedSigningSecret []byte) (string, error) {
if cached, ok := s.cache.Load(webhookConfigurationID); ok {
entry := cached.(*cachedSecret)
if bytes.Equal(entry.encryptedSecret, encryptedSigningSecret) {
return entry.plaintext, nil
}
}
plaintext, err := cipher.Decrypt(encryptedSigningSecret, s.encryptionKey)
if err != nil {
return "", fmt.Errorf("cannot decrypt signing secret: %w", err)
}
signingSecret := string(plaintext)
s.cache.Store(webhookConfigurationID, &cachedSecret{
encryptedSecret: encryptedSigningSecret,
plaintext: signingSecret,
})
return signingSecret, nil
}
func (s *Sender) doHTTPCall(
ctx context.Context,
eventID gid.GID,
endpointURL string,
webhookData *coredata.WebhookData,
configurationID gid.GID,
signingSecret string,
) (json.RawMessage, error) {
payload := map[string]any{
"eventId": eventID.String(),
"configurationId": configurationID.String(),
"organizationId": webhookData.OrganizationID.String(),
"eventType": webhookData.EventType.String(),
"createdAt": webhookData.CreatedAt,
"data": webhookData.Data,
}
body, err := json.Marshal(payload)
if err != nil {
return nil, fmt.Errorf("cannot marshal webhook payload: %w", err)
}
reqCtx, cancel := context.WithTimeout(ctx, s.timeout)
defer cancel()
req, err := http.NewRequestWithContext(reqCtx, http.MethodPost, endpointURL, bytes.NewReader(body))
if err != nil {
return nil, fmt.Errorf("cannot create request: %w", err)
}
timestamp := strconv.FormatInt(time.Now().Unix(), 10)
signature := computeSignature(signingSecret, timestamp, body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Probo-Webhook-Event", webhookData.EventType.String())
req.Header.Set("X-Probo-Webhook-Timestamp", timestamp)
req.Header.Set("X-Probo-Webhook-Signature", signature)
resp, err := s.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("cannot send request: %w", err)
}
defer func() { _ = resp.Body.Close() }()
respBody, _ := io.ReadAll(io.LimitReader(resp.Body, maxResponseBodySize))
response := buildResponseJSON(resp, respBody)
switch resp.StatusCode {
case http.StatusOK,
http.StatusCreated,
http.StatusAccepted,
http.StatusNoContent:
return response, nil
default:
return response, fmt.Errorf("webhook endpoint returned status %d", resp.StatusCode)
}
}
func (s *Sender) recordEvent(
ctx context.Context,
eventID gid.GID,
webhookData *coredata.WebhookData,
config *coredata.WebhookConfiguration,
scope coredata.Scoper,
status coredata.WebhookEventStatus,
response json.RawMessage,
) {
event := coredata.WebhookEvent{
ID: eventID,
WebhookDataID: webhookData.ID,
WebhookConfigurationID: config.ID,
EndpointURL: config.EndpointURL,
Status: status,
Response: response,
CreatedAt: time.Now(),
}
err := s.pg.WithConn(ctx, func(conn pg.Conn) error {
return event.Insert(ctx, conn, scope)
})
if err != nil {
s.logger.ErrorCtx(ctx, "cannot insert webhook event",
log.Error(err),
log.String("webhook_data_id", webhookData.ID.String()),
log.String("configuration_id", config.ID.String()),
)
}
}
func buildResponseJSON(resp *http.Response, body []byte) json.RawMessage {
headers := make(map[string]any, len(resp.Header))
for k, v := range resp.Header {
if len(v) == 1 {
headers[k] = v[0]
} else {
headers[k] = v
}
}
var bodyValue any
if json.Valid(body) {
bodyValue = json.RawMessage(body)
} else {
bodyValue = string(body)
}
respObj := map[string]any{
"proto": resp.Proto,
"status_code": resp.StatusCode,
"headers": headers,
"body": bodyValue,
}
if len(resp.Trailer) > 0 {
trailers := make(map[string]any, len(resp.Trailer))
for k, v := range resp.Trailer {
if len(v) == 1 {
trailers[k] = v[0]
} else {
trailers[k] = v
}
}
respObj["trailers"] = trailers
}
data, _ := json.Marshal(respObj)
return data
}
func computeSignature(signingSecret, timestamp string, body []byte) string {
h := hmac.New(sha256.New, []byte(signingSecret))
_, _ = fmt.Fprintf(h, "%s:%s", timestamp, body)
return hex.EncodeToString(h.Sum(nil))
}