🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor site configuration management to use a unified updateSiteConfig function
Bill Yang3bb2dd937307
diff --git a/client/src/api/admin/excludedIPs.ts b/client/src/api/admin/excludedIPs.tsindex 3bb1f1108..8375fcf82 100644--- a/client/src/api/admin/excludedIPs.ts+++ b/client/src/api/admin/excludedIPs.ts@@ -1,6 +1,7 @@import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";import { toast } from "sonner";import { authedFetch } from "../utils";+import { updateSiteConfig } from "./sites";export interface ExcludedIPsResponse {success: boolean;@@ -26,15 +27,15 @@ export const fetchExcludedIPs = async (siteId: string): Promise<ExcludedIPsResporeturn await authedFetch<ExcludedIPsResponse>(`/site/${siteId}/excluded-ips`);};-// Update excluded IPs for a site+// Update excluded IPs for a site using the consolidated endpointexport const updateExcludedIPs = async (siteId: number, excludedIPs: string[]): Promise<UpdateExcludedIPsResponse> => {- return await authedFetch<UpdateExcludedIPsResponse>(`/site/${siteId}/excluded-ips`, undefined, {- method: "POST",- data: {- siteId: siteId.toString(),- excludedIPs,- },- });+ const result = await updateSiteConfig(siteId, { excludedIPs });+ // Map the response to match the expected interface+ return {+ success: true,+ message: "Excluded IPs updated successfully",+ excludedIPs: excludedIPs,+ };};// Hook to fetch excluded IPsdiff --git a/client/src/api/admin/sites.ts b/client/src/api/admin/sites.tsindex 45bbde678..ff558128e 100644--- a/client/src/api/admin/sites.ts+++ b/client/src/api/admin/sites.ts@@ -98,12 +98,29 @@ export function deleteSite(siteId: number) {});}-export function changeSiteDomain(siteId: number, newDomain: string) {- return authedFetch("/change-site-domain", undefined, {+// Consolidated function to update any site configuration+export function updateSiteConfig(+ siteId: number,+ config: {+ domain?: string;+ public?: boolean;+ saltUserIds?: boolean;+ blockBots?: boolean;+ excludedIPs?: string[];+ sessionReplay?: boolean;+ webVitals?: boolean;+ trackErrors?: boolean;+ trackOutbound?: boolean;+ trackUrlParams?: boolean;+ trackInitialPageView?: boolean;+ trackSpaNavigation?: boolean;+ }+) {+ return authedFetch("/update-site-config", undefined, {method: "POST",data: {siteId,- newDomain,+ ...config,},headers: {"Content-Type": "application/json",@@ -111,18 +128,6 @@ export function changeSiteDomain(siteId: number, newDomain: string) {});}-export function changeSitePublic(siteId: number, isPublic: boolean) {- return authedFetch("/change-site-public", undefined, {- method: "POST",- data: {- siteId,- isPublic,- },- headers: {- "Content-Type": "application/json",- },- });-}export function useSiteHasData(siteId: string) {return useQuery({@@ -159,31 +164,6 @@ export function useGetSite(siteId?: string | number) {});}-export function changeSiteSalt(siteId: number, saltUserIds: boolean) {- return authedFetch("/change-site-salt", undefined, {- method: "POST",- data: {- siteId,- saltUserIds,- },- headers: {- "Content-Type": "application/json",- },- });-}--export function changeSiteBlockBots(siteId: number, blockBots: boolean) {- return authedFetch("/change-site-block-bots", undefined, {- method: "POST",- data: {- siteId,- blockBots,- },- headers: {- "Content-Type": "application/json",- },- });-}export function useGetSiteIsPublic(siteId?: string | number) {return useQuery({diff --git a/client/src/components/SiteSettings/SiteConfiguration.tsx b/client/src/components/SiteSettings/SiteConfiguration.tsxindex f80d2ef6d..b7e73ff7e 100644--- a/client/src/components/SiteSettings/SiteConfiguration.tsx+++ b/client/src/components/SiteSettings/SiteConfiguration.tsx@@ -22,12 +22,9 @@ import { Label } from "@/components/ui/label";import { Switch } from "@/components/ui/switch";import {- changeSiteBlockBots,- changeSiteDomain,- changeSitePublic,- changeSiteSalt,deleteSite,SiteResponse,+ updateSiteConfig,useGetSitesFromOrg,} from "@/api/admin/sites";import { normalizeDomain } from "@/lib/utils";@@ -62,7 +59,7 @@ export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: Stry {setIsChangingDomain(true);const normalizedDomain = normalizeDomain(newDomain);- await changeSiteDomain(siteMetadata.siteId, normalizedDomain);+ await updateSiteConfig(siteMetadata.siteId, { domain: normalizedDomain });toast.success("Domain updated successfully");router.refresh();refetch();@@ -93,7 +90,7 @@ export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: Sconst handlePublicToggle = async (checked: boolean) => {try {setIsChangingPublic(true);- await changeSitePublic(siteMetadata.siteId, checked);+ await updateSiteConfig(siteMetadata.siteId, { public: checked });setIsPublic(checked);toast.success(checked ? "Site analytics made public" : "Site analytics made private");refetch();@@ -109,7 +106,7 @@ export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: Sconst handleSaltToggle = async (checked: boolean) => {try {setIsChangingSalt(true);- await changeSiteSalt(siteMetadata.siteId, checked);+ await updateSiteConfig(siteMetadata.siteId, { saltUserIds: checked });setIsSalting(checked);toast.success(checked ? "User ID salting enabled" : "User ID salting disabled");refetch();@@ -125,7 +122,7 @@ export function SiteConfiguration({ siteMetadata, disabled = false, onClose }: Sconst handleBlockBotsToggle = async (checked: boolean) => {try {setIsChangingBlockBots(true);- await changeSiteBlockBots(siteMetadata.siteId, checked);+ await updateSiteConfig(siteMetadata.siteId, { blockBots: checked });setIsBlockingBots(checked);toast.success(checked ? "Bot blocking enabled" : "Bot blocking disabled");refetch();diff --git a/server/src/api/sites/changeSiteBlockBots.ts b/server/src/api/sites/changeSiteBlockBots.tsdeleted file mode 100644index c55259c6b..000000000--- a/server/src/api/sites/changeSiteBlockBots.ts+++ /dev/null@@ -1,41 +0,0 @@-import { eq } from "drizzle-orm";-import { FastifyReply, FastifyRequest } from "fastify";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-import { siteConfig } from "../../lib/siteConfig.js";--interface ChangeSiteBlockBotsRequest {- Body: {- siteId: number;- blockBots: boolean;- };-}--export async function changeSiteBlockBots(request: FastifyRequest<ChangeSiteBlockBotsRequest>, reply: FastifyReply) {- const { siteId, blockBots } = request.body;-- const userHasAdminAccessToSite = await getUserHasAdminAccessToSite(request, String(siteId));- if (!userHasAdminAccessToSite) {- return reply.status(403).send({ error: "Forbidden" });- }-- try {- // Fetch site to check it exists- const site = await db.query.sites.findFirst({- where: eq(sites.siteId, siteId),- });-- if (!site) {- return reply.status(404).send({ error: "Site not found" });- }-- // Update the site config cache- siteConfig.updateConfig(siteId, { blockBots });-- return reply.status(200).send({ success: true });- } catch (error) {- console.error("Error changing site bot blocking setting:", error);- return reply.status(500).send({ error: "Internal server error" });- }-}diff --git a/server/src/api/sites/changeSiteDomain.ts b/server/src/api/sites/changeSiteDomain.tsdeleted file mode 100644index 39f26073a..000000000--- a/server/src/api/sites/changeSiteDomain.ts+++ /dev/null@@ -1,53 +0,0 @@-import { eq } from "drizzle-orm";-import { FastifyReply, FastifyRequest } from "fastify";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-import { siteConfig } from "../../lib/siteConfig.js";--export async function changeSiteDomain(- request: FastifyRequest<{- Body: {- siteId: number;- newDomain: string;- };- }>,- reply: FastifyReply-) {- const { siteId, newDomain } = request.body;-- const userHasAdminAccessToSite = await getUserHasAdminAccessToSite(request, String(siteId));- if (!userHasAdminAccessToSite) {- return reply.status(403).send({ error: "Forbidden" });- }-- // Validate domain format using regex- const domainRegex = /^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/;- if (!domainRegex.test(newDomain)) {- return reply.status(400).send({- error: "Invalid domain format. Must be a valid domain like example.com or sub.example.com",- });- }-- try {- // Check if site exists and user has permission- const siteResult = await db.select().from(sites).where(eq(sites.siteId, siteId));-- if (siteResult.length === 0) {- return reply.status(404).send({ error: "Site not found" });- }-- siteConfig.updateConfig(siteId, { domain: newDomain });-- return reply.status(200).send({ message: "Domain updated successfully" });- } catch (err) {- console.error("Error changing site domain:", err);-- // Check for unique constraint violation- if (String(err).includes('duplicate key value violates unique constraint "sites_domain_unique"')) {- return reply.status(409).send({ error: "Domain already in use" });- }-- return reply.status(500).send({ error: String(err) });- }-}diff --git a/server/src/api/sites/changeSitePublic.ts b/server/src/api/sites/changeSitePublic.tsdeleted file mode 100644index dc8166578..000000000--- a/server/src/api/sites/changeSitePublic.ts+++ /dev/null@@ -1,40 +0,0 @@-import { FastifyRequest, FastifyReply } from "fastify";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { eq } from "drizzle-orm";-import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-import { siteConfig } from "../../lib/siteConfig.js";--interface ChangeSitePublicRequest {- Body: {- siteId: number;- isPublic: boolean;- };-}--export async function changeSitePublic(request: FastifyRequest<ChangeSitePublicRequest>, reply: FastifyReply) {- const { siteId, isPublic } = request.body;-- const userHasAdminAccessToSite = await getUserHasAdminAccessToSite(request, String(siteId));- if (!userHasAdminAccessToSite) {- return reply.status(403).send({ error: "Forbidden" });- }-- try {- // Fetch site to check ownership- const site = await db.query.sites.findFirst({- where: eq(sites.siteId, siteId),- });-- if (!site) {- return reply.status(404).send({ error: "Site not found" });- }-- siteConfig.updateConfig(siteId, { public: isPublic });-- return reply.status(200).send({ success: true });- } catch (error) {- console.error("Error changing site public status:", error);- return reply.status(500).send({ error: "Internal server error" });- }-}diff --git a/server/src/api/sites/changeSiteSalt.ts b/server/src/api/sites/changeSiteSalt.tsdeleted file mode 100644index ca275e3c7..000000000--- a/server/src/api/sites/changeSiteSalt.ts+++ /dev/null@@ -1,40 +0,0 @@-import { eq } from "drizzle-orm";-import { FastifyReply, FastifyRequest } from "fastify";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-import { siteConfig } from "../../lib/siteConfig.js";--interface ChangeSiteSaltRequest {- Body: {- siteId: number;- saltUserIds: boolean;- };-}--export async function changeSiteSalt(request: FastifyRequest<ChangeSiteSaltRequest>, reply: FastifyReply) {- const { siteId, saltUserIds } = request.body;-- const userHasAdminAccessToSite = await getUserHasAdminAccessToSite(request, String(siteId));- if (!userHasAdminAccessToSite) {- return reply.status(403).send({ error: "Forbidden" });- }-- try {- // Fetch site to check it exists- const site = await db.query.sites.findFirst({- where: eq(sites.siteId, siteId),- });-- if (!site) {- return reply.status(404).send({ error: "Site not found" });- }-- siteConfig.updateConfig(siteId, { saltUserIds });-- return reply.status(200).send({ success: true });- } catch (error) {- console.error("Error changing site salt setting:", error);- return reply.status(500).send({ error: "Internal server error" });- }-}diff --git a/server/src/api/sites/updateSiteConfig.ts b/server/src/api/sites/updateSiteConfig.tsnew file mode 100644index 000000000..ea56479fa--- /dev/null+++ b/server/src/api/sites/updateSiteConfig.ts@@ -0,0 +1,156 @@+import { FastifyReply, FastifyRequest } from "fastify";+import { z } from "zod";+import { db } from "../../db/postgres/postgres.js";+import { sites } from "../../db/postgres/schema.js";+import { eq } from "drizzle-orm";+import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";+import { siteConfig } from "../../lib/siteConfig.js";+import { validateIPPattern } from "../../lib/ipUtils.js";++// Schema for the update request - all fields are optional but validated when present+const updateSiteConfigSchema = z.object({+ siteId: z.union([z.string(), z.number()]).transform(val => {+ const num = typeof val === 'number' ? val : parseInt(val as string, 10);+ if (isNaN(num) || num <= 0) {+ throw new z.ZodError([{+ code: z.ZodIssueCode.custom,+ message: "Invalid site ID: must be a positive integer",+ path: ["siteId"]+ }]);+ }+ return num;+ }),+ // Site settings+ public: z.boolean().optional(),+ saltUserIds: z.boolean().optional(),+ blockBots: z.boolean().optional(),+ domain: z.string()+ .regex(/^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/,+ "Invalid domain format. Must be a valid domain like example.com or sub.example.com")+ .optional(),+ excludedIPs: z.array(z.string().trim().min(1)).max(100).optional(),++ // Analytics features+ sessionReplay: z.boolean().optional(),+ webVitals: z.boolean().optional(),+ trackErrors: z.boolean().optional(),+ trackOutbound: z.boolean().optional(),+ trackUrlParams: z.boolean().optional(),+ trackInitialPageView: z.boolean().optional(),+ trackSpaNavigation: z.boolean().optional(),+});++type UpdateSiteConfigRequest = z.infer<typeof updateSiteConfigSchema>;++export async function updateSiteConfig(+ request: FastifyRequest<{ Body: UpdateSiteConfigRequest }>,+ reply: FastifyReply+) {+ try {+ // Validate request body+ const validationResult = updateSiteConfigSchema.safeParse(request.body);+ if (!validationResult.success) {+ return reply.status(400).send({+ success: false,+ error: "Invalid request data",+ details: validationResult.error.flatten(),+ });+ }++ const { siteId, ...updateData } = validationResult.data;++ // Check user permissions+ const userHasAdminAccessToSite = await getUserHasAdminAccessToSite(request, String(siteId));+ if (!userHasAdminAccessToSite) {+ return reply.status(403).send({ error: "Forbidden" });+ }++ // Check if site exists+ const site = await db.query.sites.findFirst({+ where: eq(sites.siteId, siteId),+ });++ if (!site) {+ return reply.status(404).send({ error: "Site not found" });+ }++ // Additional validation for excluded IPs if provided+ if (updateData.excludedIPs) {+ const validationErrors: string[] = [];+ for (const ip of updateData.excludedIPs) {+ const validation = validateIPPattern(ip);+ if (!validation.valid) {+ validationErrors.push(`${ip}: ${validation.error}`);+ }+ }++ if (validationErrors.length > 0) {+ return reply.status(400).send({+ success: false,+ error: "Invalid IP patterns",+ details: validationErrors,+ });+ }+ }++ // Build the update object - only include fields that were provided+ const dbUpdateData: any = {};++ // Map the fields that exist in both request and database+ const directMappings = [+ 'public', 'saltUserIds', 'blockBots', 'domain', 'excludedIPs',+ 'sessionReplay', 'webVitals', 'trackErrors', 'trackOutbound',+ 'trackUrlParams', 'trackInitialPageView', 'trackSpaNavigation'+ ];++ for (const field of directMappings) {+ if (updateData[field as keyof typeof updateData] !== undefined) {+ dbUpdateData[field] = updateData[field as keyof typeof updateData];+ }+ }++ // Only proceed if there are fields to update+ if (Object.keys(dbUpdateData).length === 0) {+ return reply.status(400).send({+ success: false,+ error: "No fields to update",+ });+ }++ // Add updatedAt timestamp+ dbUpdateData.updatedAt = new Date().toISOString();++ // Update the database+ await db+ .update(sites)+ .set(dbUpdateData)+ .where(eq(sites.siteId, siteId));++ // Update the site config cache+ await siteConfig.updateConfig(siteId, updateData);++ // Get the updated configuration to return+ const updatedConfig = await siteConfig.getConfig(siteId);++ return reply.status(200).send({+ success: true,+ message: "Site configuration updated successfully",+ config: updatedConfig,+ });+ } catch (error) {+ console.error("Error updating site configuration:", error);++ // Check for unique constraint violation on domain+ if (String(error).includes('duplicate key value violates unique constraint')) {+ return reply.status(409).send({+ success: false,+ error: "Domain already in use"+ });+ }++ return reply.status(500).send({+ success: false,+ error: "Failed to update site configuration"+ });+ }+}\ No newline at end of filediff --git a/server/src/api/sites/updateSiteExcludedIPs.ts b/server/src/api/sites/updateSiteExcludedIPs.tsdeleted file mode 100644index 6d8d647d0..000000000--- a/server/src/api/sites/updateSiteExcludedIPs.ts+++ /dev/null@@ -1,75 +0,0 @@-import { FastifyReply, FastifyRequest } from "fastify";-import { z } from "zod";-import { getUserHasAccessToSite } from "../../lib/auth-utils.js";-import { validateIPPattern } from "../../lib/ipUtils.js";-import { siteConfig } from "../../lib/siteConfig.js";--const updateExcludedIPsSchema = z.object({- siteId: z.string().min(1),- excludedIPs: z.array(z.string().trim().min(1)).max(100), // Limit to 100 IPs/ranges-});--export async function updateSiteExcludedIPs(request: FastifyRequest, reply: FastifyReply) {- try {- const validationResult = updateExcludedIPsSchema.safeParse(request.body);-- if (!validationResult.success) {- return reply.status(400).send({- success: false,- error: "Invalid request data",- details: validationResult.error.flatten(),- });- }-- const { siteId, excludedIPs } = validationResult.data;- const numericSiteId = Number(siteId);-- // Validate that siteId is a valid integer- if (!Number.isInteger(numericSiteId) || isNaN(numericSiteId) || numericSiteId <= 0) {- return reply.status(400).send({- success: false,- error: "Invalid site ID: must be a positive integer",- });- }-- // Check if user has access to this site- const hasAccess = await getUserHasAccessToSite(request, numericSiteId);-- if (!hasAccess) {- return reply.status(403).send({- success: false,- error: "Forbidden: You don't have access to this site",- });- }-- // Validate each IP pattern- const validationErrors: string[] = [];- for (const ip of excludedIPs) {- const validation = validateIPPattern(ip);- if (!validation.valid) {- validationErrors.push(`${ip}: ${validation.error}`);- }- }-- if (validationErrors.length > 0) {- return reply.status(400).send({- success: false,- error: "Invalid IP patterns",- details: validationErrors,- });- }-- siteConfig.updateConfig(numericSiteId, { excludedIPs });- return reply.send({- success: true,- message: "Excluded IPs updated successfully",- excludedIPs,- });- } catch (error) {- console.error("Error updating excluded IPs:", error);- return reply.status(500).send({- success: false,- error: "Failed to update excluded IPs",- });- }-}diff --git a/server/src/index.ts b/server/src/index.tsindex 448c67008..65505cbd3 100644--- a/server/src/index.ts+++ b/server/src/index.ts@@ -45,10 +45,7 @@ import { getSessionReplayEvents } from "./api/sessionReplay/getSessionReplayEvenimport { getSessionReplays } from "./api/sessionReplay/getSessionReplays.js";import { recordSessionReplay } from "./api/sessionReplay/recordSessionReplay.js";import { addSite } from "./api/sites/addSite.js";-import { changeSiteBlockBots } from "./api/sites/changeSiteBlockBots.js";-import { changeSiteDomain } from "./api/sites/changeSiteDomain.js";-import { changeSitePublic } from "./api/sites/changeSitePublic.js";-import { changeSiteSalt } from "./api/sites/changeSiteSalt.js";+import { updateSiteConfig } from "./api/sites/updateSiteConfig.js";import { deleteSite } from "./api/sites/deleteSite.js";import { getSite } from "./api/sites/getSite.js";import { getSiteApiConfig } from "./api/sites/getSiteApiConfig.js";@@ -57,7 +54,6 @@ import { getSiteHasData } from "./api/sites/getSiteHasData.js";import { getSiteIsPublic } from "./api/sites/getSiteIsPublic.js";import { getSitesFromOrg } from "./api/sites/getSitesFromOrg.js";import { updateSiteApiConfig } from "./api/sites/updateSiteApiConfig.js";-import { updateSiteExcludedIPs } from "./api/sites/updateSiteExcludedIPs.js";import { createCheckoutSession } from "./api/stripe/createCheckoutSession.js";import { createPortalSession } from "./api/stripe/createPortalSession.js";import { getSubscription } from "./api/stripe/getSubscription.js";@@ -332,10 +328,7 @@ server.get("/api/session-replay/:sessionId/:site", getSessionReplayEvents);// Administrativeserver.get("/api/config", getConfig);server.post("/api/add-site", addSite);-server.post("/api/change-site-domain", changeSiteDomain);-server.post("/api/change-site-public", changeSitePublic);-server.post("/api/change-site-salt", changeSiteSalt);-server.post("/api/change-site-block-bots", changeSiteBlockBots);+server.post("/api/update-site-config", updateSiteConfig);server.post("/api/delete-site/:id", deleteSite);server.get("/api/get-sites-from-org/:organizationId", getSitesFromOrg);server.get("/api/get-site/:id", getSite);@@ -343,7 +336,6 @@ server.get("/api/site/:siteId/api-config", getSiteApiConfig);server.post("/api/site/:siteId/api-config", updateSiteApiConfig);server.get("/api/site/:siteId/tracking-config", getTrackingConfig);server.get("/api/site/:siteId/excluded-ips", getSiteExcludedIPs);-server.post("/api/site/:siteId/excluded-ips", updateSiteExcludedIPs);server.get("/api/list-organization-members/:organizationId", listOrganizationMembers);server.get("/api/user/organizations", getUserOrganizations);server.post("/api/add-user-to-organization", addUserToOrganization);