Rate limiting without a handler

[ddsultan]

🚀 Feature Proposal

It would be really helpful if one could add route based rate limiting without a handler function.

Motivation

I am using Fastify as a gateway in combination with fastify-gateway. With the gateway plugin (fastify-gateway) I can delegate handling to external services. By being able to add route based rate limiter without a handler parameter we can make the fastify-rate-limit plugin usable beyond typical route based rate limiting.

Example

Expected Behaviour:

fastify.register(fastifyRateLimit, { //just as an option
  config: {
    route: '/routeX',
    rateLimit: {
      max: 3,
      timeWindow: '1 minute'
    }
  }
})

[mcollina]

This should already be supported: look at the example in https://github.com/fastify/fastify-rate-limit/blob/master/README.md#usage. M

[ddsultan]

@mcollina, Thank you for your response. If I am not mistaken the reference you have provided does not do route based rate limiting but global rate limiting. In the feature I am suggesting route configuration can be done, for example, with fastify-gateway

[Eomm]

I don't think this feature should be added here: it has too many side effect.

The problem here is that fastify-gateway is registering routes for you, without passing the necessary config.

So you should ask for a change here:

https://github.com/jkyberneees/fastify-gateway/blob/3ca4e22f2982245fdeb2efd77792964d3c871f02/index.js#L53

adding a new parameter as input to give to the route creation.

Otherwise, you can do it by yourself using the onRoute hook and write some code:

fastify.addHook('onRoute', (routeOptions) => {
if(routeOptions.url === '/routeX' ){
  routeOptions.config.rateLimit: {
      max: 3,
      timeWindow: '1 minute'
    }
}
...
})

(this hook must be registered before the fastify-rate-limit plugin).
In this way, it should works

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.