Skip to content

Fix 37351 dofn cache collision#37353

Closed
Eliaaazzz wants to merge 4 commits intoapache:masterfrom
Eliaaazzz:fix-37351-dofn-cache-collision
Closed

Fix 37351 dofn cache collision#37353
Eliaaazzz wants to merge 4 commits intoapache:masterfrom
Eliaaazzz:fix-37351-dofn-cache-collision

Conversation

@Eliaaazzz
Copy link
Contributor

Please add a meaningful description for your change here


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

This fixes a bug where ByteBuddyDoFnInvokerFactory would return the same cached invoker for different generic instantiations of the same DoFn class.

Changes:
1. Introduced InvokerCacheKey with TypeDescriptors to ensure unique cache entries.
2. Updated generateInvokerClass to append type-based hash suffix.
3. Added regression test (testCacheKeyCollisionProof).

Fixes apache#37351
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Eliaaazzz, 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 addresses a critical cache collision issue within the Apache Beam Java SDK's ByteBuddyDoFnInvokerFactory. Previously, the system could incorrectly reuse DoFnInvoker instances for DoFn classes that shared the same base class but differed in their generic type parameters, leading to potential runtime instability. The core of the solution involves refining the caching mechanism to consider the full generic type information of a DoFn when generating and retrieving its invoker, ensuring type safety and correct behavior across diverse DoFn instantiations. A minor change was also made to the Python SDK to improve type hint handling.

Highlights

  • Java SDK DoFn Invoker Cache Fix: The ByteBuddyDoFnInvokerFactory in the Java SDK has been updated to prevent cache collisions for DoFnInvoker constructors. Previously, DoFns with the same class but different generic type parameters could incorrectly share the same cached invoker.
  • Enhanced Cache Key: A new InvokerCacheKey class has been introduced. This key now incorporates the DoFn class, its input TypeDescriptor, and its output TypeDescriptor, ensuring that different generic instantiations of the same DoFn class are treated as distinct entries in the cache.
  • Unique Generated Class Names: Generated DoFnInvoker classes now include a hash of their generic type parameters in their names. This prevents class name collisions at runtime when the same DoFn is used with varying generic types.
  • New Test Case for Collision Proofing: A dedicated test (testCacheKeyCollisionProof) has been added to verify that different generic instantiations of a DoFn correctly produce distinct invoker classes, confirming the effectiveness of the fix.
  • Python Type Hint Refactoring: A minor refactoring in the Python SDK's external.py to store type hints in a local variable, preventing potential AttributeError and duplicate calls during processing.
  • Gitignore Update: The .gitignore file has been updated to include .venv/, preventing local Python virtual environment directories from being committed.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant