Adding getIpFromRequest method to get the request's IP

[Borales]

Our project sits behind the proxy, so we need to get IP from the headers (x-forwarded-for).

If necessary, a developer could extend RateLimiterGuard class and override the getIpFromRequest method:

import { RateLimiterGuard } from 'nestjs-rate-limiter'
import type { Request } from 'express'

class MyRateLimiterGuard extends RateLimiterGuard {
  protected getIpFromRequest(request: Request): string {
    return request.get('x-forwarded-for');
  }
}

This would also help to solve the problem mentioned here:

import { RateLimiterGuard } from 'nestjs-rate-limiter'
import type { Request } from 'express'
import * as requestIp from 'request-ip'

class MyRateLimiterGuard extends RateLimiterGuard {
  protected getIpFromRequest(request: Request): string {
    return requestIp.getClientIp(request);
  }
}

[onur-ozkan]

Thank you for contributing!

[Borales]

@ozkanonur would it be possible to release 3.0.1 with this change? It kinda blocks our integration (ip is undefined for us, so it's not really limiting the requests at the moment)

[onur-ozkan]

@ozkanonur would it be possible to release 3.0.1 with this change? It kinda blocks our integration (ip is undefined for us, so it's not really limiting the requests at the moment)

I just published v3.1.0