Skip to content

Document that the initial token is not a replay - #4982

Merged
smcvb merged 1 commit into
mainfrom
fixtoken-init-replay
Aug 27, 2026
Merged

Document that the initial token is not a replay#4982
smcvb merged 1 commit into
mainfrom
fixtoken-init-replay

Conversation

@MateuszNaKodach

Copy link
Copy Markdown
Contributor

In Axon Framework 5 a streaming processor starting without a stored token handles its initial catch-up under ReplayStatus.REGULAR rather than as a replay, unlike Axon Framework 4. This documents that behavior and the reasoning behind it across the PooledStreamingEventProcessorConfiguration Javadoc, the streaming event processors reference page, and the projectors migration guide. It adds a migration section with an AF4-vs-AF5 comparison table and a runnable ReplayingInitialTokenExample showing how to restore the AF4 replay behavior by concluding the replay at the latest position. No behavioral code changes are included beyond Javadoc updates.

@MateuszNaKodach
MateuszNaKodach requested a review from a team as a code owner August 26, 2026 23:35
@MateuszNaKodach
MateuszNaKodach requested review from hatzlj, jangalinski and laura-devriendt-lemon and removed request for a team August 26, 2026 23:35
@MateuszNaKodach MateuszNaKodach self-assigned this Aug 26, 2026
@MateuszNaKodach MateuszNaKodach added Priority 2: Should High priority. Ideally, these issues are part of the release they’re assigned to. Type: Documentation Use to signal issues that describe documentation work. labels Aug 26, 2026
@MateuszNaKodach MateuszNaKodach added this to the Release 5.4.0 milestone Aug 26, 2026
A streaming processor starting without a stored token handles its initial
catch-up in ReplayStatus.REGULAR rather than as a replay. Document this
behavior and the reasoning across the PooledStreamingEventProcessorConfiguration
Javadoc, the streaming event processors reference page, and the projectors
migration guide, including how to flag the initial catch-up as a replay when
handlers rely on ReplayStatus.REPLAY to suppress side effects.

@smcvb smcvb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍

@smcvb
smcvb merged commit 179f37c into main Aug 27, 2026
9 checks passed
@smcvb
smcvb deleted the fixtoken-init-replay branch August 27, 2026 06:23
@smcvb

smcvb commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

/backport axon-5.3.x

@github-actions

Copy link
Copy Markdown
Contributor

Successfully created backport PR for axon-5.3.x:

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

Labels

Priority 2: Should High priority. Ideally, these issues are part of the release they’re assigned to. Type: Documentation Use to signal issues that describe documentation work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants