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.

Keep revenue fields in partner APIs and zero them when sharing is disabled.

Kiran K32f7b81ea9db
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts
index 873bc26946..8563909dda 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts
@@ -15,7 +15,7 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING,
} from "@/lib/constants/partner-profile";
-import { omitSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { assertRateLimit } from "@/lib/upstash/assert-rate-limit";
import { RATELIMIT_POLICIES } from "@/lib/upstash/ratelimit-policies";
@@ -146,7 +146,7 @@ export const GET = withPartnerProfile(
return formatted.map((row) =>
row && typeof row === "object" && "saleAmount" in row
- ? omitSaleAmount(row)
+ ? zeroSaleAmount(row)
: row,
);
},
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/route.ts
index 90010bafcb..5bd8a052b6 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/route.ts
@@ -8,7 +8,7 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING,
} from "@/lib/constants/partner-profile";
-import { omitSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { partnerProfileAnalyticsQuerySchema } from "@/lib/zod/schemas/partner-profile";
import { parseFilterValue, toCentsNumber } from "@dub/utils";
@@ -124,14 +124,14 @@ export const GET = withPartnerProfile(
return NextResponse.json(
response.map((row) =>
row && typeof row === "object" && "saleAmount" in row
- ? omitSaleAmount(row)
+ ? zeroSaleAmount(row)
: row,
),
);
}
if (response && typeof response === "object" && "saleAmount" in response) {
- return NextResponse.json(omitSaleAmount(response));
+ return NextResponse.json(zeroSaleAmount(response));
}
return NextResponse.json(response);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/[customerId]/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/[customerId]/route.ts
index f88a58076b..96eebe3843 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/[customerId]/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/[customerId]/route.ts
@@ -10,7 +10,7 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
} from "@/lib/constants/partner-profile";
import { generateRandomName } from "@/lib/names";
-import { omitSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma } from "@/lib/prisma";
import { PartnerProfileCustomerSchema } from "@/lib/zod/schemas/partner-profile";
@@ -124,48 +124,43 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
CUSTOMER_LTV_EXCLUDED_PROGRAM_IDS.includes(program.id) ||
hidePartnerRevenue;
+ const transformed = transformCustomer({
+ ...customer,
+ firstSaleAt: customer.commissions[0]?.createdAt ?? null,
+ email: customer.email
+ ? customerDataSharingEnabledAt
+ ? customer.email
+ : obfuscateCustomerEmail(customer.email)
+ : customer.name || generateRandomName(),
+ });
+
return NextResponse.json(
PartnerProfileCustomerSchema.extend({
...(customerDataSharingEnabledAt && { name: z.string().nullish() }),
- })
- .omit({
- ...(ltvExcluded && {
- saleAmount: true,
- }),
- })
- .parse({
- ...transformCustomer({
- ...customer,
- firstSaleAt: customer.commissions[0]?.createdAt ?? null,
- email: customer.email
- ? customerDataSharingEnabledAt
- ? customer.email
- : obfuscateCustomerEmail(customer.email)
- : customer.name || generateRandomName(),
- }),
- activity: {
- ...customer,
- events: hidePartnerRevenue
- ? events.map((event) => {
- if (event.event === "sale") {
- const { saleAmount: _, sale, link, ...rest } = event;
- const { amount: __, ...saleRest } = sale;
-
- return {
- ...rest,
- sale: saleRest,
- link: link ? omitSaleAmount(link) : link,
- };
- }
-
+ }).parse({
+ ...transformed,
+ ...(ltvExcluded && { saleAmount: 0 }),
+ activity: {
+ ...customer,
+ events: hidePartnerRevenue
+ ? events.map((event) => {
+ if (event.event === "sale") {
return {
...event,
- link: event.link ? omitSaleAmount(event.link) : event.link,
+ saleAmount: 0,
+ sale: { ...event.sale, amount: 0 },
+ link: event.link ? zeroSaleAmount(event.link) : event.link,
};
- })
- : events,
- link,
- },
- }),
+ }
+
+ return {
+ ...event,
+ link: event.link ? zeroSaleAmount(event.link) : event.link,
+ };
+ })
+ : events,
+ link,
+ },
+ }),
);
});
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/route.ts
index 3948dd9a9e..af5e8602c7 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/route.ts
@@ -119,30 +119,27 @@ export const GET = withPartnerProfile(
// Map customers with their data
const customersWithData = customers.map((customer) => {
+ const transformed = transformCustomer({
+ ...customer,
+ firstSaleAt: customer.commissions[0]?.createdAt ?? null,
+ email: customer.email
+ ? customerDataSharingEnabledAt
+ ? customer.email
+ : obfuscateCustomerEmail(customer.email)
+ : customer.name || generateRandomName(),
+ });
+
return PartnerProfileCustomerSchema.extend({
...(customerDataSharingEnabledAt && { name: z.string().nullish() }),
- })
- .omit({
- ...(ltvExcluded && {
- saleAmount: true,
- }),
- })
- .parse({
- ...transformCustomer({
- ...customer,
- firstSaleAt: customer.commissions[0]?.createdAt ?? null,
- email: customer.email
- ? customerDataSharingEnabledAt
- ? customer.email
- : obfuscateCustomerEmail(customer.email)
- : customer.name || generateRandomName(),
- }),
- activity: {
- ...customer,
- events: [],
- link: customer.link,
- },
- });
+ }).parse({
+ ...transformed,
+ ...(ltvExcluded && { saleAmount: 0 }),
+ activity: {
+ ...customer,
+ events: [],
+ link: customer.link,
+ },
+ });
});
return NextResponse.json(customersWithData);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/route.ts
index af6281286f..0abdc816d0 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/route.ts
@@ -10,6 +10,8 @@ import {
MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING,
} from "@/lib/constants/partner-profile";
import { generateRandomName } from "@/lib/names";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import {
PartnerProfileLinkSchema,
partnerProfileEventsQuerySchema,
@@ -21,15 +23,38 @@ import * as z from "zod/v4";
// GET /api/partner-profile/programs/[programId]/events – get events for a program enrollment link
export const GET = withPartnerProfile(
async ({ partner, params, searchParams }) => {
- const { program, links, totalCommissions, customerDataSharingEnabledAt } =
- await getProgramEnrollmentOrThrow({
- partnerId: partner.id,
- programId: params.programId,
- include: {
- program: true,
- links: true,
+ const {
+ program,
+ links,
+ totalCommissions,
+ customerDataSharingEnabledAt,
+ partnerGroup,
+ } = await getProgramEnrollmentOrThrow({
+ partnerId: partner.id,
+ programId: params.programId,
+ include: {
+ program: {
+ select: {
+ id: true,
+ workspaceId: true,
+ startedAt: true,
+ createdAt: true,
+ },
},
- });
+ links: {
+ select: {
+ id: true,
+ domain: true,
+ key: true,
+ },
+ },
+ partnerGroup: {
+ select: {
+ revenueDataSharingDisabledAt: true,
+ },
+ },
+ },
+ });
if (
LARGE_PROGRAM_IDS.includes(program.id) &&
@@ -109,13 +134,15 @@ export const GET = withPartnerProfile(
dataAvailableFrom: program.startedAt ?? program.createdAt,
});
+ const hidePartnerRevenue = isPartnerRevenueHidden(partnerGroup);
+
const response = events.map((event) => {
// don't return ip address for partner profile
// @ts-ignore – ip is deprecated but present in the data
const { ip, click, customer, ...eventRest } = event;
const { ip: _, ...clickRest } = click;
- return {
+ const mapped = {
...eventRest,
click: clickRest,
link: event?.link ? PartnerProfileLinkSchema.parse(event.link) : null,
@@ -139,6 +166,19 @@ export const GET = withPartnerProfile(
}),
}),
};
+
+ if (!hidePartnerRevenue) {
+ return mapped;
+ }
+
+ return {
+ ...mapped,
+ ...("saleAmount" in mapped ? { saleAmount: 0 } : {}),
+ ...("sale" in mapped && mapped.sale
+ ? { sale: { ...mapped.sale, amount: 0 } }
+ : {}),
+ link: mapped.link ? zeroSaleAmount(mapped.link) : mapped.link,
+ };
});
return NextResponse.json(response);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/[linkId]/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/[linkId]/route.ts
index 6ec011013a..a317bdbda4 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/[linkId]/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/[linkId]/route.ts
@@ -5,6 +5,8 @@ import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enro
import { parseRequestBody } from "@/lib/api/utils";
import { applyGroupUtmToLink } from "@/lib/api/utm/apply-group-utm-to-link";
import { withPartnerProfile } from "@/lib/auth/partner";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma } from "@/lib/prisma";
import { NewLinkProps } from "@/lib/types";
import { PartnerProfileLinkSchema } from "@/lib/zod/schemas/partner-profile";
@@ -158,7 +160,13 @@ export const PATCH = withPartnerProfile(
updatedLink: linkWithUtm,
});
- return NextResponse.json(PartnerProfileLinkSchema.parse(partnerLink));
+ const hidePartnerRevenue = isPartnerRevenueHidden(group);
+
+ return NextResponse.json(
+ PartnerProfileLinkSchema.parse(
+ hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink,
+ ),
+ );
},
);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/route.ts
index 66dde4fd6c..16792c2f7d 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/links/route.ts
@@ -5,6 +5,8 @@ import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enro
import { parseRequestBody } from "@/lib/api/utils";
import { applyGroupUtmToLink } from "@/lib/api/utm/apply-group-utm-to-link";
import { withPartnerProfile } from "@/lib/auth/partner";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma } from "@/lib/prisma";
import { getResolvedPartnerLinkRewards } from "@/lib/rewards/get-resolved-partner-link-rewards";
import { PartnerProfileLinkSchema } from "@/lib/zod/schemas/partner-profile";
@@ -25,6 +27,7 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
saleReward,
customReward,
discount,
+ partnerGroup: group,
} = await getProgramEnrollmentOrThrow({
partnerId: partner.id,
programId: params.programId,
@@ -35,6 +38,11 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
saleReward: true,
customReward: true,
discount: true,
+ partnerGroup: {
+ select: {
+ revenueDataSharingDisabledAt: true,
+ },
+ },
links: {
include: {
linkReward: {
@@ -56,6 +64,7 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
);
const enrollmentRewards = [clickReward, leadReward, saleReward, customReward];
+ const hidePartnerRevenue = isPartnerRevenueHidden(group);
const result = links.map((link) => {
const discountCode = linksByDiscountCode.get(link.id);
@@ -65,12 +74,14 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
enrollmentDiscount: discount,
});
- return {
+ const partnerLink = {
...link,
...resolvedRewards,
discountCode: discountCode?.code,
discountCodeDisabledAt: discountCode?.disabledAt ?? null,
};
+
+ return hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink;
});
return NextResponse.json(z.array(PartnerProfileLinkSchema).parse(result));
@@ -180,8 +191,15 @@ export const POST = withPartnerProfile(
const partnerLink = await createLink(linkWithUtm);
- return NextResponse.json(PartnerProfileLinkSchema.parse(partnerLink), {
- status: 201,
- });
+ const hidePartnerRevenue = isPartnerRevenueHidden(group);
+
+ return NextResponse.json(
+ PartnerProfileLinkSchema.parse(
+ hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink,
+ ),
+ {
+ status: 201,
+ },
+ );
},
);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/route.ts
index 93dd70327b..d20e50bec7 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/route.ts
@@ -1,6 +1,7 @@
import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enrollment-or-throw";
import { withPartnerProfile } from "@/lib/auth/partner";
-import { hidePartnerLinkSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { ProgramEnrollmentSchema } from "@/lib/zod/schemas/programs";
import { Reward } from "@prisma/client";
import { NextResponse } from "next/server";
@@ -40,12 +41,13 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
].filter((r): r is Reward => r !== null);
const { partnerGroup } = programEnrollment;
+ const hidePartnerRevenue = isPartnerRevenueHidden(partnerGroup);
return NextResponse.json(
ProgramEnrollmentSchema.parse({
...programEnrollment,
links: programEnrollment.links?.map((link) =>
- hidePartnerLinkSaleAmount(link, partnerGroup),
+ hidePartnerRevenue ? zeroSaleAmount(link) : link,
),
rewards,
group: partnerGroup,
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/bounties/[bountyId]/bounty-performance-section.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/bounties/[bountyId]/bounty-performance-section.tsx
index 49793ed8e5..030410d4ae 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/bounties/[bountyId]/bounty-performance-section.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/bounties/[bountyId]/bounty-performance-section.tsx
@@ -4,6 +4,7 @@ import { formatDateTooltip } from "@/lib/analytics/format-date-tooltip";
import { PartnerAnalyticsFilters } from "@/lib/analytics/types";
import { isCurrencyAttribute } from "@/lib/api/workflows/utils";
import { PERFORMANCE_BOUNTY_SCOPE_ATTRIBUTES } from "@/lib/bounty/api/performance-bounty-scope-attributes";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import usePartnerAnalytics from "@/lib/swr/use-partner-analytics";
import {
usePartnerProfileEarnings,
@@ -99,6 +100,19 @@ export function BountyPerformanceSection({
}: {
bounty: PartnerBountyProps;
}) {
+ const { programEnrollment } = useProgramEnrollment();
+ const attribute = bounty.performanceCondition?.attribute as
+ | PerformanceAttribute
+ | undefined;
+
+ // Hide the whole section when the bounty is revenue-based and revenue is hidden
+ if (
+ attribute === "totalSaleAmount" &&
+ isPartnerRevenueHidden(programEnrollment?.group)
+ ) {
+ return null;
+ }
+
return (
<div className="flex flex-col gap-6">
<div className="flex flex-col gap-3">
diff --git a/apps/web/lib/api/partners/notify-partner-commission.ts b/apps/web/lib/api/partners/notify-partner-commission.ts
index 8a36ca0ed8..b67ff55526 100644
--- a/apps/web/lib/api/partners/notify-partner-commission.ts
+++ b/apps/web/lib/api/partners/notify-partner-commission.ts
@@ -1,3 +1,4 @@
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma } from "@/lib/prisma";
import { sendBatchEmail } from "@dub/email";
import {
@@ -28,7 +29,10 @@ export async function notifyPartnerCommission({
Program,
"name" | "slug" | "logo" | "supportEmail" | "environment"
>;
- group: Pick<PartnerGroup, "holdingPeriodDays">;
+ group: Pick<
+ PartnerGroup,
+ "holdingPeriodDays" | "revenueDataSharingDisabledAt"
+ >;
workspace: Pick<Project, "id" | "slug" | "name">;
commission: Pick<
Commission,
@@ -124,6 +128,7 @@ export async function notifyPartnerCommission({
},
group: {
holdingPeriodDays: group.holdingPeriodDays,
+ revenueDataSharingDisabled: isPartnerRevenueHidden(group),
},
partner: {
id: commission.partnerId,
diff --git a/apps/web/lib/partners/is-partner-revenue-hidden.ts b/apps/web/lib/partners/is-partner-revenue-hidden.ts
index d58411cf69..242aaf6515 100644
--- a/apps/web/lib/partners/is-partner-revenue-hidden.ts
+++ b/apps/web/lib/partners/is-partner-revenue-hidden.ts
@@ -2,8 +2,8 @@ import { PartnerGroup } from "@prisma/client";
/** Group shape used to decide whether sale dollar amounts are hidden from partners. */
export type PartnerRevenueVisibilityGroup =
- | Pick<PartnerGroup, "hideRevenueFromPartnersAt">
- | { hideRevenueFromPartnersAt?: Date | string | null }
+ | Pick<PartnerGroup, "revenueDataSharingDisabledAt">
+ | { revenueDataSharingDisabledAt?: Date | string | null }
| null
| undefined;
@@ -11,5 +11,5 @@ export type PartnerRevenueVisibilityGroup =
export function isPartnerRevenueHidden(
group: PartnerRevenueVisibilityGroup,
): boolean {
- return Boolean(group?.hideRevenueFromPartnersAt);
+ return Boolean(group?.revenueDataSharingDisabledAt);
}
diff --git a/packages/email/src/templates/new-commission-alert-partner.tsx b/packages/email/src/templates/new-commission-alert-partner.tsx
index 7a57d79a54..194f1bc5b8 100644
--- a/packages/email/src/templates/new-commission-alert-partner.tsx
+++ b/packages/email/src/templates/new-commission-alert-partner.tsx
@@ -26,6 +26,7 @@ export default function NewCommissionAlertPartner({
},
group = {
holdingPeriodDays: 30,
+ revenueDataSharingDisabled: false,
},
commission = {
type: "sale",
@@ -44,6 +45,7 @@ export default function NewCommissionAlertPartner({
};
group: {
holdingPeriodDays: number;
+ revenueDataSharingDisabled?: boolean;
};
commission: {
type: "click" | "lead" | "sale" | "custom" | "referral";
@@ -56,6 +58,7 @@ export default function NewCommissionAlertPartner({
const earningsInDollars = currencyFormatter(commission.earnings);
const linkToEarnings = `https://partners.dub.co/programs/${program.slug}/earnings`;
const isOnHold = commission.status === "hold";
+ const hidePartnerRevenue = Boolean(group.revenueDataSharingDisabled);
return (
<Html>
@@ -93,6 +96,8 @@ export default function NewCommissionAlertPartner({
<strong className="text-black">{program.name}</strong>'s
partner program via your partner referral link.
</>
+ ) : hidePartnerRevenue ? (
+ "made a purchase"
) : (
<>
made a{" "}