Skip to content

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

Enhance site configuration by adding new analytics features and refactoring toggle management

Bill Yang95db4776e31a
diff --git a/client/src/api/admin/sites.ts b/client/src/api/admin/sites.ts
index ff558128e..e13f4bf7f 100644
--- a/client/src/api/admin/sites.ts
+++ b/client/src/api/admin/sites.ts
@@ -17,6 +17,14 @@ export type SiteResponse = {
saltUserIds: boolean;
blockBots: boolean;
isOwner: boolean;
+ // Analytics features
+ sessionReplay?: boolean;
+ webVitals?: boolean;
+ trackErrors?: boolean;
+ trackOutbound?: boolean;
+ trackUrlParams?: boolean;
+ trackInitialPageView?: boolean;
+ trackSpaNavigation?: boolean;
};
export type GetSitesFromOrgResponse = {
diff --git a/client/src/components/SiteSettings/SiteConfiguration.tsx b/client/src/components/SiteSettings/SiteConfiguration.tsx
index b7e73ff7e..45a823861 100644
--- a/client/src/components/SiteSettings/SiteConfiguration.tsx
+++ b/client/src/components/SiteSettings/SiteConfiguration.tsx
@@ -2,7 +2,7 @@
import { AlertTriangle } from "lucide-react";
import { useRouter } from "next/navigation";
-import { useState } from "react";
+import { useState, useCallback } from "react";
import { toast } from "sonner";
import {
@@ -21,12 +21,7 @@ import { Input } from "@/components/ui/input";
import { Label } from "@/components/ui/label";
import { Switch } from "@/components/ui/switch";
-import {
- deleteSite,
- SiteResponse,
- updateSiteConfig,
- useGetSitesFromOrg,
-} from "@/api/admin/sites";
+import { deleteSite, SiteResponse, updateSiteConfig, useGetSitesFromOrg } from "@/api/admin/sites";
import { normalizeDomain } from "@/lib/utils";
import { IPExclusionManager } from "./IPExclusionManager";
@@ -36,20 +31,69 @@ interface SiteConfigurationProps {
onClose?: () => void;
}
+interface ToggleConfig {
+ id: string;
+ label: string;
+ description: string;
+ value: boolean;
+ key: keyof SiteResponse;
+ enabledMessage?: string;
+ disabledMessage?: string;
+}
+
export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: SiteConfigurationProps) {
const { refetch } = useGetSitesFromOrg(siteMetadata?.organizationId ?? "");
const router = useRouter();
const [newDomain, setNewDomain] = useState(siteMetadata.domain);
const [isChangingDomain, setIsChangingDomain] = useState(false);
- const [isPublic, setIsPublic] = useState(siteMetadata.public || false);
- const [isChangingPublic, setIsChangingPublic] = useState(false);
- const [isSalting, setIsSalting] = useState(siteMetadata.saltUserIds || false);
- const [isChangingSalt, setIsChangingSalt] = useState(false);
- const [isBlockingBots, setIsBlockingBots] = useState(siteMetadata.blockBots || false);
- const [isChangingBlockBots, setIsChangingBlockBots] = useState(false);
const [isDeleting, setIsDeleting] = useState(false);
+ // Track all toggle states and loading states in single objects
+ const [toggleStates, setToggleStates] = useState({
+ public: siteMetadata.public || false,
+ saltUserIds: siteMetadata.saltUserIds || false,
+ blockBots: siteMetadata.blockBots || false,
+ sessionReplay: siteMetadata.sessionReplay || false,
+ webVitals: siteMetadata.webVitals || false,
+ trackErrors: siteMetadata.trackErrors || false,
+ trackOutbound: siteMetadata.trackOutbound ?? true,
+ trackUrlParams: siteMetadata.trackUrlParams ?? true,
+ trackInitialPageView: siteMetadata.trackInitialPageView ?? true,
+ trackSpaNavigation: siteMetadata.trackSpaNavigation ?? true,
+ });
+
+ const [loadingStates, setLoadingStates] = useState<Record<string, boolean>>({});
+
+ // Generic toggle handler
+ const handleToggle = useCallback(
+ async (
+ key: keyof typeof toggleStates,
+ checked: boolean,
+ successMessage?: { enabled: string; disabled: string }
+ ) => {
+ setLoadingStates(prev => ({ ...prev, [key]: true }));
+ try {
+ await updateSiteConfig(siteMetadata.siteId, { [key]: checked });
+ setToggleStates(prev => ({ ...prev, [key]: checked }));
+ const message = successMessage
+ ? checked
+ ? successMessage.enabled
+ : successMessage.disabled
+ : `${key.replace(/([A-Z])/g, " $1").toLowerCase()} ${checked ? "enabled" : "disabled"}`;
+ toast.success(message);
+ refetch();
+ } catch (error) {
+ console.error(`Error updating ${key}:`, error);
+ toast.error(`Failed to update ${key.replace(/([A-Z])/g, " $1").toLowerCase()}`);
+ setToggleStates(prev => ({ ...prev, [key]: !checked }));
+ } finally {
+ setLoadingStates(prev => ({ ...prev, [key]: false }));
+ }
+ },
+ [siteMetadata.siteId, refetch]
+ );
+
const handleDomainChange = async () => {
if (!newDomain) {
toast.error("Domain cannot be empty");
@@ -87,109 +131,141 @@ export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: S
}
};
- const handlePublicToggle = async (checked: boolean) => {
- try {
- setIsChangingPublic(true);
- await updateSiteConfig(siteMetadata.siteId, { public: checked });
- setIsPublic(checked);
- toast.success(checked ? "Site analytics made public" : "Site analytics made private");
- refetch();
- } catch (error) {
- console.error("Error changing public status:", error);
- toast.error("Failed to update public status");
- setIsPublic(!checked); // Revert UI state on error
- } finally {
- setIsChangingPublic(false);
- }
- };
+ // Configuration for privacy & security toggles
+ const privacyToggles: ToggleConfig[] = [
+ {
+ id: "public",
+ label: "Public Analytics",
+ description: "Anyone can view your site analytics without logging in",
+ value: toggleStates.public,
+ key: "public",
+ enabledMessage: "Site analytics made public",
+ disabledMessage: "Site analytics made private",
+ },
+ {
+ id: "saltUserIds",
+ label: "User ID Salting",
+ description: "User IDs will be salted with a daily rotating key for enhanced privacy",
+ value: toggleStates.saltUserIds,
+ key: "saltUserIds",
+ enabledMessage: "User ID salting enabled",
+ disabledMessage: "User ID salting disabled",
+ },
+ {
+ id: "blockBots",
+ label: "Block Bot Traffic",
+ description: "Traffic from known bots and crawlers will not be tracked",
+ value: toggleStates.blockBots,
+ key: "blockBots",
+ enabledMessage: "Bot blocking enabled",
+ disabledMessage: "Bot blocking disabled",
+ },
+ ];
- const handleSaltToggle = async (checked: boolean) => {
- try {
- setIsChangingSalt(true);
- await updateSiteConfig(siteMetadata.siteId, { saltUserIds: checked });
- setIsSalting(checked);
- toast.success(checked ? "User ID salting enabled" : "User ID salting disabled");
- refetch();
- } catch (error) {
- console.error("Error changing salt setting:", error);
- toast.error("Failed to update salting setting");
- setIsSalting(!checked); // Revert UI state on error
- } finally {
- setIsChangingSalt(false);
- }
- };
+ // Configuration for analytics feature toggles
+ const analyticsToggles: ToggleConfig[] = [
+ {
+ id: "sessionReplay",
+ label: "Session Replay",
+ description: "Record and replay user sessions to understand user behavior",
+ value: toggleStates.sessionReplay,
+ key: "sessionReplay",
+ enabledMessage: "Session replay enabled",
+ disabledMessage: "Session replay disabled",
+ },
+ {
+ id: "webVitals",
+ label: "Web Vitals",
+ description: "Track Core Web Vitals metrics (LCP, CLS, INP, FCP, TTFB)",
+ value: toggleStates.webVitals,
+ key: "webVitals",
+ enabledMessage: "Web Vitals enabled",
+ disabledMessage: "Web Vitals disabled",
+ },
+ {
+ id: "trackErrors",
+ label: "Error Tracking",
+ description: "Capture JavaScript errors and exceptions from your site",
+ value: toggleStates.trackErrors,
+ key: "trackErrors",
+ enabledMessage: "Error tracking enabled",
+ disabledMessage: "Error tracking disabled",
+ },
+ {
+ id: "trackOutbound",
+ label: "Track Outbound Links",
+ description: "Track when users click on external links",
+ value: toggleStates.trackOutbound,
+ key: "trackOutbound",
+ enabledMessage: "Outbound tracking enabled",
+ disabledMessage: "Outbound tracking disabled",
+ },
+ {
+ id: "trackUrlParams",
+ label: "Track URL Parameters",
+ description: "Include query string parameters in page tracking",
+ value: toggleStates.trackUrlParams,
+ key: "trackUrlParams",
+ enabledMessage: "URL parameters tracking enabled",
+ disabledMessage: "URL parameters tracking disabled",
+ },
+ {
+ id: "trackInitialPageView",
+ label: "Track Initial Page View",
+ description: "Automatically track the first page view when the script loads",
+ value: toggleStates.trackInitialPageView,
+ key: "trackInitialPageView",
+ enabledMessage: "Initial page view tracking enabled",
+ disabledMessage: "Initial page view tracking disabled",
+ },
+ {
+ id: "trackSpaNavigation",
+ label: "Track SPA Navigation",
+ description: "Automatically track navigation in single-page applications",
+ value: toggleStates.trackSpaNavigation,
+ key: "trackSpaNavigation",
+ enabledMessage: "SPA navigation tracking enabled",
+ disabledMessage: "SPA navigation tracking disabled",
+ },
+ ];
- const handleBlockBotsToggle = async (checked: boolean) => {
- try {
- setIsChangingBlockBots(true);
- await updateSiteConfig(siteMetadata.siteId, { blockBots: checked });
- setIsBlockingBots(checked);
- toast.success(checked ? "Bot blocking enabled" : "Bot blocking disabled");
- refetch();
- } catch (error) {
- console.error("Error changing bot blocking setting:", error);
- toast.error("Failed to update bot blocking setting");
- setIsBlockingBots(!checked); // Revert UI state on error
- } finally {
- setIsChangingBlockBots(false);
- }
- };
+ const renderToggleSection = (toggles: ToggleConfig[], title?: string) => (
+ <>
+ {title && <h4 className="text-sm font-semibold text-foreground">{title}</h4>}
+ {toggles.map(toggle => (
+ <div key={toggle.id} className="flex items-center justify-between">
+ <div>
+ <Label htmlFor={toggle.id} className="text-sm font-medium text-foreground block">
+ {toggle.label}
+ </Label>
+ <p className="text-xs text-muted-foreground mt-1">{toggle.description}</p>
+ </div>
+ <Switch
+ id={toggle.id}
+ checked={toggle.value}
+ disabled={loadingStates[toggle.key] || disabled}
+ onCheckedChange={checked =>
+ handleToggle(
+ toggle.key as keyof typeof toggleStates,
+ checked,
+ toggle.enabledMessage && toggle.disabledMessage
+ ? { enabled: toggle.enabledMessage, disabled: toggle.disabledMessage }
+ : undefined
+ )
+ }
+ />
+ </div>
+ ))}
+ </>
+ );
return (
<div className="pt-4 space-y-6 max-h-[70vh] overflow-y-auto">
- {/* Public Analytics Section */}
- <div className="flex items-center justify-between">
- <div>
- <Label htmlFor="publicAnalytics" className="text-sm font-medium text-foreground block">
- Public Analytics
- </Label>
- <p className="text-xs text-muted-foreground mt-1">
- When enabled, anyone can view your site analytics without logging in
- </p>
- </div>
- <Switch
- id="publicAnalytics"
- checked={isPublic}
- disabled={isChangingPublic || disabled}
- onCheckedChange={handlePublicToggle}
- />
- </div>
+ {/* Privacy & Security Settings */}
+ <div className="space-y-4">{renderToggleSection(privacyToggles, "Privacy & Security")}</div>
- {/* User ID Salting Section */}
- <div className="flex items-center justify-between">
- <div>
- <Label htmlFor="saltUserIds" className="text-sm font-medium text-foreground block">
- Enable User ID Salting
- </Label>
- <p className="text-xs text-muted-foreground mt-1">
- When enabled, user IDs will be salted with a daily rotating key for enhanced privacy
- </p>
- </div>
- <Switch
- id="saltUserIds"
- checked={isSalting}
- disabled={isChangingSalt || disabled}
- onCheckedChange={handleSaltToggle}
- />
- </div>
-
- {/* Bot Blocking Section */}
- <div className="flex items-center justify-between">
- <div>
- <Label htmlFor="blockBots" className="text-sm font-medium text-foreground block">
- Block Bot Traffic
- </Label>
- <p className="text-xs text-muted-foreground mt-1">
- When enabled, traffic from known bots and crawlers will not be tracked
- </p>
- </div>
- <Switch
- id="blockBots"
- checked={isBlockingBots}
- disabled={isChangingBlockBots || disabled}
- onCheckedChange={handleBlockBotsToggle}
- />
- </div>
+ {/* Analytics Features */}
+ <div className="space-y-4">{renderToggleSection(analyticsToggles, "Analytics Features")}</div>
{/* IP Exclusions Section */}
<IPExclusionManager siteId={siteMetadata.siteId} disabled={disabled} />
diff --git a/client/src/components/SiteSettings/SiteSettings.tsx b/client/src/components/SiteSettings/SiteSettings.tsx
index 23731e55b..67b1f3f72 100644
--- a/client/src/components/SiteSettings/SiteSettings.tsx
+++ b/client/src/components/SiteSettings/SiteSettings.tsx
@@ -52,7 +52,7 @@ function SiteSettingsInner({ siteMetadata, trigger }: { siteMetadata: SiteRespon
</Button>
)}
</DialogTrigger>
- <DialogContent className="sm:max-w-[500px]">
+ <DialogContent className="sm:max-w-[750px]">
<DialogHeader>
<DialogTitle>Site Settings</DialogTitle>
<DialogDescription>Manage settings for {siteMetadata.domain}</DialogDescription>
diff --git a/server/src/api/sites/getSite.ts b/server/src/api/sites/getSite.ts
index 7e4deb6be..615696d44 100644
--- a/server/src/api/sites/getSite.ts
+++ b/server/src/api/sites/getSite.ts
@@ -46,6 +46,14 @@ export async function getSite(request: FastifyRequest<GetSiteParams>, reply: Fas
public: site.public,
blockBots: site.blockBots,
isOwner: isOwner,
+ // Analytics features
+ sessionReplay: site.sessionReplay,
+ webVitals: site.webVitals,
+ trackErrors: site.trackErrors,
+ trackOutbound: site.trackOutbound,
+ trackUrlParams: site.trackUrlParams,
+ trackInitialPageView: site.trackInitialPageView,
+ trackSpaNavigation: site.trackSpaNavigation,
});
} catch (error) {
console.error("Error retrieving site:", error);