pekko/akka-persistence/src/test/scala/akka/persistence/PersistentActorSpec.scala
2022-04-11 16:13:47 +02:00

1847 lines
69 KiB
Scala

/*
* Copyright (C) 2009-2022 Lightbend Inc. <https://www.lightbend.com>
*/
package akka.persistence
import java.util.concurrent.atomic.AtomicInteger
import scala.collection.immutable.Seq
import scala.concurrent.Await
import scala.concurrent.duration._
import scala.util.Random
import scala.util.control.NoStackTrace
import scala.annotation.nowarn
import com.typesafe.config.{ Config, ConfigFactory }
import akka.actor._
import akka.persistence.PersistentActorSpec._
import akka.testkit.{ EventFilter, ImplicitSender, TestLatch, TestProbe }
import org.scalatest.concurrent.Eventually
object PersistentActorSpec {
final case class Cmd(data: Any)
final case class Evt(data: Any)
final case class LatchCmd(latch: TestLatch, data: Any) extends NoSerializationVerificationNeeded
final case class Delete(toSequenceNr: Long)
abstract class ExamplePersistentActor(name: String) extends NamedPersistentActor(name) {
var events: List[Any] = Nil
var askedForDelete: Option[ActorRef] = None
val updateState: Receive = {
case Evt(data) => events = data :: events
case d @ Some(_: ActorRef) => askedForDelete = d.asInstanceOf[Some[ActorRef]]
}
val commonBehavior: Receive = {
case "boom" => throw new TestException("boom")
case GetState => sender() ! events.reverse
case Delete(toSequenceNr) =>
persist(Some(sender())) { s =>
askedForDelete = s
}
deleteMessages(toSequenceNr)
}
def receiveRecover = updateState
}
trait InmemRuntimePluginConfig extends PersistenceIdentity with RuntimePluginConfig {
val providedConfig: Config
override def journalPluginId: String = s"custom.persistence.journal.inmem"
override def snapshotPluginId: String = "custom.persistence.snapshot-store.local"
override def journalPluginConfig: Config = providedConfig
override def snapshotPluginConfig: Config = providedConfig
}
class Behavior1PersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persistAll(Seq(Evt(s"${data}-1"), Evt(s"${data}-2")))(updateState)
case d: DeleteMessagesSuccess =>
val replyTo = askedForDelete.getOrElse(
throw new RuntimeException("Received DeleteMessagesSuccess without anyone asking for delete!"))
replyTo ! d
case d: DeleteMessagesFailure =>
val replyTo = askedForDelete.getOrElse(
throw new RuntimeException("Received DeleteMessagesFailure without anyone asking for delete!"))
replyTo ! d
}
override protected def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit =
event match {
case Evt(data) => sender() ! s"Rejected: $data"
case _ => super.onPersistRejected(cause, event, seqNr)
}
override protected def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit =
event match {
case Evt(data) => sender() ! s"Failure: $data"
case _ => super.onPersistFailure(cause, event, seqNr)
}
}
class Behavior1PersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends Behavior1PersistentActor(name)
with InmemRuntimePluginConfig
class Behavior2PersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persistAll(Seq(Evt(s"${data}-1"), Evt(s"${data}-2")))(updateState)
persistAll(Seq(Evt(s"${data}-3"), Evt(s"${data}-4")))(updateState)
}
}
class Behavior2PersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends Behavior2PersistentActor(name)
with InmemRuntimePluginConfig
class Behavior3PersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persistAll(Seq(Evt(s"${data}-11"), Evt(s"${data}-12")))(updateState)
updateState(Evt(s"${data}-10"))
}
}
class Behavior3PersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends Behavior3PersistentActor(name)
with InmemRuntimePluginConfig
class ChangeBehaviorInLastEventHandlerPersistentActor(name: String) extends ExamplePersistentActor(name) {
val newBehavior: Receive = {
case Cmd(data) =>
persist(Evt(s"${data}-21"))(updateState)
persist(Evt(s"${data}-22")) { event =>
updateState(event)
context.unbecome()
}
}
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persist(Evt(s"${data}-0")) { event =>
updateState(event)
context.become(newBehavior)
}
}
}
class ChangeBehaviorInLastEventHandlerPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends ChangeBehaviorInLastEventHandlerPersistentActor(name)
with InmemRuntimePluginConfig
class ChangeBehaviorInFirstEventHandlerPersistentActor(name: String) extends ExamplePersistentActor(name) {
val newBehavior: Receive = {
case Cmd(data) =>
persist(Evt(s"${data}-21")) { event =>
updateState(event)
context.unbecome()
}
persist(Evt(s"${data}-22"))(updateState)
}
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persist(Evt(s"${data}-0")) { event =>
updateState(event)
context.become(newBehavior)
}
}
}
class ChangeBehaviorInFirstEventHandlerPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends ChangeBehaviorInFirstEventHandlerPersistentActor(name)
with InmemRuntimePluginConfig
class ChangeBehaviorInCommandHandlerFirstPersistentActor(name: String) extends ExamplePersistentActor(name) {
val newBehavior: Receive = {
case Cmd(data) =>
context.unbecome()
persistAll(Seq(Evt(s"${data}-31"), Evt(s"${data}-32")))(updateState)
updateState(Evt(s"${data}-30"))
}
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
context.become(newBehavior)
persist(Evt(s"${data}-0"))(updateState)
}
}
class ChangeBehaviorInCommandHandlerFirstPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends ChangeBehaviorInCommandHandlerFirstPersistentActor(name)
with InmemRuntimePluginConfig
class ChangeBehaviorInCommandHandlerLastPersistentActor(name: String) extends ExamplePersistentActor(name) {
val newBehavior: Receive = {
case Cmd(data) =>
persistAll(Seq(Evt(s"${data}-31"), Evt(s"${data}-32")))(updateState)
updateState(Evt(s"${data}-30"))
context.unbecome()
}
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persist(Evt(s"${data}-0"))(updateState)
context.become(newBehavior)
}
}
class ChangeBehaviorInCommandHandlerLastPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends ChangeBehaviorInCommandHandlerLastPersistentActor(name)
with InmemRuntimePluginConfig
class SnapshottingPersistentActor(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
override def receiveRecover = super.receiveRecover.orElse {
case SnapshotOffer(_, events: List[_]) =>
probe ! "offered"
this.events = events
}
private def handleCmd(cmd: Cmd): Unit = {
persistAll(Seq(Evt(s"${cmd.data}-41"), Evt(s"${cmd.data}-42")))(updateState)
}
def receiveCommand: Receive = commonBehavior.orElse {
case c: Cmd => handleCmd(c)
case SaveSnapshotSuccess(_) => probe ! "saved"
case "snap" => saveSnapshot(events)
}
}
class SnapshottingPersistentActorWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends SnapshottingPersistentActor(name, probe)
with InmemRuntimePluginConfig
class SnapshottingBecomingPersistentActor(name: String, probe: ActorRef)
extends SnapshottingPersistentActor(name, probe) {
val becomingRecover: Receive = {
case msg: SnapshotOffer =>
context.become(becomingCommand)
// sending ourself a normal message here also tests
// that we stash them until recovery is complete
self ! "It's changing me"
super.receiveRecover(msg)
}
override def receiveRecover = becomingRecover.orElse(super.receiveRecover)
val becomingCommand: Receive = receiveCommand.orElse {
case "It's changing me" => probe ! "I am becoming"
}
}
class SnapshottingBecomingPersistentActorWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends SnapshottingBecomingPersistentActor(name, probe)
with InmemRuntimePluginConfig
class ReplyInEventHandlerPersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case Cmd("a") => persist(Evt("a"))(evt => sender() ! evt.data)
}
}
class ReplyInEventHandlerPersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends ReplyInEventHandlerPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistPersistentActor(name: String) extends ExamplePersistentActor(name) {
var counter = 0
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
sender() ! data
persistAsync(Evt(s"$data-${incCounter()}")) { evt =>
sender() ! evt.data
}
}
private def incCounter(): Int = {
counter += 1
counter
}
override protected def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit =
event match {
case Evt(data) => sender() ! s"Failure: $data"
case _ => super.onPersistFailure(cause, event, seqNr)
}
}
class AsyncPersistPersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends AsyncPersistPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistThreeTimesPersistentActor(name: String) extends ExamplePersistentActor(name) {
var counter = 0
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
sender() ! data
(1 to 3).foreach { _ =>
persistAsync(Evt(s"$data-${incCounter()}")) { evt =>
sender() ! ("a" + evt.data.toString.drop(1)) // c-1 => a-1, as in "ack"
}
}
}
private def incCounter(): Int = {
counter += 1
counter
}
}
class AsyncPersistThreeTimesPersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends AsyncPersistThreeTimesPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistSameEventTwicePersistentActor(name: String) extends ExamplePersistentActor(name) {
// atomic because used from inside the *async* callbacks
val sendMsgCounter = new AtomicInteger()
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
sender() ! data
val event = Evt(data)
persistAsync(event) { evt =>
// be way slower, in order to be overtaken by the other callback
Thread.sleep(300)
sender() ! s"${evt.data}-a-${sendMsgCounter.incrementAndGet()}"
}
persistAsync(event) { evt =>
sender() ! s"${evt.data}-b-${sendMsgCounter.incrementAndGet()}"
}
}
}
class AsyncPersistSameEventTwicePersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends AsyncPersistSameEventTwicePersistentActor(name)
with InmemRuntimePluginConfig
@nowarn // compiler knows persistAll(Nil)(lambda) will never invoke lambda
class PersistAllNilPersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data: String) if data contains "defer" =>
deferAsync("before-nil")(sender() ! _)
persistAll(Nil)(_ => sender() ! "Nil")
deferAsync("after-nil")(sender() ! _)
sender() ! data
case Cmd(data: String) if data contains "persist" =>
persist("before-nil")(sender() ! _)
persistAll(Nil)(_ => sender() ! "Nil")
deferAsync("after-nil")(sender() ! _)
sender() ! data
}
}
class PersistAllNilPersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends PersistAllNilPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistAndPersistMixedSyncAsyncSyncPersistentActor(name: String) extends ExamplePersistentActor(name) {
var counter = 0
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
sender() ! data
persist(Evt(s"$data-e1")) { evt =>
sender() ! s"${evt.data}-${incCounter()}"
}
// this should be happily executed
persistAsync(Evt(s"$data-ea2")) { evt =>
sender() ! s"${evt.data}-${incCounter()}"
}
persist(Evt(s"$data-e3")) { evt =>
sender() ! s"${evt.data}-${incCounter()}"
}
}
private def incCounter(): Int = {
counter += 1
counter
}
}
class AsyncPersistAndPersistMixedSyncAsyncSyncPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends AsyncPersistAndPersistMixedSyncAsyncSyncPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistAndPersistMixedSyncAsyncPersistentActor(name: String) extends ExamplePersistentActor(name) {
var sendMsgCounter = 0
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
sender() ! data
persist(Evt(s"$data-e1")) { evt =>
sender() ! s"${evt.data}-${incCounter()}"
}
persistAsync(Evt(s"$data-ea2")) { evt =>
sender() ! s"${evt.data}-${incCounter()}"
}
}
def incCounter() = {
sendMsgCounter += 1
sendMsgCounter
}
}
class AsyncPersistAndPersistMixedSyncAsyncPersistentActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends AsyncPersistAndPersistMixedSyncAsyncPersistentActor(name)
with InmemRuntimePluginConfig
class AsyncPersistHandlerCorrelationCheck(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = commonBehavior.orElse {
case Cmd(data) =>
persistAsync(Evt(data)) { evt =>
if (data != evt.data)
sender() ! s"Expected [$data] bot got [${evt.data}]"
if (evt.data == "done")
sender() ! "done"
}
}
}
class AsyncPersistHandlerCorrelationCheckWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends AsyncPersistHandlerCorrelationCheck(name)
with InmemRuntimePluginConfig
class PrimitiveEventPersistentActor(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case Cmd("a") => persist(5)(evt => sender() ! evt)
}
}
class PrimitiveEventPersistentActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends PrimitiveEventPersistentActor(name)
with InmemRuntimePluginConfig
class HandleRecoveryFinishedEventPersistentActor(name: String, probe: ActorRef)
extends SnapshottingPersistentActor(name, probe) {
val sendingRecover: Receive = {
case msg: SnapshotOffer =>
// sending ourself a normal message tests
// that we stash them until recovery is complete
self ! "I am the stashed"
super.receiveRecover(msg)
case RecoveryCompleted =>
probe ! RecoveryCompleted
self ! "I am the recovered"
updateState(Evt(RecoveryCompleted))
}
override def receiveRecover = sendingRecover.orElse(super.receiveRecover)
override def receiveCommand: Receive = super.receiveCommand.orElse {
case s: String => probe ! s
}
}
class HandleRecoveryFinishedEventPersistentActorWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends HandleRecoveryFinishedEventPersistentActor(name, probe)
with InmemRuntimePluginConfig
trait DeferActor extends PersistentActor {
def doDefer[A](event: A)(handler: A => Unit): Unit
}
trait DeferSync {
this: PersistentActor =>
def doDefer[A](event: A)(handler: A => Unit): Unit = defer(event)(handler)
}
trait DeferAsync {
this: PersistentActor =>
def doDefer[A](event: A)(handler: A => Unit): Unit = deferAsync(event)(handler)
}
abstract class DeferringWithPersistActor(name: String) extends ExamplePersistentActor(name) with DeferActor {
val receiveCommand: Receive = {
case Cmd(data) =>
doDefer("d-1") { sender() ! _ }
persist(s"$data-2") { sender() ! _ }
doDefer("d-3") { sender() ! _ }
doDefer("d-4") { sender() ! _ }
}
}
class DeferringAsyncWithPersistActor(name: String) extends DeferringWithPersistActor(name) with DeferAsync
class DeferringSyncWithPersistActor(name: String) extends DeferringWithPersistActor(name) with DeferSync
class DeferringAsyncWithPersistActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringAsyncWithPersistActor(name)
with InmemRuntimePluginConfig
class DeferringSyncWithPersistActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringSyncWithPersistActor(name)
with InmemRuntimePluginConfig
abstract class DeferringWithAsyncPersistActor(name: String) extends ExamplePersistentActor(name) with DeferActor {
val receiveCommand: Receive = {
case Cmd(data) =>
doDefer(s"d-$data-1") { sender() ! _ }
persistAsync(s"pa-$data-2") { sender() ! _ }
doDefer(s"d-$data-3") { sender() ! _ }
doDefer(s"d-$data-4") { sender() ! _ }
}
}
class DeferringAsyncWithAsyncPersistActor(name: String) extends DeferringWithAsyncPersistActor(name) with DeferAsync
class DeferringSyncWithAsyncPersistActor(name: String) extends DeferringWithAsyncPersistActor(name) with DeferSync
class DeferringAsyncWithAsyncPersistActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringAsyncWithAsyncPersistActor(name)
with InmemRuntimePluginConfig
class DeferringSyncWithAsyncPersistActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringSyncWithAsyncPersistActor(name)
with InmemRuntimePluginConfig
abstract class DeferringMixedCallsPPADDPADPersistActor(name: String)
extends ExamplePersistentActor(name)
with DeferActor {
val receiveCommand: Receive = {
case Cmd(data) =>
persist(s"p-$data-1") { sender() ! _ }
persistAsync(s"pa-$data-2") { sender() ! _ }
doDefer(s"d-$data-3") { sender() ! _ }
doDefer(s"d-$data-4") { sender() ! _ }
persistAsync(s"pa-$data-5") { sender() ! _ }
doDefer(s"d-$data-6") { sender() ! _ }
}
}
class DeferringAsyncMixedCallsPPADDPADPersistActor(name: String)
extends DeferringMixedCallsPPADDPADPersistActor(name)
with DeferAsync
class DeferringSyncMixedCallsPPADDPADPersistActor(name: String)
extends DeferringMixedCallsPPADDPADPersistActor(name)
with DeferSync
class DeferringAsyncMixedCallsPPADDPADPersistActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends DeferringAsyncMixedCallsPPADDPADPersistActor(name)
with InmemRuntimePluginConfig
class DeferringSyncMixedCallsPPADDPADPersistActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends DeferringSyncMixedCallsPPADDPADPersistActor(name)
with InmemRuntimePluginConfig
abstract class DeferringWithNoPersistCallsPersistActor(name: String)
extends ExamplePersistentActor(name)
with DeferActor {
val receiveCommand: Receive = {
case Cmd(_) =>
doDefer("d-1") { sender() ! _ }
doDefer("d-2") { sender() ! _ }
doDefer("d-3") { sender() ! _ }
}
}
class DeferringAsyncWithNoPersistCallsPersistActor(name: String)
extends DeferringWithNoPersistCallsPersistActor(name)
with DeferAsync
class DeferringSyncWithNoPersistCallsPersistActor(name: String)
extends DeferringWithNoPersistCallsPersistActor(name)
with DeferSync
class DeferringAsyncWithNoPersistCallsPersistActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends DeferringAsyncWithNoPersistCallsPersistActor(name)
with InmemRuntimePluginConfig
class DeferringSyncWithNoPersistCallsPersistActorWithInmemRuntimePluginConfig(
name: String,
val providedConfig: Config)
extends DeferringSyncWithNoPersistCallsPersistActor(name)
with InmemRuntimePluginConfig
abstract class DeferringActor(name: String) extends ExamplePersistentActor(name) with DeferActor {
val receiveCommand: Receive = {
case Cmd(data) =>
sender() ! data
persist(()) { _ =>
} // skip calling defer immediately because of empty pending invocations
doDefer(Evt(s"$data-defer")) { evt =>
sender() ! evt.data
}
}
}
class DeferringAsyncActor(name: String) extends DeferringActor(name) with DeferAsync
class DeferringSyncActor(name: String) extends DeferringActor(name) with DeferSync
class DeferringAsyncActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringAsyncActor(name)
with InmemRuntimePluginConfig
class DeferringSyncActorWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends DeferringSyncActor(name)
with InmemRuntimePluginConfig
class StressOrdering(name: String) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case LatchCmd(latch, data) =>
sender() ! data
Await.ready(latch, 5.seconds)
persistAsync(data)(_ => ())
case Cmd(data) =>
sender() ! data
persist(data)(_ => ())
case s: String =>
sender() ! s
}
}
class StressOrderingWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends StressOrdering(name)
with InmemRuntimePluginConfig
class RecoverMessageCausedRestart(name: String) extends NamedPersistentActor(name) {
var master: ActorRef = _
val receiveCommand: Receive = {
case "Boom" =>
master = sender()
throw new TestException("boom")
}
override def preRestart(reason: Throwable, message: Option[Any]): Unit = {
if (master ne null) {
master ! "failed with " + reason.getClass.getSimpleName + " while processing " + message.getOrElse("")
}
context.stop(self)
}
override def receiveRecover = {
case _ => ()
}
}
class RecoverMessageCausedRestartWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends RecoverMessageCausedRestart(name)
with InmemRuntimePluginConfig
class MultipleAndNestedPersists(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case s: String =>
probe ! s
persist(s + "-outer-1") { outer =>
probe ! outer
persist(s + "-inner-1") { inner =>
probe ! inner
}
}
persist(s + "-outer-2") { outer =>
probe ! outer
persist(s + "-inner-2") { inner =>
probe ! inner
}
}
}
}
class MultipleAndNestedPersistsWithInmemRuntimePluginConfig(name: String, probe: ActorRef, val providedConfig: Config)
extends MultipleAndNestedPersists(name, probe)
with InmemRuntimePluginConfig
class MultipleAndNestedPersistAsyncs(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case s: String =>
probe ! s
persistAsync(s + "-outer-1") { outer =>
probe ! outer
persistAsync(s + "-inner-1") { inner =>
probe ! inner
}
}
persistAsync(s + "-outer-2") { outer =>
probe ! outer
persistAsync(s + "-inner-2") { inner =>
probe ! inner
}
}
}
}
class MultipleAndNestedPersistAsyncsWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends MultipleAndNestedPersistAsyncs(name, probe)
with InmemRuntimePluginConfig
class DeeplyNestedPersistAsyncs(name: String, maxDepth: Int, probe: ActorRef) extends ExamplePersistentActor(name) {
var currentDepths = Map.empty[String, Int].withDefaultValue(1)
def weMustGoDeeper: String => Unit = { dWithDepth =>
val d = dWithDepth.split("-").head
probe ! dWithDepth
if (currentDepths(d) < maxDepth) {
currentDepths = currentDepths.updated(d, currentDepths(d) + 1)
persistAsync(d + "-" + currentDepths(d))(weMustGoDeeper)
} else {
// reset depth counter before next command
currentDepths = currentDepths.updated(d, 1)
}
}
val receiveCommand: Receive = {
case s: String =>
probe ! s
persistAsync(s + "-" + 1)(weMustGoDeeper)
}
}
class DeeplyNestedPersistAsyncsWithInmemRuntimePluginConfig(
name: String,
maxDepth: Int,
probe: ActorRef,
val providedConfig: Config)
extends DeeplyNestedPersistAsyncs(name, maxDepth, probe)
with InmemRuntimePluginConfig
class NestedPersistNormalAndAsyncs(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case s: String =>
probe ! s
persist(s + "-outer-1") { outer =>
probe ! outer
persistAsync(s + "-inner-async-1") { inner =>
probe ! inner
}
}
persist(s + "-outer-2") { outer =>
probe ! outer
persistAsync(s + "-inner-async-2") { inner =>
probe ! inner
}
}
}
}
class NestedPersistNormalAndAsyncsWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends NestedPersistNormalAndAsyncs(name, probe)
with InmemRuntimePluginConfig
class NestedPersistAsyncsAndNormal(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case s: String =>
probe ! s
persistAsync(s + "-outer-async-1") { outer =>
probe ! outer
persist(s + "-inner-1") { inner =>
probe ! inner
}
}
persistAsync(s + "-outer-async-2") { outer =>
probe ! outer
persist(s + "-inner-2") { inner =>
probe ! inner
}
}
}
}
class NestedPersistAsyncsAndNormalWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends NestedPersistAsyncsAndNormal(name, probe)
with InmemRuntimePluginConfig
class NestedPersistInAsyncEnforcesStashing(name: String, probe: ActorRef) extends ExamplePersistentActor(name) {
val receiveCommand: Receive = {
case s: String =>
probe ! s
persistAsync(s + "-outer-async") { outer =>
probe ! outer
persist(s + "-inner") { inner =>
probe ! inner
Thread.sleep(1000) // really long wait here...
// the next incoming command must be handled by the following function
context.become({ case _ => sender() ! "done" })
}
}
}
}
class NestedPersistInAsyncEnforcesStashingWithInmemRuntimePluginConfig(
name: String,
probe: ActorRef,
val providedConfig: Config)
extends NestedPersistInAsyncEnforcesStashing(name, probe)
with InmemRuntimePluginConfig
class DeeplyNestedPersists(name: String, maxDepth: Int, probe: ActorRef) extends ExamplePersistentActor(name) {
var currentDepths = Map.empty[String, Int].withDefaultValue(1)
def weMustGoDeeper: String => Unit = { dWithDepth =>
val d = dWithDepth.split("-").head
probe ! dWithDepth
if (currentDepths(d) < maxDepth) {
currentDepths = currentDepths.updated(d, currentDepths(d) + 1)
persist(d + "-" + currentDepths(d))(weMustGoDeeper)
} else {
// reset depth counter before next command
currentDepths = currentDepths.updated(d, 1)
}
}
val receiveCommand: Receive = {
case s: String =>
probe ! s
persist(s + "-" + 1)(weMustGoDeeper)
}
}
class DeeplyNestedPersistsWithInmemRuntimePluginConfig(
name: String,
maxDepth: Int,
probe: ActorRef,
val providedConfig: Config)
extends DeeplyNestedPersists(name, maxDepth, probe)
with InmemRuntimePluginConfig
class StackableTestPersistentActor(val probe: ActorRef)
extends StackableTestPersistentActor.BaseActor
with PersistentActor
with StackableTestPersistentActor.MixinActor {
override def persistenceId: String = "StackableTestPersistentActor"
def receiveCommand = {
case "restart" =>
throw new Exception("triggering restart") with NoStackTrace {
override def toString = "Boom!"
}
}
def receiveRecover = {
case _ => ()
}
override def preStart(): Unit = {
probe ! "preStart"
super.preStart()
}
override def postStop(): Unit = {
probe ! "postStop"
super.postStop()
}
override def preRestart(reason: Throwable, message: Option[Any]): Unit = {
probe ! "preRestart"
super.preRestart(reason, message)
}
override def postRestart(reason: Throwable): Unit = {
probe ! "postRestart"
super.postRestart(reason)
}
}
class StackableTestPersistentActorWithInmemRuntimePluginConfig(probe: ActorRef, val providedConfig: Config)
extends StackableTestPersistentActor(probe)
with InmemRuntimePluginConfig
object StackableTestPersistentActor {
trait BaseActor extends Actor {
this: StackableTestPersistentActor =>
override protected[akka] def aroundPreStart() = {
probe ! "base aroundPreStart"
super.aroundPreStart()
}
override protected[akka] def aroundPostStop() = {
probe ! "base aroundPostStop"
super.aroundPostStop()
}
override protected[akka] def aroundPreRestart(reason: Throwable, message: Option[Any]) = {
probe ! "base aroundPreRestart"
super.aroundPreRestart(reason, message)
}
override protected[akka] def aroundPostRestart(reason: Throwable) = {
probe ! "base aroundPostRestart"
super.aroundPostRestart(reason)
}
override protected[akka] def aroundReceive(receive: Receive, message: Any) = {
if (message == "restart" && recoveryFinished) {
probe ! s"base aroundReceive $message"
}
super.aroundReceive(receive, message)
}
}
trait MixinActor extends Actor {
this: StackableTestPersistentActor =>
override protected[akka] def aroundPreStart() = {
probe ! "mixin aroundPreStart"
super.aroundPreStart()
}
override protected[akka] def aroundPostStop() = {
probe ! "mixin aroundPostStop"
super.aroundPostStop()
}
override protected[akka] def aroundPreRestart(reason: Throwable, message: Option[Any]) = {
probe ! "mixin aroundPreRestart"
super.aroundPreRestart(reason, message)
}
override protected[akka] def aroundPostRestart(reason: Throwable) = {
probe ! "mixin aroundPostRestart"
super.aroundPostRestart(reason)
}
override protected[akka] def aroundReceive(receive: Receive, message: Any) = {
if (message == "restart" && recoveryFinished) {
probe ! s"mixin aroundReceive $message"
}
super.aroundReceive(receive, message)
}
}
}
class PersistInRecovery(name: String) extends ExamplePersistentActor(name) {
override def receiveRecover = {
case Evt("invalid") =>
persist(Evt("invalid-recovery"))(updateState)
case e: Evt => updateState(e)
case RecoveryCompleted =>
persistAsync(Evt("rc-1"))(updateState)
persist(Evt("rc-2"))(updateState)
persistAsync(Evt("rc-3"))(updateState)
}
override def onRecoveryFailure(cause: scala.Throwable, event: Option[Any]): Unit = ()
def receiveCommand = commonBehavior.orElse {
case Cmd(d) => persist(Evt(d))(updateState)
}
}
class PersistInRecoveryWithInmemRuntimePluginConfig(name: String, val providedConfig: Config)
extends PersistInRecovery(name)
with InmemRuntimePluginConfig
class ExceptionActor(name: String) extends ExamplePersistentActor(name) {
override def receiveCommand = commonBehavior
override def receiveRecover = throw new TestException("boom")
}
}
abstract class PersistentActorSpec(config: Config) extends PersistenceSpec(config) with ImplicitSender with Eventually {
import PersistentActorSpec._
override protected def beforeEach(): Unit = {
super.beforeEach()
val persistentActor = behavior1PersistentActor
persistentActor ! Cmd("a")
persistentActor ! GetState
expectMsg(List("a-1", "a-2"))
}
protected def behavior1PersistentActor: ActorRef = namedPersistentActor[Behavior1PersistentActor]
protected def behavior2PersistentActor: ActorRef = namedPersistentActor[Behavior2PersistentActor]
protected def behavior3PersistentActor: ActorRef = namedPersistentActor[Behavior3PersistentActor]
protected def changeBehaviorInFirstEventHandlerPersistentActor: ActorRef =
namedPersistentActor[ChangeBehaviorInFirstEventHandlerPersistentActor]
protected def changeBehaviorInLastEventHandlerPersistentActor: ActorRef =
namedPersistentActor[ChangeBehaviorInLastEventHandlerPersistentActor]
protected def changeBehaviorInCommandHandlerFirstPersistentActor: ActorRef =
namedPersistentActor[ChangeBehaviorInCommandHandlerFirstPersistentActor]
protected def changeBehaviorInCommandHandlerLastPersistentActor: ActorRef =
namedPersistentActor[ChangeBehaviorInCommandHandlerLastPersistentActor]
protected def snapshottingPersistentActor: ActorRef =
system.actorOf(Props(classOf[SnapshottingPersistentActor], name, testActor))
protected def snapshottingBecomingPersistentActor: ActorRef =
system.actorOf(Props(classOf[SnapshottingBecomingPersistentActor], name, testActor))
protected def replyInEventHandlerPersistentActor: ActorRef = namedPersistentActor[ReplyInEventHandlerPersistentActor]
protected def primitiveEventPersistentActor: ActorRef = namedPersistentActor[PrimitiveEventPersistentActor]
protected def asyncPersistPersistentActor: ActorRef = namedPersistentActor[AsyncPersistPersistentActor]
protected def asyncPersistThreeTimesPersistentActor: ActorRef =
namedPersistentActor[AsyncPersistThreeTimesPersistentActor]
protected def asyncPersistSameEventTwicePersistentActor: ActorRef =
namedPersistentActor[AsyncPersistSameEventTwicePersistentActor]
protected def persistAllNilPersistentActor: ActorRef = namedPersistentActor[PersistAllNilPersistentActor]
protected def asyncPersistAndPersistMixedSyncAsyncSyncPersistentActor: ActorRef =
namedPersistentActor[AsyncPersistAndPersistMixedSyncAsyncSyncPersistentActor]
protected def asyncPersistAndPersistMixedSyncAsyncPersistentActor: ActorRef =
namedPersistentActor[AsyncPersistAndPersistMixedSyncAsyncPersistentActor]
protected def asyncPersistHandlerCorrelationCheck: ActorRef =
namedPersistentActor[AsyncPersistHandlerCorrelationCheck]
protected def deferringWithPersistActor: ActorRef = namedPersistentActor[DeferringWithPersistActor]
protected def deferringWithAsyncPersistActor: ActorRef = namedPersistentActor[DeferringWithAsyncPersistActor]
protected def deferringMixedCallsPPADDPADPersistActor: ActorRef =
namedPersistentActor[DeferringMixedCallsPPADDPADPersistActor]
protected def deferringWithNoPersistCallsPersistActor: ActorRef =
namedPersistentActor[DeferringWithNoPersistCallsPersistActor]
protected def handleRecoveryFinishedEventPersistentActor: ActorRef =
system.actorOf(Props(classOf[HandleRecoveryFinishedEventPersistentActor], name, testActor))
protected def stressOrdering: ActorRef = namedPersistentActor[StressOrdering]
protected def stackableTestPersistentActor: ActorRef =
system.actorOf(Props(classOf[StackableTestPersistentActor], testActor))
protected def multipleAndNestedPersists: ActorRef =
system.actorOf(Props(classOf[MultipleAndNestedPersists], name, testActor))
protected def multipleAndNestedPersistAsyncs: ActorRef =
system.actorOf(Props(classOf[MultipleAndNestedPersistAsyncs], name, testActor))
protected def deeplyNestedPersists(nestedPersists: Int): ActorRef =
system.actorOf(Props(classOf[DeeplyNestedPersists], name, nestedPersists, testActor))
protected def deeplyNestedPersistAsyncs(nestedPersistAsyncs: Int): ActorRef =
system.actorOf(Props(classOf[DeeplyNestedPersistAsyncs], name, nestedPersistAsyncs, testActor))
protected def nestedPersistNormalAndAsyncs: ActorRef =
system.actorOf(Props(classOf[NestedPersistNormalAndAsyncs], name, testActor))
protected def nestedPersistAsyncsAndNormal: ActorRef =
system.actorOf(Props(classOf[NestedPersistAsyncsAndNormal], name, testActor))
protected def nestedPersistInAsyncEnforcesStashing: ActorRef =
system.actorOf(Props(classOf[NestedPersistInAsyncEnforcesStashing], name, testActor))
protected def persistInRecovery: ActorRef = namedPersistentActor[PersistInRecovery]
protected def recoverMessageCausedRestart: ActorRef = namedPersistentActor[RecoverMessageCausedRestart]
protected def deferringAsyncWithPersistActor: ActorRef = namedPersistentActor[DeferringAsyncWithPersistActor]
protected def deferringSyncWithPersistActor: ActorRef = namedPersistentActor[DeferringSyncWithPersistActor]
protected def deferringAsyncWithAsyncPersistActor: ActorRef =
namedPersistentActor[DeferringAsyncWithAsyncPersistActor]
protected def deferringSyncWithAsyncPersistActor: ActorRef = namedPersistentActor[DeferringSyncWithAsyncPersistActor]
protected def deferringAsyncMixedCallsPPADDPADPersistActor: ActorRef =
namedPersistentActor[DeferringAsyncMixedCallsPPADDPADPersistActor]
protected def deferringSyncMixedCallsPPADDPADPersistActor: ActorRef =
namedPersistentActor[DeferringSyncMixedCallsPPADDPADPersistActor]
protected def deferringAsyncWithNoPersistCallsPersistActor: ActorRef =
namedPersistentActor[DeferringAsyncWithNoPersistCallsPersistActor]
protected def deferringSyncWithNoPersistCallsPersistActor: ActorRef =
namedPersistentActor[DeferringSyncWithNoPersistCallsPersistActor]
protected def deferringAsyncActor: ActorRef = namedPersistentActor[DeferringAsyncActor]
protected def deferringSyncActor: ActorRef = namedPersistentActor[DeferringSyncActor]
"A persistent actor" must {
"fail fast if persistenceId is null" in {
import akka.testkit.filterEvents
filterEvents(EventFilter[ActorInitializationException]()) {
EventFilter.error(message = "requirement failed: persistenceId is [null] for PersistentActor").intercept {
val ref = system.actorOf(Props(new NamedPersistentActor(null) {
override def receiveRecover: Receive = Actor.emptyBehavior
override def receiveCommand: Receive = Actor.emptyBehavior
}))
watch(ref)
expectTerminated(ref)
}
}
}
"fail fast if persistenceId is an empty string" in {
import akka.testkit.filterEvents
filterEvents(EventFilter[ActorInitializationException]()) {
EventFilter.error(message = "persistenceId cannot be empty for PersistentActor").intercept {
val ref = system.actorOf(Props(new NamedPersistentActor(" ") {
override def receiveRecover: Receive = Actor.emptyBehavior
override def receiveCommand: Receive = Actor.emptyBehavior
}))
watch(ref)
expectTerminated(ref)
}
}
}
"recover from persisted events" in {
val persistentActor = behavior1PersistentActor
persistentActor ! GetState
expectMsg(List("a-1", "a-2"))
}
"handle multiple emitted events in correct order (for a single persist call)" in {
val persistentActor = behavior1PersistentActor
persistentActor ! Cmd("b")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2"))
}
"handle multiple emitted events in correct order (for multiple persist calls)" in {
val persistentActor = behavior2PersistentActor
persistentActor ! Cmd("b")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2", "b-3", "b-4"))
}
"receive emitted events immediately after command" in {
val persistentActor = behavior3PersistentActor
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-10", "b-11", "b-12", "c-10", "c-11", "c-12"))
}
"recover on command failure" in {
val persistentActor = behavior3PersistentActor
persistentActor ! Cmd("b")
persistentActor ! "boom"
persistentActor ! Cmd("c")
persistentActor ! GetState
// cmd that was added to state before failure (b-10) is not replayed ...
expectMsg(List("a-1", "a-2", "b-11", "b-12", "c-10", "c-11", "c-12"))
}
"allow behavior changes in event handler (when handling first event)" in {
val persistentActor = changeBehaviorInFirstEventHandlerPersistentActor
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
persistentActor ! Cmd("d")
persistentActor ! Cmd("e")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-0", "c-21", "c-22", "d-0", "e-21", "e-22"))
}
"allow behavior changes in event handler (when handling last event)" in {
val persistentActor = changeBehaviorInLastEventHandlerPersistentActor
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
persistentActor ! Cmd("d")
persistentActor ! Cmd("e")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-0", "c-21", "c-22", "d-0", "e-21", "e-22"))
}
"allow behavior changes in command handler (as first action)" in {
val persistentActor = changeBehaviorInCommandHandlerFirstPersistentActor
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
persistentActor ! Cmd("d")
persistentActor ! Cmd("e")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-0", "c-30", "c-31", "c-32", "d-0", "e-30", "e-31", "e-32"))
}
"allow behavior changes in command handler (as last action)" in {
val persistentActor = changeBehaviorInCommandHandlerLastPersistentActor
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
persistentActor ! Cmd("d")
persistentActor ! Cmd("e")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-0", "c-30", "c-31", "c-32", "d-0", "e-30", "e-31", "e-32"))
}
"support snapshotting" in {
val persistentActor1 = snapshottingPersistentActor
persistentActor1 ! Cmd("b")
persistentActor1 ! "snap"
persistentActor1 ! Cmd("c")
expectMsg("saved")
persistentActor1 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42"))
val persistentActor2 = snapshottingPersistentActor
expectMsg("offered")
persistentActor2 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42"))
}
"support context.become during recovery" in {
val persistentActor1 = snapshottingPersistentActor
persistentActor1 ! Cmd("b")
persistentActor1 ! "snap"
persistentActor1 ! Cmd("c")
expectMsg("saved")
persistentActor1 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42"))
val persistentActor2 = snapshottingBecomingPersistentActor
expectMsg("offered")
expectMsg("I am becoming")
persistentActor2 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42"))
}
"be able to reply within an event handler" in {
val persistentActor = replyInEventHandlerPersistentActor
persistentActor ! Cmd("a")
expectMsg("a")
}
"be able to persist primitive events" in {
val persistentActor = primitiveEventPersistentActor
persistentActor ! Cmd("a")
expectMsg(5)
}
"be able to opt-out from stashing messages until all events have been processed" in {
// There's a race between "y" and "x-1", but only if we receive "y" we will prove
// that commands are processed before events have been persisted. Therefore, we
// retry until eventually...
eventually {
val probe = TestProbe()
val persistentActor = asyncPersistPersistentActor
probe.send(persistentActor, Cmd("x"))
probe.send(persistentActor, Cmd("y"))
probe.expectMsg("x")
probe.expectMsg("y") // "y" command was processed before event persisted
probe.expectMsg("x-1")
probe.expectMsg("y-2")
}
}
"support multiple persistAsync calls for one command, and execute them 'when possible', not hindering command processing" in {
val persistentActor = asyncPersistThreeTimesPersistentActor
val commands = (1 to 10).map { i =>
Cmd(s"c-$i")
}
commands.foreach { i =>
Thread.sleep(Random.nextInt(10))
persistentActor ! i
}
val all: Seq[String] = this.receiveN(40).asInstanceOf[Seq[String]] // each command = 1 reply + 3 event-replies
val replies = all.filter(r => r.count(_ == '-') == 1)
replies should equal(commands.map(_.data))
val expectedAcks = (3 to 32).map { i =>
s"a-${i / 3}-${i - 2}"
}
val acks = all.filter(r => r.count(_ == '-') == 2)
acks should equal(expectedAcks)
}
"reply to the original sender() of a command, even when using persistAsync" in {
// the setting of sender() for PersistentRepl is handled by PersistentActor currently
// but as we want to remove it soon, keeping the explicit test here.
val persistentActor = asyncPersistThreeTimesPersistentActor
val commands = (1 to 10).map { i =>
Cmd(s"c-$i")
}
val probes = Vector.fill(10)(TestProbe())
probes.zip(commands).foreach {
case (p, c) =>
persistentActor.tell(c, p.ref)
}
val ackClass = classOf[String]
within(3.seconds) {
probes.foreach {
_.expectMsgAllClassOf(ackClass, ackClass, ackClass)
}
}
}
"support the same event being asyncPersist'ed multiple times" in {
val persistentActor = asyncPersistSameEventTwicePersistentActor
persistentActor ! Cmd("x")
expectMsg("x")
expectMsg("x-a-1")
expectMsg("x-b-2")
expectNoMessage(100.millis)
}
"support calling persistAll with Nil" in {
val persistentActor = persistAllNilPersistentActor
persistentActor ! Cmd("defer-x")
expectMsg("before-nil")
expectMsg("after-nil")
expectMsg("defer-x")
persistentActor ! Cmd("persist-x")
expectMsg("persist-x")
expectMsg("before-nil")
expectMsg("after-nil")
}
"support a mix of persist calls (sync, async, sync) and persist calls in expected order" in {
val persistentActor = asyncPersistAndPersistMixedSyncAsyncSyncPersistentActor
persistentActor ! Cmd("a")
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
expectMsg("a")
expectMsg("a-e1-1") // persist
expectMsg("a-ea2-2") // persistAsync, but ordering enforced by sync persist below
expectMsg("a-e3-3") // persist
expectMsg("b")
expectMsg("b-e1-4")
expectMsg("b-ea2-5")
expectMsg("b-e3-6")
expectMsg("c")
expectMsg("c-e1-7")
expectMsg("c-ea2-8")
expectMsg("c-e3-9")
expectNoMessage(100.millis)
}
"support a mix of persist calls (sync, async) and persist calls" in {
val persistentActor = asyncPersistAndPersistMixedSyncAsyncPersistentActor
persistentActor ! Cmd("a")
persistentActor ! Cmd("b")
persistentActor ! Cmd("c")
expectMsg("a")
expectMsg("a-e1-1") // persist, must be before next command
var expectInAnyOrder1 = Set("b", "a-ea2-2")
expectInAnyOrder1 -= expectMsgAnyOf(expectInAnyOrder1.toList: _*) // ea2 is persistAsync, b (command) can processed before it
expectMsgAnyOf(expectInAnyOrder1.toList: _*)
expectMsg("b-e1-3") // persist, must be before next command
var expectInAnyOrder2 = Set("c", "b-ea2-4")
expectInAnyOrder2 -= expectMsgAnyOf(expectInAnyOrder2.toList: _*) // ea2 is persistAsync, b (command) can processed before it
expectMsgAnyOf(expectInAnyOrder2.toList: _*)
expectMsg("c-e1-5")
expectMsg("c-ea2-6")
expectNoMessage(100.millis)
}
"correlate persistAsync handlers after restart" in {
val persistentActor = asyncPersistHandlerCorrelationCheck
for (n <- 1 to 100) persistentActor ! Cmd(n)
persistentActor ! "boom"
for (n <- 1 to 20) persistentActor ! Cmd(n)
persistentActor ! Cmd("done")
expectMsg(5.seconds, "done")
}
"allow deferring handlers in order to provide ordered processing in respect to persist handlers" in {
def test(actor: ActorRef): Unit = {
actor ! Cmd("a")
expectMsg("d-1")
expectMsg("a-2")
expectMsg("d-3")
expectMsg("d-4")
expectNoMessage(100.millis)
}
test(deferringAsyncWithPersistActor)
test(deferringSyncWithPersistActor)
}
"allow deferring handlers in order to provide ordered processing in respect to asyncPersist handlers" in {
def test(actor: ActorRef): Unit = {
actor ! Cmd("a")
expectMsg("d-a-1")
expectMsg("pa-a-2")
expectMsg("d-a-3")
expectMsg("d-a-4")
expectNoMessage(100.millis)
}
test(deferringAsyncWithAsyncPersistActor)
test(deferringSyncWithAsyncPersistActor)
}
"invoke deferred handlers, in presence of mixed a long series persist / persistAsync calls" in {
def test(actor: ActorRef): Unit = {
val p1, p2 = TestProbe()
actor.tell(Cmd("a"), p1.ref)
actor.tell(Cmd("b"), p2.ref)
p1.expectMsg("p-a-1")
p1.expectMsg("pa-a-2")
p1.expectMsg("d-a-3")
p1.expectMsg("d-a-4")
p1.expectMsg("pa-a-5")
p1.expectMsg("d-a-6")
p2.expectMsg("p-b-1")
p2.expectMsg("pa-b-2")
p2.expectMsg("d-b-3")
p2.expectMsg("d-b-4")
p2.expectMsg("pa-b-5")
p2.expectMsg("d-b-6")
expectNoMessage(100.millis)
}
test(deferringAsyncMixedCallsPPADDPADPersistActor)
test(deferringSyncMixedCallsPPADDPADPersistActor)
}
"invoke deferred handlers right away, if there are no pending persist handlers registered" in {
def test(actor: ActorRef): Unit = {
actor ! Cmd("a")
expectMsg("d-1")
expectMsg("d-2")
expectMsg("d-3")
expectNoMessage(100.millis)
}
test(deferringAsyncWithNoPersistCallsPersistActor)
test(deferringSyncWithNoPersistCallsPersistActor)
}
"invoke deferred handlers, preserving the original sender references" in {
def test(actor: ActorRef): Unit = {
val p1, p2 = TestProbe()
actor.tell(Cmd("a"), p1.ref)
actor.tell(Cmd("b"), p2.ref)
p1.expectMsg("d-a-1")
p1.expectMsg("pa-a-2")
p1.expectMsg("d-a-3")
p1.expectMsg("d-a-4")
p2.expectMsg("d-b-1")
p2.expectMsg("pa-b-2")
p2.expectMsg("d-b-3")
p2.expectMsg("d-b-4")
expectNoMessage(100.millis)
}
test(deferringAsyncWithAsyncPersistActor)
test(deferringSyncWithAsyncPersistActor)
}
"handle new messages before deferAsync handler is called" in {
// Depending on timing, 'x-defer' might arrive before or after 'y'.
// This test is meant to demonstrate that 'x-defer' *may* arrive later.'
eventually {
val probe = TestProbe()
val persistentActor = deferringAsyncActor
probe.send(persistentActor, Cmd("x"))
probe.send(persistentActor, Cmd("y"))
probe.expectMsg("x")
probe.expectMsg("y") // "y" command was processed before event persisted
probe.expectMsg("x-defer")
probe.expectMsg("y-defer")
}
}
"handle defer sequentially" in {
val persistentActor = deferringSyncActor
persistentActor ! Cmd("x")
persistentActor ! Cmd("y")
expectMsg("x")
expectMsg("x-defer")
expectMsg("y")
expectMsg("y-defer")
}
"receive RecoveryFinished if it is handled after all events have been replayed" in {
val persistentActor1 = snapshottingPersistentActor
persistentActor1 ! Cmd("b")
persistentActor1 ! "snap"
persistentActor1 ! Cmd("c")
expectMsg("saved")
persistentActor1 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42"))
val persistentActor2 = handleRecoveryFinishedEventPersistentActor
expectMsg("offered")
expectMsg(RecoveryCompleted)
expectMsg("I am the stashed")
expectMsg("I am the recovered")
persistentActor2 ! GetState
expectMsg(List("a-1", "a-2", "b-41", "b-42", "c-41", "c-42", RecoveryCompleted))
}
"preserve order of incoming messages" in {
val persistentActor = stressOrdering
persistentActor ! Cmd("a")
val latch = TestLatch(1)
persistentActor ! LatchCmd(latch, "b")
persistentActor ! "c"
expectMsg("a")
expectMsg("b")
persistentActor ! "d"
latch.countDown()
expectMsg("c")
expectMsg("d")
}
"be used as a stackable modification" in {
val persistentActor = stackableTestPersistentActor
expectMsg("mixin aroundPreStart")
expectMsg("base aroundPreStart")
expectMsg("preStart")
persistentActor ! "restart"
expectMsg("mixin aroundReceive restart")
expectMsg("base aroundReceive restart")
expectMsg("mixin aroundPreRestart")
expectMsg("base aroundPreRestart")
expectMsg("preRestart")
expectMsg("postStop")
expectMsg("mixin aroundPostRestart")
expectMsg("base aroundPostRestart")
expectMsg("postRestart")
expectMsg("preStart")
persistentActor ! PoisonPill
expectMsg("mixin aroundPostStop")
expectMsg("base aroundPostStop")
expectMsg("postStop")
expectNoMessage(100.millis)
}
"allow multiple persists with nested persist calls" in {
val persistentActor = multipleAndNestedPersists
persistentActor ! "a"
persistentActor ! "b"
expectMsg("a")
expectMsg("a-outer-1")
expectMsg("a-outer-2")
expectMsg("a-inner-1")
expectMsg("a-inner-2")
// and only then process "b"
expectMsg("b")
expectMsg("b-outer-1")
expectMsg("b-outer-2")
expectMsg("b-inner-1")
expectMsg("b-inner-2")
}
"allow multiple persistAsyncs with nested persistAsync calls" in {
val persistentActor = multipleAndNestedPersistAsyncs
persistentActor ! "a"
persistentActor ! "b"
val msgs = receiveN(10).map(_.toString)
val as = msgs.filter(_.startsWith("a"))
val bs = msgs.filter(_.startsWith("b"))
as should equal(List("a", "a-outer-1", "a-outer-2", "a-inner-1", "a-inner-2"))
bs should equal(List("b", "b-outer-1", "b-outer-2", "b-inner-1", "b-inner-2"))
}
"allow deeply nested persist calls" in {
val nestedPersists = 6
val persistentActor = deeplyNestedPersists(nestedPersists)
persistentActor ! "a"
persistentActor ! "b"
expectMsg("a")
receiveN(6) should ===((1 to nestedPersists).map("a-" + _))
// and only then process "b"
expectMsg("b")
receiveN(6) should ===((1 to nestedPersists).map("b-" + _))
}
"allow deeply nested persistAsync calls" in {
val nestedPersistAsyncs = 6
val persistentActor = deeplyNestedPersistAsyncs(nestedPersistAsyncs)
persistentActor ! "a"
expectMsg("a")
val got = receiveN(nestedPersistAsyncs)
got should beIndependentlyOrdered("a-")
persistentActor ! "b"
persistentActor ! "c"
val expectedReplies = 2 + (nestedPersistAsyncs * 2)
receiveN(expectedReplies).map(_.toString) should beIndependentlyOrdered("b-", "c-")
}
"allow mixed nesting of persistAsync in persist calls" in {
val persistentActor = nestedPersistNormalAndAsyncs
persistentActor ! "a"
expectMsg("a")
receiveN(4) should equal(List("a-outer-1", "a-outer-2", "a-inner-async-1", "a-inner-async-2"))
}
"allow mixed nesting of persist in persistAsync calls" in {
val persistentActor = nestedPersistAsyncsAndNormal
persistentActor ! "a"
expectMsg("a")
receiveN(4) should equal(List("a-outer-async-1", "a-outer-async-2", "a-inner-1", "a-inner-2"))
}
"make sure persist retains promised semantics when nested in persistAsync callback" in {
val persistentActor = nestedPersistInAsyncEnforcesStashing
persistentActor ! "a"
expectMsg("a")
expectMsg("a-outer-async")
expectMsg("a-inner")
persistentActor ! "b"
expectMsg("done")
// which means that b only got applied after the inner persist() handler finished
// so it keeps the persist() semantics, even though we should not recommend this style it can come in handy I guess
}
"be able to delete events" in {
val persistentActor = behavior1PersistentActor
persistentActor ! Cmd("b")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2"))
persistentActor ! Delete(2L) // delete "a-1" and "a-2"
persistentActor ! "boom" // restart, recover
expectMsgType[DeleteMessagesSuccess]
persistentActor ! GetState
expectMsg(List("b-1", "b-2"))
}
"be able to delete all events" in {
val persistentActor = behavior1PersistentActor
persistentActor ! Cmd("b")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2"))
persistentActor ! Delete(Long.MaxValue)
persistentActor ! "boom" // restart, recover
expectMsgType[DeleteMessagesSuccess]
persistentActor ! GetState
expectMsg(Nil)
}
"not be able to delete higher seqnr than current" in {
val persistentActor = behavior1PersistentActor
persistentActor ! Cmd("b")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2"))
persistentActor ! Delete(5L) // > current 4
persistentActor ! "boom" // restart, recover
expectMsgType[DeleteMessagesFailure].cause.getMessage should include("less than or equal to lastSequenceNr")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "b-1", "b-2"))
}
"recover the message which caused the restart" in {
val persistentActor = recoverMessageCausedRestart
persistentActor ! "Boom"
expectMsg("failed with TestException while processing Boom")
}
"be able to persist events that happen during recovery" in {
val persistentActor = persistInRecovery
persistentActor ! GetState
expectMsgAnyOf(List("a-1", "a-2", "rc-1", "rc-2"), List("a-1", "a-2", "rc-1", "rc-2", "rc-3"))
persistentActor ! Cmd("invalid")
persistentActor ! GetState
expectMsg(List("a-1", "a-2", "rc-1", "rc-2", "rc-3", "invalid"))
watch(persistentActor)
persistentActor ! "boom"
expectTerminated(persistentActor)
}
"stop actor when direct exception from receiveRecover" in {
val persistentActor = namedPersistentActor[ExceptionActor]
watch(persistentActor)
expectTerminated(persistentActor)
}
}
}
class InmemPersistentActorSpec extends PersistentActorSpec(PersistenceSpec.config("inmem", "InmemPersistentActorSpec"))
/**
* Same test suite as [[InmemPersistentActorSpec]], the only difference is that all persistent actors are using the
* provided [[Config]] instead of the [[Config]] coming from the [[ActorSystem]].
*/
class InmemPersistentActorWithRuntimePluginConfigSpec
extends PersistentActorSpec(PersistenceSpec.config("inmem", "InmemPersistentActorWithRuntimePluginConfigSpec")) {
val providedActorConfig: Config = {
ConfigFactory
.parseString(s"""
| custom.persistence.snapshot-store.local.dir = target/snapshots-InmemPersistentActorWithRuntimePluginConfigSpec/
""".stripMargin)
.withValue(
s"custom.persistence.journal.inmem",
system.settings.config.getValue(s"akka.persistence.journal.inmem"))
.withValue(
"custom.persistence.snapshot-store.local",
system.settings.config.getValue("akka.persistence.snapshot-store.local"))
}
override protected def behavior1PersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[Behavior1PersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def behavior2PersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[Behavior2PersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def behavior3PersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[Behavior3PersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def changeBehaviorInFirstEventHandlerPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[
ChangeBehaviorInFirstEventHandlerPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def changeBehaviorInLastEventHandlerPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[ChangeBehaviorInLastEventHandlerPersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def changeBehaviorInCommandHandlerFirstPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[
ChangeBehaviorInCommandHandlerFirstPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def changeBehaviorInCommandHandlerLastPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[
ChangeBehaviorInCommandHandlerLastPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def snapshottingPersistentActor: ActorRef =
system.actorOf(
Props(classOf[SnapshottingPersistentActorWithInmemRuntimePluginConfig], name, testActor, providedActorConfig))
override protected def snapshottingBecomingPersistentActor: ActorRef =
system.actorOf(
Props(
classOf[SnapshottingBecomingPersistentActorWithInmemRuntimePluginConfig],
name,
testActor,
providedActorConfig))
override protected def replyInEventHandlerPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[ReplyInEventHandlerPersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def primitiveEventPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[PrimitiveEventPersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def asyncPersistPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[AsyncPersistPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def asyncPersistThreeTimesPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[AsyncPersistThreeTimesPersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def asyncPersistSameEventTwicePersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[AsyncPersistSameEventTwicePersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def persistAllNilPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[PersistAllNilPersistentActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def asyncPersistAndPersistMixedSyncAsyncSyncPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[
AsyncPersistAndPersistMixedSyncAsyncSyncPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def asyncPersistAndPersistMixedSyncAsyncPersistentActor: ActorRef =
namedPersistentActorWithProvidedConfig[
AsyncPersistAndPersistMixedSyncAsyncPersistentActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def asyncPersistHandlerCorrelationCheck: ActorRef =
namedPersistentActorWithProvidedConfig[AsyncPersistHandlerCorrelationCheckWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def handleRecoveryFinishedEventPersistentActor: ActorRef =
system.actorOf(
Props(
classOf[HandleRecoveryFinishedEventPersistentActorWithInmemRuntimePluginConfig],
name,
testActor,
providedActorConfig))
override protected def stressOrdering: ActorRef =
namedPersistentActorWithProvidedConfig[StressOrderingWithInmemRuntimePluginConfig](providedActorConfig)
override protected def stackableTestPersistentActor: ActorRef =
system.actorOf(
Props(classOf[StackableTestPersistentActorWithInmemRuntimePluginConfig], testActor, providedActorConfig))
override protected def multipleAndNestedPersists: ActorRef =
system.actorOf(
Props(classOf[MultipleAndNestedPersistsWithInmemRuntimePluginConfig], name, testActor, providedActorConfig))
override protected def multipleAndNestedPersistAsyncs: ActorRef =
system.actorOf(
Props(classOf[MultipleAndNestedPersistAsyncsWithInmemRuntimePluginConfig], name, testActor, providedActorConfig))
override protected def deeplyNestedPersists(nestedPersists: Int): ActorRef =
system.actorOf(
Props(
classOf[DeeplyNestedPersistsWithInmemRuntimePluginConfig],
name,
nestedPersists,
testActor,
providedActorConfig))
override protected def deeplyNestedPersistAsyncs(nestedPersistAsyncs: Int): ActorRef =
system.actorOf(
Props(
classOf[DeeplyNestedPersistAsyncsWithInmemRuntimePluginConfig],
name,
nestedPersistAsyncs,
testActor,
providedActorConfig))
override protected def nestedPersistNormalAndAsyncs: ActorRef =
system.actorOf(
Props(classOf[NestedPersistNormalAndAsyncsWithInmemRuntimePluginConfig], name, testActor, providedActorConfig))
override protected def nestedPersistAsyncsAndNormal: ActorRef =
system.actorOf(
Props(classOf[NestedPersistAsyncsAndNormalWithInmemRuntimePluginConfig], name, testActor, providedActorConfig))
override protected def nestedPersistInAsyncEnforcesStashing: ActorRef =
system.actorOf(
Props(
classOf[NestedPersistInAsyncEnforcesStashingWithInmemRuntimePluginConfig],
name,
testActor,
providedActorConfig))
override protected def persistInRecovery: ActorRef =
namedPersistentActorWithProvidedConfig[PersistInRecoveryWithInmemRuntimePluginConfig](providedActorConfig)
override protected def recoverMessageCausedRestart: ActorRef =
namedPersistentActorWithProvidedConfig[RecoverMessageCausedRestartWithInmemRuntimePluginConfig](providedActorConfig)
override protected def deferringAsyncWithPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringAsyncWithPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringSyncWithPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringSyncWithPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringAsyncWithAsyncPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringAsyncWithAsyncPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringSyncWithAsyncPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringSyncWithAsyncPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringAsyncMixedCallsPPADDPADPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringAsyncMixedCallsPPADDPADPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringSyncMixedCallsPPADDPADPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringSyncMixedCallsPPADDPADPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringAsyncWithNoPersistCallsPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringAsyncWithNoPersistCallsPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringSyncWithNoPersistCallsPersistActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringSyncWithNoPersistCallsPersistActorWithInmemRuntimePluginConfig](
providedActorConfig)
override protected def deferringAsyncActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringAsyncActorWithInmemRuntimePluginConfig](providedActorConfig)
override protected def deferringSyncActor: ActorRef =
namedPersistentActorWithProvidedConfig[DeferringSyncActorWithInmemRuntimePluginConfig](providedActorConfig)
}