-
Notifications
You must be signed in to change notification settings - Fork 77
optimize gapic #2531
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
optimize gapic #2531
Conversation
Summary of ChangesHello @ohmayr, 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 implements a significant performance optimization by introducing a caching mechanism for context-aware schema objects. By passing a shared Highlights
🧠 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 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a caching mechanism to optimize with_context calls, which is a good idea for performance. However, the implementation has a few issues that need to be addressed: a critical bug in api.py that will cause a runtime error, and several issues with the caching implementation itself regarding type safety, potential cache corruption, and code duplication. My detailed comments point out these issues with suggestions for fixes.
| collisions=v.names, | ||
| visited_messages=visited_messages, | ||
| collisions=global_collisions, | ||
| visited_messages=frozenset(v.names), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a type mismatch here. The visited_messages parameter in with_context expects a Set[wrappers.MessageType], but you are passing frozenset(v.names), which is a frozenset[str]. This will likely lead to a TypeError at runtime inside MessageType.with_context when set operations are performed. The original code passed an empty set of MessageType. To fix this, you should pass an empty set.
| visited_messages=frozenset(v.names), | |
| visited_messages=set(), |
gapic/schema/metadata.py
Outdated
| return selector | ||
|
|
||
| def with_context(self, *, collisions: Set[str]) -> "Address": | ||
| def with_context(self, *, collisions: Set[str], context_cache: Optional[Dict[tuple, "MessageType"]] = None,) -> "Address": |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The type hint for context_cache is incorrect. It's specified as Optional[Dict[tuple, "MessageType"]], but this method caches and returns an Address object. This same issue exists across all the modified with_context methods in this pull request (in both metadata.py and wrappers.py), where each method caches objects of its own class type. This can lead to type confusion and bugs.
A more accurate type hint would be Optional[Dict[tuple, Any]] to reflect that the cache holds various types. Note that this would require importing Any from typing on line 31.
| def with_context(self, *, collisions: Set[str], context_cache: Optional[Dict[tuple, "MessageType"]] = None,) -> "Address": | |
| def with_context(self, *, collisions: Set[str], context_cache: Optional[Dict[tuple, Any]] = None,) -> "Address": |
gapic/schema/metadata.py
Outdated
| """ | ||
| return ( | ||
| context_cache = context_cache if context_cache is not None else {} | ||
| cache_key = (id(self), id(collisions)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using id(collisions) as part of the cache key is unsafe because collisions is a mutable Set. If the set is modified elsewhere, its ID remains the same, but its contents change. This can lead to incorrect cache hits, as the logic of with_context depends on the contents of the collisions set. To make caching robust, the cache key should be based on the content of the set, for example by using a frozenset. This issue is present in all with_context methods that have been modified in this PR.
| cache_key = (id(self), id(collisions)) | |
| cache_key = (id(self), frozenset(collisions)) |
gapic/schema/metadata.py
Outdated
| context_cache = context_cache if context_cache is not None else {} | ||
| cache_key = (id(self), id(collisions)) | ||
| if cache_key in context_cache: | ||
| return context_cache[cache_key] | ||
|
|
||
| updated_msg = ( | ||
| dataclasses.replace(self, collisions=collisions) | ||
| if collisions and collisions != self.collisions | ||
| else self | ||
| ) | ||
|
|
||
| context_cache[cache_key] = updated_msg | ||
| return updated_msg |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The caching logic here is repeated in many with_context methods across metadata.py and wrappers.py. To improve maintainability and adhere to the DRY (Don't Repeat Yourself) principle, consider refactoring this logic into a reusable decorator. A decorator could encapsulate the caching mechanism, making the with_context methods cleaner and less prone to copy-paste errors.
68e453e to
8e7e903
Compare
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:
Fixes #<issue_number_goes_here> 🦕