Simulate rate limiting on GitHub APIs

Summary

This sample contains a preset to simulate rate limiting on GitHub APIs.

Your GitHub script, bot, or integration works until it hits GitHub’s rate limit: 60 requests per hour without authentication, or 5,000 with a personal access token. Then GitHub answers with a 403 or 429, and code that doesn’t read the x-ratelimit-* headers fails or keeps retrying.

Using this preset, you can see what your code does at the limit without using up your real one. Dev Proxy counts your requests to api.github.com, returns the x-ratelimit-limit, x-ratelimit-remaining, and x-ratelimit-reset headers, and answers with a 429 after 60 requests. Your code keeps calling the real GitHub API URLs.

Compatibility

Contributors

• Waldek Mastykarz

Version history

Minimal path to awesome

• Get the sample:

  • Download just this sample:

    npx gitload-cli https://github.com/pnp/proxy-samples/tree/main/samples/github-rate-limiting

    or

  • Download as a .ZIP file and unzip it, or

  • Clone this repository

• Start Dev Proxy by running devproxy in the sample’s folder

Alternatively, download the preset with Dev Proxy and start it from any folder:

devproxy config get github-rate-limiting
devproxy --config-file "~dataFolder/configs/github-rate-limiting/.devproxy/devproxyrc.json"

• Send more than 60 requests to the GitHub API, for example:

  curl -ikx http://127.0.0.1:8000 https://api.github.com/users/octocat

To simulate GitHub’s secondary rate limits instead, start Dev Proxy by running devproxy --config-file .devproxy/devproxyrc-secondary.json.

Features

This preset simulates rate limiting on GitHub APIs.

Using this sample you can use Dev Proxy to:

• Simulate GitHub’s primary rate limit of 60 requests per hour. Each response includes the x-ratelimit-limit, x-ratelimit-remaining, and x-ratelimit-reset headers. After you exceed the limit, Dev Proxy returns a 429 Too Many Requests response with the API rate limit exceeded message that GitHub sends.
• Detect when your app retries a request before the rate limit resets, using the RetryAfterPlugin.
• Simulate GitHub’s secondary rate limits, using the devproxyrc-secondary.json config. Dev Proxy randomly returns a 429 Too Many Requests response with a retry-after header and detects when your app retries too early.

For more information about GitHub API rate limits, see Rate limits for the REST API.

For more information about the configuration options, see the documentation of the RateLimitingPlugin, RetryAfterPlugin, and GenericRandomErrorPlugin.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

If you encounter any issues using this sample, create a new issue.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.