Function activateRateLimiter

apps/api/src/utils/rate-limiter.ts:4–46

({
  fastify,
  max,
  timeWindow,
  keyGenerator,
}: {
  fastify: FastifyInstance;
  max: number;
  timeWindow?: string;
  keyGenerator?: (req: T) => string | undefined;
})

import type { FastifyInstance, FastifyRequest } from 'fastify';

export async function activateRateLimiter<T extends FastifyRequest>({
  fastify,
  max,
  timeWindow,
  keyGenerator,
}: {
  fastify: FastifyInstance;
  max: number;
  timeWindow?: string;
  keyGenerator?: (req: T) => string | undefined;
}) {
  await fastify.register(import('@fastify/rate-limit'), {
    max,
    timeWindow: timeWindow || '1 minute',
    errorResponseBuilder: (req, reply) => {
      return {
        statusCode: 429,
        error: 'Too Many Requests',
        message: 'You have exceeded the rate limit for this endpoint.',
      };
    },
    // In test mode use in-memory storage so tests don't need a running Redis
    redis: process.env.NODE_ENV !== 'test' ? getRedisCache() : undefined,
    keyGenerator(req) {
      if (keyGenerator) {
        const key = keyGenerator(req as T);
        if (key) {
          return key;
        }
      }
      return (req.headers['openpanel-client-id'] ||
        req.headers['x-real-ip'] ||
        req.headers['x-client-ip'] ||
        req.headers['x-forwarded-for']) as string;
    },
    onExceeded: (req, reply) => {
      req.log.warn(
        { clientId: req.headers['openpanel-client-id'] },
        'Rate limit exceeded',
      );
    },
  });
}