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.

Honor nested lead fields on create and seed shared commission test rewards.

Kiran K16c0c8138289
diff --git a/apps/web/lib/api/commissions/create-manual-commissions.ts b/apps/web/lib/api/commissions/create-manual-commissions.ts
index 0680901517..99728e4843 100644
--- a/apps/web/lib/api/commissions/create-manual-commissions.ts
+++ b/apps/web/lib/api/commissions/create-manual-commissions.ts
@@ -181,6 +181,8 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
// Lead commission
if (type === CommissionType.lead) {
+ const leadMetadata = args.lead?.metadata;
+
commissionsToCreate.push({
event: CommissionType.lead,
programId,
@@ -196,6 +198,9 @@ export async function createManualCommissions(args: CreateCommissionsArgs) {
customer: {
country: targetCustomer.country,
},
+ lead: {
+ ...(leadMetadata != null && { metadata: leadMetadata }),
+ },
},
});
}
@@ -415,7 +420,7 @@ async function recordEvents(args: RecordEventsArgs) {
const { workspace, programId, targetLink, targetCustomer } = args;
if (type === "lead") {
- finalLeadEventDate = args.leadEventDate ?? new Date();
+ finalLeadEventDate = args.date ?? args.leadEventDate ?? new Date();
} else if (args.importStripeInvoices) {
stripeCustomerInvoices = await getCustomerStripeInvoices({
stripeCustomerId: targetCustomer.stripeCustomerId!,
@@ -447,8 +452,6 @@ async function recordEvents(args: RecordEventsArgs) {
const clickId = nanoid(16);
const clickedAt = new Date(finalLeadEventDate.getTime() - 5 * 60 * 1000);
- const leadEventName = type === "lead" ? args.leadEventName : "Sign up";
- let saleEvents: z.infer<typeof saleEventSchemaTBWithTimestamp>[] = [];
// Record click event
const clickEvent = recordClickZodSchema.parse({
@@ -464,15 +467,26 @@ async function recordEvents(args: RecordEventsArgs) {
});
// Record lead event
+ const lead =
+ type === "lead"
+ ? {
+ eventName: args.lead?.eventName ?? args.leadEventName ?? "Sign up",
+ metadata: args.lead?.metadata ?? null,
+ }
+ : null;
+
const leadEvent = leadEventSchemaTBWithTimestamp.parse({
...clickEvent,
event_id: nanoid(16),
- event_name: leadEventName ?? "Sign up",
+ event_name: lead?.eventName,
customer_id: targetCustomer.id,
timestamp: finalLeadEventDate.toISOString(),
+ metadata: lead?.metadata ? JSON.stringify(lead.metadata) : "",
});
// Record sale events
+ let saleEvents: z.infer<typeof saleEventSchemaTBWithTimestamp>[] = [];
+
if (type === "sale") {
const {
invoiceId,
diff --git a/apps/web/lib/zod/schemas/commissions.ts b/apps/web/lib/zod/schemas/commissions.ts
index c78b90fa62..1a0e37d435 100644
--- a/apps/web/lib/zod/schemas/commissions.ts
+++ b/apps/web/lib/zod/schemas/commissions.ts
@@ -512,9 +512,9 @@ const createLeadCommissionSchema = z.object({
.string()
.trim()
.max(255)
- .default("Sign up")
+ .nullish()
.describe(
- "The name of the lead event to track. If not provided, defaults to 'Sign up'.",
+ "The name of the lead event to track. If not provided, defaults to 'Sign up'.",
)
.meta({ example: "Sign up" }),
metadata: trackLeadRequestSchema.shape.metadata,
diff --git a/apps/web/playwright/api/clawbacks/clawbacks.spec.ts b/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
index 6928224527..9bdb57c9a0 100644
--- a/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
+++ b/apps/web/playwright/api/clawbacks/clawbacks.spec.ts
@@ -60,37 +60,6 @@ async function expectClawbackCreated({
});
}
-test("POST /commissions – clawback by partnerId", async ({ api, program }) => {
- let partnerId: string | undefined;
-
- try {
- const { status: createStatus, data: created } = await createPartner(api, {
- groupId: program.defaultGroupId,
- });
- partnerId = created.id;
- expect(createStatus).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "custom",
- partnerId,
- amount: -500,
- description: "fraud",
- });
-
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectClawbackCreated({
- partnerId: created.id,
- programId: program.id,
- amount: 500,
- description: "fraud",
- });
- } finally {
- await deletePartner(partnerId);
- }
-});
-
test("POST /commissions – clawback with arbitrary description", async ({
api,
program,
@@ -152,28 +121,6 @@ const clawbackErrorCases = [
"invalid_type: partnerId: Invalid input: expected string, received undefined",
}),
},
- {
- name: "POST /commissions – clawback amount 0",
- body: {
- type: "custom",
- partnerId: "pn_test",
- amount: 0,
- description: "fraud",
- },
- expected: apiError({
- code: "unprocessable_entity",
- message: "custom: amount: Amount cannot be 0.",
- }),
- },
- {
- name: "POST /commissions – clawback missing description",
- body: { type: "custom", partnerId: "pn_test", amount: -500 },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- "custom: description: `description` is required when creating a clawback (negative amount).",
- }),
- },
];
for (const { name, body, expected } of clawbackErrorCases) {
diff --git a/apps/web/playwright/api/commissions/commissions.spec.ts b/apps/web/playwright/api/commissions/commissions.spec.ts
index d5ab19fcf3..f9f2f8df6c 100644
--- a/apps/web/playwright/api/commissions/commissions.spec.ts
+++ b/apps/web/playwright/api/commissions/commissions.spec.ts
@@ -4,541 +4,499 @@ import { nanoid } from "@dub/utils";
import { expect } from "@playwright/test";
import { apiError, randomCustomer } from "../../utils";
import { test } from "../fixtures";
-import { createPartner, deletePartner } from "../partners/helpers";
-import {
- createPartnerWithCommissionRewards,
- deleteCommissionPartner,
- expectCommissionCreated,
- LEAD_REWARD_CENTS,
- SALE_REWARD_CENTS,
-} from "./helpers";
+import { TEST_COMMISSION_REWARDS } from "../setup-test-workspace";
+import { expectCommissionCreated, withCommissionPartner } from "./helpers";
const expectedQueuedResponse = {
- success: true,
- message: "Your commissions are being created and will appear shortly.",
+ status: 202,
+ data: {
+ success: true,
+ message: "Your commissions are being created and will appear shortly.",
+ },
+};
+
+const expectedClawbackResponse = {
+ status: 202,
+ data: {
+ success: true,
+ message: "A clawback has been queued for the partner!",
+ },
};
const oversizedMetadata = {
blob: "x".repeat(10_000),
};
-test("POST /commissions – custom", async ({ api, program }) => {
- let partnerId: string | undefined;
- const description = `custom-${nanoid()}`;
-
- try {
- const { status: createStatus, data: created } = await createPartner(api, {
- groupId: program.defaultGroupId,
- });
- partnerId = created.id;
- expect(createStatus).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "custom",
- partnerId,
- amount: 500,
- description,
- });
+function customerBody() {
+ const customer = randomCustomer();
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
+ return {
+ externalId: customer.externalId,
+ email: customer.email,
+ name: customer.name,
+ country: "US",
+ };
+}
- await expectCommissionCreated({
- partnerId: created.id,
- programId: program.id,
- type: "custom",
- description,
- expectedAmount: 0,
- expectedEarnings: 500,
+test.describe("Custom commissions", () => {
+ test("creates a custom commission", async ({ api, program }) => {
+ const description = `custom-${nanoid()}`;
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "custom",
+ partnerId,
+ amount: 500,
+ description,
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "custom",
+ description,
+ expectedAmount: 0,
+ expectedEarnings: 500,
+ });
});
- } finally {
- await deletePartner(partnerId);
- }
-});
-
-test("POST /commissions – lead", async ({ api, program }) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const customer = randomCustomer();
+ });
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "lead",
- partnerId,
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
- },
+ test("creates a clawback", async ({ api, program }) => {
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "custom",
+ partnerId,
+ amount: -500,
+ description: "fraud",
+ }),
+ ).toEqual(expectedClawbackResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "custom",
+ description: "fraud",
+ expectedAmount: 0,
+ expectedEarnings: -500,
+ });
});
+ });
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
+ test.describe("validates", () => {
+ const errorCases = [
+ {
+ name: "rejects amount of 0",
+ body: { type: "custom", partnerId: "pn_test", amount: 0 },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message: "custom: amount: Amount cannot be 0.",
+ }),
+ },
+ {
+ name: "rejects clawback without description",
+ body: { type: "custom", partnerId: "pn_test", amount: -500 },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: description: `description` is required when creating a clawback (negative amount).",
+ }),
+ },
+ ];
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "lead",
- expectedAmount: 0,
- expectedEarnings: LEAD_REWARD_CENTS,
- });
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
+ for (const { name, body, expected } of errorCases) {
+ test(name, async ({ api }) => {
+ expect(await api.post("/api/commissions", body)).toEqual(expected);
+ });
+ }
+ });
});
-test("POST /commissions – sale", async ({ api, program }) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const invoiceId = `INV_${nanoid()}`;
- const customer = randomCustomer();
-
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "sale",
- partnerId,
- saleAmount: 1000,
- invoiceId,
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
- },
+test.describe("Lead commissions", () => {
+ test("creates a lead commission", async ({ api, program }) => {
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "lead",
+ partnerId,
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "lead",
+ });
});
+ });
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "sale",
- invoiceId,
- expectedAmount: 1000,
- expectedEarnings: SALE_REWARD_CENTS,
+ test("creates using date + lead.eventName", async ({ api, program }) => {
+ const date = new Date("2024-01-10T00:00:00.000Z");
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "lead",
+ partnerId,
+ date: date.toISOString(),
+ lead: {
+ eventName: "Requested demo",
+ metadata: { plan: "pro" },
+ },
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "lead",
+ expectedEarnings:
+ TEST_COMMISSION_REWARDS.lead.modifiers[0].amountInCents,
+ expectedCreatedAt: date,
+ });
});
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
-});
-
-test("POST /commissions – customer not found", async ({ api, program }) => {
- let partnerId: string | undefined;
+ });
- try {
- const { status: createStatus, data: created } = await createPartner(api, {
- groupId: program.defaultGroupId,
+ test("supports deprecated leadEventName + leadEventDate", async ({
+ api,
+ program,
+ }) => {
+ const leadEventDate = new Date("2024-06-15T12:00:00.000Z");
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "lead",
+ partnerId,
+ leadEventName: "Signed up",
+ leadEventDate: leadEventDate.toISOString(),
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "lead",
+ expectedCreatedAt: leadEventDate,
+ });
});
- partnerId = created.id;
- expect(createStatus).toEqual(201);
+ });
- expect(
- await api.post("/api/commissions", {
- type: "sale",
+ test("date takes precedence over leadEventDate", async ({ api, program }) => {
+ const date = new Date("2024-08-01T00:00:00.000Z");
+ const leadEventDate = new Date("2020-01-01T00:00:00.000Z");
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "lead",
+ partnerId,
+ date: date.toISOString(),
+ leadEventDate: leadEventDate.toISOString(),
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
partnerId,
- customerId: "cus_nonexistent",
- saleAmount: 1000,
- }),
- ).toEqual(
- apiError({
- code: "not_found",
- message: "Customer cus_nonexistent not found.",
- }),
- );
- } finally {
- await deletePartner(partnerId);
- }
-});
-
-test("POST /commissions – duplicate invoiceId", async ({ api, program }) => {
- let partnerId: string | undefined;
- const invoiceId = `INV_${nanoid()}`;
- const customer = randomCustomer();
+ programId: program.id,
+ type: "lead",
+ expectedCreatedAt: date,
+ });
+ });
+ });
- try {
- const { status: createStatus, data: created } = await createPartner(api, {
- groupId: program.defaultGroupId,
+ test.describe("validates", () => {
+ test("rejects oversized metadata", async ({ api }) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "lead",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ lead: { metadata: oversizedMetadata },
+ }),
+ ).toEqual(
+ apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: lead.metadata: Metadata must be less than 10,000 characters when stringified",
+ }),
+ );
});
- partnerId = created.id;
- expect(createStatus).toEqual(201);
+ });
+});
- await prisma.commission.create({
- data: {
- id: createId({ prefix: "cm_" }),
+test.describe("Sale commissions", () => {
+ test("creates a sale commission", async ({ api, program }) => {
+ const invoiceId = `INV_${nanoid()}`;
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ saleAmount: 1000,
+ invoiceId,
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
programId: program.id,
- partnerId: created.id,
type: "sale",
- amount: 1000,
- earnings: 100,
- quantity: 1,
invoiceId,
- },
+ });
});
+ });
- expect(
- await api.post("/api/commissions", {
- type: "sale",
+ test("creates using nested sale", async ({ api, program }) => {
+ const invoiceId = `INV_${nanoid()}`;
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ saleAmount: 1000,
+ invoiceId,
+ sale: {
+ amount: 1000,
+ currency: "usd",
+ eventName: "Invoice paid",
+ paymentProcessor: "stripe",
+ invoiceId,
+ metadata: { productId: "sku_nested" },
+ },
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
partnerId,
- saleAmount: 1000,
+ programId: program.id,
+ type: "sale",
invoiceId,
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
- },
- }),
- ).toEqual(
- apiError({
- code: "conflict",
- message: `There is already a commission for the invoice ${invoiceId}.`,
- }),
- );
- } finally {
- await deleteCommissionPartner({ partnerId });
- }
-});
-
-test("POST /commissions – lead with deprecated leadEventName and leadEventDate", async ({
- api,
- program,
-}) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const customer = randomCustomer();
- const leadEventDate = new Date("2024-06-15T12:00:00.000Z");
-
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "lead",
- partnerId,
- leadEventName: "Signed up",
- leadEventDate: leadEventDate.toISOString(),
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
- },
+ });
});
+ });
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "lead",
- expectedAmount: 0,
- expectedEarnings: LEAD_REWARD_CENTS,
- expectedCreatedAt: leadEventDate,
+ test("supports deprecated sale fields", async ({ api, program }) => {
+ const invoiceId = `INV_${nanoid()}`;
+ const saleEventDate = new Date("2024-03-01T08:30:00.000Z");
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ saleAmount: 1000,
+ invoiceId,
+ productId: "sku_deprecated",
+ saleEventDate: saleEventDate.toISOString(),
+ customer: customerBody(),
+ }),
+ ).toEqual(expectedQueuedResponse);
+
+ await expectCommissionCreated({
+ partnerId,
+ programId: program.id,
+ type: "sale",
+ invoiceId,
+ expectedCreatedAt: saleEventDate,
+ });
});
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
-});
-
-test("POST /commissions – sale with deprecated saleEventDate and productId", async ({
- api,
- program,
-}) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const invoiceId = `INV_${nanoid()}`;
- const customer = randomCustomer();
- const saleEventDate = new Date("2024-03-01T08:30:00.000Z");
+ });
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "sale",
- partnerId,
- saleAmount: 1000,
- invoiceId,
- productId: "sku_deprecated",
- saleEventDate: saleEventDate.toISOString(),
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
- },
+ test("rejects duplicate invoice", async ({ api, program }) => {
+ const invoiceId = `INV_${nanoid()}`;
+
+ await withCommissionPartner(api, program, async (partnerId) => {
+ await prisma.commission.create({
+ data: {
+ id: createId({ prefix: "cm_" }),
+ programId: program.id,
+ partnerId,
+ type: "sale",
+ amount: 1000,
+ earnings: 100,
+ quantity: 1,
+ invoiceId,
+ },
+ });
+
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ saleAmount: 1000,
+ invoiceId,
+ customer: customerBody(),
+ }),
+ ).toEqual(
+ apiError({
+ code: "conflict",
+ message: `There is already a commission for the invoice ${invoiceId}.`,
+ }),
+ );
});
+ });
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "sale",
- invoiceId,
- expectedAmount: 1000,
- expectedEarnings: SALE_REWARD_CENTS,
- expectedCreatedAt: saleEventDate,
+ test("imports Stripe invoices", async ({ api, program, workspace }) => {
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ importStripeInvoices: true,
+ customer: customerBody(),
+ }),
+ ).toEqual(
+ apiError({
+ code: "bad_request",
+ message: `Your workspace isn't connected to Stripe yet. Please install the Stripe integration to continue: https://app.dub.co/${workspace.slug}/settings/integrations/stripe`,
+ }),
+ );
});
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
-});
-
-test("POST /commissions – lead with date and lead.eventName", async ({
- api,
- program,
-}) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const customer = randomCustomer();
+ });
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "lead",
- partnerId,
- date: new Date("2024-01-10T00:00:00.000Z").toISOString(),
- lead: {
- eventName: "Requested demo",
- metadata: { plan: "pro" },
+ test.describe("validates", () => {
+ const errorCases = [
+ {
+ name: "rejects missing saleAmount",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ importStripeInvoices: false,
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: saleAmount: `saleAmount` is required when `importStripeInvoices` is false.",
+ }),
},
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
+ {
+ name: "rejects saleAmount of 0",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ importStripeInvoices: false,
+ saleAmount: 0,
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message: "custom: saleAmount: Sale amount cannot be 0.",
+ }),
},
- });
-
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "lead",
- expectedAmount: 0,
- expectedEarnings: LEAD_REWARD_CENTS,
- });
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
-});
-
-test("POST /commissions – sale with nested sale and deprecated saleAmount", async ({
- api,
- program,
-}) => {
- let partnerId: string | undefined;
- let groupId: string | undefined;
- const invoiceId = `INV_${nanoid()}`;
- const customer = randomCustomer();
-
- try {
- const created = await createPartnerWithCommissionRewards(api, {
- programId: program.id,
- });
- partnerId = created.data.id;
- groupId = created.groupId;
- expect(created.status).toEqual(201);
-
- const { status, data } = await api.post("/api/commissions", {
- type: "sale",
- partnerId,
- saleAmount: 1000,
- invoiceId,
- sale: {
- amount: 1000,
- currency: "usd",
- eventName: "Invoice paid",
- paymentProcessor: "stripe",
- invoiceId,
- metadata: { productId: "sku_nested" },
+ {
+ name: "rejects missing sale.amount",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ saleAmount: 1000,
+ sale: {},
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message: "invalid_type: sale.amount: amount is required",
+ }),
},
- customer: {
- externalId: customer.externalId,
- email: customer.email,
- name: customer.name,
- country: "US",
+ {
+ name: "rejects invalid paymentProcessor",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ sale: { amount: 1000, paymentProcessor: "foo" },
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ 'invalid_value: sale.paymentProcessor: Invalid option: expected one of "stripe"|"shopify"|"polar"|"paddle"|"apple"|"revenuecat"|"dub"|"custom"',
+ }),
},
+ {
+ name: "rejects oversized metadata",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ sale: { amount: 1000, metadata: oversizedMetadata },
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: sale.metadata: Metadata must be less than 10,000 characters when stringified",
+ }),
+ },
+ {
+ name: "rejects sale.amount without saleAmount",
+ body: {
+ type: "sale",
+ partnerId: "pn_test",
+ customerId: "cus_test",
+ sale: { amount: 1000 },
+ },
+ expected: apiError({
+ code: "unprocessable_entity",
+ message:
+ "custom: saleAmount: `saleAmount` is required when `importStripeInvoices` is false.",
+ }),
+ },
+ ];
+
+ for (const { name, body, expected } of errorCases) {
+ test(name, async ({ api }) => {
+ expect(await api.post("/api/commissions", body)).toEqual(expected);
+ });
+ }
+
+ test("rejects unknown customer", async ({ api, program }) => {
+ await withCommissionPartner(api, program, async (partnerId) => {
+ expect(
+ await api.post("/api/commissions", {
+ type: "sale",
+ partnerId,
+ customerId: "cus_nonexistent",
+ saleAmount: 1000,
+ }),
+ ).toEqual(
+ apiError({
+ code: "not_found",
+ message: "Customer cus_nonexistent not found.",
+ }),
+ );
+ });
});
-
- expect(status).toEqual(202);
- expect(data).toStrictEqual(expectedQueuedResponse);
-
- await expectCommissionCreated({
- partnerId: created.data.id,
- programId: program.id,
- type: "sale",
- invoiceId,
- expectedAmount: 1000,
- expectedEarnings: SALE_REWARD_CENTS,
- });
- } finally {
- await deleteCommissionPartner({ partnerId, groupId });
- }
+ });
});
-const commissionErrorCases = [
+const typeErrorCases = [
{
- name: "POST /commissions – missing type",
+ name: "rejects missing type",
body: { partnerId: "pn_test", amount: 500 },
- expected: apiError({
- code: "unprocessable_entity",
- message: "invalid_union: type: Invalid input",
- }),
},
{
- name: "POST /commissions – invalid type",
+ name: "rejects invalid type",
body: { type: "invalid", partnerId: "pn_test" },
- expected: apiError({
- code: "unprocessable_entity",
- message: "invalid_union: type: Invalid input",
- }),
- },
- {
- name: "POST /commissions – custom amount 0",
- body: { type: "custom", partnerId: "pn_test", amount: 0 },
- expected: apiError({
- code: "unprocessable_entity",
- message: "custom: amount: Amount cannot be 0.",
- }),
- },
- {
- name: "POST /commissions – sale missing saleAmount",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- importStripeInvoices: false,
- },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- "custom: saleAmount: `saleAmount` is required when `importStripeInvoices` is false.",
- }),
- },
- {
- name: "POST /commissions – sale.amount without saleAmount",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- sale: { amount: 1000 },
- },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- "custom: saleAmount: `saleAmount` is required when `importStripeInvoices` is false.",
- }),
- },
- {
- name: "POST /commissions – saleAmount 0",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- importStripeInvoices: false,
- saleAmount: 0,
- },
- expected: apiError({
- code: "unprocessable_entity",
- message: "custom: saleAmount: Sale amount cannot be 0.",
- }),
- },
- {
- name: "POST /commissions – sale object missing amount",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- saleAmount: 1000,
- sale: {},
- },
- expected: apiError({
- code: "unprocessable_entity",
- message: "invalid_type: sale.amount: amount is required",
- }),
- },
- {
- name: "POST /commissions – invalid paymentProcessor",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- sale: { amount: 1000, paymentProcessor: "foo" },
- },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- 'invalid_value: sale.paymentProcessor: Invalid option: expected one of "stripe"|"shopify"|"polar"|"paddle"|"apple"|"revenuecat"|"dub"|"custom"',
- }),
- },
- {
- name: "POST /commissions – sale metadata too large",
- body: {
- type: "sale",
- partnerId: "pn_test",
- customerId: "cus_test",
- sale: { amount: 1000, metadata: oversizedMetadata },
- },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- "custom: sale.metadata: Metadata must be less than 10,000 characters when stringified",
- }),
- },
- {
- name: "POST /commissions – lead metadata too large",
- body: {
- type: "lead",
- partnerId: "pn_test",
- customerId: "cus_test",
- lead: { metadata: oversizedMetadata },
- },
- expected: apiError({
- code: "unprocessable_entity",
- message:
- "custom: lead.metadata: Metadata must be less than 10,000 characters when stringified",
- }),
},
];
-for (const { name, body, expected } of commissionErrorCases) {
+for (const { name, body } of typeErrorCases) {
test(name, async ({ api }) => {
- expect(await api.post("/api/commissions", body)).toEqual(expected);
+ expect(await api.post("/api/commissions", body)).toEqual(
+ apiError({
+ code: "unprocessable_entity",
+ message: "invalid_union: type: Invalid input",
+ }),
+ );
});
}
diff --git a/apps/web/playwright/api/commissions/helpers.ts b/apps/web/playwright/api/commissions/helpers.ts
index bab34b3fc8..8f6fbf9972 100644
--- a/apps/web/playwright/api/commissions/helpers.ts
+++ b/apps/web/playwright/api/commissions/helpers.ts
@@ -1,82 +1,32 @@
-import { createId } from "@/lib/api/create-id";
import { prisma } from "@/lib/prisma";
-import { DEFAULT_ADDITIONAL_PARTNER_LINKS } from "@/lib/zod/schemas/groups";
-import { nanoid } from "@dub/utils";
import { expect } from "@playwright/test";
-import { EventType, RewardStructure } from "@prisma/client";
import type { ApiClient } from "../fixtures";
import { createPartner, deletePartner } from "../partners/helpers";
-import { TEST_WORKSPACE } from "../setup-test-workspace";
+import { TEST_COMMISSION_REWARDS } from "../setup-test-workspace";
-export const LEAD_REWARD_CENTS = 1000;
-export const SALE_REWARD_CENTS = 2500;
-
-export async function createPartnerWithCommissionRewards(
+export async function withCommissionPartner(
api: ApiClient,
- { programId }: { programId: string },
+ program: { defaultGroupId: string },
+ run: (partnerId: string) => Promise<void>,
) {
- const groupId = createId({ prefix: "grp_" });
-
- const [leadReward, saleReward] = await Promise.all([
- prisma.reward.create({
- data: {
- id: createId({ prefix: "rw_" }),
- programId,
- event: EventType.lead,
- type: RewardStructure.flat,
- amountInCents: LEAD_REWARD_CENTS,
- },
- }),
- prisma.reward.create({
- data: {
- id: createId({ prefix: "rw_" }),
- programId,
- event: EventType.sale,
- type: RewardStructure.flat,
- amountInCents: SALE_REWARD_CENTS,
- maxDuration: 0,
- },
- }),
- ]);
-
- await prisma.partnerGroup.create({
- data: {
- id: groupId,
- programId,
- slug: `pw-cm-${nanoid(8).toLowerCase()}`,
- name: "Playwright Commissions",
- maxPartnerLinks: DEFAULT_ADDITIONAL_PARTNER_LINKS,
- leadRewardId: leadReward.id,
- saleRewardId: saleReward.id,
- },
- });
-
- await prisma.partnerGroupDefaultLink.create({
- data: {
- id: createId({ prefix: "pgdl_" }),
- programId,
- groupId,
- domain: TEST_WORKSPACE.program.domain,
- url: TEST_WORKSPACE.program.url,
- },
- });
-
- const created = await createPartner(api, {
- groupId,
- });
+ let partnerId: string | undefined;
- return {
- ...created,
- groupId,
- };
+ try {
+ const { status, data } = await createPartner(api, {
+ groupId: program.defaultGroupId,
+ });
+ partnerId = data.id;
+ expect(status).toEqual(201);
+ await run(partnerId);
+ } finally {
+ await deleteCommissionPartner({ partnerId });
+ }
}
export async function deleteCommissionPartner({
partnerId,
- groupId,
}: {
partnerId: string | undefined;
- groupId?: string;
}) {
if (partnerId) {
const links = await prisma.link.findMany({
@@ -101,60 +51,6 @@ export async function deleteCommissionPartner({
}
await deletePartner(partnerId);
-
- if (!groupId) {
- return;
- }
-
- const group = await prisma.partnerGroup.findUnique({
- where: {
- id: groupId,
- },
- select: {
- leadRewardId: true,
- saleRewardId: true,
- },
- });
-
- if (!group) {
- return;
- }
-
- await prisma.partnerGroupDefaultLink.deleteMany({
- where: {
- groupId,
- },
- });
-
- await prisma.partnerGroup.update({
- where: {
- id: groupId,
- },
- data: {
- leadRewardId: null,
- saleRewardId: null,
- },
- });
-
- await prisma.partnerGroup.delete({
- where: {
- id: groupId,
- },
- });
-
- const rewardIds = [group.leadRewardId, group.saleRewardId].filter(
- (id): id is string => id != null,
- );
-
- if (rewardIds.length > 0) {
- await prisma.reward.deleteMany({
- where: {
- id: {
- in: rewardIds,
- },
- },
- });
- }
}
export async function expectCommissionCreated({
@@ -172,10 +68,20 @@ export async function expectCommissionCreated({
type: "custom" | "lead" | "sale";
description?: string;
invoiceId?: string;
- expectedAmount: number;
- expectedEarnings: number;
+ expectedAmount?: number;
+ expectedEarnings?: number;
expectedCreatedAt?: Date;
}) {
+ const amount =
+ expectedAmount ?? (type === "lead" ? 0 : type === "sale" ? 1000 : 0);
+ const earnings =
+ expectedEarnings ??
+ (type === "lead"
+ ? TEST_COMMISSION_REWARDS.lead.amountInCents
+ : type === "sale"
+ ? TEST_COMMISSION_REWARDS.sale.amountInCents
+ : 0);
+
await expect
.poll(async () => {
const commission = await prisma.commission.findFirst({
@@ -211,8 +117,8 @@ export async function expectCommissionCreated({
partnerId,
programId,
type,
- amount: expectedAmount,
- earnings: expectedEarnings,
+ amount,
+ earnings,
quantity: 1,
description: description ?? null,
invoiceId: invoiceId ?? null,
diff --git a/apps/web/playwright/api/setup-test-workspace.ts b/apps/web/playwright/api/setup-test-workspace.ts
index ad01b77312..bf6df951d3 100644
--- a/apps/web/playwright/api/setup-test-workspace.ts
+++ b/apps/web/playwright/api/setup-test-workspace.ts
@@ -5,6 +5,7 @@ import {
DEFAULT_ADDITIONAL_PARTNER_LINKS,
DEFAULT_PARTNER_GROUP,
} from "@/lib/zod/schemas/groups";
+import { EventType, RewardStructure } from "@prisma/client";
import { config as loadEnv } from "dotenv-flow";
import { mkdir, writeFile } from "fs/promises";
import path from "path";
@@ -33,6 +34,38 @@ export const TEST_WORKSPACE = {
},
} as const;
+export const TEST_COMMISSION_REWARDS = {
+ lead: {
+ id: "rw_playwright_api_lead",
+ event: EventType.lead,
+ type: RewardStructure.flat,
+ amountInCents: 1000,
+ modifiers: [
+ {
+ operator: "AND",
+ type: RewardStructure.flat,
+ amountInCents: 5000,
+ conditions: [
+ {
+ entity: "lead",
+ attribute: "metadata",
+ metadataField: "plan",
+ operator: "equals_to",
+ value: "pro",
+ },
+ ],
+ },
+ ],
+ },
+ sale: {
+ id: "rw_playwright_api_sale",
+ event: EventType.sale,
+ type: RewardStructure.flat,
+ amountInCents: 2500,
+ maxDuration: 0,
+ },
+} as const;
+
const authFile = path.join(__dirname, "../.auth/api.json");
// Upserts a dedicated Playwright API user, workspace, membership,
@@ -259,6 +292,25 @@ async function setupTestProgram({
},
});
+ await Promise.all(
+ [TEST_COMMISSION_REWARDS.lead, TEST_COMMISSION_REWARDS.sale].map(
+ (reward) => {
+ const { id, ...data } = reward;
+ return prisma.reward.upsert({
+ where: {
+ id,
+ },
+ create: {
+ id,
+ programId: program.id,
+ ...data,
+ },
+ update: data,
+ });
+ },
+ ),
+ );
+
const group = await prisma.partnerGroup.upsert({
where: {
programId_slug: {
@@ -273,10 +325,14 @@ async function setupTestProgram({
name: DEFAULT_PARTNER_GROUP.name,
color: DEFAULT_PARTNER_GROUP.color,
maxPartnerLinks: DEFAULT_ADDITIONAL_PARTNER_LINKS,
+ leadRewardId: TEST_COMMISSION_REWARDS.lead.id,
+ saleRewardId: TEST_COMMISSION_REWARDS.sale.id,
},
update: {
name: DEFAULT_PARTNER_GROUP.name,
maxPartnerLinks: DEFAULT_ADDITIONAL_PARTNER_LINKS,
+ leadRewardId: TEST_COMMISSION_REWARDS.lead.id,
+ saleRewardId: TEST_COMMISSION_REWARDS.sale.id,
},
});