feat(grpc): Add util method to extract Task ID and Push Notification Config ID from request#524
feat(grpc): Add util method to extract Task ID and Push Notification Config ID from request#524rinaldiangoogle wants to merge 4 commits intoa2aproject:mainfrom
Conversation
…om request
Both `GetTaskPushNotificationConfigRequest` and `DeleteTaskPushNotificationConfigRequest` have a `name` field that has the same format: `tasks/{task_id}/pushNotificationConfigs/{config_id}`. Adding here a utility to extract the Task ID and Config ID. Can't output a `types.TaskPushNotificationConfig` as the `PushNotificationConfig` requires a url.
Summary of ChangesHello @rinaldiangoogle, 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 utility method within the 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
The pull request introduces a utility method task_push_notification_config_params to extract Task ID and Push Notification Config ID from the name field of GetTaskPushNotificationConfigRequest and DeleteTaskPushNotificationConfigRequest. The method uses a regular expression to match the expected format and raises a ServerError with an InvalidParamsError if the format doesn't match. The code appears to be well-structured and includes error handling.
|
Can you add tests for this method? |
`task_push_notification_config_params`
| ) | ||
|
|
||
| @classmethod | ||
| def task_push_notification_config_params( |
There was a problem hiding this comment.
I think what would be more useful is a generic function to parse PushNotifiactionConfig's name from a string. Such a function could be used in various contexts beyond these specific requests.
There was a problem hiding this comment.
I guess an option could be to get a string as parameter and fail if not in the tasks/{task_id}/pushNotificationConfigs/{config_id} format. Although, as in the PR description, that would still not be possible to have a more flexible function and output a PushNotifiactionConfig since there the url property is required (unless we change that).
Since we are in the proto_utils I think it is fair to working with these proto requests as parameters.
There was a problem hiding this comment.
The behavior would be the similar, your current implementation also fails if the format is incorrect, and you can always move the function to a different utils file. I just think it would be more versatile to have it accept a string value.
I feel like returning the PushNotifiactionConfig would be misleading here. You cannot build it from GetTaskPushNotificationConfigRequest.
Both
GetTaskPushNotificationConfigRequestandDeleteTaskPushNotificationConfigRequesthave anamefield that has the same format:tasks/{task_id}/pushNotificationConfigs/{config_id}. Adding here a utility to extract the Task ID and Config ID. Can't output atypes.TaskPushNotificationConfigas thePushNotificationConfigrequires a url.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)