mirror of
https://github.com/hanzo-fi/webhooks.git
synced 2026-10-30 20:32:55 +00:00
Maxence MaireauxandGitHub
6504cd9692
* fix: resolve P0/P1 reliability and security issues - P0: Process messages synchronously to prevent data loss on crash The Watermill handler now blocks until webhook delivery completes. Messages are only acknowledged after processing, not before. Errors on invalid payloads are returned (nack) instead of swallowed. Per-config failures use continue instead of return, so one bad endpoint no longer blocks delivery to other matching configs. - P1: Replace panic with error on unknown filter key FindManyConfigs now returns an error instead of panicking when called with an unrecognized filter key. A single bad API request no longer crashes the process. - P1: Remove environment and secret logging Removed os.Environ() dumps from server and worker startup. Replaced config %+v logging with safe ID/endpoint-only logging. Removed event-payload from OpenTelemetry span attributes. - Docs: Add architecture, message-processing, and security docs. Fix CTE typo in retry-mechanism.md. No breaking changes to public API, Store interface, or CLI flags. * chore: add CODEOWNERS assigning @formancehq/backend as default reviewers * fix: remove dead code flagged by ineffassign linter * fix: address CodeRabbit review feedback - Return error (nack) when InsertOneAttempt fails for non-success attempts, preventing silent loss of retry records - Rewrite TestProcessMessages_SynchronousProcessing to be deterministic: HTTP handler blocks on a channel, test proves handler is blocked until the HTTP response completes - Add TestProcessMessages_NackOnInsertFailureForRetry for the new nack path - Expand secret logging test patterns to cover %v and more variable names - Rename TestConfigStringerDoesNotLeakSecret to TestDocument_PercentPlusVLeaksSecrets - Fix retry-mechanism.md claim query priority documentation: DISTINCT ON does per-webhook ordering, not global priority * fix: propagate errors to span, avoid err shadowing in defer - Rename loop-scoped err to attemptErr/insertErr so the defer closure captures the correct error for span.RecordError() - Add explicit span.RecordError() on MakeAttempt and InsertOneAttempt failures that previously went unrecorded in traces - Assign err before return on nack path so the defer sees it - Update Go version in architecture doc to 1.25+ (matches go.mod) Addresses review comments from paul-nicolas on PR #142. * fix: handle transport errors in MakeAttempt as retryable attempts - MakeAttempt now returns a retryable Attempt (instead of a bare error) when httpClient.Do fails due to transport/timeout, preventing event loss since the attempt record is persisted for the retry loop - Replace base64-looking test secret with plain dummy to avoid triggering secret scanners in CI Addresses CodeRabbit review comments on PR #142.
87 lines
2.3 KiB
Go
87 lines
2.3 KiB
Go
package webhooks_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
webhooks "github.com/formancehq/webhooks/pkg"
|
|
)
|
|
|
|
type fixedBackoff struct {
|
|
delay time.Duration
|
|
}
|
|
|
|
func (f *fixedBackoff) GetRetryDelay(int) (time.Duration, error) {
|
|
return f.delay, nil
|
|
}
|
|
|
|
type noRetryPolicy struct{}
|
|
|
|
func (n *noRetryPolicy) GetRetryDelay(int) (time.Duration, error) {
|
|
return 0, fmt.Errorf("max retries exceeded")
|
|
}
|
|
|
|
func TestMakeAttempt_TransportError_ReturnsRetryableAttempt(t *testing.T) {
|
|
// Use a server that is immediately closed to force a transport error
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
}))
|
|
server.Close() // close immediately so httpClient.Do fails
|
|
|
|
cfg := webhooks.Config{
|
|
ConfigUser: webhooks.ConfigUser{
|
|
Endpoint: server.URL,
|
|
Secret: webhooks.NewSecret(),
|
|
EventTypes: []string{"test.event"},
|
|
},
|
|
ID: "cfg-transport",
|
|
Active: true,
|
|
}
|
|
|
|
policy := &fixedBackoff{delay: 15 * time.Second}
|
|
|
|
attempt, err := webhooks.MakeAttempt(
|
|
context.Background(), server.Client(), policy,
|
|
"attempt-id", "webhook-id", 0, cfg, "", []byte(`{"type":"test.event"}`), false,
|
|
)
|
|
|
|
// No bare error — the attempt is returned with retry status
|
|
require.NoError(t, err)
|
|
assert.Equal(t, webhooks.StatusAttemptToRetry, attempt.Status)
|
|
assert.Equal(t, 0, attempt.StatusCode)
|
|
assert.False(t, attempt.NextRetryAfter.IsZero(), "NextRetryAfter should be set")
|
|
}
|
|
|
|
func TestMakeAttempt_TransportError_MaxRetriesExceeded(t *testing.T) {
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
|
|
server.Close()
|
|
|
|
cfg := webhooks.Config{
|
|
ConfigUser: webhooks.ConfigUser{
|
|
Endpoint: server.URL,
|
|
Secret: webhooks.NewSecret(),
|
|
EventTypes: []string{"test.event"},
|
|
},
|
|
ID: "cfg-transport-max",
|
|
Active: true,
|
|
}
|
|
|
|
// Policy that always returns error = max retries exceeded
|
|
policy := &noRetryPolicy{}
|
|
|
|
attempt, err := webhooks.MakeAttempt(
|
|
context.Background(), http.DefaultClient, policy,
|
|
"attempt-id", "webhook-id", 999, cfg, "", []byte(`{"type":"test.event"}`), false,
|
|
)
|
|
|
|
require.NoError(t, err)
|
|
assert.Equal(t, webhooks.StatusAttemptFailed, attempt.Status)
|
|
}
|