Deprecate JobRepository#getStepExecution(long, long)

Resolves #5007

Author: fmbenhassine

spring-batch-core/src/main/java/org/springframework/batch/core/repository/JobRepository.java

@@ -166,8 +166,8 @@ default JobExecution getJobExecution(long executionId) {
 	/**
 	 * Retrieve job executions by their job instance. The corresponding step executions
 	 * may not be fully hydrated (for example, their execution context may be missing),
-	 * depending on the implementation. In that case, use
-	 * {@link #getStepExecution(long, long)} to hydrate them.
+	 * depending on the implementation. In that case, use {@link #getStepExecution(long)}
+	 * to hydrate them.
 	 * @param jobInstance The {@link JobInstance} to query.
 	 * @return the list of all executions for the specified {@link JobInstance}.
 	 */
@@ -203,8 +203,7 @@ default JobExecution getLastJobExecution(String jobName, JobParameters jobParame
 	/**
 	 * Retrieve running job executions. The corresponding step executions may not be fully
 	 * hydrated (for example, their execution context may be missing), depending on the
-	 * implementation. In that case, use {@link #getStepExecution(long, long)} to hydrate
-	 * them.
+	 * implementation. In that case, use {@link #getStepExecution(long)} to hydrate them.
 	 * @param jobName The name of the job.
 	 * @return the set of running executions for jobs with the specified name.
 	 */
@@ -228,14 +227,27 @@ default Set<JobExecution> findRunningJobExecutions(@Nullable String jobName) {
 	 * @return the {@link StepExecution} that has this ID or {@code null} if not found.
 	 *
 	 * @see #getJobExecution(long)
+	 * @deprecated since 6.0 in favor of {@link #getStepExecution(long)}
 	 */
-	// FIXME incorrect contract: stepExecutionId is globally unique, no need for
-	// jobExecutionId
+	@Deprecated(since = "6.0", forRemoval = true)
 	@Nullable
 	default StepExecution getStepExecution(long jobExecutionId, long stepExecutionId) {
 		throw new UnsupportedOperationException();
 	}
 
+	/**
+	 * Retrieve a {@link StepExecution} by its ID. The execution context for the step
+	 * should be available in the result, and the parent job execution should have its
+	 * primitive properties, but it may not contain the job instance information.
+	 * @param stepExecutionId The step execution ID.
+	 * @return the {@link StepExecution} that has this ID or {@code null} if not found.
+	 * @since 6.0
+	 */
+	@Nullable
+	default StepExecution getStepExecution(long stepExecutionId) {
+		throw new UnsupportedOperationException();
+	}
+
 	/**
 	 * @param jobInstance {@link JobInstance} instance containing the step executions.
 	 * @param stepName the name of the step execution that might have run.

spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/mongodb/MongoStepExecutionDao.java

@@ -16,11 +16,12 @@
 package org.springframework.batch.core.repository.dao.mongodb;
 
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Optional;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobInstance;
 import org.springframework.batch.core.step.StepExecution;
@@ -88,6 +89,8 @@ public void updateStepExecution(StepExecution stepExecution) {
 		this.mongoOperations.findAndReplace(query, stepExecutionToUpdate, STEP_EXECUTIONS_COLLECTION_NAME);
 	}
 
+	@Nullable
+	@Override
 	public StepExecution getStepExecution(long stepExecutionId) {
 		Query query = query(where("stepExecutionId").is(stepExecutionId));
 		org.springframework.batch.core.repository.persistence.StepExecution stepExecution = this.mongoOperations

spring-batch-core/src/main/java/org/springframework/batch/core/repository/explore/support/SimpleJobExplorer.java

@@ -249,6 +249,7 @@ private void getJobExecutionDependencies(JobExecution jobExecution) {
 	 * ===================================================================================
 	 */
 
+	@Deprecated(since = "6.0", forRemoval = true)
 	@Nullable
 	@Override
 	public StepExecution getStepExecution(long jobExecutionId, long executionId) {

spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/ResourcelessJobRepository.java

@@ -201,6 +201,7 @@ public StepExecution createStepExecution(String stepName, JobExecution jobExecut
 		return stepExecution;
 	}
 
+	@Deprecated(since = "6.0", forRemoval = true)
 	@Override
 	@Nullable
 	public StepExecution getStepExecution(long jobExecutionId, long stepExecutionId) {
@@ -214,6 +215,25 @@ public StepExecution getStepExecution(long jobExecutionId, long stepExecutionId)
 			.orElse(null);
 	}
 
+	/**
+	 * Retrieve a {@link StepExecution} by its id.
+	 * @param stepExecutionId the id of the step execution to retrieve
+	 * @return the {@link StepExecution} with the given id if it exists, null otherwise.
+	 * @since 6.0
+	 */
+	@Override
+	@Nullable
+	public StepExecution getStepExecution(long stepExecutionId) {
+		if (this.jobExecution == null) {
+			return null;
+		}
+		return this.jobExecution.getStepExecutions()
+			.stream()
+			.filter(stepExecution -> stepExecution.getId() == stepExecutionId)
+			.findFirst()
+			.orElse(null);
+	}
+
 	@Override
 	@Nullable
 	public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) {

spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/SimpleJobRepository.java

@@ -18,6 +18,8 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.batch.core.BatchStatus;
 import org.springframework.batch.core.job.JobExecution;
 import org.springframework.batch.core.job.JobInstance;
@@ -80,6 +82,12 @@ public List<JobInstance> findJobInstances(String jobName) {
 		return this.jobInstanceDao.getJobInstances(jobName);
 	}
 
+	@Nullable
+	@Override
+	public StepExecution getStepExecution(long executionId) {
+		return this.stepExecutionDao.getStepExecution(executionId);
+	}
+
 	/**
 	 * Create a new {@link JobExecution} for the given {@link JobInstance} and
 	 * {@link JobParameters}, and associate the provided {@link ExecutionContext} with the

spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/StepExecutionRequest.java

@@ -32,6 +32,7 @@ public class StepExecutionRequest implements Serializable {
 
 	private String stepName;
 
+	// FIXME not used on the remote side, can we remove it?
 	private Long jobExecutionId;
 
 	private StepExecutionRequest() {

spring-batch-integration/src/main/java/org/springframework/batch/integration/partition/StepExecutionRequestHandler.java

@@ -45,9 +45,8 @@ public void setJobRepository(JobRepository jobRepository) {
 	@ServiceActivator
 	public StepExecution handle(StepExecutionRequest request) {
 
-		Long jobExecutionId = request.getJobExecutionId();
 		Long stepExecutionId = request.getStepExecutionId();
-		StepExecution stepExecution = jobRepository.getStepExecution(jobExecutionId, stepExecutionId);
+		StepExecution stepExecution = jobRepository.getStepExecution(stepExecutionId);
 		if (stepExecution == null) {
 			throw new NoSuchStepException("No StepExecution could be located for this request: " + request);
 		}

spring-batch-integration/src/test/java/org/springframework/batch/integration/partition/JmsIntegrationTests.java

@@ -73,7 +73,7 @@ void testLaunchJob() throws Exception {
 			// BATCH-1703: we are using a map dao so the step executions in the job
 			// execution are old and we need to
 			// pull them back out of the repository...
-			stepExecution = jobRepository.getStepExecution(jobExecution.getId(), stepExecution.getId());
+			stepExecution = jobRepository.getStepExecution(stepExecution.getId());
 			logger.debug(String.valueOf(stepExecution));
 			assertEquals(BatchStatus.COMPLETED, stepExecution.getStatus());
 		}