Skip to content

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

Refactor analytics API endpoints to utilize `FilterParams` for improv… (#396)

Bill Yang9b36804ea437
diff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
index d1fe6d18a..03d527d40 100644
--- a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
@@ -1,16 +1,17 @@
"use client";
-import { FilterParameter } from "@rybbit/shared";
import { Button } from "@/components/ui/button";
+import { FilterParameter } from "@rybbit/shared";
import { AlertCircle, Info, RefreshCcw } from "lucide-react";
import { ReactNode } from "react";
import { usePaginatedSingleCol } from "../../../../../api/analytics/usePaginatedSingleCol";
import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";
import { CardLoader } from "../../../../../components/ui/card";
-import { StandardSectionDialog } from "./StandardSectionDialog";
import { Row } from "./Row";
import { Skeleton } from "./Skeleton";
-import { useWindowSize } from "@uidotdev/usehooks";
+import { StandardSectionDialog } from "./StandardSectionDialog";
+
+const MAX_ITEMS_TO_DISPLAY = 10;
export function StandardSection({
title,
@@ -53,10 +54,6 @@ export function StandardSection({
? 100 / itemsForDisplay[0].percentage
: 1;
- const { width } = useWindowSize();
-
- const MAX_ITEMS_TO_DISPLAY = width && width < 768 ? 10 : Infinity;
-
return (
<>
{isFetching && (
diff --git a/client/src/hooks/useAdminUsers.ts b/client/src/hooks/useAdminUsers.ts
index 971662953..6d98edb69 100644
--- a/client/src/hooks/useAdminUsers.ts
+++ b/client/src/hooks/useAdminUsers.ts
@@ -88,7 +88,6 @@ export function useAdminUsers() {
await authClient.admin.impersonateUser({
userId,
});
- console.log("impersonated");
router.push("/");
// Redirect to home after impersonation
return true;
diff --git a/server/src/api/analytics/events/getEventNames.ts b/server/src/api/analytics/events/getEventNames.ts
index 889d6ae25..c99c9b72c 100644
--- a/server/src/api/analytics/events/getEventNames.ts
+++ b/server/src/api/analytics/events/getEventNames.ts
@@ -40,17 +40,7 @@ export async function getEventNames(
return res.status(403).send({ error: "Forbidden" });
}
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } }
- );
+ const timeStatement = getTimeStatement(req.query);
const filterStatement = filters ? getFilterStatement(filters) : "";
diff --git a/server/src/api/analytics/events/getEventProperties.ts b/server/src/api/analytics/events/getEventProperties.ts
index 5182d15ae..e48a4425a 100644
--- a/server/src/api/analytics/events/getEventProperties.ts
+++ b/server/src/api/analytics/events/getEventProperties.ts
@@ -46,17 +46,7 @@ export async function getEventProperties(
return res.status(400).send({ error: "Event name is required" });
}
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } }
- );
+ const timeStatement = getTimeStatement(req.query);
const filterStatement = filters ? getFilterStatement(filters) : "";
diff --git a/server/src/api/analytics/events/getEvents.ts b/server/src/api/analytics/events/getEvents.ts
index 66e84b208..11ce70b99 100644
--- a/server/src/api/analytics/events/getEvents.ts
+++ b/server/src/api/analytics/events/getEvents.ts
@@ -6,6 +6,7 @@ import {
getFilterStatement,
} from "../utils.js";
import { getUserHasAccessToSitePublic } from "../../../lib/auth-utils.js";
+import { FilterParams } from "@rybbit/shared";
export type GetEventsResponse = {
timestamp: string;
@@ -28,15 +29,11 @@ interface GetEventsRequest {
Params: {
site: string;
};
- Querystring: {
- startDate?: string;
- endDate?: string;
- timeZone?: string;
- filters?: string;
+ Querystring: FilterParams<{
page?: string;
pageSize?: string;
count?: string; // Keeping for backward compatibility
- };
+ }>;
}
export async function getEvents(
@@ -66,7 +63,7 @@ export async function getEvents(
// Get time and filter statements if parameters are provided
const timeStatement =
startDate || endDate
- ? getTimeStatement({ date: { startDate, endDate, timeZone } })
+ ? getTimeStatement(req.query)
: "AND timestamp > now() - INTERVAL 30 MINUTE"; // Default to last 30 minutes if no time range specified
const filterStatement = filters ? getFilterStatement(filters) : "";
diff --git a/server/src/api/analytics/funnels/getFunnel.ts b/server/src/api/analytics/funnels/getFunnel.ts
index 31a76228d..c8247b6f9 100644
--- a/server/src/api/analytics/funnels/getFunnel.ts
+++ b/server/src/api/analytics/funnels/getFunnel.ts
@@ -64,7 +64,9 @@ export async function getFunnel(
try {
// Create the time statement for the date range
const timeStatement = getTimeStatement({
- date: { startDate, endDate, timeZone },
+ startDate,
+ endDate,
+ timeZone,
});
// Get filter conditions using the existing utility function
diff --git a/server/src/api/analytics/getJourneys.ts b/server/src/api/analytics/getJourneys.ts
index 32df4230c..4e3a1cb7f 100644
--- a/server/src/api/analytics/getJourneys.ts
+++ b/server/src/api/analytics/getJourneys.ts
@@ -2,17 +2,15 @@ import { FastifyRequest, FastifyReply } from "fastify";
import clickhouse from "../../db/clickhouse/clickhouse.js";
import { DateTime } from "luxon";
import { getTimeStatement } from "./utils.js";
+import { FilterParams } from "@rybbit/shared";
export const getJourneys = async (
request: FastifyRequest<{
Params: { site: string };
- Querystring: {
+ Querystring: FilterParams<{
steps?: string;
- startDate?: string;
- endDate?: string;
- timeZone?: string;
limit?: string;
- };
+ }>;
}>,
reply: FastifyReply
) => {
@@ -42,18 +40,7 @@ export const getJourneys = async (
}
// Time conditions using getTimeStatement
- const timeStatement = getTimeStatement({
- date:
- startDate || endDate
- ? {
- startDate:
- startDate || DateTime.now().minus({ days: 30 }).toISODate(),
- endDate: endDate || DateTime.now().toISODate(),
- timeZone,
- table: "events",
- }
- : undefined,
- });
+ const timeStatement = getTimeStatement(request.query);
// Query to find sequences of events (journeys) for each user
const result = await clickhouse.query({
diff --git a/server/src/api/analytics/getOverview.ts b/server/src/api/analytics/getOverview.ts
index dd211395b..025b6ae31 100644
--- a/server/src/api/analytics/getOverview.ts
+++ b/server/src/api/analytics/getOverview.ts
@@ -18,26 +18,10 @@ type GetOverviewResponse = {
session_duration: number;
};
-const getQuery = ({
- startDate,
- endDate,
- timeZone,
- filters,
- pastMinutesRange,
-}: {
- startDate: string;
- endDate: string;
- timeZone: string;
- filters: string;
- pastMinutesRange?: { start: number; end: number };
-}) => {
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } };
+const getQuery = (params: FilterParams) => {
+ const filterStatement = getFilterStatement(params.filters);
- const filterStatement = getFilterStatement(filters);
-
- return `SELECT
+ return `SELECT
session_stats.sessions,
session_stats.pages_per_session,
session_stats.bounce_rate * 100 AS bounce_rate,
@@ -64,7 +48,7 @@ const getQuery = ({
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(timeParams)}
+ ${getTimeStatement(params)}
GROUP BY session_id
)
) AS session_stats
@@ -78,7 +62,7 @@ const getQuery = ({
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(timeParams)}
+ ${getTimeStatement(params)}
AND type = 'pageview'
) AS page_stats`;
};
@@ -108,17 +92,13 @@ export async function getOverview(
return res.status(403).send({ error: "Forbidden" });
}
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
const query = getQuery({
startDate,
endDate,
timeZone,
filters,
- pastMinutesRange: pastMinutesRange,
+ pastMinutesStart,
+ pastMinutesEnd,
});
try {
diff --git a/server/src/api/analytics/getOverviewBucketed.ts b/server/src/api/analytics/getOverviewBucketed.ts
index e7822d7d0..c0d1055b1 100644
--- a/server/src/api/analytics/getOverviewBucketed.ts
+++ b/server/src/api/analytics/getOverviewBucketed.ts
@@ -34,23 +34,16 @@ const bucketIntervalMap = {
year: "1 YEAR",
} as const;
-function getTimeStatementFill(
- {
- date,
- pastMinutesRange,
- }: {
- date?: { startDate: string; endDate: string; timeZone: string };
- pastMinutesRange?: { start: number; end: number };
- },
- bucket: TimeBucket
-) {
- const { params, bucket: validatedBucket } = validateTimeStatementFillParams(
- { date, pastMinutesRange },
- bucket
- );
+function getTimeStatementFill(params: FilterParams, bucket: TimeBucket) {
+ const { params: validatedParams, bucket: validatedBucket } =
+ validateTimeStatementFillParams(params, bucket);
- if (params.date) {
- const { startDate, endDate, timeZone } = params.date;
+ if (
+ validatedParams.startDate &&
+ validatedParams.endDate &&
+ validatedParams.timeZone
+ ) {
+ const { startDate, endDate, timeZone } = validatedParams;
return `WITH FILL FROM toTimeZone(
toDateTime(${
TimeBucketToFn[validatedBucket]
@@ -75,8 +68,11 @@ function getTimeStatementFill(
) STEP INTERVAL ${bucketIntervalMap[validatedBucket]}`;
}
// For specific past minutes range - convert to exact timestamps for better performance
- if (params.pastMinutesRange) {
- const { start, end } = params.pastMinutesRange;
+ if (
+ validatedParams.pastMinutesStart !== undefined &&
+ validatedParams.pastMinutesEnd !== undefined
+ ) {
+ const { pastMinutesStart: start, pastMinutesEnd: end } = validatedParams;
// Calculate exact timestamps in JavaScript to avoid runtime ClickHouse calculations
const now = new Date();
@@ -114,28 +110,24 @@ function getTimeStatementFill(
return "";
}
-const getQuery = ({
- startDate,
- endDate,
- timeZone,
- bucket,
- filters,
- pastMinutesRange,
-}: {
- startDate: string;
- endDate: string;
- timeZone: string;
- bucket: TimeBucket;
- filters: string;
- pastMinutesRange?: { start: number; end: number };
-}) => {
+const getQuery = (params: FilterParams<{ bucket: TimeBucket }>) => {
+ const {
+ startDate,
+ endDate,
+ timeZone,
+ bucket,
+ filters,
+ pastMinutesStart,
+ pastMinutesEnd,
+ } = params;
const filterStatement = getFilterStatement(filters);
- const isAllTime = !startDate && !endDate && !pastMinutesRange;
+ const pastMinutesRange =
+ pastMinutesStart !== undefined && pastMinutesEnd !== undefined
+ ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
+ : undefined;
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } };
+ const isAllTime = !startDate && !endDate && !pastMinutesRange;
const query = `
SELECT
@@ -168,12 +160,12 @@ FROM
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(timeParams)}
+ ${getTimeStatement(params)}
AND type = 'pageview'
GROUP BY session_id
)
GROUP BY time ORDER BY time ${
- isAllTime ? "" : getTimeStatementFill(timeParams, bucket)
+ isAllTime ? "" : getTimeStatementFill(params, bucket)
}
) AS session_stats
FULL JOIN
@@ -188,10 +180,10 @@ FULL JOIN
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(timeParams)}
+ ${getTimeStatement(params)}
AND type = 'pageview'
GROUP BY time ORDER BY time ${
- isAllTime ? "" : getTimeStatementFill(timeParams, bucket)
+ isAllTime ? "" : getTimeStatementFill(params, bucket)
}
) AS page_stats
USING time
@@ -252,7 +244,8 @@ export async function getOverviewBucketed(
timeZone,
bucket,
filters,
- pastMinutesRange,
+ pastMinutesStart,
+ pastMinutesEnd,
});
try {
diff --git a/server/src/api/analytics/getPageTitles.ts b/server/src/api/analytics/getPageTitles.ts
index 60ae60a8a..c7677d70b 100644
--- a/server/src/api/analytics/getPageTitles.ts
+++ b/server/src/api/analytics/getPageTitles.ts
@@ -49,20 +49,7 @@ const getPageTitlesQuery = (
} = request.query;
const filterStatement = getFilterStatement(filters);
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : {
- date: { startDate, endDate, timeZone },
- }
- );
+ const timeStatement = getTimeStatement(request.query);
let validatedLimit: number | null = null;
if (!isCountQuery && limit !== undefined) {
diff --git a/server/src/api/analytics/getSessions.ts b/server/src/api/analytics/getSessions.ts
index 4647b3083..c16dce40d 100644
--- a/server/src/api/analytics/getSessions.ts
+++ b/server/src/api/analytics/getSessions.ts
@@ -48,16 +48,7 @@ export async function getSessions(
req: FastifyRequest<GetSessionsRequest>,
res: FastifyReply
) {
- const {
- startDate,
- endDate,
- timeZone,
- filters,
- page,
- userId,
- pastMinutesStart,
- pastMinutesEnd,
- } = req.query;
+ const { filters, page, userId } = req.query;
const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSitePublic(req, site);
if (!userHasAccessToSite) {
@@ -65,21 +56,7 @@ export async function getSessions(
}
const filterStatement = getFilterStatement(filters);
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- // Set up time parameters
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : startDate && endDate
- ? { date: { startDate, endDate, timeZone } }
- : {};
-
- const timeStatement = getTimeStatement(timeParams);
+ const timeStatement = getTimeStatement(req.query);
const query = `
WITH AggregatedSessions AS (
diff --git a/server/src/api/analytics/getSingleCol.ts b/server/src/api/analytics/getSingleCol.ts
index 7da60e64f..908304651 100644
--- a/server/src/api/analytics/getSingleCol.ts
+++ b/server/src/api/analytics/getSingleCol.ts
@@ -69,20 +69,7 @@ const getQuery = (
} = request.query;
const filterStatement = getFilterStatement(filters);
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : {
- date: { startDate, endDate, timeZone },
- }
- );
+ const timeStatement = getTimeStatement(request.query);
let validatedLimit: number | null = null;
if (!isCountQuery && limit !== undefined) {
diff --git a/server/src/api/analytics/getUserSessions.ts b/server/src/api/analytics/getUserSessions.ts
index 18f132682..26f750656 100644
--- a/server/src/api/analytics/getUserSessions.ts
+++ b/server/src/api/analytics/getUserSessions.ts
@@ -66,9 +66,7 @@ export async function getUserSessions(
}
const filterStatement = getFilterStatement(filters);
- const timeStatement = getTimeStatement({
- date: { startDate, endDate, timeZone },
- });
+ const timeStatement = getTimeStatement(req.query);
const query = `
SELECT
diff --git a/server/src/api/analytics/getUsers.ts b/server/src/api/analytics/getUsers.ts
index 81d056220..29b4b27d3 100644
--- a/server/src/api/analytics/getUsers.ts
+++ b/server/src/api/analytics/getUsers.ts
@@ -74,22 +74,9 @@ export async function getUsers(
const actualSortBy = validSortFields.includes(sortBy) ? sortBy : "last_seen";
const actualSortOrder = sortOrder === "asc" ? "ASC" : "DESC";
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- // Set up time parameters
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : startDate && endDate
- ? { date: { startDate, endDate, timeZone } }
- : {};
-
// Generate filter statement and time statement
const filterStatement = getFilterStatement(filters);
- const timeStatement = getTimeStatement(timeParams);
+ const timeStatement = getTimeStatement(req.query);
const query = `
WITH AggregatedUsers AS (
diff --git a/server/src/api/analytics/goals/getGoals.ts b/server/src/api/analytics/goals/getGoals.ts
index 0bbed1f6f..5202d831b 100644
--- a/server/src/api/analytics/goals/getGoals.ts
+++ b/server/src/api/analytics/goals/getGoals.ts
@@ -148,21 +148,7 @@ export async function getGoals(
// Build filter and time clauses for ClickHouse queries
const filterStatement = filters ? getFilterStatement(filters) : "";
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- // Set up time parameters
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : startDate || endDate
- ? { date: { startDate, endDate, timeZone } }
- : {};
-
- const timeStatement = getTimeStatement(timeParams);
+ const timeStatement = getTimeStatement(request.query);
// First, get the total number of unique sessions (denominator for conversion rate)
const totalSessionsQuery = `
diff --git a/server/src/api/analytics/performance/getPerformanceByDimension.ts b/server/src/api/analytics/performance/getPerformanceByDimension.ts
index 3e0b516a2..8163b07e9 100644
--- a/server/src/api/analytics/performance/getPerformanceByDimension.ts
+++ b/server/src/api/analytics/performance/getPerformanceByDimension.ts
@@ -91,20 +91,7 @@ const getQuery = (
}
const filterStatement = getFilterStatement(filters);
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : {
- date: { startDate, endDate, timeZone },
- }
- );
+ const timeStatement = getTimeStatement(request.query);
let validatedLimit: number | null = null;
if (!isCountQuery && limit !== undefined) {
diff --git a/server/src/api/analytics/performance/getPerformanceOverview.ts b/server/src/api/analytics/performance/getPerformanceOverview.ts
index f9f15dfb2..790fb1520 100644
--- a/server/src/api/analytics/performance/getPerformanceOverview.ts
+++ b/server/src/api/analytics/performance/getPerformanceOverview.ts
@@ -9,26 +9,10 @@ import { getUserHasAccessToSitePublic } from "../../../lib/auth-utils.js";
import { PerformanceOverviewMetrics } from "../types.js";
import { FilterParams } from "@rybbit/shared";
-const getQuery = ({
- startDate,
- endDate,
- timeZone,
- filters,
- pastMinutesRange,
-}: {
- startDate: string;
- endDate: string;
- timeZone: string;
- filters: string;
- pastMinutesRange?: { start: number; end: number };
-}) => {
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } };
+const getQuery = (params: FilterParams) => {
+ const filterStatement = getFilterStatement(params.filters);
- const filterStatement = getFilterStatement(filters);
-
- return `SELECT
+ return `SELECT
quantile(0.5)(lcp) AS lcp_p50,
quantile(0.75)(lcp) AS lcp_p75,
quantile(0.9)(lcp) AS lcp_p90,
@@ -51,11 +35,11 @@ const getQuery = ({
quantile(0.99)(ttfb) AS ttfb_p99,
COUNT(*) AS total_performance_events
FROM events
- WHERE
+ WHERE
site_id = {siteId:Int32}
AND type = 'performance'
${filterStatement}
- ${getTimeStatement(timeParams)}`;
+ ${getTimeStatement(params)}`;
};
export interface PerformanceOverviewRequest {
@@ -69,32 +53,13 @@ export async function getPerformanceOverview(
req: FastifyRequest<PerformanceOverviewRequest>,
res: FastifyReply
) {
- const {
- startDate,
- endDate,
- timeZone,
- filters,
- pastMinutesStart,
- pastMinutesEnd,
- } = req.query;
const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSitePublic(req, site);
if (!userHasAccessToSite) {
return res.status(403).send({ error: "Forbidden" });
}
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const query = getQuery({
- startDate,
- endDate,
- timeZone,
- filters,
- pastMinutesRange: pastMinutesRange,
- });
+ const query = getQuery(req.query);
try {
const result = await clickhouse.query({
diff --git a/server/src/api/analytics/performance/getPerformanceTimeSeries.ts b/server/src/api/analytics/performance/getPerformanceTimeSeries.ts
index b3a926ae8..51937bd02 100644
--- a/server/src/api/analytics/performance/getPerformanceTimeSeries.ts
+++ b/server/src/api/analytics/performance/getPerformanceTimeSeries.ts
@@ -35,23 +35,16 @@ const bucketIntervalMap = {
year: "1 YEAR",
} as const;
-function getTimeStatementFill(
- {
- date,
- pastMinutesRange,
- }: {
- date?: { startDate: string; endDate: string; timeZone: string };
- pastMinutesRange?: { start: number; end: number };
- },
- bucket: TimeBucket
-) {
- const { params, bucket: validatedBucket } = validateTimeStatementFillParams(
- { date, pastMinutesRange },
- bucket
- );
-
- if (params.date) {
- const { startDate, endDate, timeZone } = params.date;
+function getTimeStatementFill(params: FilterParams, bucket: TimeBucket) {
+ const { params: validatedParams, bucket: validatedBucket } =
+ validateTimeStatementFillParams(params, bucket);
+
+ if (
+ validatedParams.startDate &&
+ validatedParams.endDate &&
+ validatedParams.timeZone
+ ) {
+ const { startDate, endDate, timeZone } = validatedParams;
return `WITH FILL FROM toTimeZone(
toDateTime(${
TimeBucketToFn[validatedBucket]
@@ -76,8 +69,11 @@ function getTimeStatementFill(
) STEP INTERVAL ${bucketIntervalMap[validatedBucket]}`;
}
// For specific past minutes range - convert to exact timestamps for better performance
- if (params.pastMinutesRange) {
- const { start, end } = params.pastMinutesRange;
+ if (
+ validatedParams.pastMinutesStart !== undefined &&
+ validatedParams.pastMinutesEnd !== undefined
+ ) {
+ const { pastMinutesStart: start, pastMinutesEnd: end } = validatedParams;
// Calculate exact timestamps in JavaScript to avoid runtime ClickHouse calculations
const now = new Date();
@@ -115,28 +111,20 @@ function getTimeStatementFill(
return "";
}
-const getQuery = ({
- startDate,
- endDate,
- timeZone,
- bucket,
- filters,
- pastMinutesRange,
-}: {
- startDate: string;
- endDate: string;
- timeZone: string;
- bucket: TimeBucket;
- filters: string;
- pastMinutesRange?: { start: number; end: number };
-}) => {
+const getQuery = (params: FilterParams<{ bucket: TimeBucket }>) => {
+ const {
+ startDate,
+ endDate,
+ timeZone,
+ bucket,
+ filters,
+ pastMinutesStart,
+ pastMinutesEnd,
+ } = params;
const filterStatement = getFilterStatement(filters);
- const isAllTime = !startDate && !endDate && !pastMinutesRange;
-
- const timeParams = pastMinutesRange
- ? { pastMinutesRange }
- : { date: { startDate, endDate, timeZone } };
+ const isAllTime =
+ !startDate && !endDate && !pastMinutesStart && !pastMinutesEnd;
const query = `
SELECT
@@ -169,13 +157,11 @@ WHERE
site_id = {siteId:Int32}
AND type = 'performance'
${filterStatement}
- ${getTimeStatement(timeParams)}
+ ${getTimeStatement(params)}
GROUP BY time ORDER BY time ${
- isAllTime ? "" : getTimeStatementFill(timeParams, bucket)
+ isAllTime ? "" : getTimeStatementFill(params, bucket)
}`;
- console.log(query);
-
return query;
};
@@ -190,15 +176,6 @@ export async function getPerformanceTimeSeries(
}>,
res: FastifyReply
) {
- const {
- startDate,
- endDate,
- timeZone,
- bucket,
- filters,
- pastMinutesStart,
- pastMinutesEnd,
- } = req.query;
const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSitePublic(req, site);
@@ -206,20 +183,7 @@ export async function getPerformanceTimeSeries(
return res.status(403).send({ error: "Forbidden" });
}
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const query = getQuery({
- startDate,
- endDate,
- timeZone,
- bucket,
- filters,
- pastMinutesRange,
- });
+ const query = getQuery(req.query);
try {
const result = await clickhouse.query({
diff --git a/server/src/api/analytics/query-validation.ts b/server/src/api/analytics/query-validation.ts
index c70c06909..c2394f01c 100644
--- a/server/src/api/analytics/query-validation.ts
+++ b/server/src/api/analytics/query-validation.ts
@@ -1,5 +1,5 @@
+import { FilterParams } from "@rybbit/shared";
import { z } from "zod";
-import { Filter, FilterParameter, FilterType } from "./types.js";
// =============================================================================
// TIME RELATED SCHEMAS
@@ -116,26 +116,91 @@ const timeStatementParamsSchema = z
});
/**
- * Schema for parameters to getTimeStatementFill() function
- * Either date or pastMinutesRange must be provided
+ * Schema for FilterParams used in getTimeStatementFill() function
*/
-const timeStatementFillParamsSchema = z
+const filterParamsTimeStatementFillSchema = z
.object({
- date: fillDateParamsSchema.optional(),
- pastMinutesRange: z
- .object({
- start: z.number().nonnegative(),
- end: z.number().nonnegative(),
+ startDate: z
+ .string()
+ .regex(dateRegex, { message: "Invalid date format. Use YYYY-MM-DD" })
+ .optional()
+ .refine((date) => !date || !isNaN(Date.parse(date)), {
+ message: "Invalid date value",
+ }),
+ endDate: z
+ .string()
+ .regex(dateRegex, { message: "Invalid date format. Use YYYY-MM-DD" })
+ .optional()
+ .refine((date) => !date || !isNaN(Date.parse(date)), {
+ message: "Invalid date value",
+ }),
+ timeZone: z
+ .string()
+ .min(1, { message: "Time zone cannot be empty" })
+ .optional()
+ .refine(
+ (tz) => {
+ if (!tz) return true;
+ try {
+ // Test if time zone is valid by attempting to format a date with it
+ Intl.DateTimeFormat(undefined, { timeZone: tz });
+ return true;
+ } catch (e) {
+ return false;
+ }
+ },
+ { message: "Invalid time zone" }
+ ),
+ pastMinutesStart: z
+ .union([z.string(), z.number()])
+ .optional()
+ .transform((val) => {
+ if (val === undefined) return undefined;
+ const num = typeof val === "string" ? Number(val) : val;
+ return isNaN(num) ? undefined : num;
})
+ .refine((val) => val === undefined || val >= 0, {
+ message: "pastMinutesStart must be non-negative",
+ }),
+ pastMinutesEnd: z
+ .union([z.string(), z.number()])
.optional()
- .refine((data) => !data || data.start > data.end, {
- message: "start must be greater than end (start = older, end = newer)",
+ .transform((val) => {
+ if (val === undefined) return undefined;
+ const num = typeof val === "string" ? Number(val) : val;
+ return isNaN(num) ? undefined : num;
+ })
+ .refine((val) => val === undefined || val >= 0, {
+ message: "pastMinutesEnd must be non-negative",
}),
+ filters: z.string().optional(),
})
.refine(
- (data) => data.date !== undefined || data.pastMinutesRange !== undefined,
+ (data) => {
+ const hasDateParams = data.startDate && data.endDate && data.timeZone;
+ const hasPastMinutesParams =
+ data.pastMinutesStart !== undefined &&
+ data.pastMinutesEnd !== undefined;
+ return hasDateParams || hasPastMinutesParams;
+ },
{
- message: "Either date or pastMinutesRange must be provided",
+ message:
+ "Either (startDate, endDate, timeZone) or (pastMinutesStart, pastMinutesEnd) must be provided",
+ }
+ )
+ .refine(
+ (data) => {
+ if (
+ data.pastMinutesStart !== undefined &&
+ data.pastMinutesEnd !== undefined
+ ) {
+ return data.pastMinutesStart > data.pastMinutesEnd;
+ }
+ return true;
+ },
+ {
+ message:
+ "pastMinutesStart must be greater than pastMinutesEnd (start = older, end = newer)",
}
);
@@ -225,17 +290,17 @@ export function validateTimeStatementParams(params: unknown) {
}
/**
- * Validates and sanitizes parameters for getTimeStatementFill()
- * @param params Raw time parameters
+ * Validates and sanitizes FilterParams for getTimeStatementFill()
+ * @param params FilterParams object
* @param bucket Raw bucket parameter
* @returns Validated parameters and bucket
*/
export function validateTimeStatementFillParams(
- params: unknown,
+ params: FilterParams,
bucket: unknown
) {
- const validatedParams = timeStatementFillParamsSchema.parse(params);
const validatedBucket = timeBucketSchema.parse(bucket);
+ const validatedParams = filterParamsTimeStatementFillSchema.parse(params);
return {
params: validatedParams,
diff --git a/server/src/api/analytics/utils.ts b/server/src/api/analytics/utils.ts
index a335fec84..4f04170b9 100644
--- a/server/src/api/analytics/utils.ts
+++ b/server/src/api/analytics/utils.ts
@@ -1,24 +1,33 @@
import { ResultSet } from "@clickhouse/client";
-import { Filter, FilterParameter, FilterType } from "./types.js";
+import { FilterParams } from "@rybbit/shared";
+import SqlString from "sqlstring";
import {
- validateTimeStatementParams,
- validateFilters,
filterParamSchema,
+ validateFilters,
+ validateTimeStatementParams,
} from "./query-validation.js";
-import SqlString from "sqlstring";
+import { FilterParameter, FilterType } from "./types.js";
+
+export function getTimeStatement(
+ params: Pick<
+ FilterParams,
+ "startDate" | "endDate" | "timeZone" | "pastMinutesStart" | "pastMinutesEnd"
+ >
+) {
+ const { startDate, endDate, timeZone, pastMinutesStart, pastMinutesEnd } =
+ params;
+
+ // Construct the legacy format for validation
+ const pastMinutesRange =
+ pastMinutesStart !== undefined && pastMinutesEnd !== undefined
+ ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
+ : undefined;
+
+ const date =
+ startDate && endDate && timeZone
+ ? { startDate, endDate, timeZone }
+ : undefined;
-export function getTimeStatement({
- date,
- pastMinutesRange,
-}: {
- date?: {
- startDate?: string;
- endDate?: string;
- timeZone?: string;
- table?: "events" | "sessions";
- };
- pastMinutesRange?: { start: number; end: number };
-}) {
// Sanitize inputs with Zod
const sanitized = validateTimeStatementParams({
date,