refactor: optimize GHApp installation ID retrieval #2218
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @mathur07, I'm Gemini Code Assist1! 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 introduces a significant refactoring to optimize how GitHub App installation IDs are retrieved. The primary goal is to enhance efficiency and reliability by moving away from listing all installations to a more direct and targeted approach. This change improves the system's ability to locate the correct installation for a given repository, organization, or user, making the process faster and more resilient to various GitHub App configurations.
Highlights
- Optimized Installation ID Retrieval: The core logic for retrieving GitHub App installation IDs has been overhauled. Instead of listing all installations and then filtering, the system now directly attempts to find the installation associated with a given repository URL.
- Enhanced Fallback Logic: New fallback mechanisms have been implemented. If a direct repository installation is not found, the system will now attempt to find an organization-level installation, and then a user-level installation, ensuring broader compatibility and robustness.
- Codebase Simplification: The
matchReposmethod and therepoListfield, which were part of the old installation listing approach, have been removed, simplifying theInstallstruct and related code. - Improved Error Handling: Error handling for token retrieval has been refined. If a token cannot be generated for an installation, a warning is now logged, allowing the process to continue if possible, rather than failing outright.
- Comprehensive Test Updates: The test suite has been significantly updated to reflect and thoroughly validate the new direct lookup and fallback behaviors, including various success and failure scenarios.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly improves the GitHub App installation ID retrieval by fetching it directly instead of listing all installations. This is a great optimization. The fallback logic for repository, organization, and user installations is well-thought-out, and the error handling has been enhanced. The tests have been updated accordingly and provide good coverage for the new logic.
I have a couple of minor suggestions to improve code clarity and maintainability.
|
@mathur07 why duplicate? |
|
@zakisk we want to get this work to finish sooner. The work is essentially complete; we just need to address a few final review comments. |
mathur07
force-pushed
the
shumathu-KONFLUX-5929
branch
from
75709dc to
048b887
Compare
|
@aThorp96 @infernus01 PTAL |
- Removed listing of all installations. - Fetched the installation directly using the repository URL. - Added fallback to find the organization installation if the repository installation is not found. - Enhanced error handling for token retrieval. - Updated tests to reflect the changes. - Eliminated the matchRepos method from Install struct as it was unused refactor: Improve GitHub App installation ID retrieval Signed-off-by: Chmouel Boudjnah <[email protected]>
mathur07
force-pushed
the
shumathu-KONFLUX-5929
branch
from
d2f9481 to
ac1a5a1
Compare
duplicate of refactor: Improve GitHub App installation ID retrieval | 2154
📝 Description of the Change
🔗 Linked GitHub Issue
Fixes # https://issues.redhat.com/browse/KONFLUX-5929
👨🏻 Linked Jira
🚀 Type of Change
fix:)feat:)feat!:,fix!:)docs:)chore:)refactor:)enhance:)deps:)🧪 Testing Strategy
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.