feat: add Bearer authentication support for push notifications#598
feat: add Bearer authentication support for push notifications#598Tareqox wants to merge 4 commits intoa2aproject:mainfrom
Conversation
- Honor PushNotificationConfig.authentication field in BasePushNotificationSender - Add Authorization header when Bearer scheme is configured - Maintain backward compatibility with existing X-A2A-Notification-Token header
Add comprehensive test coverage for authentication scenarios
Summary of ChangesHello @Tareqox, 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 new feature that enables push notifications to utilize Bearer token authentication. This enhancement provides a more secure and flexible way to dispatch notifications to external services by supporting a common authentication standard, ensuring that sensitive information is transmitted only to authorized recipients. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request adds support for Bearer authentication for push notifications, which is a valuable feature. The implementation is correct and includes comprehensive tests for various scenarios, including success cases, missing credentials, and non-bearer schemes. I've made a couple of minor suggestions to improve code readability and simplify the logic in base_push_notification_sender.py. Overall, this is a solid contribution.
| if push_info.authentication and push_info.authentication.schemes: | ||
| for scheme in push_info.authentication.schemes: | ||
| if scheme.lower() == 'bearer' and push_info.authentication.credentials: | ||
| headers['Authorization'] = f'Bearer {push_info.authentication.credentials}' | ||
| break |
There was a problem hiding this comment.
For better readability and conciseness, you can use any() with a generator expression to check for the 'bearer' scheme. This achieves the same result as the for loop with a break but in a more idiomatic and efficient Python style, as it also avoids iterating if credentials are not present.
if push_info.authentication and push_info.authentication.credentials:
if any(scheme.lower() == 'bearer' for scheme in push_info.authentication.schemes):
headers['Authorization'] = f'Bearer {push_info.authentication.credentials}'| url, | ||
| json=task.model_dump(mode='json', exclude_none=True), | ||
| headers=headers, | ||
| headers=headers if headers else None, |
style: apply code formatting and linting fixes
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.fix:which represents bug fixes, and correlates to a SemVer patch.feat:represents a new feature, and correlates to a SemVer minor.feat!:, orfix!:,refactor!:, etc., which represent a breaking change (indicated by the!) and will result in a SemVer major.bash scripts/format.shfrom the repository root to format)Fixes #585