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.

Null sale amounts in partner APIs when revenue sharing is disabled.

Kiran Ke49effeca202
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 8563909dda..286ea07c74 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 { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { nullAnalyticsSaleAmounts } 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";
@@ -140,15 +140,9 @@ export const GET = withPartnerProfile(
formatRows: (rows) => {
const formatted = formatPartnerAnalyticsForExport(rows);
- if (!isPartnerRevenueHidden(partnerGroup)) {
- return formatted;
- }
-
- return formatted.map((row) =>
- row && typeof row === "object" && "saleAmount" in row
- ? zeroSaleAmount(row)
- : row,
- );
+ return isPartnerRevenueHidden(partnerGroup)
+ ? nullAnalyticsSaleAmounts(formatted)
+ : formatted;
},
getAnalyticsParams: () =>
parsedParams.linkId
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 5bd8a052b6..505cb5836a 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 { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import { nullAnalyticsSaleAmounts } 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";
@@ -116,24 +116,10 @@ export const GET = withPartnerProfile(
dataAvailableFrom: program.startedAt ?? program.createdAt,
});
- if (!isPartnerRevenueHidden(partnerGroup)) {
- return NextResponse.json(response);
- }
-
- if (Array.isArray(response)) {
- return NextResponse.json(
- response.map((row) =>
- row && typeof row === "object" && "saleAmount" in row
- ? zeroSaleAmount(row)
- : row,
- ),
- );
- }
-
- if (response && typeof response === "object" && "saleAmount" in response) {
- return NextResponse.json(zeroSaleAmount(response));
- }
-
- return NextResponse.json(response);
+ return NextResponse.json(
+ isPartnerRevenueHidden(partnerGroup)
+ ? nullAnalyticsSaleAmounts(response)
+ : 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 96eebe3843..37d19c0db1 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,10 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
} from "@/lib/constants/partner-profile";
import { generateRandomName } from "@/lib/names";
-import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
+import {
+ nullPartnerEventRevenue,
+ nullSaleAmount,
+} 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";
@@ -138,26 +141,11 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
PartnerProfileCustomerSchema.extend({
...(customerDataSharingEnabledAt && { name: z.string().nullish() }),
}).parse({
- ...transformed,
- ...(ltvExcluded && { saleAmount: 0 }),
+ ...(ltvExcluded ? nullSaleAmount(transformed) : transformed),
activity: {
...customer,
events: hidePartnerRevenue
- ? events.map((event) => {
- if (event.event === "sale") {
- return {
- ...event,
- saleAmount: 0,
- sale: { ...event.sale, amount: 0 },
- link: event.link ? zeroSaleAmount(event.link) : event.link,
- };
- }
-
- return {
- ...event,
- link: event.link ? zeroSaleAmount(event.link) : event.link,
- };
- })
+ ? events.map(nullPartnerEventRevenue)
: 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 af5e8602c7..8885704a78 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
@@ -9,6 +9,7 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
} from "@/lib/constants/partner-profile";
import { generateRandomName } from "@/lib/names";
+import { nullSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma, sanitizeFullTextSearch } from "@/lib/prisma";
import {
@@ -132,8 +133,7 @@ export const GET = withPartnerProfile(
return PartnerProfileCustomerSchema.extend({
...(customerDataSharingEnabledAt && { name: z.string().nullish() }),
}).parse({
- ...transformed,
- ...(ltvExcluded && { saleAmount: 0 }),
+ ...(ltvExcluded ? nullSaleAmount(transformed) : transformed),
activity: {
...customer,
events: [],
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 0abdc816d0..1fdc5be6c2 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,7 +10,7 @@ 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 { nullPartnerEventRevenue } from "@/lib/partners/hide-partner-revenue";
import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import {
PartnerProfileLinkSchema,
@@ -167,18 +167,7 @@ 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 hidePartnerRevenue ? nullPartnerEventRevenue(mapped) : mapped;
});
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 a317bdbda4..6b0b514d29 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,8 +5,7 @@ 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 { hidePartnerSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { prisma } from "@/lib/prisma";
import { NewLinkProps } from "@/lib/types";
import { PartnerProfileLinkSchema } from "@/lib/zod/schemas/partner-profile";
@@ -160,11 +159,9 @@ export const PATCH = withPartnerProfile(
updatedLink: linkWithUtm,
});
- const hidePartnerRevenue = isPartnerRevenueHidden(group);
-
return NextResponse.json(
PartnerProfileLinkSchema.parse(
- hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink,
+ hidePartnerSaleAmount(partnerLink, group),
),
);
},
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 16792c2f7d..264872530e 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,8 +5,7 @@ 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 { hidePartnerSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { prisma } from "@/lib/prisma";
import { getResolvedPartnerLinkRewards } from "@/lib/rewards/get-resolved-partner-link-rewards";
import { PartnerProfileLinkSchema } from "@/lib/zod/schemas/partner-profile";
@@ -64,7 +63,6 @@ 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);
@@ -74,14 +72,15 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
enrollmentDiscount: discount,
});
- const partnerLink = {
- ...link,
- ...resolvedRewards,
- discountCode: discountCode?.code,
- discountCodeDisabledAt: discountCode?.disabledAt ?? null,
- };
-
- return hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink;
+ return hidePartnerSaleAmount(
+ {
+ ...link,
+ ...resolvedRewards,
+ discountCode: discountCode?.code,
+ discountCodeDisabledAt: discountCode?.disabledAt ?? null,
+ },
+ group,
+ );
});
return NextResponse.json(z.array(PartnerProfileLinkSchema).parse(result));
@@ -191,11 +190,9 @@ export const POST = withPartnerProfile(
const partnerLink = await createLink(linkWithUtm);
- const hidePartnerRevenue = isPartnerRevenueHidden(group);
-
return NextResponse.json(
PartnerProfileLinkSchema.parse(
- hidePartnerRevenue ? zeroSaleAmount(partnerLink) : partnerLink,
+ hidePartnerSaleAmount(partnerLink, group),
),
{
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 d20e50bec7..637a2e3325 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,7 +1,6 @@
import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enrollment-or-throw";
import { withPartnerProfile } from "@/lib/auth/partner";
-import { zeroSaleAmount } from "@/lib/partners/hide-partner-revenue";
-import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
+import { hidePartnerSaleAmount } from "@/lib/partners/hide-partner-revenue";
import { ProgramEnrollmentSchema } from "@/lib/zod/schemas/programs";
import { Reward } from "@prisma/client";
import { NextResponse } from "next/server";
@@ -41,13 +40,12 @@ 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) =>
- hidePartnerRevenue ? zeroSaleAmount(link) : link,
+ hidePartnerSaleAmount(link, partnerGroup),
),
rewards,
group: partnerGroup,
diff --git a/apps/web/lib/api/partner-profile/get-earnings-for-partner.ts b/apps/web/lib/api/partner-profile/get-earnings-for-partner.ts
index 2d08bb15ed..baf66ef321 100644
--- a/apps/web/lib/api/partner-profile/get-earnings-for-partner.ts
+++ b/apps/web/lib/api/partner-profile/get-earnings-for-partner.ts
@@ -2,6 +2,8 @@ import { getStartEndDates } from "@/lib/analytics/utils/get-start-end-dates";
import { DubApiError } from "@/lib/api/errors";
import { buildPaginationQuery } from "@/lib/api/pagination";
import { generateRandomName } from "@/lib/names";
+import { nullAmount } from "@/lib/partners/hide-partner-revenue";
+import { isPartnerRevenueHidden } from "@/lib/partners/is-partner-revenue-hidden";
import { prisma } from "@/lib/prisma";
import {
getPartnerEarningsQuerySchema,
@@ -134,6 +136,11 @@ export async function getEarningsForPartner(
programEnrollment: {
select: {
customerDataSharingEnabledAt: true,
+ partnerGroup: {
+ select: {
+ revenueDataSharingDisabledAt: true,
+ },
+ },
},
},
},
@@ -178,7 +185,7 @@ export async function getEarningsForPartner(
const customerEmail =
e.customer?.email || e.customer?.name || generateRandomName();
- return {
+ const earning = {
...e,
customer: e.customer
? {
@@ -190,6 +197,10 @@ export async function getEarningsForPartner(
}
: null,
};
+
+ return isPartnerRevenueHidden(programEnrollment.partnerGroup)
+ ? nullAmount(earning)
+ : earning;
}),
);
}
diff --git a/apps/web/lib/partners/is-partner-revenue-hidden.ts b/apps/web/lib/partners/is-partner-revenue-hidden.ts
index 242aaf6515..e5c8fc4b8e 100644
--- a/apps/web/lib/partners/is-partner-revenue-hidden.ts
+++ b/apps/web/lib/partners/is-partner-revenue-hidden.ts
@@ -1,11 +1,7 @@
-import { PartnerGroup } from "@prisma/client";
-
/** Group shape used to decide whether sale dollar amounts are hidden from partners. */
-export type PartnerRevenueVisibilityGroup =
- | Pick<PartnerGroup, "revenueDataSharingDisabledAt">
- | { revenueDataSharingDisabledAt?: Date | string | null }
- | null
- | undefined;
+export type PartnerRevenueVisibilityGroup = {
+ revenueDataSharingDisabledAt?: Date | string | null;
+} | null | undefined;
/** Whether partners in this group should not see sale dollar amounts. */
export function isPartnerRevenueHidden(
diff --git a/apps/web/lib/postback/schemas.ts b/apps/web/lib/postback/schemas.ts
index e889cce98c..19d5c044a9 100644
--- a/apps/web/lib/postback/schemas.ts
+++ b/apps/web/lib/postback/schemas.ts
@@ -75,7 +75,7 @@ export const saleEventPostbackSchema = z.object({
link: postbackLinkSchema,
customer: postbackCustomerSchema,
sale: z.object({
- amount: z.number(),
+ amount: z.number().nullable(),
currency: z.string(),
}),
});
@@ -91,6 +91,7 @@ export const commissionEventPostbackSchema = CommissionSchema.pick({
quantity: true,
createdAt: true,
}).extend({
+ amount: z.number().nullable(),
link: postbackLinkSchema.nullable(),
customer: postbackCustomerSchema.nullable(),
});
diff --git a/apps/web/lib/zod/schemas/partner-profile.ts b/apps/web/lib/zod/schemas/partner-profile.ts
index 5a484d5623..c6eed98a03 100644
--- a/apps/web/lib/zod/schemas/partner-profile.ts
+++ b/apps/web/lib/zod/schemas/partner-profile.ts
@@ -41,6 +41,7 @@ export const PartnerEarningsSchema = CommissionSchema.omit({
invoiceId: true,
metadata: true,
}).extend({
+ amount: z.number().nullable(),
customer: z
.object({
id: z.string(),
@@ -195,6 +196,7 @@ export const PartnerProfileLinkSchema = LinkSchema.pick({
saleAmount: true,
comments: true,
}).extend({
+ saleAmount: centsSchema.nullable(),
createdAt: z.string().or(z.date()),
partnerGroupDefaultLinkId: z.string().nullish(),
clickReward: RewardSchema.nullable().default(null),
@@ -317,7 +319,7 @@ export const PartnerBountySchema = BountySchema.omit({
totalLeads: z.number(),
totalConversions: z.number(),
totalSales: z.number(),
- totalSaleAmount: centsSchema,
+ totalSaleAmount: centsSchema.nullable(),
totalCommissions: centsSchema,
}),
});
diff --git a/apps/web/lib/zod/schemas/programs.ts b/apps/web/lib/zod/schemas/programs.ts
index a0267bc3d5..7b5e010dc4 100644
--- a/apps/web/lib/zod/schemas/programs.ts
+++ b/apps/web/lib/zod/schemas/programs.ts
@@ -22,7 +22,7 @@ import { programInviteEmailDataSchema } from "./program-invite-email";
import { RewardSchema } from "./rewards";
import { submittedLeadFormSchema } from "./submitted-lead-form";
import { UserSchema } from "./users";
-import { centsSchemaWithDefault, parseDateSchema } from "./utils";
+import { centsSchema, centsSchemaWithDefault, parseDateSchema } from "./utils";
export const eligibilityConditionSchema = z
.object({
@@ -124,6 +124,8 @@ export const ProgramPartnerLinkSchema = LinkSchema.pick({
conversions: true,
sales: true,
saleAmount: true,
+}).extend({
+ saleAmount: centsSchema.nullable(),
});
// Internal-only fields used by the Dub UI.