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.

Block deleting partner groups that still have partners.

Kiran Kac9f2f1a1dd4
diff --git a/apps/web/app/(ee)/api/groups/[groupIdOrSlug]/route.ts b/apps/web/app/(ee)/api/groups/[groupIdOrSlug]/route.ts
index 094a7eecd0..5844b755c3 100644
--- a/apps/web/app/(ee)/api/groups/[groupIdOrSlug]/route.ts
+++ b/apps/web/app/(ee)/api/groups/[groupIdOrSlug]/route.ts
@@ -1,8 +1,7 @@
import { recordAuditLog } from "@/lib/api/audit-logs/record-audit-log";
import { DubApiError } from "@/lib/api/errors";
+import { deletePartnerGroup } from "@/lib/api/groups/delete-partner-group";
import { getGroupOrThrow } from "@/lib/api/groups/get-group-or-throw";
-import { movePartnersToGroup } from "@/lib/api/groups/move-partners-to-group";
-import { removeGroupIdFromMoveRules } from "@/lib/api/groups/remove-group-id-from-move-rules";
import { upsertGroupMoveRules } from "@/lib/api/groups/upsert-group-move-rules";
import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";
import { parseRequestBody } from "@/lib/api/utils";
@@ -263,31 +262,20 @@ export const DELETE = withWorkspace(
const programId = getDefaultProgramIdOrThrow(workspace);
const { groupIdOrSlug } = params;
- const [group, defaultGroup] = await Promise.all([
- prisma.partnerGroup.findUniqueOrThrow({
- where: {
- ...(groupIdOrSlug.startsWith("grp_")
- ? {
- id: groupIdOrSlug,
- }
- : {
- programId_slug: {
- programId,
- slug: groupIdOrSlug,
- },
- }),
- },
- }),
-
- prisma.partnerGroup.findUniqueOrThrow({
- where: {
- programId_slug: {
- programId,
- slug: DEFAULT_PARTNER_GROUP.slug,
- },
- },
- }),
- ]);
+ const group = await prisma.partnerGroup.findUniqueOrThrow({
+ where: {
+ ...(groupIdOrSlug.startsWith("grp_")
+ ? {
+ id: groupIdOrSlug,
+ }
+ : {
+ programId_slug: {
+ programId,
+ slug: groupIdOrSlug,
+ },
+ }),
+ },
+ });
if (group.programId !== programId) {
throw new DubApiError({
@@ -296,121 +284,28 @@ export const DELETE = withWorkspace(
});
}
- if (group.slug === DEFAULT_PARTNER_GROUP.slug) {
- throw new DubApiError({
- code: "forbidden",
- message: "You cannot delete the default group of your program.",
- });
- }
+ await deletePartnerGroup(group);
- while (true) {
- const programEnrollments = await prisma.programEnrollment.findMany({
- where: {
- groupId: group.id,
- },
- take: 100,
- });
- if (programEnrollments.length === 0) {
- break;
- }
- const count = await movePartnersToGroup({
+ waitUntil(
+ recordAuditLog({
workspaceId: workspace.id,
programId,
- partnerIds: programEnrollments.map(({ partnerId }) => partnerId),
- userId: session.user.id,
- group: defaultGroup,
- isGroupDeleted: true,
- });
- console.log(`Moved ${count} partners to the default group`);
- }
-
- let shouldDeleteGroupRewards = false;
-
- const groupRewardIds = [
- group.clickRewardId,
- group.leadRewardId,
- group.saleRewardId,
- group.referralRewardId,
- group.customRewardId,
- ].filter(Boolean) as string[];
-
- if (groupRewardIds.length > 0) {
- const groupRewardCommissions = await prisma.commission.count({
- where: {
- programId,
- rewardId: {
- in: groupRewardIds,
- },
- },
- take: 100,
- });
- if (groupRewardCommissions === 0) {
- shouldDeleteGroupRewards = true;
- }
- }
-
- const deletedGroup = await prisma.$transaction(async (tx) => {
- // 1. Delete the group's rewards (if no commissions are associated with the rewards)
- if (shouldDeleteGroupRewards) {
- await tx.reward.deleteMany({
- where: {
- id: {
- in: groupRewardIds,
- },
- },
- });
- }
-
- // Note: we can't delete this group's discount yet because it is needed
- // for `remap-discount-codes` that runs in movePartnersToGroup
- // but we will delete the Discount in `remap-discount-codes` once there are no remaining discount codes.
-
- // 2. Delete the group move workflow
- if (group.workflowId) {
- await tx.workflow.delete({
- where: {
- id: group.workflowId,
+ action: "group.deleted",
+ description: `Group ${group.name} (${group.id}) deleted`,
+ actor: session.user,
+ targets: [
+ {
+ type: "group",
+ id: group.id,
+ metadata: group,
},
- });
- }
-
- // 3. Delete the group
- await tx.partnerGroup.delete({
- where: {
- id: group.id,
- },
- });
+ ],
+ }),
+ );
- return true;
+ return NextResponse.json({
+ id: group.id,
});
-
- if (deletedGroup) {
- waitUntil(
- Promise.allSettled([
- recordAuditLog({
- workspaceId: workspace.id,
- programId,
- action: "group.deleted",
- description: `Group ${group.name} (${group.id}) deleted`,
- actor: session.user,
- targets: [
- {
- type: "group",
- id: group.id,
- metadata: group,
- },
- ],
- }),
-
- removeGroupIdFromMoveRules({
- programId,
- groupId: group.id,
- }),
- ]),
- );
- }
-
- return NextResponse.json({ id: group.id });
},
{
requiredPermissions: ["groups.write"],
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/groups/groups-table.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/groups/groups-table.tsx
index 00c75d3578..f104bb8fd2 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/groups/groups-table.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/groups/groups-table.tsx
@@ -2,6 +2,7 @@
import { clientAccessCheck } from "@/lib/client-access-check";
import useGroupsCount from "@/lib/swr/use-groups-count";
+import usePartnersCount from "@/lib/swr/use-partners-count";
import useProgram from "@/lib/swr/use-program";
import useWorkspace from "@/lib/swr/use-workspace";
import { GroupExtendedProps } from "@/lib/types";
@@ -38,7 +39,7 @@ import { cn, currencyFormatter, fetcher, nFormatter } from "@dub/utils";
import { Row } from "@tanstack/react-table";
import { Command } from "cmdk";
import { useParams, useRouter } from "next/navigation";
-import { useState } from "react";
+import { useMemo, useState } from "react";
import { toast } from "sonner";
import useSWR from "swr";
@@ -88,6 +89,27 @@ export function GroupsTable() {
error: countError,
} = useGroupsCount();
+ const { partnersCount: partnersCountByGroup } = usePartnersCount<
+ | {
+ groupId: string;
+ _count: number;
+ }[]
+ | undefined
+ >({
+ groupBy: "groupId",
+ ignoreParams: true,
+ });
+
+ const partnersCountByGroupId = useMemo(() => {
+ const map = new Map<string, number>();
+ partnersCountByGroup?.forEach(({ groupId, _count }) => {
+ if (groupId) {
+ map.set(groupId, _count);
+ }
+ });
+ return map;
+ }, [partnersCountByGroup]);
+
const isFiltered = Object.keys(searchParamsObj).some(
(key) => !["sortBy", "sortOrder", "page"].includes(key),
);
@@ -164,7 +186,11 @@ export function GroupsTable() {
enableHiding: false,
header: () => <EditColumnsButton table={table} />,
cell: ({ row }) => (
- <RowMenuButton row={row} currentDefaultGroup={currentDefaultGroup} />
+ <RowMenuButton
+ row={row}
+ currentDefaultGroup={currentDefaultGroup}
+ partnersCount={partnersCountByGroupId.get(row.original.id) ?? 0}
+ />
),
},
],
@@ -246,9 +272,11 @@ export function GroupsTable() {
function RowMenuButton({
row,
currentDefaultGroup,
+ partnersCount,
}: {
row: Row<GroupExtendedProps>;
currentDefaultGroup: GroupExtendedProps | undefined;
+ partnersCount: number;
}) {
const router = useRouter();
const { slug } = useParams();
@@ -262,12 +290,21 @@ function RowMenuButton({
const { openConfirmSetDefaultGroupModal, ConfirmSetDefaultGroupModal } =
useConfirmSetDefaultGroupModal();
- const permissionsError = clientAccessCheck({
+ const [copiedGroupId, copyToClipboard] = useCopyToClipboard();
+
+ const { error: permissionsError } = clientAccessCheck({
action: "groups.write",
role,
- }).error;
+ });
- const [copiedGroupId, copyToClipboard] = useCopyToClipboard();
+ const partnersTooltip =
+ partnersCount > 0
+ ? "Move all partners to another group before deleting."
+ : undefined;
+
+ const deleteGroupDisabledReason = permissionsError
+ ? String(permissionsError)
+ : partnersTooltip;
return (
<>
@@ -347,7 +384,7 @@ function RowMenuButton({
label="Delete group"
variant="danger"
onSelect={() => setShowDeleteGroupModal(true)}
- disabledTooltip={permissionsError || undefined}
+ disabledTooltip={deleteGroupDisabledReason || undefined}
/>
</>
)}
@@ -396,21 +433,25 @@ function MenuItem({
return (
<DynamicTooltipWrapper
- tooltipProps={disabledTooltip ? { content: disabledTooltip } : undefined}
+ tooltipProps={
+ disabledTooltip ? { content: disabledTooltip, side: "left" } : undefined
+ }
>
- <Command.Item
- className={cn(
- "flex cursor-pointer select-none items-center gap-2 whitespace-nowrap rounded-md p-2 text-sm",
- disabledTooltip
- ? "cursor-not-allowed opacity-50"
- : "data-[selected=true]:bg-neutral-100",
- text,
- )}
- onSelect={disabledTooltip ? undefined : onSelect}
- >
- <IconComp className={cn("size-4 shrink-0", icon)} />
- {label}
- </Command.Item>
+ <div>
+ <Command.Item
+ className={cn(
+ "flex cursor-pointer select-none items-center gap-2 whitespace-nowrap rounded-md p-2 text-sm",
+ disabledTooltip
+ ? "cursor-not-allowed opacity-50"
+ : "data-[selected=true]:bg-neutral-100",
+ text,
+ )}
+ onSelect={disabledTooltip ? undefined : onSelect}
+ >
+ <IconComp className={cn("size-4 shrink-0", icon)} />
+ {label}
+ </Command.Item>
+ </div>
</DynamicTooltipWrapper>
);
}
diff --git a/apps/web/lib/api/groups/delete-partner-group.ts b/apps/web/lib/api/groups/delete-partner-group.ts
new file mode 100644
index 0000000000..79c4cb9e40
--- /dev/null
+++ b/apps/web/lib/api/groups/delete-partner-group.ts
@@ -0,0 +1,93 @@
+import { prisma } from "@/lib/prisma";
+import { DEFAULT_PARTNER_GROUP } from "@/lib/zod/schemas/groups";
+import { PartnerGroup } from "@prisma/client";
+import { waitUntil } from "@vercel/functions";
+import { DubApiError } from "../errors";
+import { removeGroupIdFromMoveRules } from "./remove-group-id-from-move-rules";
+
+// Delete a partner group. You can't delete a group that still has partners.
+export async function deletePartnerGroup(
+ group: Pick<
+ PartnerGroup,
+ | "id"
+ | "slug"
+ | "name"
+ | "clickRewardId"
+ | "leadRewardId"
+ | "saleRewardId"
+ | "referralRewardId"
+ | "customRewardId"
+ | "discountId"
+ | "workflowId"
+ | "programId"
+ >,
+) {
+ if (group.slug === DEFAULT_PARTNER_GROUP.slug) {
+ throw new DubApiError({
+ code: "forbidden",
+ message: "You cannot delete the default group of your program.",
+ });
+ }
+
+ const enrollment = await prisma.programEnrollment.findFirst({
+ where: {
+ groupId: group.id,
+ },
+ select: {
+ id: true,
+ },
+ take: 1,
+ });
+
+ if (enrollment) {
+ throw new DubApiError({
+ code: "bad_request",
+ message:
+ "You cannot delete a group that still has partners. Move them to another group first.",
+ });
+ }
+
+ await prisma.$transaction([
+ // Soft delete rewards
+ prisma.reward.updateMany({
+ where: {
+ groupId: group.id,
+ },
+ data: {
+ programId: null,
+ },
+ }),
+
+ // Delete discounts
+ prisma.discount.deleteMany({
+ where: {
+ groupId: group.id,
+ },
+ }),
+
+ // Delete group move workflow
+ ...(group.workflowId
+ ? [
+ prisma.workflow.delete({
+ where: {
+ id: group.workflowId,
+ },
+ }),
+ ]
+ : []),
+
+ // Delete the group
+ prisma.partnerGroup.delete({
+ where: {
+ id: group.id,
+ },
+ }),
+ ]);
+
+ waitUntil(
+ removeGroupIdFromMoveRules({
+ programId: group.programId,
+ groupId: group.id,
+ }),
+ );
+}
diff --git a/apps/web/tests/partner-groups/index.test.ts b/apps/web/tests/partner-groups/index.test.ts
index 452af3ae8a..637ef033e1 100644
--- a/apps/web/tests/partner-groups/index.test.ts
+++ b/apps/web/tests/partner-groups/index.test.ts
@@ -14,6 +14,7 @@ import { randomValue } from "@dub/utils";
import slugify from "@sindresorhus/slugify";
import { describe, expect, test } from "vitest";
import { IntegrationHarness } from "../utils/integration";
+import { E2E_PARTNER } from "../utils/resource";
const expectedGroup: Partial<GroupProps> = {
id: expect.any(String),
@@ -295,6 +296,38 @@ describe.sequential("/groups/**", async () => {
});
});
+ test("DELETE /groups/[groupId] - cannot delete group with partners", async () => {
+ const { status: moveStatus } = await http.post<{ count: number }>({
+ path: `/groups/${group.id}/partners`,
+ body: {
+ partnerIds: [E2E_PARTNER.id],
+ },
+ });
+
+ expect(moveStatus).toEqual(200);
+
+ const { status, data } = await http.delete<{
+ error: { code: string; message: string };
+ }>({
+ path: `/groups/${group.id}`,
+ });
+
+ expect(status).toEqual(400);
+ expect(data.error.code).toEqual("bad_request");
+ expect(data.error.message).toContain(
+ "You cannot delete a group that still has partners",
+ );
+
+ const { status: moveBackStatus } = await http.post<{ count: number }>({
+ path: `/groups/${DEFAULT_PARTNER_GROUP.slug}/partners`,
+ body: {
+ partnerIds: [E2E_PARTNER.id],
+ },
+ });
+
+ expect(moveBackStatus).toEqual(200);
+ });
+
test("DELETE /groups/[groupId] - delete group", async () => {
const { status, data } = await http.delete<{ id: string }>({
path: `/groups/${group.id}`,
diff --git a/apps/web/ui/modals/delete-group-modal.tsx b/apps/web/ui/modals/delete-group-modal.tsx
index d1db323376..f58b0bd5aa 100644
--- a/apps/web/ui/modals/delete-group-modal.tsx
+++ b/apps/web/ui/modals/delete-group-modal.tsx
@@ -7,7 +7,6 @@ import { Users } from "lucide-react";
import { FormEvent, useCallback, useMemo, useState } from "react";
import { toast } from "sonner";
import { GroupColorCircle } from "../partners/groups/group-color-circle";
-import { PartnerEmailNotificationTooltipHelper } from "../shared/partner-email-notification-tooltip-helper";
interface DeleteGroupModalProps {
group: Pick<GroupExtendedProps, "id" | "name" | "color" | "totalPartners">;
@@ -33,6 +32,7 @@ const DeleteGroupModal = ({
onSuccess: async () => {
setShowModal(false);
await mutatePrefix("/api/groups");
+ await mutatePrefix("/api/partners/count");
toast.success("Group deleted successfully!");
onDelete?.();
},
@@ -71,25 +71,6 @@ const DeleteGroupModal = ({
<ul className="mt-0.5 list-outside list-disc space-y-px pl-4">
<li>Rewards created for this group will be deleted.</li>
<li>Discount created for this group will be deleted.</li>
-
- {group.totalPartners && group.totalPartners > 0 ? (
- <>
- <li>
- Partners in this group will be moved to your{" "}
- <strong>Default</strong> group.
- </li>
- <li>
- Partners in this group will have their rewards and
- discount updated to the <strong>Default</strong> group
- settings.
- </li>
- <li>
- Partners in this group will be{" "}
- <PartnerEmailNotificationTooltipHelper /> about the
- change.
- </li>
- </>
- ) : null}
</ul>
<p className="mt-4">