Code Monkey home page Code Monkey logo

redis-rolling-rate-limiter's Introduction

Rolling Rate Limiter with Redis

Build Status NPM version dependencies Status

Rolling Rate Limiter is a module for Node.js which provides a basic, but a solid rate limiter using sliding windows stored in Redis. It was inspired from ClassDojo Rate Limiter, but several issues has been fixed like :

  • Removing closure to fix a memory leak if a lot of users request the limit
  • Instead of fetching the whole range (with ZRANGE(key, 0, -1)) and then count the number of elements, we use ZCARD, and only fetch the first timestamp and the last timestamp, so we avoid a large operation in Redis and save a lot of memory if we use a large limit (like 3000 request / min).
  • Fixing a bug with interval in microseconds instead of milliseconds
  • Avoid a race condition with ZREM and ZADD

Requirements

  • NodeJS >= 0.10.x
  • Redis >= 2.6.12

Setup

npm install --save redis-rolling-rate-limiter

Examples

var RateLimiter = require("redis-ratelimit");
var redis = require('ioredis'); // or node_redis or any Redis Client

var client = redis.createClient({
  port: 6379,
  host: '127.0.0.1'
});

var limiter = RateLimiter({
  redis: client, 
  namespace: "my-limiter", // optional
  interval: 1000, // in miliseconds (= 1s)
  maxInInterval: 10, // 10 actions max
  minDifference: 100 // optional: the minimum time (in miliseconds) between any two actions
});

client.on('ready', function() {
 limiter('my-limit', function(err, timeLeft) {
  if(err) {
    throw err;
  }
  
  // timeLeft is in ms
  if(timeLeft > 0) {
    console.log('Rate limit exceeded, Please wait %s secs', timeLeft/1000);
  } else {
    // Do your stuff
  }
  
 });
});

redis-rolling-rate-limiter's People

Contributors

aurlin avatar rj33 avatar chavee avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.