Skip to content

Comments

[pull] main from spring-projects:main#9

Merged
pull[bot] merged 5 commits intoStars1233:mainfrom
spring-projects:main
May 22, 2025
Merged

[pull] main from spring-projects:main#9
pull[bot] merged 5 commits intoStars1233:mainfrom
spring-projects:main

Conversation

@pull
Copy link

@pull pull bot commented May 22, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Switch to a resourceless default batch infrastructure and introduce explicit annotations for JDBC and Mongo repositories, while refactoring registration logic, simplifying configuration, and updating associated factory beans and tests.

New Features:

  • Add @EnableJdbcJobRepository annotation for configuring a JDBC-based job repository
  • Add @EnableMongoJobRepository annotation for configuring a MongoDB-based job repository
  • Introduce JdbcDefaultBatchConfiguration and MongoDefaultBatchConfiguration for specialized repository setups

Enhancements:

  • Use ResourcelessJobRepository and ResourcelessTransactionManager as the default batch infrastructure
  • Refactor BatchRegistrar to select default, JDBC or Mongo repositories based on annotations
  • Streamline DefaultBatchConfiguration by removing legacy JDBC customization methods and deprecating jobParametersConverter
  • Expose new setter methods in JdbcJobRepositoryFactoryBean for repository properties
  • Implement getJobInstanceCount in ResourcelessJobRepository

Tests:

  • Remove tests expecting missing DataSource/TransactionManager errors under default configuration
  • Update integration tests to apply @EnableJdbcJobRepository where JDBC repositories are required

Before this commit, EnableBatchProcessing was tied to a JDBC
infrastructure. Therefore, it was impossible to use a non-JDBC
job repository with that annotation.

This commit removes the dependency to a JDBC infrastructure from
EnableBatchProcessing and introduces new annotations to configure
specific job repository implementations. It also updates the
programmatic way of configuring infrastructure beans with a base
configuration class for each supported job repository implementation.

NB: The XML namespace was not changed accordingly as the XSD will not
be updated starting from v6.

Resolves #4718
@pull pull bot added the ⤵️ pull label May 22, 2025
@pull pull bot merged commit f7fcfaa into Stars1233:main May 22, 2025
@gitstream-cm
Copy link

gitstream-cm bot commented May 22, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 3976/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

@sourcery-ai
Copy link

sourcery-ai bot commented May 22, 2025

Reviewer's Guide

This PR refactors the default Spring Batch infrastructure to use a resourceless in-memory repository by default and introduces dedicated JDBC and MongoDB configurations via new annotations. It simplifies the core DefaultBatchConfiguration, extracts database-backed setups into separate classes, and updates the registrar, factory beans, tests, and sample code accordingly.

Sequence Diagram: BatchRegistrar Job Repository Registration Logic

sequenceDiagram
    participant AppMeta as AnnotationMetadata
    participant Registrar as BatchRegistrar
    participant Registry as BeanDefinitionRegistry

    AppMeta->>+Registrar: registerBeanDefinitions(metadata, registry)
    Registrar->>Registrar: registerJobRepository(metadata, registry)
    alt jobRepository bean already defined
        Registrar-->>-AppMeta: Log info and skip
    else Check for @EnableJdbcJobRepository
        AppMeta->>Registrar: hasAnnotation(EnableJdbcJobRepository.class)
        alt @EnableJdbcJobRepository present
            Registrar->>Registrar: registerJdbcJobRepository(registry, metadata)
            Registrar->>Registry: registerBeanDefinition("jobRepository", JdbcJobRepositoryFactoryBean)
        else Check for @EnableMongoJobRepository
            AppMeta->>Registrar: hasAnnotation(EnableMongoJobRepository.class)
            alt @EnableMongoJobRepository present
                Registrar->>Registrar: registerMongoJobRepository(registry, metadata)
                Registrar->>Registry: registerBeanDefinition("jobRepository", MongoJobRepositoryFactoryBean)
            else Default Resourceless
                Registrar->>Registrar: registerDefaultJobRepository(registry)
                Registrar->>Registry: registerBeanDefinition("jobRepository", ResourcelessJobRepository)
            end
        end
    end
