Add Logic to Handle if Key Encounters GitHub API Rate Limit

[IsaacMilarky]

Add Logic to Handle if Key Encounters GitHub API Rate Limit

Problem

The script doesn't handle the situation where it encounters a GitHub rate limit.

Solution

Check the api response object to see if a rate limit status was encountered. If it was then sleep for the amount of time given by the GitHub response header x-ratelimit-reset.

More information on the GitHub rate limit can be found here: https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28

Result

Summary:

• Add loop to retry when issues are encountered
• Check response code for rate limit ( 403 and 429 )
• Extract x-ratelimit-reset from response header if rate limit triggered, this is a timestamp for when the key will be good again. We convert the timestamp into a duration in seconds and then sleep for that many seconds
• Get local time for when the key will be good again and print to stdout
• Raise ConnectionError if rate limit still happens after 5 tries

Test Plan

I have tested the script locally

[sachin-panayil]

great way to handle this 🚢