Skip to content

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

Refactor analytics components to integrate filter functionality

Bill Yang0b6d40f5278c
diff --git a/client/src/api/analytics/userSessions.ts b/client/src/api/analytics/userSessions.ts
index 519a2a901..f59baa793 100644
--- a/client/src/api/analytics/userSessions.ts
+++ b/client/src/api/analytics/userSessions.ts
@@ -1,6 +1,10 @@
import { useQuery, useInfiniteQuery } from "@tanstack/react-query";
import { BACKEND_URL } from "../../lib/const";
-import { useStore } from "../../lib/store";
+import {
+ getFilteredFilters,
+ SESSION_PAGE_FILTERS,
+ useStore,
+} from "../../lib/store";
import { APIResponse } from "../types";
import { getStartAndEndDate, authedFetch } from "../utils";
@@ -46,12 +50,14 @@ export type GetSessionsResponse = {
session_id: string;
user_id: string;
country: string;
+ city: string;
iso_3166_2: string;
language: string;
device_type: string;
browser: string;
operating_system: string;
referrer: string;
+ channel: string;
session_end: string;
session_start: string;
session_duration: number;
@@ -65,8 +71,10 @@ export function useGetSessionsInfinite(userId?: string) {
const { time, site, filters } = useStore();
const { startDate, endDate } = getStartAndEndDate(time);
+ const filteredFilters = getFilteredFilters(SESSION_PAGE_FILTERS);
+
return useInfiniteQuery<APIResponse<GetSessionsResponse>>({
- queryKey: ["sessions-infinite", time, site, filters, userId],
+ queryKey: ["sessions-infinite", time, site, filteredFilters, userId],
queryFn: ({ pageParam = 1 }) => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
return authedFetch(`${BACKEND_URL}/sessions`, {
@@ -74,7 +82,7 @@ export function useGetSessionsInfinite(userId?: string) {
endDate: userId ? undefined : endDate,
timezone,
site,
- filters,
+ filters: filteredFilters,
page: pageParam,
userId,
}).then((res) => res.json());
diff --git a/client/src/api/analytics/users.ts b/client/src/api/analytics/users.ts
index 92f6ce9a3..3309ff15e 100644
--- a/client/src/api/analytics/users.ts
+++ b/client/src/api/analytics/users.ts
@@ -1,12 +1,20 @@
import { useQuery } from "@tanstack/react-query";
import { BACKEND_URL } from "../../lib/const";
-import { useStore, Filter } from "../../lib/store";
+import {
+ useStore,
+ Filter,
+ USER_PAGE_FILTERS,
+ getFilteredFilters,
+} from "../../lib/store";
import { getStartAndEndDate, authedFetch } from "../utils";
import { APIResponse } from "../types";
export type UsersResponse = {
user_id: string;
country: string;
+ iso_3166_2: string;
+ city: string;
+ language: string;
browser: string;
operating_system: string;
device_type: string;
@@ -26,10 +34,11 @@ export interface GetUsersOptions {
}
export function useGetUsers(options: GetUsersOptions) {
- const { time, site, filters: storeFilters } = useStore();
+ const { time, site } = useStore();
const { startDate, endDate } = getStartAndEndDate(time);
const { page, pageSize, sortBy, sortOrder } = options;
+ const filteredFilters = getFilteredFilters(USER_PAGE_FILTERS);
return useQuery<
APIResponse<UsersResponse[]> & {
@@ -46,7 +55,7 @@ export function useGetUsers(options: GetUsersOptions) {
pageSize,
sortBy,
sortOrder,
- storeFilters,
+ filteredFilters,
],
queryFn: async () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
@@ -56,7 +65,7 @@ export function useGetUsers(options: GetUsersOptions) {
endDate,
timezone,
site,
- filters: storeFilters,
+ filters: filteredFilters,
page,
pageSize,
sortBy,
diff --git a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
index f3343809b..f3236c268 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
@@ -1,70 +1,100 @@
import { X } from "lucide-react";
+import { useGetRegionName } from "../../../../../lib/geo";
import {
- Filter,
FilterParameter,
FilterType,
removeFilter,
updateFilter,
useStore,
} from "../../../../../lib/store";
-import { getCountryName } from "../../../../../lib/utils";
-import { NewFilterButton } from "./NewFilterButton";
-import { useGetRegionName } from "../../../../../lib/geo";
import {
filterTypeToLabel,
getParameterNameLabel,
getParameterValueLabel,
} from "../../shared/Filters/utils";
+import { NewFilterButton } from "./NewFilterButton";
+import {
+ Tooltip,
+ TooltipContent,
+ TooltipTrigger,
+} from "../../../../../components/ui/tooltip";
-export function Filters() {
+export function Filters({
+ availableFilters,
+}: {
+ availableFilters?: FilterParameter[];
+}) {
const { filters } = useStore();
const { getRegionName } = useGetRegionName();
return (
<div className="flex gap-2">
<NewFilterButton />
- {filters?.map((filter, i) => (
- <div
- key={filter.parameter}
- className="px-2 py-1 rounded-md bg-neutral-850 text-neutral-400 flex items-center gap-1 text-sm"
- >
- <div className="text-neutral-300">
- {getParameterNameLabel(filter.parameter)}
- </div>
- <div
- className={`text-emerald-400 font-medium cursor-pointer ${
- filter.type === "not_equals" || filter.type === "not_contains"
- ? "text-red-400"
- : ""
- }`}
- onClick={() => {
- let newType: FilterType = "equals";
- if (filter.type === "equals") {
- newType = "not_equals";
- } else if (filter.type === "not_equals") {
- newType = "contains";
- } else if (filter.type === "contains") {
- newType = "not_contains";
- } else if (filter.type === "not_contains") {
- newType = "equals";
- }
+ {filters.map((filter, i) => {
+ const disabled =
+ availableFilters && !availableFilters.includes(filter.parameter);
+
+ return (
+ <Tooltip key={filter.parameter}>
+ {disabled && (
+ <TooltipContent>
+ <p>Filter not active for this page</p>
+ </TooltipContent>
+ )}
+ <TooltipTrigger>
+ <div
+ key={filter.parameter}
+ className={`px-2 py-1 rounded-lg ${
+ disabled ? "bg-neutral-900" : "bg-neutral-850"
+ } text-neutral-400 flex items-center gap-1 text-sm`}
+ >
+ <div
+ className={disabled ? "text-neutral-500" : "text-neutral-300"}
+ >
+ {getParameterNameLabel(filter.parameter)}
+ </div>
+ <div
+ className={`text-emerald-400 font-medium cursor-pointer whitespace-nowrap ${
+ filter.type === "not_equals" ||
+ filter.type === "not_contains"
+ ? "text-red-400"
+ : ""
+ }`}
+ onClick={() => {
+ let newType: FilterType = "equals";
+ if (filter.type === "equals") {
+ newType = "not_equals";
+ } else if (filter.type === "not_equals") {
+ newType = "contains";
+ } else if (filter.type === "contains") {
+ newType = "not_contains";
+ } else if (filter.type === "not_contains") {
+ newType = "equals";
+ }
- updateFilter({ ...filter, type: newType }, i);
- }}
- >
- {filterTypeToLabel(filter.type)}
- </div>
- <div className="text-neutral-100 font-medium">
- {getParameterValueLabel(filter, getRegionName)}
- </div>
- <div
- className="text-neutral-400 cursor-pointer hover:text-neutral-200"
- onClick={() => removeFilter(filter)}
- >
- <X size={16} strokeWidth={3} />
- </div>
- </div>
- ))}
+ updateFilter({ ...filter, type: newType }, i);
+ }}
+ >
+ {filterTypeToLabel(filter.type)}
+ </div>
+ <div
+ className={`text-neutral-100 font-medium whitespace-nowrap ${
+ disabled ? "text-neutral-500" : ""
+ }`}
+ >
+ {getParameterValueLabel(filter, getRegionName)}
+ </div>
+ <div
+ className="text-neutral-400 cursor-pointer hover:text-neutral-200"
+ onClick={() => removeFilter(filter)}
+ >
+ <X size={16} strokeWidth={3} />
+ </div>
+ </div>
+ </TooltipTrigger>
+ </Tooltip>
+ );
+ })}
</div>
);
}
diff --git a/client/src/app/[site]/components/SubHeader/SubHeader.tsx b/client/src/app/[site]/components/SubHeader/SubHeader.tsx
index e4cbf5506..2f4b0ea86 100644
--- a/client/src/app/[site]/components/SubHeader/SubHeader.tsx
+++ b/client/src/app/[site]/components/SubHeader/SubHeader.tsx
@@ -2,7 +2,7 @@
import { Filters } from "./Filters/Filters";
import { Button } from "@/components/ui/button";
-import { goBack, goForward, useStore } from "@/lib/store";
+import { FilterParameter, goBack, goForward, useStore } from "@/lib/store";
import { ChevronLeft, ChevronRight } from "lucide-react";
import { DateTime } from "luxon";
@@ -36,7 +36,11 @@ const canGoForward = (time: Time) => {
return false;
};
-export function SubHeader() {
+export function SubHeader({
+ availableFilters,
+}: {
+ availableFilters?: FilterParameter[];
+}) {
const { time, setTime } = useStore();
const { data: sites } = useGetSites();
const pathname = usePathname();
@@ -45,7 +49,7 @@ export function SubHeader() {
return (
<div className="flex gap-2 mb-3 mt-1 justify-between">
- <Filters />
+ <Filters availableFilters={availableFilters} />
<div className="flex items-center gap-2">
<DateSelector time={time} setTime={setTime} />
<div className="flex items-center">
diff --git a/client/src/app/[site]/layout.tsx b/client/src/app/[site]/layout.tsx
index de011d612..0c4bda64f 100644
--- a/client/src/app/[site]/layout.tsx
+++ b/client/src/app/[site]/layout.tsx
@@ -25,7 +25,7 @@ export default function SiteLayout({
useSyncStateWithUrl();
useEffect(() => {
- if (pathname.includes("/")) {
+ if (pathname.includes("/") && pathname.split("/")[1] !== site) {
setSite(pathname.split("/")[1]);
}
}, [pathname]);
diff --git a/client/src/app/[site]/sessions/page.tsx b/client/src/app/[site]/sessions/page.tsx
index 79e5c847c..a1f052227 100644
--- a/client/src/app/[site]/sessions/page.tsx
+++ b/client/src/app/[site]/sessions/page.tsx
@@ -1,12 +1,13 @@
"use client";
+import { SESSION_PAGE_FILTERS } from "../../../lib/store";
import { SubHeader } from "../components/SubHeader/SubHeader";
import SessionsList from "@/components/Sessions/SessionsList";
export default function SessionsPage() {
return (
<div>
- <SubHeader />
+ <SubHeader availableFilters={SESSION_PAGE_FILTERS} />
<SessionsList />
</div>
);
diff --git a/client/src/app/[site]/users/page.tsx b/client/src/app/[site]/users/page.tsx
index e6af8cffe..0b513d952 100644
--- a/client/src/app/[site]/users/page.tsx
+++ b/client/src/app/[site]/users/page.tsx
@@ -37,6 +37,7 @@ import {
TooltipTrigger,
} from "../../../components/ui/tooltip";
import { SubHeader } from "../components/SubHeader/SubHeader";
+import { USER_PAGE_FILTERS } from "../../../lib/store";
// Set up column helper
const columnHelper = createColumnHelper<UsersResponse>();
@@ -269,7 +270,7 @@ export default function UsersPage() {
return (
<div className="space-y-4">
- <SubHeader />
+ <SubHeader availableFilters={USER_PAGE_FILTERS} />
{/* <div className="flex items-center justify-between">
<h1 className="text-2xl font-bold flex items-center gap-2">
<Users className="w-6 h-6" />
diff --git a/client/src/lib/store.ts b/client/src/lib/store.ts
index 8d38fa78a..37a728c0f 100644
--- a/client/src/lib/store.ts
+++ b/client/src/lib/store.ts
@@ -43,6 +43,34 @@ export type FilterParameter =
| "exit_page"
| "dimensions";
+export const SESSION_PAGE_FILTERS: FilterParameter[] = [
+ "browser",
+ "operating_system",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "iso_3166_2",
+ "event_name",
+ "channel",
+ "entry_page",
+ "exit_page",
+];
+
+export const USER_PAGE_FILTERS: FilterParameter[] = [
+ "browser",
+ "operating_system",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "iso_3166_2",
+];
+
export type Filter = {
parameter: FilterParameter;
value: string[];
@@ -315,3 +343,8 @@ export const updateFilter = (filter: Filter, index: number) => {
const { filters, setFilters } = useStore.getState();
setFilters(filters.map((f, i) => (i === index ? filter : f)));
};
+
+export const getFilteredFilters = (parameters: FilterParameter[]) => {
+ const { filters } = useStore.getState();
+ return filters.filter((f) => parameters.includes(f.parameter));
+};
diff --git a/client/src/lib/urlParams.ts b/client/src/lib/urlParams.ts
index 6d258f85e..0a1f683b9 100644
--- a/client/src/lib/urlParams.ts
+++ b/client/src/lib/urlParams.ts
@@ -172,7 +172,7 @@ export const useSyncStateWithUrl = () => {
if (!pathname) return false;
const pathParts = pathname.split("/");
if (pathParts.length < 3) return false;
- return ["main", "sessions"].includes(pathParts[2]);
+ return ["main", "sessions", "users"].includes(pathParts[2]);
};
// Initialize from URL params after site is set
diff --git a/server/src/api/analytics/getSessions.ts b/server/src/api/analytics/getSessions.ts
index 157c66412..e5da5b666 100644
--- a/server/src/api/analytics/getSessions.ts
+++ b/server/src/api/analytics/getSessions.ts
@@ -12,11 +12,13 @@ export type GetSessionsResponse = {
user_id: string;
country: string;
iso_3166_2: string;
+ city: string;
language: string;
device_type: string;
browser: string;
operating_system: string;
referrer: string;
+ channel: string;
session_end: string;
session_start: string;
session_duration: number;
@@ -50,38 +52,47 @@ export async function getSessions(
}
const filterStatement = getFilterStatement(filters);
+ const timeStatement = getTimeStatement({
+ date: { startDate, endDate, timezone },
+ });
const query = `
-SELECT
- session_id,
- user_id,
- argMax(country, timestamp) AS country,
- argMax(iso_3166_2, timestamp) AS iso_3166_2,
- argMax(language, timestamp) AS language,
- argMax(device_type, timestamp) AS device_type,
- argMax(browser, timestamp) AS browser,
- argMax(operating_system, timestamp) AS operating_system,
- argMin(referrer, timestamp) AS referrer,
- MAX(timestamp) AS session_end,
- MIN(timestamp) AS session_start,
- dateDiff('second', MIN(timestamp), MAX(timestamp)) AS session_duration,
- argMinIf(pathname, timestamp, type = 'pageview') AS entry_page,
- argMaxIf(pathname, timestamp, type = 'pageview') AS exit_page,
- countIf(type = 'pageview') AS pageviews,
- countIf(type = 'custom_event') AS events
-FROM pageviews
-WHERE
- site_id = ${site}
- ${userId ? ` AND user_id = '${userId}'` : ""}
- ${filterStatement}
- ${getTimeStatement({
- date: { startDate, endDate, timezone },
- })}
-GROUP BY
- session_id,
- user_id
-ORDER BY session_end DESC
-LIMIT 100 OFFSET ${(page - 1) * 100}
+ WITH AggregatedSessions AS (
+ SELECT
+ session_id,
+ user_id,
+ argMax(country, timestamp) AS country,
+ argMax(iso_3166_2, timestamp) AS iso_3166_2,
+ argMax(city, timestamp) AS city,
+ argMax(language, timestamp) AS language,
+ argMax(device_type, timestamp) AS device_type,
+ argMax(browser, timestamp) AS browser,
+ argMax(operating_system, timestamp) AS operating_system,
+ argMax(screen_width, timestamp) AS screen_width,
+ argMax(screen_height, timestamp) AS screen_height,
+ argMin(referrer, timestamp) AS referrer,
+ argMin(channel, timestamp) AS channel,
+ MAX(timestamp) AS session_end,
+ MIN(timestamp) AS session_start,
+ dateDiff('second', MIN(timestamp), MAX(timestamp)) AS session_duration,
+ argMinIf(pathname, timestamp, type = 'pageview') AS entry_page,
+ argMaxIf(pathname, timestamp, type = 'pageview') AS exit_page,
+ countIf(type = 'pageview') AS pageviews,
+ countIf(type = 'custom_event') AS events
+ FROM pageviews
+ WHERE
+ site_id = ${site}
+ ${userId ? ` AND user_id = '${userId}'` : ""}
+ ${timeStatement}
+ GROUP BY
+ session_id,
+ user_id
+ )
+ SELECT *
+ FROM AggregatedSessions
+ WHERE 1 = 1 ${filterStatement}
+ ORDER BY session_end DESC
+ LIMIT 100 OFFSET ${(page - 1) * 100}
`;
try {
@@ -93,7 +104,8 @@ LIMIT 100 OFFSET ${(page - 1) * 100}
const data = await processResults<GetSessionsResponse[number]>(result);
return res.send({ data });
} catch (error) {
- console.error("Error fetching devices:", error);
- return res.status(500).send({ error: "Failed to fetch devices" });
+ console.error("Generated Query:", query);
+ console.error("Error fetching sessions:", error);
+ return res.status(500).send({ error: "Failed to fetch sessions" });
}
}
diff --git a/server/src/api/analytics/getUsers.ts b/server/src/api/analytics/getUsers.ts
index f106e9575..b4f5ccde7 100644
--- a/server/src/api/analytics/getUsers.ts
+++ b/server/src/api/analytics/getUsers.ts
@@ -10,6 +10,9 @@ import { getUserHasAccessToSite } from "../../lib/auth-utils.js";
export type GetUsersResponse = {
user_id: string;
country: string;
+ iso_3166_2: string;
+ city: string;
+ language: string;
browser: string;
operating_system: string;
device_type: string;
@@ -70,30 +73,41 @@ export async function getUsers(
const actualSortBy = validSortFields.includes(sortBy) ? sortBy : "last_seen";
const actualSortOrder = sortOrder === "asc" ? "ASC" : "DESC";
+ // Generate filter statement and time statement
const filterStatement = getFilterStatement(filters);
+ const timeStatement = getTimeStatement({
+ date: { startDate, endDate, timezone },
+ });
- // Query to get user data with pagination
const query = `
-SELECT
- user_id,
- argMax(country, timestamp) AS country,
- argMax(browser, timestamp) AS browser,
- argMax(operating_system, timestamp) AS operating_system,
- argMax(device_type, timestamp) AS device_type,
- countIf(type = 'pageview') AS pageviews,
- countIf(type = 'custom_event') AS events,
- count(distinct session_id) AS sessions,
- max(timestamp) AS last_seen,
- min(timestamp) AS first_seen
-FROM pageviews
-WHERE
- site_id = ${site}
- ${filterStatement}
- ${getTimeStatement({
- date: { startDate, endDate, timezone },
- })}
-GROUP BY
- user_id
+WITH AggregatedUsers AS (
+ SELECT
+ user_id,
+ argMax(country, timestamp) AS country,
+ argMax(iso_3166_2, timestamp) AS iso_3166_2,
+ argMax(city, timestamp) AS city,
+ argMax(language, timestamp) AS language,
+ argMax(browser, timestamp) AS browser,
+ argMax(operating_system, timestamp) AS operating_system,
+ argMax(device_type, timestamp) AS device_type,
+ argMax(screen_width, timestamp) AS screen_width,
+ argMax(screen_height, timestamp) AS screen_height,
+ argMin(referrer, timestamp) AS referrer,
+ countIf(type = 'pageview') AS pageviews,
+ countIf(type = 'custom_event') AS events,
+ count(distinct session_id) AS sessions,
+ max(timestamp) AS last_seen,
+ min(timestamp) AS first_seen
+ FROM pageviews
+ WHERE
+ site_id = ${site}
+ ${timeStatement}
+ GROUP BY
+ user_id
+)
+SELECT *
+FROM AggregatedUsers
+WHERE 1 = 1 ${filterStatement}
ORDER BY ${actualSortBy} ${actualSortOrder}
LIMIT ${pageSizeNum} OFFSET ${offset}
`;