Skip to content

Allow multiple calls to rollback() #2751

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 2 commits into from
Jun 11, 2025
Merged

Allow multiple calls to rollback() #2751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2da391
Allow multiple calls to rollback()
brfrn169 Jun 10, 2025
8eed905
Merge branch 'master' into allow-multiple-calls-to-rollback
brfrn169 Jun 11, 2025
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
14 changes: 10 additions & 4 deletions core/src/main/java/com/scalar/db/common/StateManagedDistributedTransactionManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,12 @@ public void commit() throws CommitException, UnknownTransactionStatusException {

@Override
public void rollback() throws RollbackException {
if (status == Status.COMMITTED || status == Status.ROLLED_BACK) {
if (status == Status.ROLLED_BACK) {
Copy link
Contributor

@komamitsu komamitsu Jun 11, 2025

Choose a reason for hiding this comment

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

status seems to move to ROLLED_BACK even when rolling back the transaction fails. If users first receive an exception from rollback() and then try the second attempt, it will look like success while the transaction might not be rolled back. What do you think?

Copy link
Collaborator Author

@brfrn169 brfrn169 Jun 11, 2025

Choose a reason for hiding this comment

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

IMO, that’s okay. Even if rolling back a transaction fails, the transaction manager is expected to automatically and eventually roll back the transaction. So, I don’t think applications need to retry the rollback themselves. What do you think?

Copy link
Contributor

@komamitsu komamitsu Jun 11, 2025

Choose a reason for hiding this comment

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

I see. Sounds good 👍

return;
}
if (status == Status.COMMITTED) {
throw new IllegalStateException(
CoreError.TRANSACTION_ALREADY_COMMITTED_OR_ROLLED_BACK.buildMessage(status));
CoreError.TRANSACTION_ALREADY_COMMITTED.buildMessage(status));
}
try {
super.rollback();
Expand All @@ -159,9 +162,12 @@ public void rollback() throws RollbackException {

@Override
public void abort() throws AbortException {
if (status == Status.COMMITTED || status == Status.ROLLED_BACK) {
if (status == Status.ROLLED_BACK) {
return;
}
if (status == Status.COMMITTED) {
throw new IllegalStateException(
CoreError.TRANSACTION_ALREADY_COMMITTED_OR_ROLLED_BACK.buildMessage(status));
CoreError.TRANSACTION_ALREADY_COMMITTED.buildMessage(status));
}
try {
super.abort();
Expand Down
14 changes: 10 additions & 4 deletions core/src/main/java/com/scalar/db/common/StateManagedTwoPhaseCommitTransactionManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,12 @@ public void commit() throws CommitException, UnknownTransactionStatusException {

@Override
public void rollback() throws RollbackException {
if (status == Status.COMMITTED || status == Status.ROLLED_BACK) {
if (status == Status.ROLLED_BACK) {
return;
}
if (status == Status.COMMITTED) {
throw new IllegalStateException(
CoreError.TRANSACTION_ALREADY_COMMITTED_OR_ROLLED_BACK.buildMessage(status));
CoreError.TRANSACTION_ALREADY_COMMITTED.buildMessage(status));
}
try {
super.rollback();
Expand All @@ -196,9 +199,12 @@ public void rollback() throws RollbackException {

@Override
public void abort() throws AbortException {
if (status == Status.COMMITTED || status == Status.ROLLED_BACK) {
if (status == Status.ROLLED_BACK) {
return;
}
if (status == Status.COMMITTED) {
throw new IllegalStateException(
CoreError.TRANSACTION_ALREADY_COMMITTED_OR_ROLLED_BACK.buildMessage(status));
CoreError.TRANSACTION_ALREADY_COMMITTED.buildMessage(status));
}
try {
super.abort();
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/com/scalar/db/common/error/CoreError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,10 @@ public enum CoreError implements ScalarDbError {
Category.USER_ERROR, "0042", "Invalid ID specified. ID: %d", "", ""),
TRANSACTION_NOT_ACTIVE(
Category.USER_ERROR, "0043", "The transaction is not active. Status: %s", "", ""),
TRANSACTION_ALREADY_COMMITTED_OR_ROLLED_BACK(
TRANSACTION_ALREADY_COMMITTED(
Category.USER_ERROR,
"0044",
"The transaction has already been committed or rolled back. Status: %s",
"The transaction has already been committed. Status: %s",
"",
""),
TRANSACTION_NOT_PREPARED(
Expand Down
51 changes: 49 additions & 2 deletions core/src/test/java/com/scalar/db/common/StateManagedDistributedTransactionManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.only;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.scalar.db.api.Delete;
Expand All @@ -21,6 +23,7 @@
import com.scalar.db.api.SerializableStrategy;
import com.scalar.db.api.Update;
import com.scalar.db.api.Upsert;
import com.scalar.db.exception.transaction.AbortException;
import com.scalar.db.exception.transaction.CommitException;
import com.scalar.db.exception.transaction.RollbackException;
import com.scalar.db.exception.transaction.TransactionException;
Expand Down Expand Up @@ -308,12 +311,56 @@ public void rollback_AfterCommit_ShouldThrowIllegalStateException()
}

@Test
public void rollback_Twice_ShouldThrowIllegalStateException() throws RollbackException {
public void rollback_Twice_ShouldNotThrowAnyExceptionAndCallWrappedTransactionRollbackOnlyOnce()
throws RollbackException {
// Arrange
transaction.rollback();

// Act Assert
assertThatThrownBy(() -> transaction.rollback()).isInstanceOf(IllegalStateException.class);
assertThatCode(() -> transaction.rollback()).doesNotThrowAnyException();

verify(wrappedTransaction, only()).rollback();
}

@Test
public void abort_ShouldNotThrowAnyException() {
// Arrange

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterCommitFailed_ShouldNotThrowAnyException()
throws CommitException, UnknownTransactionStatusException {
// Arrange
doThrow(CommitException.class).when(wrappedTransaction).commit();
assertThatThrownBy(() -> transaction.commit()).isInstanceOf(CommitException.class);

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterCommit_ShouldThrowIllegalStateException()
throws CommitException, UnknownTransactionStatusException {
// Arrange
transaction.commit();

// Act Assert
assertThatThrownBy(() -> transaction.abort()).isInstanceOf(IllegalStateException.class);
}

@Test
public void abort_Twice_ShouldNotThrowAnyExceptionAndCallWrappedTransactionAbortOnlyOnce()
throws AbortException {
// Arrange
transaction.abort();

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();

verify(wrappedTransaction, only()).abort();
}
}
}
77 changes: 75 additions & 2 deletions .../src/test/java/com/scalar/db/common/StateManagedTwoPhaseCommitTransactionManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.only;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.scalar.db.api.Delete;
Expand All @@ -18,6 +20,7 @@
import com.scalar.db.api.TwoPhaseCommitTransactionManager;
import com.scalar.db.api.Update;
import com.scalar.db.api.Upsert;
import com.scalar.db.exception.transaction.AbortException;
import com.scalar.db.exception.transaction.CommitException;
import com.scalar.db.exception.transaction.PreparationException;
import com.scalar.db.exception.transaction.RollbackException;
Expand Down Expand Up @@ -385,12 +388,82 @@ public void rollback_AfterCommit_ShouldThrowIllegalStateException()
}

@Test
public void rollback_Twice_ShouldThrowIllegalStateException() throws RollbackException {
public void rollback_Twice_ShouldNotThrowAnyExceptionAndCallWrappedTransactionRollbackOnlyOnce()
throws RollbackException {
// Arrange
transaction.rollback();

// Act Assert
assertThatThrownBy(() -> transaction.rollback()).isInstanceOf(IllegalStateException.class);
assertThatCode(() -> transaction.rollback()).doesNotThrowAnyException();

verify(wrappedTransaction, only()).rollback();
}

@Test
public void abort_ShouldNotThrowAnyException() {
// Arrange

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterCommitFailed_ShouldNotThrowAnyException()
throws PreparationException, CommitException, UnknownTransactionStatusException {
// Arrange
doThrow(CommitException.class).when(wrappedTransaction).commit();

transaction.prepare();
assertThatThrownBy(() -> transaction.commit()).isInstanceOf(CommitException.class);

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterPrepareFailed_ShouldNotThrowAnyException() throws PreparationException {
// Arrange
doThrow(PreparationException.class).when(wrappedTransaction).prepare();
assertThatThrownBy(() -> transaction.prepare()).isInstanceOf(PreparationException.class);

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterValidateFailed_ShouldNotThrowAnyException()
throws PreparationException, ValidationException {
// Arrange
doThrow(ValidationException.class).when(wrappedTransaction).validate();

transaction.prepare();
assertThatThrownBy(() -> transaction.validate()).isInstanceOf(ValidationException.class);

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();
}

@Test
public void abort_AfterCommit_ShouldThrowIllegalStateException()
throws PreparationException, CommitException, UnknownTransactionStatusException {
// Arrange
transaction.prepare();
transaction.commit();

// Act Assert
assertThatThrownBy(() -> transaction.abort()).isInstanceOf(IllegalStateException.class);
}

@Test
public void abort_Twice_ShouldNotThrowAnyExceptionAndCallWrappedTransactionAbortOnlyOnce()
throws AbortException {
// Arrange
transaction.abort();

// Act Assert
assertThatCode(() -> transaction.abort()).doesNotThrowAnyException();

verify(wrappedTransaction, only()).abort();
}
}
}