API Rate Limiter

Created by Josiah Adegboye.

Made with ❤️, Express, Docker, Redis MongoDB, k6, InfluxDB and Grafana.

How to run

First clone the repo with

git clone https://github.com/i-mighty/rate-limiter

Then

cd ./rate-limiter

Next, start the services with docker

docker-compose up

Or start the services individually i.e

docker-compose up mongodb //For the mongodb database
docker-compose up server //For the express server
docker-compose up redis //For the redis in memory db
docker-compose up k6 //For the k6 tester
docker-compose up influxdb //For the influxdb database
docker-compose up grafana //For the grafana server

Testing

To run tests, first start all the services by running

docker-compose up

Next migrate DB with fake data by running

cd server && yarn migrate-up

You can also create more migrations to run on more specific data. Next edit your k6/rate_limit.js file to replace the mock client-key, 641cfcfdbd76775d0bab39bc with an _id from your newly migrated clients in your mongodb. (NB! client-key must be added to the header else the request will return a 403)

Next run (in another terminal window)

yarn run limit-test

Or directly run the bash script:

bash limit-test.sh

Running either of the above from the project root folder runs the k6 test scripts. Click on the grafana link to see the test results.

Created by Josiah Adegboye