Merge pull request #2710 from dubinc/trigger-refactor

Triggers refactor

Author: steven-tey

apps/web/app/(ee)/api/events/export/route.ts

@@ -22,7 +22,7 @@ const columnNames: Record<string, string> = {
 };
 
 const columnAccessors = {
-  trigger: (r: Row) => (r.qr ? "QR scan" : "Link click"),
+  trigger: (r: Row) => r.click.trigger,
   event: (r: LeadEvent | SaleEvent) => r.eventName,
   link: (r: Row) => r.domain + (r.key === "_root" ? "" : `/${r.key}`),
   country: (r: Row) =>

apps/web/lib/analytics/constants.ts

@@ -207,12 +207,6 @@ export const DIMENSIONAL_ANALYTICS_FILTERS = [
   "utm_content",
 ];
 
-export const TRIGGER_DISPLAY = {
-  qr: "QR Code Scan",
-  link: "Link Click",
-  pageview: "Page View",
-  deeplink: "Deep Link",
-};
 export const TRIGGER_TYPES = ["qr", "link", "pageview", "deeplink"] as const;
 
 export const EVENT_TYPES = ["clicks", "leads", "sales"] as const;

apps/web/lib/analytics/get-analytics.ts

@@ -78,12 +78,8 @@ export const getAnalytics = async (params: AnalyticsFilters) => {
     dataAvailableFrom,
   });
 
