🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Enhance site configuration management by adding tracking configuration endpoint
Bill Yang7e16c18635be
diff --git a/server/src/api/sites/changeSiteBlockBots.ts b/server/src/api/sites/changeSiteBlockBots.tsindex d650ef8ca..c55259c6b 100644--- a/server/src/api/sites/changeSiteBlockBots.ts+++ b/server/src/api/sites/changeSiteBlockBots.ts@@ -30,17 +30,8 @@ export async function changeSiteBlockBots(request: FastifyRequest<ChangeSiteBlocreturn reply.status(404).send({ error: "Site not found" });}- // Update site blockBots setting- await db- .update(sites)- .set({- blockBots: blockBots,- updatedAt: new Date().toISOString(),- })- .where(eq(sites.siteId, siteId));-// Update the site config cache- siteConfig.updateSiteBlockBotsSetting(siteId, blockBots);+ siteConfig.updateConfig(siteId, { blockBots });return reply.status(200).send({ success: true });} catch (error) {diff --git a/server/src/api/sites/changeSiteDomain.ts b/server/src/api/sites/changeSiteDomain.tsindex b571a25e5..06689ab28 100644--- a/server/src/api/sites/changeSiteDomain.ts+++ b/server/src/api/sites/changeSiteDomain.ts@@ -38,19 +38,8 @@ export async function changeSiteDomain(return reply.status(404).send({ error: "Site not found" });}- // Update the site domain- await db- .update(sites)- .set({- domain: newDomain,- name: newDomain,- updatedAt: new Date().toISOString(),- })- .where(eq(sites.siteId, siteId));-- // Reload allowed domains to update CORS configurationawait loadAllowedDomains();- siteConfig.updateSiteDomain(siteId, newDomain);+ siteConfig.updateConfig(siteId, { domain: newDomain });return reply.status(200).send({ message: "Domain updated successfully" });} catch (err) {diff --git a/server/src/api/sites/changeSitePublic.ts b/server/src/api/sites/changeSitePublic.tsindex 5b95666f9..dc8166578 100644--- a/server/src/api/sites/changeSitePublic.ts+++ b/server/src/api/sites/changeSitePublic.ts@@ -30,17 +30,7 @@ export async function changeSitePublic(request: FastifyRequest<ChangeSitePublicRreturn reply.status(404).send({ error: "Site not found" });}- // Update site public status- await db- .update(sites)- .set({- public: isPublic,- updatedAt: new Date().toISOString(),- })- .where(eq(sites.siteId, siteId));-- // Update the public sites cache- siteConfig.updateSitePublicStatus(siteId, isPublic);+ siteConfig.updateConfig(siteId, { public: isPublic });return reply.status(200).send({ success: true });} catch (error) {diff --git a/server/src/api/sites/changeSiteSalt.ts b/server/src/api/sites/changeSiteSalt.tsindex 66e000d73..ca275e3c7 100644--- a/server/src/api/sites/changeSiteSalt.ts+++ b/server/src/api/sites/changeSiteSalt.ts@@ -30,17 +30,7 @@ export async function changeSiteSalt(request: FastifyRequest<ChangeSiteSaltRequereturn reply.status(404).send({ error: "Site not found" });}- // Update site salt setting- await db- .update(sites)- .set({- saltUserIds: saltUserIds,- updatedAt: new Date().toISOString(),- })- .where(eq(sites.siteId, siteId));-- // Update the site config cache- siteConfig.updateSiteSaltSetting(siteId, saltUserIds);+ siteConfig.updateConfig(siteId, { saltUserIds });return reply.status(200).send({ success: true });} catch (error) {diff --git a/server/src/api/sites/getTrackingConfig.ts b/server/src/api/sites/getTrackingConfig.tsnew file mode 100644index 000000000..4e44b75a2--- /dev/null+++ b/server/src/api/sites/getTrackingConfig.ts@@ -0,0 +1,20 @@+import { FastifyReply, FastifyRequest } from "fastify";+import { siteConfig } from "../../lib/siteConfig.js";++export async function getTrackingConfig(request: FastifyRequest<{ Params: { siteId: string } }>, reply: FastifyReply) {+ try {+ const config = await siteConfig.getConfig(request.params.siteId);+ return reply.send({+ sessionReplay: config?.sessionReplay,+ webVitals: config?.webVitals,+ trackErrors: config?.trackErrors,+ trackOutbound: config?.trackOutbound,+ trackUrlParams: config?.trackUrlParams,+ trackInitialPageView: config?.trackInitialPageView,+ trackSpaNavigation: config?.trackSpaNavigation,+ });+ } catch (error) {+ console.error("Error getting tracking config:", error);+ return reply.status(500).send({ error: "Failed to get tracking configuration" });+ }+}diff --git a/server/src/api/sites/updateSiteApiConfig.ts b/server/src/api/sites/updateSiteApiConfig.tsindex bee84d118..088d0f93f 100644--- a/server/src/api/sites/updateSiteApiConfig.ts+++ b/server/src/api/sites/updateSiteApiConfig.ts@@ -1,11 +1,8 @@-import { FastifyRequest, FastifyReply } from "fastify";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { eq, and } from "drizzle-orm";+import crypto from "crypto";+import { FastifyReply, FastifyRequest } from "fastify";import { z } from "zod";-import { siteConfig } from "../../lib/siteConfig.js";import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-import crypto from "crypto";+import { siteConfig } from "../../lib/siteConfig.js";// Schema for updating API configurationconst updateApiConfigSchema = z.object({@@ -56,19 +53,16 @@ export async function updateSiteApiConfig(request: FastifyRequest, reply: Fastifbreak;}- // Update the site- const updatedSite = await db.update(sites).set(updateData).where(eq(sites.siteId, parsedSiteId)).returning({- apiKey: sites.apiKey,- });-// Update the site config cacheif (action === "generate_api_key" || action === "revoke_api_key") {- siteConfig.updateSiteApiKey(parsedSiteId, updateData.apiKey);+ siteConfig.updateConfig(parsedSiteId, { apiKey: updateData.apiKey });}return reply.send({success: true,- data: updatedSite[0],+ data: {+ apiKey: updateData.apiKey,+ },});} catch (error) {console.error("Error updating site dev config:", error);diff --git a/server/src/api/sites/updateSiteExcludedIPs.ts b/server/src/api/sites/updateSiteExcludedIPs.tsindex 6daca8da6..6d8d647d0 100644--- a/server/src/api/sites/updateSiteExcludedIPs.ts+++ b/server/src/api/sites/updateSiteExcludedIPs.ts@@ -1,11 +1,8 @@import { FastifyReply, FastifyRequest } from "fastify";import { z } from "zod";-import { db } from "../../db/postgres/postgres.js";-import { sites } from "../../db/postgres/schema.js";-import { siteConfig } from "../../lib/siteConfig.js";-import { validateIPPattern } from "../../lib/ipUtils.js";import { getUserHasAccessToSite } from "../../lib/auth-utils.js";-import { eq } from "drizzle-orm";+import { validateIPPattern } from "../../lib/ipUtils.js";+import { siteConfig } from "../../lib/siteConfig.js";const updateExcludedIPsSchema = z.object({siteId: z.string().min(1),@@ -62,21 +59,7 @@ export async function updateSiteExcludedIPs(request: FastifyRequest, reply: Fast});}- // Update the database and cache atomically- await db.transaction(async tx => {- // Update the database- await tx- .update(sites)- .set({- excludedIPs: excludedIPs,- updatedAt: new Date().toISOString(),- })- .where(eq(sites.siteId, numericSiteId));-- // Update the cache - if this fails, the transaction will rollback- siteConfig.updateSiteExcludedIPs(numericSiteId, excludedIPs);- });-+ siteConfig.updateConfig(numericSiteId, { excludedIPs });return reply.send({success: true,message: "Excluded IPs updated successfully",diff --git a/server/src/db/postgres/schema.ts b/server/src/db/postgres/schema.tsindex d2008bd44..7a942cb30 100644--- a/server/src/db/postgres/schema.ts+++ b/server/src/db/postgres/schema.ts@@ -66,6 +66,13 @@ export const sites = pgTable(saltUserIds: boolean().default(false),blockBots: boolean().default(true).notNull(),excludedIPs: jsonb("excluded_ips").default([]), // Array of IP addresses/ranges to exclude+ sessionReplay: boolean().default(false),+ webVitals: boolean().default(false),+ trackErrors: boolean().default(false),+ trackOutbound: boolean().default(true),+ trackUrlParams: boolean().default(true),+ trackInitialPageView: boolean().default(true),+ trackSpaNavigation: boolean().default(true),apiKey: text("api_key"), // Format: rb_{32_hex_chars} = 35 chars total},table => [diff --git a/server/src/index.ts b/server/src/index.tsindex abaca339b..1f36df264 100644--- a/server/src/index.ts+++ b/server/src/index.ts@@ -76,6 +76,7 @@ import { trackEvent } from "./services/tracker/trackEvent.js";// need to import telemetry service here to start itimport { telemetryService } from "./services/telemetryService.js";import { extractSiteId } from "./utils.js";+import { getTrackingConfig } from "./api/sites/getTrackingConfig.js";const __filename = fileURLToPath(import.meta.url);const __dirname = dirname(__filename);@@ -207,6 +208,7 @@ const PUBLIC_ROUTES: string[] = ["/api/stripe/webhook","/api/session-replay/record","/api/admin/telemetry",+ "/api/site/:siteId/tracking-config",];// Define analytics routes that can be public@@ -346,6 +348,7 @@ server.get("/api/get-sites-from-org/:organizationId", getSitesFromOrg);server.get("/api/get-site/:id", getSite);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);diff --git a/server/src/lib/siteConfig.ts b/server/src/lib/siteConfig.tsindex 9e17dfa73..0144d3ebd 100644--- a/server/src/lib/siteConfig.ts+++ b/server/src/lib/siteConfig.ts@@ -14,6 +14,13 @@ interface SiteConfigData {blockBots: boolean;excludedIPs: string[];apiKey?: string | null;+ sessionReplay: boolean;+ webVitals: boolean;+ trackErrors: boolean;+ trackOutbound: boolean;+ trackUrlParams: boolean;+ trackInitialPageView: boolean;+ trackSpaNavigation: boolean;}class SiteConfig {@@ -31,7 +38,7 @@ class SiteConfig {try {const isNumeric = this.isNumericId(siteIdOrId);- const site = await db+ const [site] = await db.select({id: sites.id,siteId: sites.siteId,@@ -41,24 +48,38 @@ class SiteConfig {blockBots: sites.blockBots,excludedIPs: sites.excludedIPs,apiKey: sites.apiKey,+ sessionReplay: sites.sessionReplay,+ webVitals: sites.webVitals,+ trackErrors: sites.trackErrors,+ trackOutbound: sites.trackOutbound,+ trackUrlParams: sites.trackUrlParams,+ trackInitialPageView: sites.trackInitialPageView,+ trackSpaNavigation: sites.trackSpaNavigation,}).from(sites).where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId))).limit(1);- if (!site[0]) {+ if (!site) {return undefined;}return {- id: site[0].id,- siteId: site[0].siteId,- public: site[0].public || false,- saltUserIds: site[0].saltUserIds || false,- domain: site[0].domain || "",- blockBots: site[0].blockBots === undefined ? true : site[0].blockBots,- excludedIPs: Array.isArray(site[0].excludedIPs) ? site[0].excludedIPs : [],- apiKey: site[0].apiKey,+ id: site.id,+ siteId: site.siteId,+ public: site.public || false,+ saltUserIds: site.saltUserIds || false,+ domain: site.domain || "",+ blockBots: site.blockBots === undefined ? true : site.blockBots,+ excludedIPs: Array.isArray(site.excludedIPs) ? site.excludedIPs : [],+ apiKey: site.apiKey,+ sessionReplay: site.sessionReplay || false,+ webVitals: site.webVitals || false,+ trackErrors: site.trackErrors || false,+ trackOutbound: site.trackOutbound || true,+ trackUrlParams: site.trackUrlParams || true,+ trackInitialPageView: site.trackInitialPageView || true,+ trackSpaNavigation: site.trackSpaNavigation || true,};} catch (error) {logger.error(error as Error, `Error fetching site configuration for ${siteIdOrId}`);@@ -66,7 +87,6 @@ class SiteConfig {}}-/*** Get the full site configuration*/@@ -75,99 +95,15 @@ class SiteConfig {return this.getSiteByAnyId(siteIdOrId);}- /**- * Update the public status of a site- */- async updateSitePublicStatus(siteIdOrId: number | string, isPublic: boolean): Promise<void> {- try {- const isNumeric = this.isNumericId(siteIdOrId);-- await db- .update(sites)- .set({ public: isPublic })- .where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));- } catch (error) {- logger.error(error as Error, `Error updating public status for site ${siteIdOrId}`);- }- }-- /**- * Update the salt user IDs setting of a site- */- async updateSiteSaltSetting(siteIdOrId: number | string, saltUserIds: boolean): Promise<void> {- try {- const isNumeric = this.isNumericId(siteIdOrId);-- await db- .update(sites)- .set({ saltUserIds })- .where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));- } catch (error) {- logger.error(error as Error, `Error updating salt setting for site ${siteIdOrId}`);- }- }-- /**- * Update the bot blocking setting of a site- */- async updateSiteBlockBotsSetting(siteIdOrId: number | string, blockBots: boolean): Promise<void> {- try {- const isNumeric = this.isNumericId(siteIdOrId);-- await db- .update(sites)- .set({ blockBots })- .where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));- } catch (error) {- logger.error(error as Error, `Error updating block bots setting for site ${siteIdOrId}`);- }- }-- /**- * Update the domain of a site- */- async updateSiteDomain(siteIdOrId: number | string, domain: string): Promise<void> {- try {- const isNumeric = this.isNumericId(siteIdOrId);-- await db- .update(sites)- .set({ domain })- .where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));- } catch (error) {- logger.error(error as Error, `Error updating domain for site ${siteIdOrId}`);- }- }-- /**- * Update the API key of a site- */- async updateSiteApiKey(siteIdOrId: number | string, apiKey: string | null): Promise<void> {- try {- const isNumeric = this.isNumericId(siteIdOrId);-- await db- .update(sites)- .set({ apiKey })- .where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));- } catch (error) {- logger.error(error as Error, `Error updating API key for site ${siteIdOrId}`);- }- }-- /**- * Update the excluded IPs of a site- */- async updateSiteExcludedIPs(siteIdOrId: number | string, excludedIPs: string[]): Promise<void> {+ async updateConfig(siteIdOrId: number | string, config: Partial<SiteConfigData>): Promise<void> {try {const isNumeric = this.isNumericId(siteIdOrId);-await db.update(sites)- .set({ excludedIPs })+ .set(config).where(isNumeric ? eq(sites.siteId, Number(siteIdOrId)) : eq(sites.id, String(siteIdOrId)));} catch (error) {- logger.error(error as Error, `Error updating excluded IPs for site ${siteIdOrId}`);+ logger.error(error as Error, `Error updating site configuration for ${siteIdOrId}`);}}diff --git a/server/src/services/shared/requestValidation.test.ts b/server/src/services/shared/requestValidation.test.tsindex 5ed70173d..888536604 100644--- a/server/src/services/shared/requestValidation.test.ts+++ b/server/src/services/shared/requestValidation.test.ts@@ -10,6 +10,14 @@ interface SiteConfigData {saltUserIds: boolean;blockBots: boolean;excludedIPs: string[];+ sessionReplay: boolean;+ webVitals: boolean;+ errors: boolean;+ outbound: boolean;+ trackOutbound: boolean;+ trackUrlParams: boolean;+ trackInitialPageView: boolean;+ trackSpaNavigation: boolean;}// Mock dependencies@@ -69,6 +77,14 @@ describe("validateApiKey", () => {saltUserIds: false,blockBots: true,excludedIPs: [],+ sessionReplay: false,+ webVitals: false,+ errors: false,+ outbound: true,+ trackOutbound: true,+ trackUrlParams: true,+ trackInitialPageView: true,+ trackSpaNavigation: true,};vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);@@ -94,6 +110,14 @@ describe("validateApiKey", () => {saltUserIds: false,blockBots: true,excludedIPs: [],+ sessionReplay: false,+ webVitals: false,+ errors: false,+ outbound: true,+ trackOutbound: true,+ trackUrlParams: true,+ trackInitialPageView: true,+ trackSpaNavigation: true,};vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);@@ -113,6 +137,14 @@ describe("validateApiKey", () => {saltUserIds: false,blockBots: true,excludedIPs: [],+ sessionReplay: false,+ webVitals: false,+ errors: false,+ outbound: true,+ trackOutbound: true,+ trackUrlParams: true,+ trackInitialPageView: true,+ trackSpaNavigation: true,};vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);@@ -124,7 +156,7 @@ describe("validateApiKey", () => {it("should handle site with no API key configured", async () => {const mockSite: Partial<SiteConfigData> &- Pick<SiteConfigData, "id" | "siteId" | "domain" | "public" | "saltUserIds" | "blockBots" | "excludedIPs"> = {+ Pick<SiteConfigData, "id" | "siteId" | "domain" | "public" | "saltUserIds" | "blockBots" | "excludedIPs" | "sessionReplay" | "webVitals" | "errors" | "outbound" | "trackOutbound" | "trackUrlParams" | "trackInitialPageView" | "trackSpaNavigation"> = {id: "test-id",siteId: 1,domain: "example.com",@@ -132,6 +164,14 @@ describe("validateApiKey", () => {saltUserIds: false,blockBots: true,excludedIPs: [],+ sessionReplay: false,+ webVitals: false,+ errors: false,+ outbound: true,+ trackOutbound: true,+ trackUrlParams: true,+ trackInitialPageView: true,+ trackSpaNavigation: true,}; // No apiKey propertyvi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite as SiteConfigData);