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.

Record API logs `/track/open`, `/track/**/client` (#3743)

Kiran Kbe570dd05486
diff --git a/apps/web/app/(ee)/api/hubspot/webhook/route.ts b/apps/web/app/(ee)/api/hubspot/webhook/route.ts
index f96562d611..cd1bac7797 100644
--- a/apps/web/app/(ee)/api/hubspot/webhook/route.ts
+++ b/apps/web/app/(ee)/api/hubspot/webhook/route.ts
@@ -1,3 +1,4 @@
+import { captureWebhookLog } from "@/lib/api-logs/capture-webhook-log";
import { DubApiError, handleAndReturnErrorResponse } from "@/lib/api/errors";
import { withAxiom } from "@/lib/axiom/server";
import { hubSpotOAuthProvider } from "@/lib/integrations/hubspot/oauth";
@@ -8,6 +9,7 @@ import {
import { trackHubSpotLeadEvent } from "@/lib/integrations/hubspot/track-lead";
import { trackHubSpotSaleEvent } from "@/lib/integrations/hubspot/track-sale";
import { prisma } from "@dub/prisma";
+import { waitUntil } from "@vercel/functions";
import crypto from "crypto";
import { NextResponse } from "next/server";
@@ -15,6 +17,8 @@ const HUBSPOT_CLIENT_SECRET = process.env.HUBSPOT_CLIENT_SECRET || "";
// POST /api/hubspot/webhook – listen to webhook events from Hubspot
export const POST = withAxiom(async (req) => {
+ const startTime = Date.now();
+
try {
const rawPayload = await req.text();
const signature = req.headers.get("X-HubSpot-Signature");
@@ -53,15 +57,56 @@ export const POST = withAxiom(async (req) => {
// HS send multiple events in the same request
// so we need to process each event individually
- await Promise.allSettled(payload.map(processWebhookEvent));
+ const results = await Promise.allSettled(payload.map(processWebhookEvent));
+
+ const responseBody = { message: "Webhook received." };
+ const duration = Date.now() - startTime;
+
+ // Collect log entries from fulfilled results, including failures
+ const logEntries: Array<{
+ workspaceId: string;
+ statusCode: number;
+ responseBody: unknown;
+ }> = [];
- return NextResponse.json({ message: "Webhook received." });
+ for (const r of results) {
+ if (r.status !== "fulfilled" || !r.value) {
+ continue;
+ }
+
+ const { workspaceId, errorResponse } = r.value;
+
+ logEntries.push({
+ workspaceId,
+ statusCode: errorResponse ? errorResponse.status : 200,
+ responseBody: errorResponse ?? responseBody,
+ });
+ }
+
+ waitUntil(
+ Promise.allSettled(
+ logEntries.map((entry) =>
+ captureWebhookLog({
+ workspaceId: entry.workspaceId,
+ method: req.method,
+ path: "/hubspot/webhook",
+ statusCode: entry.statusCode,
+ duration,
+ requestBody: payload,
+ responseBody: entry.responseBody,
+ userAgent: req.headers.get("user-agent"),
+ }),
+ ),
+ ),
+ );
+
+ return NextResponse.json(responseBody);
} catch (error) {
return handleAndReturnErrorResponse(error);
}
});
-// Process individual event
+// Process individual event, returns workspaceId and error response if failed
async function processWebhookEvent(event: any) {
const { objectTypeId, portalId, subscriptionType } =
hubSpotWebhookSchema.parse(event);
@@ -107,50 +152,61 @@ async function processWebhookEvent(event: any) {
console.log("[HubSpot] Event", event);
console.log("[HubSpot] Integration settings", settings);
- // Contact events
- if (objectTypeId === "0-1") {
- const isContactCreated = subscriptionType === "object.creation";
-
- const isLifecycleStageChanged =
- subscriptionType === "object.propertyChange" &&
- settings.leadTriggerEvent === "lifecycleStageReached";
-
- if (isContactCreated || isLifecycleStageChanged) {
- await trackHubSpotLeadEvent({
- payload: event,
- workspace,
- authToken,
- settings,
- });
- }
- }
-
- // Deal event
- if (objectTypeId === "0-3") {
- const isDealCreated =
- subscriptionType === "object.creation" &&
- settings.leadTriggerEvent === "dealCreated";
-
- const isDealUpdated = subscriptionType === "object.propertyChange";
-
- // Track the final lead event
- if (isDealCreated) {
- await trackHubSpotLeadEvent({
- payload: event,
- workspace,
- authToken,
- settings,
- });
+ try {
+ // Contact events
+ if (objectTypeId === "0-1") {
+ const isContactCreated = subscriptionType === "object.creation";
+
+ const isLifecycleStageChanged =
+ subscriptionType === "object.propertyChange" &&
+ settings.leadTriggerEvent === "lifecycleStageReached";
+
+ if (isContactCreated || isLifecycleStageChanged) {
+ await trackHubSpotLeadEvent({
+ payload: event,
+ workspace,
+ authToken,
+ settings,
+ });
+ }
}
- // Track the sale event when deal is closed won
- else if (isDealUpdated) {
- await trackHubSpotSaleEvent({
- payload: event,
- workspace,
- authToken,
- settings,
- });
+ // Deal event
+ if (objectTypeId === "0-3") {
+ const isDealCreated =
+ subscriptionType === "object.creation" &&
+ settings.leadTriggerEvent === "dealCreated";
+
+ const isDealUpdated = subscriptionType === "object.propertyChange";
+
+ // Track the final lead event
+ if (isDealCreated) {
+ await trackHubSpotLeadEvent({
+ payload: event,
+ workspace,
+ authToken,
+ settings,
+ });
+ }
+
+ // Track the sale event when deal is closed won
+ else if (isDealUpdated) {
+ await trackHubSpotSaleEvent({
+ payload: event,
+ workspace,
+ authToken,
+ settings,
+ });
+ }
}
+ } catch (error) {
+ return {
+ workspaceId: workspace.id,
+ errorResponse: handleAndReturnErrorResponse(error),
+ };
}
+
+ return {
+ workspaceId: workspace.id,
+ };
}
diff --git a/apps/web/app/(ee)/api/shopify/integration/webhook/route.ts b/apps/web/app/(ee)/api/shopify/integration/webhook/route.ts
index 7d1c5a32f4..ae468ed5cc 100644
--- a/apps/web/app/(ee)/api/shopify/integration/webhook/route.ts
+++ b/apps/web/app/(ee)/api/shopify/integration/webhook/route.ts
@@ -1,5 +1,7 @@
+import { captureWebhookLog } from "@/lib/api-logs/capture-webhook-log";
import { prisma } from "@dub/prisma";
import { log } from "@dub/utils";
+import { waitUntil } from "@vercel/functions";
import crypto from "crypto";
import { appUninstalled } from "./app-uninstalled";
import { customersDataRequest } from "./customers-data-request";
@@ -19,6 +21,7 @@ const relevantTopics = new Set([
// POST /api/shopify/integration/webhook – Listen to Shopify webhook events
export const POST = async (req: Request) => {
+ const startTime = Date.now();
const data = await req.text();
const headers = req.headers;
const topic = headers.get("x-shopify-topic") || "";
@@ -60,6 +63,14 @@ export const POST = async (req: Request) => {
);
}
+ const requestLog = {
+ workspaceId: workspace.id,
+ method: req.method,
+ path: "/shopify/integration/webhook" as const,
+ requestBody: event,
+ userAgent: req.headers.get("user-agent"),
+ };
+
let response = "OK";
try {
@@ -100,8 +111,30 @@ export const POST = async (req: Request) => {
type: "errors",
});
- return new Response(`[Shopify] Webhook handler failed. View logs`);
+ const response = new Response(
+ `[Shopify] Webhook handler failed. View logs`,
+ );
+
+ waitUntil(
+ captureWebhookLog({
+ ...requestLog,
+ statusCode: 500,
+ duration: Date.now() - startTime,
+ responseBody: response,
+ }),
+ );
+
+ return response;
}
+ waitUntil(
+ captureWebhookLog({
+ ...requestLog,
+ statusCode: 200,
+ duration: Date.now() - startTime,
+ responseBody: response,
+ }),
+ );
+
return new Response(response);
};
diff --git a/apps/web/app/(ee)/api/track/open/route.ts b/apps/web/app/(ee)/api/track/open/route.ts
index f3305e9cb8..3ea39948a4 100644
--- a/apps/web/app/(ee)/api/track/open/route.ts
+++ b/apps/web/app/(ee)/api/track/open/route.ts
@@ -1,3 +1,4 @@
+import { captureRequestLog } from "@/lib/api-logs/capture-request-log";
import { COMMON_CORS_HEADERS } from "@/lib/api/cors";
import { DubApiError, handleAndReturnErrorResponse } from "@/lib/api/errors";
import { linkCache } from "@/lib/api/links/cache";
@@ -20,6 +21,12 @@ import { NextResponse } from "next/server";
// POST /api/track/open – Track an open event for deep link
export const POST = withAxiom(async (req) => {
+ const startTime = Date.now();
+ const url = new URL(req.url);
+ const requestHeaders = req.headers;
+ const reqForLog = req.clone();
+ let workspaceId: string | null = null;
+
try {
const { deepLink: deepLinkUrl, dubDomain } = trackOpenRequestSchema.parse(
await parseRequestBody(req),
@@ -108,6 +115,8 @@ export const POST = withAxiom(async (req) => {
});
}
+ workspaceId = cachedLink.projectId;
+
const linkData = {
id: cachedLink.id,
domain,
@@ -149,9 +158,42 @@ export const POST = withAxiom(async (req) => {
link: linkData,
});
- return NextResponse.json(response, { headers: COMMON_CORS_HEADERS });
+ const jsonResponse = NextResponse.json(response, {
+ headers: COMMON_CORS_HEADERS,
+ });
+
+ captureRequestLog({
+ req: reqForLog,
+ response: jsonResponse,
+ workspace: { id: workspaceId },
+ session: undefined,
+ token: null,
+ url,
+ requestHeaders,
+ startTime,
+ });
+
+ return jsonResponse;
} catch (error) {
- return handleAndReturnErrorResponse(error, COMMON_CORS_HEADERS);
+ const errorResponse = handleAndReturnErrorResponse(
+ error,
+ COMMON_CORS_HEADERS,
+ );
+
+ if (workspaceId) {
+ captureRequestLog({
+ req: reqForLog,
+ response: errorResponse,
+ workspace: { id: workspaceId },
+ session: undefined,
+ token: null,
+ url,
+ requestHeaders,
+ startTime,
+ });
+ }
+
+ return errorResponse;
}
});
diff --git a/apps/web/app/api/logs/[logId]/route.ts b/apps/web/app/api/logs/[logId]/route.ts
index 49a4458501..acc242b65e 100644
--- a/apps/web/app/api/logs/[logId]/route.ts
+++ b/apps/web/app/api/logs/[logId]/route.ts
@@ -32,7 +32,12 @@ export const GET = withWorkspace(
});
}
- return NextResponse.json(await enrichApiLogs(log));
+ const enrichedLog = await enrichApiLogs({
+ logs: log,
+ workspace,
+ });
+
+ return NextResponse.json(enrichedLog);
},
{
requiredPermissions: ["workspaces.read"],
diff --git a/apps/web/app/api/logs/route.ts b/apps/web/app/api/logs/route.ts
index 484eb44ea2..13a48fcc19 100644
--- a/apps/web/app/api/logs/route.ts
+++ b/apps/web/app/api/logs/route.ts
@@ -25,7 +25,12 @@ export const GET = withWorkspace(
workspaceId: workspace.id,
});
- return NextResponse.json(await enrichApiLogs(logs));
+ const enrichedLogs = await enrichApiLogs({
+ logs,
+ workspace,
+ });
+
+ return NextResponse.json(enrichedLogs);
},
{
requiredPermissions: ["workspaces.read"],
diff --git a/apps/web/lib/api-logs/capture-request-log.ts b/apps/web/lib/api-logs/capture-request-log.ts
index 51cc227063..2112b7dc8f 100644
--- a/apps/web/lib/api-logs/capture-request-log.ts
+++ b/apps/web/lib/api-logs/capture-request-log.ts
@@ -49,9 +49,9 @@ export function captureRequestLog({
}: {
req: Request;
response: Response;
- workspace: WorkspaceWithUsers;
- session: Session | undefined;
- token: TokenCacheItem | null;
+ workspace: Pick<WorkspaceWithUsers, "id">;
+ session: Pick<Session, "user"> | undefined;
+ token: Pick<TokenCacheItem, "id"> | null;
url: URL;
requestHeaders: Headers;
startTime: number;
diff --git a/apps/web/lib/api-logs/constants.ts b/apps/web/lib/api-logs/constants.ts
index c62d3578a0..6365f41184 100644
--- a/apps/web/lib/api-logs/constants.ts
+++ b/apps/web/lib/api-logs/constants.ts
@@ -1,10 +1,16 @@
import type { PlanProps } from "@/lib/types";
import {
APPSFLYER_INTEGRATION_ID,
+ HUBSPOT_INTEGRATION_ID,
SHOPIFY_INTEGRATION_ID,
STRIPE_INTEGRATION_ID,
} from "@dub/utils";
+export const PUBLISHABLE_KEY_REQUEST_PATHS = [
+ "/track/lead/client",
+ "/track/sale/client",
+] as const;
+
// Route patterns for parameterized path matching.
// Used both for logging eligibility and route pattern extraction.
// Order matters: more specific patterns must come before less specific ones.
@@ -13,6 +19,7 @@ export const ROUTE_PATTERNS = [
"/track/lead",
"/track/sale",
"/track/open",
+ ...PUBLISHABLE_KEY_REQUEST_PATHS,
// Partners
"/partners/links/upsert",
@@ -118,4 +125,17 @@ export const WEBHOOK_REQUEST_ACTORS_BY_PATH = {
image:
"https://dubassets.com/integrations/int_iWOtrZgmcyU6XDwKr4AYYqLN_jUmF77W",
},
+ "/hubspot/webhook": {
+ id: HUBSPOT_INTEGRATION_ID,
+ name: "HubSpot",
+ image:
+ "https://dubassets.com/integrations/int_ffw3qgrFAahY6qs1hXaH3wHS_JPoCPOh",
+ },
} as const;
+
+export const PUBLISHABLE_KEY_ACTOR = {
+ id: "publishable_key",
+ name: "Publishable Key",
+ email: null,
+ image: null,
+};
diff --git a/apps/web/lib/api-logs/enrich-api-logs.ts b/apps/web/lib/api-logs/enrich-api-logs.ts
index b347a3c22b..303e049972 100644
--- a/apps/web/lib/api-logs/enrich-api-logs.ts
+++ b/apps/web/lib/api-logs/enrich-api-logs.ts
@@ -1,10 +1,18 @@
import { prisma } from "@dub/prisma";
-import { ApiLogTB, EnrichedApiLog } from "../types";
-import { WEBHOOK_REQUEST_ACTORS_BY_PATH } from "./constants";
+import { ApiLogTB, EnrichedApiLog, WorkspaceWithUsers } from "../types";
+import {
+ PUBLISHABLE_KEY_ACTOR,
+ PUBLISHABLE_KEY_REQUEST_PATHS,
+ WEBHOOK_REQUEST_ACTORS_BY_PATH,
+} from "./constants";
-export async function enrichApiLogs(
- logs: ApiLogTB | ApiLogTB[],
-): Promise<EnrichedApiLog | EnrichedApiLog[]> {
+export async function enrichApiLogs({
+ logs,
+ workspace,
+}: {
+ logs: ApiLogTB | ApiLogTB[];
+ workspace: WorkspaceWithUsers;
+}): Promise<EnrichedApiLog | EnrichedApiLog[]> {
const isSingle = !Array.isArray(logs);
const logsArray: ApiLogTB[] = isSingle ? [logs] : logs;
@@ -56,17 +64,41 @@ export async function enrichApiLogs(
]),
);
- const enriched = logsArray.map((log) => ({
- ...log,
- // timestamp is always in UTC
- timestamp: new Date(log.timestamp + "Z").toISOString(),
- token: log.token_id ? tokenMap.get(log.token_id) ?? null : null,
- user: log.user_id
- ? webhookRequestActorsMap.get(log.user_id) ??
- userMap.get(log.user_id) ??
- null
- : null,
- }));
+ const publishableKeyRequestPaths = new Set<string>(
+ PUBLISHABLE_KEY_REQUEST_PATHS,
+ );
+
+ const publishableKeyToken = workspace.publishableKey
+ ? {
+ id: PUBLISHABLE_KEY_ACTOR.id,
+ name: "",
+ partialKey: `${workspace.publishableKey.slice(0, 3)}...${workspace.publishableKey.slice(-4)}`,
+ }
+ : null;
+
+ const enriched = logsArray.map((log) => {
+ const isPublishableKeyRequest = publishableKeyRequestPaths.has(
+ log.route_pattern,
+ );
+
+ return {
+ ...log,
+ // timestamp is always in UTC
+ timestamp: new Date(log.timestamp + "Z").toISOString(),
+ token: isPublishableKeyRequest
+ ? publishableKeyToken
+ : log.token_id
+ ? tokenMap.get(log.token_id) ?? null
+ : null,
+ user: isPublishableKeyRequest
+ ? PUBLISHABLE_KEY_ACTOR
+ : log.user_id
+ ? webhookRequestActorsMap.get(log.user_id) ??
+ userMap.get(log.user_id) ??
+ null
+ : null,
+ };
+ });
return isSingle ? enriched[0] : enriched;
}
diff --git a/apps/web/lib/auth/publishable-key.ts b/apps/web/lib/auth/publishable-key.ts
index 0317aec276..9a8540a114 100644
--- a/apps/web/lib/auth/publishable-key.ts
+++ b/apps/web/lib/auth/publishable-key.ts
@@ -1,3 +1,4 @@
+import { captureRequestLog } from "@/lib/api-logs/capture-request-log";
import { DubApiError, handleAndReturnErrorResponse } from "@/lib/api/errors";
import { withAxiom } from "@/lib/axiom/server";
import { ratelimit } from "@/lib/upstash";
@@ -41,9 +42,14 @@ export const withPublishableKey = (
req,
{ params: initialParams }: { params: Promise<Record<string, string>> },
) => {
+ const startTime = Date.now();
const params = (await initialParams) || {};
+ const url = new URL(req.url);
+ const reqForLog = req.clone();
+
let requestHeaders = await headers();
let responseHeaders = COMMON_CORS_HEADERS;
+ let workspace: Project | null = null;
try {
const authorizationHeader = requestHeaders.get("Authorization");
@@ -80,7 +86,7 @@ export const withPublishableKey = (
});
}
- const workspace = await prisma.project.findUnique({
+ workspace = await prisma.project.findUnique({
where: {
publishableKey,
},
@@ -101,7 +107,25 @@ export const withPublishableKey = (
}
const searchParams = getSearchParams(req.url);
- return await handler({ req, params, searchParams, workspace });
+ const response = await handler({
+ req,
+ params,
+ searchParams,
+ workspace,
+ });
+
+ captureRequestLog({
+ req: reqForLog,
+ response,
+ workspace,
+ session: undefined,
+ token: null,
+ url,
+ requestHeaders,
+ startTime,
+ });
+
+ return response;
} else {
throw new DubApiError({
code: "unauthorized",
@@ -109,7 +133,25 @@ export const withPublishableKey = (
});
}
} catch (error) {
- return handleAndReturnErrorResponse(error, responseHeaders);
+ const errorResponse = handleAndReturnErrorResponse(
+ error,
+ responseHeaders,
+ );
+
+ if (workspace) {
+ captureRequestLog({
+ req: reqForLog,
+ response: errorResponse,
+ workspace,
+ session: undefined,
+ token: null,
+ url,
+ requestHeaders,
+ startTime,
+ });
+ }
+
+ return errorResponse;
}
},
);