Move next parameters calculation logic in job operator

Resolves #4911

Author: fmbenhassine

spring-batch-core/src/main/java/org/springframework/batch/core/job/parameters/JobParametersBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2024 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,40 +52,18 @@ public class JobParametersBuilder {
 
 	private Map<String, JobParameter<?>> parameterMap;
 
-	private JobExplorer jobExplorer;
-
 	/**
 	 * Default constructor. Initializes the builder with empty parameters.
 	 */
 	public JobParametersBuilder() {
 		this.parameterMap = new HashMap<>();
 	}
 
-	/**
-	 * @param jobExplorer {@link JobExplorer} used for looking up previous job parameter
-	 * information.
-	 */
-	public JobParametersBuilder(JobExplorer jobExplorer) {
-		this.jobExplorer = jobExplorer;
-		this.parameterMap = new HashMap<>();
-	}
-
 	/**
 	 * Copy constructor. Initializes the builder with the supplied parameters.
 	 * @param jobParameters {@link JobParameters} instance used to initialize the builder.
 	 */
 	public JobParametersBuilder(JobParameters jobParameters) {
-		this(jobParameters, null);
-	}
-
-	/**
-	 * Copy constructor. Initializes the builder with the supplied parameters.
-	 * @param jobParameters {@link JobParameters} instance used to initialize the builder.
-	 * @param jobExplorer {@link JobExplorer} used for looking up previous job parameter
-	 * information.
-	 */
-	public JobParametersBuilder(JobParameters jobParameters, JobExplorer jobExplorer) {
-		this.jobExplorer = jobExplorer;
 		this.parameterMap = new HashMap<>(jobParameters.getParameters());
 	}
 
@@ -319,51 +297,4 @@ public JobParametersBuilder addJobParameters(JobParameters jobParameters) {
 		return this;
 	}
 
-	/**
-	 * Initializes the {@link JobParameters} based on the state of the {@link Job}. This
-	 * should be called after all parameters have been entered into the builder. All
-	 * parameters already set on this builder instance are appended to those retrieved
-	 * from the job incrementer, overriding any with the same key (this is the same
-	 * behavior as
-	 * {@link org.springframework.batch.core.launch.support.CommandLineJobRunner} with the
-	 * {@code -next} option and
-	 * {@link org.springframework.batch.core.launch.JobOperator#startNextInstance(String)}).
-	 * @param job The job for which the {@link JobParameters} are being constructed.
-	 * @return a reference to this object.
-	 *
-	 * @since 4.0
-	 */
-	public JobParametersBuilder getNextJobParameters(Job job) {
-		Assert.state(this.jobExplorer != null, "A JobExplorer is required to get next job parameters");
-		Assert.notNull(job, "Job must not be null");
-		Assert.notNull(job.getJobParametersIncrementer(),
-				"No job parameters incrementer found for job=" + job.getName());
-
-		String name = job.getName();
-		JobParameters nextParameters;
-		JobInstance lastInstance = this.jobExplorer.getLastJobInstance(name);
-		JobParametersIncrementer incrementer = job.getJobParametersIncrementer();
-		if (lastInstance == null) {
-			// Start from a completely clean sheet
-			nextParameters = incrementer.getNext(new JobParameters());
-		}
-		else {
-			JobExecution previousExecution = this.jobExplorer.getLastJobExecution(lastInstance);
-			if (previousExecution == null) {
-				// Normally this will not happen - an instance exists with no executions
-				nextParameters = incrementer.getNext(new JobParameters());
-			}
-			else {
-				nextParameters = incrementer.getNext(previousExecution.getJobParameters());
-			}
-		}
-
-		// start with parameters from the incrementer
-		Map<String, JobParameter<?>> nextParametersMap = new HashMap<>(nextParameters.getParameters());
-		// append new parameters (overriding those with the same key)
-		nextParametersMap.putAll(this.parameterMap);
-		this.parameterMap = nextParametersMap;
-		return this;
-	}
-
 }

spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/CommandLineJobRunner.java

@@ -373,8 +373,23 @@ int start(String jobPath, String jobIdentifier, String[] parameters, Set<String>
 			}
 
 			if (opts.contains("-next")) {
-				jobParameters = new JobParametersBuilder(jobParameters, jobExplorer).getNextJobParameters(job)
-					.toJobParameters();
+				JobInstance lastInstance = jobRepository.getLastJobInstance(jobName);
+				JobParametersIncrementer incrementer = job.getJobParametersIncrementer();
+				if (lastInstance == null) {
+					// Start from a completely clean sheet
+					jobParameters = incrementer.getNext(new JobParameters());
+				}
+				else {
+					JobExecution previousExecution = jobRepository.getLastJobExecution(lastInstance);
+					if (previousExecution == null) {
+						// Normally this will not happen - an instance exists with no
+						// executions
+						jobParameters = incrementer.getNext(new JobParameters());
+					}
+					else {
+						jobParameters = incrementer.getNext(previousExecution.getJobParameters());
+					}
+				}
 			}
 
 			JobExecution jobExecution = launcher.run(job, jobParameters);

