@12-apps/payments-frontend 3.2.2 → 3.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@12-apps/payments-frontend",
-  "version": "3.2.2",
+  "version": "3.2.4",
   "type": "module",
   "description": "Browser half of the vendor-agnostic payments platform: plug-and-play MUI components for the per-provider settings page (credential form from each provider's schema, masked hints, verify/enable) and the checkout page (PIX QR + polling, card tokenization, hosted-checkout redirect), plus the headless hooks and fetch clients they build on. Talks only to the host's payments HTTP surface — never to a provider directly. Microfrontend-ready: no app coupling, host injects theme and auth.",
   "exports": {

package/src/components/checkout/checkout-flow.tsx

@@ -197,6 +197,7 @@ function CheckoutFlowBody(props: Omit<CheckoutFlowProps, "components">): JSX.Ele
           onRegenerate={() => { c.setStep("payment"); void c.startPayment("PIX"); }}
           onBackToMenu={c.goToMenu}
           paidExtra={confirmationExtra}
+          awaitingTimedOut={c.resumeTimedOut}
         />
       ) : null}
     </Box>

package/src/components/checkout/hosted-return.ts

@@ -70,13 +70,24 @@ function isReturnTrip(): boolean {
  * take the order.
  */
 export function hostedCheckoutReturnPending(tenantSlug?: string): boolean {
-  if (isReturnTrip()) return true;
   const parked = readParked();
-  if (!parked) return false;
-  // Same two questions the resume asks, so a gate and the flow behind it can
-  // never disagree: another store's hand-off is not this route's business, and
+  // THE PARKED ENTRY DECIDES whenever there is one — the same two questions the
+  // resume asks, so a gate and the flow behind it cannot disagree about whose
+  // return this is. Another store's hand-off is not this route's business, and
   // a stale one is nobody's.
-  return belongsHere(parked, tenantSlug) && !isStale(parked);
+  //
+  // Asking the URL FIRST is what this used to do, and it made the two disagree
+  // exactly where it costs something: a provider marker is per-TAB, so store
+  // A's abandoned hand-off plus any marked URL had the gate answer "a return is
+  // pending here" on store B while `takeHostedOrder` correctly refused to
+  // resume it. A gate that stands aside for a return that is not going to
+  // happen is a gate that has been talked out of its job.
+  if (parked) return belongsHere(parked, tenantSlug) && !isStale(parked);
+  // Nothing parked, so the provider's own marker is the only evidence left that
+  // a return is in progress. It is kept, and only here, for the case that has
+  // no other signal: the flow has already CONSUMED the entry, and a gate
+  // re-asking mid-visit must not curtain the confirmation it just let through.
+  return isReturnTrip();
 }
 
 /**

package/src/components/checkout/payment-status.tsx

@@ -66,6 +66,28 @@ const OUTCOME: Record<OrderStatus, Outcome> = {
   },
 };
 
+/**
+ * What the screen says once it has stopped asking (FUT-556).
+ *
+ * NOT an `OrderStatus`: the order really is still AWAITING_PAYMENT and may yet
+ * settle — the scheduled reconciliation keeps asking the provider long after
+ * this tab is gone. What ran out is the WAIT, not the order, and saying
+ * otherwise would be the more expensive lie: a buyer told "não concluído" who
+ * has in fact paid will either pay twice or call the store.
+ *
+ * So it leads with what is true and unglamorous — we have not heard yet — and
+ * spends its remaining words on the one instruction that matters, which is not
+ * to pay again.
+ */
+const AWAITING_TIMED_OUT: Outcome = {
+  heading: "Ainda não recebemos a confirmação",
+  support:
+    "Se você já pagou, o pedido é confirmado assim que a operadora avisar — " +
+    "não pague de novo. Você pode fechar esta tela.",
+  icon: <ScheduleIcon fontSize="large" />,
+  tone: "warning",
+};
+
 const TONE_COLOR: Record<Outcome["tone"], string> = {
   success: "success.main",
   danger: "error.main",
@@ -86,14 +108,29 @@ function orderReference(orderId: string): string {
 }
 
 /** The headline block: icon, outcome, and one supporting line. */
-function OutcomeHero({ status }: { status: OrderStatus }): JSX.Element {
+function OutcomeHero({
+  status,
+  timedOut = false,
+}: {
+  status: OrderStatus;
+  timedOut?: boolean;
+}): JSX.Element {
   const { Text } = useCheckoutComponents();
-  const outcome = OUTCOME[status];
+  const outcome = timedOut && status === "AWAITING_PAYMENT" ? AWAITING_TIMED_OUT : OUTCOME[status];
   return (
     <Box
       // `payment-paid` is load-bearing for the storefront journeys — it is how
-      // they assert the buyer actually got there.
-      data-testid={status === "PAID" ? "payment-paid" : `payment-${status.toLowerCase()}`}
+      // they assert the buyer actually got there. The timed-out wait gets its
+      // OWN id rather than reusing `payment-awaiting_payment`: a test that
+      // cannot tell "still asking" from "stopped asking" is a test that would
+      // pass against the unbounded spinner this replaced.
+      data-testid={
+        timedOut && status === "AWAITING_PAYMENT"
+          ? "payment-awaiting-timeout"
+          : status === "PAID"
+            ? "payment-paid"
+            : `payment-${status.toLowerCase()}`
+      }
       sx={{ display: "flex", flexDirection: "column", alignItems: "center", gap: 1, textAlign: "center" }}
     >
       <Box sx={{ color: TONE_COLOR[outcome.tone], display: "flex" }}>{outcome.icon}</Box>
@@ -206,6 +243,7 @@ export function PaymentStatus({
   onRegenerate,
   onBackToMenu,
   paidExtra,
+  awaitingTimedOut = false,
 }: {
   status: OrderStatus | null;
   totalLabel: string;
@@ -223,6 +261,12 @@ export function PaymentStatus({
    * is the difference between an offer and an interruption.
    */
   paidExtra?: ReactNode;
+  /**
+   * The wait has been given up on — see {@link AWAITING_TIMED_OUT}. Only
+   * meaningful while AWAITING_PAYMENT; every other status has already resolved,
+   * so a stale flag cannot change what a settled screen says.
+   */
+  awaitingTimedOut?: boolean;
 }): JSX.Element {
   const { LoadingState } = useCheckoutComponents();
   const effective: OrderStatus = status ?? "AWAITING_PAYMENT";
@@ -231,9 +275,10 @@ export function PaymentStatus({
     <Box
       data-testid="payment-status"
       data-status={effective}
+      data-timed-out={awaitingTimedOut ? "true" : undefined}
       sx={{ display: "flex", flexDirection: "column", gap: 3, alignItems: "stretch", py: 2 }}
     >
-      <OutcomeHero status={effective} />
+      <OutcomeHero status={effective} timedOut={awaitingTimedOut} />
 
       {effective === "PAID" ? (
         <PaidFacts totalLabel={totalLabel} orderId={orderId} buyerEmail={buyerEmail} />
@@ -241,7 +286,7 @@ export function PaymentStatus({
 
       {effective === "PAID" ? paidExtra : null}
 
-      {effective === "AWAITING_PAYMENT" ? (
+      {effective === "AWAITING_PAYMENT" && !awaitingTimedOut ? (
         <LoadingState variant="spinner" size="md" message="" dataTestId="payment-pending" />
       ) : null}
 

package/src/components/checkout/use-checkout-controller.ts

@@ -174,6 +174,44 @@ function handOverToProvider(
   return true;
 }
 
+/**
+ * How long the resumed screen keeps asking, and how often.
+ *
+ * TWO RATES, because one rate cannot serve this wait. The interval decides two
+ * things that pull opposite ways: how fast a buyer WHO PAID is told so, and
+ * what an abandoned checkout costs for the rest of the window. Every poll is a
+ * provider round trip, so a slow rate is cheap and leaves a paying buyer
+ * watching a spinner seconds longer than they need to — and the person on this
+ * screen has almost always paid. A single number picks one of them to lose;
+ * this shipped at a flat 5 s and picked the wrong one.
+ *
+ * So: 2.5 s for the first two minutes, which is where essentially every real
+ * webhook lands (it fires within seconds of the payment, and this rate matches
+ * what card and PIX already use), then 10 s for the remaining thirteen. A
+ * confirmation is at most 2.5 s late, and an abandoned checkout costs ~126
+ * polls instead of the 360 a flat 2.5 s would have.
+ *
+ * The three constants are ONE decision — 48 × 2.5 s + 78 × 10 s ≈ 15 min — so
+ * the cap is derived rather than typed, and cannot drift from the comment.
+ *
+ * Fifteen minutes because by then a webhook that was ever coming has come. Past
+ * that the answer will not change while the buyer watches: the scheduled
+ * reconciliation is what rescues a genuinely late one, and it does that whether
+ * the tab is open or not.
+ *
+ * The card wait is bounded at 90 s (`CARD_AWAITING_POLL_CAP`) because a card
+ * authorises inline and a buyer is holding their phone. This leg is the other
+ * shape: the buyer has already been off to another site and back, and may
+ * legitimately still be finishing there.
+ */
+const HOSTED_RESUME_FAST_MS = 2_500;
+const HOSTED_RESUME_SLOW_MS = 10_000;
+/** Two minutes at the fast rate, before the wait is worth economising on. */
+const HOSTED_RESUME_FAST_POLLS = (2 * 60_000) / HOSTED_RESUME_FAST_MS;
+/** Thirteen more at the slow one — 15 minutes all told. */
+const HOSTED_RESUME_POLL_CAP =
+  HOSTED_RESUME_FAST_POLLS + (13 * 60_000) / HOSTED_RESUME_SLOW_MS;
+
 /**
  * The leg of checkout that resumes after a hosted provider sent the buyer back
  * (FUT-556).
@@ -182,14 +220,29 @@ function handOverToProvider(
  * parked copy — once, on first render — and polled here rather than in a PIX or
  * card view, because a redirect provider produced neither. The webhook is still
  * what settles the order; this only tells the buyer that it did.
+ *
+ * And it stops telling them eventually. This poll was the one unbounded wait
+ * left in checkout — card and wallet both cap theirs — so a buyer who came back
+ * from a payment they never completed got "Confirmando seu pagamento… isso
+ * costuma levar alguns segundos" and a spinner, truthfully forever. The screen
+ * had no way to reach a terminal state, because the ORDER has none: expiry is
+ * PIX-only, and a redirect charge carries no QR window to lapse. `timedOut` is
+ * what the screen says instead of spinning.
  */
 function useHostedResume(tenantSlug?: string): {
   order: CheckoutOrder | null;
   status: OrderStatus | null;
+  timedOut: boolean;
 } {
   const [order] = useState(() => takeHostedOrder(tenantSlug));
-  const { status } = usePaymentPolling(order?.orderId ?? null, { enabled: Boolean(order) });
-  return { order, status };
+  const { status, timedOut } = usePaymentPolling(order?.orderId ?? null, {
+    enabled: Boolean(order),
+    intervalMs: HOSTED_RESUME_FAST_MS,
+    slowAfterPolls: HOSTED_RESUME_FAST_POLLS,
+    slowIntervalMs: HOSTED_RESUME_SLOW_MS,
+    maxHealthyPolls: HOSTED_RESUME_POLL_CAP,
+  });
+  return { order, status, timedOut };
 }
 
 /**
@@ -328,6 +381,10 @@ export function useCheckoutController(
   return {
     step, setStep, method, setMethod, buyer, setBuyer, saveProfile, setSaveProfile,
     order, finalStatus: finalStatus ?? resume.status, creating,
+    // Only ever true on the resumed leg: `useHostedResume` is the sole caller
+    // that caps its polls, and a buyer who never left has a card or PIX view
+    // reporting its own wait.
+    resumeTimedOut: resume.timedOut,
     createError: failure.message, errorField: failure.field, errorCode: failure.code,
     goToMenu: onExitToMenu, back, editBuyer,
     goToPayment, startPayment, payWithEmail, handleResolved, retry, completed,

package/src/components/checkout/use-payment-polling.ts

@@ -14,11 +14,45 @@ interface PollingOptions {
    * Undefined ⇒ unbounded, today's behavior (the PIX consumer passes no cap).
    */
   maxHealthyPolls?: number;
+  /**
+   * Opt-in BACKOFF: after this many healthy polls, keep asking at
+   * {@link slowIntervalMs} instead of {@link intervalMs}.
+   *
+   * A single interval cannot serve a long wait, because the two things it
+   * decides pull opposite ways. It is how fast a buyer WHO PAID learns that
+   * they did — every poll is a provider round trip, and the answer lands within
+   * seconds of the webhook — and it is also what an abandoned checkout costs
+   * for the rest of the window. Tuning one picks the other's loser: a slow
+   * interval taxes the common case (the person on this screen almost always
+   * paid) to subsidise the rare one.
+   *
+   * Splitting them costs neither. Both must be set for backoff to apply.
+   */
+  slowAfterPolls?: number;
+  slowIntervalMs?: number;
 }
 
 /** Consecutive poll errors tolerated before giving up (avoids an infinite spinner). */
 const MAX_POLL_ERRORS = 4;
 
+/**
+ * How long before the next ask, given how many healthy polls have happened.
+ *
+ * A pure function of the options, so it lives out here rather than inside the
+ * effect — the hook is at its size gate, and a scheduling RULE is easier to
+ * read (and to test) stated once than threaded through a closure.
+ *
+ * Reads the count AFTER the poll just made, so the slow phase begins on the
+ * poll FOLLOWING the threshold rather than one early: a wait described as "N
+ * fast polls" has to actually make N of them.
+ */
+function pollDelay(healthy: number, options: PollingOptions): number {
+  const { intervalMs = 2500, slowAfterPolls, slowIntervalMs } = options;
+  const backingOff =
+    slowAfterPolls !== undefined && slowIntervalMs !== undefined && healthy >= slowAfterPolls;
+  return backingOff ? slowIntervalMs : intervalMs;
+}
+
 /**
  * Poll an order's payment status until it reaches a terminal state.
  *
@@ -29,7 +63,13 @@ const MAX_POLL_ERRORS = 4;
  */
 export function usePaymentPolling(
   orderId: string | null,
-  { intervalMs = 2500, enabled = true, maxHealthyPolls }: PollingOptions = {},
+  {
+    intervalMs = 2500,
+    enabled = true,
+    maxHealthyPolls,
+    slowAfterPolls,
+    slowIntervalMs,
+  }: PollingOptions = {},
 ): { status: OrderStatus | null; error: string | null; timedOut: boolean } {
   const [status, setStatus] = useState<OrderStatus | null>(null);
   const [error, setError] = useState<string | null>(null);
@@ -80,7 +120,7 @@ export function usePaymentPolling(
       }
       timer = setTimeout(() => {
         void tick();
-      }, intervalMs);
+      }, pollDelay(healthyCount, { intervalMs, slowAfterPolls, slowIntervalMs }));
     };
 
     void tick();
@@ -91,7 +131,7 @@ export function usePaymentPolling(
         clearTimeout(timer);
       }
     };
-  }, [orderId, intervalMs, enabled, maxHealthyPolls, client]);
+  }, [orderId, intervalMs, enabled, maxHealthyPolls, slowAfterPolls, slowIntervalMs, client]);
 
   return { status, error, timedOut };
 }

package/src/flows/copy.ts

@@ -35,6 +35,18 @@ export interface CheckoutCopyFE {
   returnPending: string;
   /** The return leg when nothing was parked — the buyer came back to nothing. */
   returnUnknown: string;
+  /**
+   * The return leg once the bounded wait elapsed and the screen stopped asking
+   * (FUT-556) — say that nothing has arrived yet and, above all, not to pay
+   * again.
+   *
+   * OPTIONAL, so adopting a version with the bound is not a breaking change for
+   * a host that has not written the sentence yet. The BOUND itself applies
+   * either way: with no copy the screen still stops spinning and falls back to
+   * `returnPending` as a warning, which is the honest half. The words are the
+   * part only a host can own.
+   */
+  returnTimedOut?: string;
   /** Nothing to check out (cart mode only). */
   emptyCartTitle: string;
   emptyCartAction: string;

package/src/flows/screens-hosted.tsx

@@ -96,6 +96,26 @@ function buildHostedHandoff(runtime: FlowsRuntime): CheckoutScreens["HostedHando
   };
 }
 
+/**
+ * How long this screen keeps asking, and how often — see the twin constants in
+ * `use-checkout-controller.ts`, which bounds the same wait for the components
+ * layer. 2.5 s for two minutes, then 10 s for thirteen: 126 polls, 15 minutes.
+ *
+ * Two rates because one cannot serve both ends of this wait — a paying buyer
+ * learns within 2.5 s, an abandoned checkout costs a third of what a flat fast
+ * rate would. The reasoning is on the twin constants.
+ *
+ * Stated here rather than imported because the two waits are the same DECISION
+ * arrived at twice, not one shared implementation: this screen takes its FAST
+ * interval from the host's `polling` config when there is one, and a host that
+ * tunes that must not have this package's cap silently mean a different
+ * wall-clock window than the constant's comment claims.
+ */
+const RETURN_FAST_MS = 2_500;
+const RETURN_SLOW_MS = 10_000;
+const RETURN_FAST_POLLS = (2 * 60_000) / RETURN_FAST_MS;
+const RETURN_POLL_CAP = RETURN_FAST_POLLS + (13 * 60_000) / RETURN_SLOW_MS;
+
 function buildHostedReturn(runtime: FlowsRuntime): CheckoutScreens["HostedReturn"] {
   function HostedReturnBody({
     onResolved,
@@ -106,9 +126,15 @@ function buildHostedReturn(runtime: FlowsRuntime): CheckoutScreens["HostedReturn
     // Read-and-clear, once, on first render: the resumed view belongs to
     // exactly one return trip.
     const [parked] = useState(takeHostedOrder);
-    const { status } = usePaymentPolling(parked?.orderId ?? null, {
+    // Bounded, for the reason on RETURN_POLL_CAP: nothing here can ever reach a
+    // terminal state on its own, so an unbounded poll is a spinner the buyer
+    // watches until they close the tab.
+    const { status, timedOut } = usePaymentPolling(parked?.orderId ?? null, {
       enabled: Boolean(parked),
-      intervalMs: runtime.config.polling?.intervalMs,
+      intervalMs: runtime.config.polling?.intervalMs ?? RETURN_FAST_MS,
+      slowAfterPolls: RETURN_FAST_POLLS,
+      slowIntervalMs: RETURN_SLOW_MS,
+      maxHealthyPolls: RETURN_POLL_CAP,
     });
 
     useEffect(() => {
@@ -126,6 +152,21 @@ function buildHostedReturn(runtime: FlowsRuntime): CheckoutScreens["HostedReturn
         />
       );
     }
+    if (timedOut) {
+      return (
+        <Box data-testid="checkout-hosted-return" sx={{ py: 4 }}>
+          <Alert
+            variant="warning"
+            title={runtime.copy.returnPending}
+            {...(runtime.copy.returnTimedOut === undefined
+              ? {}
+              : { description: runtime.copy.returnTimedOut })}
+            showIcon
+            data-testid="checkout-hosted-return-timeout"
+          />
+        </Box>
+      );
+    }
     return (
       <Box data-testid="checkout-hosted-return" sx={{ py: 4 }}>
         <LoadingState