🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor analytics API for improved parameter handling and input validation
Bill Yang2d451b38f955
diff --git a/server/src/api/analytics/getFunnel.ts b/server/src/api/analytics/getFunnel.tsindex 295a9fb28..40e73df8c 100644--- a/server/src/api/analytics/getFunnel.ts+++ b/server/src/api/analytics/getFunnel.ts@@ -96,7 +96,7 @@ export async function getFunnel(typeFROM eventsWHERE- site_id = ${site}+ site_id = {siteId:Int32}${timeStatement}${filterConditions}AND user_id != ''@@ -161,7 +161,7 @@ export async function getFunnel(LEFT JOIN (SELECT step_number + 1 as next_step_number, visitorsFROM StepCounts- WHERE step_number < ${steps.length}+ WHERE step_number < {stepNumber:Int32}) as prev_step ON s1.step_number = prev_step.next_step_numberORDER BY s1.step_number`;@@ -170,6 +170,10 @@ export async function getFunnel(const result = await clickhouse.query({query,format: "JSONEachRow",+ query_params: {+ siteId: Number(site),+ stepNumber: steps.length,+ },});// Process the resultsdiff --git a/server/src/api/analytics/getLiveUsercount.ts b/server/src/api/analytics/getLiveUsercount.tsindex c58e2c7ec..00fd8e3d5 100644--- a/server/src/api/analytics/getLiveUsercount.ts+++ b/server/src/api/analytics/getLiveUsercount.ts@@ -18,7 +18,7 @@ export const getLiveUsercount = async (}const query = await clickhouse.query({- query: `SELECT COUNT(DISTINCT(session_id)) AS count FROM events WHERE timestamp > now() - interval '${minutes} minute' AND site_id = {siteId:Int32}`,+ query: `SELECT COUNT(DISTINCT(session_id)) AS count FROM events WHERE timestamp > now() - interval {minutes:Int32} minute AND site_id = {siteId:Int32}`,format: "JSONEachRow",query_params: {siteId: Number(site),diff --git a/server/src/api/analytics/getOverviewBucketed.ts b/server/src/api/analytics/getOverviewBucketed.tsindex 9470c87da..ad4ab85c1 100644--- a/server/src/api/analytics/getOverviewBucketed.ts+++ b/server/src/api/analytics/getOverviewBucketed.ts@@ -6,6 +6,7 @@ import {processResults,} from "./utils.js";import { getUserHasAccessToSitePublic } from "../../lib/auth-utils.js";+import { sanitizeTimeStatementFillParams } from "./sql-sanitziation.js";const TimeBucketToFn = {minute: "toStartOfMinute",@@ -41,23 +42,28 @@ function getTimeStatementFill(},bucket: TimeBucket) {- if (date) {- const { startDate, endDate, timezone } = date;+ const { params, bucket: validatedBucket } = sanitizeTimeStatementFillParams(+ { date, pastMinutes },+ bucket+ );++ if (params.date) {+ const { startDate, endDate, timezone } = params.date;return `WITH FILL FROM toTimeZone(- toDateTime(${TimeBucketToFn[bucket]}(toDateTime('${startDate}', '${timezone}'))),+ toDateTime(${TimeBucketToFn[validatedBucket]}(toDateTime('${startDate}', '${timezone}'))),'UTC')TO if(toDate('${endDate}') = toDate(now(), '${timezone}'),now(),toTimeZone(- toDateTime(${TimeBucketToFn[bucket]}(toDateTime('${endDate}', '${timezone}'))) + INTERVAL 1 DAY,+ toDateTime(${TimeBucketToFn[validatedBucket]}(toDateTime('${endDate}', '${timezone}'))) + INTERVAL 1 DAY,'UTC')- ) STEP INTERVAL ${bucketIntervalMap[bucket]}`;+ ) STEP INTERVAL ${bucketIntervalMap[validatedBucket]}`;}- if (pastMinutes) {- return `WITH FILL FROM now() - INTERVAL ${pastMinutes} MINUTE TO now() STEP INTERVAL ${bucketIntervalMap[bucket]}`;+ if (params.pastMinutes) {+ return `WITH FILL FROM now() - INTERVAL ${params.pastMinutes} MINUTE TO now() STEP INTERVAL ${bucketIntervalMap[validatedBucket]}`;}return "";}@@ -208,7 +214,7 @@ export async function getOverviewBucketed(bucket,site,filters,- pastMinutes,+ pastMinutes: pastMinutes ? Number(pastMinutes) : undefined,});try {diff --git a/server/src/api/analytics/sql-sanitziation.ts b/server/src/api/analytics/sql-sanitziation.tsindex e69de29bb..1d1bf77fe 100644--- a/server/src/api/analytics/sql-sanitziation.ts+++ b/server/src/api/analytics/sql-sanitziation.ts@@ -0,0 +1,113 @@+import { z } from "zod";+import { Filter, FilterParameter, FilterType } from "./types.js";++// Schemas for getTimeStatement()+const tableSchema = z.enum(["events", "sessions"]).optional();++const dateParamsSchema = z.object({+ startDate: z.string().optional(),+ endDate: z.string().optional(),+ timezone: z.string(),+ table: tableSchema,+});++const timeStatementParamsSchema = z+ .object({+ date: dateParamsSchema.optional(),+ pastMinutes: z.number().nonnegative().optional(),+ })+ .refine((data) => data.date !== undefined || data.pastMinutes !== undefined, {+ message: "Either date or pastMinutes must be provided",+ });++// Schema for getTimeStatementFill()+const fillDateParamsSchema = z.object({+ startDate: z.string(),+ endDate: z.string(),+ timezone: z.string(),+});++const timeStatementFillParamsSchema = z+ .object({+ date: fillDateParamsSchema.optional(),+ pastMinutes: z.number().nonnegative().optional(),+ })+ .refine((data) => data.date !== undefined || data.pastMinutes !== undefined, {+ message: "Either date or pastMinutes must be provided",+ });++const timeBucketSchema = z.enum([+ "minute",+ "five_minutes",+ "ten_minutes",+ "fifteen_minutes",+ "hour",+ "day",+ "week",+ "month",+ "year",+]);++// Schema for getFilterStatement()+const filterTypeSchema = z.enum([+ "equals",+ "not_equals",+ "contains",+ "not_contains",+]);++const filterParamSchema = z.enum([+ "browser",+ "operating_system",+ "language",+ "country",+ "region",+ "city",+ "device_type",+ "referrer",+ "pathname",+ "page_title",+ "querystring",+ "event_name",+ "channel",+ "entry_page",+ "exit_page",+ "dimensions",+]);++const filterSchema = z.object({+ parameter: filterParamSchema,+ type: filterTypeSchema,+ value: z.array(z.string()),+});++// Validate and sanitize inputs+export function sanitizeTimeStatementParams(params: unknown) {+ return timeStatementParamsSchema.parse(params);+}++export function sanitizeTimeStatementFillParams(+ params: unknown,+ bucket: unknown+) {+ const validatedParams = timeStatementFillParamsSchema.parse(params);+ const validatedBucket = timeBucketSchema.parse(bucket);++ return {+ params: validatedParams,+ bucket: validatedBucket,+ };+}++export function sanitizeFilters(filtersStr: string) {+ // First validate it's proper JSON+ let parsed: unknown;+ try {+ parsed = JSON.parse(filtersStr);+ } catch (e) {+ throw new Error("Invalid JSON format");+ }++ // Then validate the parsed structure+ return z.array(filterSchema).parse(parsed);+}diff --git a/server/src/api/analytics/utils.ts b/server/src/api/analytics/utils.tsindex a605fa684..adf80be8e 100644--- a/server/src/api/analytics/utils.ts+++ b/server/src/api/analytics/utils.ts@@ -1,20 +1,27 @@import { ResultSet } from "@clickhouse/client";import { Filter, FilterParameter, FilterType } from "./types.js";+import {+ sanitizeTimeStatementParams,+ sanitizeFilters,+} from "./sql-sanitziation.js";export function getTimeStatement({date,pastMinutes,}: {date?: {- startDate: string;- endDate: string;+ startDate?: string;+ endDate?: string;timezone: string;table?: "events" | "sessions";};pastMinutes?: number;}) {- if (date) {- const { startDate, endDate, timezone, table } = date;+ // Sanitize inputs with Zod+ const sanitized = sanitizeTimeStatementParams({ date, pastMinutes });++ if (sanitized.date) {+ const { startDate, endDate, timezone, table } = sanitized.date;if (!startDate && !endDate) {return "";}@@ -34,8 +41,8 @@ export function getTimeStatement({))`;}- if (pastMinutes) {- return `AND timestamp > now() - interval '${pastMinutes} minute'`;+ if (sanitized.pastMinutes) {+ return `AND timestamp > now() - interval '${sanitized.pastMinutes} minute'`;}}@@ -86,14 +93,18 @@ export function getFilterStatement(filters: string) {if (!filters) {return "";}- const filtersArray = JSON.parse(filters);++ // Sanitize inputs with Zod+ const filtersArray = sanitizeFilters(filters);+if (filtersArray.length === 0) {return "";}+return ("AND " +filtersArray- .map((filter: Filter) => {+ .map((filter) => {const x =filter.type === "contains" || filter.type === "not_contains"? "%"