From be08a0e2fe352f1cf6b5e874a1a7274a6124a414 Mon Sep 17 00:00:00 2001 From: Christopher Batey Date: Fri, 25 Oct 2019 17:23:25 +0100 Subject: [PATCH 1/2] Clarify snapshop every n events --- .../main/scala/akka/persistence/typed/internal/Running.scala | 1 + .../akka/persistence/typed/javadsl/RetentionCriteria.scala | 3 +++ .../akka/persistence/typed/scaladsl/RetentionCriteria.scala | 3 +++ 3 files changed, 7 insertions(+) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/Running.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/Running.scala index a8a2c8ec7f..1a408d07fa 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/Running.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/Running.scala @@ -531,5 +531,6 @@ private[akka] object Running { @unused event: PersistentRepr): Unit = () @InternalStableApi private[akka] def onWriteSuccess(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = () + @InternalStableApi private[akka] def onWriteDone(@unused ctx: ActorContext[_], @unused event: PersistentRepr): Unit = () } diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala index 40e8388255..5661b2cf03 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala @@ -32,6 +32,9 @@ object RetentionCriteria { * * Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to * delete old events. Events are not deleted by default. + * + * If multiple events are persisted with a persist the snapshot will happen after + * all of the events are persisted rather than precisely every numberOfEvents */ def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria = SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala index 7845618b4f..182b1797b8 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala @@ -32,6 +32,9 @@ object RetentionCriteria { * * Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to * delete old events. Events are not deleted by default. + * + * If multiple events are persisted with a single Effect the snapshot will happen after + * all of the events are persisted rather than precisely every numberOfEvents */ def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria = SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false) From cf5316a71c5786309d4cbcb1f862cd7612904412 Mon Sep 17 00:00:00 2001 From: Christopher Batey Date: Mon, 4 Nov 2019 10:38:31 +0000 Subject: [PATCH 2/2] Apply suggestions from code review Co-Authored-By: Helena Edelson --- .../akka/persistence/typed/javadsl/RetentionCriteria.scala | 4 ++-- .../akka/persistence/typed/scaladsl/RetentionCriteria.scala | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala index 5661b2cf03..fee6bdea4d 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/RetentionCriteria.scala @@ -33,8 +33,8 @@ object RetentionCriteria { * Use [[SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot]] to * delete old events. Events are not deleted by default. * - * If multiple events are persisted with a persist the snapshot will happen after - * all of the events are persisted rather than precisely every numberOfEvents + * If multiple events are persisted with a single Effect, the snapshot will happen after + * all of the events are persisted rather than precisely every `numberOfEvents`. */ def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria = SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala index 182b1797b8..fd7df34b5c 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/RetentionCriteria.scala @@ -34,7 +34,7 @@ object RetentionCriteria { * delete old events. Events are not deleted by default. * * If multiple events are persisted with a single Effect the snapshot will happen after - * all of the events are persisted rather than precisely every numberOfEvents + * all of the events are persisted rather than precisely every `numberOfEvents`. */ def snapshotEvery(numberOfEvents: Int, keepNSnapshots: Int): SnapshotCountRetentionCriteria = SnapshotCountRetentionCriteriaImpl(numberOfEvents, keepNSnapshots, deleteEventsOnSnapshot = false)