🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor Google Search Console hooks and endpoints for improved modularity
Bill Yange8b4386d8d65
diff --git a/client/src/api/gsc/endpoints/connection.ts b/client/src/api/gsc/endpoints/connection.tsnew file mode 100644index 000000000..0329c2e46--- /dev/null+++ b/client/src/api/gsc/endpoints/connection.ts@@ -0,0 +1,50 @@+import { authedFetch } from "../../utils";++export type GSCConnectionStatus = {+ connected: boolean;+ gscPropertyUrl: string | null;+};++export type GSCConnectResponse = {+ authUrl: string;+};++export type GSCDisconnectResponse = {+ success: boolean;+};++/**+ * Fetch GSC connection status for a site+ * GET /api/sites/:site/gsc/status+ */+export async function fetchGSCConnectionStatus(+ site: string | number+): Promise<GSCConnectionStatus> {+ return authedFetch<GSCConnectionStatus>(`/sites/${site}/gsc/status`);+}++/**+ * Get OAuth URL to connect GSC to a site+ * GET /api/sites/:site/gsc/connect+ */+export async function connectGSC(+ site: string | number+): Promise<GSCConnectResponse> {+ return authedFetch<GSCConnectResponse>(`/sites/${site}/gsc/connect`);+}++/**+ * Disconnect GSC from a site+ * DELETE /api/sites/:site/gsc/disconnect+ */+export async function disconnectGSC(+ site: string | number+): Promise<GSCDisconnectResponse> {+ return authedFetch<GSCDisconnectResponse>(+ `/sites/${site}/gsc/disconnect`,+ undefined,+ {+ method: "DELETE",+ }+ );+}diff --git a/client/src/api/gsc/endpoints/data.ts b/client/src/api/gsc/endpoints/data.tsnew file mode 100644index 000000000..160b9f251--- /dev/null+++ b/client/src/api/gsc/endpoints/data.ts@@ -0,0 +1,38 @@+import { authedFetch } from "../../utils";++export type GSCDimension = "query" | "page" | "country" | "device";++export type GSCData = {+ name: string;+ clicks: number;+ impressions: number;+ ctr: number;+ position: number;+};++export interface GSCDataParams {+ dimension: GSCDimension;+ startDate: string;+ endDate: string;+ timeZone: string;+}++/**+ * Fetch Google Search Console data for a specific dimension+ * GET /api/sites/:site/gsc/data+ */+export async function fetchGSCData(+ site: string | number,+ params: GSCDataParams+): Promise<GSCData[]> {+ const response = await authedFetch<{ data: GSCData[] }>(+ `/sites/${site}/gsc/data`,+ {+ dimension: params.dimension,+ start_date: params.startDate,+ end_date: params.endDate,+ time_zone: params.timeZone,+ }+ );+ return response.data;+}diff --git a/client/src/api/gsc/endpoints/index.ts b/client/src/api/gsc/endpoints/index.tsnew file mode 100644index 000000000..803e19078--- /dev/null+++ b/client/src/api/gsc/endpoints/index.ts@@ -0,0 +1,16 @@+// Connection endpoints+export {+ fetchGSCConnectionStatus,+ connectGSC,+ disconnectGSC,+} from "./connection";++export type {+ GSCConnectionStatus,+ GSCConnectResponse,+ GSCDisconnectResponse,+} from "./connection";++// Data endpoints+export { fetchGSCData } from "./data";+export type { GSCDimension, GSCData, GSCDataParams } from "./data";diff --git a/client/src/api/gsc/hooks/useConnectGSC.ts b/client/src/api/gsc/hooks/useConnectGSC.tsnew file mode 100644index 000000000..fea12554c--- /dev/null+++ b/client/src/api/gsc/hooks/useConnectGSC.ts@@ -0,0 +1,19 @@+import { useMutation } from "@tanstack/react-query";+import { useStore } from "../../../lib/store";+import { connectGSC } from "../endpoints";++/**+ * Hook to initiate GSC connection (get OAuth URL)+ */+export function useConnectGSC() {+ const { site } = useStore();++ return useMutation({+ mutationFn: async () => {+ const response = await connectGSC(site);+ // Redirect to Google OAuth+ window.location.href = response.authUrl;+ return response;+ },+ });+}diff --git a/client/src/api/gsc/hooks/useDisconnectGSC.ts b/client/src/api/gsc/hooks/useDisconnectGSC.tsnew file mode 100644index 000000000..180a2a504--- /dev/null+++ b/client/src/api/gsc/hooks/useDisconnectGSC.ts@@ -0,0 +1,23 @@+import { useMutation, useQueryClient } from "@tanstack/react-query";+import { useStore } from "../../../lib/store";+import { disconnectGSC } from "../endpoints";++/**+ * Hook to disconnect GSC from a site+ */+export function useDisconnectGSC() {+ const queryClient = useQueryClient();+ const { site } = useStore();++ return useMutation({+ mutationFn: async () => {+ return disconnectGSC(site);+ },+ onSuccess: () => {+ // Invalidate connection status query+ queryClient.invalidateQueries({ queryKey: ["gsc-status", site] });+ // Invalidate all data queries+ queryClient.invalidateQueries({ queryKey: ["gsc-data"] });+ },+ });+}diff --git a/client/src/api/gsc/hooks/useGetGSCConnection.ts b/client/src/api/gsc/hooks/useGetGSCConnection.tsnew file mode 100644index 000000000..e7c12fc26--- /dev/null+++ b/client/src/api/gsc/hooks/useGetGSCConnection.ts@@ -0,0 +1,17 @@+import { useQuery } from "@tanstack/react-query";+import { useStore } from "../../../lib/store";+import { fetchGSCConnectionStatus } from "../endpoints";++/**+ * Hook to check if the current site has a GSC connection+ */+export function useGetGSCConnection(options?: { site?: number | string }) {+ const { site: storeSite } = useStore();+ const site = options?.site ?? storeSite;++ return useQuery({+ queryKey: ["gsc-status", site],+ queryFn: () => fetchGSCConnectionStatus(site!),+ enabled: !!site,+ });+}diff --git a/client/src/api/gsc/hooks/useGetGSCData.ts b/client/src/api/gsc/hooks/useGetGSCData.tsnew file mode 100644index 000000000..5967dfa53--- /dev/null+++ b/client/src/api/gsc/hooks/useGetGSCData.ts@@ -0,0 +1,28 @@+import { useQuery } from "@tanstack/react-query";+import { useStore } from "../../../lib/store";+import { buildApiParams } from "../../utils";+import { toQueryParams } from "../../analytics/endpoints/types";+import { fetchGSCData, GSCDimension } from "../endpoints";++/**+ * Hook to fetch data from Google Search Console for a specific dimension+ */+export function useGetGSCData(dimension: GSCDimension) {+ const { site, time, timezone } = useStore();+ const timeParams = toQueryParams(buildApiParams(time));++ return useQuery({+ queryKey: ["gsc-data", dimension, site, timeParams, timezone],+ queryFn: () => {+ return fetchGSCData(site!, {+ dimension,+ startDate: timeParams.start_date,+ endDate: timeParams.end_date,+ timeZone: timezone,+ });+ },+ enabled: !!site,+ // Refetch less frequently since GSC data updates slowly+ staleTime: 5 * 60 * 1000, // 5 minutes+ });+}diff --git a/client/src/api/gsc/useGSCConnection.ts b/client/src/api/gsc/useGSCConnection.tsdeleted file mode 100644index 43fa72d0a..000000000--- a/client/src/api/gsc/useGSCConnection.ts+++ /dev/null@@ -1,71 +0,0 @@-import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";-import { useStore } from "../../lib/store";-import { authedFetch } from "../utils";--export type GSCConnectionStatus = {- connected: boolean;- gscPropertyUrl: string | null;-};--/**- * Hook to check if the current site has a GSC connection- */-export function useGSCConnection() {- const { site } = useStore();-- return useQuery({- queryKey: ["gsc-status", site],- enabled: !!site,- queryFn: () => {- return authedFetch<GSCConnectionStatus>(`/gsc/status/${site}`);- },- });-}--/**- * Hook to initiate GSC connection (get OAuth URL)- */-export function useConnectGSC() {- const { site } = useStore();-- return useMutation({- mutationFn: async () => {- const response = await authedFetch<{ authUrl: string }>(`/gsc/connect/${site}`);- // Redirect to Google OAuth- window.location.href = response.authUrl;- return response;- },- });-}--/**- * Hook to disconnect GSC from a site- */-export function useDisconnectGSC() {- const { site } = useStore();- const queryClient = useQueryClient();-- return useMutation({- mutationFn: async () => {- return authedFetch<{ success: boolean }>(`/gsc/disconnect/${site}`, undefined, {- method: "DELETE",- });- },- onSuccess: () => {- // Invalidate connection status query- queryClient.invalidateQueries({ queryKey: ["gsc-status", site] });- // Invalidate data queries- queryClient.invalidateQueries({ queryKey: ["gsc-queries", site] });- queryClient.invalidateQueries({ queryKey: ["gsc-pages", site] });- },- });-}--/**- * Standalone fetch function for GSC connection status (used for exports)- */-export async function fetchGSCConnectionStatus(- site: number | string-): Promise<GSCConnectionStatus> {- return authedFetch<GSCConnectionStatus>(`/gsc/status/${site}`);-}diff --git a/client/src/api/gsc/useGSCData.ts b/client/src/api/gsc/useGSCData.tsdeleted file mode 100644index e3c6797b1..000000000--- a/client/src/api/gsc/useGSCData.ts+++ /dev/null@@ -1,53 +0,0 @@-import { useQuery } from "@tanstack/react-query";-import { Time } from "../../components/DateSelector/types";-import { useStore } from "../../lib/store";-import { toQueryParams } from "../analytics/endpoints/types";-import { authedFetch, buildApiParams } from "../utils";--export type GSCDimension = "query" | "page" | "country" | "device";--export type GSCData = {- name: string;- clicks: number;- impressions: number;- ctr: number;- position: number;-};--/**- * Hook to fetch data from Google Search Console for a specific dimension- */-export function useGSCData(dimension: GSCDimension) {- const { site, time, timezone } = useStore();-- const timeParams = toQueryParams(buildApiParams(time));-- return useQuery({- queryKey: ["gsc-data", dimension, site, timeParams, timezone],- enabled: !!site,- queryFn: () => {- return authedFetch<{ data: GSCData[] }>(`/gsc/data/${site}`, {- ...timeParams,- dimension,- }).then((res) => res.data);- },- // Refetch less frequently since GSC data updates slowly- staleTime: 5 * 60 * 1000, // 5 minutes- });-}--/**- * Standalone fetch function for GSC data (used for exports)- */-export async function fetchGSCData(- site: number | string,- dimension: GSCDimension,- time: Time-): Promise<GSCData[]> {- const timeParams = toQueryParams(buildApiParams(time));- const response = await authedFetch<{ data: GSCData[] }>(`/gsc/data/${site}`, {- ...timeParams,- dimension,- });- return response.data;-}diff --git a/client/src/app/[site]/main/components/ExportButton.tsx b/client/src/app/[site]/main/components/ExportButton.tsxindex ef47042e8..af9bd9662 100644--- a/client/src/app/[site]/main/components/ExportButton.tsx+++ b/client/src/app/[site]/main/components/ExportButton.tsx@@ -11,8 +11,7 @@ import {fetchOverviewBucketed,} from "../../../../api/analytics/endpoints";import { getStartAndEndDate } from "../../../../api/utils";-import { fetchGSCConnectionStatus } from "../../../../api/gsc/useGSCConnection";-import { fetchGSCData, GSCDimension } from "../../../../api/gsc/useGSCData";+import { fetchGSCConnectionStatus, fetchGSCData, GSCDimension } from "../../../../api/gsc/endpoints";import { Button } from "../../../../components/ui/button";import { Tooltip, TooltipContent, TooltipTrigger } from "../../../../components/ui/tooltip";import { IS_CLOUD } from "../../../../lib/const";@@ -182,7 +181,13 @@ export function ExportButton() {const gscResults = await Promise.all(GSC_DIMENSIONS.map(async ({ dimension, filename }) => {try {- const data = await fetchGSCData(site, dimension, time);+ const { startDate, endDate } = getStartAndEndDate(time);+ const data = await fetchGSCData(site, {+ dimension,+ startDate: startDate ?? "",+ endDate: endDate ?? "",+ timeZone,+ });return {filename,data: data as unknown as Record<string, unknown>[],diff --git a/client/src/app/[site]/main/components/sections/SearchConsole.tsx b/client/src/app/[site]/main/components/sections/SearchConsole.tsxindex a8c2dccaf..30475448a 100644--- a/client/src/app/[site]/main/components/sections/SearchConsole.tsx+++ b/client/src/app/[site]/main/components/sections/SearchConsole.tsx@@ -1,7 +1,9 @@import { Expand, Info, Monitor, Smartphone, SquareArrowOutUpRight, Tablet } from "lucide-react";import { useState } from "react";-import { useConnectGSC, useGSCConnection } from "../../../../../api/gsc/useGSCConnection";-import { GSCDimension, useGSCData } from "../../../../../api/gsc/useGSCData";+import { useConnectGSC } from "../../../../../api/gsc/hooks/useConnectGSC";+import { useGetGSCConnection } from "../../../../../api/gsc/hooks/useGetGSCConnection";+import { useGetGSCData } from "../../../../../api/gsc/hooks/useGetGSCData";+import { GSCDimension } from "../../../../../api/gsc/endpoints";import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../../../../components/ui/basic-tabs";import { Button } from "../../../../../components/ui/button";import { Card, CardContent, CardLoader } from "../../../../../components/ui/card";@@ -40,7 +42,7 @@ interface DataListProps {}function DataList({ dimension, label, renderName, expanded, close }: DataListProps) {- const { data, isLoading, isFetching } = useGSCData(dimension);+ const { data, isLoading, isFetching } = useGetGSCData(dimension);const totalClicks = data?.reduce((acc, item) => acc + item.clicks, 0) || 0;@@ -125,7 +127,7 @@ export function SearchConsole() {const [tab, setTab] = useState<Tab>("queries");const [expanded, setExpanded] = useState(false);const close = () => setExpanded(false);- const { data: connection, isLoading: isLoadingConnection } = useGSCConnection();+ const { data: connection, isLoading: isLoadingConnection } = useGetGSCConnection();const topSection = (<div className="flex flex-row gap-2 justify-between items-center">diff --git a/client/src/app/[site]/main/components/sections/SearchConsoleDialog.tsx b/client/src/app/[site]/main/components/sections/SearchConsoleDialog.tsxindex d81875fcb..24382097b 100644--- a/client/src/app/[site]/main/components/sections/SearchConsoleDialog.tsx+++ b/client/src/app/[site]/main/components/sections/SearchConsoleDialog.tsx@@ -16,7 +16,8 @@ import {import { useDebounce } from "@uidotdev/usehooks";import { ChevronDown, ChevronUp, Loader2, Search } from "lucide-react";import { ReactNode, useMemo, useState } from "react";-import { GSCData, GSCDimension, useGSCData } from "../../../../../api/gsc/useGSCData";+import { useGetGSCData } from "../../../../../api/gsc/hooks/useGetGSCData";+import { GSCData, GSCDimension } from "../../../../../api/gsc/endpoints";import { cn } from "../../../../../lib/utils";interface SearchConsoleDialogProps {@@ -30,7 +31,7 @@ interface SearchConsoleDialogProps {const columnHelper = createColumnHelper<GSCData>();export function SearchConsoleDialog({ title, dimension, renderName, expanded, close }: SearchConsoleDialogProps) {- const { data, isLoading } = useGSCData(dimension);+ const { data, isLoading } = useGetGSCData(dimension);const [searchTerm, setSearchTerm] = useState("");const debouncedSearchTerm = useDebounce(searchTerm, 200);diff --git a/client/src/components/SiteSettings/GSCManager.tsx b/client/src/components/SiteSettings/GSCManager.tsxindex 783bf07b4..719062540 100644--- a/client/src/components/SiteSettings/GSCManager.tsx+++ b/client/src/components/SiteSettings/GSCManager.tsx@@ -1,6 +1,8 @@"use client";-import { useConnectGSC, useDisconnectGSC, useGSCConnection } from "@/api/gsc/useGSCConnection";+import { useConnectGSC } from "@/api/gsc/hooks/useConnectGSC";+import { useDisconnectGSC } from "@/api/gsc/hooks/useDisconnectGSC";+import { useGetGSCConnection } from "@/api/gsc/hooks/useGetGSCConnection";import { ConfirmationModal } from "@/components/ConfirmationModal";import { Button } from "@/components/ui/button";import { SiGoogle } from "@icons-pack/react-simple-icons";@@ -15,7 +17,7 @@ interface GSCManagerProps {export function GSCManager({ disabled = false }: GSCManagerProps) {const [gscStatus] = useQueryState("gsc", parseAsString);- const { data: connection, isLoading, refetch } = useGSCConnection();+ const { data: connection, isLoading, refetch } = useGetGSCConnection();const { mutate: connect, isPending: isConnecting } = useConnectGSC();const { mutate: disconnect, isPending: isDisconnecting } = useDisconnectGSC();const [isDisconnectModalOpen, setIsDisconnectModalOpen] = useState(false);