Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Refactor trackingPayloadSchema for improved validation and reusability

Bill Yang2ba7df9888da
diff --git a/server/src/services/tracker/trackEvent.ts b/server/src/services/tracker/trackEvent.ts
index 0986c6e9f..906b9bd22 100644
--- a/server/src/services/tracker/trackEvent.ts
+++ b/server/src/services/tracker/trackEvent.ts
@@ -9,77 +9,68 @@ import { pageviewQueue } from "./pageviewQueue.js";
import { createBasePayload } from "./utils.js";
import { getLocation } from "../../db/geolocation/geolocation.js";
+// Shared fields for all event types
+const baseEventFields = {
+ site_id: z.string().min(1),
+ hostname: z.string().max(253).optional(),
+ pathname: z.string().max(2048).optional(),
+ querystring: z.string().max(2048).optional(),
+ screenWidth: z.number().int().positive().optional(),
+ screenHeight: z.number().int().positive().optional(),
+ language: z.string().max(35).optional(),
+ page_title: z.string().max(512).optional(),
+ referrer: z.string().max(2048).optional(),
+ user_id: z.string().max(255).optional(),
+ ip_address: z.string().ip().optional(),
+ user_agent: z.string().max(512).optional(),
+};
+
+// Default event_name and properties used by pageview and performance
+const defaultEventProps = {
+ event_name: z.string().max(256).optional(),
+ properties: z.string().max(2048).optional(),
+};
+
+// Reusable JSON validation refine
+const jsonStringRefine = (message: string) =>
+ z
+ .string()
+ .max(2048)
+ .refine(
+ val => {
+ try {
+ JSON.parse(val);
+ return true;
+ } catch {
+ return false;
+ }
+ },
+ { message }
+ )
+ .optional();
+
// Define Zod schema for validation
export const trackingPayloadSchema = z.discriminatedUnion("type", [
z
.object({
type: z.literal("pageview"),
- site_id: z.string().min(1),
- hostname: z.string().max(253).optional(),
- pathname: z.string().max(2048).optional(),
- querystring: z.string().max(2048).optional(),
- screenWidth: z.number().int().positive().optional(),
- screenHeight: z.number().int().positive().optional(),
- language: z.string().max(35).optional(),
- page_title: z.string().max(512).optional(),
- referrer: z.string().max(2048).optional(),
- event_name: z.string().max(256).optional(),
- properties: z.string().max(2048).optional(),
- user_id: z.string().max(255).optional(),
- ip_address: z.string().ip().optional(), // Custom IP for geolocation
- user_agent: z.string().max(512).optional(), // Custom user agent
+ ...baseEventFields,
+ ...defaultEventProps,
})
.strict(),
z
.object({
type: z.literal("custom_event"),
- site_id: z.string().min(1),
- hostname: z.string().max(253).optional(),
- pathname: z.string().max(2048).optional(),
- querystring: z.string().max(2048).optional(),
- screenWidth: z.number().int().positive().optional(),
- screenHeight: z.number().int().positive().optional(),
- language: z.string().max(35).optional(),
- page_title: z.string().max(512).optional(),
- referrer: z.string().max(2048).optional(),
+ ...baseEventFields,
event_name: z.string().min(1).max(256),
- properties: z
- .string()
- .max(2048)
- .refine(
- val => {
- try {
- JSON.parse(val);
- return true;
- } catch (e) {
- return false;
- }
- },
- { message: "Properties must be a valid JSON string" }
- )
- .optional(), // Optional but must be valid JSON if present
- user_id: z.string().max(255).optional(),
- ip_address: z.string().ip().optional(), // Custom IP for geolocation
- user_agent: z.string().max(512).optional(), // Custom user agent
+ properties: jsonStringRefine("Properties must be a valid JSON string"),
})
.strict(),
z
.object({
type: z.literal("performance"),
- site_id: z.string().min(1),
- hostname: z.string().max(253).optional(),
- pathname: z.string().max(2048).optional(),
- querystring: z.string().max(2048).optional(),
- screenWidth: z.number().int().positive().optional(),
- screenHeight: z.number().int().positive().optional(),
- language: z.string().max(35).optional(),
- page_title: z.string().max(512).optional(),
- referrer: z.string().max(2048).optional(),
- event_name: z.string().max(256).optional(),
- properties: z.string().max(2048).optional(),
- user_id: z.string().max(255).optional(),
- ip_address: z.string().ip().optional(), // Custom IP for geolocation
- user_agent: z.string().max(512).optional(), // Custom user agent
+ ...baseEventFields,
+ ...defaultEventProps,
// Performance metrics (can be null if not collected)
lcp: z.number().min(0).nullable().optional(),
cls: z.number().min(0).nullable().optional(),
@@ -91,16 +82,8 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
z
.object({
type: z.literal("outbound"),
- site_id: z.string().min(1),
- hostname: z.string().max(253).optional(),
- pathname: z.string().max(2048).optional(),
- querystring: z.string().max(2048).optional(),
- screenWidth: z.number().int().positive().optional(),
- screenHeight: z.number().int().positive().optional(),
- language: z.string().max(35).optional(),
- page_title: z.string().max(512).optional(),
- referrer: z.string().max(2048).optional(),
- event_name: z.string().max(256).optional(), // Empty for outbound events
+ ...baseEventFields,
+ event_name: z.string().max(256).optional(),
properties: z
.string()
.max(2048)
@@ -108,20 +91,16 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
val => {
try {
const parsed = JSON.parse(val);
- // Validate outbound-specific properties
if (typeof parsed.url !== "string" || parsed.url.length === 0) return false;
if (parsed.text && typeof parsed.text !== "string") return false;
if (parsed.target && typeof parsed.target !== "string") return false;
-
- // Validate URL format
try {
new URL(parsed.url);
} catch {
return false;
}
-
return true;
- } catch (e) {
+ } catch {
return false;
}
},
@@ -129,23 +108,12 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
message: "Properties must be valid JSON with outbound link fields (url required, text and target optional)",
}
),
- user_id: z.string().max(255).optional(),
- ip_address: z.string().ip().optional(), // Custom IP for geolocation
- user_agent: z.string().max(512).optional(), // Custom user agent
})
.strict(),
z
.object({
type: z.literal("error"),
- site_id: z.string().min(1),
- hostname: z.string().max(253).optional(),
- pathname: z.string().max(2048).optional(),
- querystring: z.string().max(2048).optional(),
- screenWidth: z.number().int().positive().optional(),
- screenHeight: z.number().int().positive().optional(),
- language: z.string().max(35).optional(),
- page_title: z.string().max(512).optional(),
- referrer: z.string().max(2048).optional(),
+ ...baseEventFields,
event_name: z.string().min(1).max(256), // Error type (TypeError, ReferenceError, etc.)
properties: z
.string()
@@ -154,17 +122,11 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
val => {
try {
const parsed = JSON.parse(val);
- // Validate error-specific properties
if (typeof parsed.message !== "string") return false;
if (parsed.stack && typeof parsed.stack !== "string") return false;
-
- // Support both camelCase and lowercase for backwards compatibility
if (parsed.fileName && typeof parsed.fileName !== "string") return false;
-
if (parsed.lineNumber && typeof parsed.lineNumber !== "number") return false;
-
if (parsed.columnNumber && typeof parsed.columnNumber !== "number") return false;
-
// Apply truncation limits
if (parsed.message && parsed.message.length > 500) {
parsed.message = parsed.message.substring(0, 500);
@@ -172,9 +134,8 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
if (parsed.stack && parsed.stack.length > 2000) {
parsed.stack = parsed.stack.substring(0, 2000);
}
-
return true;
- } catch (e) {
+ } catch {
return false;
}
},
@@ -183,9 +144,6 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
"Properties must be valid JSON with error fields (message, stack, fileName, lineNumber, columnNumber)",
}
),
- user_id: z.string().max(255).optional(),
- ip_address: z.string().ip().optional(), // Custom IP for geolocation
- user_agent: z.string().max(512).optional(), // Custom user agent
})
.strict(),
]);