🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor site configuration handling to use unified getConfig method
Bill Yangb6d909d0800d
diff --git a/server/src/api/sessionReplay/recordSessionReplay.ts b/server/src/api/sessionReplay/recordSessionReplay.tsindex f6466a0e1..43c09decf 100644--- a/server/src/api/sessionReplay/recordSessionReplay.ts+++ b/server/src/api/sessionReplay/recordSessionReplay.ts@@ -37,7 +37,8 @@ export async function recordSessionReplay() {try {// Get the site configuration to get the numeric siteId- const siteId = (await siteConfig.getSiteConfig(request.params.site))?.siteId;+ const { siteId, excludedIPs } = (await siteConfig.getConfig(request.params.site)) ?? {};+if (!siteId) {throw new Error(`Site not found: ${request.params.site}`);}@@ -80,7 +81,7 @@ export async function recordSessionReplay(// Check if the IP should be excluded from trackingconst requestIP = getIpAddress(request);- if (await siteConfig.isIPExcluded(requestIP, siteId)) {+ if (excludedIPs && excludedIPs.includes(requestIP)) {logger.info(`[SessionReplay] IP ${requestIP} excluded from tracking for site ${siteId}`);return reply.status(200).send({success: true,diff --git a/server/src/api/sites/getSiteApiConfig.ts b/server/src/api/sites/getSiteApiConfig.tsindex 4fd43f1d2..b48a3c7f9 100644--- a/server/src/api/sites/getSiteApiConfig.ts+++ b/server/src/api/sites/getSiteApiConfig.ts@@ -4,13 +4,13 @@ import { sites } from "../../db/postgres/schema.js";import { eq, and } from "drizzle-orm";import { getUserHasAdminAccessToSite } from "../../lib/auth-utils.js";-export async function getSiteApiConfig(request: FastifyRequest, reply: FastifyReply) {+export async function getSiteApiConfig(request: FastifyRequest<{ Params: { siteId: string } }>, reply: FastifyReply) {try {if (!request.user) {return reply.status(401).send({ success: false, error: "Unauthorized" });}- const { siteId } = request.params as { siteId: string };+ const { siteId } = request.params;const parsedSiteId = parseInt(siteId, 10);if (isNaN(parsedSiteId)) {diff --git a/server/src/api/sites/getSiteIsPublic.ts b/server/src/api/sites/getSiteIsPublic.tsindex 8a283b16b..07a1fe5a9 100644--- a/server/src/api/sites/getSiteIsPublic.ts+++ b/server/src/api/sites/getSiteIsPublic.ts@@ -3,6 +3,7 @@ import { siteConfig } from "../../lib/siteConfig.js";export async function getSiteIsPublic(request: FastifyRequest<{ Params: { site: string } }>, reply: FastifyReply) {const { site } = request.params;- const isPublic = await siteConfig.isSitePublic(site);+ const config = await siteConfig.getConfig(site);+ const isPublic = config?.public || false;return reply.status(200).send({ isPublic });}diff --git a/server/src/index.ts b/server/src/index.tsindex 8b028777b..abaca339b 100644--- a/server/src/index.ts+++ b/server/src/index.ts@@ -75,7 +75,7 @@ import { siteConfig } from "./lib/siteConfig.js";import { trackEvent } from "./services/tracker/trackEvent.js";// need to import telemetry service here to start itimport { telemetryService } from "./services/telemetryService.js";-import { extractSiteId, isSitePublic } from "./utils.js";+import { extractSiteId } from "./utils.js";const __filename = fileURLToPath(import.meta.url);const __dirname = dirname(__filename);@@ -262,7 +262,7 @@ server.addHook("onRequest", async (request, reply) => {if (ANALYTICS_ROUTES.some(route => processedUrl.startsWith(route))) {const siteId = extractSiteId(processedUrl);- if (siteId && (await isSitePublic(siteId))) {+ if (siteId && (await siteConfig.getConfig(siteId))?.public) {// Skip auth check for public sitesreturn;}diff --git a/server/src/lib/auth-utils.ts b/server/src/lib/auth-utils.tsindex 059ce54c9..69fcb12b8 100644--- a/server/src/lib/auth-utils.ts+++ b/server/src/lib/auth-utils.ts@@ -1,10 +1,10 @@+import { and, eq, inArray } from "drizzle-orm";import { FastifyRequest } from "fastify";-import { auth } from "./auth.js";-import { sites, member, user } from "../db/postgres/schema.js";-import { inArray, eq, and } from "drizzle-orm";-import { db } from "../db/postgres/postgres.js";-import { isSitePublic } from "../utils.js";import NodeCache from "node-cache";+import { db } from "../db/postgres/postgres.js";+import { member, sites, user } from "../db/postgres/schema.js";+import { auth } from "./auth.js";+import { siteConfig } from "./siteConfig.js";export function mapHeaders(headers: any) {const entries = Object.entries(headers);@@ -111,7 +111,10 @@ export async function getSitesUserHasAccessTo(req: FastifyRequest, adminOnly = f// for routes that are potentially publicexport async function getUserHasAccessToSitePublic(req: FastifyRequest, siteId: string | number) {- const [sites, isPublic] = await Promise.all([getSitesUserHasAccessTo(req), isSitePublic(siteId)]);+ const [sites, isPublic] = await Promise.all([+ getSitesUserHasAccessTo(req),+ (await siteConfig.getConfig(siteId))?.public,+ ]);return sites.some(site => site.siteId === Number(siteId)) || isPublic;}diff --git a/server/src/lib/siteConfig.ts b/server/src/lib/siteConfig.tsindex d876e5857..9e17dfa73 100644--- a/server/src/lib/siteConfig.ts+++ b/server/src/lib/siteConfig.ts@@ -66,47 +66,11 @@ class SiteConfig {}}- /**- * Check if a site is public- */- async isSitePublic(siteIdOrId?: string | number): Promise<boolean> {- if (!siteIdOrId) return false;- const config = await this.getSiteByAnyId(siteIdOrId);- return config?.public || false;- }-- /**- * Check if a site has user ID salting enabled- */- async shouldSaltUserIds(siteIdOrId?: string | number): Promise<boolean> {- if (!siteIdOrId) return false;- const config = await this.getSiteByAnyId(siteIdOrId);- return config?.saltUserIds || false;- }-- /**- * Check if a site has bot blocking enabled- */- async shouldBlockBots(siteIdOrId?: string | number): Promise<boolean> {- if (!siteIdOrId) return true; // Default to blocking bots if no site specified- const config = await this.getSiteByAnyId(siteIdOrId);- // Default to true if configuration is not found (safeguard)- return config?.blockBots !== false;- }-- /**- * Get the domain of a site- */- async getSiteDomain(siteIdOrId?: string | number): Promise<string> {- if (!siteIdOrId) return "";- const config = await this.getSiteByAnyId(siteIdOrId);- return config?.domain || "";- }/*** Get the full site configuration*/- async getSiteConfig(siteIdOrId?: string | number): Promise<SiteConfigData | undefined> {+ async getConfig(siteIdOrId?: string | number): Promise<SiteConfigData | undefined> {if (!siteIdOrId) return undefined;return this.getSiteByAnyId(siteIdOrId);}@@ -191,15 +155,6 @@ class SiteConfig {}}- /**- * Get excluded IPs for a site- */- async getExcludedIPs(siteIdOrId?: string | number): Promise<string[]> {- if (!siteIdOrId) return [];- const config = await this.getSiteByAnyId(siteIdOrId);- return config?.excludedIPs || [];- }-/*** Update the excluded IPs of a site*/@@ -255,7 +210,8 @@ class SiteConfig {*/async isIPExcluded(ipAddress: string, siteIdOrId?: string | number): Promise<boolean> {if (!siteIdOrId) return false; // If no site specified, don't exclude any IPs- const excludedIPs = await this.getExcludedIPs(siteIdOrId);+ const config = await this.getSiteByAnyId(siteIdOrId);+ const excludedIPs = config?.excludedIPs || [];if (!excludedIPs || excludedIPs.length === 0) {return false;}diff --git a/server/src/services/shared/requestValidation.test.ts b/server/src/services/shared/requestValidation.test.tsindex ec6c93d58..5ed70173d 100644--- a/server/src/services/shared/requestValidation.test.ts+++ b/server/src/services/shared/requestValidation.test.ts@@ -51,11 +51,11 @@ describe("validateApiKey", () => {});it("should return success false when site is not found", async () => {- vi.mocked(siteConfig.getSiteConfig).mockResolvedValue(undefined);+ vi.mocked(siteConfig.getConfig).mockResolvedValue(undefined);const result = await validateApiKey(1, "test-api-key");- expect(siteConfig.getSiteConfig).toHaveBeenCalledWith(1);+ expect(siteConfig.getConfig).toHaveBeenCalledWith(1);expect(result).toEqual({ success: false, error: "Site not found" });});@@ -71,7 +71,7 @@ describe("validateApiKey", () => {excludedIPs: [],};- vi.mocked(siteConfig.getSiteConfig).mockResolvedValue(mockSite);+ vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);// Mock console.info to avoid output during testsconst consoleSpy = vi.spyOn(console, "info").mockImplementation(() => {});@@ -96,7 +96,7 @@ describe("validateApiKey", () => {excludedIPs: [],};- vi.mocked(siteConfig.getSiteConfig).mockResolvedValue(mockSite);+ vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);const result = await validateApiKey(1, "invalid-api-key");@@ -115,11 +115,11 @@ describe("validateApiKey", () => {excludedIPs: [],};- vi.mocked(siteConfig.getSiteConfig).mockResolvedValue(mockSite);+ vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite);await validateApiKey("123", "test-key");- expect(siteConfig.getSiteConfig).toHaveBeenCalledWith(123);+ expect(siteConfig.getConfig).toHaveBeenCalledWith(123);});it("should handle site with no API key configured", async () => {@@ -134,7 +134,7 @@ describe("validateApiKey", () => {excludedIPs: [],}; // No apiKey property- vi.mocked(siteConfig.getSiteConfig).mockResolvedValue(mockSite as SiteConfigData);+ vi.mocked(siteConfig.getConfig).mockResolvedValue(mockSite as SiteConfigData);const result = await validateApiKey(1, "any-key");@@ -142,7 +142,7 @@ describe("validateApiKey", () => {});it("should handle errors during validation", async () => {- vi.mocked(siteConfig.getSiteConfig).mockRejectedValue(new Error("Database error"));+ vi.mocked(siteConfig.getConfig).mockRejectedValue(new Error("Database error"));const consoleSpy = vi.spyOn(console, "error").mockImplementation(() => {});diff --git a/server/src/services/shared/requestValidation.ts b/server/src/services/shared/requestValidation.tsindex 9c29e7c35..fe7ac653b 100644--- a/server/src/services/shared/requestValidation.ts+++ b/server/src/services/shared/requestValidation.ts@@ -35,7 +35,7 @@ export async function validateApiKey(siteId: string | number, apiKey?: string):try {const numericSiteId = typeof siteId === "string" ? parseInt(siteId, 10) : siteId;- const site = await siteConfig.getSiteConfig(numericSiteId);+ const site = await siteConfig.getConfig(numericSiteId);if (!site) {return { success: false, error: "Site not found" };diff --git a/server/src/services/tracker/trackEvent.ts b/server/src/services/tracker/trackEvent.tsindex 636dabb0b..9ec1b9f16 100644--- a/server/src/services/tracker/trackEvent.ts+++ b/server/src/services/tracker/trackEvent.ts@@ -244,7 +244,7 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {}// Get the site configuration to get the numeric siteId- const siteConfiguration = await siteConfig.getSiteConfig(validatedPayload.site_id);+ const siteConfiguration = await siteConfig.getConfig(validatedPayload.site_id);if (!siteConfiguration) {logger.warn({ siteId: validatedPayload.site_id }, "Site not found");return reply.status(404).send({diff --git a/server/src/services/userId/userIdService.ts b/server/src/services/userId/userIdService.tsindex 5dc432e60..0c28e4013 100644--- a/server/src/services/userId/userIdService.ts+++ b/server/src/services/userId/userIdService.ts@@ -49,7 +49,8 @@ class UserIdService {*/async generateUserId(ip: string, userAgent: string, siteId: number): Promise<string> {// Only apply salt if the site has salting enabled- if (await siteConfig.shouldSaltUserIds(siteId)) {+ const config = await siteConfig.getConfig(siteId);+ if (config && config.saltUserIds) {const dailySalt = this.getDailySalt(); // Get the salt for the current dayreturn crypto.createHash("sha256")diff --git a/server/src/utils.ts b/server/src/utils.tsindex c566b48bb..eefffaae3 100644--- a/server/src/utils.ts+++ b/server/src/utils.ts@@ -1,5 +1,4 @@import { FastifyRequest } from "fastify";-import { siteConfig } from "./lib/siteConfig.js";import * as psl from "psl";const desktopOS = new Set([@@ -121,17 +120,6 @@ export function getDeviceType(screenWidth: number, screenHeight: number, ua: UAPreturn "Mobile";}-// Check if a site is public-export const isSitePublic = async (siteId: string | number) => {- try {- // Use the cached value- return await siteConfig.isSitePublic(siteId);- } catch (err) {- console.error("Error checking if site is public:", err);- return false;- }-};-// Extract site ID from pathexport const extractSiteId = (path: string) => {// Remove query parameters if present