Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-748 - Allow publication completion to delete database entries.

Browse Source 
We now expose a spring.modulith.events.completion-mode property, defaulting the previous behavior to a value of UPDATE. The property can also be configured to DELETE, which will cause the persistence implementations to flip to removing the database entries for event publications instead of setting the completion date.
This commit is contained in:
Oliver Drotbohm
2024-08-27 21:52:53 +02:00
parent 65178e42de
commit cd0b5cf5c3
17 changed files with 572 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/docs/antora/modules/ROOT/pages/appendix.adoc
View File

@@ -18,6 +18,10 @@
|The strategy to be applied to detect application modules.
Can either be the class name of a custom implementation of `ApplicationModuleDetectionStrategy` or `direct-subpackages` (which is also the final fallback if nothing is configured) or `explicitly-annotated` to only select packages explicitly annotated with `@ApplicationModule` or jMolecules' `@Module`. See xref:fundamentals.adoc#customizing-modules[Customize Application Module Detection] for details.
|`spring.modulith.events.completion-mode`
|`UPDATE`
|How to mark event publications as completed. The default sets the completion date on the database entry, `DELETE` removes the entry right away. For details, see xref:events.adoc#publication-registry.completion[Event Publication Completion].
|`spring.modulith.events.externalization.enabled`
|`true`
|Whether to enable event externalization.

14
src/docs/antora/modules/ROOT/pages/events.adoc
View File

@@ -273,6 +273,20 @@ This artifact contains two primary abstractions that are available to applicatio
* `CompletedEventPublications` -- This interface allows accessing all completed event publications, and provides an API to immediately purge all of them from the database or the completed publications older that a given duration (for example, 1 minute).
* `IncompleteEventPublications` -- This interface allows accessing all incomplete event publications to resubmit either the ones matching a given predicate or older than a given `Duration` relative to the original publishing date.
[[publication-registry.completion]]
=== Event Publication Completion
Event publications are marked as completed when a transactional or `@ApplicationModuleListener` execution completes successfully.
By default, the completion is registered by setting the completion date on an `EventPublication`.
This means that completed publications will remain in the Event Publication Registry so that they can be inspected through the `CompletedEventPublications` interface as described xref:events.adoc#publication-registry.managing-publications[above].
A consequence of this is that you'll need to put some code in place that will periodically purge old, completed ``EventPublication``s.
Otherwise, the persistent abstraction of them, for example a relational database table, will grow unbounded and the interaction with the store creating and completing new ``EventPublication`` might slow down.
Spring Modulith 1.3 introduces a configuration property `spring.modulith.events.completion-mode`.
It defaults to `UPDATE` which is backed by the strategy described above.
Alternatively, the completion mode can be set to `DELETE`, which alters the registry's persistence mechanisms to rather delete ``EventPublication``s on completion.
This means that `CompletedEventPublications` will not return any publications anymore, but at the same time, you don't have to worry about purging the completed events from the persistence store manually anymore.
[[publication-registry.publication-repositories]]
=== Event Publication Repositories