v3.1.0 (#85)

* Adding getIpFromRequest method to get the request's IP (#84) * upgrade to v3.1.0 Co-authored-by: Oleksandr Bordun <[email protected]>
onur-ozkan · Dec 1, 2021 · 8fe4589 · 8fe4589
1 parent b3b9c45
commit 8fe4589
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,7 @@
   - [omitResponseHeaders](https://github.com/ozkanonur/nestjs-rate-limiter#-omitResponseHeaders)
   - [errorMessage](https://github.com/ozkanonur/nestjs-rate-limiter#-errorMessage)
   - [customResponseSchema](https://github.com/ozkanonur/nestjs-rate-limiter#-customResponseSchema)
+- [Override Functions](https://github.com/ozkanonur/nestjs-rate-limiter#override-functions)
 - [Benchmarks](https://github.com/ozkanonur/nestjs-rate-limiter#benchmarks)
 - [TODO List](https://github.com/ozkanonur/nestjs-rate-limiter#todo)
 
@@ -465,6 +466,22 @@ GraphQLModule.forRoot({
   <br>
 
   customResponseSchema option allows to provide customizable response schemas
+
+# Override Functions
+
+#### It's possible to override <code> getIpFromRequest </code> function by extending <code> RateLimiterGuard </code> class.
+
+```ts
+import { RateLimiterGuard } from 'nestjs-rate-limiter'
+import type { Request } from 'express'
+
+class ExampleRateLimiterGuard extends RateLimiterGuard {
+  protected getIpFromRequest(request: Request): string {
+    return request.get('x-forwarded-for');
+  }
+}
+```
+
 # Benchmarks
 
 1000 concurrent clients with maximum 2000 requests per sec during 30 seconds.

diff --git a/lib/rate-limiter.guard.ts b/lib/rate-limiter.guard.ts
@@ -166,12 +166,16 @@ export class RateLimiterGuard implements CanActivate {
 		const response = this.httpHandler(context).res
 
 		const rateLimiter: RateLimiterAbstract = await this.getRateLimiter(reflectedOptions)
-		const key = request.ip?.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/)?.[0]
+		const key = this.getIpFromRequest(request)
 
 		await this.responseHandler(response, key, rateLimiter, points, pointsConsumed)
 		return true
 	}
 
+	protected getIpFromRequest(request: { ip: string }): string {
+	        return request.ip?.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/)?.[0]
+	}
+
 	private httpHandler(context: ExecutionContext) {
 		if (this.options.for === 'ExpressGraphql') {
 			return {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nestjs-rate-limiter",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Highly configurable and extensible rate limiter library",
   "repository": {
     "type": "git",