V3

[adevinwild]

V3

This PR introduces new way to use rate limit, by being inspired by how modern libraries handle it (which I think is the way to go and really allows customizability)

Before

import { defaultRateLimit, configureDefaults } from '@perseidesjs/medusa-plugin-rate-limit'

configureDefaults({
  limit: 100,
  window: 900,
})

export default defineMiddlewares({
  routes: [
    {
      matcher: "/store/custom*",
      middlewares: [defaultRateLimit()],
    },
  ],
})

After

import { defineMiddlewares } from "@medusajs/medusa"
import { RateLimit } from '@perseidesjs/medusa-plugin-rate-limit'
import { Modules } from "@medusajs/framework/utils"

export default defineMiddlewares({
  routes: [
    {
      matcher: "/store/custom*",
      middlewares: [
        async (req: MedusaRequest, res: MedusaResponse, next: MedusaNextFunction) => {
          const cacheService = req.scope.resolve(Modules.CACHE)
          const rateLimit = new RateLimit({
            cacheService,
            options: {
              limit: 50, // 50 requests per minute
              window: 60
            }
          })

          const ip = req.headers['x-forwarded-for'] as string
          const { success } = await rateLimit.limit(ip)
          if (!success) {
            res.status(429).send('Too many requests, please try again later.')
            return
          }
          next()
        }
      ],
    },
  ],
})

As you can see the main changes resides in the export of a new class RateLimit which will be our new way to throttle endpoints, with much more freedom.
This really unlocks new ways/scenarios to rate limit your endpoints in our Medusa apps, this still uses the cache module under the hood

[changeset-bot]

🦋 Changeset detected

Latest commit: 2ab43cf

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@perseidesjs/medusa-plugin-rate-limit	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR