Merge pull request #71 from DouglasNeuroInformatics/throttler

add ability for user to override default throttler config and remove old magic string implementation for login throttle

Author: joshunrau

src/app/app.factory.ts

@@ -1,6 +1,7 @@
 import type { MiddlewareConsumer, Provider, Type } from '@nestjs/common';
 import { APP_FILTER, APP_GUARD, APP_PIPE } from '@nestjs/core';
 import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
+import type { ThrottlerModuleOptions } from '@nestjs/throttler';
 import type { Simplify } from 'type-fest';
 import type { z } from 'zod/v4';
 
@@ -24,6 +25,7 @@ export type CreateAppOptions = Simplify<
     envSchema: z.ZodType<UserTypes.Env>;
     imports?: (ConditionalImport | ImportedModule)[];
     providers?: Provider[];
+    throttler?: ThrottlerModuleOptions;
   }
 >;
 
@@ -39,9 +41,26 @@ export class AppFactory {
     controllers,
     envConfig,
     imports: userImports = [],
-    providers: userProviders = []
+    providers: userProviders = [],
+    throttler = [
+      {
+        limit: 25,
+        name: 'short',
+        ttl: 1000
+      },
+      {
+        limit: 100,
+        name: 'medium',
+        ttl: 10_000
+      },
+      {
+        limit: 250,
+        name: 'long',
+        ttl: 60_000
+      }
+    ]
   }: Simplify<
-    Pick<CreateAppOptions, 'configureMiddleware' | 'controllers' | 'imports' | 'providers'> & {
+    Pick<CreateAppOptions, 'configureMiddleware' | 'controllers' | 'imports' | 'providers' | 'throttler'> & {
       envConfig: UserTypes.Env;
     }
   >): DynamicAppModule {
@@ -65,34 +84,7 @@ export class AppFactory {
     }
 
     if (envConfig.THROTTLER_ENABLED) {
-      coreImports.push(
-        ThrottlerModule.forRoot([
-          {
-            limit: 25,
-            name: 'short',
-            ttl: 1000
-          },
-          {
-            limit: 100,
-            name: 'medium',
-            ttl: 10_000
-          },
-          {
-            limit: 250,
-            name: 'long',
-            ttl: 60_000
-          },
-          {
-            limit: envConfig.LOGIN_REQUEST_TROTTLER_LIMIT ?? 50,
-            name: 'login',
-            skipIf: (context): boolean => {
-              const handler = context.getHandler();
-              return handler.name !== 'login';
-            },
-            ttl: envConfig.LOGIN_REQUEST_TROTTLER_TTL ?? 60_000
-          }
-        ])
-      );
+      coreImports.push(ThrottlerModule.forRoot(throttler));
       coreProviders.push({
         provide: APP_GUARD,
         useClass: ThrottlerGuard

src/schemas/env.schema.ts

@@ -16,8 +16,6 @@ export const $BaseEnv = z.object({
   DEBUG: $BooleanLike.optional(),
   /** enable log-level logs (default = true in development or production, false in tests) */
   LOG: $BooleanLike.optional(),
-  LOGIN_REQUEST_TROTTLER_LIMIT: $NumberLike.pipe(z.number().int().positive()).optional(),
-  LOGIN_REQUEST_TROTTLER_TTL: $NumberLike.pipe(z.number().int().positive()).optional(),
   NODE_ENV: z.enum(['development', 'production', 'test']),
   SECRET_KEY: z.string().min(16),
   THROTTLER_ENABLED: $BooleanLike.default(true),