Skip to content

[Java] Optimize beam pubsub message to serialized pubsub protobuf message#37896

Open
scwhittle wants to merge 1 commit intoapache:masterfrom
scwhittle:pubsub_optimization
Open

[Java] Optimize beam pubsub message to serialized pubsub protobuf message#37896
scwhittle wants to merge 1 commit intoapache:masterfrom
scwhittle:pubsub_optimization

Conversation

@scwhittle
Copy link
Contributor

For the common case where just the payload is set, we can just copy directly to a byte array.
For the case where there are other set fields, we optimize protobuf construction by not calling methods on the builder for empty attribute map or empty strings.


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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 significantly enhances the performance of serializing Beam PubsubMessage objects into Google Cloud Pub/Sub protobuf messages. It introduces optimizations to reduce overhead, particularly for messages consisting solely of a payload, by directly serializing the payload to a byte array. For messages with additional fields, it refines the protobuf builder usage to avoid setting empty or null values, contributing to more efficient message construction and overall improved serialization speed.

Highlights

  • Serialization Optimization: Optimized the toProto method to avoid setting empty or null attributes, message IDs, and ordering keys on the protobuf builder, reducing unnecessary operations and improving efficiency.
  • Direct Payload Serialization: Introduced a new private method toSerializedPubsubMessageProto for direct byte array serialization of PubsubMessage instances, specifically optimizing the common case where only the payload is present by using CodedOutputStream.
  • Serializable Function Update: Updated the ParsePayloadAsPubsubMessageProto serializable function to leverage the new optimized toSerializedPubsubMessageProto path for improved performance.
  • Comprehensive Testing: Added a new comprehensive unit test file, PubsubMessagesTest, to validate the correctness of toProto, fromProto, and the new optimized serialization logic across various message configurations, including cases with empty/null attributes, message IDs, and ordering keys.

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

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.

@scwhittle scwhittle force-pushed the pubsub_optimization branch from ab7ee1a to f9a0cb1 Compare March 20, 2026 10:53
@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@scwhittle scwhittle force-pushed the pubsub_optimization branch from f9a0cb1 to d1cad03 Compare March 20, 2026 13:45
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