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.

Track reward modifier (condition) changes in activity log

Kiran K08ef2c5e2ff6
diff --git a/apps/web/lib/actions/partners/create-reward.ts b/apps/web/lib/actions/partners/create-reward.ts
index 5f0223d3e7..1647779213 100644
--- a/apps/web/lib/actions/partners/create-reward.ts
+++ b/apps/web/lib/actions/partners/create-reward.ts
@@ -1,5 +1,6 @@
"use server";
+import { trackRewardActivityLog } from "@/lib/api/activity-log/track-reward-activity-log";
import { recordAuditLog } from "@/lib/api/audit-logs/record-audit-log";
import { createId } from "@/lib/api/create-id";
import { getGroupOrThrow } from "@/lib/api/groups/get-group-or-throw";
@@ -107,19 +108,32 @@ export const createRewardAction = authActionClient
});
waitUntil(
- recordAuditLog({
- workspaceId: workspace.id,
- programId,
- action: "reward.created",
- description: `Reward ${reward.id} created`,
- actor: user,
- targets: [
- {
- type: "reward",
- id: reward.id,
- metadata: serializeReward(reward),
- },
- ],
- }),
+ Promise.allSettled([
+ recordAuditLog({
+ workspaceId: workspace.id,
+ programId,
+ action: "reward.created",
+ description: `Reward ${reward.id} created`,
+ actor: user,
+ targets: [
+ {
+ type: "reward",
+ id: reward.id,
+ metadata: serializeReward(reward),
+ },
+ ],
+ }),
+
+ trackRewardActivityLog({
+ workspaceId: workspace.id,
+ programId,
+ userId: user.id,
+ resourceId: reward.id,
+ parentResourceType: "group",
+ parentResourceId: groupId,
+ old: null,
+ new: reward,
+ }),
+ ]),
);
});
diff --git a/apps/web/lib/actions/partners/delete-reward.ts b/apps/web/lib/actions/partners/delete-reward.ts
index 0cc398c212..a9e4db8375 100644
--- a/apps/web/lib/actions/partners/delete-reward.ts
+++ b/apps/web/lib/actions/partners/delete-reward.ts
@@ -1,5 +1,6 @@
"use server";
+import { trackRewardActivityLog } from "@/lib/api/activity-log/track-reward-activity-log";
import { recordAuditLog } from "@/lib/api/audit-logs/record-audit-log";
import { getRewardOrThrow } from "@/lib/api/partners/get-reward-or-throw";
import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";
@@ -35,8 +36,8 @@ export const deleteRewardAction = authActionClient
const rewardIdColumn = REWARD_EVENT_COLUMN_MAPPING[reward.event];
- await prisma.$transaction(async (tx) => {
- await tx.partnerGroup.update({
+ const partnerGroup = await prisma.$transaction(async (tx) => {
+ const group = await tx.partnerGroup.update({
// @ts-ignore
where: {
[rewardIdColumn]: reward.id,
@@ -60,22 +61,37 @@ export const deleteRewardAction = authActionClient
id: reward.id,
},
});
+
+ return group;
});
waitUntil(
- recordAuditLog({
- workspaceId: workspace.id,
- programId,
- action: "reward.deleted",
- description: `Reward ${rewardId} deleted`,
- actor: user,
- targets: [
- {
- type: "reward",
- id: rewardId,
- metadata: reward,
- },
- ],
- }),
+ Promise.allSettled([
+ recordAuditLog({
+ workspaceId: workspace.id,
+ programId,
+ action: "reward.deleted",
+ description: `Reward ${rewardId} deleted`,
+ actor: user,
+ targets: [
+ {
+ type: "reward",
+ id: rewardId,
+ metadata: reward,
+ },
+ ],
+ }),
+
+ trackRewardActivityLog({
+ workspaceId: workspace.id,
+ programId,
+ userId: user.id,
+ resourceId: reward.id,
+ parentResourceType: "group",
+ parentResourceId: partnerGroup?.id,
+ old: reward,
+ new: null,
+ }),
+ ]),
);
});
diff --git a/apps/web/lib/actions/partners/update-reward.ts b/apps/web/lib/actions/partners/update-reward.ts
index c4618286c4..1f9faf13e8 100644
--- a/apps/web/lib/actions/partners/update-reward.ts
+++ b/apps/web/lib/actions/partners/update-reward.ts
@@ -1,5 +1,6 @@
"use server";
+import { trackRewardActivityLog } from "@/lib/api/activity-log/track-reward-activity-log";
import { recordAuditLog } from "@/lib/api/audit-logs/record-audit-log";
import { getRewardOrThrow } from "@/lib/api/partners/get-reward-or-throw";
import { serializeReward } from "@/lib/api/partners/serialize-reward";
@@ -96,6 +97,10 @@ export const updateRewardAction = authActionClient
salePartnerGroup,
].some((group) => group?.slug === "default");
+ // Determine the groupId from the partner group relation
+ const partnerGroup =
+ clickPartnerGroup || leadPartnerGroup || salePartnerGroup;
+
waitUntil(
Promise.allSettled([
recordAuditLog({
@@ -113,6 +118,17 @@ export const updateRewardAction = authActionClient
],
}),
+ trackRewardActivityLog({
+ workspaceId: workspace.id,
+ programId,
+ userId: user.id,
+ resourceId: rewardMetadata.id,
+ parentResourceType: "group",
+ parentResourceId: partnerGroup?.id,
+ old: reward,
+ new: updatedReward,
+ }),
+
// we only cache default group pages for now so we need to invalidate them
...(isDefaultGroup
? [
diff --git a/apps/web/lib/api/activity-log/build-change-set.ts b/apps/web/lib/api/activity-log/build-program-enrollment-change-set.ts
similarity index 100%
rename from apps/web/lib/api/activity-log/build-change-set.ts
rename to apps/web/lib/api/activity-log/build-program-enrollment-change-set.ts
diff --git a/apps/web/lib/api/activity-log/track-activity-log.ts b/apps/web/lib/api/activity-log/track-activity-log.ts
index 2d3a6bde17..26c5283c8c 100644
--- a/apps/web/lib/api/activity-log/track-activity-log.ts
+++ b/apps/web/lib/api/activity-log/track-activity-log.ts
@@ -8,10 +8,23 @@ import { prisma } from "@dub/prisma";
import { Prisma } from "@dub/prisma/client";
import { prettyPrint } from "@dub/utils";
+const ACTIONS_WITHOUT_CHANGE_SET: ActivityLogAction[] = [
+ "referral.created",
+ "reward.created",
+ "reward.deleted",
+];
+
export interface TrackActivityLogInput
extends Pick<
Prisma.ActivityLogUncheckedCreateInput,
- "workspaceId" | "programId" | "resourceId" | "userId" | "description"
+ | "workspaceId"
+ | "programId"
+ | "resourceId"
+ | "userId"
+ | "description"
+ | "parentResourceType"
+ | "parentResourceId"
+ | "batchId"
> {
resourceType: ActivityLogResourceType;
action: ActivityLogAction;
@@ -25,7 +38,7 @@ export const trackActivityLog = async (
inputs = inputs.filter(
(i) =>
- i.action === "referral.created" ||
+ ACTIONS_WITHOUT_CHANGE_SET.includes(i.action) ||
(i.changeSet && Object.keys(i.changeSet).length > 0),
);
diff --git a/apps/web/lib/api/activity-log/track-reward-activity-log.ts b/apps/web/lib/api/activity-log/track-reward-activity-log.ts
new file mode 100644
index 0000000000..01882e55b4
--- /dev/null
+++ b/apps/web/lib/api/activity-log/track-reward-activity-log.ts
@@ -0,0 +1,211 @@
+import { serializeReward } from "@/lib/api/partners/serialize-reward";
+import type { RewardConditions, RewardProps } from "@/lib/types";
+import { rewardConditionsSchema } from "@/lib/zod/schemas/rewards";
+import type { Reward } from "@dub/prisma/client";
+import type { z } from "zod/v4";
+import { getResourceDiff } from "./get-resource-diff";
+import type { TrackActivityLogInput } from "./track-activity-log";
+import { trackActivityLog } from "./track-activity-log";
+
+type RewardConditionModifier = z.infer<typeof rewardConditionsSchema>;
+
+interface TrackRewardActivityLogParams
+ extends Omit<TrackActivityLogInput, "action" | "changeSet" | "resourceType"> {
+ old: Reward | RewardProps | null;
+ new: Reward | RewardProps | null;
+}
+
+function toRewardActivitySnapshot(reward: RewardProps) {
+ return {
+ type: reward.type,
+ amountInCents: reward.amountInCents ?? null,
+ amountInPercentage: reward.amountInPercentage ?? null,
+ maxDuration: reward.maxDuration ?? null,
+ description: reward.description ?? null,
+ tooltipDescription: reward.tooltipDescription ?? null,
+ modifiers: reward.modifiers ?? null,
+ };
+}
+
+function normalizeModifiers(modifiers: unknown): RewardConditionModifier[] {
+ if (!Array.isArray(modifiers)) return [];
+ return modifiers.filter(
+ (m): m is RewardConditionModifier =>
+ m != null &&
+ typeof m === "object" &&
+ Array.isArray((m as RewardConditionModifier).conditions),
+ ) as RewardConditionModifier[];
+}
+
+function modifierEquals(
+ a: RewardConditionModifier,
+ b: RewardConditionModifier,
+): boolean {
+ return JSON.stringify(a) === JSON.stringify(b);
+}
+
+function buildModifierChangeSetEntries(
+ oldModifiers: RewardConditions[],
+ newModifiers: RewardConditions[],
+) {
+ const logs: Pick<TrackActivityLogInput, "action" | "changeSet">[] = [];
+
+ const oldById = new Map<string, RewardConditions>();
+ const newById = new Map<string, RewardConditions>();
+
+ for (const modifier of oldModifiers) {
+ if (modifier.id != null && modifier.id !== "") {
+ oldById.set(modifier.id, modifier);
+ }
+ }
+
+ for (const modifier of newModifiers) {
+ if (modifier.id != null && modifier.id !== "") {
+ newById.set(modifier.id, modifier);
+ }
+ }
+
+ for (const [id, oldMod] of oldById) {
+ const newMod = newById.get(id);
+
+ // Condition removed
+ if (newMod === undefined) {
+ logs.push({
+ action: "reward.conditionRemoved",
+ changeSet: {
+ condition: {
+ old: oldMod,
+ new: null,
+ },
+ },
+ });
+ }
+
+ // Condition updated
+ if (newMod !== undefined && !modifierEquals(oldMod, newMod)) {
+ logs.push({
+ action: "reward.conditionUpdated",
+ changeSet: {
+ condition: {
+ old: oldMod,
+ new: newMod,
+ },
+ },
+ });
+ }
+ }
+
+ for (const [id, newMod] of newById) {
+ const oldMod = oldById.get(id);
+
+ // Condition added
+ if (oldMod === undefined) {
+ logs.push({
+ action: "reward.conditionAdded",
+ changeSet: {
+ condition: {
+ old: null,
+ new: newMod,
+ },
+ },
+ });
+ }
+ }
+
+ return logs;
+}
+
+export function trackRewardActivityLog({
+ old: oldReward,
+ new: newReward,
+ ...baseInput
+}: TrackRewardActivityLogParams) {
+ if (oldReward === null && newReward !== null) {
+ const newSnapshot = toRewardActivitySnapshot(
+ serializeReward(newReward as Reward),
+ );
+
+ return trackActivityLog({
+ ...baseInput,
+ resourceType: "reward",
+ action: "reward.created",
+ changeSet: {
+ reward: {
+ old: null,
+ new: newSnapshot,
+ },
+ },
+ });
+ }
+
+ const activityLogs: Pick<TrackActivityLogInput, "action" | "changeSet">[] =
+ [];
+
+ if (oldReward !== null && newReward !== null) {
+ const oldSnapshot = toRewardActivitySnapshot(
+ serializeReward(oldReward as Reward),
+ );
+
+ const newSnapshot = toRewardActivitySnapshot(
+ serializeReward(newReward as Reward),
+ );
+
+ const diff = getResourceDiff(oldSnapshot, newSnapshot, {
+ fields: [
+ "type",
+ "amountInCents",
+ "amountInPercentage",
+ "maxDuration",
+ "description",
+ "tooltipDescription",
+ ],
+ });
+
+ if (diff) {
+ activityLogs.push({
+ ...baseInput,
+ action: "reward.updated",
+ changeSet: diff,
+ });
+ }
+
+ // Find the reward modifiers diff
+ const oldModifiers = Array.isArray(oldReward.modifiers)
+ ? oldReward.modifiers
+ : [];
+ const newModifiers = Array.isArray(newReward.modifiers)
+ ? newReward.modifiers
+ : [];
+
+ activityLogs.push(
+ ...buildModifierChangeSetEntries(oldModifiers, newModifiers),
+ );
+ }
+
+ if (oldReward !== null && newReward === null) {
+ const oldSnapshot = toRewardActivitySnapshot(
+ serializeReward(oldReward as Reward),
+ );
+
+ activityLogs.push({
+ ...baseInput,
+ action: "reward.deleted",
+ changeSet: {
+ reward: {
+ old: oldSnapshot,
+ new: null,
+ },
+ },
+ });
+ }
+
+ const finalActivityLogs: TrackActivityLogInput[] = activityLogs.map(
+ (log) => ({
+ ...baseInput,
+ ...log,
+ resourceType: "reward",
+ }),
+ );
+
+ return trackActivityLog(finalActivityLogs);
+}
diff --git a/apps/web/lib/api/groups/move-partners-to-group.ts b/apps/web/lib/api/groups/move-partners-to-group.ts
index c3a8590a6a..ff0dd18ef6 100644
--- a/apps/web/lib/api/groups/move-partners-to-group.ts
+++ b/apps/web/lib/api/groups/move-partners-to-group.ts
@@ -4,7 +4,7 @@ import { prisma } from "@dub/prisma";
import { PartnerGroup, WorkspaceRole } from "@dub/prisma/client";
import { APP_DOMAIN_WITH_NGROK } from "@dub/utils";
import { waitUntil } from "@vercel/functions";
-import { buildProgramEnrollmentChangeSet } from "../activity-log/build-change-set";
+import { buildProgramEnrollmentChangeSet } from "../activity-log/build-program-enrollment-change-set";
import {
trackActivityLog,
TrackActivityLogInput,
diff --git a/apps/web/lib/zod/schemas/activity-log.ts b/apps/web/lib/zod/schemas/activity-log.ts
index 526c306a5e..ecd61089fa 100644
--- a/apps/web/lib/zod/schemas/activity-log.ts
+++ b/apps/web/lib/zod/schemas/activity-log.ts
@@ -16,10 +16,15 @@ export const activityLogActionSchema = z.enum([
"referral.unqualified",
"referral.closedWon",
"referral.closedLost",
+
"partner.groupChanged",
+
"reward.created",
"reward.updated",
"reward.deleted",
+ "reward.conditionAdded",
+ "reward.conditionRemoved",
+ "reward.conditionUpdated",
]);
export const getActivityLogsQuerySchema = z.object({
diff --git a/packages/prisma/schema/activity.prisma b/packages/prisma/schema/activity.prisma
index 74afad30e8..06c6aab022 100644
--- a/packages/prisma/schema/activity.prisma
+++ b/packages/prisma/schema/activity.prisma
@@ -1,14 +1,17 @@
model ActivityLog {
- id String @id @default(cuid())
- workspaceId String
- programId String
- resourceType String
- resourceId String
- userId String?
- action String
- description String? @db.Text
- changeSet Json?
- createdAt DateTime @default(now())
+ id String @id @default(cuid())
+ workspaceId String
+ programId String
+ parentResourceType String?
+ parentResourceId String?
+ resourceType String
+ resourceId String
+ userId String?
+ action String
+ description String? @db.Text
+ batchId String?
+ changeSet Json?
+ createdAt DateTime @default(now())
user User? @relation(fields: [userId], references: [id])