Skip to content

Comments

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

Merged
pull[bot] merged 1 commit intoStars1233:mainfrom
spring-projects:main
Jun 2, 2025
Merged

[pull] main from spring-projects:main#12
pull[bot] merged 1 commit intoStars1233:mainfrom
spring-projects:main

Conversation

@pull
Copy link

@pull pull bot commented Jun 2, 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

Enhance the JobRegistry implementation by auto-populating MapJobRegistry with Job beans and streamline the API to register Job instances directly while deprecating the old JobFactory-based initializer and cleaning up related configuration and tests.

New Features:

  • MapJobRegistry now implements ApplicationContextAware and SmartInitializingSingleton to automatically discover and register all Job beans in the application context.

Enhancements:

  • Simplify JobRegistry API to register and retrieve Job instances directly, removing the JobFactory abstraction and ReferenceJobFactory usage.
  • Deprecate JobRegistrySmartInitializingSingleton and remove its automatic bean registration from DefaultBatchConfiguration and BatchRegistrar.
  • Update DefaultJobLoader and JobFactoryRegistrationListener to register jobs using the new JobRegistry.register(Job) API.

Tests:

  • Update existing tests to use direct Job registration, remove tests for JobRegistrySmartInitializingSingleton, and bump copyright years.

Before this commit, it was required to populate the job registry
with a different component (like a bean post processor or a smart
initializing singleton) before being able to use it with the JobOperator.

This commit makes the `MapJobRegistry` smart enough to auto register
jobs defined in the application context. This removes the need for a
distinct component to populate the registry and therefore simplifies
the configuration.

This commit also:

- removes the usage of `JobFactory` from `JobRegistry`
- deprecates JobRegistrySmartInitializingSingleton and removes
its configuration from the default batch configuration

Resolves #4854
Resolves #4855
Resolves #4856
@pull pull bot added the ⤵️ pull label Jun 2, 2025
@pull pull bot merged commit a7f090a into Stars1233:main Jun 2, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Jun 2, 2025

Reviewer's Guide

This PR refactors the job registry to directly manage Job instances with automatic bean discovery and registration, deprecates the legacy JobRegistrySmartInitializingSingleton in favor of the enhanced MapJobRegistry, updates job registration logic across core classes, and adapts tests and configuration to the new API.

Sequence Diagram: Automatic Job Registration by MapJobRegistry

sequenceDiagram
    participant AC as ApplicationContext
    participant MJR as MapJobRegistry

    AC ->> MJR: setApplicationContext(applicationContext)
    AC ->> MJR: afterSingletonsInstantiated()
    MJR ->> AC: getBeansOfType(Job.class)
    AC -->> MJR: Map<String, Job> jobBeans
    MJR ->> MJR: map.putAll(jobBeans)
Loading

Class Diagram: Updated Job Registration Components

classDiagram
    direction LR

    class JobRegistry {
        <<Interface>>
        +register(Job job)
        +unregister(String name)
        +getJob(String name) Job
        +getJobNames() Set~String~
    }

    class MapJobRegistry {
        +ConcurrentMap~String, Job~ map
        +ApplicationContext applicationContext
        +Log logger
        +setApplicationContext(ApplicationContext context)
        +afterSingletonsInstantiated()
        +register(Job job)
        +unregister(String name)
        +getJob(String name) Job
        +getJobNames() Set~String~
    }
    MapJobRegistry --|> JobRegistry
    MapJobRegistry ..> ApplicationContext : uses
    MapJobRegistry ..> Job : aggregates

    class SmartInitializingSingleton {
        <<Interface>>
        +afterSingletonsInstantiated()
    }
    MapJobRegistry --|> SmartInitializingSingleton

    class ApplicationContextAware {
        <<Interface>>
        +setApplicationContext(ApplicationContext context)
    }
    MapJobRegistry --|> ApplicationContextAware

    class JobRegistrySmartInitializingSingleton {
        <<Deprecated>>
        -JobRegistry jobRegistry
        -BeanFactory beanFactory
        -Set~String~ jobNames
        +setJobRegistry(JobRegistry jobRegistry)
        +setBeanFactory(BeanFactory beanFactory)
        +afterPropertiesSet()
        +destroy()
        +afterSingletonsInstantiated()
        #postProcessAfterInitialization(Job job, String beanName)
    }
    JobRegistrySmartInitializingSingleton o-- JobRegistry

    class Job {
        <<Interface>>
        +getName() String
    }

    class DefaultJobLoader {
      -JobRegistry jobRegistry
      #doRegister(ConfigurableApplicationContext context, Job job)
    }
    DefaultJobLoader o-- JobRegistry

    class JobFactoryRegistrationListener {
      -JobRegistry jobRegistry
      +bind(JobFactory jobFactory, Map params)
    }
    JobFactoryRegistrationListener o-- JobRegistry

    class JobFactory {
      <<Interface>>
      +createJob() Job
      +getJobName() String
    }
    JobFactoryRegistrationListener ..> JobFactory : uses

    class DefaultBatchConfiguration {
        +jobLauncher(JobRepository jr) JobLauncher
        +jobRepository(DataSource ds, PlatformTransactionManager tm) JobRepository
        +jobRegistry() JobRegistry
        +jobOperator(JobRepository jr, JobRegistry jreg, JobLauncher jl, JobExplorer je, PlatformTransactionManager tm) JobOperator
    }
    DefaultBatchConfiguration ..> JobRegistry : creates

    class BatchRegistrar {
        +registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry)
    }
    BatchRegistrar ..> BeanDefinitionRegistry : uses
Loading

File-Level Changes

Change Details Files
Refactor MapJobRegistry to directly manage Job instances and auto-register beans
  • Implement ApplicationContextAware and SmartInitializingSingleton
  • Switch internal map from JobFactory to Job and update register/get/unregister signatures
  • Populate registry from ApplicationContext at startup
  • Add logging support via LogFactory
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/MapJobRegistry.java
Deprecate and remove JobRegistrySmartInitializingSingleton in favor of auto-registration
  • Mark SmartInitializingSingleton class as @deprecated
  • Remove bean definitions in DefaultBatchConfiguration and BatchRegistrar
  • Clean up XML contexts and test beans referencing the deprecated singleton
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobRegistrySmartInitializingSingleton.java
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/BatchRegistrar.java
multiple src/test/resources XML files
Update job registration to use direct Job instances
  • Replace ReferenceJobFactory usage with register(Job) calls
  • Adjust DefaultJobLoader to call jobRegistry.register(job)
  • Update JobFactoryRegistrationListener to register created Job directly
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultJobLoader.java
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/JobFactoryRegistrationListener.java
Adapt tests to the new registration API
  • Replace ReferenceJobFactory in tests with direct JobSupport instances
  • Update assertions to use Job.getName() instead of factory name
  • Remove tests and assertions related to JobRegistrySmartInitializingSingleton
spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/MapJobRegistryTests.java
other test classes under src/test/java
Update file metadata and imports
  • Bump copyright years to 2025 across files
  • Add Mahmoud Ben Hassine as author where applicable
  • Remove obsolete imports and tidy dependencies
multiple Java files in src/main/java and src/test/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 Jun 2, 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