Add audience and prompt as configurable for OAuth flows #2738
Conversation
This change adds the ability to specify an `audience` and `prompt` when generating an OAuth2 authorization URL. This is necessary for some OAuth2 providers that require these parameters. The following changes were made: - Added optional `audience` and `prompt` fields to the `OAuth2Auth` model. - Updated the `AuthHandler` to include the `audience` and `prompt` parameters in the authorization URL. - Added a unit test to verify that the `audience` and `prompt` parameters are correctly included in the authorization URL.
![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 @mescanne, 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 enhances the OAuth authentication flow by introducing configurable audience and prompt parameters. This allows the system to better integrate with OAuth servers that require these specific parameters, such as Jira, providing more flexibility in authentication requests.
Highlights
- OAuth2Auth Model Extension: Added audience and prompt as optional string fields to the OAuth2Auth data model, allowing these parameters to be configured for OAuth flows.
- Dynamic Authorization URI Generation: Modified the generate_auth_uri function to dynamically include the audience and prompt parameters in the OAuth authorization URL if they are provided in the OAuth2Auth configuration. The prompt parameter defaults to "consent" if not explicitly set.
- Test Suite Enhancement: Updated the MockOAuth2Session to correctly process prompt and audience parameters when generating authorization URLs, and added a new dedicated test case to verify that generate_auth_uri correctly incorporates these new configurable parameters into the authorization URL.
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. ↩
adk-bot
added
bot triaged
|
Response from ADK Triaging Agent Hello @mescanne, thank you for creating this PR! Could you please associate a GitHub issue with this PR? If there is no existing issue, could you please create one? This information will help reviewers to review your PR more efficiently. Thanks! |
There was a problem hiding this comment.
Code Review
This pull request correctly adds support for audience and prompt parameters in OAuth2 flows, which is a useful feature. The implementation is solid and includes new tests to cover the changes. I have a couple of suggestions to make the code even better: one to simplify a conditional block in auth_handler.py and another to improve the robustness of a test mock in test_auth_handler.py.
Jacksunwei
requested review from
seanzhou1023
and removed request for
Jacksunwei
Some OAuth servers require audience such as Jira. This change allows the configuration of audience and prompt (if it needs to be changed) and adds some tests.
This is for issue 2755.
Happy to provide changes/updates if needed.