Files
multica/packages/core/billing/mutations.ts
LinYushen 7bbca54e92 feat(billing): test page consuming /api/cloud-billing/* (#3442)
* feat(billing): test page consuming /api/cloud-billing/*

Stuffs every cloud-billing endpoint onto a single dev page so we can
verify the proxy + Stripe end-to-end flow without a designed UI.
Reachable at /<workspaceSlug>/billing — the page is account-level
data but lives under the workspace dashboard layout because that's
where the authenticated shell sits. No sidebar entry on purpose;
this is test-quality and meant to be deleted when the real billing
UI ships.

What's there:

  * Balance card (GET /balance)
  * Stripe-success polling banner — visible only when ?session_id=
    is in the URL (Stripe substitutes it into checkout_success_url
    on its way back). React Query refetchInterval polls every 2s
    until the topup status reaches credited / failed / canceled,
    then a 'Clear from URL' button calls navigation.replace(pathname).
  * Buy section: server-authoritative price tier buttons (GET
    /price-tiers) → POST /checkout-sessions → window.location to the
    Stripe URL. We do NOT hard-code amounts on the frontend; tier
    config lives in cloud's billing.price_tiers.
  * Stripe Billing Portal button (POST /portal-sessions). Opens in a
    new tab so the originating page stays put for easy verification.
    Documented behaviour: 400 is expected for users with no Stripe
    customer record yet.
  * Three lists: transactions / batches / topups.

Plumbing:

  * packages/core/types/billing.ts — interfaces mirroring the cloud
    response shapes. Status / source / tx_type fields are typed
    'string' rather than enum unions to match the schemas' z.string()
    parsing (same convention as CloudRuntimeNode); the canonical
    enum values are exported as separate type aliases for callers
    that want to switch on them.
  * packages/core/api/schemas.ts — 9 zod schemas + 7 EMPTY_ fallbacks,
    all .loose() so a non-breaking cloud-side field addition doesn't
    crash the parser.
  * packages/core/api/client.ts — 8 methods using parseWithFallback,
    matching the existing cloud-runtime shape.
  * packages/core/billing/{queries,mutations,index}.ts — React Query
    queryOptions + mutations. Notable choices: balance / lists are
    NOT keyed on workspace (account-level data), and the
    checkout-session polling stops automatically when status is
    terminal so we don't poll forever after a user closes the tab.
  * packages/core/package.json + packages/views/package.json — exports
    map updated for @multica/core/billing and @multica/views/billing.

Verification:

  * pnpm --filter @multica/core typecheck clean
  * pnpm --filter @multica/views typecheck — only pre-existing
    hast-util-to-html error in editor code (exists on main)
  * pnpm --filter @multica/core test — 412 passing
  * pnpm --filter @multica/views test — 877 passing, 1 failure
    (editor/readonly-content) is also pre-existing on main, not
    caused by this change

Out of scope: real production-quality billing UI; sidebar entry; i18n
strings; mobile app. This is a single test page; it gets replaced
when the real UI ships.

* fix(billing): refetch balance/lists when checkout polling reaches terminal

Closes the second-half of the Stripe-return race the previous commit
left dangling.

Symptom:
  After Stripe redirects back with ?session_id=..., the banner polls
  /checkout-sessions/{id} every 2s and the rest of the page (balance,
  transactions, batches, topups) is fetched once on mount. The
  webhook race means those four queries usually see pre-credit state
  — but the banner is the only thing that keeps polling, so once it
  reads 'credited' nothing else on the page knows. The user would
  see 'Final status: credited' next to a stale balance card until
  they manually refresh.

Fix:
  Add useInvalidateBillingDataAfterCredit() in @multica/core/billing —
  a hook returning a callback that flushes balance / transactions /
  batches / topups (NOT the checkout-session itself; its
  refetchInterval already terminated, refetching would just confirm
  the same value). The Stripe-success banner runs this callback in
  a useEffect keyed on terminal-status transition, so it fires
  exactly once when the polling lands.

  Strict scope is documented in the hook's JSDoc:
    - balance/transactions/batches: only change at the 'credited'
      transition (cloud writes ledger + batch + wallet in one DB tx)
    - topups: changes on every terminal transition
    - For 'failed' / 'canceled' we technically over-fetch the first
      three; three cheap round-trips, simplifies the call site, fine
      on a test page.

  Effect dep is . terminal flips false→true at most once
  per session id (the polling stops when terminal is true so the
  data won't change again). If the user lands here with a session
  that is already terminal (re-opened tab on a credited URL), the
  effect still fires on first data load and we still re-fetch —
  correct, the cached snapshot is just as stale in that case.

go build / pnpm typecheck / pnpm test clean (core 412 passing; only
pre-existing hast-util-to-html error in unrelated editor code on
views, same as on main).
2026-05-28 16:48:04 +08:00

80 lines
3.5 KiB
TypeScript

import { useCallback } from "react";
import { useMutation, useQueryClient } from "@tanstack/react-query";
import { api } from "../api";
import type { CreateBillingCheckoutSessionRequest } from "../types";
import { billingKeys } from "./queries";
// Both mutations here trigger a hop OUT of the SPA — Stripe Checkout
// and Stripe Billing Portal are hosted pages. The mutation completes
// once the URL is in our hands; the caller is responsible for the
// `window.location.href = url` redirect (or in newer flows,
// `window.open` + tab-aware polling).
//
// We invalidate the topup list on settle so when the user returns
// from Stripe the new `pending` order shows up immediately. The
// balance and transactions are NOT invalidated here — they only flip
// after Stripe + the cloud webhook actually credit, which is a
// post-redirect concern.
export function useCreateCloudBillingCheckoutSession() {
const qc = useQueryClient();
return useMutation({
mutationFn: (data: CreateBillingCheckoutSessionRequest) =>
api.createCloudBillingCheckoutSession(data),
onSettled: () => {
// The new pending topup row is visible to the topups list as
// soon as Cloud writes it. Invalidate so the user sees the new
// pending entry without a page refresh.
qc.invalidateQueries({ queryKey: [...billingKeys.all(), "topups"] });
},
});
}
export function useCreateCloudBillingPortalSession() {
return useMutation({
mutationFn: () => api.createCloudBillingPortalSession(),
// No cache invalidation — the portal opens, the user does whatever,
// and any state changes Stripe-side propagate back via webhook.
// The next React Query refetch picks them up at its own cadence.
});
}
/**
* useInvalidateBillingDataAfterCredit returns a callback that flushes
* the cached balance / transactions / batches / topups so the page
* re-fetches them. Used by the Stripe-success polling banner: once it
* detects the topup status flipped to a terminal value (credited /
* failed / canceled), the banner is the only query that's been
* polling — every other card on the page is still showing its
* pre-checkout snapshot. Without this invalidation the user sees
* "Final status: credited" while the balance card still displays the
* old number until they click refresh.
*
* Scope of the invalidation:
*
* - balance + transactions + batches: only ever change at the
* `credited` transition (the cloud writes the credit ledger and
* batch row in the same DB transaction as the wallet update).
* For `failed` / `canceled` they do NOT change, so technically we
* over-fetch in those cases — three extra cheap round-trips that
* simplify the call site and are negligible on a test page.
*
* - topups: changes on every terminal transition (the order row
* flips status), so it always needs invalidating.
*
* - the checkout-session query itself is intentionally NOT in this
* sweep. Its `refetchInterval` already returned `false` when
* status went terminal; refetching would just confirm the same
* value we already hold and wake the polling cycle back up for
* no benefit.
*/
export function useInvalidateBillingDataAfterCredit() {
const qc = useQueryClient();
return useCallback(() => {
qc.invalidateQueries({ queryKey: billingKeys.balance() });
qc.invalidateQueries({ queryKey: [...billingKeys.all(), "transactions"] });
qc.invalidateQueries({ queryKey: [...billingKeys.all(), "batches"] });
qc.invalidateQueries({ queryKey: [...billingKeys.all(), "topups"] });
}, [qc]);
}