Loading

Class Diagram: Batch Configuration Hierarchy Changes

classDiagram
    DefaultBatchConfiguration --|> ApplicationContextAware
    JdbcDefaultBatchConfiguration --|> DefaultBatchConfiguration
    MongoDefaultBatchConfiguration --|> DefaultBatchConfiguration

    class DefaultBatchConfiguration {
        +ApplicationContext applicationContext
        +setApplicationContext(ApplicationContext) void
        +jobRepository() JobRepository 
        +jobRegistry() JobRegistry
        +jobOperator(JobRepository, JobRegistry) JobOperator
        +jobRegistrySmartInitializingSingleton(JobRegistry) JobRegistrySmartInitializingSingleton
        #getTransactionManager() PlatformTransactionManager
        #getTaskExecutor() TaskExecutor
        #getJobParametersConverter() JobParametersConverter
        #getIsolationLevelForCreate() Isolation
        #getValidateTransactionState() boolean
        #getJobKeyGenerator() JobKeyGenerator
        %% Methods removed/changed for JDBC specific config:
        %% - jobRepository() now returns ResourcelessJobRepository by default
        %% - getTransactionManager() now returns ResourcelessTransactionManager by default
        %% - getDataSource(), getDatabaseType(), getIncrementerFactory(), etc. (JDBC specific getters) removed
    }

    class JdbcDefaultBatchConfiguration {
        <<New>>
        +jobRepository() JobRepository
        #getDataSource() DataSource
        #getTransactionManager() DataSourceTransactionManager
        #getDatabaseType() String
        #getIncrementerFactory() DataFieldMaxValueIncrementerFactory
        #getClobType() int
        #getTablePrefix() String
        #getExecutionContextSerializer() ExecutionContextSerializer
        #getConversionService() ConfigurableConversionService
        #getJdbcOperations() JdbcOperations
        #getCharset() Charset
        #getMaxVarCharLength() int
    }

    class MongoDefaultBatchConfiguration {
        <<New>>
        +jobRepository() JobRepository
        #getMongoOperations() MongoOperations
        #getTransactionManager() MongoTransactionManager
    }
Loading

Class Diagram: Changes to @EnableBatchProcessing and New Repository Annotations

classDiagram
    class EnableBatchProcessing {
        +modular: boolean
        +taskExecutorRef: String
        +transactionManagerRef: String // For JobOperator
        +jobParametersConverterRef: String // Deprecated
        %% Attributes removed related to JDBC JobRepository configuration:
        %% - dataSourceRef
        %% - databaseType
        %% - executionContextSerializerRef
        %% - charset
        %% - tablePrefix
        %% - maxVarCharLength
        %% - incrementerFactoryRef
        %% - jobKeyGeneratorRef (for JobRepo)
        %% - clobType
        %% - isolationLevelForCreate
        %% - conversionServiceRef
    }

    class EnableJdbcJobRepository {
        <<New Annotation>>
        +dataSourceRef(): String
        +transactionManagerRef(): String
        +databaseType(): String
        +isolationLevelForCreate(): Isolation
        +validateTransactionState(): boolean
        +charset(): String
        +tablePrefix(): String
        +maxVarCharLength(): int
        +clobType(): int
        +jdbcOperationsRef(): String
        +jobKeyGeneratorRef(): String
        +executionContextSerializerRef(): String
        +incrementerFactoryRef(): String
        +conversionServiceRef(): String
    }

    class EnableMongoJobRepository {
        <<New Annotation>>
        +mongoOperationsRef(): String
        +transactionManagerRef(): String
        +isolationLevelForCreate(): Isolation
        +validateTransactionState(): boolean
        +jobKeyGeneratorRef(): String
    }
Loading

Class Diagram: JobRepository FactoryBean and ResourcelessJobRepository Modifications

