spring-projects / spring-projects/spring-modulith

Improve documentation for event registry and handling of failed events

Open
#1,362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.2k
Forks
222
PR merge metrics
No merged PRs in 30d

Description

I asked Oliver a question about the event publication and externalization of events on Bluesky, and he asked me to create a ticket asking for the docs to be more precise about this. So here goes. :)

After reading the documentation, I was not sure what would happen if the broker I wanted to externalize an event to was down, if the message would be lost or if the event was backed by the registry in the same way as when events are handled internally. I have now learned that event externalization is just another listener and will be treated as such, but this could be clearer in the documentation.

Another thing that might be clearer is if it is the event itself that is stored in the registry or if there are individual entries in the registry for each event listener. If I have two event listeners for the same event and one of them fails, will only the one that failed be re-triggered or will both listeners be re-triggered?

Thanks for a great addition to the Spring ecosystem!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation covering event publication, event externalization, the event registry, and failed event handling. Verify how broker outages and multiple listeners are handled, then update the relevant documentation so it clearly explains persistence and retry behavior for each case.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.