Potential parameter key collision in `.getUniqueJobParameters()`

[PENEKhun]

Expected Behavior

The key used for the job parameter generated by getUniqueJobParameters() should never conflict with parameter names defined in a user’s job. Users should be able to call getUniqueJobParametersBuilder() and add any parameter name freely, without the risk of overwriting the framework-generated unique parameter.

Current Behavior

Currently, getUniqueJobParameters() uses a hardcoded "random" key.

public JobParameters getUniqueJobParameters() {
    return new JobParameters(Set.of(
        new JobParameter<>("random", this.secureRandom.nextLong(), Long.class)
    ));
}

This creates a collision risk because

JobParameters params = jobOperatorTestUtils.getUniqueJobParametersBuilder()
    .addLong("random", 12345L)  // Overwrites the unique parameter!
    .toJobParameters();

The current behavior makes it impossible to safely use getUniqueJobParametersBuilder() when a user’s job already defines a parameter named "random". In this case, the user-provided "random" parameter overwrites the framework-generated one, creating an unintended collision.

Context

• Q: What other alternatives have you considered?
  • 1. Use a namespaced key (e.g., spring.batch.test.unique) instead random key.
  • 2. UUID as key + descriptive value (e.g., {UUID="Auto-generated by Spring Batch Test for unique job parameters"})

[fmbenhassine]

The key used for the job parameter generated by getUniqueJobParameters() should never conflict with parameter names defined in a user’s job.

It is the opposite: user defined parameter names should never conflict with those provided by the framework. The method getUniqueJobParameters mentions that it adds a random number but does not specify the parameter name (which is random). Two things:

• Parameters provided by the framework should be prefixed with batch. (similar to execution context attributes)
• The method getUniqueJobParameters should be updated to add the batch. prefix to the random parameter and mentions that clearly in the Javadoc.

[PENEKhun]

The key used for the job parameter generated by getUniqueJobParameters() should never conflict with parameter names defined in a user’s job.

It is the opposite: user defined parameter names should never conflict with those provided by the framework. The method getUniqueJobParameters mentions that it adds a random number but does not specify the parameter name (which is random). Two things:

• Parameters provided by the framework should be prefixed with batch. (similar to execution context attributes)
• The method getUniqueJobParameters should be updated to add the batch. prefix to the random parameter and mentions that clearly in the Javadoc.

I applied at #5089 . Thank you!

[fmbenhassine]

Resolved in #5089. Thank you for your contribution 🙏