Migration Recipe for SpringBatch 5.0

[desprez]

Springboot 3.x Spring-Boot-3.0-Release-Notes comes with new version 5.0 of Spring-batch and lots of deprecated stuff and changes.
Do you plan to add recipes for this migration, here or in annoter repository ?

[timtebeek]

This repository would probably be the best place for such migration recipes, similar to how we've included recipes for Spring Data migrations here as well. I imagine a new package org.openrewrite.java.spring.batch should be enough to get started for now. Would you be willing to contribute migration recipes to kick this off?

I'll link the Spring Batch v5.0.0 Release and Migration Guide here for others as well.

Quickly looking through the migration guide there's:

• Dependency upgrades such as Spring Framework 6, Jakarta EE 9, Hibernate 6.
  • There are already existing efforts for these migrations that we can link to in a Spring Batch 5 migration
• Database schema updates
  • Not clear to me if these would require a recipe.
• Job repository/explorer configuration updates
• Transaction manager bean exposure/configuration
• JobBuilderFactory and StepBuilderFactory bean exposure/configuration
  
• Data types updates
  • Metric counters (readCount, writeCount, etc) in org.springframework.batch.core.StepExecution and org.springframework.batch.core.StepContribution have been changed from int to long
  • The skipCount parameter in org.springframework.batch.core.step.skip.SkipPolicy#shouldSkip has been changed from int to long. This is related to the previous point.
  • The type of fields startTime, endTime, createTime and lastUpdated in JobExecution and StepExecution was changed from java.util.Date to java.time.LocalDateTime.
• The dependency to Jackson was made optional. In order to use the JacksonExecutionContextStringSerializer, jackson-core should be added to the classpath.
• SystemCommandTasklet updates
• Moved APIs some Migration Recipes for SpringBatch 5.0  #280
  • The BatchMetrics class (which is intended for internal use only) has been moved from org.springframework.batch.core.metrics to the org.springframework.batch.core.observability package.
  • The Chunk class was moved from the org.springframework.batch.core.step.item package (spring-batch-core module) to the org.springframework.batch.item package (spring-batch-infrastrucutre module)
  • The ScopeConfiguration class has moved from org.springframework.batch.core.configuration.annotation to org.springframework.batch.core.configuration.support
• Removed APIs
  • The signature of the method ItemWriter#write(List) was changed to ItemWriter#write(Chunk)
    • Change usages of items in those method with items.getItems(), such as in items.stream()
• Deprecated APIs
  • JobBuilderFactory
  • ChunkListenerSupport
  • StepExecutionListenerSupport
  • RepeatListenerSupport
  • JobExecutionListenerSupport
  • SkipListenerSupport

[desprez]

Hello,
please take a look for this pr #280

[crankydillo]

Is there a plan for the spring-batch migration to be embedded in the spring-boot 3 migration somehow? Or is it expected that someone would run spring-boot-3.0 upgrade and then spring-batch-5.0 upgrade? I would assume the former since spring-boot governs batch version, right?

Anyhow, I'm asking because I work on a project that has some similarities to spring-boot and am wondering how to pattern upgrades. I promise not to derail this issue:)

[timtebeek]

The plan is certainly to make these recipes part of a regular Spring Boot migration; there's good work already done in

• Spring Batch recipe for MigrateStepBuilderFactory #284
  But I wasn't immediately able to work out the final bit needed to get it going and ready for a merge.

[timtebeek]

The skip policy changes were also brought up on this PR, for a potential declarative recipe fix

• Add ChangeMethodParameter for modify parameters in method declaration rewrite#4683