Skip to content

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

Refactor analytics hooks to consolidate `useGetOverviewBucketed` functionality, replacing separate past minutes hooks with a unified approach. Updated components to utilize the new structure, enhancing code clarity and reducing redundancy in data fetching logic. Introduced `getQueryParams` utility for improved query parameter handling across the application.

Bill Yanga6f718fdb8ee
diff --git a/client/src/api/analytics/useGetOverviewBucketed.ts b/client/src/api/analytics/useGetOverviewBucketed.ts
index bc7ef9d69..4fc611386 100644
--- a/client/src/api/analytics/useGetOverviewBucketed.ts
+++ b/client/src/api/analytics/useGetOverviewBucketed.ts
@@ -7,7 +7,7 @@ import {
import { timeZone } from "../../lib/dateTimeUtils";
import { useStore } from "../../lib/store";
import { APIResponse } from "../types";
-import { authedFetch, getStartAndEndDate } from "../utils";
+import { authedFetch, getQueryParams } from "../utils";
type PeriodTime = "current" | "previous";
@@ -26,175 +26,68 @@ export function useGetOverviewBucketed({
site,
bucket = "hour",
dynamicFilters = [],
+ refetchInterval,
+ pastMinutesStart,
+ pastMinutesEnd,
props,
}: {
periodTime?: PeriodTime;
site: number | string;
bucket?: TimeBucket;
dynamicFilters?: Filter[];
+ refetchInterval?: number;
+ pastMinutesStart?: number;
+ pastMinutesEnd?: number;
props?: Partial<UseQueryOptions<APIResponse<GetOverviewBucketedResponse>>>;
}): UseQueryResult<APIResponse<GetOverviewBucketedResponse>> {
const { time, previousTime, filters: globalFilters } = useStore();
const timeToUse = periodTime === "previous" ? previousTime : time;
-
- const { startDate, endDate } = getStartAndEndDate(timeToUse);
-
const combinedFilters = [...globalFilters, ...dynamicFilters];
- return useQuery({
- queryKey: ["overview-bucketed", timeToUse, bucket, site, combinedFilters],
- queryFn: () => {
- return authedFetch<APIResponse<GetOverviewBucketedResponse>>(
- `/overview-bucketed/${site}`,
- {
- startDate,
- endDate,
- timeZone,
- bucket,
- filters: combinedFilters,
- }
- );
- },
- placeholderData: (_, query: any) => {
- if (!query?.queryKey) return undefined;
- const [, , , prevSite] = query.queryKey as [
- string,
- any,
- TimeBucket,
- string | number,
- Filter[]
- ];
-
- if (prevSite === site) {
- return query.state.data;
- }
- return undefined;
+ // Use getQueryParams utility to handle conditional logic
+ const queryParams = getQueryParams(
+ timeToUse,
+ {
+ timeZone,
+ bucket,
+ filters: combinedFilters,
},
- staleTime: Infinity,
- ...props,
- });
-}
-
-export function useGetOverviewBucketedPastMinutes({
- pastMinutesStart,
- pastMinutesEnd,
- site,
- bucket = "hour",
- refetchInterval,
- dynamicFilters = [],
- props,
-}: {
- pastMinutesStart: number;
- pastMinutesEnd: number;
- site: number | string;
- bucket?: TimeBucket;
- refetchInterval?: number;
- dynamicFilters?: Filter[];
- props?: Partial<UseQueryOptions<APIResponse<GetOverviewBucketedResponse>>>;
-}): UseQueryResult<APIResponse<GetOverviewBucketedResponse>> {
- const { filters: globalFilters } = useStore();
-
- const combinedFilters = [...globalFilters, ...dynamicFilters];
-
- return useQuery({
- queryKey: [
- "overview-bucketed-past-minutes-range",
+ {
pastMinutesStart,
pastMinutesEnd,
- site,
- bucket,
- combinedFilters,
- ],
- queryFn: () => {
- return authedFetch<APIResponse<GetOverviewBucketedResponse>>(
- `/overview-bucketed/${site}`,
- {
- timeZone,
- bucket,
+ }
+ );
+
+ // Generate appropriate query key based on whether we're using past minutes or regular time
+ const queryKey =
+ pastMinutesStart !== undefined && pastMinutesEnd !== undefined
+ ? [
+ "overview-bucketed-past-minutes",
pastMinutesStart,
pastMinutesEnd,
- filters: combinedFilters,
- }
- );
- },
- refetchInterval,
- placeholderData: (_, query: any) => {
- if (!query?.queryKey) return undefined;
- const [, , prevSite] = query.queryKey as [
- string,
- any,
- string | number,
- TimeBucket,
- Filter[]
- ];
- if (prevSite === site) {
- return query.state.data;
- }
- return undefined;
- },
- staleTime: Infinity,
- ...props,
- });
-}
-
-/**
- * Hook to get previous time period data for comparison with last-24-hours mode
- */
-export function useGetOverviewBucketedPreviousPastMinutes({
- pastMinutesStart,
- pastMinutesEnd,
- site,
- bucket = "hour",
- refetchInterval,
- dynamicFilters = [],
- props,
-}: {
- pastMinutesStart: number;
- pastMinutesEnd: number;
- site: number | string;
- bucket?: TimeBucket;
- refetchInterval?: number;
- dynamicFilters?: Filter[];
- props?: Partial<UseQueryOptions<APIResponse<GetOverviewBucketedResponse>>>;
-}): UseQueryResult<APIResponse<GetOverviewBucketedResponse>> {
- const { filters: globalFilters } = useStore();
-
- const combinedFilters = [...globalFilters, ...dynamicFilters];
+ site,
+ bucket,
+ combinedFilters,
+ ]
+ : ["overview-bucketed", timeToUse, bucket, site, combinedFilters];
return useQuery({
- queryKey: [
- "overview-bucketed-previous-past-minutes",
- pastMinutesStart,
- pastMinutesEnd,
- site,
- bucket,
- combinedFilters,
- ],
+ queryKey,
queryFn: () => {
return authedFetch<APIResponse<GetOverviewBucketedResponse>>(
`/overview-bucketed/${site}`,
- {
- timeZone,
- bucket,
- pastMinutesStart,
- pastMinutesEnd,
- filters: combinedFilters,
- }
+ queryParams
);
},
refetchInterval,
placeholderData: (_, query: any) => {
if (!query?.queryKey) return undefined;
- const [, , , prevSite] = query.queryKey as [
- string,
- number,
- number,
- string | number,
- TimeBucket,
- Filter[]
- ];
- if (prevSite === site) {
+ const queryKeyArray = query.queryKey as any[];
+
+ // Find site in query key (position varies based on query type)
+ const siteIndex = queryKeyArray.findIndex((item) => item === site);
+ if (siteIndex !== -1) {
return query.state.data;
}
return undefined;
diff --git a/client/src/api/analytics/useGetOverviewWithInView.ts b/client/src/api/analytics/useGetOverviewWithInView.ts
deleted file mode 100644
index 4852653e3..000000000
--- a/client/src/api/analytics/useGetOverviewWithInView.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-import { useGetOverview } from "./useGetOverview";
-import { useQuery } from "@tanstack/react-query";
-import { timeZone } from "../../lib/dateTimeUtils";
-import { authedFetch } from "../utils";
-
-/**
- * A hook that provides overview data with support for
- * conditional fetching based on viewport visibility
- */
-export function useGetOverviewWithInView({
- pastMinutes = 24 * 60,
- site,
- isInView = true,
-}: {
- pastMinutes?: number;
- site?: number | string;
- isInView?: boolean;
-}) {
- // Always call the useQuery hook, but conditionally enable the fetch
- return useQuery({
- queryKey: ["overview-past-minutes", pastMinutes, site],
- queryFn: () => {
- return authedFetch(`/overview/${site}`, {
- pastMinutes,
- timeZone,
- });
- },
- enabled: isInView, // Only fetch when in view
- staleTime: Infinity,
- placeholderData: (_, query: any) => {
- if (!query?.queryKey) return undefined;
- const prevQueryKey = query.queryKey as [string, string, string];
- const [, , prevSite] = prevQueryKey;
-
- if (prevSite === site) {
- return query.state.data;
- }
- return undefined;
- },
- });
-}
diff --git a/client/src/app/[site]/main/components/MainSection/MainSection.tsx b/client/src/app/[site]/main/components/MainSection/MainSection.tsx
index 412758cae..9231ae749 100644
--- a/client/src/app/[site]/main/components/MainSection/MainSection.tsx
+++ b/client/src/app/[site]/main/components/MainSection/MainSection.tsx
@@ -4,11 +4,7 @@ import { Tilt_Warp } from "next/font/google";
import Image from "next/image";
import Link from "next/link";
import { useGetOverview } from "../../../../../api/analytics/useGetOverview";
-import {
- useGetOverviewBucketed,
- useGetOverviewBucketedPastMinutes,
- useGetOverviewBucketedPreviousPastMinutes,
-} from "../../../../../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "../../../../../api/analytics/useGetOverviewBucketed";
import { authClient } from "../../../../../lib/auth";
import { useStore } from "../../../../../lib/store";
import { cn } from "../../../../../lib/utils";
@@ -70,7 +66,7 @@ export function MainSection() {
data: pastMinutesData,
isFetching: isPastMinutesFetching,
error: pastMinutesError,
- } = useGetOverviewBucketedPastMinutes({
+ } = useGetOverviewBucketed({
pastMinutesStart: 24 * 60,
pastMinutesEnd: 0,
site,
@@ -84,7 +80,7 @@ export function MainSection() {
data: pastMinutesPreviousData,
isFetching: isPastMinutesPreviousFetching,
error: pastMinutesPreviousError,
- } = useGetOverviewBucketedPreviousPastMinutes({
+ } = useGetOverviewBucketed({
pastMinutesStart: 48 * 60,
pastMinutesEnd: 24 * 60,
site,
diff --git a/client/src/app/[site]/main/components/MainSection/Overview.tsx b/client/src/app/[site]/main/components/MainSection/Overview.tsx
index 68d14f66c..d4fe2cd7f 100644
--- a/client/src/app/[site]/main/components/MainSection/Overview.tsx
+++ b/client/src/app/[site]/main/components/MainSection/Overview.tsx
@@ -6,10 +6,7 @@ import NumberFlow from "@number-flow/react";
import { TrendingDown, TrendingUp } from "lucide-react";
import { useState } from "react";
import { useGetOverview } from "../../../../../api/analytics/useGetOverview";
-import {
- useGetOverviewBucketed,
- useGetOverviewBucketedPastMinutes,
-} from "../../../../../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "../../../../../api/analytics/useGetOverviewBucketed";
import { StatType, useStore } from "../../../../../lib/store";
import { SparklinesChart } from "./SparklinesChart";
@@ -79,29 +76,17 @@ const Stat = ({
const [isHovering, setIsHovering] = useState(false);
const isPast24HoursMode = time.mode === "last-24-hours";
- // Regular bucketed data for sparklines
- const { data: regularData } = useGetOverviewBucketed({
+ // Consolidated bucketed data for sparklines - automatically handles both modes
+ const { data } = useGetOverviewBucketed({
site,
bucket,
- props: {
- enabled: !isPast24HoursMode,
- },
- });
-
- // Past minutes data for sparklines
- const { data: pastMinutesData } = useGetOverviewBucketedPastMinutes({
- pastMinutesStart: 24 * 60,
- pastMinutesEnd: 0,
- site,
- bucket,
- props: {
- enabled: isPast24HoursMode,
- },
+ // For past-24-hours mode, use custom past minutes; otherwise use regular time-based approach
+ ...(isPast24HoursMode && {
+ pastMinutesStart: 24 * 60,
+ pastMinutesEnd: 0,
+ }),
});
- // Use the appropriate data source based on mode
- const data = isPast24HoursMode ? pastMinutesData : regularData;
-
// Filter and format sparklines data
const sparklinesData =
data?.data
diff --git a/client/src/app/[site]/main/components/sections/Weekdays.tsx b/client/src/app/[site]/main/components/sections/Weekdays.tsx
index 45cfe3cb7..0b1f1dc11 100644
--- a/client/src/app/[site]/main/components/sections/Weekdays.tsx
+++ b/client/src/app/[site]/main/components/sections/Weekdays.tsx
@@ -1,9 +1,6 @@
import { DateTime } from "luxon";
import { useMemo, useState } from "react";
-import {
- useGetOverviewBucketed,
- useGetOverviewBucketedPastMinutes,
-} from "../../../../../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "../../../../../api/analytics/useGetOverviewBucketed";
import {
Tabs,
TabsList,
@@ -57,7 +54,7 @@ export function Weekdays() {
data: past24HoursData,
isFetching: isPast24HoursFetching,
error: past24HoursError,
- } = useGetOverviewBucketedPastMinutes({
+ } = useGetOverviewBucketed({
pastMinutesStart: 24 * 60,
pastMinutesEnd: 0,
site,
diff --git a/client/src/app/[site]/pages/components/PageListItem.tsx b/client/src/app/[site]/pages/components/PageListItem.tsx
index b77fe43c3..6012524a6 100644
--- a/client/src/app/[site]/pages/components/PageListItem.tsx
+++ b/client/src/app/[site]/pages/components/PageListItem.tsx
@@ -1,10 +1,7 @@
"use client";
import { useGetSite } from "@/api/admin/sites";
-import {
- useGetOverviewBucketed,
- useGetOverviewBucketedPastMinutes,
-} from "@/api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "@/api/analytics/useGetOverviewBucketed";
import { SingleColResponse } from "@/api/analytics/useSingleCol";
import { usePageMetadata } from "@/api/usePageMetadata";
import { Card, CardContent } from "@/components/ui/card";
@@ -56,7 +53,7 @@ export function PageListItem({
// Past minutes data for sparklines
const { data: pastMinutesData, isLoading: isLoadingPastMinutes } =
- useGetOverviewBucketedPastMinutes({
+ useGetOverviewBucketed({
pastMinutesStart: 24 * 60,
pastMinutesEnd: 0,
site,
diff --git a/client/src/app/[site]/realtime/RealtimeChart/RealtimeChart.tsx b/client/src/app/[site]/realtime/RealtimeChart/RealtimeChart.tsx
index e9f401674..370bcd25c 100644
--- a/client/src/app/[site]/realtime/RealtimeChart/RealtimeChart.tsx
+++ b/client/src/app/[site]/realtime/RealtimeChart/RealtimeChart.tsx
@@ -1,14 +1,14 @@
import { ResponsiveBar } from "@nivo/bar";
import { DateTime } from "luxon";
import { useMemo } from "react";
-import { useGetOverviewBucketedPastMinutes } from "../../../../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "../../../../api/analytics/useGetOverviewBucketed";
import { nivoTheme } from "../../../../lib/nivo";
import { useStore } from "../../../../lib/store";
export function RealtimeChart() {
const { site } = useStore();
- const { data, isLoading } = useGetOverviewBucketedPastMinutes({
+ const { data, isLoading } = useGetOverviewBucketed({
pastMinutesStart: 30,
pastMinutesEnd: 0,
site,
diff --git a/client/src/components/SiteCard.tsx b/client/src/components/SiteCard.tsx
index 6b89160d2..5c30f4d16 100644
--- a/client/src/components/SiteCard.tsx
+++ b/client/src/components/SiteCard.tsx
@@ -1,7 +1,7 @@
import { ArrowRight } from "lucide-react";
import Link from "next/link";
import { useGetOverview } from "../api/analytics/useGetOverview";
-import { useGetOverviewBucketedPastMinutes } from "../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketed } from "../api/analytics/useGetOverviewBucketed";
import { useInView } from "../hooks/useInView";
import { Favicon } from "./Favicon";
import { SiteSessionChart } from "./SiteSessionChart";
@@ -26,7 +26,7 @@ export function SiteCard({ siteId, domain }: SiteCardProps) {
// Track if we've ever loaded data successfully
const hasLoadedData = useRef(false);
- const { data, isLoading, isSuccess } = useGetOverviewBucketedPastMinutes({
+ const { data, isLoading, isSuccess } = useGetOverviewBucketed({
pastMinutesStart: 24 * 60,
pastMinutesEnd: 0,
site: siteId,