Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Adding holding period selection to payout settings (#4452)

Marcus Farrell382882a86069
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-holding-periods.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-holding-periods.tsx
new file mode 100644
index 0000000000..756a83c4b6
--- /dev/null
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-holding-periods.tsx
@@ -0,0 +1,370 @@
+"use client";
+
+import { PAYOUT_HOLDING_PERIOD_DAYS } from "@/lib/constants/payouts";
+import useWorkspace from "@/lib/swr/use-workspace";
+import { GroupProps } from "@/lib/types";
+import { DEFAULT_PARTNER_GROUP } from "@/lib/zod/schemas/groups";
+import { GroupColorCircle } from "@/ui/partners/groups/group-color-circle";
+import { MarkdownDescription } from "@/ui/shared/markdown-description";
+import { StatusBadge, Switch } from "@dub/ui";
+import { ChevronDown } from "lucide-react";
+import Link from "next/link";
+import { useCallback, useMemo, useState } from "react";
+
+export type HoldingPeriodGroup = Pick<
+ GroupProps,
+ "id" | "name" | "slug" | "color" | "holdingPeriodDays"
+>;
+
+// A PATCH /api/groups/[groupId] payload that Save needs to send
+export type HoldingPeriodUpdate = {
+ groupId: string;
+ holdingPeriodDays: number;
+ applyToAllGroups?: boolean;
+};
+
+type AllGroupsState = { enabled: false } | { enabled: true; days: number };
+
+const HOLDING_PERIOD_DESCRIPTION =
+ "[Set how long to hold funds](https://dub.co/help/article/partner-payouts#payout-holding-period) before they are eligible for payout. 30 days is recommended.";
+
+// Scroll distance (px) over which the top/bottom fades go from hidden to fully visible
+const FADE_SCROLL_DISTANCE = 40;
+
+/**
+ * Stages holding period edits (per group, or one value for all groups) until
+ * the payout settings form is saved. Nothing here touches the API.
+ */
+export function useProgramHoldingPeriods(
+ groups: HoldingPeriodGroup[] | undefined,
+) {
+ // Per-group edits keyed by group ID; only holds values that differ from the saved value
+ const [overrides, setOverrides] = useState<Record<string, number>>({});
+
+ // null = untouched, so the switch reflects the saved data (on when every group already shares one value)
+ const [allGroups, setAllGroups] = useState<AllGroupsState | null>(null);
+
+ // Always list the default group first
+ const sortedGroups = useMemo(() => {
+ if (!groups) return [];
+
+ const defaultGroup = groups.find(
+ (group) => group.slug === DEFAULT_PARTNER_GROUP.slug,
+ );
+
+ return defaultGroup
+ ? [defaultGroup, ...groups.filter((group) => group !== defaultGroup)]
+ : groups;
+ }, [groups]);
+
+ const defaultGroup: HoldingPeriodGroup | undefined = sortedGroups[0];
+
+ const getHoldingPeriodDays = useCallback(
+ (group: HoldingPeriodGroup) =>
+ overrides[group.id] ?? group.holdingPeriodDays,
+ [overrides],
+ );
+
+ const setGroupHoldingPeriodDays = useCallback(
+ (group: HoldingPeriodGroup, days: number) =>
+ setOverrides((prev) => {
+ const next = { ...prev };
+
+ if (days === group.holdingPeriodDays) {
+ delete next[group.id];
+ } else {
+ next[group.id] = days;
+ }
+
+ return next;
+ }),
+ [],
+ );
+
+ const savedValuesMatch =
+ sortedGroups.length > 1 &&
+ sortedGroups.every(
+ (group) => group.holdingPeriodDays === sortedGroups[0].holdingPeriodDays,
+ );
+
+ const allGroupsEnabled = allGroups ? allGroups.enabled : savedValuesMatch;
+
+ const allGroupsDays = allGroups?.enabled
+ ? allGroups.days
+ : defaultGroup?.holdingPeriodDays ?? PAYOUT_HOLDING_PERIOD_DAYS[0];
+
+ // Switching on starts from the default group's current value; switching off
+ // restores the per-group values (including any unsaved per-group edits)
+ const setAllGroupsEnabled = useCallback(
+ (enabled: boolean) =>
+ setAllGroups(
+ enabled && defaultGroup
+ ? { enabled: true, days: getHoldingPeriodDays(defaultGroup) }
+ : { enabled: false },
+ ),
+ [defaultGroup, getHoldingPeriodDays],
+ );
+
+ const setAllGroupsDays = useCallback(
+ (days: number) => setAllGroups({ enabled: true, days }),
+ [],
+ );
+
+ const pendingUpdates = useMemo<HoldingPeriodUpdate[]>(() => {
+ if (allGroupsEnabled) {
+ const needsUpdate = sortedGroups.some(
+ (group) => group.holdingPeriodDays !== allGroupsDays,
+ );
+
+ return needsUpdate && defaultGroup
+ ? [
+ {
+ groupId: defaultGroup.id,
+ holdingPeriodDays: allGroupsDays,
+ applyToAllGroups: true,
+ },
+ ]
+ : [];
+ }
+
+ return sortedGroups.flatMap((group) => {
+ const days = overrides[group.id];
+
+ return days !== undefined && days !== group.holdingPeriodDays
+ ? [{ groupId: group.id, holdingPeriodDays: days }]
+ : [];
+ });
+ }, [allGroupsEnabled, allGroupsDays, defaultGroup, sortedGroups, overrides]);
+
+ return {
+ sortedGroups,
+ getHoldingPeriodDays,
+ setGroupHoldingPeriodDays,
+ allGroupsEnabled,
+ allGroupsDays,
+ setAllGroupsEnabled,
+ setAllGroupsDays,
+ pendingUpdates,
+ };
+}
+
+export type ProgramHoldingPeriods = ReturnType<typeof useProgramHoldingPeriods>;
+
+export function ProgramPayoutHoldingPeriods({
+ loading,
+ holdingPeriods,
+}: {
+ loading: boolean;
+ holdingPeriods: ProgramHoldingPeriods;
+}) {
+ const {
+ sortedGroups,
+ getHoldingPeriodDays,
+ setGroupHoldingPeriodDays,
+ allGroupsEnabled,
+ allGroupsDays,
+ setAllGroupsEnabled,
+ setAllGroupsDays,
+ } = holdingPeriods;
+
+ return (
+ <div className="space-y-3">
+ <div>
+ <h4 className="text-base font-semibold leading-6 text-neutral-900">
+ Payout holding period
+ </h4>
+ <MarkdownDescription className="text-sm font-medium text-neutral-500">
+ {HOLDING_PERIOD_DESCRIPTION}
+ </MarkdownDescription>
+ </div>
+
+ <label className="flex w-fit cursor-pointer select-none items-center gap-3 py-1">
+ <Switch
+ checked={allGroupsEnabled}
+ fn={setAllGroupsEnabled}
+ disabled={loading}
+ />
+ <span className="text-sm font-medium text-neutral-900">
+ Use one holding period for all groups
+ </span>
+ </label>
+
+ {allGroupsEnabled ? (
+ <div className="flex h-11 items-center justify-between gap-4 rounded-lg border border-neutral-200 bg-white px-4">
+ <div className="flex min-w-0 items-center gap-2">
+ <div className="flex -space-x-1">
+ {sortedGroups.slice(0, 3).map((group) => (
+ <div key={group.id} className="rounded-full ring-2 ring-white">
+ <GroupColorCircle group={group} />
+ </div>
+ ))}
+ </div>
+ <span className="text-sm font-medium text-neutral-700">
+ All groups
+ </span>
+ <span className="rounded-md bg-neutral-100 px-1.5 py-0.5 text-xs font-semibold text-neutral-700">
+ {sortedGroups.length}
+ </span>
+ </div>
+
+ <HoldingPeriodSelect
+ label="all groups"
+ value={allGroupsDays}
+ onChange={setAllGroupsDays}
+ />
+ </div>
+ ) : (
+ <HoldingPeriodsTable
+ groups={sortedGroups}
+ loading={loading}
+ getHoldingPeriodDays={getHoldingPeriodDays}
+ onHoldingPeriodDaysChange={setGroupHoldingPeriodDays}
+ />
+ )}
+ </div>
+ );
+}
+
+function HoldingPeriodsTable({
+ groups,
+ loading,
+ getHoldingPeriodDays,
+ onHoldingPeriodDaysChange,
+}: {
+ groups: HoldingPeriodGroup[];
+ loading: boolean;
+ getHoldingPeriodDays: (group: HoldingPeriodGroup) => number;
+ onHoldingPeriodDaysChange: (group: HoldingPeriodGroup, days: number) => void;
+}) {
+ const { slug: workspaceSlug } = useWorkspace();
+
+ const [fades, setFades] = useState({ top: 0, bottom: 0 });
+
+ const updateFades = useCallback((el: HTMLElement) => {
+ const maxScrollTop = el.scrollHeight - el.clientHeight;
+ const top = Math.min(el.scrollTop / FADE_SCROLL_DISTANCE, 1);
+ const bottom =
+ maxScrollTop <= 0
+ ? 0
+ : Math.min((maxScrollTop - el.scrollTop) / FADE_SCROLL_DISTANCE, 1);
+
+ setFades((prev) =>
+ prev.top === top && prev.bottom === bottom ? prev : { top, bottom },
+ );
+ }, []);
+
+ // Callback ref (rather than an effect): measures once the container mounts and
+ // whenever it or its rows resize, e.g. when the skeleton is replaced by groups
+ const scrollRef = useCallback(
+ (el: HTMLDivElement | null) => {
+ if (!el) return;
+
+ const observer = new ResizeObserver(() => updateFades(el));
+ observer.observe(el);
+ if (el.firstElementChild) observer.observe(el.firstElementChild);
+
+ return () => observer.disconnect();
+ },
+ [updateFades],
+ );
+
+ return (
+ <div className="relative overflow-hidden rounded-lg border border-neutral-200 bg-white">
+ <div
+ ref={scrollRef}
+ onScroll={(e) => updateFades(e.currentTarget)}
+ className="scrollbar-hide max-h-[268px] overflow-y-auto [clip-path:inset(0)]"
+ >
+ <div className="divide-y divide-neutral-200">
+ {loading
+ ? [...Array(3)].map((_, idx) => (
+ <div
+ key={idx}
+ className="flex h-11 items-center justify-between px-4"
+ >
+ <div className="h-4 w-32 animate-pulse rounded-md bg-neutral-200" />
+ <div className="h-4 w-16 animate-pulse rounded-md bg-neutral-200" />
+ </div>
+ ))
+ : groups.map((group) => (
+ <div
+ key={group.id}
+ className="flex h-11 items-center justify-between gap-4 px-4"
+ >
+ <div className="flex min-w-0 items-center gap-2">
+ <Link
+ href={`/${workspaceSlug}/program/groups/${group.slug}/settings`}
+ target="_blank"
+ className="flex min-w-0 items-center gap-2 rounded-md text-sm font-medium text-neutral-700 transition-colors hover:text-neutral-900 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-neutral-500"
+ >
+ <GroupColorCircle group={group} />
+ <span className="truncate">{group.name}</span>
+ </Link>
+ {group.slug === DEFAULT_PARTNER_GROUP.slug && (
+ <StatusBadge
+ variant="new"
+ icon={null}
+ className="px-1.5 py-0.5"
+ >
+ Default
+ </StatusBadge>
+ )}
+ </div>
+
+ <HoldingPeriodSelect
+ label={group.name}
+ value={getHoldingPeriodDays(group)}
+ onChange={(days) => onHoldingPeriodDaysChange(group, days)}
+ />
+ </div>
+ ))}
+ </div>
+ </div>
+
+ {/* Top scroll fade */}
+ <div
+ aria-hidden
+ className="pointer-events-none absolute inset-x-0 top-0 h-8 bg-gradient-to-b from-white to-transparent"
+ style={{ opacity: fades.top }}
+ />
+
+ {/* Bottom scroll fade */}
+ <div
+ aria-hidden
+ className="pointer-events-none absolute inset-x-0 bottom-0 h-20 bg-gradient-to-t from-white to-transparent"
+ style={{ opacity: fades.bottom }}
+ />
+ </div>
+ );
+}
+
+function HoldingPeriodSelect({
+ label,
+ value,
+ onChange,
+}: {
+ label: string;
+ value: number;
+ onChange: (days: number) => void;
+}) {
+ // The native <select> is stretched invisibly over the label so the closed
+ // state matches the design while still opening the system dropdown
+ return (
+ <div className="relative -mr-2 flex h-8 shrink-0 items-center gap-2 rounded-md px-2 text-sm text-neutral-800 transition-colors hover:bg-neutral-100 has-[:focus-visible]:ring-2 has-[:focus-visible]:ring-neutral-500">
+ <span aria-hidden>{value} days</span>
+ <ChevronDown className="size-3 text-neutral-600" aria-hidden />
+ <select
+ aria-label={`Payout holding period for ${label}`}
+ value={value}
+ onChange={(e) => onChange(Number(e.target.value))}
+ className="absolute inset-0 size-full cursor-pointer opacity-0"
+ >
+ {PAYOUT_HOLDING_PERIOD_DAYS.map((days) => (
+ <option key={days} value={days}>
+ {days} days{days === 30 ? " (recommended)" : ""}
+ </option>
+ ))}
+ </select>
+ </div>
+ );
+}
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-methods.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-methods.tsx
index f500cf61b6..2e7e034517 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-methods.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-methods.tsx
@@ -140,7 +140,7 @@ export function ProgramPayoutMethods() {
{program?.payoutMode !== "internal" && <ExternalPayoutMethods />}
{!paymentMethodsLoading && displayPaymentMethods.length === 0 && (
- <div className="flex flex-col items-center justify-center rounded-lg bg-neutral-50 py-6">
+ <div className="flex flex-col items-center justify-center rounded-xl bg-neutral-100 py-6">
<MoneyBill className="mb-2 size-6 text-neutral-900" />
<h3 className="text-content-emphasis text-xs font-semibold leading-4">
No payout methods
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-settings-sheet.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-settings-sheet.tsx
index 363e5b8f7f..1fc7b67b38 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-settings-sheet.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/program-payout-settings-sheet.tsx
@@ -7,18 +7,22 @@ import {
getAllowedMinPayoutAmounts,
} from "@/lib/constants/payouts";
import { mutatePrefix } from "@/lib/swr/mutate";
+import useGroups from "@/lib/swr/use-groups";
import useProgram from "@/lib/swr/use-program";
import useWorkspace from "@/lib/swr/use-workspace";
import { ProgramProps } from "@/lib/types";
-import { DEFAULT_PARTNER_GROUP } from "@/lib/zod/schemas/groups";
import { X } from "@/ui/shared/icons";
import { Button, Sheet, Slider } from "@dub/ui";
import NumberFlow from "@number-flow/react";
import { useAction } from "next-safe-action/hooks";
-import { useParams } from "next/navigation";
-import { Dispatch, SetStateAction, useEffect, useState } from "react";
+import { Dispatch, SetStateAction, useState } from "react";
import { useForm } from "react-hook-form";
import { toast } from "sonner";
+import {
+ HoldingPeriodUpdate,
+ ProgramPayoutHoldingPeriods,
+ useProgramHoldingPeriods,
+} from "./program-payout-holding-periods";
import { ProgramPayoutMethods } from "./program-payout-methods";
import { ProgramPayoutModeSection } from "./program-payout-mode-section";
@@ -33,7 +37,9 @@ function ProgramPayoutSettingsSheetContent({
}: ProgramPayoutSettingsSheetProps) {
const { id: workspaceId, defaultProgramId } = useWorkspace();
const { program } = useProgram();
- const params = useParams<{ slug: string }>();
+ const { groups, loading: groupsLoading } = useGroups({
+ query: { sortBy: "createdAt", sortOrder: "asc" },
+ });
const {
register,
@@ -43,34 +49,66 @@ function ProgramPayoutSettingsSheetContent({
formState: { isDirty, isValid, isSubmitting },
} = useForm<FormData>({
mode: "onBlur",
+ // Resets the form (and recomputes isDirty/isValid) once the program loads
+ values: program ? { minPayoutAmount: program.minPayoutAmount } : undefined,
});
- useEffect(() => {
- if (program) {
- setValue("minPayoutAmount", program.minPayoutAmount);
- }
- }, [program, setValue]);
+ // Holding period edits are staged until the form is saved
+ const holdingPeriods = useProgramHoldingPeriods(groups);
- const { executeAsync } = useAction(updateProgramAction, {
- onSuccess: async () => {
- toast.success("Payout settings updated successfully.");
- setIsOpen(false);
- mutatePrefix([`/api/programs/${defaultProgramId}`, `/api/groups`]);
- },
- onError: ({ error }) => {
- toast.error(parseActionError(error, "Failed to update payout settings."));
- },
- });
+ const { executeAsync } = useAction(updateProgramAction);
const onSubmit = async (data: FormData) => {
- if (!workspaceId) {
+ if (!workspaceId || !program) {
return;
}
- await executeAsync({
- workspaceId,
- ...data,
- });
+ const requests: Promise<void>[] = [];
+
+ if (data.minPayoutAmount !== program.minPayoutAmount) {
+ requests.push(
+ executeAsync({
+ workspaceId,
+ minPayoutAmount: data.minPayoutAmount,
+ }).then((result) => {
+ if (result?.serverError || result?.validationErrors) {
+ throw new Error(
+ parseActionError(
+ result,
+ "Failed to update minimum payout amount.",
+ ),
+ );
+ }
+ }),
+ );
+ }
+
+ requests.push(
+ ...holdingPeriods.pendingUpdates.map((update) =>
+ updateGroupHoldingPeriod({ workspaceId, ...update }),
+ ),
+ );
+
+ const results = await Promise.allSettled(requests);
+
+ // Refresh the program + groups even if a request failed, so the sheet reflects what was saved
+ await mutatePrefix([`/api/programs/${defaultProgramId}`, "/api/groups"]);
+
+ const failure = results.find(
+ (result): result is PromiseRejectedResult => result.status === "rejected",
+ );
+
+ if (failure) {
+ toast.error(
+ failure.reason instanceof Error
+ ? failure.reason.message
+ : "Failed to update payout settings.",
+ );
+ return;
+ }
+
+ toast.success("Payout settings updated successfully.");
+ setIsOpen(false);
};
const minPayoutAmount = watch("minPayoutAmount");
@@ -78,6 +116,8 @@ function ProgramPayoutSettingsSheetContent({
? getAllowedMinPayoutAmounts(workspaceId)
: ALLOWED_MIN_PAYOUT_AMOUNTS;
+ const hasChanges = isDirty || holdingPeriods.pendingUpdates.length > 0;
+
return (
<form onSubmit={handleSubmit(onSubmit)} className="flex h-full flex-col">
<div className="sticky top-0 z-10 border-b border-neutral-200 bg-white">
@@ -95,32 +135,9 @@ function ProgramPayoutSettingsSheetContent({
</div>
</div>
- <div className="h-full divide-y divide-neutral-200 bg-neutral-50 p-4 sm:p-6">
- {/* Payout holding period */}
- <div className="grid gap-3 pb-6">
- <div>
- <h4 className="text-base font-semibold leading-6 text-neutral-900">
- Payout holding period
- </h4>
- <p className="text-sm font-medium text-neutral-500">
- The payout holding period is now configurable on a group level.
- </p>
- </div>
- <a
- href={`/${params.slug}/program/groups/${DEFAULT_PARTNER_GROUP.slug}/settings`}
- target="_blank"
- >
- <Button
- type="button"
- variant="secondary"
- text="View default group settings ↗"
- className="h-8 w-full px-3"
- />
- </a>
- </div>
-
+ <div className="flex h-full flex-col gap-8 bg-neutral-50 p-4 sm:p-6">
{/* Minimum payout amount */}
- <div className="space-y-6 py-6">
+ <div className="space-y-6">
<div>
<h4 className="text-base font-semibold leading-6 text-neutral-900">
Minimum payout amount
@@ -170,15 +187,15 @@ function ProgramPayoutSettingsSheetContent({
</div>
{/* Payout methods */}
- <div className="py-6">
- <ProgramPayoutMethods />
- </div>
+ <ProgramPayoutMethods />
- {program?.payoutMode !== "internal" && (
- <div className="py-6">
- <ProgramPayoutModeSection />
- </div>
- )}
+ {program?.payoutMode !== "internal" && <ProgramPayoutModeSection />}
+
+ {/* Payout holding period */}
+ <ProgramPayoutHoldingPeriods
+ loading={groupsLoading}
+ holdingPeriods={holdingPeriods}
+ />
</div>
<div className="sticky bottom-0 z-10 border-t border-neutral-200 bg-white">
@@ -195,7 +212,7 @@ function ProgramPayoutSettingsSheetContent({
text="Save"
className="h-8 w-fit px-3"
loading={isSubmitting}
- disabled={!isDirty || !isValid}
+ disabled={!hasChanges || !isValid}
type="submit"
/>
</div>
@@ -204,6 +221,32 @@ function ProgramPayoutSettingsSheetContent({
);
}
+async function updateGroupHoldingPeriod({
+ workspaceId,
+ groupId,
+ holdingPeriodDays,
+ applyToAllGroups,
+}: HoldingPeriodUpdate & { workspaceId: string }) {
+ const response = await fetch(
+ `/api/groups/${groupId}?workspaceId=${workspaceId}`,
+ {
+ method: "PATCH",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({
+ holdingPeriodDays,
+ ...(applyToAllGroups && { updateHoldingPeriodDaysForAllGroups: true }),
+ }),
+ },
+ );
+
+ if (!response.ok) {
+ const { error } = await response.json();
+ throw new Error(
+ error?.message || "Failed to update payout holding period.",
+ );
+ }
+}
+
export function ProgramPayoutSettingsSheet({
isOpen,
...rest