Merge pull request #96 from lerna-stack/untyped-api-is-deprecated

Add deprecated annotation to untyped APIs

Author: tksugimoto

CHANGELOG.md

@@ -13,20 +13,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
   ⚠️ This change does not allow rolling updates. You have to update your system by stopping the whole cluster.
 
+- Made internal APIs private
+
+  If you are only using the APIs using in the implementation guide, this change does not affect your application.
+  Otherwise, some APIs may be unavailable.
+  Please see [PR#47](https://github.com/lerna-stack/akka-entity-replication/pull/47) to check APIs that will no longer be available. 
+  
 ### Added
 - Java11 support
 - Add new typed API based on Akka Typed [PR#79](https://github.com/lerna-stack/akka-entity-replication/pull/79)
   - This API reduces runtime errors and increases productivity.
 
-### Removed
+### Deprecated
 
-- Made internal APIs private
-  
-  ⚠️ If you are only using the APIs using in the implementation guide, this change does not affect your application. 
-  Otherwise, some APIs may be unavailable.
-  Please see the following PR to check APIs that will no longer be available.
+- Untyped (classic) API has been deprecated [PR#96](https://github.com/lerna-stack/akka-entity-replication/pull/96)
 
-  https://github.com/lerna-stack/akka-entity-replication/pull/47
+  ⚠️ This API will be removed in the next major version release.
 
 ## [v1.0.0] - 2021-03-29
 [v1.0.0]: https://github.com/lerna-stack/akka-entity-replication/compare/v0.1.1...v1.0.0

docs/implementation_guide.md

@@ -3,9 +3,8 @@
 ---
 **Warning**
 
-This API is no longer actively improved.
-We will focus to develop [Typed API](./typed/implementation_guide.md).
-It is not recommended using this API to build new applications.
+This API has been deprecated.
+Use [Typed API](./typed/implementation_guide.md) instead to build new applications.
 
 ---
 

docs/testing_guide.md

@@ -3,9 +3,8 @@
 ---
 **Warning**
 
-This API is no longer actively improved.
-We will focus to develop [Typed API](./typed/testing_guide.md).
-It is not recommended using this API to build new applications.
+This API has been deprecated.
+Use [Typed API](./typed/implementation_guide.md) instead to build new applications.
 
 ---
 

src/main/scala/lerna/akka/entityreplication/ClusterReplication.scala

@@ -29,6 +29,7 @@ class ClusterReplication private (system: ExtendedActorSystem) extends Extension
   private[this] lazy val guardian: ActorRef =
     system.systemActorOf(ClusterReplicationGuardian.props(), "clusterReplicationGuardian")
 
+  @deprecated(message = "Use typed.ClusterReplication.init() instead", since = "2.0.0")
   def start(
       typeName: String,
       entityProps: Props,

src/main/scala/lerna/akka/entityreplication/ClusterReplicationSettings.scala

@@ -11,7 +11,11 @@ import scala.concurrent.duration.FiniteDuration
 
 object ClusterReplicationSettings {
 
-  def apply(system: ActorSystem): ClusterReplicationSettings = {
+  @deprecated("Use typed.ClusterReplicationSettings instead", since = "2.0.0")
+  def apply(system: ActorSystem): ClusterReplicationSettings = create(system)
+
+  // for internal use
+  private[entityreplication] def create(system: ActorSystem): ClusterReplicationSettings = {
     val cluster = Cluster(system)
     ClusterReplicationSettingsImpl(system.settings.config, cluster.settings.Roles)
   }

src/main/scala/lerna/akka/entityreplication/ReplicationActor.scala

@@ -17,14 +17,15 @@ private[entityreplication] object ReplicationActor {
   private def generateInstanceId(): EntityInstanceId = EntityInstanceId(instanceIdCounter.getAndIncrement())
 }
 
+@deprecated(message = "Use typed.ReplicatedEntityBehavior instead", since = "2.0.0")
 trait ReplicationActor[StateData] extends Actor with Stash with akka.lerna.StashFactory {
   import context.dispatcher
 
   private val internalStash = createStash()
 
   private val instanceId = ReplicationActor.generateInstanceId()
 
-  private[this] val settings = ClusterReplicationSettings(context.system)
+  private[this] val settings = ClusterReplicationSettings.create(context.system)
 
   private[this] val log = Logging(context.system, this)
 

src/main/scala/lerna/akka/entityreplication/testkit/TestReplicationActorProps.scala

@@ -6,6 +6,7 @@ import lerna.akka.entityreplication.ReplicationActor
 /**
   * The [[TestReplicationActorProps]] allows to test [[ReplicationActor]] like a normal Actor.
   */
+@deprecated(message = "Use typed.testkit.ReplicatedEntityBehaviorTestKit instead", since = "2.0.0")
 object TestReplicationActorProps {
 
   def apply(replicationActorProps: Props): Props = {

src/main/scala/lerna/akka/entityreplication/typed/internal/ClusterReplicationImpl.scala

@@ -23,7 +23,7 @@ private[entityreplication] class ClusterReplicationImpl(system: ActorSystem[_])
 
   private[this] def internalInit[M, E](entity: ReplicatedEntity[M, E]): ActorRef[E] = {
     val classicSystem = system.toClassic
-    val settings      = entity.settings.getOrElse(untyped.ClusterReplicationSettings(classicSystem))
+    val settings      = entity.settings.getOrElse(untyped.ClusterReplicationSettings.create(classicSystem))
     val extractEntityId: untyped.ReplicationRegion.ExtractEntityId = {
       case ReplicationEnvelope(entityId, message) => (entityId, message)
     }

src/main/scala/lerna/akka/entityreplication/typed/internal/behavior/ReplicatedEntityBehaviorImpl.scala

@@ -32,7 +32,7 @@ private[entityreplication] final case class ReplicatedEntityBehaviorImpl[Command
 
   override def apply(ctx: TypedActorContext[Command]): Behavior[Command] = {
     try {
-      val settings = ClusterReplicationSettings(ctx.asScala.system.toClassic)
+      val settings = ClusterReplicationSettings.create(ctx.asScala.system.toClassic)
       Behaviors.intercept(() => interceptor)(createBehavior(entityContext.shard, settings)).narrow
     } catch {
       case NonFatal(e) =>

src/multi-jvm/scala/lerna/akka/entityreplication/ConsistencyTestBase.scala

@@ -4,6 +4,8 @@ import akka.remote.testconductor.RoleName
 import akka.remote.testkit.MultiNodeConfig
 import com.typesafe.config.ConfigFactory
 
+import scala.annotation.nowarn
+
 object ConsistencyTestBase {
 
   object ConsistencyTestBaseConfig extends MultiNodeConfig {
@@ -71,6 +73,7 @@ object ConsistencyTestBase {
     }
   }
 
+  @nowarn("msg=Use typed.ReplicatedEntityBehavior instead")
   class ConsistencyTestReplicationActor() extends ReplicationActor[Int] {
 
     import ConsistencyTestReplicationActor._