The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Geo-specific CPC rewards (#3239)
Kiran K3af0af9bb434
diff --git a/apps/web/app/(ee)/api/cron/aggregate-clicks/resolve-click-reward-amount.ts b/apps/web/app/(ee)/api/cron/aggregate-clicks/resolve-click-reward-amount.tsnew file mode 100644index 0000000000..8669aeb67c--- /dev/null+++ b/apps/web/app/(ee)/api/cron/aggregate-clicks/resolve-click-reward-amount.ts@@ -0,0 +1,43 @@+import { serializeReward } from "@/lib/api/partners/serialize-reward";+import { evaluateRewardConditions } from "@/lib/partners/evaluate-reward-conditions";+import { getRewardAmount } from "@/lib/partners/get-reward-amount";+import { rewardConditionsArraySchema } from "@/lib/zod/schemas/rewards";+import { Reward } from "@dub/prisma/client";++// Resolve the click reward amount for a given reward and country+export function resolveClickRewardAmount({+ reward,+ country,+}: {+ reward: Reward;+ country: string;+}): number {+ let partnerReward = reward;++ if (reward.modifiers) {+ const modifiers = rewardConditionsArraySchema.safeParse(reward.modifiers);++ if (modifiers.success) {+ const matchedCondition = evaluateRewardConditions({+ conditions: modifiers.data,+ context: {+ customer: {+ country,+ },+ },+ });++ if (matchedCondition) {+ partnerReward = {+ ...partnerReward,+ amountInCents:+ matchedCondition.amountInCents != null+ ? matchedCondition.amountInCents+ : null,+ };+ }+ }+ }++ return getRewardAmount(serializeReward(partnerReward));+}diff --git a/apps/web/app/(ee)/api/cron/aggregate-clicks/route.ts b/apps/web/app/(ee)/api/cron/aggregate-clicks/route.tsindex bb0035a22d..ebc78a7ede 100644--- a/apps/web/app/(ee)/api/cron/aggregate-clicks/route.ts+++ b/apps/web/app/(ee)/api/cron/aggregate-clicks/route.ts@@ -1,18 +1,21 @@-import { getAnalytics } from "@/lib/analytics/get-analytics";import { createId } from "@/lib/api/create-id";import { handleAndReturnErrorResponse } from "@/lib/api/errors";-import { serializeReward } from "@/lib/api/partners/serialize-reward";import { syncTotalCommissions } from "@/lib/api/partners/sync-total-commissions";import { qstash } from "@/lib/cron";import { verifyQstashSignature } from "@/lib/cron/verify-qstash";import { verifyVercelSignature } from "@/lib/cron/verify-vercel";-import { getRewardAmount } from "@/lib/partners/get-reward-amount";-import { analyticsResponse } from "@/lib/zod/schemas/analytics-response";+import { getTopLinksByCountries } from "@/lib/tinybird/get-top-links-by-countries";import { prisma } from "@dub/prisma";import { CommissionType, Prisma } from "@dub/prisma/client";-import { APP_DOMAIN_WITH_NGROK, nFormatter } from "@dub/utils";+import {+ APP_DOMAIN_WITH_NGROK,+ currencyFormatter,+ getPrettyUrl,+ nFormatter,+} from "@dub/utils";import { z } from "zod";import { logAndRespond } from "../utils";+import { resolveClickRewardAmount } from "./resolve-click-reward-amount";export const dynamic = "force-dynamic";@@ -73,6 +76,7 @@ async function handler(req: Request) {},select: {id: true,+ shortLink: true,programId: true,partnerId: true,programEnrollment: {@@ -99,39 +103,82 @@ async function handler(req: Request) {return logAndRespond(endMessage);}- console.time("getAnalytics");- // getting the actual click count for the links for the previous day- const linkClickStats: z.infer<(typeof analyticsResponse)["top_links"]>[] =- await getAnalytics({- event: "clicks",- groupBy: "top_links",- linkIds: linksWithClickRewards.map(({ id }) => id),- start,- end,- });- console.timeEnd("getAnalytics");+ const clicksByCountries = await getTopLinksByCountries({+ linkIds: linksWithClickRewards.map(({ id }) => id),+ start,+ end,+ });// This should never happen, but just in case- if (linkClickStats.length === 0) {+ if (clicksByCountries.length === 0) {return logAndRespond(endMessage);}- // creating a map of link id to clicks count (for easy lookup)- const linkClicksMap = new Map(- linkClickStats.map(({ id, clicks }) => [id, clicks]),- );+ // Group clicks by link_id for easier iteration+ const clicksByLinkId = new Map<string, typeof clicksByCountries>();+ for (const click of clicksByCountries) {+ const existing = clicksByLinkId.get(click.link_id) || [];+ existing.push(click);+ clicksByLinkId.set(click.link_id, existing);+ }++ const linkEarningsMap = new Map<+ string,+ { linkClicks: number; earnings: number }+ >();++ // Calculate earnings per link considering geo CPC+ for (const {+ id: linkId,+ shortLink,+ programEnrollment,+ } of linksWithClickRewards) {+ if (!programEnrollment?.clickReward) {+ console.log(`No click reward for link ${linkId}.`);+ continue;+ }++ const linkClicksByCountry = clicksByLinkId.get(linkId) || [];++ // Calculate earnings per country for each link+ for (const { country, clicks } of linkClicksByCountry) {+ const rewardAmount = resolveClickRewardAmount({+ reward: programEnrollment.clickReward,+ country,+ });++ const existing = linkEarningsMap.get(linkId) || {+ linkClicks: 0,+ earnings: 0,+ };- // creating a list of commissions to create+ linkEarningsMap.set(linkId, {+ linkClicks: existing.linkClicks + clicks,+ earnings: existing.earnings + rewardAmount * clicks,+ });++ // only console.log if there are modifiers+ if (programEnrollment.clickReward.modifiers) {+ console.log(+ `Earnings for link ${getPrettyUrl(shortLink)} for ${country}: ${currencyFormatter(rewardAmount)} * ${clicks} = ${currencyFormatter(+ rewardAmount * clicks,+ )}`,+ );+ }+ }+ }++ // Create commissions for each linkconst commissionsToCreate = linksWithClickRewards.map(({ id, programId, partnerId, programEnrollment }) => {if (!programId || !partnerId || !programEnrollment?.clickReward) {return null;}- const linkClicks = linkClicksMap.get(id) ?? 0;- const earnings =- getRewardAmount(serializeReward(programEnrollment.clickReward)) *- linkClicks;+ const { linkClicks, earnings } = linkEarningsMap.get(id) || {+ linkClicks: 0,+ earnings: 0,+ };if (linkClicks === 0 || earnings === 0) {return null;@@ -159,17 +206,19 @@ async function handler(req: Request) {data: commissionsToCreate,});+ // Sync total commissions for each partner that we created commissions forfor (const { partnerId, programId } of commissionsToCreate) {- // Sync total commissions for each partner that we created commissions forawait syncTotalCommissions({partnerId,programId,});}+console.log(`Synced total commissions count for ${commissionsToCreate.length} partners`,);+ // Schedule next batch if we have more links to processif (linksWithClickRewards.length === BATCH_SIZE) {const nextStartingAfter =linksWithClickRewards[linksWithClickRewards.length - 1].id;diff --git a/apps/web/app/(ee)/api/rewards/[rewardId]/route.ts b/apps/web/app/(ee)/api/rewards/[rewardId]/route.tsnew file mode 100644index 0000000000..b5d89ad89c--- /dev/null+++ b/apps/web/app/(ee)/api/rewards/[rewardId]/route.ts@@ -0,0 +1,26 @@+import { DubApiError } from "@/lib/api/errors";+import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";+import { withWorkspace } from "@/lib/auth";+import { RewardSchema } from "@/lib/zod/schemas/rewards";+import { prisma } from "@dub/prisma";+import { NextResponse } from "next/server";++export const GET = withWorkspace(async ({ workspace, params }) => {+ const programId = getDefaultProgramIdOrThrow(workspace);++ const reward = await prisma.reward.findUnique({+ where: {+ id: params.rewardId,+ programId,+ },+ });++ if (!reward) {+ throw new DubApiError({+ code: "not_found",+ message: "Reward not found.",+ });+ }++ return NextResponse.json(RewardSchema.parse(reward));+});diff --git a/apps/web/app/(ee)/api/programs/[programId]/rewards/route.ts b/apps/web/app/(ee)/api/rewards/route.tssimilarity index 84%rename from apps/web/app/(ee)/api/programs/[programId]/rewards/route.tsrename to apps/web/app/(ee)/api/rewards/route.tsindex c7a6e70e82..e78c724845 100644--- a/apps/web/app/(ee)/api/programs/[programId]/rewards/route.ts+++ b/apps/web/app/(ee)/api/rewards/route.ts@@ -5,8 +5,7 @@ import { prisma } from "@dub/prisma";import { NextResponse } from "next/server";import { z } from "zod";-// TODO: Remove once we migrate fully to partner groups-// GET /api/programs/[programId]/rewards - get all rewards for a program+// GET /api/rewards - get all rewards for a programexport const GET = withWorkspace(async ({ workspace }) => {const programId = getDefaultProgramIdOrThrow(workspace);diff --git a/apps/web/lib/api/rewards/validate-reward.ts b/apps/web/lib/api/rewards/validate-reward.tsindex 73eddc8c04..00116fe675 100644--- a/apps/web/lib/api/rewards/validate-reward.ts+++ b/apps/web/lib/api/rewards/validate-reward.ts@@ -65,13 +65,6 @@ export function validateReward(}if (reward.modifiers != null) {- if (reward.event === "click") {- throw new DubApiError({- code: "bad_request",- message: "Modifiers are only allowed for lead and sale events.",- });- }-const parsedModifiers = rewardConditionsArraySchema.safeParse(reward.modifiers,);diff --git a/apps/web/lib/swr/use-rewards.ts b/apps/web/lib/swr/use-rewards.tsindex 02fbeb39db..1a3627b842 100644--- a/apps/web/lib/swr/use-rewards.ts+++ b/apps/web/lib/swr/use-rewards.ts@@ -9,7 +9,7 @@ export default function useRewards() {const { data: rewards, error } = useSWR<RewardProps[]>(workspaceId &&defaultProgramId &&- `/api/programs/${defaultProgramId}/rewards?workspaceId=${workspaceId}`,+ `/api/rewards?workspaceId=${workspaceId}`,fetcher,{dedupingInterval: 60000,diff --git a/apps/web/lib/tinybird/get-top-links-by-countries.ts b/apps/web/lib/tinybird/get-top-links-by-countries.tsnew file mode 100644index 0000000000..4e2d026531--- /dev/null+++ b/apps/web/lib/tinybird/get-top-links-by-countries.ts@@ -0,0 +1,46 @@+import { formatUTCDateTimeClickhouse } from "../analytics/utils/format-utc-datetime-clickhouse";+import { getStartEndDates } from "../analytics/utils/get-start-end-dates";+import z from "../zod";+import { tb } from "./client";++const inputSchema = z.object({+ linkIds: z.array(z.string()),+ start: z.string(),+ end: z.string(),+});++const responseSchema = z.object({+ link_id: z.string(),+ country: z.string(),+ clicks: z.number().default(0),+});++const getTopLinksByCountriesTB = tb.buildPipe({+ pipe: "v3_group_by_link_country",+ parameters: inputSchema,+ data: responseSchema,+});++export async function getTopLinksByCountries({+ linkIds,+ start,+ end,+}: {+ linkIds: string[];+ start: Date;+ end: Date;+}) {+ const { startDate, endDate } = getStartEndDates({+ start,+ end,+ timezone: "UTC",+ });++ const response = await getTopLinksByCountriesTB({+ linkIds,+ start: formatUTCDateTimeClickhouse(startDate),+ end: formatUTCDateTimeClickhouse(endDate),+ });++ return response.data;+}diff --git a/apps/web/tests/rewards/click-reward.test.ts b/apps/web/tests/rewards/click-reward.test.tsnew file mode 100644index 0000000000..32f3031b05--- /dev/null+++ b/apps/web/tests/rewards/click-reward.test.ts@@ -0,0 +1,74 @@+import { Reward } from "@dub/prisma/client";+import { describe, expect, test, vi } from "vitest";+import { resolveClickRewardAmount } from "../../app/(ee)/api/cron/aggregate-clicks/resolve-click-reward-amount";+import { IntegrationHarness } from "../utils/integration";++// Mock server-only module+vi.mock("server-only", () => ({}));++const REWARD_ID = "rw_ZE0KAEtZuOGwNHtoVm1U0JpF";++describe.sequential("Click reward resolution", async () => {+ const h = new IntegrationHarness();+ const { http } = await h.init();++ // Fetch the reward from the API+ const { status, data: reward } = await http.get<Reward>({+ path: `/rewards/${REWARD_ID}`,+ });++ if (status !== 200 || !reward) {+ throw new Error(`Failed to fetch reward from API: ${status}`);+ }++ test("countries in modifier list (US, GB, AU) get modifier amount", () => {+ // The reward has modifiers: US, GB, AU should get 100 cents+ const modifierCountries = ["US", "GB", "AU"];++ modifierCountries.forEach((country) => {+ const amount = resolveClickRewardAmount({+ reward,+ country,+ });++ expect(amount).toBe(100);+ });+ });++ test("countries not in modifier list get base amount", () => {+ // The reward base amount is 20 cents+ // Countries not in the modifier list should get the base amount+ const otherCountries = ["CA", "FR", "DE", "JP"];++ otherCountries.forEach((country) => {+ const amount = resolveClickRewardAmount({+ reward,+ country,+ });++ expect(amount).toBe(20);+ });+ });++ test("all countries return expected amounts", () => {+ // Test all countries to ensure correct behavior+ const testCases = [+ { country: "US", expected: 100 },+ { country: "GB", expected: 100 },+ { country: "AU", expected: 100 },+ { country: "CA", expected: 20 },+ { country: "FR", expected: 20 },+ { country: "DE", expected: 20 },+ { country: "JP", expected: 20 },+ ];++ testCases.forEach(({ country, expected }) => {+ const amount = resolveClickRewardAmount({+ reward,+ country,+ });++ expect(amount).toBe(expected);+ });+ });+});diff --git a/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx b/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsxindex 8d3af1a4ea..6cc492ebfc 100644--- a/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx+++ b/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx@@ -528,20 +528,19 @@ function RewardSheetContent({variant="outline"className="size-6 shrink-0 p-0"icon={<X className="size-3" strokeWidth={2} />}- onClick={() =>- setValue("description", null, { shouldDirty: true })- }+ onClick={() => {+ setValue("description", null, { shouldDirty: true });+ setValue("tooltipDescription", null, {+ shouldDirty: true,+ });+ }}/></div></div></motion.div></div>}- content={- selectedEvent === "click" ? undefined : (- <RewardsLogic isDefaultReward={false} />- )- }+ content={<RewardsLogic isDefaultReward={false} />}/><VerticalLine />diff --git a/apps/web/ui/partners/rewards/rewards-logic.tsx b/apps/web/ui/partners/rewards/rewards-logic.tsxindex 50994979fa..71620b85b8 100644--- a/apps/web/ui/partners/rewards/rewards-logic.tsx+++ b/apps/web/ui/partners/rewards/rewards-logic.tsx@@ -230,7 +230,7 @@ const ENTITIES = {const EVENT_ENTITIES: Record<EventType, (keyof typeof ENTITIES)[]> = {sale: ["sale", "customer", "partner"],lead: ["customer", "partner"],- click: [],+ click: ["customer"],};const formatValue = (diff --git a/packages/tinybird/pipes/v3_group_by_link_country.pipe b/packages/tinybird/pipes/v3_group_by_link_country.pipenew file mode 100644index 0000000000..90024965fa--- /dev/null+++ b/packages/tinybird/pipes/v3_group_by_link_country.pipe@@ -0,0 +1,22 @@+NODE endpoint+SQL >++ %+ SELECT+ link_id,+ country,+ COUNT(*) AS clicks+ FROM+ dub_click_events_mv+ WHERE+ link_id IN {{ Array(linkIds, 'String') }}+ AND timestamp >= {{ DateTime64(start) }}+ AND timestamp <= {{ DateTime64(end) }}+ GROUP BY+ link_id,+ country+ ORDER BY+ link_id ASC,+ clicks DESC++