Files
Crussell/backend/handlers/webhooks/webhooks_test.go
T
popertots 7439fa86c1 Fix payment review round 3: saved-card idempotency, stale-pending sweep, webhook fail-closed
R1/R4: saved_card branch in CreateTerminalPayment now mirrors CreateTipPayment
- advisory lock (crussell:payment:<bookingID>) serializes concurrent double-clicks
- deterministic key bookingID-sc-type-amount-cardID (<=45 chars) so a lost-response
  retry derives the same key and dedups instead of double-charging
- idempotency switch inside the lock: completed -> dedup, pending -> reuse with
  pence amount-guard, failed -> clean 409
- success response includes card_brand/card_last4 (frontend already reads them)

R2: add 'failed' case to all four retry switches (tip, booking, gift card, till)
- a swept/definitively-rejected record returns 409 instead of 500-ing on the
  idempotency_key UNIQUE constraint

R3: extend SweepStalePendingPayments to till_sales card rows
- sweeps pending till_sales (online_square/in_person_card) past Square's ~24h
  key retention, closing the double-charge window for till sales
- swept rows logged with the same CRITICAL manual-reconciliation marker as the
  refund sweep

Webhook fail-closed: reject 503 when SQUARE_WEBHOOK_SIGNATURE_KEY unset, 403 on
bad signature (was: skip verification in dev)

Refund status resolution: refunds now resolve by Square status
(COMPLETED/PENDING/FAILED/REJECTED) instead of assuming completed; real error
codes (REFUND_AMOUNT_INVALID, PAYMENT_NOT_REFUNDABLE, REFUND_ALREADY_PENDING)
added to the definitive/processed classification

HTTP client: CreateCard key truncated to <=45 chars, device_options always sent
(env SQUARE_TERMINAL_DEVICE_ID fallback), processing_fee reads amount_money,
ListCards cursor loop, refund keys hashed to <=45 chars

Other fixes: payment/till/gift-card advisory-lock + FOR UPDATE asymmetries,
GetPaymentByID NULL scans, loyalty redemption lock, card upsert on conflict,
mock ccof: prefix parity, IsValidSquareCheckoutID for real Square IDs,
isAdminRequest defense-in-depth on all 6 admin payment handlers, webhook
signature docs, M8/L5 debug markers removed

Docs: README/FC/TM/Overview updated (22 jobs, 20 CRITICAL sites, 23-section
GDPR export, sweep jobs, webhook fail-closed); P11 plan marks remaining items
(sandbox smoke test, M-8 customer_id, saved-card key dedup trade-off) as
deferred with rationale; gap backlog pruned of completed items
2026-08-22 00:34:49 +01:00

265 lines
8.6 KiB
Go

