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.

Improve partner link UTM handling (#3402)

Steven Tey88ef7cb6dafb
diff --git a/apps/web/app/(ee)/api/embed/referrals/links/route.ts b/apps/web/app/(ee)/api/embed/referrals/links/route.ts
index 0de9c6d12c..a7f84ef43a 100644
--- a/apps/web/app/(ee)/api/embed/referrals/links/route.ts
+++ b/apps/web/app/(ee)/api/embed/referrals/links/route.ts
@@ -9,7 +9,7 @@ import { linkEventSchema } from "@/lib/zod/schemas/links";
import { createPartnerLinkSchema } from "@/lib/zod/schemas/partners";
import { ReferralsEmbedLinkSchema } from "@/lib/zod/schemas/referrals-embed";
import { prisma } from "@dub/prisma";
-import { constructURLFromUTMParams } from "@dub/utils";
+import { getUTMParamsFromURL } from "@dub/utils";
import { waitUntil } from "@vercel/functions";
import { NextResponse } from "next/server";
@@ -89,14 +89,18 @@ export const POST = withReferralsEmbedToken(
});
}
+ const linkUrl = url || partnerGroup.partnerGroupDefaultLinks[0].url;
+
const { link, error, code } = await processLink({
payload: {
key: key || undefined,
- url: constructURLFromUTMParams(
- url || partnerGroup.partnerGroupDefaultLinks[0].url,
- extractUtmParams(partnerGroup.utmTemplate),
- ),
- ...extractUtmParams(partnerGroup.utmTemplate, { excludeRef: true }),
+ url: linkUrl,
+ ...(partnerGroup.utmTemplate
+ ? {
+ ...extractUtmParams(partnerGroup.utmTemplate),
+ ...getUTMParamsFromURL(linkUrl),
+ }
+ : {}),
domain: program.domain,
programId: program.id,
folderId: program.defaultFolderId,
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 440afc536b..cfcab2c5da 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
@@ -11,6 +11,7 @@ import {
INACTIVE_ENROLLMENT_STATUSES,
} from "@/lib/zod/schemas/partners";
import { prisma } from "@dub/prisma";
+import { getUTMParamsFromURL } from "@dub/utils";
import { NextResponse } from "next/server";
import * as z from "zod/v4";
@@ -106,18 +107,25 @@ export const POST = withPartnerProfile(
})
: null;
+ const linkUrl = url || program.url;
+
const { link, error, code } = await processLink({
payload: {
domain: program.domain,
key: key || undefined,
- url: url || program.url,
+ url: linkUrl,
+ ...(groupUtmTemplate
+ ? {
+ ...extractUtmParams(groupUtmTemplate),
+ ...getUTMParamsFromURL(linkUrl),
+ }
+ : {}),
programId: program.id,
tenantId,
partnerId: partner.id,
folderId: program.defaultFolderId,
comments,
trackConversion: true,
- ...(groupUtmTemplate ? extractUtmParams(groupUtmTemplate) : {}),
},
workspace: {
id: program.workspaceId,
diff --git a/apps/web/app/(ee)/api/partners/links/route.ts b/apps/web/app/(ee)/api/partners/links/route.ts
index d046a4f5f6..8fbea14461 100644
--- a/apps/web/app/(ee)/api/partners/links/route.ts
+++ b/apps/web/app/(ee)/api/partners/links/route.ts
@@ -15,7 +15,7 @@ import {
} from "@/lib/zod/schemas/partners";
import { ProgramPartnerLinkSchema } from "@/lib/zod/schemas/programs";
import { prisma } from "@dub/prisma";
-import { constructURLFromUTMParams } from "@dub/utils";
+import { getUTMParamsFromURL } from "@dub/utils";
import { waitUntil } from "@vercel/functions";
import { NextResponse } from "next/server";
import * as z from "zod/v4";
@@ -122,16 +122,20 @@ export const POST = withWorkspace(
validatePartnerLinkUrl({ group: partnerGroup, url });
+ const linkUrl = url || partnerGroup.partnerGroupDefaultLinks[0].url;
+
const { link, error, code } = await processLink({
payload: {
...linkProps,
domain: program.domain,
key: key || undefined,
- url: constructURLFromUTMParams(
- url || partnerGroup.partnerGroupDefaultLinks[0].url,
- extractUtmParams(partnerGroup.utmTemplate),
- ),
- ...extractUtmParams(partnerGroup.utmTemplate, { excludeRef: true }),
+ url: linkUrl,
+ ...(partnerGroup.utmTemplate
+ ? {
+ ...extractUtmParams(partnerGroup.utmTemplate),
+ ...getUTMParamsFromURL(linkUrl),
+ }
+ : {}),
programId: program.id,
tenantId: partner.tenantId,
partnerId: partner.partnerId,
diff --git a/apps/web/app/(ee)/api/partners/links/upsert/route.ts b/apps/web/app/(ee)/api/partners/links/upsert/route.ts
index 9493001a44..54e931dbaf 100644
--- a/apps/web/app/(ee)/api/partners/links/upsert/route.ts
+++ b/apps/web/app/(ee)/api/partners/links/upsert/route.ts
@@ -18,7 +18,7 @@ import { sendWorkspaceWebhook } from "@/lib/webhook/publish";
import { linkEventSchema } from "@/lib/zod/schemas/links";
import { upsertPartnerLinkSchema } from "@/lib/zod/schemas/partners";
import { prisma } from "@dub/prisma";
-import { constructURLFromUTMParams, deepEqual } from "@dub/utils";
+import { deepEqual, getUTMParamsFromURL } from "@dub/utils";
import { waitUntil } from "@vercel/functions";
import { NextResponse } from "next/server";
@@ -77,7 +77,7 @@ export const PUT = withWorkspace(
}
validatePartnerLinkUrl({
- group: partner.partnerGroup,
+ group: partnerGroup,
url,
});
@@ -192,7 +192,7 @@ export const PUT = withWorkspace(
});
}
} else {
- const utmTemplate = partner.partnerGroup?.utmTemplate;
+ const linkUrl = url || partnerGroup.partnerGroupDefaultLinks[0].url;
// proceed with /api/partners/links POST logic
const { link, error, code } = await processLink({
@@ -200,11 +200,13 @@ export const PUT = withWorkspace(
...linkProps,
domain: program.domain,
key: key || undefined,
- url: constructURLFromUTMParams(
- url || partnerGroup.partnerGroupDefaultLinks[0].url,
- extractUtmParams(partnerGroup.utmTemplate),
- ),
- ...extractUtmParams(partnerGroup.utmTemplate, { excludeRef: true }),
+ url: linkUrl,
+ ...(partnerGroup.utmTemplate
+ ? {
+ ...extractUtmParams(partnerGroup.utmTemplate),
+ ...getUTMParamsFromURL(linkUrl),
+ }
+ : {}),
programId: program.id,
tenantId: partner.tenantId,
partnerId: partner.partnerId,
diff --git a/packages/utils/src/functions/urls.ts b/packages/utils/src/functions/urls.ts
index 0b1869a249..b29c2781a4 100644
--- a/packages/utils/src/functions/urls.ts
+++ b/packages/utils/src/functions/urls.ts
@@ -117,6 +117,14 @@ export const paramsMetadata = [
{ display: "Referral (ref)", key: "ref", examples: "google, twitter" },
];
+export const getUTMParamsFromURL = (url: string) => {
+ return Object.fromEntries(
+ Object.entries(getParamsFromURL(url)).filter(([key]) =>
+ UTMTags.includes(key as (typeof UTMTags)[number]),
+ ),
+ );
+};
+
export const getUrlWithoutUTMParams = (url: string) => {
try {
const newURL = new URL(url);