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.

assign partner tags when creating a partner

Pedro Ladeira0f9752cea1e3
diff --git a/apps/web/lib/api/partners/create-and-enroll-partner.ts b/apps/web/lib/api/partners/create-and-enroll-partner.ts
index d98f4d5ea1..345ddb2165 100644
--- a/apps/web/lib/api/partners/create-and-enroll-partner.ts
+++ b/apps/web/lib/api/partners/create-and-enroll-partner.ts
@@ -12,6 +12,7 @@ import { ProgramEnrollmentStatus } from "@prisma/client";
import { waitUntil } from "@vercel/functions";
import { DubApiError } from "../errors";
import { getGroupOrThrow } from "../groups/get-group-or-throw";
+import { throwIfInvalidPartnerTags } from "../partner-tags/throw-if-invalid-partner-tags";
import { createOrGetProgramEnrollment } from "./create-or-get-program-enrollment";
import { createPartnerDefaultLinks } from "./create-partner-default-links";
import { getOrCreatePartner } from "./get-or-create-partner";
@@ -144,6 +145,12 @@ export const createAndEnrollPartner = async ({
includeExpandedFields: true,
});
+ const partnerTags = await throwIfInvalidPartnerTags({
+ programId: program.id,
+ partnerTagIds: partner.tagIds,
+ partnerTagNames: partner.tagNames,
+ });
+
const { partner: existingOrNewPartner } = await getOrCreatePartner({
email: partner.email,
create: {
@@ -181,6 +188,17 @@ export const createAndEnrollPartner = async ({
});
}
+ if (partnerTags.length > 0) {
+ await prisma.programPartnerTag.createMany({
+ skipDuplicates: true,
+ data: partnerTags.map(({ id: partnerTagId }) => ({
+ programId: program.id,
+ partnerId: existingOrNewPartner.id,
+ partnerTagId,
+ })),
+ });
+ }
+
// Queue an index update because a new enrollment was created.
waitUntil(queuePartnerSearchSync({ enrollmentIds: [programEnrollment.id] }));
@@ -214,6 +232,7 @@ export const createAndEnrollPartner = async ({
...programEnrollment,
id: programEnrollment.partner.id,
links,
+ ...(partnerTags.length > 0 && { tags: partnerTags }),
...polyfillSocialMediaFields(programEnrollment.partner.platforms),
});
diff --git a/apps/web/lib/openapi/partners/create-partner.ts b/apps/web/lib/openapi/partners/create-partner.ts
index 03021e50a7..5f1ac0a088 100644
--- a/apps/web/lib/openapi/partners/create-partner.ts
+++ b/apps/web/lib/openapi/partners/create-partner.ts
@@ -10,7 +10,7 @@ export const createPartner: ZodOpenApiOperationObject = {
"x-speakeasy-name-override": "create",
summary: "Create or update a partner",
description:
- "Creates or updates a partner record (upsert behavior). If a partner with the same email already exists, their program enrollment will be updated with the provided tenantId. If no existing partner is found, a new partner will be created using the supplied information.",
+ "Creates or updates a partner record (upsert behavior). If a partner with the same email already exists, their program enrollment will be updated with the provided tenantId. If no existing partner is found, a new partner will be created using the supplied information. If `tagIds` or `tagNames` is provided, those tags are assigned when the partner is newly enrolled. `tagIds` takes priority over `tagNames` when it contains at least one ID. Existing enrollments are returned unchanged.",
requestBody: {
content: {
"application/json": {
diff --git a/apps/web/lib/zod/schemas/partners.ts b/apps/web/lib/zod/schemas/partners.ts
index 47b3d18011..7bb7b0ca54 100644
--- a/apps/web/lib/zod/schemas/partners.ts
+++ b/apps/web/lib/zod/schemas/partners.ts
@@ -735,6 +735,20 @@ export const createPartnerSchema = z.object({
.describe(
"The group ID to add the partner to. If not provided, the partner will be added to the default group.",
),
+ tagIds: z
+ .array(z.string())
+ .max(100)
+ .optional()
+ .describe(
+ "The IDs of the partner tags to assign when creating the partner. Existing tags are kept. Takes priority over `tagNames` only when it contains at least one ID.",
+ ),
+ tagNames: z
+ .array(z.string())
+ .max(100)
+ .optional()
+ .describe(
+ "The names of the partner tags to assign when creating the partner. Existing tags are kept. Ignored only when `tagIds` contains at least one ID.",
+ ),
country: z
.string()
.nullish()
@@ -805,6 +819,8 @@ export const onboardPartnerSchema = createPartnerSchema
email: true,
country: true,
linkProps: true,
+ tagIds: true,
+ tagNames: true,
})
.extend({
name: z.string().min(1, "Name is required"),
diff --git a/apps/web/playwright/api/partners/partners.spec.ts b/apps/web/playwright/api/partners/partners.spec.ts
index cbbc82e0bd..67fc71505f 100644
--- a/apps/web/playwright/api/partners/partners.spec.ts
+++ b/apps/web/playwright/api/partners/partners.spec.ts
@@ -1,3 +1,4 @@
+import { prisma } from "@/lib/prisma";
import type { EnrolledPartnerProps } from "@/lib/types";
import { EnrolledPartnerSchema as EnrolledPartnerSchemaDate } from "@/lib/zod/schemas/partners";
import { nanoid } from "@dub/utils";
@@ -5,6 +6,7 @@ import { expect } from "@playwright/test";
import slugify from "@sindresorhus/slugify";
import * as z from "zod/v4";
import { apiError, randomName, randomPartnerEmail } from "../../utils";
+import { createPartnerTag, deletePartnerTag } from "../campaigns/helpers";
import { test } from "../fixtures";
import { TEST_WORKSPACE } from "../setup-test-workspace";
import { createPartner, deletePartner } from "./helpers";
@@ -223,3 +225,149 @@ test("POST /partners – upsert tenantId on existing partner", async ({
await deletePartner(partnerId);
}
});
+
+test("POST /partners – invalid tagIds", async ({ api, program }) => {
+ const email = randomPartnerEmail();
+ const tagId = "ptag_invalid";
+
+ const response = await api.post("/api/partners", {
+ email,
+ tagIds: [tagId],
+ });
+
+ expect(response).toEqual(
+ apiError({
+ code: "bad_request",
+ message: `Invalid partner tag IDs detected: ${tagId}`,
+ }),
+ );
+
+ const enrollment = await prisma.programEnrollment.findFirst({
+ where: {
+ programId: program.id,
+ partner: {
+ email,
+ },
+ },
+ });
+
+ expect(enrollment).toBeNull();
+});
+
+test("POST /partners – with tagIds", async ({ api, program }) => {
+ let partnerId: string | undefined;
+ let partnerTagId: string | undefined;
+
+ try {
+ const partnerTag = await createPartnerTag(program.id);
+ partnerTagId = partnerTag.id;
+
+ const { status, data } = await createPartner(api, {
+ tagIds: [partnerTag.id, partnerTag.id],
+ });
+ partnerId = data.id;
+
+ expect(status).toEqual(201);
+ const parsed = EnrolledPartnerSchema.parse(data);
+ expect(parsed.tags).toEqual([
+ {
+ id: partnerTag.id,
+ name: partnerTag.name,
+ },
+ ]);
+
+ const tags = await prisma.programPartnerTag.findMany({
+ where: {
+ programId: program.id,
+ partnerId,
+ },
+ });
+
+ expect(tags).toEqual([
+ expect.objectContaining({
+ partnerTagId: partnerTag.id,
+ }),
+ ]);
+ } finally {
+ if (partnerId) {
+ await prisma.programPartnerTag.deleteMany({
+ where: { partnerId },
+ });
+ }
+ await deletePartner(partnerId);
+ await deletePartnerTag(partnerTagId);
+ }
+});
+
+test("POST /partners – invalid tagNames", async ({ api, program }) => {
+ const email = randomPartnerEmail();
+ const tagName = "missing-partner-tag";
+
+ const response = await api.post("/api/partners", {
+ email,
+ tagNames: [tagName],
+ });
+
+ expect(response).toEqual(
+ apiError({
+ code: "bad_request",
+ message: `Invalid partner tag names detected: ${tagName}`,
+ }),
+ );
+
+ const enrollment = await prisma.programEnrollment.findFirst({
+ where: {
+ programId: program.id,
+ partner: {
+ email,
+ },
+ },
+ });
+
+ expect(enrollment).toBeNull();
+});
+
+test("POST /partners – with tagNames", async ({ api, program }) => {
+ let partnerId: string | undefined;
+ let partnerTagId: string | undefined;
+
+ try {
+ const partnerTag = await createPartnerTag(program.id);
+ partnerTagId = partnerTag.id;
+
+ const { status, data } = await createPartner(api, {
+ tagNames: [partnerTag.name, partnerTag.name],
+ });
+ partnerId = data.id;
+
+ expect(status).toEqual(201);
+ const parsed = EnrolledPartnerSchema.parse(data);
+ expect(parsed.tags).toEqual([
+ {
+ id: partnerTag.id,
+ name: partnerTag.name,
+ },
+ ]);
+
+ const tags = await prisma.programPartnerTag.findMany({
+ where: {
+ programId: program.id,
+ partnerId,
+ },
+ });
+
+ expect(tags).toEqual([
+ expect.objectContaining({
+ partnerTagId: partnerTag.id,
+ }),
+ ]);
+ } finally {
+ if (partnerId) {
+ await prisma.programPartnerTag.deleteMany({
+ where: { partnerId },
+ });
+ }
+ await deletePartner(partnerId);
+ await deletePartnerTag(partnerTagId);
+ }
+});