Skip to content

Conversation

@userzhy
Copy link

@userzhy userzhy commented Dec 24, 2025

Fix PubsubUnboundedSink's WriterFn not enforcing message count limit per publish batch

Description

This PR fixes a bug where PubsubUnboundedSink's WriterFn was not properly enforcing the message count limit per publish batch. The publishBatchSize parameter was being passed to the constructor but was never stored or used in the processElement method.

According to Google Cloud Pub/Sub resource limits, a single publish request can contain at most 1000 messages. Without this fix, batches could exceed this limit, causing Pub/Sub to reject the publish request.

Changes

  • Add publishBatchSize field to WriterFn class
  • Store publishBatchSize in both WriterFn constructors
  • Add message count check in processElement alongside existing byte size check
  • Update both PubsubSinkDynamicDestinations and PubsubSink to pass publishBatchSize when creating WriterFn instances

Testing

  • Existing PubsubUnboundedSinkTest tests pass
  • The test sendMoreThanOneBatchByNumMessages specifically validates batch splitting by message count

Fixes #36885


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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @userzhy, 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 bug in the PubsubUnboundedSink component where it failed to respect Google Cloud Pub/Sub's message count limit per publish batch. By integrating the publishBatchSize parameter into the WriterFn's batching logic, the system will now proactively split message batches based on both message count and byte size, ensuring compliance with Pub/Sub's resource limits and preventing potential publish failures. Additionally, a minor enhancement was made to Python's logging mechanism to include logger names in log entries for better debugging.

Highlights

  • Pub/Sub Batch Limit Enforcement: Fixed a bug in PubsubUnboundedSink where the WriterFn was not properly enforcing the 1000 messages per batch limit for Google Cloud Pub/Sub, which could lead to rejected publish requests.
  • WriterFn Parameter Usage: The publishBatchSize parameter is now correctly stored and utilized within the WriterFn's processElement method to split batches by message count, complementing the existing byte size check.
  • Python Logging Enhancement: The FnApiLogRecordHandler in Python now includes the logger name in its custom_data field, improving log filtering and debugging capabilities.

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

@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

This commit fixes the issue where PubsubUnboundedSink's WriterFn was not
properly enforcing the message count limit per publish batch. The
publishBatchSize parameter was being passed to the constructor but not
stored or used in the processElement method.

Changes:
- Add publishBatchSize field to WriterFn class
- Store publishBatchSize in both WriterFn constructors
- Add message count check in processElement alongside existing byte size check
- Update both PubsubSinkDynamicDestinations and PubsubSink to pass
  publishBatchSize when creating WriterFn instances

The fix ensures that batches are split when they reach either the message
count limit or the byte size limit, preventing Pubsub from rejecting
batches that exceed the 1000 messages per request limit.

Fixes apache#36885
@userzhy userzhy force-pushed the fix/36885-pubsub-unbounded-sink-batch-size-limit branch from 325f313 to f70b0f2 Compare December 24, 2025 05:49
@github-actions
Copy link
Contributor

Assigning reviewers:

R: @chamikaramj for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

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.

[Bug]: PubsubUnboundedSink not following 1000 messages per batch limit

1 participant