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.

Persist lead and sale event metadata on commission records.

Kiran Kee805f757cae
diff --git a/apps/web/app/(ee)/api/workflows/create-partner-commission/route.ts b/apps/web/app/(ee)/api/workflows/create-partner-commission/route.ts
index d64ab12bd1..516346317a 100644
--- a/apps/web/app/(ee)/api/workflows/create-partner-commission/route.ts
+++ b/apps/web/app/(ee)/api/workflows/create-partner-commission/route.ts
@@ -192,6 +192,7 @@ async function stepCreateCommission(
createdAt,
status,
userId,
+ metadata,
context,
programEnrollment,
} = input;
@@ -451,6 +452,7 @@ async function stepCreateCommission(
status,
description,
createdAt,
+ metadata,
},
});
diff --git a/apps/web/lib/api/commissions/create-manual-commissions.ts b/apps/web/lib/api/commissions/create-manual-commissions.ts
index 7e20b3e371..4b50d632b2 100644
--- a/apps/web/lib/api/commissions/create-manual-commissions.ts
+++ b/apps/web/lib/api/commissions/create-manual-commissions.ts
@@ -178,7 +178,7 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
// Lead commission
if (type === CommissionType.lead) {
- const leadMetadata = args.lead?.metadata;
+ const metadata = args.lead?.metadata;
commissionsToCreate.push({
event: CommissionType.lead,
@@ -191,12 +191,13 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
// we don't add the "Z" to the timestamp because it's already in UTC
createdAt: new Date(leadEvent.timestamp),
userId: user.id,
+ ...(metadata != null && { metadata }),
context: {
customer: {
country: targetCustomer.country,
},
lead: {
- ...(leadMetadata != null && { metadata: leadMetadata }),
+ ...(metadata != null && { metadata }),
},
},
});
@@ -222,6 +223,7 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
status: "refunded" as const,
}),
userId: user.id,
+ ...(saleEvent.metadata != null && { metadata: saleEvent.metadata }),
context: {
customer: {
country: targetCustomer.country,
@@ -230,6 +232,7 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
sale: {
productId: saleEvent.productId,
amount: saleEvent.amount,
+ ...(saleEvent.metadata != null && { metadata: saleEvent.metadata }),
},
},
isFirstConversion,
@@ -566,7 +569,7 @@ async function recordEvents(args: RecordEventsArgs) {
const metadata = saleEvent.metadata
? JSON.parse(saleEvent.metadata)
- : undefined;
+ : null;
return {
id: saleEvent.event_id,
@@ -575,6 +578,8 @@ async function recordEvents(args: RecordEventsArgs) {
currency: saleEvent.currency,
invoiceId: saleEvent.invoice_id,
productId: metadata?.productId,
+ // Only persist user-provided metadata on the commission.
+ metadata: stripeInvoice ? null : metadata,
...(stripeInvoice?.refunded && {
status: "refunded" as const,
}),
diff --git a/apps/web/lib/api/conversions/track-lead.ts b/apps/web/lib/api/conversions/track-lead.ts
index 8f39ebc019..015062fb41 100644
--- a/apps/web/lib/api/conversions/track-lead.ts
+++ b/apps/web/lib/api/conversions/track-lead.ts
@@ -300,6 +300,7 @@ export const trackLead = async ({
eventId: leadEventId,
customerId: customer.id,
quantity: eventQuantity ?? 1,
+ ...(metadata != null && { metadata }),
context: {
customer: {
country: customer.country,
diff --git a/apps/web/lib/api/conversions/track-sale.ts b/apps/web/lib/api/conversions/track-sale.ts
index ea4b8472fe..5e890549fe 100644
--- a/apps/web/lib/api/conversions/track-sale.ts
+++ b/apps/web/lib/api/conversions/track-sale.ts
@@ -577,6 +577,7 @@ const _trackSale = async ({
quantity: 1,
invoiceId,
currency,
+ ...(metadata != null && { metadata }),
context: {
customer: {
country: customer.country,
diff --git a/apps/web/lib/zod/schemas/commissions.ts b/apps/web/lib/zod/schemas/commissions.ts
index 5cdfc19895..d61cdd8b51 100644
--- a/apps/web/lib/zod/schemas/commissions.ts
+++ b/apps/web/lib/zod/schemas/commissions.ts
@@ -468,6 +468,7 @@ export const createPartnerCommissionSchema = z.object({
createdAt: z.coerce.date().optional(),
status: commissionPatchStatusSchema.optional(), // used for create-manual-commission (import commission as refunded)
userId: z.string().optional(),
+ metadata: z.record(z.string(), z.any()).nullish(),
context: rewardContextSchema.optional(),
skipWorkflow: z.boolean().default(false).optional(),
isFirstConversion: z.boolean().optional(),
diff --git a/apps/web/playwright/api/commissions/commissions.spec.ts b/apps/web/playwright/api/commissions/commissions.spec.ts
index f2af30dfa5..678b9f2869 100644
--- a/apps/web/playwright/api/commissions/commissions.spec.ts
+++ b/apps/web/playwright/api/commissions/commissions.spec.ts
@@ -580,6 +580,26 @@ test.describe("Sale commissions", () => {
message: "custom: sale.amount: Sale amount cannot be 0.",
}),
},
+ {
+ name: "rejects nested sale fields when importing Stripe invoices",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ importStripeInvoices: true,
+ date: "2024-03-01T08:30:00.000Z",
+ sale: {
+ amount: 5000,
+ invoiceId: "in_test",
+ metadata: { productId: "sku" },
+ },
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: sale: `sale` and `date` cannot be provided when `importStripeInvoices` is enabled.",
+ }),
+ },
{
name: "rejects invalid paymentProcessor",
body: {