The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Add partner group filter and column to Payouts (#4038)
Pedro Ladeirac46ead84282c
diff --git a/apps/web/app/(ee)/api/payouts/count/route.ts b/apps/web/app/(ee)/api/payouts/count/route.tsindex 808302e663..72720e6572 100644--- a/apps/web/app/(ee)/api/payouts/count/route.ts+++ b/apps/web/app/(ee)/api/payouts/count/route.ts@@ -1,10 +1,11 @@+import { buildProgramEnrollmentFilter } from "@/lib/api/payouts/get-payouts";import { getPayoutEligibilityFilter } from "@/lib/api/payouts/payout-eligibility-filter";import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";import { getProgramOrThrow } from "@/lib/api/programs/get-program-or-throw";import { withWorkspace } from "@/lib/auth";import { payoutsCountQuerySchema } from "@/lib/zod/schemas/payouts";import { prisma } from "@dub/prisma";-import { FraudEventStatus, PayoutStatus, Prisma } from "@dub/prisma/client";+import { PayoutStatus, Prisma } from "@dub/prisma/client";import { NextResponse } from "next/server";// GET /api/payouts/count@@ -14,7 +15,7 @@ export const GET = withWorkspace(async ({ workspace, searchParams }) => {const isHoldStatus = searchParams.status === "hold";const { status: _status, ...restSearchParams } = searchParams;- let { status, partnerId, groupBy, eligibility, invoiceId } =+ let { status, partnerId, groupId, groupBy, eligibility, invoiceId } =payoutsCountQuerySchema.parse(isHoldStatus ? restSearchParams : searchParams,);@@ -28,6 +29,11 @@ export const GET = withWorkspace(async ({ workspace, searchParams }) => {programId,});+ const programEnrollment = buildProgramEnrollmentFilter({+ groupId,+ isHoldStatus,+ });+const where: Prisma.PayoutWhereInput = {programId,...(partnerId && { partnerId }),@@ -35,15 +41,7 @@ export const GET = withWorkspace(async ({ workspace, searchParams }) => {...getPayoutEligibilityFilter({ program, workspace }),}),...(invoiceId && { invoiceId }),- ...(isHoldStatus && {- programEnrollment: {- fraudEventGroups: {- some: {- status: FraudEventStatus.pending,- },- },- },- }),+ ...(programEnrollment && { programEnrollment }),};// Get payout count by statusdiff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/bounties/[bountyId]/use-bounty-submission-filters.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/bounties/[bountyId]/use-bounty-submission-filters.tsxindex 7ff13896b3..6903ad3857 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/bounties/[bountyId]/use-bounty-submission-filters.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/bounties/[bountyId]/use-bounty-submission-filters.tsx@@ -73,7 +73,6 @@ export function useBountySubmissionFilters({value: group.id,label: group.name,icon: <GroupColorCircle group={group} />,- permalink: `/${slug}/program/groups/${group.slug}/rewards`,};}) ?? null,},diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/commissions-table.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/commissions-table.tsxindex 6e198b578d..3b44ddaf13 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/commissions-table.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/commissions-table.tsx@@ -195,7 +195,7 @@ export function CommissionsTable() {},{id: "group",- header: "Group",+ header: "Partner Group",cell: ({ row }) => {if (!groups) return "-";@@ -208,9 +208,16 @@ export function CommissionsTable() {return (<div className="flex items-center gap-2"><GroupColorCircle group={group} />- <span className="truncate text-sm font-medium">+ <Link+ href={`/${slug}/program/groups/${group.slug}`}+ target="_blank"+ onClick={(e) => e.stopPropagation()}+ onAuxClick={(e) => e.stopPropagation()}+ className="min-w-0 cursor-alias truncate text-sm font-medium decoration-dotted hover:underline"+ title={group.name}+ >{group.name}- </span>+ </Link></div>);},diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/use-commission-filters.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/use-commission-filters.tsxindex 6659d6d97b..aba3440c60 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/use-commission-filters.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/use-commission-filters.tsx@@ -108,7 +108,6 @@ export function useCommissionFilters() {value: group.id,label: group.name,icon: <GroupColorCircle group={group} />,- permalink: `/${slug}/program/groups/${group.slug}/rewards`,};}) ?? null,},diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/partners/use-partner-filters.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/partners/use-partner-filters.tsxindex bea99d3231..8c757d5d0e 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/partners/use-partner-filters.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/partners/use-partner-filters.tsx@@ -282,7 +282,6 @@ export function usePartnerFilters(label: groupData.name,icon: <GroupColorCircle group={groupData} />,right: nFormatter(_count || 0, { full: true }),- permalink: `/${slug}/program/groups/${groupData.slug}/rewards`,};}).filter((group) => group !== null)diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsxindex fe06cdd4f7..f64812e71c 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-table.tsx@@ -2,12 +2,14 @@import { getPlanCapabilities } from "@/lib/plan-capabilities";import { useFraudGroupCount } from "@/lib/swr/use-fraud-groups-count";+import useGroups from "@/lib/swr/use-groups";import { usePayoutsCount } from "@/lib/swr/use-payouts-count";import useProgram from "@/lib/swr/use-program";import useWorkspace from "@/lib/swr/use-workspace";import { TREMENDOUS_MAX_PAYOUT_AMOUNT_CENTS } from "@/lib/tremendous/constants";import { FraudGroupCountByPartner, PayoutResponse } from "@/lib/types";import { ExternalPayoutsIndicator } from "@/ui/partners/external-payouts-indicator";+import { GroupColorCircle } from "@/ui/partners/groups/group-color-circle";import { PartnerRowItem } from "@/ui/partners/partner-row-item";import { PayoutStatusBadges } from "@/ui/partners/payout-status-badges";import { AnimatedEmptyState } from "@/ui/shared/animated-empty-state";@@ -20,11 +22,13 @@ import {AnimatedSizeContainer,Button,DynamicTooltipWrapper,+ EditColumnsButton,Filter,StatusBadge,Table,Tooltip,TooltipContent,+ useColumnVisibility,usePagination,useRouterStuff,useTable,@@ -94,6 +98,11 @@ function isPayoutEligibleForBatchConfirm(const PAYOUTS_MAX_PAGE_SIZE = 50;+const payoutsColumns = {+ all: ["periodEnd", "partner", "group", "status", "initiatedAt", "amount"],+ defaultVisible: ["periodEnd", "partner", "status", "initiatedAt", "amount"],+};+export function PayoutTable() {const router = useRouter();const { queryParams, searchParams, searchParamsObj, getQueryString } =@@ -107,8 +116,17 @@ export function PayoutTable() {} = useWorkspace();const { program } = useProgram();+ const { groups } = useGroups();const minPayoutAmount = program?.minPayoutAmount ?? 0;+ const { columnVisibility, setColumnVisibility } = useColumnVisibility(+ "payouts-table-columns",+ {+ all: payoutsColumns.all,+ defaultVisible: payoutsColumns.defaultVisible,+ },+ );+const sortBy = searchParams.get("sortBy") || "amount";const sortOrder = searchParams.get("sortOrder") === "asc" ? "asc" : "desc";@@ -163,80 +181,126 @@ export function PayoutTable() {(key) => !["sortBy", "sortOrder", "page"].includes(key),);+ const columns = useMemo(+ () =>+ [+ {+ id: "periodEnd",+ header: "Period",+ accessorFn: (d: PayoutResponse) => formatPeriod(d),+ },+ {+ id: "partner",+ header: "Partner",+ cell: ({ row }) => {+ return <PartnerRowItem partner={row.original.partner} />;+ },+ },+ {+ id: "group",+ header: "Partner Group",+ cell: ({ row }) => {+ if (!groups) return "-";++ const group = groups.find(+ (g) => g.id === row.original.partner.groupId,+ );++ if (!group) return "-";++ return (+ <div className="flex items-center gap-2">+ <GroupColorCircle group={group} />+ <Link+ href={`/${workspaceSlug}/program/groups/${group.slug}`}+ target="_blank"+ onClick={(e) => e.stopPropagation()}+ onAuxClick={(e) => e.stopPropagation()}+ className="min-w-0 cursor-alias truncate text-sm font-medium decoration-dotted hover:underline"+ title={group.name}+ >+ {group.name}+ </Link>+ </div>+ );+ },+ },+ {+ id: "status",+ header: "Status",+ cell: ({ row }) => {+ const hasPendingFraudEvents =+ canManageFraudEvents &&+ fraudGroupCountMap.has(row.original.partner.id);++ const status =+ hasPendingFraudEvents && row.original.status === "pending"+ ? "hold"+ : row.original.status;++ const badge = PayoutStatusBadges[status];++ return badge ? (+ <StatusBadge icon={badge.icon} variant={badge.variant}>+ <DynamicTooltipWrapper+ tooltipProps={+ row.original.status === "failed" &&+ row.original.failureReason+ ? {+ content: row.original.failureReason,+ }+ : undefined+ }+ >+ {badge.label}+ </DynamicTooltipWrapper>+ </StatusBadge>+ ) : (+ "-"+ );+ },+ },+ {+ id: "initiatedAt",+ header: "Paid",+ cell: ({ row }) => (+ <PayoutPaidCell+ initiatedAt={row.original.initiatedAt}+ paidAt={row.original.paidAt}+ user={row.original.user}+ />+ ),+ },+ {+ id: "amount",+ header: "Amount",+ cell: ({ row }) => (+ <AmountRowItem+ payout={row.original}+ hasPendingFraudEvents={+ canManageFraudEvents &&+ fraudGroupCountMap.has(row.original.partner.id)+ }+ />+ ),+ },+ {+ id: "menu",+ enableHiding: false,+ header: ({ table }) => <EditColumnsButton table={table} />,+ cell: () => null,+ },+ ].filter((c) => c.id === "menu" || payoutsColumns.all.includes(c.id)),+ [canManageFraudEvents, fraudGroupCountMap, groups, workspaceSlug],+ );+const { table, ...tableProps } = useTable({data: payouts || [],loading: isLoading,error: error || countError ? "Failed to load payouts" : undefined,- columns: [- {- id: "periodEnd",- header: "Period",- accessorFn: (d) => formatPeriod(d),- },- {- header: "Partner",- cell: ({ row }) => {- return <PartnerRowItem partner={row.original.partner} />;- },- },- {- header: "Status",- cell: ({ row }) => {- const hasPendingFraudEvents =- canManageFraudEvents &&- fraudGroupCountMap.has(row.original.partner.id);-- const status =- hasPendingFraudEvents && row.original.status === "pending"- ? "hold"- : row.original.status;-- const badge = PayoutStatusBadges[status];-- return badge ? (- <StatusBadge icon={badge.icon} variant={badge.variant}>- <DynamicTooltipWrapper- tooltipProps={- row.original.status === "failed" && row.original.failureReason- ? {- content: row.original.failureReason,- }- : undefined- }- >- {badge.label}- </DynamicTooltipWrapper>- </StatusBadge>- ) : (- "-"- );- },- },- {- id: "initiatedAt",- header: "Paid",- cell: ({ row }) => (- <PayoutPaidCell- initiatedAt={row.original.initiatedAt}- paidAt={row.original.paidAt}- user={row.original.user}- />- ),- },- {- id: "amount",- header: "Amount",- cell: ({ row }) => (- <AmountRowItem- payout={row.original}- hasPendingFraudEvents={- canManageFraudEvents &&- fraudGroupCountMap.has(row.original.partner.id)- }- />- ),- },- ],+ columns,+ columnVisibility,+ onColumnVisibilityChange: setColumnVisibility,pagination,onPaginationChange: setPagination,sortableColumns: ["amount", "initiatedAt"],diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/use-payout-filters.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/use-payout-filters.tsxindex 95dbcf10b7..fbe3a7c25b 100644--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/use-payout-filters.tsx+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/use-payout-filters.tsx@@ -1,21 +1,27 @@+import useGroups from "@/lib/swr/use-groups";import usePartners from "@/lib/swr/use-partners";import { usePayoutsCount } from "@/lib/swr/use-payouts-count";+import useWorkspace from "@/lib/swr/use-workspace";import { EnrolledPartnerProps } from "@/lib/types";+import { GroupColorCircle } from "@/ui/partners/groups/group-color-circle";import { PartnerAvatar } from "@/ui/partners/partner-avatar";import { PayoutStatusBadges } from "@/ui/partners/payout-status-badges";import { useRouterStuff } from "@dub/ui";-import { CircleDotted, InvoiceDollar, Users } from "@dub/ui/icons";+import { CircleDotted, InvoiceDollar, Users, Users6 } from "@dub/ui/icons";import { cn, nFormatter } from "@dub/utils";import { useCallback, useMemo, useState } from "react";import { useDebounce } from "use-debounce";export function usePayoutFilters() {+ const { slug } = useWorkspace();const { searchParamsObj, queryParams } = useRouterStuff();const { payoutsCount } = usePayoutsCount({groupBy: "status",});+ const { groups } = useGroups();+const [selectedFilter, setSelectedFilter] = useState<string | null>(null);const [search, setSearch] = useState("");const [debouncedSearch] = useDebounce(search, 500);@@ -40,6 +46,19 @@ export function usePayoutFilters() {};}) ?? null,},+ {+ key: "groupId",+ icon: Users6,+ label: "Partner Group",+ options:+ groups?.map((group) => {+ return {+ value: group.id,+ label: group.name,+ icon: <GroupColorCircle group={group} />,+ };+ }) ?? null,+ },{key: "status",icon: CircleDotted,@@ -74,19 +93,21 @@ export function usePayoutFilters() {options: [],},],- [payoutsCount, partners],+ [payoutsCount, partners, groups, slug],);const activeFilters = useMemo(() => {- const { status, partnerId, invoiceId } = searchParamsObj;+ const { status, partnerId, groupId, invoiceId } = searchParamsObj;return [...(status ? [{ key: "status", value: status }] : []),...(partnerId ? [{ key: "partnerId", value: partnerId }] : []),+ ...(groupId ? [{ key: "groupId", value: groupId }] : []),...(invoiceId ? [{ key: "invoiceId", value: invoiceId }] : []),];}, [searchParamsObj.status,searchParamsObj.partnerId,+ searchParamsObj.groupId,searchParamsObj.invoiceId,]);@@ -112,7 +133,7 @@ export function usePayoutFilters() {const onRemoveAll = useCallback(() =>queryParams({- del: ["status", "search", "partnerId", "invoiceId"],+ del: ["status", "search", "partnerId", "invoiceId", "groupId"],}),[queryParams],);diff --git a/apps/web/lib/api/payouts/get-payouts.ts b/apps/web/lib/api/payouts/get-payouts.tsindex 3fcdbb6993..f1ab3b6ce1 100644--- a/apps/web/lib/api/payouts/get-payouts.ts+++ b/apps/web/lib/api/payouts/get-payouts.ts@@ -4,6 +4,7 @@ import { getProgramOrThrow } from "@/lib/api/programs/get-program-or-throw";import { payoutsQuerySchema } from "@/lib/zod/schemas/payouts";import { prisma } from "@dub/prisma";import { FraudEventStatus, PayoutStatus, Prisma } from "@dub/prisma/client";+import { parseFilterValue } from "@dub/utils";import * as z from "zod/v4";export type PayoutsQueryFilters = z.infer<typeof payoutsQuerySchema>;@@ -20,6 +21,7 @@ function pickPayoutQueryParams(partnerId,tenantId,invoiceId,+ groupId,sortBy,sortOrder,page,@@ -31,6 +33,7 @@ function pickPayoutQueryParams(partnerId,tenantId,invoiceId,+ groupId,sortBy,sortOrder,page,@@ -62,6 +65,36 @@ export function parsePayoutsQuery(};}+export function buildProgramEnrollmentFilter({+ groupId,+ isHoldStatus,+}: {+ groupId?: string;+ isHoldStatus?: boolean;+}): Prisma.ProgramEnrollmentWhereInput | undefined {+ const groupFilter = groupId ? parseFilterValue(groupId) : null;++ if (!groupFilter && !isHoldStatus) {+ return undefined;+ }++ return {+ ...(groupFilter && {+ groupId:+ groupFilter.sqlOperator === "NOT IN"+ ? { notIn: groupFilter.values }+ : { in: groupFilter.values },+ }),+ ...(isHoldStatus && {+ fraudEventGroups: {+ some: {+ status: FraudEventStatus.pending,+ },+ },+ }),+ };+}+export function buildPayoutWhere({programId,filters,@@ -69,25 +102,21 @@ export function buildPayoutWhere({programId: string;filters: Pick<ParsedPayoutsFilters,- "status" | "partnerId" | "invoiceId" | "isHoldStatus"+ "status" | "partnerId" | "invoiceId" | "groupId" | "isHoldStatus">;}): Prisma.PayoutWhereInput {- const { status, partnerId, invoiceId, isHoldStatus } = filters;+ const { status, partnerId, invoiceId, groupId, isHoldStatus } = filters;+ const programEnrollment = buildProgramEnrollmentFilter({+ groupId,+ isHoldStatus,+ });return {programId,...(status && { status }),...(partnerId && { partnerId }),...(invoiceId && { invoiceId }),- ...(isHoldStatus && {- programEnrollment: {- fraudEventGroups: {- some: {- status: FraudEventStatus.pending,- },- },- },- }),+ ...(programEnrollment && { programEnrollment }),};}@@ -159,6 +188,7 @@ export async function getPayouts({status: rest.status,partnerId,invoiceId: rest.invoiceId,+ groupId: rest.groupId,isHoldStatus,},}),@@ -189,6 +219,7 @@ export async function getPayouts({partner: {...partner,tenantId: programEnrollment.tenantId,+ groupId: programEnrollment.groupId,},user,};@@ -217,6 +248,7 @@ export async function getPayoutsCount({status: rest.status,partnerId,invoiceId: rest.invoiceId,+ groupId: rest.groupId,isHoldStatus,},}),diff --git a/apps/web/lib/swr/use-payouts-count.ts b/apps/web/lib/swr/use-payouts-count.tsindex 047b97490e..50bcaa304b 100644--- a/apps/web/lib/swr/use-payouts-count.ts+++ b/apps/web/lib/swr/use-payouts-count.ts@@ -27,7 +27,7 @@ export function usePayoutsCount({workspaceId,},{- include: ignoreParams ? [] : ["status", "partnerId", "invoiceId"],+ include: ignoreParams ? [] : ["status", "partnerId", "invoiceId", "groupId"],},)}`,fetcher,diff --git a/apps/web/lib/zod/schemas/payouts.ts b/apps/web/lib/zod/schemas/payouts.tsindex fe481f5091..95fefa6fc2 100644--- a/apps/web/lib/zod/schemas/payouts.ts+++ b/apps/web/lib/zod/schemas/payouts.ts@@ -52,6 +52,14 @@ export const payoutsQuerySchema = z.describe("Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID.",),+ groupId: z+ .string()+ .optional()+ .describe(+ "Filter the list of payouts by the associated partner group. " ++ "Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). " ++ "Examples: `group_abc`, `group_abc,group_xyz`, `-group_abc`.",+ ),sortBy: z.enum(["amount", "initiatedAt", "paidAt"]).default("amount")@@ -68,6 +76,7 @@ export const payoutsCountQuerySchema = payoutsQuerySchemastatus: true,partnerId: true,invoiceId: true,+ groupId: true,}).extend({programId: z.string().optional(),diff --git a/apps/web/tests/payouts/index.test.ts b/apps/web/tests/payouts/index.test.tsindex 36411ec26d..10c2daf6e8 100644--- a/apps/web/tests/payouts/index.test.ts+++ b/apps/web/tests/payouts/index.test.ts@@ -69,6 +69,44 @@ describe("GET /payouts", async () => {);});+ test("filters by groupId", async () => {+ const { data: partnerPayouts, status: partnerStatus } = await http.get<+ PayoutResponse[]+ >({+ path: "/payouts",+ query: {+ partnerId: E2E_PARTNER.id,+ limit: "1",+ },+ });++ expect(partnerStatus).toEqual(200);+ expect(partnerPayouts.length).toBeGreaterThan(0);++ const groupId = partnerPayouts[0].partner.groupId;+ if (!groupId) {+ throw new Error("Expected partner payout to include groupId");+ }+ expect(groupId).toMatch(/^grp_/);++ const { data, status } = await http.get<PayoutResponse[]>({+ path: "/payouts",+ query: {+ groupId,+ limit: "5",+ },+ });++ expect(status).toEqual(200);+ expect(Array.isArray(data)).toBe(true);++ if (data.length > 0) {+ expect(data.every((payout) => payout.partner.groupId === groupId)).toBe(+ true,+ );+ }+ });+test("filters by tenantId", async () => {const { data, status } = await http.get<PayoutResponse[]>({path: "/payouts",