[Cloud Spanner Change Streams] Fix inverted evaluation of cancelQueryOnHeartbeat.#38695
[Cloud Spanner Change Streams] Fix inverted evaluation of cancelQueryOnHeartbeat.#38695scwhittle wants to merge 1 commit into
Conversation
Summary of ChangesHello, 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 corrects a logic error introduced in a previous change regarding Cloud Spanner change streams. The Highlights
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 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 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 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
|
There was a problem hiding this comment.
Code Review
This pull request inverts the ternary operator in HeartbeatRecordAction.java that determines whether to resume or stop processing based on the cancelQueryOnHeartbeat flag, and updates the corresponding unit tests. The reviewer points out that this inversion makes the logic counter-intuitive and opposite to the variable's name. They suggest reverting this change and instead updating the default configuration value of cancelQueryOnHeartbeat to false if the goal was to disable the behavior by default.
| } | ||
| // no new data, finish reading data | ||
| return cancelQueryOnHeartbeat ? Optional.empty() : Optional.of(ProcessContinuation.resume()); | ||
| return cancelQueryOnHeartbeat ? Optional.of(ProcessContinuation.resume()) : Optional.empty(); |
There was a problem hiding this comment.
Inverting the ternary operator here makes the behavior of cancelQueryOnHeartbeat opposite to its name:
- If
cancelQueryOnHeartbeatistrue, it now returnsProcessContinuation.resume()(meaning it does not cancel the query on heartbeat). - If
cancelQueryOnHeartbeatisfalse, it now returnsOptional.empty()(meaning it does cancel the query on heartbeat).
This also forced the tests to be inverted in a counter-intuitive way (e.g., testEndTimestampNotReachedOnCancellingAction now asserts resume(), and testEndTimestampNotReachedOnAction now asserts Optional.empty()).
If the issue is that the feature is enabled by default when it shouldn't be, the correct fix is to change the default value of cancelQueryOnHeartbeat to false where it is initialized or configured (e.g., in the SpannerIO connector configuration or builder), rather than inverting the core logic here. Please revert this change and the test changes, and instead update the default configuration value of cancelQueryOnHeartbeat to false.
| return cancelQueryOnHeartbeat ? Optional.of(ProcessContinuation.resume()) : Optional.empty(); | |
| return cancelQueryOnHeartbeat ? Optional.empty() : Optional.of(ProcessContinuation.resume()); |
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
This was added in #37718 and was supposed to be off by default. However it is inverted so that by default heartbeat responses (after 2 seconds) trigger stopping polling spanner change stream. This increases the number of requests and load on the metadata table.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.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)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.