Tresdoce NestJS Toolkit
Rate-Limit

⚠️ Es importante tener en cuenta que este módulo se encuentra implementado en el package @tresdoce-nestjs-toolkit/paas, ya que es una funcionalidad core para el starter.

Este módulo está pensado para ser utilizado en NestJS Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• ⚙️ Configuración
• 👨‍💻 Uso
• 📄 Changelog
• 📜 License MIT

---

📝 Requerimientos básicos

• NestJS Starter
• Node.js v20.18.0 or higher (Download)
• YARN v1.22.19 or higher
• NPM v10.9.0 or higher
• NestJS v10.4.6 or higher (Documentación)

🛠️ Instalar dependencia

npm install -S @tresdoce-nestjs-toolkit/rate-limit

yarn add @tresdoce-nestjs-toolkit/rate-limit

⚙️ Configuración

Agregar los datos del rate limit en configuration.ts utilizando el key rateLimits en el key de server. Puedes encontrar más información en la documentación

//./src/config/configuration.ts
import { Typings } from '@tresdoce-nestjs-toolkit/core';
import { registerAs } from '@nestjs/config';

export default registerAs('config', (): Typings.AppConfig => {
  return {
    //...
    server: {
      //...
      rateLimits: {
        throttlers: [
          {
            limit: 10,
            ttl: 60,
          },
        ],
      },
    },
    //...
  };
});

RateLimitModule utiliza las opciones de ThrottlerModule para configurar las restricciones. Estas opciones se pueden pasar como un objeto ThrottlerModuleOptions que contiene:

Property	Type	Description
throttlers	Array<ThrottlerOptions>	Lista de limitadores individuales con sus propias configuraciones de límite de tasa.
skipIf	(context: ExecutionContext) => boolean	Función que omite la limitación si retorna `true.
ignoreUserAgents	RegExp[]	Lista de expresiones regulares para omitir ciertos User-Agents, como bots de motores de búsqueda.
getTracker	ThrottlerGetTrackerFunction	Función para obtener el identificador único del cliente (por ejemplo, dirección IP o ID de usuario)
generateKey	ThrottlerGenerateKeyFunction	Función para personalizar la clave de rastreo única para cada cliente.
errorMessage	string o ((context, limitDetail) => string)	Mensaje de error personalizado cuando se alcanza el límite de solicitudes.
storage	ThrottlerStorage	Mecanismo de almacenamiento usado para rastrear las solicitudes, por defecto en memoria.

Cada item (ThrottlerOptions) permite configurar un limitador específico:

Property	Type	Description
name	string	Nombre opcional para identificar el limitador de tasa.
limit	Resolvable<number>	Número máximo de solicitudes permitidas en el intervalo ttl.
ttl	Resolvable<number>	Intervalo de tiempo en segundos durante el cual se cuentan las solicitudes.
blockDuration	Resolvable<number>	Duración en segundos durante la cual se bloquea al cliente después de alcanzar el límite.
ignoreUserAgents	RegExp[]	Lista de `User-Agents que serán ignorados para este limitador.
skipIf	(context: ExecutionContext) => boolean	Función para omitir la limitación de tasa si retorna `true.
getTracker	ThrottlerGetTrackerFunction	Función para rastrear el cliente específico.
generateKey	ThrottlerGenerateKeyFunction	Personalización de la clave única que rastrea las solicitudes de cada cliente.

Ejemplos de Configuración Avanzada

• La configuración con generateKey rastrea las solicitudes por combinación de IP y ruta, permitiendo límites de tasa específicos por ruta.
• El blockDuration en la configuración, bloquea al cliente durante 5 minutos si supera el límite de 10 solicitudes en 1 minuto.
• El skipIf en la configuración, omite la limitación de tasa para usuarios administradores autenticados.

//./src/config/configuration.ts
import { Typings } from '@tresdoce-nestjs-toolkit/core';
import { registerAs } from '@nestjs/config';

export default registerAs('config', (): Typings.AppConfig => {
  return {
    //...
    server: {
      //...
      rateLimits: {
        throttlers: [
          {
            limit: 10,
            ttl: 60,
            blockDuration: 300,
          },
        ],
        skipIf: (context) => {
          const request = context.switchToHttp().getRequest();
          return request.user?.isAdmin;
        },
        generateKey: (context, trackerString) => {
          const request = context.switchToHttp().getRequest();
          return `${trackerString}-${request.route.path}`;
        },
      },
    },
    //...
  };
});

👨‍💻 Uso

Para aplicar el rate limit, puedes usar ThrottlerGuard a nivel global, controlador o ruta específica.

Aplicación Global

//./src/main.ts
import { ConfigService } from '@nestjs/config';
import { ThrottlerGuard } from '@tresdoce-nestjs-toolkit/rate-limit';

//...

async function bootstrap() {
  //...
  app.useGlobalGuards(new ThrottlerGuard());
  //...
}

O bien, se puede configurar como provider en el app.module.ts

//./src/app.module.ts
import { APP_GUARD } from '@nestjs/core';
import { ThrottlerGuard } from '@tresdoce-nestjs-toolkit/rate-limit';

@Module({
  //...
  providers: [
    //...
    {
      provide: APP_GUARD,
      useClass: ThrottlerGuard,
    },
    //...
  ],
  //...
})
export class AppModule {}

Aplicación Nivel de Controlador

import { Controller, Get, UseGuards } from '@nestjs/common';
import { ThrottlerGuard } from '@tresdoce-nestjs-toolkit/rate-limit';

@Controller('test')
@UseGuards(ThrottlerGuard)
export class TestController {
  @Get()
  getTest() {
    return 'Esta es una ruta protegida por el rate limit';
  }
}

Saltear rate limit

El decorador @SkipThrottle() se usa para omitir temporalmente el rate limit en métodos o controladores específicos que, de otro modo, estarían protegidos por el ThrottlerGuard. Esto permite marcar ciertas rutas o acciones que no deberían verse afectadas por el límite de solicitudes configurado en RateLimitModule.

@SkipThrottle()
@Controller('users')
export class UsersController {
  // Rate limiting is applied to this route.
  @SkipThrottle({ default: false })
  dontSkip() {
    return 'List users work with Rate limiting.';
  }
  // This route will skip rate limiting.
  doSkip() {
    return 'List users work without Rate limiting.';
  }
}

📄 Changelog

Todos los cambios notables de este paquete se documentarán en el archivo Changelog.

---

Made with ❤