-  if (trigger) {
-    if (trigger === "qr") {
-      qr = true;
-    } else if (trigger === "link") {
-      qr = false;
-    }
+  if (qr) {
+    trigger = "qr";
   }
 
   if (region) {
@@ -112,7 +108,7 @@ export const getAnalytics = async (params: AnalyticsFilters) => {
     eventType: event,
     workspaceId,
     tagIds,
-    qr,
+    trigger,
     start: startDate.toISOString().replace("T", " ").replace("Z", ""),
     end: endDate.toISOString().replace("T", " ").replace("Z", ""),
     granularity,

apps/web/lib/analytics/get-events.ts

@@ -48,12 +48,8 @@ export const getEvents = async (params: EventsFilters) => {
     dataAvailableFrom,
   });
 
-  if (trigger) {
-    if (trigger === "qr") {
-      qr = true;
-    } else if (trigger === "link") {
-      qr = false;
-    }
+  if (qr) {
+    trigger = "qr";
   }
 
   if (region) {
@@ -82,7 +78,7 @@ export const getEvents = async (params: EventsFilters) => {
     ...params,
     eventType,
     workspaceId,
-    qr,
+    trigger,
     country,
     region,
     order: sortOrder,

apps/web/lib/zod/schemas/analytics.ts

@@ -184,7 +184,7 @@ export const analyticsQuerySchema = z
       .enum(TRIGGER_TYPES)
       .optional()
       .describe(
-        "The trigger to retrieve analytics for. If undefined, return both QR and link clicks.",
+        "The trigger to retrieve analytics for. If undefined, returns all trigger types.",
       ),
     referer: z
       .string()
@@ -246,7 +246,7 @@ export const analyticsFilterTB = z
     customerId: z.string().optional(),
     root: z.boolean().optional(),
     saleType: z.string().optional(),
-    qr: z.boolean().optional(),
+    trigger: z.enum(TRIGGER_TYPES).optional(),
     start: z.string(),
     end: z.string(),
     granularity: z.enum(["minute", "hour", "day", "month"]).optional(),

apps/web/lib/zod/schemas/clicks.ts

@@ -20,6 +20,7 @@ export const clickEventSchemaTB = z.object({
   browser_version: z.string().nullable(),
   os: z.string().nullable(),
   os_version: z.string().nullable(),
+  trigger: z.string().nullish(), // backwards compatibility
   engine: z.string().nullable(),
   engine_version: z.string().nullable(),
   cpu_architecture: z.string().nullable(),
@@ -45,6 +46,7 @@ export const clickEventSchemaTBEndpoint = z.object({
   device: z.string().nullable(),
   browser: z.string().nullable(),
   os: z.string().nullable(),
+  trigger: z.string().nullish(), // backwards compatibility
   referer: z.string().nullable(),
   referer_url: z.string().nullable(),
   referer_url_processed: z.string().nullable(),
@@ -63,6 +65,7 @@ export const clickEventSchema = z.object({
   device: z.string(),
   browser: z.string(),
   os: z.string(),
+  trigger: z.string().nullish(), // backwards compatibility
   referer: z.string(),
   refererUrl: z.string(),
   qr: z.coerce.boolean(),

apps/web/lib/zod/schemas/leads.ts

@@ -113,6 +113,7 @@ export const leadEventSchemaTBEndpoint = z.object({
   device: z.string().nullable(),
   browser: z.string().nullable(),
   os: z.string().nullable(),
+  trigger: z.string().nullish(), // backwards compatibility
   referer: z.string().nullable(),
   referer_url: z.string().nullable(),
   referer_url_processed: z.string().nullable(),

apps/web/lib/zod/schemas/sales.ts

@@ -127,6 +127,7 @@ export const saleEventSchemaTBEndpoint = z.object({
   device: z.string().nullable(),
   browser: z.string().nullable(),
   os: z.string().nullable(),
+  trigger: z.string().nullish(), // backwards compatibility
   referer: z.string().nullable(),
   referer_url: z.string().nullable(),
   referer_url_processed: z.string().nullable(),

apps/web/ui/analytics/device-icon.tsx

@@ -4,16 +4,15 @@ import { BlurImage } from "@dub/ui";
 import {
   AppleLogo,
   Cube,
-  CursorRays,
   Desktop,
   GamingConsole,
   MobilePhone,
-  QRCode,
   TV,
   Tablet,
   Watch,
   Window,
 } from "@dub/ui/icons";
+import { TRIGGER_DISPLAY } from "./trigger-display";
 
 export default function DeviceIcon({
   display,
@@ -89,11 +88,8 @@ export default function DeviceIcon({
         );
     }
   } else if (tab === "triggers") {
-    if (display === "qr") {
-      return <QRCode className={className} />;
-    } else {
-      return <CursorRays className={className} />;
-    }
+    const { icon: Icon } = TRIGGER_DISPLAY[display ?? "link"];
+    return <Icon className={className} />;
   } else {
     return (
       <BlurImage

apps/web/ui/analytics/devices.tsx

@@ -1,7 +1,4 @@
-import {
-  SINGULAR_ANALYTICS_ENDPOINTS,
-  TRIGGER_DISPLAY,
-} from "@/lib/analytics/constants";
+import { SINGULAR_ANALYTICS_ENDPOINTS } from "@/lib/analytics/constants";
 import { DeviceTabs } from "@/lib/analytics/types";
 import { useRouterStuff } from "@dub/ui";
 import { Cube, CursorRays, MobilePhone, Window } from "@dub/ui/icons";
@@ -11,6 +8,7 @@ import { AnalyticsLoadingSpinner } from "./analytics-loading-spinner";
 import { AnalyticsContext } from "./analytics-provider";
 import BarList from "./bar-list";
 import DeviceIcon from "./device-icon";
+import { TRIGGER_DISPLAY } from "./trigger-display";
 import { useAnalyticsFilterOption } from "./utils";
 
 export default function Devices() {
@@ -20,7 +18,7 @@ export default function Devices() {
   const dataKey = selectedTab === "sales" ? saleUnit : "count";
 
   const [tab, setTab] = useState<DeviceTabs>("devices");
-  const { data, loading } = useAnalyticsFilterOption(tab);
+  const { data } = useAnalyticsFilterOption(tab);
   const singularTabName = SINGULAR_ANALYTICS_ENDPOINTS[tab];
 
   return (
@@ -53,7 +51,7 @@ export default function Devices() {
                     ),
                     title:
                       tab === "triggers"
-                        ? TRIGGER_DISPLAY[d.trigger]
+                        ? TRIGGER_DISPLAY[d.trigger].title
                         : d[singularTabName],
                     href: queryParams({
                       ...(searchParams.has(singularTabName)