//go:build test
package webhooks
import (
"bytes"
"context"
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
)
// =============================================================================
// Unit tests — verifySquareSignature (pure function)
// =============================================================================
func TestVerifySquareSignature_ValidSignature(t *testing.T) {
t.Parallel()
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
key := "test-signing-key"
notificationURL := "http://localhost:8080/webhooks/square"
payload := notificationURL + string(body)
mac := hmac.New(sha256.New, []byte(key))
mac.Write([]byte(payload))
expectedSig := base64.StdEncoding.EncodeToString(mac.Sum(nil))
if !verifySquareSignature(body, expectedSig, key, notificationURL) {
t.Error("expected valid signature to verify")
}
}
func TestVerifySquareSignature_InvalidSignature(t *testing.T) {
t.Parallel()
body := []byte(`{"type":"payment.updated"}`)
key := "test-signing-key"
notificationURL := "http://localhost:8080/webhooks/square"
if verifySquareSignature(body, "invalid-signature", key, notificationURL) {
t.Error("expected invalid signature to fail")
}
}
func TestVerifySquareSignature_WrongKey(t *testing.T) {
t.Parallel()
body := []byte(`{"type":"payment.updated"}`)
notificationURL := "http://localhost:8080/webhooks/square"
payload := notificationURL + string(body)
mac := hmac.New(sha256.New, []byte("correct-key"))
mac.Write([]byte(payload))
sig := base64.StdEncoding.EncodeToString(mac.Sum(nil))
// Verify with a different key
if verifySquareSignature(body, sig, "wrong-key", notificationURL) {
t.Error("expected wrong key to produce failing verification")
}
}
func TestVerifySquareSignature_EmptyBody(t *testing.T) {
t.Parallel()
key := "test-signing-key"
notificationURL := "http://localhost:8080/webhooks/square"
payload := notificationURL + string([]byte{})
mac := hmac.New(sha256.New, []byte(key))
mac.Write([]byte(payload))
expectedSig := base64.StdEncoding.EncodeToString(mac.Sum(nil))
if !verifySquareSignature([]byte{}, expectedSig, key, notificationURL) {
t.Error("expected empty body verification to succeed with matching signature")
}
}
func TestVerifySquareSignature_TamperedBody(t *testing.T) {
t.Parallel()
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
key := "test-signing-key"
notificationURL := "http://localhost:8080/webhooks/square"
payload := notificationURL + string(body)
mac := hmac.New(sha256.New, []byte(key))
mac.Write([]byte(payload))
sig := base64.StdEncoding.EncodeToString(mac.Sum(nil))
// Verify with a tampered body
tamperedBody := []byte(`{"type":"payment.updated","event_id":"evt_2"}`)
if verifySquareSignature(tamperedBody, sig, key, notificationURL) {
t.Error("expected tampered body to fail verification")
}
}
// =============================================================================
// Integration tests — HandleSquareWebhook
// =============================================================================
func makeWebhookRequest(body []byte, signature string, ctx context.Context) *httptest.ResponseRecorder {
w := httptest.NewRecorder()
req := httptest.NewRequest("POST", "/webhooks/square", bytes.NewReader(body))
req = req.WithContext(ctx)
req.Header.Set("Content-Type", "application/json")
if signature != "" {
req.Header.Set("x-square-hmacsha256-signature", signature)
}
HandleSquareWebhook(w, req)
return w
}
// webhookTestEnv sets a signing key and returns a valid signature for the body
// (the fail-closed handler requires a verifiable signature on every request).
func webhookTestEnv(t *testing.T, body []byte) (signature string) {
t.Helper()
tKey := "test-signing-key"
tURL := "http://localhost:8080/webhooks/square"
mac := hmac.New(sha256.New, []byte(tKey))
mac.Write([]byte(tURL))
mac.Write(body)
t.Setenv("SQUARE_WEBHOOK_SIGNATURE_KEY", tKey)
return base64.StdEncoding.EncodeToString(mac.Sum(nil))
}
func TestHandleSquareWebhook_PaymentUpdated(t *testing.T) {
event := SquareWebhookEvent{
Type: "payment.updated",
EventID: "evt_payment_1",
CreatedAt: "2025-01-01T00:00:00Z",
Data: json.RawMessage(`{"id":"payment_1"}`),
}
body, _ := json.Marshal(event)
sig := webhookTestEnv(t, body)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusOK {
t.Errorf("expected 200, got %d. body: %s", w.Code, w.Body.String())
}
if w.Body.String() != "ok" {
t.Errorf("expected body 'ok', got %q", w.Body.String())
}
}
func TestHandleSquareWebhook_RefundUpdated(t *testing.T) {
event := SquareWebhookEvent{
Type: "refund.updated",
EventID: "evt_refund_1",
CreatedAt: "2025-01-01T00:00:00Z",
Data: json.RawMessage(`{"id":"refund_1"}`),
}
body, _ := json.Marshal(event)
sig := webhookTestEnv(t, body)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusOK {
t.Errorf("expected 200, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_DisputeCreated(t *testing.T) {
event := SquareWebhookEvent{
Type: "dispute.created",
EventID: "evt_dispute_1",
CreatedAt: "2025-01-01T00:00:00Z",
Data: json.RawMessage(`{"id":"dispute_1"}`),
}
body, _ := json.Marshal(event)
sig := webhookTestEnv(t, body)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusOK {
t.Errorf("expected 200 for dispute.created, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_UnknownEventType(t *testing.T) {
event := SquareWebhookEvent{
Type: "invoice.created",
EventID: "evt_unknown_1",
CreatedAt: "2025-01-01T00:00:00Z",
Data: json.RawMessage(`{"id":"inv_1"}`),
}
body, _ := json.Marshal(event)
sig := webhookTestEnv(t, body)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusOK {
t.Errorf("expected 200 for unknown event type, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_InvalidJSON(t *testing.T) {
body := []byte(`{invalid json}`)
sig := webhookTestEnv(t, body)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusBadRequest {
t.Errorf("expected 400 for invalid JSON, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_BodyTooLarge(t *testing.T) {
// 600KB body exceeds the 512KB limit
largeBody := []byte(strings.Repeat("a", 600*1024))
sig := webhookTestEnv(t, largeBody)
w := makeWebhookRequest(largeBody, sig, context.Background())
if w.Code != http.StatusRequestEntityTooLarge {
t.Errorf("expected 413 for oversized body, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_ValidSignatureWithEnvKey(t *testing.T) {
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
key := "env-signing-key"
notificationURL := "http://localhost:8080/webhooks/square"
payload := notificationURL + string(body)
mac := hmac.New(sha256.New, []byte(key))
mac.Write([]byte(payload))
sig := base64.StdEncoding.EncodeToString(mac.Sum(nil))
t.Setenv("SQUARE_WEBHOOK_SIGNATURE_KEY", key)
w := makeWebhookRequest(body, sig, context.Background())
if w.Code != http.StatusOK {
t.Errorf("expected 200 with valid signature, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_InvalidSignatureWithEnvKey(t *testing.T) {
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
t.Setenv("SQUARE_WEBHOOK_SIGNATURE_KEY", "env-signing-key")
w := makeWebhookRequest(body, "bad-signature", context.Background())
if w.Code != http.StatusForbidden {
t.Errorf("expected 403 with invalid signature, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_NoSignatureWhenKeySet(t *testing.T) {
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
t.Setenv("SQUARE_WEBHOOK_SIGNATURE_KEY", "env-signing-key")
// No x-square-signature header at all
w := makeWebhookRequest(body, "", context.Background())
if w.Code != http.StatusForbidden {
t.Errorf("expected 403 when signature key is set but header missing, got %d. body: %s", w.Code, w.Body.String())
}
}
func TestHandleSquareWebhook_RejectedWhenKeyEmpty(t *testing.T) {
t.Setenv("SQUARE_WEBHOOK_SIGNATURE_KEY", "")
body := []byte(`{"type":"payment.updated","event_id":"evt_1"}`)
// Fail-closed: an unset signing key means the webhook cannot be verified,
// so the request is rejected rather than accepted with a bad signature.
w := makeWebhookRequest(body, "some-signature", context.Background())
if w.Code != http.StatusServiceUnavailable {
t.Errorf("expected 503 when no key configured (fail-closed), got %d. body: %s", w.Code, w.Body.String())
}
}