Skip to content

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

Refactor analytics hooks to utilize centralized `getQueryParams` utility for query parameter construction. This change eliminates duplicated logic for handling past-24-hours mode across multiple files, enhancing maintainability and consistency in API calls. Updated relevant hooks to streamline their implementation and improve code clarity.

Bill Yanga08cfadbf9db
diff --git a/client/src/api/analytics/useGetPageTitles.ts b/client/src/api/analytics/useGetPageTitles.ts
index a6ede4b96..976783259 100644
--- a/client/src/api/analytics/useGetPageTitles.ts
+++ b/client/src/api/analytics/useGetPageTitles.ts
@@ -3,7 +3,7 @@ import { useQuery, UseQueryResult } from "@tanstack/react-query";
import { timeZone } from "@/lib/dateTimeUtils";
import { useStore } from "@/lib/store";
import { APIResponse } from "../types";
-import { authedFetch, getStartAndEndDate } from "../utils";
+import { authedFetch, getQueryParams } from "../utils";
// This should match PageTitleItem from the backend
export type PageTitleItem = {
@@ -42,28 +42,12 @@ export function useGetPageTitlesPaginated({
> {
const { time, site, filters } = useStore();
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = time.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone: timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- limit,
- page,
- filters: useFilters ? filters : undefined,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(time),
- timeZone: timeZone,
- limit,
- page,
- filters: useFilters ? filters : undefined,
- };
+ const queryParams = {
+ ...getQueryParams(time),
+ limit,
+ page,
+ filters: useFilters ? filters : undefined,
+ };
return useQuery({
queryKey: [
@@ -73,7 +57,7 @@ export function useGetPageTitlesPaginated({
filters,
limit,
page,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ time.mode === "last-24-hours" ? "past-minutes" : "date-range",
],
queryFn: () => {
return authedFetch<APIResponse<PageTitlesPaginatedResponse>>(
diff --git a/client/src/api/analytics/useGetPerformanceByDimension.ts b/client/src/api/analytics/useGetPerformanceByDimension.ts
index b936b7421..9ed2713e9 100644
--- a/client/src/api/analytics/useGetPerformanceByDimension.ts
+++ b/client/src/api/analytics/useGetPerformanceByDimension.ts
@@ -1,9 +1,8 @@
import { Filter } from "@rybbit/shared";
import { useQuery, UseQueryResult } from "@tanstack/react-query";
import { usePerformanceStore } from "../../app/[site]/performance/performanceStore";
-import { timeZone } from "../../lib/dateTimeUtils";
import { useStore } from "../../lib/store";
-import { authedFetch, getStartAndEndDate } from "../utils";
+import { authedFetch, getQueryParams } from "../utils";
type UseGetPerformanceByDimensionOptions = {
site: number | string;
@@ -72,36 +71,15 @@ export function useGetPerformanceByDimension({
const { time, filters } = useStore();
const { selectedPercentile } = usePerformanceStore();
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = time.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone: timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- limit,
- page,
- percentile: selectedPercentile,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- sortBy,
- sortOrder,
- dimension,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(time),
- timeZone: timeZone,
- limit,
- page,
- percentile: selectedPercentile,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- sortBy,
- sortOrder,
- dimension,
- };
+ const queryParams = getQueryParams(time, {
+ limit,
+ page,
+ percentile: selectedPercentile,
+ filters: useFilters ? [...filters, ...additionalFilters] : undefined,
+ sortBy,
+ sortOrder,
+ dimension,
+ });
return useQuery({
queryKey: [
@@ -113,7 +91,7 @@ export function useGetPerformanceByDimension({
selectedPercentile,
limit,
page,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ time.mode === "last-24-hours" ? "past-minutes" : "date-range",
additionalFilters,
sortBy,
sortOrder,
diff --git a/client/src/api/analytics/useGetPerformanceOverview.ts b/client/src/api/analytics/useGetPerformanceOverview.ts
index d8fe3b888..95fff77f5 100644
--- a/client/src/api/analytics/useGetPerformanceOverview.ts
+++ b/client/src/api/analytics/useGetPerformanceOverview.ts
@@ -1,7 +1,7 @@
import { useQuery } from "@tanstack/react-query";
import { useStore } from "../../lib/store";
import { usePerformanceStore } from "../../app/[site]/performance/performanceStore";
-import { authedFetch, getStartAndEndDate } from "../utils";
+import { authedFetch, getQueryParams } from "../utils";
import { timeZone } from "../../lib/dateTimeUtils";
export type GetPerformanceOverviewResponse = {
@@ -34,26 +34,10 @@ export function useGetPerformanceOverview({
const { selectedPercentile } = usePerformanceStore();
const timeToUse = periodTime === "previous" ? previousTime : time;
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = timeToUse.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- filters,
- percentile: selectedPercentile,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(timeToUse),
- timeZone,
- filters,
- percentile: selectedPercentile,
- };
+ const queryParams = getQueryParams(timeToUse, {
+ filters,
+ percentile: selectedPercentile,
+ });
return useQuery({
queryKey: [
@@ -62,7 +46,7 @@ export function useGetPerformanceOverview({
site,
filters,
selectedPercentile,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ timeToUse.mode === "last-24-hours" ? "past-minutes" : "date-range",
],
queryFn: () => {
return authedFetch<{ data: GetPerformanceOverviewResponse }>(
diff --git a/client/src/api/analytics/useGetPerformanceTimeSeries.ts b/client/src/api/analytics/useGetPerformanceTimeSeries.ts
index 666d84553..f03abf991 100644
--- a/client/src/api/analytics/useGetPerformanceTimeSeries.ts
+++ b/client/src/api/analytics/useGetPerformanceTimeSeries.ts
@@ -8,7 +8,7 @@ import { usePerformanceStore } from "../../app/[site]/performance/performanceSto
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";
@@ -62,29 +62,12 @@ export function useGetPerformanceTimeSeries({
const timeToUse = periodTime === "previous" ? previousTime : time;
const bucketToUse = bucket || storeBucket;
-
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = timeToUse.mode === "last-24-hours";
-
const combinedFilters = [...globalFilters, ...dynamicFilters];
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- bucket: bucketToUse,
- filters: combinedFilters,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(timeToUse),
- timeZone,
- bucket: bucketToUse,
- filters: combinedFilters,
- };
+ const queryParams = getQueryParams(timeToUse, {
+ bucket: bucketToUse,
+ filters: combinedFilters,
+ });
return useQuery({
queryKey: [
@@ -94,7 +77,7 @@ export function useGetPerformanceTimeSeries({
site,
combinedFilters,
selectedPerformanceMetric,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ timeToUse.mode === "last-24-hours" ? "past-minutes" : "date-range",
],
queryFn: () => {
return authedFetch<APIResponse<GetPerformanceTimeSeriesResponse>>(
diff --git a/client/src/api/analytics/useInfiniteSingleCol.ts b/client/src/api/analytics/useInfiniteSingleCol.ts
index 833828289..475bbaa3b 100644
--- a/client/src/api/analytics/useInfiniteSingleCol.ts
+++ b/client/src/api/analytics/useInfiniteSingleCol.ts
@@ -5,7 +5,7 @@ import {
InfiniteData,
} from "@tanstack/react-query";
import { SingleColResponse } from "@/api/analytics/useSingleCol";
-import { authedFetch, getStartAndEndDate } from "@/api/utils";
+import { authedFetch, getQueryParams } from "@/api/utils";
import { timeZone } from "@/lib/dateTimeUtils";
import { useStore } from "@/lib/store";
@@ -29,8 +29,6 @@ export function useInfiniteSingleCol({
> {
const { time, site, filters } = useStore();
- const isPast24HoursMode = time.mode === "last-24-hours";
-
return useInfiniteQuery({
queryKey: [
parameter,
@@ -38,28 +36,17 @@ export function useInfiniteSingleCol({
site,
filters,
limit,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ time.mode === "last-24-hours" ? "past-minutes" : "date-range",
"infinite-single-col",
],
queryFn: async ({ pageParam = 1 }) => {
- const queryParams = isPast24HoursMode
- ? {
- timeZone: timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- parameter,
- limit,
- page: pageParam,
- filters: useFilters ? filters : undefined,
- }
- : {
- ...getStartAndEndDate(time),
- timeZone: timeZone,
- parameter,
- limit,
- page: pageParam,
- filters: useFilters ? filters : undefined,
- };
+ const queryParams = {
+ ...getQueryParams(time),
+ parameter,
+ limit,
+ page: pageParam,
+ filters: useFilters ? filters : undefined,
+ };
const response = await authedFetch<{
data: InfinitePaginatedResponse;
diff --git a/client/src/api/analytics/usePaginatedSingleCol.ts b/client/src/api/analytics/usePaginatedSingleCol.ts
index 6bf8b8e97..bb4ad014f 100644
--- a/client/src/api/analytics/usePaginatedSingleCol.ts
+++ b/client/src/api/analytics/usePaginatedSingleCol.ts
@@ -1,7 +1,7 @@
import { Filter, FilterParameter } from "@rybbit/shared";
import { useQuery, UseQueryResult } from "@tanstack/react-query";
import { SingleColResponse } from "@/api/analytics/useSingleCol";
-import { authedFetch, getStartAndEndDate } from "@/api/utils";
+import { authedFetch, getQueryParams } from "@/api/utils";
import { timeZone } from "@/lib/dateTimeUtils";
import { useStore } from "@/lib/store";
@@ -29,30 +29,13 @@ export function usePaginatedSingleCol({
}: UsePaginatedSingleColOptions): UseQueryResult<PaginatedResponse> {
const { time, site, filters } = useStore();
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = time.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone: timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- parameter,
- limit,
- page,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(time),
- timeZone: timeZone,
- parameter,
- limit,
- page,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- };
+ const queryParams = {
+ ...getQueryParams(time),
+ parameter,
+ limit,
+ page,
+ filters: useFilters ? [...filters, ...additionalFilters] : undefined,
+ };
return useQuery({
queryKey: [
@@ -62,7 +45,7 @@ export function usePaginatedSingleCol({
filters,
limit,
page,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ time.mode === "last-24-hours" ? "past-minutes" : "date-range",
additionalFilters,
],
queryFn: async () => {
diff --git a/client/src/api/analytics/useSingleCol.ts b/client/src/api/analytics/useSingleCol.ts
index 935a46551..ba5b2c53c 100644
--- a/client/src/api/analytics/useSingleCol.ts
+++ b/client/src/api/analytics/useSingleCol.ts
@@ -3,7 +3,7 @@ import { useQuery, UseQueryResult } from "@tanstack/react-query";
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";
@@ -31,28 +31,18 @@ export function useSingleCol({
const { time, previousTime, site, filters } = useStore();
const timeToUse = periodTime === "previous" ? previousTime : time;
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = timeToUse.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach using pastMinutesStart/pastMinutesEnd
- timeZone: timeZone,
- parameter,
- limit,
- pastMinutesStart: periodTime === "previous" ? 48 * 60 : 24 * 60,
- pastMinutesEnd: periodTime === "previous" ? 24 * 60 : 0,
- filters: useFilters ? filters : undefined,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(timeToUse),
- timeZone: timeZone,
- parameter,
- limit,
- filters: useFilters ? filters : undefined,
- };
+ const queryParams = getQueryParams(
+ timeToUse,
+ {
+ parameter,
+ limit,
+ filters: useFilters ? filters : undefined,
+ },
+ {
+ pastMinutesStart: periodTime === "previous" ? 48 * 60 : 24 * 60,
+ pastMinutesEnd: periodTime === "previous" ? 24 * 60 : 0,
+ }
+ );
// Use a consistent query key format that includes the mode
const queryKey = [
@@ -62,7 +52,7 @@ export function useSingleCol({
filters,
limit,
useFilters,
- isPast24HoursMode ? "past-minutes" : "date-range",
+ timeToUse.mode === "last-24-hours" ? "past-minutes" : "date-range",
];
return useQuery({
diff --git a/client/src/api/utils.ts b/client/src/api/utils.ts
index 866ef1102..18493df83 100644
--- a/client/src/api/utils.ts
+++ b/client/src/api/utils.ts
@@ -2,6 +2,7 @@ import { DateTime } from "luxon";
import { Time } from "../components/DateSelector/types";
import axios, { AxiosRequestConfig } from "axios";
import { BACKEND_URL } from "../lib/const";
+import { timeZone } from "../lib/dateTimeUtils";
export function getStartAndEndDate(time: Time) {
if (time.mode === "range") {
@@ -34,6 +35,32 @@ export function getStartAndEndDate(time: Time) {
return { startDate: time.day, endDate: time.day };
}
+export function getQueryParams(
+ time: Time,
+ additionalParams: Record<string, any> = {},
+ options: {
+ pastMinutesStart?: number;
+ pastMinutesEnd?: number;
+ } = {}
+): Record<string, any> {
+ const isPast24HoursMode = time.mode === "last-24-hours";
+
+ return isPast24HoursMode
+ ? {
+ // Past minutes approach for last-24-hours mode
+ timeZone,
+ pastMinutesStart: options.pastMinutesStart ?? 24 * 60, // 24 hours ago by default
+ pastMinutesEnd: options.pastMinutesEnd ?? 0, // now by default
+ ...additionalParams,
+ }
+ : {
+ // Regular date-based approach
+ ...getStartAndEndDate(time),
+ timeZone,
+ ...additionalParams,
+ };
+}
+
export async function authedFetch<T>(
url: string,
params?: Record<string, any>,
diff --git a/memory-bank/decisionLog.md b/memory-bank/decisionLog.md
index 8810b27de..6baa36ce8 100644
--- a/memory-bank/decisionLog.md
+++ b/memory-bank/decisionLog.md
@@ -80,3 +80,22 @@ User requested to add support for the past 24-hour mode to useGetPerformanceTime
- Updated query keys to include mode differentiation ("past-minutes" vs "date-range")
- Maintained existing date-based approach for all other time modes
- Used same pattern as useGetPerformanceByDimension for consistency
+
+[2025-01-08 19:23:09] - **Code Deduplication: Query Parameter Logic Refactoring**
+
+- **Decision**: Created a centralized `getQueryParams` utility function to eliminate duplicated conditional logic across analytics hooks
+- **Problem**: Found 7+ instances of identical `isPast24HoursMode` conditional logic for query parameter construction
+- **Solution**:
+ - Created `getQueryParams(time, pastMinutesStart?, pastMinutesEnd?)` utility in `client/src/api/utils.ts`
+ - Handles both past-24-hours mode (using pastMinutesStart/End) and regular date-based queries
+ - Supports optional custom past minutes parameters for complex cases
+- **Files Refactored**:
+ - `useGetPerformanceTimeSeries.ts` - Reduced ~20 lines to 3 lines
+ - `useGetPerformanceOverview.ts` - Simplified conditional logic
+ - `useGetPerformanceByDimension.ts` - Removed duplicated logic
+ - `useSingleCol.ts` - Enhanced with custom past minutes support
+ - `usePaginatedSingleCol.ts` - Simplified query parameter construction
+ - `useInfiniteSingleCol.ts` - Removed conditional logic duplication
+ - `useGetPageTitles.ts` - Standardized query parameter handling
+- **Benefits**: Improved maintainability, reduced code duplication, centralized time-based query logic
+- **Impact**: Significant reduction in duplicated code across analytics layer
diff --git a/memory-bank/progress.md b/memory-bank/progress.md
index 0141d0c09..5b55ac2fe 100644
--- a/memory-bank/progress.md
+++ b/memory-bank/progress.md
@@ -104,3 +104,23 @@ This file tracks the project's progress using a task list format.
- Updated query keys to differentiate between "past-minutes" and "date-range" modes
- Maintained backward compatibility with existing date-range based queries
- Achieved consistency across all performance analytics hooks
+
+[2025-01-08 19:23:28] - **COMPLETED: Analytics Hooks Code Deduplication**
+
+- **Task**: Eliminate duplicated query parameter logic across analytics hooks
+- **Status**: ✅ COMPLETED
+- **Work Done**:
+ - Created centralized [`getQueryParams`](client/src/api/utils.ts:1) utility function
+ - Refactored 7 analytics hook files to use the new utility
+ - Reduced code duplication from ~20 lines per file to 3 lines
+ - Enhanced utility to support custom past minutes parameters for complex cases
+- **Files Modified**:
+ - [`client/src/api/utils.ts`](client/src/api/utils.ts:1) - Added `getQueryParams` utility
+ - [`useGetPerformanceTimeSeries.ts`](client/src/api/analytics/useGetPerformanceTimeSeries.ts:1) - Refactored
+ - [`useGetPerformanceOverview.ts`](client/src/api/analytics/useGetPerformanceOverview.ts:1) - Refactored
+ - [`useGetPerformanceByDimension.ts`](client/src/api/analytics/useGetPerformanceByDimension.ts:1) - Refactored
+ - [`useSingleCol.ts`](client/src/api/analytics/useSingleCol.ts:1) - Refactored with custom params
+ - [`usePaginatedSingleCol.ts`](client/src/api/analytics/usePaginatedSingleCol.ts:1) - Refactored
+ - [`useInfiniteSingleCol.ts`](client/src/api/analytics/useInfiniteSingleCol.ts:1) - Refactored
+ - [`useGetPageTitles.ts`](client/src/api/analytics/useGetPageTitles.ts:1) - Refactored
+- **Impact**: Significantly improved code maintainability and reduced duplication across analytics layer