Skip to content

Support ACKNOWLEDGEMENT_MODE for JmsIO#39253

Open
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:jmsackmode
Open

Support ACKNOWLEDGEMENT_MODE for JmsIO#39253
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:jmsackmode

Conversation

@Abacn

@Abacn Abacn commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Introduce INDIVIDUAL_ACKNOWLEDGEMENT for supported providers

(Re)introduce CLIENT_ACKNOWLEDGEMENT_UNSAFE that restore the behavior prior to Beam 2.55.0, provide a way to mitigate #30218 (comment)

  • CheckpointMark behavior in alignment with different ACKNOWLEDGEMENT_MODE

  • Ref count active checkpoint for quicker onClose that releases session

  • Fix hanging checkpoint when no incoming data in direct runner. This allows us to do an exact assert

  • Optimize long running unit test usign a short retry

  • Re-enable AMQP integration test after stuck unack messages resolved

Please add a meaningful description for your change here

Fix #26203 ; fix #26175


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
Copy Markdown
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 adds support for configurable acknowledgement modes in JmsIO, enabling better compatibility with various JMS providers and performance tuning. The changes involve a significant refactoring of how JmsIO manages JMS sessions and consumers, ensuring that resources are correctly handled across different acknowledgement strategies. Additionally, the PR improves the reliability of integration tests and addresses a bug in the direct runner's checkpoint finalization logic.

Highlights

  • Added AcknowledgeMode Support: Introduced configurable AcknowledgeMode (CLIENT_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE_UNSAFE, INDIVIDUAL_ACKNOWLEDGE) to JmsIO to support diverse JMS provider requirements.
  • Refactored Checkpoint Management: Updated JmsCheckpointMark and UnboundedJmsReader to track active checkpoints and manage session/consumer lifecycles appropriately for each acknowledgement mode.
  • Improved Resource Cleanup: Enhanced UnboundedJmsReader to delay connection closure until all active checkpoints are finalized, preventing premature resource release.
  • Integration Test Enhancements: Updated integration tests to validate new acknowledgement modes and improved test stability by fixing port management and cleanup logic.
  • Bug Fixes: Fixed a checkpoint finalization issue in UnboundedReadEvaluatorFactory to ensure proper cleanup of old checkpoints.
New Features

🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 support for multiple acknowledgment modes in JmsIO (CLIENT_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE_UNSAFE, and INDIVIDUAL_ACKNOWLEDGE) to optimize message consumption and prevent message backlogs, along with corresponding updates to checkpointing and reader closing logic. The review feedback highlights two important issues: a potential race condition in JmsIO.java where the consumer and session could be closed concurrently on different threads in CLIENT_ACKNOWLEDGE mode, and a potential hang during reader shutdown if a RuntimeException in JmsCheckpointMark.finalizeCheckpoint() prevents the decrement of activeCheckpoints.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

if (watermark.isBefore(BoundedWindow.TIMESTAMP_MAX_VALUE)) {
// If the reader had no elements available, but the shard is not done, reuse it later
// Might be better to finalize old checkpoint.
// If the reader had no elements available, but the shard is not done, reuse it later.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in a typical run, 5/6 tests observe small amount of messages are not acked due to the known issue noted here:

// TODO(yathu) resolve pending messages with direct runner then we can simply assert

  • testPublishingThenReadingAllClientAcknowledgeUnsafe: 1
  • testPublishingThenReadingAllIndividualAcknowledge: 13
  • testPublishingThenReadingAllIndividualAcknowledge: 13
  • testPublishingThenReadingAll: 34
  • testPublishingThenReadingAll: 33

@Abacn

Abacn commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

possible reviewers R: @tkaymak (for streaming IO) @shunping would you mind taking a look?

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

* CheckpointMark behavior in alignment with different ACKNOWLEDGEMENT_MODE

* Ref count active checkpoint for quicker onClose that releases session

* Fix hanging checkpoint when no incoming data in direct runner. This
  allows us to do an exact assert

* Optimize long running unit test usign a short retry

* Re-enable AMQP integration test after stuck unack messages resolved
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.

[Failing Test]: JmsIO tests flaky due to port occupied [Failing Test]: JmsIOIT.testPublishingThenReadingAll highly flaky

1 participant