rate-limiter-flexible
Advanced tools
rate-limiter-flexible - npm Package Compare versions
Comparing version 0.18.3 to 0.18.4
@@ -107,2 +107,6 @@ module.exports = class RateLimiterAbstract { | ||
| } | ||
| block() { | ||
| throw new Error("You have to implement the method 'block'!"); | ||
| } | ||
| }; |
| { | ||
| "name": "rate-limiter-flexible", | ||
| "version": "0.18.3", | ||
| "version": "0.18.4", | ||
| "description": "Flexible API rate limiter backed by Redis for distributed node.js applications", | ||
@@ -10,4 +10,4 @@ "main": "index.js", | ||
| "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls", | ||
| "eslint": "node_modules/eslint/bin/eslint.js --quiet lib/*", | ||
| "eslint-fix": "node_modules/eslint/bin/eslint.js --fix lib/*" | ||
| "eslint": "node_modules/eslint/bin/eslint.js --quiet lib/**/**.js", | ||
| "eslint-fix": "node_modules/eslint/bin/eslint.js --fix lib/**/**.js" | ||
| }, | ||
@@ -31,2 +31,3 @@ "repository": { | ||
| "homepage": "https://github.com/animir/node-rate-limiter-flexible#readme", | ||
| "types": "./lib/index.d.ts", | ||
| "devDependencies": { | ||
@@ -33,0 +34,0 @@ "chai": "^4.1.2", |
@@ -92,3 +92,3 @@ [](https://travis-ci.org/animir/node-rate-limiter-flexible) | ||
| * [RateLimiterRedis](#ratelimiterredis) | ||
| * [RateLimiterRedis](https://github.com/animir/node-rate-limiter-flexible/wiki/Redis) | ||
| * [RateLimiterMongo](https://github.com/animir/node-rate-limiter-flexible/wiki/Mongo) | ||
@@ -270,96 +270,3 @@ * [RateLimiterMySQL](https://github.com/animir/node-rate-limiter-flexible/wiki/MySQL) (support Sequelize and Knex) | ||
| ## Usage | ||
| ### RateLimiterRedis | ||
| Redis >=2.6.12 | ||
| It supports both `redis` and `ioredis` clients. | ||
| Redis client must be created with offline queue switched off. | ||
| ```javascript | ||
| const redis = require('redis'); | ||
| const redisClient = redis.createClient({ enable_offline_queue: false }); | ||
| const Redis = require('ioredis'); | ||
| const redisClient = new Redis({ | ||
| options: { | ||
| enableOfflineQueue: false | ||
| } | ||
| }); | ||
| const { RateLimiterRedis, RateLimiterMemory } = require('rate-limiter-flexible'); | ||
| // It is recommended to process Redis errors and setup some reconnection strategy | ||
| redisClient.on('error', (err) => { | ||
| }); | ||
| const opts = { | ||
| // Basic options | ||
| storeClient: redisClient, | ||
| points: 5, // Number of points | ||
| duration: 5, // Per second(s) | ||
| // Custom | ||
| execEvenly: false, // Do not delay actions evenly | ||
| blockDuration: 0, // Do not block if consumed more than points | ||
| keyPrefix: 'rlflx', // must be unique for limiters with different purpose | ||
| // Database limiters specific | ||
| inmemoryBlockOnConsumed: 10, // If 10 points consumed in current duration | ||
| inmemoryBlockDuration: 30, // block for 30 seconds in current process memory | ||
| }; | ||
| const rateLimiterRedis = new RateLimiterRedis(opts); | ||
| rateLimiterRedis.consume(remoteAddress) | ||
| .then((rateLimiterRes) => { | ||
| // ... Some app logic here ... | ||
| // Depending on results it allows to fine | ||
| rateLimiterRedis.penalty(remoteAddress, 3) | ||
| .then((rateLimiterRes) => {}); | ||
| // or rise number of points for current duration | ||
| rateLimiterRedis.reward(remoteAddress, 2) | ||
| .then((rateLimiterRes) => {}); | ||
| }) | ||
| .catch((rejRes) => { | ||
| if (rejRes instanceof Error) { | ||
| // Some Redis error | ||
| // Never happen if `insuranceLimiter` set up | ||
| // Decide what to do with it in other case | ||
| } else { | ||
| // Can't consume | ||
| // If there is no error, rateLimiterRedis promise rejected with number of ms before next request allowed | ||
| const secs = Math.round(rejRes.msBeforeNext / 1000) || 1; | ||
| res.set('Retry-After', String(secs)); | ||
| res.status(429).send('Too Many Requests'); | ||
| } | ||
| }); | ||
| ``` | ||
| #### RateLimiterRedis benchmark | ||
| Endpoint is pure NodeJS endpoint launched in `node:10.5.0-jessie` and `redis:4.0.10-alpine` Docker containers by PM2 with 4 workers | ||
| By `bombardier -c 1000 -l -d 30s -r 2000 -t 5s http://127.0.0.1:8000` | ||
| Test with 1000 concurrent requests with maximum 2000 requests per sec during 30 seconds | ||
| ```text | ||
| Statistics Avg Stdev Max | ||
| Reqs/sec 2015.20 511.21 14570.19 | ||
| Latency 2.45ms 7.51ms 138.41ms | ||
| Latency Distribution | ||
| 50% 1.95ms | ||
| 75% 2.16ms | ||
| 90% 2.43ms | ||
| 95% 2.77ms | ||
| 99% 5.73ms | ||
| HTTP codes: | ||
| 1xx - 0, 2xx - 53556, 3xx - 0, 4xx - 6417, 5xx - 0 | ||
| ``` | ||
| ## Contribution | ||
@@ -366,0 +273,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by5.26%
20
- Lines of code
- increased by4.03%
1911
Worsened metrics
- Total package byte prevSize
- decreased by-0.12%
71022
- Number of lines in readme file
- decreased by-24.6%
285
No dependency changes