Skip to content

Backport to branch(3.16) : Fix error handling for one-phase commit #2830

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

Merged
merged 1 commit into from
Jul 7, 2025
Merged

Backport to branch(3.16) : Fix error handling for one-phase commit #2830

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
5 changes: 3 additions & 2 deletions core/src/main/java/com/scalar/db/transaction/consensuscommit/CommitHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,8 @@ protected void handleCommitConflict(Snapshot snapshot, Exception cause)
}

@VisibleForTesting
void onePhaseCommitRecords(Snapshot snapshot) throws CommitException {
void onePhaseCommitRecords(Snapshot snapshot)
throws CommitConflictException, UnknownTransactionStatusException {
try {
OnePhaseCommitMutationComposer composer =
new OnePhaseCommitMutationComposer(snapshot.getId(), tableMetadataManager);
Expand All @@ -279,7 +280,7 @@ void onePhaseCommitRecords(Snapshot snapshot) throws CommitException {
e,
snapshot.getId());
} catch (ExecutionException e) {
throw new CommitException(
throw new UnknownTransactionStatusException(
CoreError.CONSENSUS_COMMIT_COMMITTING_RECORDS_FAILED.buildMessage(), e, snapshot.getId());
}
}
Expand Down
19 changes: 11 additions & 8 deletions core/src/test/java/com/scalar/db/transaction/consensuscommit/CommitHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1089,7 +1089,7 @@ public void canOnePhaseCommit_WhenMutationsGrouperThrowsException_ShouldThrowCom

@Test
public void onePhaseCommitRecords_WhenSuccessful_ShouldMutateUsingComposerMutations()
throws CommitException, ExecutionException {
throws CommitConflictException, UnknownTransactionStatusException, ExecutionException {
// Arrange
Snapshot snapshot = spy(prepareSnapshotWithSamePartitionPut());
doNothing().when(storage).mutate(anyList());
Expand Down Expand Up @@ -1131,15 +1131,16 @@ public void onePhaseCommitRecords_WhenSuccessful_ShouldMutateUsingComposerMutati
}

@Test
public void onePhaseCommitRecords_WhenExecutionExceptionThrown_ShouldThrowCommitException()
throws ExecutionException {
public void
onePhaseCommitRecords_WhenExecutionExceptionThrown_ShouldThrowUnknownTransactionStatusException()
throws ExecutionException {
// Arrange
Snapshot snapshot = prepareSnapshotWithSamePartitionPut();
doThrow(ExecutionException.class).when(storage).mutate(anyList());

// Act Assert
assertThatThrownBy(() -> handler.onePhaseCommitRecords(snapshot))
.isInstanceOf(CommitException.class)
.isInstanceOf(UnknownTransactionStatusException.class)
.hasCauseInstanceOf(ExecutionException.class);
}

Expand All @@ -1162,17 +1163,19 @@ public void commit_OnePhaseCommitted_ShouldNotThrowAnyException()
}

@Test
public void commit_OnePhaseCommitted_CommitExceptionThrown_ShouldThrowCommitException()
throws CommitException {
public void
commit_OnePhaseCommitted_UnknownTransactionStatusExceptionThrown_ShouldThrowUnknownTransactionStatusException()
throws CommitException, UnknownTransactionStatusException {
// Arrange
CommitHandler handler = spy(createCommitHandlerWithOnePhaseCommit());
Snapshot snapshot = prepareSnapshotWithSamePartitionPut();

doReturn(true).when(handler).canOnePhaseCommit(snapshot);
doThrow(CommitException.class).when(handler).onePhaseCommitRecords(snapshot);
doThrow(UnknownTransactionStatusException.class).when(handler).onePhaseCommitRecords(snapshot);

// Act Assert
assertThatThrownBy(() -> handler.commit(snapshot, true)).isInstanceOf(CommitException.class);
assertThatThrownBy(() -> handler.commit(snapshot, true))
.isInstanceOf(UnknownTransactionStatusException.class);
Comment on lines +1177 to +1178
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jul 7, 2025

Choose a reason for hiding this comment

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

medium

The snapshot for this test is created using prepareSnapshotWithSamePartitionPut(), which includes write operations. However, commit() is called with readOnly=true. This is an inconsistent state and makes the test confusing. For a snapshot with writes, readOnly should be false. While the test currently passes due to mocking, it's better to use a realistic setup to improve clarity and ensure the test remains robust against future changes.

Suggested change
assertThatThrownBy(() -> handler.commit(snapshot, true))
.isInstanceOf(UnknownTransactionStatusException.class);
assertThatThrownBy(() -> handler.commit(snapshot, false))
.isInstanceOf(UnknownTransactionStatusException.class);


verify(handler).onFailureBeforeCommit(snapshot);
}
Expand Down
6 changes: 4 additions & 2 deletions ...test/java/com/scalar/db/transaction/consensuscommit/CommitHandlerWithGroupCommitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,8 @@ public void onePhaseCommitRecords_WhenSuccessful_ShouldMutateUsingComposerMutati
@Disabled("Enabling both one-phase commit and group commit is not supported")
@Override
@Test
public void onePhaseCommitRecords_WhenExecutionExceptionThrown_ShouldThrowCommitException() {}
public void
onePhaseCommitRecords_WhenExecutionExceptionThrown_ShouldThrowUnknownTransactionStatusException() {}

@Disabled("Enabling both one-phase commit and group commit is not supported")
@Override
Expand All @@ -264,5 +265,6 @@ public void commit_OnePhaseCommitted_ShouldNotThrowAnyException() {}
@Disabled("Enabling both one-phase commit and group commit is not supported")
@Override
@Test
public void commit_OnePhaseCommitted_CommitExceptionThrown_ShouldThrowCommitException() {}
public void
commit_OnePhaseCommitted_UnknownTransactionStatusExceptionThrown_ShouldThrowUnknownTransactionStatusException() {}
}