spring-batch-core/src/main/java/org/springframework/batch/core/launch/support/SimpleJobOperator.java

@@ -34,6 +34,7 @@
 import org.springframework.batch.core.job.JobInstance;
 import org.springframework.batch.core.job.parameters.JobParameters;
 import org.springframework.batch.core.job.parameters.JobParametersBuilder;
+import org.springframework.batch.core.job.parameters.JobParametersIncrementer;
 import org.springframework.batch.core.job.parameters.JobParametersInvalidException;
 import org.springframework.batch.core.step.Step;
 import org.springframework.batch.core.step.StepExecution;
@@ -223,51 +224,52 @@ public Long startNextInstance(String jobName)
 		}
 
 		Job job = jobRegistry.getJob(jobName);
-		JobParameters parameters = new JobParametersBuilder(jobRepository).getNextJobParameters(job).toJobParameters();
-		if (logger.isInfoEnabled()) {
-			logger.info(String.format("Attempting to launch job with name=%s and parameters=%s", jobName, parameters));
-		}
-		try {
-			return run(job, parameters).getId();
-		}
-		catch (JobExecutionAlreadyRunningException e) {
-			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job already running", jobName, parameters), e);
-		}
-		catch (JobRestartException e) {
-			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job not restartable", jobName, parameters), e);
-		}
-		catch (JobInstanceAlreadyCompleteException e) {
-			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job instance already complete", jobName, parameters), e);
-		}
-
+		return startNextInstance(job).getId();
 	}
 
 	@Override
 	public JobExecution startNextInstance(Job job)
 			throws NoSuchJobException, UnexpectedJobExecutionException, JobParametersInvalidException {
-
-		JobParameters parameters = new JobParametersBuilder(jobRepository).getNextJobParameters(job).toJobParameters();
+		Assert.notNull(job, "Job must not be null");
+		Assert.notNull(job.getJobParametersIncrementer(),
+				"No job parameters incrementer found for job=" + job.getName());
+		String name = job.getName();
+		JobParameters nextParameters;
+		JobInstance lastInstance = jobRepository.getLastJobInstance(name);
+		JobParametersIncrementer incrementer = job.getJobParametersIncrementer();
+		if (lastInstance == null) {
+			// Start from a completely clean sheet
+			nextParameters = incrementer.getNext(new JobParameters());
+		}
+		else {
+			JobExecution previousExecution = jobRepository.getLastJobExecution(lastInstance);
+			if (previousExecution == null) {
+				// Normally this will not happen - an instance exists with no executions
+				nextParameters = incrementer.getNext(new JobParameters());
+			}
+			else {
+				nextParameters = incrementer.getNext(previousExecution.getJobParameters());
+			}
+		}
 		if (logger.isInfoEnabled()) {
-			logger.info(String.format("Attempting to launch job with name=%s and parameters=%s", job.getName(),
-					parameters));
+			logger.info(String.format("Attempting to launch next instance of job with name=%s and parameters=%s",
+					job.getName(), nextParameters));
 		}
 		try {
-			return run(job, parameters);
+			return run(job, nextParameters);
 		}
 		catch (JobExecutionAlreadyRunningException e) {
 			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job already running", job.getName(), parameters), e);
+					String.format(ILLEGAL_STATE_MSG, "job already running", job.getName(), nextParameters), e);
 		}
 		catch (JobRestartException e) {
 			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job not restartable", job.getName(), parameters), e);
+					String.format(ILLEGAL_STATE_MSG, "job not restartable", job.getName(), nextParameters), e);
 		}
 		catch (JobInstanceAlreadyCompleteException e) {
 			throw new UnexpectedJobExecutionException(
-					String.format(ILLEGAL_STATE_MSG, "job instance already complete", job.getName(), parameters), e);
+					String.format(ILLEGAL_STATE_MSG, "job instance already complete", job.getName(), nextParameters),
+					e);
 		}
 
 	}

spring-batch-core/src/test/java/org/springframework/batch/core/JobParametersBuilderTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2024 the original author or authors.
+ * Copyright 2008-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,16 +30,11 @@
 import org.springframework.batch.core.job.parameters.JobParameter;
 import org.springframework.batch.core.job.parameters.JobParameters;
 import org.springframework.batch.core.job.parameters.JobParametersBuilder;
