veza/veza-backend-api/migrations/986_user_subscriptions_pending_payment_index.sql

23 lines
1.1 KiB
MySQL
Raw Normal View History

feat(subscription): pending_payment state machine + mandatory provider (v1.0.9 item G — Phase 1) First instalment of Item G from docs/audit-2026-04/v107-plan.md §G. This commit lands the state machine + create-flow change. Phase 2 (webhook handler + recovery endpoint + reconciler sweep) follows. What changes : - **`models.go`** — adds `StatusPendingPayment` to the SubscriptionStatus enum. Free-text VARCHAR(30) so no DDL needed for the value itself; Phase 2's reconciler index lives in migration 986 (additive, partial index on `created_at` WHERE status='pending_payment'). - **`service.go`** — `PaymentProvider.CreateSubscriptionPayment` interface gains an `idempotencyKey string` parameter, mirroring the marketplace.refundProvider contract added in v1.0.7 item D. Callers pass the new subscription row's UUID so a retried HTTP request collapses to one PSP charge instead of duplicating it. - **`createNewSubscription`** — refactored state machine : * Free plan → StatusActive (unchanged, in subscribeToFreePlan). * Paid plan, trial available, first-time user → StatusTrialing, no PSP call (no invoice either — Phase 2 will create the first paid invoice on trial expiry). * Paid plan, no trial / repeat user → **StatusPendingPayment** + invoice + PSP CreateSubscriptionPayment with idempotency key = subscription.ID.String(). Webhook subscription.payment_succeeded (Phase 2) flips to active; subscription.payment_failed flips to expired. - **`if s.paymentProvider != nil` short-circuit removed**. Paid plans now require a configured PaymentProvider — without one, `createNewSubscription` returns ErrPaymentProviderRequired. The handler maps this to HTTP 503 "Payment provider not configured — paid plans temporarily unavailable", surfacing env misconfig to ops instead of silently giving away paid plans (the v1.0.6.2 fantôme bug class). - **`GetUserSubscription` query unchanged** — already filters on `status IN ('active','trialing')`, so pending_payment rows correctly read as "no active subscription" for feature-gate purposes. The v1.0.6.2 hasEffectivePayment filter is kept as defence-in-depth for legacy rows. - **`hyperswitch.Provider`** — implements `subscription.PaymentProvider` by delegating to the existing `CreatePaymentSimple`. Compile-time interface assertion added (`var _ subscription.PaymentProvider = (*Provider)(nil)`). - **`routes_subscription.go`** — wires the Hyperswitch provider into `subscription.NewService` when HyperswitchEnabled + HyperswitchAPIKey + HyperswitchURL are all set. Without those, the service falls back to no-provider mode (paid subscribes return 503). - **Tests** : new TestSubscribe_PendingPaymentStateMachine in gate_test.go covers all five visible outcomes (free / paid+ provider / paid+no-provider / first-trial / repeat-trial) with a fakePaymentProvider that records calls. Asserts on idempotency key = subscription.ID.String(), PSP call counts, and the Subscribe response shape (client_secret + payment_id surfaced). 5/5 green, sqlite :memory:. Phase 2 backlog (next session) : - `ProcessSubscriptionWebhook(ctx, payload)` — flip pending_payment → active on success / expired on failure, idempotent against replays. - Recovery endpoint `POST /api/v1/subscriptions/complete/:id` — return the existing client_secret to resume a stalled flow. - Reconciliation sweep for rows stuck in pending_payment past the webhook-arrival window (uses the new partial index from migration 986). - Distribution.checkEligibility explicit pending_payment branch (today it's already handled implicitly via the active/trialing filter). - E2E @critical : POST /subscribe → POST /distribution/submit asserts 403 with "complete payment" until webhook fires. Backward compat : clients on the previous flow that called /subscribe expecting an immediately-active row will now see status=pending_payment + a client_secret. They must drive the PSP confirm step before the row is granted feature access. The v1.0.6.2 voided_subscriptions cleanup migration (980) handles pre-existing fantôme rows. go build ./... clean. Subscription + handlers test suites green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-26 08:02:00 +00:00
-- v1.0.9 Item G — subscription pending_payment state machine.
--
-- The user_subscriptions.status column is a free-text VARCHAR(30) with
-- no DB-level enum, so the new 'pending_payment' value introduced by
-- the Go const StatusPendingPayment requires no DDL. This migration is
-- documentation + an index that the future reconciliation worker
-- (Phase 2) needs to find rows stuck in pending_payment past the
-- webhook-arrival window.
--
-- Index strategy : a partial index on (created_at) WHERE status =
-- 'pending_payment' is the smallest possible footprint that still
-- gives the reconciler an O(log N) scan for "rows older than 30m
-- that haven't transitioned yet". A non-partial composite index would
-- pay storage cost for every row in the table; partial keeps it
-- proportional to the in-flight set.
CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_user_subscriptions_pending_payment
ON user_subscriptions (created_at)
WHERE status = 'pending_payment';
COMMENT ON INDEX idx_user_subscriptions_pending_payment IS
'v1.0.9 Item G — feeds the subscription reconciliation sweep that catches rows stuck in pending_payment past the webhook deadline.';