Skip to content
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

Apply optimistic locking for MongoDB repository #4795

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Apply optimistic locking for MongoDB repository #4795

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
12 changes: 10 additions & 2 deletions ...ore/src/main/java/org/springframework/batch/core/repository/dao/MongoJobExecutionDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.springframework.batch.core.JobInstance;
import org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter;
import org.springframework.batch.core.repository.persistence.converter.JobInstanceConverter;
import org.springframework.dao.OptimisticLockingFailureException;
import org.springframework.data.domain.Sort;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.query.Query;
Expand All @@ -33,6 +34,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class MongoJobExecutionDao implements JobExecutionDao {
Expand Down Expand Up @@ -72,10 +74,16 @@ public void saveJobExecution(JobExecution jobExecution) {

@Override
public void updateJobExecution(JobExecution jobExecution) {
Query query = query(where("jobExecutionId").is(jobExecution.getId()));
Query query = query(
where("jobExecutionId").is(jobExecution.getId()).and("version").is(jobExecution.getVersion()));
org.springframework.batch.core.repository.persistence.JobExecution jobExecutionToUpdate = this.jobExecutionConverter
.fromJobExecution(jobExecution);
this.mongoOperations.findAndReplace(query, jobExecutionToUpdate, JOB_EXECUTIONS_COLLECTION_NAME);
jobExecutionToUpdate.incrementVersion();
if (this.mongoOperations.findAndReplace(query, jobExecutionToUpdate, JOB_EXECUTIONS_COLLECTION_NAME) == null) {
throw new OptimisticLockingFailureException("Attempt to update step execution id=" + jobExecution.getId()
+ " with wrong version (" + jobExecution.getVersion() + ")");
}
jobExecution.incrementVersion();
}

@Override
Expand Down
13 changes: 11 additions & 2 deletions ...re/src/main/java/org/springframework/batch/core/repository/dao/MongoStepExecutionDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.repository.persistence.converter.JobExecutionConverter;
import org.springframework.batch.core.repository.persistence.converter.StepExecutionConverter;
import org.springframework.dao.OptimisticLockingFailureException;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
Expand All @@ -35,6 +36,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class MongoStepExecutionDao implements StepExecutionDao {
Expand Down Expand Up @@ -81,10 +83,17 @@ public void saveStepExecutions(Collection<StepExecution> stepExecutions) {

@Override
public void updateStepExecution(StepExecution stepExecution) {
Query query = query(where("stepExecutionId").is(stepExecution.getId()));
Query query = query(
where("stepExecutionId").is(stepExecution.getId()).and("version").is(stepExecution.getVersion()));
org.springframework.batch.core.repository.persistence.StepExecution stepExecutionToUpdate = this.stepExecutionConverter
.fromStepExecution(stepExecution);
this.mongoOperations.findAndReplace(query, stepExecutionToUpdate, STEP_EXECUTIONS_COLLECTION_NAME);
stepExecutionToUpdate.incrementVersion();
if (this.mongoOperations.findAndReplace(query, stepExecutionToUpdate,
STEP_EXECUTIONS_COLLECTION_NAME) == null) {
throw new OptimisticLockingFailureException("Attempt to update step execution id=" + stepExecution.getId()
+ " with wrong version (" + stepExecution.getVersion() + ")");
}
stepExecution.incrementVersion();
}

@Override
Expand Down
22 changes: 21 additions & 1 deletion ...ore/src/main/java/org/springframework/batch/core/repository/persistence/JobExecution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class JobExecution {
Expand Down Expand Up @@ -53,6 +54,8 @@ public class JobExecution {

private ExecutionContext executionContext;

private Integer version;

public JobExecution() {
}

Expand Down Expand Up @@ -148,13 +151,30 @@ public void setExecutionContext(ExecutionContext executionContext) {
this.executionContext = executionContext;
}

public Integer getVersion() {
return version;
}

public void setVersion(Integer version) {
this.version = version;
}

public void incrementVersion() {
if (version == null) {
version = 0;
}
else {
version = version + 1;
}
}

@Override
public String toString() {
return "JobExecution{" + "id='" + id + '\'' + ", jobExecutionId=" + jobExecutionId + ", jobInstanceId="
+ jobInstanceId + ", jobParameters=" + jobParameters + ", stepExecutions=" + stepExecutions
+ ", status=" + status + ", startTime=" + startTime + ", createTime=" + createTime + ", endTime="
+ endTime + ", lastUpdated=" + lastUpdated + ", exitStatus=" + exitStatus + ", executionContext="
+ executionContext + '}';
+ executionContext + ", version=" + version + '}';
}

}
23 changes: 22 additions & 1 deletion ...re/src/main/java/org/springframework/batch/core/repository/persistence/StepExecution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class StepExecution {
Expand Down Expand Up @@ -65,6 +66,8 @@ public class StepExecution {

private boolean terminateOnly;

private Integer version;

public StepExecution() {
}

Expand Down Expand Up @@ -224,6 +227,23 @@ public void setTerminateOnly(boolean terminateOnly) {
this.terminateOnly = terminateOnly;
}

public Integer getVersion() {
return version;
}

public void setVersion(Integer version) {
this.version = version;
}

public void incrementVersion() {
if (version == null) {
version = 0;
}
else {
version = version + 1;
}
}

@Override
public String toString() {
return "StepExecution{" + "id='" + id + '\'' + ", stepExecutionId=" + stepExecutionId + ", jobExecutionId='"
Expand All @@ -232,7 +252,8 @@ public String toString() {
+ ", readSkipCount=" + readSkipCount + ", processSkipCount=" + processSkipCount + ", writeSkipCount="
+ writeSkipCount + ", filterCount=" + filterCount + ", startTime=" + startTime + ", createTime="
+ createTime + ", endTime=" + endTime + ", lastUpdated=" + lastUpdated + ", executionContext="
+ executionContext + ", exitStatus=" + exitStatus + ", terminateOnly=" + terminateOnly + '}';
+ executionContext + ", exitStatus=" + exitStatus + ", terminateOnly=" + terminateOnly + ", version="
+ version + '}';
}

}
3 changes: 3 additions & 0 deletions ...rg/springframework/batch/core/repository/persistence/converter/JobExecutionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class JobExecutionConverter {
Expand Down Expand Up @@ -54,6 +55,7 @@ public org.springframework.batch.core.JobExecution toJobExecution(JobExecution s
source.getExitStatus().exitDescription()));
jobExecution.setExecutionContext(
new org.springframework.batch.item.ExecutionContext(source.getExecutionContext().map()));
jobExecution.setVersion(source.getVersion());
return jobExecution;
}

Expand All @@ -77,6 +79,7 @@ public JobExecution fromJobExecution(org.springframework.batch.core.JobExecution
new ExitStatus(source.getExitStatus().getExitCode(), source.getExitStatus().getExitDescription()));
org.springframework.batch.item.ExecutionContext executionContext = source.getExecutionContext();
jobExecution.setExecutionContext(new ExecutionContext(executionContext.toMap(), executionContext.isDirty()));
jobExecution.setVersion(source.getVersion());
return jobExecution;
}

Expand Down
3 changes: 3 additions & 0 deletions ...g/springframework/batch/core/repository/persistence/converter/StepExecutionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

/**
* @author Mahmoud Ben Hassine
* @author Yanming Zhou
* @since 5.2.0
*/
public class StepExecutionConverter {
Expand Down Expand Up @@ -50,6 +51,7 @@ public org.springframework.batch.core.StepExecution toStepExecution(StepExecutio
if (source.isTerminateOnly()) {
stepExecution.setTerminateOnly();
}
stepExecution.setVersion(source.getVersion());
return stepExecution;
}

Expand Down Expand Up @@ -77,6 +79,7 @@ public StepExecution fromStepExecution(org.springframework.batch.core.StepExecut
org.springframework.batch.item.ExecutionContext executionContext = source.getExecutionContext();
stepExecution.setExecutionContext(new ExecutionContext(executionContext.toMap(), executionContext.isDirty()));
stepExecution.setTerminateOnly(source.isTerminateOnly());
stepExecution.setVersion(source.getVersion());
return stepExecution;
}

Expand Down