-import org.springframework.batch.core.repository.explore.JobExplorer;
-import org.springframework.batch.core.launch.support.RunIdIncrementer;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
 
 /**
  * @author Lucas Ward
@@ -54,8 +49,6 @@ class JobParametersBuilderTests {
 
 	private SimpleJob job;
 
-	private JobExplorer jobExplorer;
-
 	private List<JobInstance> jobInstanceList;
 
 	private List<JobExecution> jobExecutionList;
@@ -65,10 +58,9 @@ class JobParametersBuilderTests {
 	@BeforeEach
 	void initialize() {
 		this.job = new SimpleJob("simpleJob");
-		this.jobExplorer = mock();
 		this.jobInstanceList = new ArrayList<>(1);
 		this.jobExecutionList = new ArrayList<>(1);
-		this.parametersBuilder = new JobParametersBuilder(this.jobExplorer);
+		this.parametersBuilder = new JobParametersBuilder();
 	}
 
 	@Test
@@ -162,90 +154,4 @@ void testAddJobParameter() {
 		assertEquals("bar", parameters.get("foo").getValue());
 	}
 
-	@Test
-	void testGetNextJobParametersFirstRun() {
-		job.setJobParametersIncrementer(new RunIdIncrementer());
-		initializeForNextJobParameters();
-		this.parametersBuilder.getNextJobParameters(this.job);
-		defaultNextJobParametersVerify(this.parametersBuilder.toJobParameters(), 4);
-	}
-
-	@Test
-	void testGetNextJobParametersNoIncrementer() {
-		initializeForNextJobParameters();
-		final Exception expectedException = assertThrows(IllegalArgumentException.class,
-				() -> this.parametersBuilder.getNextJobParameters(this.job));
-		assertEquals("No job parameters incrementer found for job=simpleJob", expectedException.getMessage());
-	}
-
-	@Test
-	void testGetNextJobParameters() {
-		this.job.setJobParametersIncrementer(new RunIdIncrementer());
-		this.jobInstanceList.add(new JobInstance(1L, "simpleJobInstance"));
-		this.jobExecutionList.add(getJobExecution(this.jobInstanceList.get(0), null));
-		when(this.jobExplorer.getJobInstances("simpleJob", 0, 1)).thenReturn(this.jobInstanceList);
-		when(this.jobExplorer.getJobExecutions(any())).thenReturn(this.jobExecutionList);
-		initializeForNextJobParameters();
-		this.parametersBuilder.getNextJobParameters(this.job);
-		defaultNextJobParametersVerify(this.parametersBuilder.toJobParameters(), 4);
-	}
-
-	@Test
-	void testGetNextJobParametersRestartable() {
-		this.job.setRestartable(true);
-		this.job.setJobParametersIncrementer(new RunIdIncrementer());
-		this.jobInstanceList.add(new JobInstance(1L, "simpleJobInstance"));
-		this.jobExecutionList.add(getJobExecution(this.jobInstanceList.get(0), BatchStatus.FAILED));
-		when(this.jobExplorer.getJobInstances("simpleJob", 0, 1)).thenReturn(this.jobInstanceList);
-		when(this.jobExplorer.getJobExecutions(any())).thenReturn(this.jobExecutionList);
-		initializeForNextJobParameters();
-		this.parametersBuilder.addLong("NON_IDENTIFYING_LONG", 1L, false);
-		this.parametersBuilder.getNextJobParameters(this.job);
-		baseJobParametersVerify(this.parametersBuilder.toJobParameters(), 5);
-	}
-
-	@Test
-	void testGetNextJobParametersNoPreviousExecution() {
-		this.job.setJobParametersIncrementer(new RunIdIncrementer());
-		this.jobInstanceList.add(new JobInstance(1L, "simpleJobInstance"));
-		when(this.jobExplorer.getJobInstances("simpleJob", 0, 1)).thenReturn(this.jobInstanceList);
-		when(this.jobExplorer.getJobExecutions(any())).thenReturn(this.jobExecutionList);
-		initializeForNextJobParameters();
-		this.parametersBuilder.getNextJobParameters(this.job);
-		baseJobParametersVerify(this.parametersBuilder.toJobParameters(), 4);
-	}
-
-	@Test
-	void testMissingJobExplorer() {
-		this.parametersBuilder = new JobParametersBuilder();
-		assertThrows(IllegalStateException.class, () -> this.parametersBuilder.getNextJobParameters(this.job));
-	}
-
-	private void initializeForNextJobParameters() {
-		this.parametersBuilder.addDate("SCHEDULE_DATE", date);
-		this.parametersBuilder.addLong("LONG", 1L);
-		this.parametersBuilder.addString("STRING", "string value");
-	}
-
-	private void defaultNextJobParametersVerify(JobParameters parameters, int paramCount) {
-		baseJobParametersVerify(parameters, paramCount);
-		assertEquals(1, parameters.getLong("run.id"));
-	}
-
-	private void baseJobParametersVerify(JobParameters parameters, int paramCount) {
-		assertEquals(date, parameters.getDate("SCHEDULE_DATE"));
-		assertEquals(1L, parameters.getLong("LONG").longValue());
-		assertEquals("string value", parameters.getString("STRING"));
-		assertEquals(paramCount, parameters.getParameters().size());
-	}
-
-	private JobExecution getJobExecution(JobInstance jobInstance, BatchStatus batchStatus) {
-		JobExecution jobExecution = new JobExecution(jobInstance, 1L, null);
-		if (batchStatus != null) {
-			jobExecution.setStatus(batchStatus);
-		}
-		return jobExecution;
-
-	}
-
 }