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.

Add Google campaign ID whitelisting to fraud detection settings (#3497)

Kiran K9b0a063d3ce8
diff --git a/apps/web/app/(ee)/api/fraud/rules/route.ts b/apps/web/app/(ee)/api/fraud/rules/route.ts
index 0c4691e340..6d93158018 100644
--- a/apps/web/app/(ee)/api/fraud/rules/route.ts
+++ b/apps/web/app/(ee)/api/fraud/rules/route.ts
@@ -29,7 +29,10 @@ export const GET = withWorkspace(
return {
type,
enabled: true,
- config: { platforms: ["google"] },
+ config: {
+ platforms: ["google"],
+ google: { whitelistedCampaignIds: [] },
+ },
};
}
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/fraud-paid-traffic-settings.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/fraud-paid-traffic-settings.tsx
index da58920c77..babed30012 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/fraud-paid-traffic-settings.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/fraud-paid-traffic-settings.tsx
@@ -3,8 +3,10 @@
import { PAID_TRAFFIC_PLATFORMS_CONFIG } from "@/lib/api/fraud/constants";
import { PaidTrafficPlatform } from "@/lib/types";
import { updateFraudRuleSettingsSchema } from "@/lib/zod/schemas/fraud";
+import { X } from "@/ui/shared/icons";
import {
Bing,
+ Button,
Facebook,
Google,
LinkedIn,
@@ -14,6 +16,7 @@ import {
Twitter,
} from "@dub/ui";
import { cn } from "@dub/utils/src";
+import { motion } from "motion/react";
import React from "react";
import { useFormContext } from "react-hook-form";
import * as z from "zod/v4";
@@ -49,7 +52,11 @@ export function FraudPaidTrafficSettings({
} = useFormContext<{ paidTrafficDetected: FormData }>();
const platforms = watch("paidTrafficDetected.config.platforms") ?? [];
+ const whitelistedCampaignIds =
+ watch("paidTrafficDetected.config.google.whitelistedCampaignIds") ?? [];
+
const enabled = watch("paidTrafficDetected.enabled");
+ const isGoogleEnabled = platforms.includes("google");
// Toggle platform in the list
const togglePlatform = (platformId: string) => {
@@ -57,9 +64,35 @@ export function FraudPaidTrafficSettings({
const newPlatforms = isSelected
? platforms.filter((p) => p !== platformId)
: [...platforms, platformId as any];
+
setValue("paidTrafficDetected.config.platforms", newPlatforms, {
shouldDirty: true,
});
+
+ if (platformId === "google" && isSelected) {
+ setValue("paidTrafficDetected.config.google.whitelistedCampaignIds", [], {
+ shouldDirty: true,
+ });
+ }
+ };
+
+ const addCampaignId = (id: string) => {
+ const trimmed = id.trim();
+ if (trimmed && !whitelistedCampaignIds.includes(trimmed)) {
+ setValue(
+ "paidTrafficDetected.config.google.whitelistedCampaignIds",
+ [...whitelistedCampaignIds, trimmed],
+ { shouldDirty: true },
+ );
+ }
+ };
+
+ const removeCampaignId = (id: string) => {
+ setValue(
+ "paidTrafficDetected.config.google.whitelistedCampaignIds",
+ whitelistedCampaignIds.filter((c) => c !== id),
+ { shouldDirty: true },
+ );
};
const isDisabled = isConfigLoading || isSubmitting;
@@ -94,42 +127,132 @@ export function FraudPaidTrafficSettings({
setValue("paidTrafficDetected.config.platforms", [], {
shouldDirty: true,
});
+ setValue(
+ "paidTrafficDetected.config.google.whitelistedCampaignIds",
+ [],
+ { shouldDirty: true },
+ );
}
}}
/>
</div>
{enabled && (
- <div className="space-y-1 p-1">
- {PAID_TRAFFIC_PLATFORMS_CONFIG.map((platform) => {
- const Icon = PAID_TRAFFIC_PLATFORM_ICONS[platform.id];
- const isPlatformEnabled = platforms.includes(platform.id);
-
- return (
- <div
- key={platform.id}
- className="group flex items-center justify-between rounded-lg px-2 py-2.5 transition-colors hover:cursor-pointer hover:bg-neutral-100"
- >
- <div className="flex items-center gap-3">
- {Icon && (
- <div className="flex h-5 w-5 items-center justify-center">
- <Icon className="h-5 w-5" />
+ <>
+ <div className="space-y-1 p-1">
+ {PAID_TRAFFIC_PLATFORMS_CONFIG.map((platform) => {
+ const Icon = PAID_TRAFFIC_PLATFORM_ICONS[platform.id];
+ const isPlatformEnabled = platforms.includes(platform.id);
+ const isGoogle = platform.id === "google";
+
+ return (
+ <React.Fragment key={platform.id}>
+ <div className="group flex items-center justify-between rounded-lg px-2 py-2.5 transition-colors hover:cursor-pointer hover:bg-neutral-100">
+ <div className="flex items-center gap-3">
+ {Icon && (
+ <div className="flex h-5 w-5 items-center justify-center">
+ <Icon className="h-5 w-5" />
+ </div>
+ )}
+ <span className="text-sm font-medium text-neutral-900">
+ {platform.name}
+ </span>
+ </div>
+ <Switch
+ trackDimensions="radix-state-checked:bg-black focus-visible:ring-black/20"
+ checked={isPlatformEnabled}
+ disabled={isDisabled}
+ fn={() => togglePlatform(platform.id)}
+ />
+ </div>
+
+ {isGoogle && (
+ <motion.div
+ initial={false}
+ animate={{
+ height: isGoogleEnabled ? "auto" : 0,
+ opacity: isGoogleEnabled ? 1 : 0,
+ }}
+ transition={{
+ height: { duration: 0.2, ease: "easeInOut" },
+ opacity: { duration: 0.15 },
+ }}
+ className="overflow-hidden"
+ >
+ <div className="m-2 space-y-3 rounded-lg border border-neutral-200 bg-neutral-50/50 p-4">
+ <label className="text-sm font-medium text-neutral-700">
+ Google campaign whitelist
+ <span className="ml-1 font-normal text-neutral-500">
+ (optional)
+ </span>
+ </label>
+ <div className="flex gap-2">
+ <input
+ type="text"
+ placeholder="e.g. 123456789"
+ disabled={isDisabled}
+ className={cn(
+ "block h-9 flex-1 rounded-md border-neutral-300 px-3 py-1.5 text-sm text-neutral-900 placeholder-neutral-400 focus:border-neutral-500 focus:outline-none focus:ring-neutral-500 disabled:bg-neutral-100 disabled:text-neutral-500",
+ )}
+ onKeyDown={(e) => {
+ if (e.key === "Enter") {
+ e.preventDefault();
+ const input = e.currentTarget;
+ addCampaignId(input.value);
+ input.value = "";
+ }
+ }}
+ />
+ <Button
+ type="button"
+ variant="secondary"
+ text="Add"
+ className="h-9 w-fit px-3"
+ disabled={isDisabled}
+ onClick={(e) => {
+ const input = e.currentTarget
+ .previousElementSibling as HTMLInputElement;
+ if (input) {
+ addCampaignId(input.value);
+ input.value = "";
+ }
+ }}
+ />
+ </div>
+
+ {whitelistedCampaignIds.length > 0 && (
+ <div className="flex flex-wrap gap-2">
+ {whitelistedCampaignIds.map((id) => (
+ <div
+ key={id}
+ className="flex items-center gap-1.5 rounded-md bg-neutral-100 px-2.5 py-1.5 text-sm text-neutral-700"
+ >
+ <span>{id}</span>
+ <button
+ type="button"
+ onClick={() => removeCampaignId(id)}
+ disabled={isDisabled}
+ aria-label="Remove campaign ID"
+ className="text-neutral-400 hover:text-neutral-600"
+ >
+ <X className="size-3.5" />
+ </button>
+ </div>
+ ))}
+ </div>
+ )}
+ <p className="text-content-subtle text-xs font-normal tracking-normal">
+ Skip the fraud event when the campaign ID matches one of
+ the predefined IDs.
+ </p>
</div>
+ </motion.div>
)}
- <span className="text-sm font-medium text-neutral-900">
- {platform.name}
- </span>
- </div>
- <Switch
- trackDimensions="radix-state-checked:bg-black focus-visible:ring-black/20"
- checked={isPlatformEnabled}
- disabled={isDisabled}
- fn={() => togglePlatform(platform.id)}
- />
- </div>
- );
- })}
- </div>
+ </React.Fragment>
+ );
+ })}
+ </div>
+ </>
)}
</div>
);
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/program-fraud-settings-sheet.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/program-fraud-settings-sheet.tsx
index 3ae1eb2aa3..2bd97ce0d2 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/program-fraud-settings-sheet.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/fraud/program-fraud-settings-sheet.tsx
@@ -3,7 +3,11 @@
import { mutatePrefix } from "@/lib/swr/mutate";
import { useApiMutation } from "@/lib/swr/use-api-mutation";
import useWorkspace from "@/lib/swr/use-workspace";
-import { FraudRuleProps, UpdateFraudRuleSettings } from "@/lib/types";
+import {
+ FraudRuleProps,
+ PaidTrafficPlatform,
+ UpdateFraudRuleSettings,
+} from "@/lib/types";
import {
getRulesBeingDisabled,
useDisableFraudRulesModal,
@@ -44,7 +48,7 @@ function ProgramFraudSettingsSheetContent({
},
paidTrafficDetected: {
enabled: false,
- config: { platforms: [] },
+ config: { platforms: [], google: { whitelistedCampaignIds: [] } },
},
},
});
@@ -65,6 +69,11 @@ function ProgramFraudSettingsSheetContent({
(rule) => rule.type === "paidTrafficDetected",
);
+ const paidTrafficConfig = (paidTrafficDetectedRule?.config ?? {}) as {
+ platforms?: PaidTrafficPlatform[];
+ google?: { whitelistedCampaignIds?: string[] };
+ };
+
form.reset({
referralSourceBanned: {
enabled: referralSourceBannedRule?.enabled ?? false,
@@ -72,7 +81,13 @@ function ProgramFraudSettingsSheetContent({
},
paidTrafficDetected: {
enabled: paidTrafficDetectedRule?.enabled ?? false,
- config: paidTrafficDetectedRule?.config ?? { platforms: [] },
+ config: {
+ platforms: paidTrafficConfig.platforms ?? [],
+ google: {
+ whitelistedCampaignIds:
+ paidTrafficConfig.google?.whitelistedCampaignIds ?? [],
+ },
+ },
},
});
}, [fraudRules, form]);
diff --git a/apps/web/lib/api/fraud/rules/check-paid-traffic-detected.ts b/apps/web/lib/api/fraud/rules/check-paid-traffic-detected.ts
index 431d5ce1a6..5e2fea2b02 100644
--- a/apps/web/lib/api/fraud/rules/check-paid-traffic-detected.ts
+++ b/apps/web/lib/api/fraud/rules/check-paid-traffic-detected.ts
@@ -9,10 +9,16 @@ import { defineFraudRule } from "../define-fraud-rule";
const configSchema = z.object({
platforms: z.array(z.enum(PAID_TRAFFIC_PLATFORMS)).optional().default([]),
+ google: z
+ .object({
+ whitelistedCampaignIds: z.array(z.string()).optional().default([]),
+ })
+ .optional(),
});
const defaultConfig: z.infer<typeof configSchema> = {
platforms: ["google"],
+ google: { whitelistedCampaignIds: [] },
};
export const checkPaidTrafficDetected = defineFraudRule({
@@ -68,6 +74,27 @@ export const checkPaidTrafficDetected = defineFraudRule({
}
}
+ // Check if the source is Google and if the campaign ID is in the allowlist
+ if (source === "google") {
+ const whitelistedCampaignIds =
+ config.google?.whitelistedCampaignIds?.filter(Boolean) ?? [];
+
+ if (whitelistedCampaignIds.length > 0) {
+ const paramsToCheck = ["gad_campaignid", "utm_campaign"];
+
+ const matched = paramsToCheck.some((param) => {
+ const value = queryParams[param]?.trim();
+ return value && whitelistedCampaignIds.includes(value);
+ });
+
+ if (matched) {
+ return {
+ triggered: false,
+ };
+ }
+ }
+ }
+
if (source) {
return {
triggered: true,
diff --git a/apps/web/lib/zod/schemas/fraud.ts b/apps/web/lib/zod/schemas/fraud.ts
index cc46c46d1f..9666fb57f2 100644
--- a/apps/web/lib/zod/schemas/fraud.ts
+++ b/apps/web/lib/zod/schemas/fraud.ts
@@ -175,6 +175,24 @@ export const updateFraudRuleSettingsSchema = z.object({
config: z
.object({
platforms: z.array(z.enum(PAID_TRAFFIC_PLATFORMS)).optional(),
+ google: z
+ .object({
+ whitelistedCampaignIds: z
+ .array(z.string())
+ .optional()
+ .transform((ids) => {
+ if (!ids || ids.length === 0) {
+ return [];
+ }
+
+ return Array.from(
+ new Set(
+ ids.map((id) => id.trim()).filter((id) => id !== ""),
+ ),
+ );
+ }),
+ })
+ .optional(),
})
.optional(),
})
@@ -194,6 +212,19 @@ export const updateFraudRuleSettingsSchema = z.object({
return { ...data, enabled: false, config: undefined };
}
+ const platforms = data.config?.platforms ?? [];
+ const hasGoogle = platforms.includes("google");
+ const googleConfig = data.config?.google;
+
+ if (!hasGoogle && googleConfig?.whitelistedCampaignIds?.length) {
+ const { google: _google, ...configWithoutGoogle } = data.config ?? {};
+
+ return {
+ ...data,
+ config: { ...configWithoutGoogle, platforms },
+ };
+ }
+
return data;
})
.optional(),