Skip to content

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

3.6 KB
Raw Blame
import { FastifyReply, FastifyRequest } from "fastify";
import { z } from "zod";
import { siteConfig, type SiteConfigData } from "../../lib/siteConfig.js";

const siteParamsSchema = z.object({
  siteId: z.string().min(1),
});

/**
 * The Site Configuration fields these endpoints expose. Each is returned under
 * its own name, which is also the field name — the response key cannot drift
 * from the field being read.
 */
type ExclusionField = Extract<
  keyof SiteConfigData,
  | "excludedIPs"
  | "excludedCountries"
  | "excludedPaths"
  | "excludedHostnames"
  | "excludedUserAgents"
  | "excludedASNs"
  | "excludedQueryParams"
>;

// The API playground surfaces error bodies verbatim, so these read as prose.
// Exhaustive by type — a new exclusion field will not compile without one.
const FIELD_LABELS: Record<ExclusionField, string> = {
  excludedIPs: "excluded IPs",
  excludedCountries: "excluded countries",
  excludedPaths: "excluded paths",
  excludedHostnames: "excluded hostnames",
  excludedUserAgents: "excluded user agents",
  excludedASNs: "excluded ASNs",
  excludedQueryParams: "excluded query params",
};

/**
 * Read one exclusion list for a Site and return it under its own field name.
 * Shared by all seven exclusion GET endpoints.
 */
async function getExclusionField(request: FastifyRequest, reply: FastifyReply, field: ExclusionField) {
  try {
    const validationResult = siteParamsSchema.safeParse(request.params);

    if (!validationResult.success) {
      return reply.status(400).send({
        success: false,
        error: "Invalid site ID",
        details: validationResult.error.flatten(),
      });
    }

    const numericSiteId = Number(validationResult.data.siteId);
    if (!Number.isInteger(numericSiteId) || numericSiteId <= 0) {
      return reply.status(400).send({
        success: false,
        error: "Invalid site ID: must be a positive integer",
      });
    }

    // Settings screens read back the write they just made, so this must not be
    // served from another worker's pre-write cache entry.
    const config = await siteConfig.reload(numericSiteId);

    if (!config) {
      return reply.status(404).send({
        success: false,
        error: "Site not found",
      });
    }

    return reply.send({
      success: true,
      [field]: config[field],
    });
  } catch (error) {
    request.log.error({ err: error }, `Error getting ${FIELD_LABELS[field]}`);
    return reply.status(500).send({
      success: false,
      error: `Failed to get ${FIELD_LABELS[field]}`,
    });
  }
}

export function getSiteExcludedIPs(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedIPs");
}

export function getSiteExcludedCountries(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedCountries");
}

export function getSiteExcludedPaths(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedPaths");
}

export function getSiteExcludedHostnames(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedHostnames");
}

export function getSiteExcludedUserAgents(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedUserAgents");
}

export function getSiteExcludedASNs(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedASNs");
}

export function getSiteExcludedQueryParams(request: FastifyRequest, reply: FastifyReply) {
  return getExclusionField(request, reply, "excludedQueryParams");
}