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.

PartnerLinkDetails new model

Pedro Ladeira58e0998a3552
diff --git a/apps/web/app/(ee)/api/cron/export/events/partner/route.ts b/apps/web/app/(ee)/api/cron/export/events/partner/route.ts
index 32e2a45125..5142465bcc 100644
--- a/apps/web/app/(ee)/api/cron/export/events/partner/route.ts
+++ b/apps/web/app/(ee)/api/cron/export/events/partner/route.ts
@@ -71,7 +71,11 @@ export async function POST(req: Request) {
programId,
include: {
program: true,
- links: true,
+ links: {
+ include: {
+ partnerLinkDetails: true,
+ },
+ },
},
});
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/count/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/count/route.ts
index 9941c8cb14..3a8658f8af 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/count/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/customers/count/route.ts
@@ -103,7 +103,11 @@ export const GET = withPartnerProfile(
key: true,
shortLink: true,
url: true,
- partnerLinkTitle: true,
+ partnerLinkDetails: {
+ select: {
+ title: true,
+ },
+ },
},
});
@@ -117,7 +121,7 @@ export const GET = withPartnerProfile(
key: link.key,
shortLink: link.shortLink,
url: link.url,
- partnerLinkTitle: link?.partnerLinkTitle,
+ partnerLinkTitle: link?.partnerLinkDetails?.title ?? null,
};
})
.filter(Boolean);
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 7171e2a7ef..b1e344258e 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
@@ -11,8 +11,9 @@ import {
import { generateRandomName } from "@/lib/names";
import { prisma, sanitizeFullTextSearch } from "@/lib/prisma";
import {
- PartnerProfileCustomerSchema,
getPartnerCustomersQuerySchema,
+ mapPartnerLinkDetails,
+ PartnerProfileCustomerSchema,
} from "@/lib/zod/schemas/partner-profile";
import { toCentsNumber } from "@dub/utils";
import { CommissionType } from "@prisma/client";
@@ -82,7 +83,11 @@ export const GET = withPartnerProfile(
: {}),
},
include: {
- link: true,
+ link: {
+ include: {
+ partnerLinkDetails: true,
+ },
+ },
commissions: {
where: {
partnerId: partner.id,
@@ -124,7 +129,9 @@ export const GET = withPartnerProfile(
activity: {
...customer,
events: [],
- link: customer.link,
+ link: customer.link
+ ? mapPartnerLinkDetails(customer.link)
+ : customer.link,
},
});
});
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
index 39fa62ddab..2a7c294e98 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
@@ -41,7 +41,11 @@ export const GET = withPartnerProfile(
programId: params.programId,
include: {
program: true,
- links: true,
+ links: {
+ include: {
+ partnerLinkDetails: true,
+ },
+ },
},
});
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 8fd7713e36..dddf660044 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
@@ -27,7 +27,11 @@ export const GET = withPartnerProfile(
programId: params.programId,
include: {
program: true,
- links: true,
+ links: {
+ include: {
+ partnerLinkDetails: true,
+ },
+ },
},
});
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 4638c35fe1..de9e261201 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
@@ -32,7 +32,11 @@ export const PATCH = withPartnerProfile(
programId,
include: {
program: true,
- links: true,
+ links: {
+ include: {
+ partnerLinkDetails: true,
+ },
+ },
partnerGroup: true,
},
});
@@ -97,6 +101,15 @@ export const PATCH = withPartnerProfile(
// if domain and key are the same, we don't need to check if the key exists
const skipKeyChecks = link.key.toLowerCase() === nextKey.toLowerCase();
+ const nextPartnerLinkTitle =
+ partnerLinkTitle !== undefined
+ ? partnerLinkTitle
+ : link.partnerLinkDetails?.title;
+ const nextPartnerLinkComments =
+ partnerLinkComments !== undefined
+ ? partnerLinkComments
+ : link.partnerLinkDetails?.comments;
+
const {
link: processedLink,
error,
@@ -122,14 +135,8 @@ export const PATCH = withPartnerProfile(
key: nextKey,
url: nextUrl,
- partnerLinkTitle:
- partnerLinkTitle !== undefined
- ? partnerLinkTitle
- : link.partnerLinkTitle,
- partnerLinkComments:
- partnerLinkComments !== undefined
- ? partnerLinkComments
- : link.partnerLinkComments,
+ partnerLinkTitle: nextPartnerLinkTitle,
+ partnerLinkComments: nextPartnerLinkComments,
},
workspace: {
id: program.workspaceId,
@@ -167,7 +174,13 @@ export const PATCH = withPartnerProfile(
updatedLink: linkWithUtm,
});
- return NextResponse.json(PartnerProfileLinkSchema.parse(partnerLink));
+ return NextResponse.json(
+ PartnerProfileLinkSchema.parse({
+ ...partnerLink,
+ partnerLinkTitle: nextPartnerLinkTitle,
+ partnerLinkComments: nextPartnerLinkComments,
+ }),
+ );
},
);
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 5d9fd25e5a..696aa5916a 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
@@ -9,6 +9,7 @@ import { prisma } from "@/lib/prisma";
import { getResolvedPartnerLinkRewards } from "@/lib/rewards/get-resolved-partner-link-rewards";
import {
createPartnerProfileLinkSchema,
+ mapPartnerLinkDetails,
PartnerProfileLinkSchema,
} from "@/lib/zod/schemas/partner-profile";
import { INACTIVE_ENROLLMENT_STATUSES } from "@/lib/zod/schemas/partners";
@@ -37,6 +38,7 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
discount: true,
links: {
include: {
+ partnerLinkDetails: true,
linkReward: {
include: {
clickReward: true,
@@ -66,7 +68,7 @@ export const GET = withPartnerProfile(async ({ partner, params }) => {
});
return {
- ...link,
+ ...mapPartnerLinkDetails(link),
...resolvedRewards,
discountCode: discountCode?.code,
discountCodeDisabledAt: discountCode?.disabledAt ?? null,
@@ -180,8 +182,15 @@ export const POST = withPartnerProfile(
const partnerLink = await createLink(linkWithUtm);
- return NextResponse.json(PartnerProfileLinkSchema.parse(partnerLink), {
- status: 201,
- });
+ return NextResponse.json(
+ PartnerProfileLinkSchema.parse({
+ ...partnerLink,
+ partnerLinkTitle: partnerLinkTitle ?? null,
+ partnerLinkComments: partnerLinkComments ?? null,
+ }),
+ {
+ status: 201,
+ },
+ );
},
);
diff --git a/apps/web/lib/analytics/get-analytics.ts b/apps/web/lib/analytics/get-analytics.ts
index 6de90cf9e9..d5f3a27665 100644
--- a/apps/web/lib/analytics/get-analytics.ts
+++ b/apps/web/lib/analytics/get-analytics.ts
@@ -218,7 +218,9 @@ export const getAnalytics = async (params: AnalyticsFilters) => {
key: true,
url: true,
title: true,
- ...(includePartnerLinkTitle ? { partnerLinkTitle: true as const } : {}),
+ ...(includePartnerLinkTitle
+ ? { partnerLinkDetails: { select: { title: true } } }
+ : {}),
comments: true,
folderId: true,
partnerId: true,
@@ -250,10 +252,10 @@ export const getAnalytics = async (params: AnalyticsFilters) => {
...item,
});
- if (includePartnerLinkTitle && "partnerLinkTitle" in link) {
+ if (includePartnerLinkTitle) {
return {
...parsed,
- partnerLinkTitle: link.partnerLinkTitle,
+ partnerLinkTitle: link.partnerLinkDetails?.title ?? null,
};
}
diff --git a/apps/web/lib/api/links/create-link.ts b/apps/web/lib/api/links/create-link.ts
index ef11918b5d..a67b023552 100644
--- a/apps/web/lib/api/links/create-link.ts
+++ b/apps/web/lib/api/links/create-link.ts
@@ -53,7 +53,25 @@ export async function createLink(link: CreateLinkOptions) {
const { utm_source, utm_medium, utm_campaign, utm_term, utm_content } =
getParamsFromURL(url);
- const { tagId, tagIds, tagNames, webhookIds, linkReward, ...rest } = link;
+ const {
+ tagId,
+ tagIds,
+ tagNames,
+ webhookIds,
+ linkReward,
+ partnerLinkTitle,
+ partnerLinkComments,
+ ...rest
+ } = link;
+
+ const partnerLinkDetailsTitle =
+ typeof partnerLinkTitle === "string" && partnerLinkTitle.trim()
+ ? truncate(partnerLinkTitle.trim(), 120)
+ : null;
+ const partnerLinkDetailsComments =
+ typeof partnerLinkComments === "string" && partnerLinkComments.trim()
+ ? partnerLinkComments
+ : null;
key = encodeKeyIfCaseSensitive({
domain: link.domain,
@@ -71,9 +89,6 @@ export async function createLink(link: CreateLinkOptions) {
shortLink: linkConstructorSimple({ domain: link.domain, key }),
title: truncate(title, 120),
description: truncate(description, 240),
- partnerLinkTitle: rest.partnerLinkTitle
- ? truncate(rest.partnerLinkTitle, 120)
- : rest.partnerLinkTitle,
// if it's an uploaded image, make this null first because we'll update it later
image: proxy && image && isNotHostedImage(image) ? null : image,
utm_source,
@@ -142,6 +157,17 @@ export async function createLink(link: CreateLinkOptions) {
},
}),
+ ...(partnerLinkDetailsTitle || partnerLinkDetailsComments
+ ? {
+ partnerLinkDetails: {
+ create: {
+ title: partnerLinkDetailsTitle,
+ comments: partnerLinkDetailsComments,
+ },
+ },
+ }
+ : {}),
+
// Link level rewards
...(hasLinkLevelReward && {
linkReward: {
diff --git a/apps/web/lib/api/links/update-link.ts b/apps/web/lib/api/links/update-link.ts
index d6aae3f2c7..1765858b24 100644
--- a/apps/web/lib/api/links/update-link.ts
+++ b/apps/web/lib/api/links/update-link.ts
@@ -73,8 +73,21 @@ export async function updateLink({
testVariants,
testStartedAt,
testCompletedAt,
+ partnerLinkTitle,
+ partnerLinkComments,
...rest
} = updatedLink;
+
+ const partnerLinkDetailsProvided =
+ partnerLinkTitle !== undefined || partnerLinkComments !== undefined;
+ const partnerLinkDetailsTitle =
+ typeof partnerLinkTitle === "string" && partnerLinkTitle.trim()
+ ? truncate(partnerLinkTitle.trim(), 120)
+ : null;
+ const partnerLinkDetailsComments =
+ typeof partnerLinkComments === "string" && partnerLinkComments.trim()
+ ? partnerLinkComments
+ : null;
const changedTestCompletedAt = testCompletedAt !== oldLink.testCompletedAt;
const combinedTagIds = combineTagIds({ tagId, tagIds });
@@ -99,9 +112,6 @@ export async function updateLink({
}),
title: truncate(title, 120),
description: truncate(description, 240),
- partnerLinkTitle: rest.partnerLinkTitle
- ? truncate(rest.partnerLinkTitle, 120)
- : rest.partnerLinkTitle,
image:
proxy && image && isNotHostedImage(image)
? `${R2_URL}/images/${id}_${imageUrlNonce}`
@@ -160,6 +170,24 @@ export async function updateLink({
},
}),
+ ...(partnerLinkDetailsProvided &&
+ (partnerLinkDetailsTitle || partnerLinkDetailsComments)
+ ? {
+ partnerLinkDetails: {
+ upsert: {
+ create: {
+ title: partnerLinkDetailsTitle,
+ comments: partnerLinkDetailsComments,
+ },
+ update: {
+ title: partnerLinkDetailsTitle,
+ comments: partnerLinkDetailsComments,
+ },
+ },
+ },
+ }
+ : {}),
+
// Shared dashboard
...(publicStats && {
dashboard: {
@@ -178,6 +206,16 @@ export async function updateLink({
},
});
+ if (
+ partnerLinkDetailsProvided &&
+ !partnerLinkDetailsTitle &&
+ !partnerLinkDetailsComments
+ ) {
+ await prisma.partnerLinkDetails.deleteMany({
+ where: { linkId: id },
+ });
+ }
+
waitUntil(
(async () => {
const { partner, discount } = await getPartnerEnrollmentInfo({
diff --git a/apps/web/lib/api/links/utils/transform-link.ts b/apps/web/lib/api/links/utils/transform-link.ts
index d6d4ababc8..e19623cb27 100644
--- a/apps/web/lib/api/links/utils/transform-link.ts
+++ b/apps/web/lib/api/links/utils/transform-link.ts
@@ -29,6 +29,10 @@ export type ExpandedLink = Link & {
programPartnerTags?: { partnerTagId: string }[] | null;
})
| null;
+ partnerLinkDetails?: {
+ title: string | null;
+ comments: string | null;
+ } | null;
};
// Transform link with additional properties
@@ -52,9 +56,8 @@ export const transformLink = (
lastLeadAt,
lastConversionAt,
programEnrollment,
- // partner-private; returned only by partner-profile link schemas
- partnerLinkTitle,
- partnerLinkComments,
+ // partner-private relation; returned only by partner-profile link schemas
+ partnerLinkDetails,
...rest
} = link;
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 c66264e641..b624e324c7 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
@@ -81,7 +81,11 @@ export async function getEarningsForPartner(
id: true,
shortLink: true,
url: true,
- partnerLinkTitle: true,
+ partnerLinkDetails: {
+ select: {
+ title: true,
+ },
+ },
},
},
program: {
@@ -143,6 +147,14 @@ export async function getEarningsForPartner(
return {
...e,
+ link: e.link
+ ? {
+ id: e.link.id,
+ shortLink: e.link.shortLink,
+ url: e.link.url,
+ partnerLinkTitle: e.link.partnerLinkDetails?.title ?? null,
+ }
+ : e.link,
customer: e.customer
? {
...e.customer,
diff --git a/apps/web/lib/api/partner-profile/get-partner-earnings-count.ts b/apps/web/lib/api/partner-profile/get-partner-earnings-count.ts
index f4fd70f253..fb9c776eb5 100644
--- a/apps/web/lib/api/partner-profile/get-partner-earnings-count.ts
+++ b/apps/web/lib/api/partner-profile/get-partner-earnings-count.ts
@@ -163,7 +163,11 @@ export async function getPartnerEarningsCount({
domain: true,
key: true,
url: true,
- partnerLinkTitle: true,
+ partnerLinkDetails: {
+ select: {
+ title: true,
+ },
+ },
},
});
@@ -176,7 +180,7 @@ export async function getPartnerEarningsCount({
domain: link?.domain,
key: link?.key,
url: link?.url,
- partnerLinkTitle: link?.partnerLinkTitle,
+ partnerLinkTitle: link?.partnerLinkDetails?.title ?? null,
_count,
};
});
diff --git a/apps/web/lib/embed/referrals/auth.ts b/apps/web/lib/embed/referrals/auth.ts
index ac142be36b..6765532b78 100644
--- a/apps/web/lib/embed/referrals/auth.ts
+++ b/apps/web/lib/embed/referrals/auth.ts
@@ -91,6 +91,9 @@ export const withReferralsEmbedToken = (
},
include: {
links: {
+ include: {
+ partnerLinkDetails: true,
+ },
orderBy: [
{
saleAmount: "desc",
diff --git a/apps/web/lib/zod/schemas/partner-profile.ts b/apps/web/lib/zod/schemas/partner-profile.ts
index 0c26a2567d..0c3207fee4 100644
--- a/apps/web/lib/zod/schemas/partner-profile.ts
+++ b/apps/web/lib/zod/schemas/partner-profile.ts
@@ -233,20 +233,39 @@ export const PartnerProfileLinkSchema = LinkSchema.pick({
discountCodeDisabledAt: z.coerce.date().nullable().default(null),
});
+export function mapPartnerLinkDetails<
+ T extends {
+ partnerLinkDetails?: {
+ title: string | null;
+ comments: string | null;
+ } | null;
+ },
+>(link: T) {
+ const { partnerLinkDetails, ...rest } = link;
+
+ return {
+ ...rest,
+ partnerLinkTitle: partnerLinkDetails?.title ?? null,
+ partnerLinkComments: partnerLinkDetails?.comments ?? null,
+ };
+}
+
export function parsePartnerProfileEventLink<T extends { id: string }>(
eventLink: T,
links: {
id: string;
- partnerLinkTitle?: string | null;
- partnerLinkComments?: string | null;
+ partnerLinkDetails?: {
+ title: string | null;
+ comments: string | null;
+ } | null;
}[],
) {
const source = links.find((link) => link.id === eventLink.id);
return PartnerProfileLinkSchema.parse({
...eventLink,
- partnerLinkTitle: source?.partnerLinkTitle ?? null,
- partnerLinkComments: source?.partnerLinkComments ?? null,
+ partnerLinkTitle: source?.partnerLinkDetails?.title ?? null,
+ partnerLinkComments: source?.partnerLinkDetails?.comments ?? null,
});
}
diff --git a/apps/web/prisma/schema/link.prisma b/apps/web/prisma/schema/link.prisma
index d0187be4ce..54b3ae6ffb 100644
--- a/apps/web/prisma/schema/link.prisma
+++ b/apps/web/prisma/schema/link.prisma
@@ -78,10 +78,6 @@ model Link {
// Comments on the particular shortlink
comments String? @db.Text
- // Partner-owned display label and notes
- partnerLinkTitle String?
- partnerLinkComments String? @db.Text
-
dashboard Dashboard?
programId String?
@@ -96,6 +92,7 @@ model Link {
commissions Commission[]
fraudEvents FraudEvent[]
linkReward LinkReward?
+ partnerLinkDetails PartnerLinkDetails?
@@unique([domain, key]) // for getting a link by domain and key
@@unique([projectId, externalId]) // for getting a link by externalId
@@ -109,3 +106,15 @@ model Link {
@@index(userId) // for relation to User table, used in /api/cron/cleanup/e2e-tests too
@@index(partnerGroupDefaultLinkId)
}
+
+// Partner-owned display label and notes. Only loaded by partner-profile APIs.
+model PartnerLinkDetails {
+ id String @id @default(cuid())
+ linkId String @unique
+ title String?
+ comments String? @db.Text
+ createdAt DateTime @default(now())
+ updatedAt DateTime @updatedAt
+
+ link Link @relation(fields: [linkId], references: [id], onDelete: Cascade)
+}
diff --git a/apps/web/scripts/migrations/backfill-partner-link-comments.ts b/apps/web/scripts/migrations/backfill-partner-link-comments.ts
index 83de0b5b8e..005525baf1 100644
--- a/apps/web/scripts/migrations/backfill-partner-link-comments.ts
+++ b/apps/web/scripts/migrations/backfill-partner-link-comments.ts
@@ -12,7 +12,7 @@ async function main() {
programId: { not: null },
partnerId: { not: null },
comments: { not: null },
- partnerLinkComments: null,
+ partnerLinkDetails: null,
NOT: {
comments: "",
},
@@ -31,14 +31,12 @@ async function main() {
break;
}
- await Promise.all(
- links.map(({ id, comments }) =>
- prisma.link.updateMany({
- where: { id, partnerLinkComments: null },
- data: { partnerLinkComments: comments },
- }),
- ),
- );
+ await prisma.partnerLinkDetails.createMany({
+ data: links.map(({ id, comments }) => ({
+ linkId: id,
+ comments,
+ })),
+ });
totalProcessed += links.length;