Add is_rate_limit_low method

[majamassarini]

RELEASE NOTES BEGIN

Calls to check the rate limit threshold have been added to the Service API and implemented where possible.

RELEASE NOTES END

[gemini-code-assist]

Summary of Changes

Hello @majamassarini, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the Service API by introducing a new method, is_rate_limit_low, which allows applications to proactively check if they are approaching API rate limits on various Git platforms. This addition aims to improve the robustness and reliability of integrations by enabling better management of API call frequency, thereby preventing service interruptions due to rate limit exhaustion.

Highlights

• New Abstract Method: Introduced an abstract is_rate_limit_low method in ogr/abstract/git_service.py to provide a standardized way to check API rate limits across different Git services.
• GitHub Service Implementation: Implemented is_rate_limit_low for GitHub in ogr/services/github/service.py, leveraging the github library to check the remaining core rate limit.
• GitLab Service Implementation: Implemented is_rate_limit_low for GitLab in ogr/services/gitlab/service.py. Since python-gitlab lacks a direct rate limit method, a HEAD request to the /api/v4/user endpoint is used to extract ratelimit-remaining from response headers. The requests library was imported for this purpose.
• Pagure Service Implementation: Implemented is_rate_limit_low for Pagure in ogr/services/pagure/service.py, which always returns False as the Pagure API does not expose rate limit information.
• Integration Tests: Added comprehensive integration tests for the is_rate_limit_low method across GitHub, GitLab, and Pagure services, including new test data files to ensure proper functionality and API interaction.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new method, is_rate_limit_low, to the GitService abstract class and provides implementations for GitHub, GitLab, and Pagure. This is a useful addition for clients of this library to proactively handle API rate limiting. The changes are well-implemented and include corresponding tests. My main feedback is on the GitLab implementation, where the exception handling can be improved to be more specific and to include logging, which will make the code more robust and easier to debug.

[centosinfra-prod-github-app]

Build failed.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/02b3b31a348241f0abd6d5a787c8c802

❌ pre-commit FAILURE in 3m 33s
❌ ogr-tests-pip-deps FAILURE in 17m 56s

[centosinfra-prod-github-app]

Build failed.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/0068c0bf701842608d80f1e5718845f9

❌ pre-commit FAILURE in 3m 25s
❌ ogr-tests-pip-deps FAILURE in 17m 51s

[lbarcziova]

one question about design, otherwise this looks like a good direction!

[lbarcziova]

what do you think about having the method in ogr to just return the number of remaining API calls, and we would check/control based on that the behaviour on packit-service?

[centosinfra-prod-github-app]

Build failed.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/02a5a9b2dd804d4aafc46798604c511b

❌ pre-commit FAILURE in 4m 13s
❌ ogr-tests-pip-deps FAILURE in 17m 51s

[centosinfra-prod-github-app]

Build failed.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/e98bc2508326424db93b0fea2a80064a

❌ pre-commit FAILURE in 4m 08s
❌ ogr-tests-pip-deps FAILURE in 17m 50s

[centosinfra-prod-github-app]

Build succeeded.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/8232f0bb119b46f28746e1855a6a650c

✔️ pre-commit SUCCESS in 3m 26s
✔️ ogr-tests-pip-deps SUCCESS in 18m 01s

[centosinfra-prod-github-app]

Build succeeded.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/9466998d689a44b0836d8be0bba0290f

✔️ pre-commit SUCCESS in 3m 25s
✔️ ogr-tests-pip-deps SUCCESS in 17m 55s

[centosinfra-prod-github-app]

Build succeeded.
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/cf491851079d497dad984bae85fb25fc

✔️ pre-commit SUCCESS in 3m 27s
✔️ ogr-tests-pip-deps SUCCESS in 17m 51s

[lbarcziova]

LGTM, thanks!

[centosinfra-prod-github-app]

Build succeeded (gate pipeline).
https://gateway-cloud-softwarefactory.apps.ocp.cloud.ci.centos.org/zuul/t/packit-service/buildset/39161a7861e6426d8a8ca337cb19178d

✔️ pre-commit SUCCESS in 3m 31s