🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor analytics API structure by consolidating single column hooks into a unified directory
Bill Yang4076d3c1cac3
diff --git a/client/src/api/analytics/singleCol/useInfiniteSingleCol.ts b/client/src/api/analytics/singleCol/useInfiniteSingleCol.tsdeleted file mode 100644index 62892bf64..000000000--- a/client/src/api/analytics/singleCol/useInfiniteSingleCol.ts+++ /dev/null@@ -1,53 +0,0 @@-import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";-import { authedFetch, getQueryParams } from "@/api/utils";-import { useStore } from "@/lib/store";-import { FilterParameter } from "@rybbit/shared";-import { InfiniteData, useInfiniteQuery, UseInfiniteQueryResult } from "@tanstack/react-query";--export type InfinitePaginatedResponse = {- data: SingleColResponse[];- totalCount: number;-};--export function useInfiniteSingleCol({- parameter,- limit = 25,- useFilters = true,-}: {- parameter: FilterParameter;- limit?: number;- useFilters?: boolean;-}): UseInfiniteQueryResult<InfiniteData<InfinitePaginatedResponse>> {- const { time, site, filters } = useStore();-- return useInfiniteQuery({- queryKey: [parameter, time, site, filters, limit, "infinite-single-col"],- queryFn: async ({ pageParam = 1 }) => {- const queryParams = {- ...getQueryParams(time),- parameter,- limit,- page: pageParam,- filters: useFilters ? filters : undefined,- };-- const response = await authedFetch<{- data: InfinitePaginatedResponse;- }>(`/single-col/${site}`, queryParams);- return response.data;- },- initialPageParam: 1,- getNextPageParam: (lastPage, allPages) => {- // If we've fetched all items, don't get next page- const totalItems = lastPage.totalCount;- const fetchedItemCount = allPages.reduce((acc, page) => acc + page.data.length, 0);-- if (fetchedItemCount >= totalItems) {- return undefined;- }-- return allPages.length + 1;- },- staleTime: 60_000,- });-}diff --git a/client/src/api/analytics/singleCol/usePaginatedSingleCol.ts b/client/src/api/analytics/singleCol/usePaginatedSingleCol.tsdeleted file mode 100644index 929975490..000000000--- a/client/src/api/analytics/singleCol/usePaginatedSingleCol.ts+++ /dev/null@@ -1,56 +0,0 @@-import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";-import { authedFetch, getQueryParams } from "@/api/utils";-import { useStore } from "@/lib/store";-import { Filter, FilterParameter } from "@rybbit/shared";-import { useQuery, UseQueryResult } from "@tanstack/react-query";--type PaginatedResponse = {- data: SingleColResponse[];- totalCount: number;-};--export function usePaginatedSingleCol({- parameter,- limit = 10,- page = 1,- useFilters = true,- enabled = true,- additionalFilters = [],-}: {- parameter: FilterParameter;- limit?: number;- page?: number;- useFilters?: boolean;- enabled?: boolean;- additionalFilters?: Filter[];-}): UseQueryResult<PaginatedResponse> {- const { time, site, filters } = useStore();-- const queryParams = {- ...getQueryParams(time),- parameter,- limit,- page,- filters: useFilters ? [...filters, ...additionalFilters] : undefined,- };-- return useQuery({- queryKey: [parameter, time, site, filters, limit, page, additionalFilters],- queryFn: async () => {- const response = await authedFetch<{ data: PaginatedResponse }>(`/single-col/${site}`, queryParams);- return response.data;- },- staleTime: 60_000,- placeholderData: (_, query: any) => {- if (!query?.queryKey) return undefined;- const prevQueryKey = query.queryKey;- const [, , prevSite] = prevQueryKey;-- if (prevSite === site) {- return query.state.data;- }- return undefined;- },- enabled,- });-}diff --git a/client/src/api/analytics/singleCol/useSingleCol.ts b/client/src/api/analytics/singleCol/useSingleCol.tsdeleted file mode 100644index c63a05e85..000000000--- a/client/src/api/analytics/singleCol/useSingleCol.ts+++ /dev/null@@ -1,72 +0,0 @@-import { FilterParameter } from "@rybbit/shared";-import { useQuery, UseQueryResult } from "@tanstack/react-query";-import { useStore } from "../../../lib/store";-import { APIResponse } from "../../types";-import { authedFetch, getQueryParams } from "../../utils";--type PeriodTime = "current" | "previous";--export type SingleColResponse = {- value: string;- title?: string;- count: number;- percentage: number;- pageviews?: number;- pageviews_percentage?: number;- time_on_page_seconds?: number;-};--export function useSingleCol({- parameter,- limit = 1000,- periodTime,- useFilters = true,-}: {- parameter: FilterParameter;- limit?: number;- periodTime?: PeriodTime;- useFilters?: boolean;-}): UseQueryResult<APIResponse<SingleColResponse[]>> {- const { time, previousTime, site, filters } = useStore();- const timeToUse = periodTime === "previous" ? previousTime : time;-- // For "previous" periods in past-minutes mode, we need to modify the time object- // to use doubled duration for the start and the original start as the end- const timeForQuery =- timeToUse.mode === "past-minutes" && periodTime === "previous"- ? {- ...timeToUse,- pastMinutesStart: timeToUse.pastMinutesStart * 2,- pastMinutesEnd: timeToUse.pastMinutesStart,- }- : timeToUse;-- const queryParams = getQueryParams(timeForQuery, {- parameter,- limit,- filters: useFilters ? filters : undefined,- });-- const queryKey = [parameter, timeForQuery, site, filters, limit, useFilters];-- return useQuery({- queryKey,- queryFn: async () => {- const response = await authedFetch<{- data: APIResponse<SingleColResponse[]>;- }>(`/single-col/${site}`, queryParams);- return response.data;- },- staleTime: 60_000,- 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/api/analytics/useSingleCol.ts b/client/src/api/analytics/useSingleCol.tsnew file mode 100644index 000000000..4c69c8978--- /dev/null+++ b/client/src/api/analytics/useSingleCol.ts@@ -0,0 +1,172 @@+import { Filter, FilterParameter } from "@rybbit/shared";+import {+ InfiniteData,+ useInfiniteQuery,+ UseInfiniteQueryResult,+ useQuery,+ UseQueryResult,+} from "@tanstack/react-query";+import { useStore } from "../../lib/store";+import { APIResponse } from "../types";+import { authedFetch, getQueryParams } from "../utils";++type PeriodTime = "current" | "previous";++export type SingleColResponse = {+ value: string;+ title?: string;+ count: number;+ percentage: number;+ pageviews?: number;+ pageviews_percentage?: number;+ time_on_page_seconds?: number;+};++export function useSingleCol({+ parameter,+ limit = 1000,+ periodTime,+ useFilters = true,+}: {+ parameter: FilterParameter;+ limit?: number;+ periodTime?: PeriodTime;+ useFilters?: boolean;+}): UseQueryResult<APIResponse<SingleColResponse[]>> {+ const { time, previousTime, site, filters } = useStore();+ const timeToUse = periodTime === "previous" ? previousTime : time;++ // For "previous" periods in past-minutes mode, we need to modify the time object+ // to use doubled duration for the start and the original start as the end+ const timeForQuery =+ timeToUse.mode === "past-minutes" && periodTime === "previous"+ ? {+ ...timeToUse,+ pastMinutesStart: timeToUse.pastMinutesStart * 2,+ pastMinutesEnd: timeToUse.pastMinutesStart,+ }+ : timeToUse;++ const queryParams = getQueryParams(timeForQuery, {+ parameter,+ limit,+ filters: useFilters ? filters : undefined,+ });++ const queryKey = [parameter, timeForQuery, site, filters, limit, useFilters];++ return useQuery({+ queryKey,+ queryFn: async () => {+ const response = await authedFetch<{+ data: APIResponse<SingleColResponse[]>;+ }>(`/single-col/${site}`, queryParams);+ return response.data;+ },+ staleTime: 60_000,+ 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;+ },+ });+}++type PaginatedResponse = {+ data: SingleColResponse[];+ totalCount: number;+};++export function usePaginatedSingleCol({+ parameter,+ limit = 10,+ page = 1,+ useFilters = true,+ enabled = true,+ additionalFilters = [],+}: {+ parameter: FilterParameter;+ limit?: number;+ page?: number;+ useFilters?: boolean;+ enabled?: boolean;+ additionalFilters?: Filter[];+}): UseQueryResult<PaginatedResponse> {+ const { time, site, filters } = useStore();++ const queryParams = {+ ...getQueryParams(time),+ parameter,+ limit,+ page,+ filters: useFilters ? [...filters, ...additionalFilters] : undefined,+ };++ return useQuery({+ queryKey: [parameter, time, site, filters, limit, page, additionalFilters],+ queryFn: async () => {+ const response = await authedFetch<{ data: PaginatedResponse }>(`/single-col/${site}`, queryParams);+ return response.data;+ },+ staleTime: 60_000,+ placeholderData: (_, query: any) => {+ if (!query?.queryKey) return undefined;+ const prevQueryKey = query.queryKey;+ const [, , prevSite] = prevQueryKey;++ if (prevSite === site) {+ return query.state.data;+ }+ return undefined;+ },+ enabled,+ });+}++export function useInfiniteSingleCol({+ parameter,+ limit = 25,+ useFilters = true,+}: {+ parameter: FilterParameter;+ limit?: number;+ useFilters?: boolean;+}): UseInfiniteQueryResult<InfiniteData<PaginatedResponse>> {+ const { time, site, filters } = useStore();++ return useInfiniteQuery({+ queryKey: [parameter, time, site, filters, limit, "infinite-single-col"],+ queryFn: async ({ pageParam = 1 }) => {+ const queryParams = {+ ...getQueryParams(time),+ parameter,+ limit,+ page: pageParam,+ filters: useFilters ? filters : undefined,+ };++ const response = await authedFetch<{+ data: PaginatedResponse;+ }>(`/single-col/${site}`, queryParams);+ return response.data;+ },+ initialPageParam: 1,+ getNextPageParam: (lastPage, allPages) => {+ // If we've fetched all items, don't get next page+ const totalItems = lastPage.totalCount;+ const fetchedItemCount = allPages.reduce((acc, page) => acc + page.data.length, 0);++ if (fetchedItemCount >= totalItems) {+ return undefined;+ }++ return allPages.length + 1;+ },+ staleTime: 60_000,+ });+}diff --git a/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx b/client/src/app/[site]/components/shared/Filters/ValueSelect.tsxindex 919cfce08..86b76f737 100644--- a/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx+++ b/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx@@ -2,7 +2,7 @@import { FilterParameter } from "@rybbit/shared";import { useMemo } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { MultiSelect } from "../../../../../components/MultiSelect";import { useGetRegionName } from "../../../../../lib/geo";import { getCountryName, getLanguageName } from "../../../../../lib/utils";diff --git a/client/src/app/[site]/components/shared/Map/MapComponent.tsx b/client/src/app/[site]/components/shared/Map/MapComponent.tsxindex 63da04a97..1b1984b84 100644--- a/client/src/app/[site]/components/shared/Map/MapComponent.tsx+++ b/client/src/app/[site]/components/shared/Map/MapComponent.tsx@@ -3,7 +3,7 @@import { useMeasure } from "@uidotdev/usehooks";import "ol/ol.css";import { useEffect, useState } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { useCountries, useSubdivisions } from "../../../../../lib/geo";import { CountryFlag } from "../icons/CountryFlag";import { useMapInstance } from "./hooks/useMapInstance";diff --git a/client/src/app/[site]/components/shared/StandardSection/Row.tsx b/client/src/app/[site]/components/shared/StandardSection/Row.tsxindex 1314126c6..58b929539 100644--- a/client/src/app/[site]/components/shared/StandardSection/Row.tsx+++ b/client/src/app/[site]/components/shared/StandardSection/Row.tsx@@ -3,8 +3,8 @@ import NumberFlow from "@number-flow/react";import { round } from "lodash";import { ChevronDown, ChevronRight, SquareArrowOutUpRight } from "lucide-react";import { ReactNode, useState, useCallback } from "react";-import { usePaginatedSingleCol } from "../../../../../api/analytics/singleCol/usePaginatedSingleCol";-import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";+import { usePaginatedSingleCol } from "../../../../../api/analytics/useSingleCol";+import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";import { addFilter, removeFilter, useStore } from "../../../../../lib/store";// Custom hook for filter handling logicdiff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsxindex 7a7b8a5fc..f80cdd434 100644--- a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx@@ -4,8 +4,8 @@ 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/singleCol/usePaginatedSingleCol";-import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";+import { usePaginatedSingleCol } from "../../../../../api/analytics/useSingleCol";+import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";import { CardLoader } from "../../../../../components/ui/card";import { Row } from "./Row";import { Skeleton } from "./Skeleton";diff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsxindex 938791a8c..9b81357f7 100644--- a/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx@@ -11,8 +11,8 @@ import {import { useDebounce, useIntersectionObserver } from "@uidotdev/usehooks";import { ChevronDown, ChevronUp, Loader2, Search, SquareArrowOutUpRight } from "lucide-react";import { ReactNode, useEffect, useMemo, useState } from "react";-import { useInfiniteSingleCol } from "../../../../../api/analytics/singleCol/useInfiniteSingleCol";-import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useInfiniteSingleCol } from "../../../../../api/analytics/useSingleCol";+import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";import { FilterParameter } from "@rybbit/shared";import { addFilter } from "../../../../../lib/store";import { cn, formatSecondsAsMinutesAndSeconds } from "../../../../../lib/utils";diff --git a/client/src/app/[site]/funnels/components/FunnelForm.tsx b/client/src/app/[site]/funnels/components/FunnelForm.tsxindex e7107ca50..adf49eeb8 100644--- a/client/src/app/[site]/funnels/components/FunnelForm.tsx+++ b/client/src/app/[site]/funnels/components/FunnelForm.tsx@@ -6,7 +6,7 @@ import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@import { Plus, Save, Trash2 } from "lucide-react";import { useState } from "react";import { FunnelResponse, FunnelStep } from "../../../../api/analytics/funnels/useGetFunnel";-import { useSingleCol } from "../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../api/analytics/useSingleCol";import { ThreeDotLoader } from "../../../../components/Loaders";import { Label } from "../../../../components/ui/label";import { Switch } from "../../../../components/ui/switch";diff --git a/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts b/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.tsindex 9a450eb8e..07139af33 100644--- a/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts+++ b/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts@@ -5,7 +5,7 @@ import VectorLayer from "ol/layer/Vector";import VectorSource from "ol/source/Vector";import { Fill, Stroke, Style } from "ol/style";import { MutableRefObject, useEffect, useMemo, useRef, useState } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { useCountries } from "../../../../../lib/geo";import { addFilter } from "../../../../../lib/store";import { createColorScale } from "../../utils/colorScale";diff --git a/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts b/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.tsindex bc83814d6..28a053f8f 100644--- a/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts+++ b/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts@@ -5,7 +5,7 @@ import VectorLayer from "ol/layer/Vector";import VectorSource from "ol/source/Vector";import { Fill, Stroke, Style } from "ol/style";import { MutableRefObject, useEffect, useMemo, useRef, useState } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { useSubdivisions } from "../../../../../lib/geo";import { addFilter } from "../../../../../lib/store";import { createColorScale } from "../../utils/colorScale";diff --git a/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts b/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.tsindex 6e6769bbd..9ee180556 100644--- a/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts+++ b/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts@@ -1,7 +1,7 @@import { FilterParameter } from "@rybbit/shared";import mapboxgl from "mapbox-gl";import { useEffect, useMemo, useRef } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { useCountries } from "../../../../../lib/geo";import { addFilter } from "../../../../../lib/store";import { createColorScale } from "../../utils/colorScale";diff --git a/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts b/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.tsindex 59a1256af..865316fe8 100644--- a/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts+++ b/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts@@ -1,7 +1,7 @@import { FilterParameter } from "@rybbit/shared";import mapboxgl from "mapbox-gl";import { useEffect, useMemo, useRef } from "react";-import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../../api/analytics/useSingleCol";import { useSubdivisions } from "../../../../../lib/geo";import { addFilter } from "../../../../../lib/store";import { createColorScale } from "../../utils/colorScale";diff --git a/client/src/app/[site]/goals/components/GoalFormModal.tsx b/client/src/app/[site]/goals/components/GoalFormModal.tsxindex af0908128..ff3162cd4 100644--- a/client/src/app/[site]/goals/components/GoalFormModal.tsx+++ b/client/src/app/[site]/goals/components/GoalFormModal.tsx@@ -7,7 +7,7 @@ import * as z from "zod";import { useCreateGoal } from "../../../../api/analytics/goals/useCreateGoal";import { Goal } from "../../../../api/analytics/goals/useGetGoals";import { useUpdateGoal } from "../../../../api/analytics/goals/useUpdateGoal";-import { useSingleCol } from "../../../../api/analytics/singleCol/useSingleCol";+import { useSingleCol } from "../../../../api/analytics/useSingleCol";import { EventIcon, PageviewIcon } from "../../../../components/EventIcons";import { Button } from "../../../../components/ui/button";import {diff --git a/client/src/app/[site]/pages/components/PageListItem.tsx b/client/src/app/[site]/pages/components/PageListItem.tsxindex 2c080ed10..03d5eecb5 100644--- a/client/src/app/[site]/pages/components/PageListItem.tsx+++ b/client/src/app/[site]/pages/components/PageListItem.tsx@@ -2,7 +2,7 @@import { useGetSite } from "@/api/admin/sites";import { useGetOverviewBucketed } from "@/api/analytics/useGetOverviewBucketed";-import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";+import { SingleColResponse } from "@/api/analytics/useSingleCol";import { usePageMetadata } from "@/api/usePageMetadata";import { Card, CardContent } from "@/components/ui/card";import { Filter } from "@rybbit/shared";