diff --git a/akka-cluster-sharding-typed/src/test/scala/akka/cluster/sharding/typed/scaladsl/ClusterShardingPersistenceSpec.scala b/akka-cluster-sharding-typed/src/test/scala/akka/cluster/sharding/typed/scaladsl/ClusterShardingPersistenceSpec.scala index 779e54903e..17b9cf46e2 100644 --- a/akka-cluster-sharding-typed/src/test/scala/akka/cluster/sharding/typed/scaladsl/ClusterShardingPersistenceSpec.scala +++ b/akka-cluster-sharding-typed/src/test/scala/akka/cluster/sharding/typed/scaladsl/ClusterShardingPersistenceSpec.scala @@ -45,7 +45,7 @@ object ClusterShardingPersistenceSpec { def persistentActor(entityId: String): Behavior[Command] = PersistentBehaviors.receive[Command, String, String]( entityId, - initialState = "", + emptyState = "", commandHandler = (_, state, cmd) ⇒ cmd match { case Add(s) ⇒ Effect.persist(s) case Get(replyTo) ⇒ diff --git a/akka-cluster-typed/src/test/scala/akka/cluster/typed/ClusterSingletonPersistenceSpec.scala b/akka-cluster-typed/src/test/scala/akka/cluster/typed/ClusterSingletonPersistenceSpec.scala index 39a45a3a64..029c7636f6 100644 --- a/akka-cluster-typed/src/test/scala/akka/cluster/typed/ClusterSingletonPersistenceSpec.scala +++ b/akka-cluster-typed/src/test/scala/akka/cluster/typed/ClusterSingletonPersistenceSpec.scala @@ -36,7 +36,7 @@ object ClusterSingletonPersistenceSpec { val persistentActor: Behavior[Command] = PersistentBehaviors.receive[Command, String, String]( persistenceId = "TheSingleton", - initialState = "", + emptyState = "", commandHandler = (_, state, cmd) ⇒ cmd match { case Add(s) ⇒ Effect.persist(s) case Get(replyTo) ⇒ diff --git a/akka-docs/src/main/paradox/typed/persistence.md b/akka-docs/src/main/paradox/typed/persistence.md index 78d540a623..eb77e7a1d6 100644 --- a/akka-docs/src/main/paradox/typed/persistence.md +++ b/akka-docs/src/main/paradox/typed/persistence.md @@ -42,7 +42,7 @@ The event and state are only used internally. The components that make up a PersistentBehavior are: * `persistenceId` is the unique identifier for the persistent actor. -* `initialState` defines the `State` when the entity is first created e.g. a Counter would start with 0 as state. +* `emptyState` defines the `State` when the entity is first created e.g. a Counter would start with 0 as state. * `commandHandler` defines how to handle command, resulting in Effects e.g. persisting events, stopping the persistent actor. * `eventHandler` updates the current state when an event has been persisted. diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedReplayingSnapshot.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedReplayingSnapshot.scala index 93063b48ad..c550ed8db2 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedReplayingSnapshot.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedReplayingSnapshot.scala @@ -20,7 +20,7 @@ import akka.persistence.typed.internal.EventsourcedBehavior._ * * In this behavior the recovery process is initiated. * We try to obtain a snapshot from the configured snapshot store, - * and if it exists, we use it instead of the `initialState`. + * and if it exists, we use it instead of the initial `emptyState`. * * Once snapshot recovery is done (or no snapshot was selected), * recovery of events continues in [[EventsourcedReplayingEvents]]. @@ -96,7 +96,7 @@ private[akka] class EventsourcedReplayingSnapshot[C, E, S](override val setup: E def onSnapshotterResponse(response: SnapshotProtocol.Response): Behavior[InternalProtocol] = { response match { case LoadSnapshotResult(sso, toSnr) ⇒ - var state: S = setup.initialState + var state: S = setup.emptyState val seqNr: Long = sso match { case Some(SelectedSnapshot(metadata, snapshot)) ⇒ diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedSetup.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedSetup.scala index 8787b1ec4b..3b23f21c44 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedSetup.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/EventsourcedSetup.scala @@ -27,7 +27,7 @@ private[persistence] final class EventsourcedSetup[C, E, S]( val context: ActorContext[InternalProtocol], val timers: TimerScheduler[InternalProtocol], val persistenceId: String, - val initialState: S, + val emptyState: S, val commandHandler: PersistentBehaviors.CommandHandler[C, E, S], val eventHandler: (S, E) ⇒ S, val writerIdentity: WriterIdentity, diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/PersistentBehaviorImpl.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/PersistentBehaviorImpl.scala index 8f805d8db6..399f521aab 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/PersistentBehaviorImpl.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/internal/PersistentBehaviorImpl.scala @@ -33,7 +33,7 @@ private[akka] object PersistentBehaviorImpl { @InternalApi private[akka] final case class PersistentBehaviorImpl[Command, Event, State]( persistenceId: String, - initialState: State, + emptyState: State, commandHandler: PersistentBehaviors.CommandHandler[Command, Event, State], eventHandler: (State, Event) ⇒ State, journalPluginId: Option[String] = None, @@ -59,7 +59,7 @@ private[akka] final case class PersistentBehaviorImpl[Command, Event, State]( ctx, timers, persistenceId, - initialState, + emptyState, commandHandler, eventHandler, WriterIdentity.newIdentity(), diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/PersistentBehavior.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/PersistentBehavior.scala index d74024aeac..e3b295279c 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/PersistentBehavior.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/javadsl/PersistentBehavior.scala @@ -29,12 +29,12 @@ abstract class PersistentBehavior[Command, Event, State >: Null](val persistence protected final def Effect: EffectFactories[Command, Event, State] = EffectFactory.asInstanceOf[EffectFactories[Command, Event, State]] /** - * Implement by returning the initial state object. + * Implement by returning the initial empty state object. * This object will be passed into this behaviors handlers, until a new state replaces it. * * Also known as "zero state" or "neutral state". */ - protected def initialState: State + protected def emptyState: State /** * Implement by handling incoming commands and return an `Effect()` to persist or signal other effects @@ -147,7 +147,7 @@ abstract class PersistentBehavior[Command, Event, State >: Null](val persistence scaladsl.PersistentBehaviors.receive[Command, Event, State]( persistenceId, - initialState, + emptyState, (c, state, cmd) ⇒ commandHandler()(c.asJava, state, cmd).asInstanceOf[EffectImpl[Event, State]], eventHandler()(_, _)) .onRecoveryCompleted((ctx, state) ⇒ onRecoveryCompleted(ctx.asJava, state)) diff --git a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/PersistentBehaviors.scala b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/PersistentBehaviors.scala index d3a1aee04e..751992d3e3 100644 --- a/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/PersistentBehaviors.scala +++ b/akka-persistence-typed/src/main/scala/akka/persistence/typed/scaladsl/PersistentBehaviors.scala @@ -24,10 +24,10 @@ object PersistentBehaviors { */ def receive[Command, Event, State]( persistenceId: String, - initialState: State, + emptyState: State, commandHandler: CommandHandler[Command, Event, State], eventHandler: (State, Event) ⇒ State): PersistentBehavior[Command, Event, State] = - PersistentBehaviorImpl(persistenceId, initialState, commandHandler, eventHandler) + PersistentBehaviorImpl(persistenceId, emptyState, commandHandler, eventHandler) /** * The `CommandHandler` defines how to act on commands. diff --git a/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorCompileOnlyTest.java b/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorCompileOnlyTest.java index 929fed9dd7..424fa1876e 100644 --- a/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorCompileOnlyTest.java +++ b/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorCompileOnlyTest.java @@ -89,7 +89,7 @@ public class PersistentActorCompileOnlyTest { //#behavior public static PersistentBehavior pb = new PersistentBehavior("p1") { @Override - public SimpleState initialState() { + public SimpleState emptyState() { return new SimpleState(); } @@ -150,7 +150,7 @@ public class PersistentActorCompileOnlyTest { private PersistentBehavior pa = new PersistentBehavior("pa") { @Override - public ExampleState initialState() { + public ExampleState emptyState() { return new ExampleState(); } @@ -259,7 +259,7 @@ public class PersistentActorCompileOnlyTest { } @Override - public EventsInFlight initialState() { + public EventsInFlight emptyState() { return new EventsInFlight(0, Collections.emptyMap()); } diff --git a/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorJavaDslTest.java b/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorJavaDslTest.java index e68293b5ee..5ea1574a44 100644 --- a/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorJavaDslTest.java +++ b/akka-persistence-typed/src/test/java/akka/persistence/typed/javadsl/PersistentActorJavaDslTest.java @@ -299,7 +299,7 @@ public class PersistentActorJavaDslTest extends JUnitSuite { } @Override - public State initialState() { + public State emptyState() { return emptyState; } diff --git a/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/BasicPersistentBehaviorsTest.java b/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/BasicPersistentBehaviorsTest.java index efa8ef44a7..2b008e75ff 100644 --- a/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/BasicPersistentBehaviorsTest.java +++ b/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/BasicPersistentBehaviorsTest.java @@ -29,7 +29,7 @@ public class BasicPersistentBehaviorsTest { } @Override - public State initialState() { + public State emptyState() { return new State(); } diff --git a/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/InDepthPersistentBehaviorTest.java b/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/InDepthPersistentBehaviorTest.java index 2e78a6125a..fa9393e63f 100644 --- a/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/InDepthPersistentBehaviorTest.java +++ b/akka-persistence-typed/src/test/java/jdocs/akka/persistence/typed/InDepthPersistentBehaviorTest.java @@ -170,7 +170,7 @@ public class InDepthPersistentBehaviorTest { } @Override - public BlogState initialState() { + public BlogState emptyState() { return new BlogState(Optional.empty(), false); } diff --git a/akka-persistence-typed/src/test/scala/akka/persistence/typed/ManyRecoveriesSpec.scala b/akka-persistence-typed/src/test/scala/akka/persistence/typed/ManyRecoveriesSpec.scala index 103c5df1c1..6a8e758e57 100644 --- a/akka-persistence-typed/src/test/scala/akka/persistence/typed/ManyRecoveriesSpec.scala +++ b/akka-persistence-typed/src/test/scala/akka/persistence/typed/ManyRecoveriesSpec.scala @@ -29,7 +29,7 @@ object ManyRecoveriesSpec { latch: Option[TestLatch]): PersistentBehavior[Cmd, Evt, String] = PersistentBehaviors.receive[Cmd, Evt, String]( persistenceId = name, - initialState = "", + emptyState = "", commandHandler = CommandHandler.command { case Cmd(s) ⇒ Effect.persist(Evt(s)).andThen(_ ⇒ probe.ref ! s"$name-$s") }, diff --git a/akka-persistence-typed/src/test/scala/akka/persistence/typed/internal/RecoveryPermitterSpec.scala b/akka-persistence-typed/src/test/scala/akka/persistence/typed/internal/RecoveryPermitterSpec.scala index 83d6661eaa..eb75a3ce10 100644 --- a/akka-persistence-typed/src/test/scala/akka/persistence/typed/internal/RecoveryPermitterSpec.scala +++ b/akka-persistence-typed/src/test/scala/akka/persistence/typed/internal/RecoveryPermitterSpec.scala @@ -44,7 +44,7 @@ object RecoveryPermitterSpec { throwOnRecovery: Boolean = false): Behavior[Command] = PersistentBehaviors.receive[Command, Event, State]( persistenceId = name, - initialState = EmptyState, + emptyState = EmptyState, commandHandler = CommandHandler.command { case StopActor ⇒ Effect.stop case command ⇒ commandProbe.ref ! command; Effect.none diff --git a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/OptionalSnapshotStoreSpec.scala b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/OptionalSnapshotStoreSpec.scala index 1cd7626130..d9795f7dcb 100644 --- a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/OptionalSnapshotStoreSpec.scala +++ b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/OptionalSnapshotStoreSpec.scala @@ -29,7 +29,7 @@ object OptionalSnapshotStoreSpec { name: String = UUID.randomUUID().toString) = PersistentBehaviors.receive[Command, Event, State]( persistenceId = name, - initialState = State(), + emptyState = State(), commandHandler = CommandHandler.command { _ ⇒ Effect.persist(Event()).andThen(probe.ref ! _) }, diff --git a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentActorCompileOnlyTest.scala b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentActorCompileOnlyTest.scala index 22f18a0955..e799c9b6f9 100644 --- a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentActorCompileOnlyTest.scala +++ b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentActorCompileOnlyTest.scala @@ -45,7 +45,7 @@ object PersistentActorCompileOnlyTest { val simpleBehavior: PersistentBehavior[SimpleCommand, SimpleEvent, ExampleState] = PersistentBehaviors.receive[SimpleCommand, SimpleEvent, ExampleState]( persistenceId = "sample-id-1", - initialState = ExampleState(Nil), + emptyState = ExampleState(Nil), commandHandler = commandHandler, eventHandler = eventHandler) //#behavior @@ -66,7 +66,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[MyCommand, MyEvent, ExampleState]( persistenceId = "sample-id-1", - initialState = ExampleState(Nil), + emptyState = ExampleState(Nil), commandHandler = CommandHandler.command { case Cmd(data, sender) ⇒ @@ -110,7 +110,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, EventsInFlight]( persistenceId = "recovery-complete-id", - initialState = EventsInFlight(0, Map.empty), + emptyState = EventsInFlight(0, Map.empty), commandHandler = (ctx: ActorContext[Command], state, cmd) ⇒ cmd match { case DoSideEffect(data) ⇒ @@ -151,7 +151,7 @@ object PersistentActorCompileOnlyTest { val b: Behavior[Command] = PersistentBehaviors.receive[Command, Event, Mood]( persistenceId = "myPersistenceId", - initialState = Happy, + emptyState = Happy, commandHandler = CommandHandler.byState { case Happy ⇒ CommandHandler.command { case Greet(whom) ⇒ @@ -192,7 +192,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, State]( persistenceId = "asdf", - initialState = State(Nil), + emptyState = State(Nil), commandHandler = CommandHandler.command { case RegisterTask(task) ⇒ Effect.persist(TaskRegistered(task)) case TaskDone(task) ⇒ Effect.persist(TaskRemoved(task)) @@ -219,7 +219,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, State]( persistenceId = "asdf", - initialState = State(Nil), + emptyState = State(Nil), commandHandler = (ctx, _, cmd) ⇒ cmd match { case RegisterTask(task) ⇒ Effect.persist(TaskRegistered(task)) @@ -282,7 +282,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, List[Id]]( persistenceId = "basket-1", - initialState = Nil, + emptyState = Nil, commandHandler = CommandHandler.byState(state ⇒ if (isFullyHydrated(basket, state)) (ctx, state, cmd) ⇒ @@ -343,7 +343,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, Mood]( persistenceId = "myPersistenceId", - initialState = Sad, + emptyState = Sad, commandHandler = (_, state, cmd) ⇒ cmd match { case Greet(whom) ⇒ @@ -379,7 +379,7 @@ object PersistentActorCompileOnlyTest { PersistentBehaviors.receive[Command, Event, State]( persistenceId = "myPersistenceId", - initialState = new State, + emptyState = new State, commandHandler = CommandHandler.command { case Enough ⇒ Effect.persist(Done) diff --git a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentBehaviorSpec.scala b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentBehaviorSpec.scala index a75c9889ed..bb50497077 100644 --- a/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentBehaviorSpec.scala +++ b/akka-persistence-typed/src/test/scala/akka/persistence/typed/scaladsl/PersistentBehaviorSpec.scala @@ -109,7 +109,7 @@ object PersistentBehaviorSpec { snapshotProbe: ActorRef[Try[Done]]): PersistentBehavior[Command, Event, State] = { PersistentBehaviors.receive[Command, Event, State]( persistenceId, - initialState = State(0, Vector.empty), + emptyState = State(0, Vector.empty), commandHandler = (ctx, state, cmd) ⇒ cmd match { case Increment ⇒ Effect.persist(Incremented(1)) diff --git a/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/BasicPersistentBehaviorsCompileOnly.scala b/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/BasicPersistentBehaviorsCompileOnly.scala index 3e470c5e5e..38a9b9a546 100644 --- a/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/BasicPersistentBehaviorsCompileOnly.scala +++ b/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/BasicPersistentBehaviorsCompileOnly.scala @@ -18,7 +18,7 @@ object BasicPersistentBehaviorsCompileOnly { val behavior: Behavior[Command] = PersistentBehaviors.receive[Command, Event, State]( persistenceId = "abc", - initialState = State(), + emptyState = State(), commandHandler = (ctx, state, cmd) ⇒ ???, eventHandler = (state, evt) ⇒ ???) //#structure @@ -27,7 +27,7 @@ object BasicPersistentBehaviorsCompileOnly { val recoveryBehavior: Behavior[Command] = PersistentBehaviors.receive[Command, Event, State]( persistenceId = "abc", - initialState = State(), + emptyState = State(), commandHandler = (ctx, state, cmd) ⇒ ???, eventHandler = (state, evt) ⇒ ???) .onRecoveryCompleted { (ctx, state) ⇒ @@ -39,7 +39,7 @@ object BasicPersistentBehaviorsCompileOnly { val taggingBehavior: Behavior[Command] = PersistentBehaviors.receive[Command, Event, State]( persistenceId = "abc", - initialState = State(), + emptyState = State(), commandHandler = (ctx, state, cmd) ⇒ ???, eventHandler = (state, evt) ⇒ ??? ).withTagger(_ ⇒ Set("tag1", "tag2")) @@ -49,7 +49,7 @@ object BasicPersistentBehaviorsCompileOnly { //#wrapPersistentBehavior val samplePersistentBehavior = PersistentBehaviors.receive[Command, Event, State]( persistenceId = "abc", - initialState = State(), + emptyState = State(), commandHandler = (ctx, state, cmd) ⇒ ???, eventHandler = (state, evt) ⇒ ???) .onRecoveryCompleted { (ctx, state) ⇒ diff --git a/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/InDepthPersistentBehaviorSpec.scala b/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/InDepthPersistentBehaviorSpec.scala index 892463f326..f1bf0fb63b 100644 --- a/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/InDepthPersistentBehaviorSpec.scala +++ b/akka-persistence-typed/src/test/scala/docs/akka/persistence/typed/InDepthPersistentBehaviorSpec.scala @@ -121,7 +121,7 @@ object InDepthPersistentBehaviorSpec { def behavior(entityId: String): Behavior[BlogCommand] = PersistentBehaviors.receive[BlogCommand, BlogEvent, BlogState]( persistenceId = "Blog-" + entityId, - initialState = BlogState.empty, + emptyState = BlogState.empty, commandHandler, eventHandler) //#behavior