Merge pull request #62 from ozkanonur/devtest

Devtest

Author: onur-ozkan

README.md

@@ -147,7 +147,12 @@ public async signUp() {
 ```ts
 import { RateLimit } from 'nestjs-rate-limiter';
 
-@RateLimit({ keyPrefix: () => programmaticFuncThatReturnsValue(), points: 1, duration: 60, errorMessage: 'You can only request 1 in a minute by giving access token' })
+@RateLimit({
+  keyPrefix: () => programmaticFuncThatReturnsValue(),
+  points: 1,
+  duration: 60,
+  customResponseSchema: () => { return { timestamp: '1611479696', message: 'Request has been blocked' }}
+})
 @Get('/example')
 public async example() {
     console.log('hello');
@@ -186,7 +191,8 @@ The usage of the limiter options is as in the code block below. For an explanati
             execEvenlyMinDelayMs: undefined,
             indexKeyPrefix: {},
             maxQueueSize: 100,
-            errorMessage: 'Rate limit exceeded'
+            errorMessage: 'Rate limit exceeded',
+            customResponseSchema: undefined
         }),
     ],
     providers: [
@@ -431,6 +437,13 @@ GraphQLModule.forRoot({
 
   errorMessage option can change the error message of rate limiter exception.
 
+  #### ● customResponseSchema
+  <code> Default: undefined </code>
+  <br>
+  <code> Type: string</code>
+  <br>
+
+  customResponseSchema option allows to provide customizable response schemas
 # Benchmarks
 
 1000 concurrent clients with maximum 2000 requests per sec during 30 seconds.

lib/default-options.spec.ts

@@ -29,5 +29,6 @@ describe('defaultRateLimiterOptions', () => {
 		expect(Object.keys(defaultRateLimiterOptions.indexKeyPrefix).length).toBe(0)
 		expect(defaultRateLimiterOptions.maxQueueSize).toBe(100)
 		expect(defaultRateLimiterOptions.errorMessage).toBe('Rate limit exceeded')
+		expect(defaultRateLimiterOptions.customResponseSchema).toBeUndefined()
 	})
 })

lib/default-options.ts

@@ -24,5 +24,6 @@ export const defaultRateLimiterOptions: RateLimiterOptions = {
 	execEvenlyMinDelayMs: undefined,
 	indexKeyPrefix: {},
 	maxQueueSize: 100,
-	errorMessage: 'Rate limit exceeded'
+	errorMessage: 'Rate limit exceeded',
+	customResponseSchema: undefined
 }

lib/rate-limiter.interceptor.ts

@@ -191,8 +191,9 @@ export class RateLimiterInterceptor implements NestInterceptor {
 			}
 		} catch (rateLimiterResponse) {
 			response.header('Retry-After', Math.ceil(rateLimiterResponse.msBeforeNext / 1000))
-			if (typeof this.options.createErrorBody === 'function') {
-				throw new HttpException(this.options.createErrorBody(rateLimiterResponse), HttpStatus.TOO_MANY_REQUESTS)
+			if (typeof this.spesificOptions?.customResponseSchema === 'function' || typeof this.options.customResponseSchema === 'function') {
+				var errorBody = this.spesificOptions?.customResponseSchema || this.options.customResponseSchema;
+				throw new HttpException(errorBody(rateLimiterResponse), HttpStatus.TOO_MANY_REQUESTS)
 			} else {
 				throw new HttpException(this.spesificOptions?.errorMessage || this.options.errorMessage, HttpStatus.TOO_MANY_REQUESTS)
 			}

lib/rate-limiter.interface.ts

@@ -27,7 +27,7 @@ export interface RateLimiterOptions {
 	indexKeyPrefix?: {}
 	maxQueueSize?: number
 	errorMessage?: string
-	createErrorBody?: (rateLimiterResponse: RateLimiterRes) => {}
+	customResponseSchema?: (rateLimiterResponse: RateLimiterRes) => {}
 }
 
 export interface RateLimiterOptionsFactory {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-rate-limiter",
-  "version": "2.6.5",
+  "version": "2.7.0",
   "description": "Highly configurable rate limiter library",
   "repository": {
     "type": "git",