Skip to content

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

Refactor analytics event handling to standardize event naming and structure

Bill Yang932691034a9d
diff --git a/client/src/api/analytics/userSessions.ts b/client/src/api/analytics/userSessions.ts
index f25c2fd8d..1eff4efeb 100644
--- a/client/src/api/analytics/userSessions.ts
+++ b/client/src/api/analytics/userSessions.ts
@@ -150,7 +150,7 @@ export interface SessionDetails {
exit_page: string;
}
-export interface PageviewEvent {
+export interface SessionEvent {
timestamp: string;
pathname: string;
hostname: string;
@@ -159,12 +159,12 @@ export interface PageviewEvent {
referrer: string;
type: string;
event_name?: string;
- properties?: string;
+ props?: string;
}
export interface SessionPageviewsAndEvents {
session: SessionDetails;
- pageviews: PageviewEvent[];
+ events: SessionEvent[];
pagination: {
total: number;
limit: number;
diff --git a/client/src/components/Sessions/SessionDetails.tsx b/client/src/components/Sessions/SessionDetails.tsx
index b4ad389d7..b8538361e 100644
--- a/client/src/components/Sessions/SessionDetails.tsx
+++ b/client/src/components/Sessions/SessionDetails.tsx
@@ -12,7 +12,7 @@ import {
Monitor,
MousePointerClick,
Smartphone,
- Tablet
+ Tablet,
} from "lucide-react";
import { DateTime } from "luxon";
import Link from "next/link";
@@ -20,7 +20,7 @@ import { useParams } from "next/navigation";
import { memo, useMemo } from "react";
import {
GetSessionsResponse,
- PageviewEvent,
+ SessionEvent,
useGetSessionDetailsInfinite,
} from "../../api/analytics/userSessions";
import { Browser } from "../../app/[site]/components/shared/icons/Browser";
@@ -36,7 +36,7 @@ function PageviewItem({
isLast = false,
nextTimestamp,
}: {
- item: PageviewEvent;
+ item: SessionEvent;
index: number;
isLast?: boolean;
nextTimestamp?: string; // Timestamp of the next event for duration calculation
@@ -45,6 +45,8 @@ function PageviewItem({
const timestamp = DateTime.fromSQL(item.timestamp, { zone: "utc" }).toLocal();
const formattedTime = timestamp.toFormat("h:mm:ss a");
+ console.info(item);
+
// Calculate duration if this is a pageview and we have the next timestamp
let duration = null;
if (!isEvent && nextTimestamp) {
@@ -72,7 +74,12 @@ function PageviewItem({
)}
{/* Connecting line */}
<div
- className={cn("flex items-center justify-center w-8 h-8 rounded-full border", isEvent ? "bg-amber-900/30 border-amber-500/50" : "bg-blue-900/30 border-blue-500/50")}
+ className={cn(
+ "flex items-center justify-center w-8 h-8 rounded-full border",
+ isEvent
+ ? "bg-amber-900/30 border-amber-500/50"
+ : "bg-blue-900/30 border-blue-500/50"
+ )}
>
<span className="text-sm font-medium">{index + 1}</span>
</div>
@@ -128,23 +135,20 @@ function PageviewItem({
{isEvent && (
<div className="flex items-center pl-7 mt-1">
<div className="text-xs text-gray-400">
- {item.properties &&
- Object.keys(JSON.parse(item.properties)).length > 0 ? (
+ {item.props && Object.keys(item.props).length > 0 ? (
<span className="flex flex-wrap gap-2 mt-1">
- {Object.entries(JSON.parse(item.properties)).map(
- ([key, value]) => (
- <Badge
- key={key}
- variant="outline"
- className="px-1.5 py-0 h-5 text-xs bg-neutral-800 text-gray-100 font-medium"
- >
- <span className="text-gray-300 font-light mr-1">
- {key}:
- </span>{" "}
- {String(value)}
- </Badge>
- )
- )}
+ {Object.entries(item.props).map(([key, value]) => (
+ <Badge
+ key={key}
+ variant="outline"
+ className="px-1.5 py-0 h-5 text-xs bg-neutral-800 text-gray-100 font-medium"
+ >
+ <span className="text-gray-300 font-light mr-1">
+ {key}:
+ </span>{" "}
+ {String(value)}
+ </Badge>
+ ))}
</span>
) : null}
</div>
@@ -204,7 +208,10 @@ const SessionDetailsTimelineSkeleton = memo(
<div className="mt-1 pl-7">
{Math.random() > 0.5 && (
<Skeleton
- className={cn("h-3", Math.random() > 0.7 ? "w-48" : "w-32")}
+ className={cn(
+ "h-3",
+ Math.random() > 0.7 ? "w-48" : "w-32"
+ )}
/>
)}
</div>
@@ -233,12 +240,10 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
} = useGetSessionDetailsInfinite(session.session_id);
const { site } = useParams();
- // Flatten all pageview pages into a single array
- const allPageviews = useMemo(() => {
+ // Flatten all events into a single array
+ const allEvents = useMemo(() => {
if (!sessionDetailsData?.pages) return [];
- return sessionDetailsData.pages.flatMap(
- (page) => page.data?.pageviews || []
- );
+ return sessionDetailsData.pages.flatMap((page) => page.data?.events || []);
}, [sessionDetailsData?.pages]);
// Get session details from the first page
@@ -246,14 +251,12 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
// Calculate total pageviews and events
const totalPageviews = useMemo(() => {
- return allPageviews.filter((p: PageviewEvent) => p.type === "pageview")
- .length;
- }, [allPageviews]);
+ return allEvents.filter((p: SessionEvent) => p.type === "pageview").length;
+ }, [allEvents]);
const totalEvents = useMemo(() => {
- return allPageviews.filter((p: PageviewEvent) => p.type !== "pageview")
- .length;
- }, [allPageviews]);
+ return allEvents.filter((p: SessionEvent) => p.type !== "pageview").length;
+ }, [allEvents]);
return (
<div className="px-4 bg-neutral-900 border-t border-neutral-800">
@@ -294,7 +297,7 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
<span>
Pageviews: {totalPageviews}
{sessionDetailsData.pages[0]?.data?.pagination?.total >
- allPageviews.length &&
+ allEvents.length &&
` of ${sessionDetailsData.pages[0]?.data?.pagination?.total}`}
</span>
</Badge>
@@ -307,12 +310,12 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
</Badge>
</div>
<div className="px-1 pt-2 pb-1">
- {allPageviews.map((pageview: PageviewEvent, index: number) => {
+ {allEvents.map((pageview: SessionEvent, index: number) => {
// Determine the next timestamp for duration calculation
// For the last item, use the session end time
let nextTimestamp;
- if (index < allPageviews.length - 1) {
- nextTimestamp = allPageviews[index + 1].timestamp;
+ if (index < allEvents.length - 1) {
+ nextTimestamp = allEvents[index + 1].timestamp;
} else if (sessionDetails) {
nextTimestamp = sessionDetails.session_end;
}
@@ -322,7 +325,7 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
key={`${pageview.timestamp}-${index}`}
item={pageview}
index={index}
- isLast={index === allPageviews.length - 1 && !hasNextPage}
+ isLast={index === allEvents.length - 1 && !hasNextPage}
nextTimestamp={nextTimestamp}
/>
);
@@ -350,7 +353,7 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
{sessionDetailsData.pages[0]?.data?.pagination?.total > 0 && (
<div className="text-center text-xs text-gray-500 mt-2">
- Showing {allPageviews.length} of{" "}
+ Showing {allEvents.length} of{" "}
{sessionDetailsData.pages[0]?.data?.pagination?.total}{" "}
events
</div>
diff --git a/server/src/api/analytics/getSession.ts b/server/src/api/analytics/getSession.ts
index 106144546..7d7bc5edc 100644
--- a/server/src/api/analytics/getSession.ts
+++ b/server/src/api/analytics/getSession.ts
@@ -26,7 +26,7 @@ export interface SessionDetails {
exit_page: string;
}
-export interface PageviewEvent {
+export interface Event {
timestamp: string;
pathname: string;
hostname: string;
@@ -40,7 +40,7 @@ export interface PageviewEvent {
export interface SessionPageviewsAndEvents {
session: SessionDetails;
- pageviews: PageviewEvent[];
+ events: Event[];
pagination: {
total: number;
limit: number;
@@ -128,7 +128,7 @@ WHERE
`;
// 3. Query to get paginated pageviews
- const pageviewsQuery = `
+ const eventsQuery = `
SELECT
timestamp,
pathname,
@@ -150,7 +150,7 @@ OFFSET {offset:Int32}
`;
// Execute queries in parallel
- const [sessionResultSettled, countResultSettled, pageviewsResultSettled] =
+ const [sessionResultSettled, countResultSettled, eventsResultSettled] =
await Promise.allSettled([
clickhouse.query({
query: sessionQuery,
@@ -169,7 +169,7 @@ OFFSET {offset:Int32}
},
}),
clickhouse.query({
- query: pageviewsQuery,
+ query: eventsQuery,
format: "JSONEachRow",
query_params: {
siteId: Number(site),
@@ -187,17 +187,17 @@ OFFSET {offset:Int32}
if (countResultSettled.status === "rejected") {
throw countResultSettled.reason;
}
- if (pageviewsResultSettled.status === "rejected") {
- throw pageviewsResultSettled.reason;
+ if (eventsResultSettled.status === "rejected") {
+ throw eventsResultSettled.reason;
}
const sessionResult = sessionResultSettled.value;
const countResult = countResultSettled.value;
- const pageviewsResult = pageviewsResultSettled.value;
+ const eventsResult = eventsResultSettled.value;
const sessionData = await processResults<SessionDetails>(sessionResult);
const countData = await processResults<{ total: number }>(countResult);
- const pageviewsData = await processResults<PageviewEvent>(pageviewsResult);
+ const eventsData = await processResults<Event>(eventsResult);
if (!sessionData || sessionData.length === 0) {
return res.status(404).send({ error: "Session not found" });
@@ -206,12 +206,12 @@ OFFSET {offset:Int32}
// Combine results
const response: SessionPageviewsAndEvents = {
session: sessionData[0],
- pageviews: pageviewsData,
+ events: eventsData,
pagination: {
total: countData[0].total,
limit,
offset,
- hasMore: offset + pageviewsData.length < countData[0].total,
+ hasMore: offset + eventsData.length < countData[0].total,
},
};