classDiagram
    AbstractJobRepositoryFactoryBean <|-- JobRepositoryFactoryBean
    JobRepositoryFactoryBean <|-- JdbcJobRepositoryFactoryBean
    AbstractJobRepositoryFactoryBean <|-- MongoJobRepositoryFactoryBean
    JobRepository <|.. ResourcelessJobRepository

    class AbstractJobRepositoryFactoryBean {
        +jobKeyGenerator: JobKeyGenerator
        +setJobKeyGenerator(JobKeyGenerator) void
        #transactionManager: PlatformTransactionManager
        #isolationLevelForCreate: String
        #validateTransactionState: boolean
        +afterPropertiesSet() void
    }

    class JobRepositoryFactoryBean {
        %% -jobKeyGenerator: JobKeyGenerator // Field removed (moved to AbstractJobRepositoryFactoryBean)
        #dataSource: DataSource
        #jdbcOperations: JdbcOperations
        #dbType: String
        #tablePrefix: String
        #incrementerFactory: DataFieldMaxValueIncrementerFactory
        #serializer: ExecutionContextSerializer
        #clobType: int
        #conversionService: ConfigurableConversionService
        #charset: Charset
    }

    class JdbcJobRepositoryFactoryBean {
        +setClobType(int) void
        +setSerializer(ExecutionContextSerializer) void
        +setMaxVarCharLength(int) void
        +setMaxVarCharLengthForShortContext(int) void
        +setMaxVarCharLengthForExitMessage(int) void
        +setDataSource(DataSource) void
        +setJdbcOperations(JdbcOperations) void
        +setDatabaseType(String) void
        +setTablePrefix(String) void
        +setIncrementerFactory(DataFieldMaxValueIncrementerFactory) void
        +setCharset(Charset) void
        +setConversionService(ConfigurableConversionService) void
        +afterPropertiesSet() void
    }
    class MongoJobRepositoryFactoryBean{
        #createJobInstanceDao() JobInstanceDao
    }

    class ResourcelessJobRepository {
        +getJobInstanceCount(String jobName) long
    }
Loading

File-Level Changes

Change Details Files
Refactored DefaultBatchConfiguration to a resourceless default and extracted database-backed variants
  • jobRepository and jobRegistry now return Resourceless implementations
  • Removed dozens of protected getters for datasources, transaction managers, serializers, etc
  • Introduced new classes JdbcDefaultBatchConfiguration and MongoDefaultBatchConfiguration
DefaultBatchConfiguration.java
JdbcDefaultBatchConfiguration.java
MongoDefaultBatchConfiguration.java
Added EnableJdbcJobRepository and EnableMongoJobRepository annotations and updated BatchRegistrar
  • New annotations capture repository-specific properties
  • BatchRegistrar.registerJobRepository now branches on the presence of these annotations
  • Property mapping for JDBC and Mongo factory beans adjusted
EnableJdbcJobRepository.java
EnableMongoJobRepository.java
BatchRegistrar.java
Enhanced JobRepositoryFactoryBean hierarchy with public setters and key-generator support
  • Exposed setters in JdbcJobRepositoryFactoryBean for clob, charset, converters, etc
  • Added jobKeyGenerator field and setter to AbstractJobRepositoryFactoryBean
  • Ensured default jobKeyGenerator initialization in afterPropertiesSet
JdbcJobRepositoryFactoryBean.java
AbstractJobRepositoryFactoryBean.java
JobRepositoryFactoryBean.java
Improved resourceless and Mongo repositories
  • Implemented getJobInstanceCount in ResourcelessJobRepository
  • Injected jobKeyGenerator into MongoJobRepositoryFactoryBean's DAOs
ResourcelessJobRepository.java
MongoJobRepositoryFactoryBean.java
Updated tests and sample configurations to use new repository annotations
  • Removed tests expecting missing datasource/transaction manager failures
  • Added @EnableJdbcJobRepository to sample and integration test configs
  • Sample code annotations and imports adjusted to new classes
BatchRegistrarTests.java
DefaultBatchConfigurationTests.java
*IntegrationTests.java
spring-batch-samples/**/*.java

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link

coderabbitai bot commented May 22, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant