Merge pull request #2147 from dubinc/click-cache-class

Refactor click caching with dedicated ClickCache class

Author: steven-tey

apps/web/app/api/track/click/route.ts

@@ -1,9 +1,9 @@
 import { verifyAnalyticsAllowedHostnames } from "@/lib/analytics/verify-analytics-allowed-hostnames";
 import { DubApiError, handleAndReturnErrorResponse } from "@/lib/api/errors";
+import { clickCache } from "@/lib/api/links/click-cache";
 import { parseRequestBody } from "@/lib/api/utils";
 import { getLinkWithAllowedHostnames } from "@/lib/planetscale/get-link-with-allowed-hostnames";
 import { recordClick } from "@/lib/tinybird";
-import { redis } from "@/lib/upstash";
 import { isValidUrl, LOCALHOST_IP, nanoid } from "@dub/utils";
 import { ipAddress, waitUntil } from "@vercel/functions";
 import { AxiomRequest, withAxiom } from "next-axiom";
@@ -31,8 +31,7 @@ export const POST = withAxiom(async (req: AxiomRequest) => {
 
     const ip = process.env.VERCEL === "1" ? ipAddress(req) : LOCALHOST_IP;
 
-    const cacheKey = `recordClick:${domain}:${key}:${ip}`;
-    let clickId = await redis.get<string>(cacheKey);
+    let clickId = await clickCache.get({ domain, key, ip });
 
     // only generate + record a new click ID if it's not already cached in Redis
     if (!clickId) {

apps/web/app/api/track/visit/route.ts

@@ -1,9 +1,9 @@
 import { verifyAnalyticsAllowedHostnames } from "@/lib/analytics/verify-analytics-allowed-hostnames";
 import { DubApiError, handleAndReturnErrorResponse } from "@/lib/api/errors";
+import { clickCache } from "@/lib/api/links/click-cache";
 import { parseRequestBody } from "@/lib/api/utils";
 import { getLinkWithAllowedHostnames } from "@/lib/planetscale/get-link-with-allowed-hostnames";
 import { recordClick } from "@/lib/tinybird";
-import { redis } from "@/lib/upstash";
 import { isValidUrl, LOCALHOST_IP, nanoid } from "@dub/utils";
 import { ipAddress, waitUntil } from "@vercel/functions";
 import { AxiomRequest, withAxiom } from "next-axiom";
@@ -37,9 +37,8 @@ export const POST = withAxiom(async (req: AxiomRequest) => {
     }
 
     const ip = process.env.VERCEL === "1" ? ipAddress(req) : LOCALHOST_IP;
-    const cacheKey = `recordClick:${domain}:${key}:${ip}`;
 
-    let clickId = await redis.get<string>(cacheKey);
+    let clickId = await clickCache.get({ domain, key, ip });
 
     // only generate + record a new click ID if it's not already cached in Redis
     if (!clickId) {

apps/web/lib/api/links/click-cache.ts

@@ -0,0 +1,28 @@
+import { redis } from "@/lib/upstash";
+
+// Cache the click ID in Redis for 1 hour
+const CACHE_EXPIRATION = 60 * 60;
+
+interface KeyProps {
+  domain: string;
+  key: string;
+  ip: string | undefined;
+}
+
+class ClickCache {
+  async set({ domain, key, ip, clickId }: KeyProps & { clickId: string }) {
+    return await redis.set(this._createKey({ domain, key, ip }), clickId, {
+      ex: CACHE_EXPIRATION,
+    });
+  }
+
+  async get({ domain, key, ip }: KeyProps) {
+    return await redis.get<string>(this._createKey({ domain, key, ip }));
+  }
+
+  _createKey({ domain, key, ip }: KeyProps) {
+    return `recordClick:${domain}:${key}:${ip}`;
+  }
+}
+
+export const clickCache = new ClickCache();

apps/web/lib/middleware/link.ts

@@ -6,7 +6,7 @@ import {
   parse,
 } from "@/lib/middleware/utils";
 import { recordClick } from "@/lib/tinybird";
-import { formatRedisLink, redis } from "@/lib/upstash";
+import { formatRedisLink } from "@/lib/upstash";
 import {
   DUB_HEADERS,
   LEGAL_WORKSPACE_ID,
@@ -27,6 +27,7 @@ import {
 } from "next/server";
 import { linkCache } from "../api/links/cache";
 import { isCaseSensitiveDomain } from "../api/links/case-sensitivity";
+import { clickCache } from "../api/links/click-cache";
 import { getLinkViaEdge } from "../planetscale";
 import { getDomainViaEdge } from "../planetscale/get-domain-via-edge";
 import { hasEmptySearchParams } from "./utils/has-empty-search-params";
@@ -227,8 +228,8 @@ export default async function LinkMiddleware(
     // if trackConversion is enabled, check if clickId is cached in Redis
     if (trackConversion) {
       const ip = process.env.VERCEL === "1" ? ipAddress(req) : LOCALHOST_IP;
-      const cacheKey = `recordClick:${domain}:${key}:${ip}`;
-      clickId = (await redis.get<string>(cacheKey)) || undefined;
+
+      clickId = (await clickCache.get({ domain, key, ip })) || undefined;
     }
     // if there's still no clickId, generate a new one
     if (!clickId) {

apps/web/lib/tinybird/record-click.ts

@@ -7,6 +7,7 @@ import {
 import { EU_COUNTRY_CODES } from "@dub/utils/src/constants/countries";
 import { geolocation, ipAddress } from "@vercel/functions";
 import { userAgent } from "next/server";
+import { clickCache } from "../api/links/click-cache";
 import { ExpandedLink, transformLink } from "../api/links/utils/transform-link";
 import {
   detectBot,
@@ -67,13 +68,11 @@ export async function recordClick({
 
   const ip = process.env.VERCEL === "1" ? ipAddress(req) : LOCALHOST_IP;
 
-  const cacheKey = `recordClick:${domain}:${key}:${ip}`;
-
   // by default, we deduplicate clicks for a domain + key pair from the same IP address – only record 1 click per hour
   // we only need to do these if skipRatelimit is not true (we skip it in /api/track/:path endpoints)
   if (!skipRatelimit) {
     // here, we check if the clickId is cached in Redis within the last hour
-    const cachedClickId = await redis.get<string>(cacheKey);
+    const cachedClickId = await clickCache.get({ domain, key, ip });
     if (cachedClickId) {
       return null;
     }
@@ -153,9 +152,7 @@ export async function recordClick({
     ).then((res) => res.json()),
 
     // cache the click ID in Redis for 1 hour
-    redis.set(cacheKey, clickId, {
-      ex: 60 * 60,
-    }),
+    clickCache.set({ domain, key, ip, clickId }),
 
     // cache the click data for 5 mins
     // we're doing this because ingested click events are not available immediately in Tinybird