Skip to content

[Cloud Spanner Change Streams] Fix inverted evaluation of cancelQueryOnHeartbeat. #38695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scwhittle wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −3
Open

[Cloud Spanner Change Streams] Fix inverted evaluation of cancelQueryOnHeartbeat. #38695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...n/java/org/apache/beam/sdk/io/gcp/spanner/changestreams/action/HeartbeatRecordAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,6 @@ public Optional<ProcessContinuation> run(
return Optional.empty();
}
// no new data, finish reading data
return cancelQueryOnHeartbeat ? Optional.empty() : Optional.of(ProcessContinuation.resume());
return cancelQueryOnHeartbeat ? Optional.of(ProcessContinuation.resume()) : Optional.empty();
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 26, 2026

Choose a reason for hiding this comment

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

high

Inverting the ternary operator here makes the behavior of cancelQueryOnHeartbeat opposite to its name:

  • If cancelQueryOnHeartbeat is true, it now returns ProcessContinuation.resume() (meaning it does not cancel the query on heartbeat).
  • If cancelQueryOnHeartbeat is false, it now returns Optional.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.

Suggested change
return cancelQueryOnHeartbeat ? Optional.of(ProcessContinuation.resume()) : Optional.empty();
return cancelQueryOnHeartbeat ? Optional.empty() : Optional.of(ProcessContinuation.resume());

}
}
4 changes: 2 additions & 2 deletions ...va/org/apache/beam/sdk/io/gcp/spanner/changestreams/action/HeartbeatRecordActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ public void testEndTimestampNotReachedOnCancellingAction() {
watermarkEstimator,
endTimestamp);

assertEquals(Optional.empty(), maybeContinuation);
assertEquals(Optional.of(ProcessContinuation.resume()), maybeContinuation);
verify(watermarkEstimator).setWatermark(new Instant(timestamp.toSqlTimestamp().getTime()));
}

Expand All @@ -254,7 +254,7 @@ public void testEndTimestampNotReachedOnAction() {
watermarkEstimator,
endTimestamp);

assertEquals(Optional.of(ProcessContinuation.resume()), maybeContinuation);
assertEquals(Optional.empty(), maybeContinuation);
verify(watermarkEstimator).setWatermark(new Instant(timestamp.toSqlTimestamp().getTime()));
}
}
Loading