Pull Request

fixes #395

This pull request introduces a new feature to bypass the GitHub API rate limit waiting loops and includes several related changes across multiple files. The key changes involve updating the configuration with a bypass, modifying the rate limit handling logic, and adding corresponding tests.

Proposed Changes

New Feature: Rate Limit Bypass

Configuration Updates:

• config.py: Added rate_limit_bypass parameter to the EnvVars class and updated the __init__ and __repr__ methods to include this parameter. Also, modified the get_env_vars function to read the RATE_LIMIT_BYPASS environment variable. [1] [2] [3] [4] [5] [6]

Main Functionality Updates:

• issue_metrics.py: Updated the search_issues function to accept a rate_limit_bypass parameter and modified the wait_for_api_refresh function to skip waiting if the bypass is enabled. Also, updated the main function to pass the rate_limit_bypass parameter to search_issues. [1] [2] [3] [4] [5] [6]

Documentation:

• README.md: Added a description for the new RATE_LIMIT_BYPASS environment variable.

Test Cases:

• test_config.py: Updated the setUp method to include RATE_LIMIT_BYPASS and added it to the environment variables. Modified the test_get_env_vars_with_github_app test case to include the rate_limit_bypass parameter. [1] [2] [3]
• test_issue_metrics.py: Added a new test case test_search_issues_with_just_owner_or_org_with_bypass to verify that the rate limit bypass works correctly.

Readiness Checklist

Author/Contributor

• If documentation is needed for this change, has that been included in this pull request
• run make lint and fix any issues that you have introduced
• run make test and ensure you have test coverage for the lines you are introducing
• If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

• Label as either fix, documentation, enhancement, infrastructure, maintenance, or breaking