chore: Remove ApiMayChange on Projection and RES over gRPC (#1170)

* chore: Remove ApiMayChange on Projection and RES over gRPC

* feedback, some final and DoNotInherit

* mima filter

akka-projection-grpc/src/main/mima-filters/1.5.4.backwards.excludes/res-replay-filter.excludes

@@ -0,0 +1,3 @@
+# remove ApiMayChange
+ProblemFilters.exclude[FinalClassProblem]("akka.projection.grpc.consumer.ConsumerFilter")
+ProblemFilters.exclude[FinalClassProblem]("akka.projection.grpc.consumer.javadsl.GrpcReadJournal")

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/ConsumerFilter.scala

@@ -16,7 +16,6 @@ import akka.actor.typed.ActorSystem
 import akka.actor.typed.Extension
 import akka.actor.typed.ExtensionId
 import akka.actor.typed.Props
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.persistence.typed.ReplicaId
 import akka.projection.grpc.internal.ConsumerFilterRegistry
@@ -28,7 +27,6 @@ import com.typesafe.config.Config
 /**
  * Extension to dynamically control the filters for the `GrpcReadJournal`.
  */
-@ApiMayChange
 object ConsumerFilter extends ExtensionId[ConsumerFilter] {
 
   private val ReplicationIdSeparator = '|'
@@ -592,8 +590,7 @@ object ConsumerFilter extends ExtensionId[ConsumerFilter] {
 
 }
 
-@ApiMayChange
-class ConsumerFilter(system: ActorSystem[_]) extends Extension {
+final class ConsumerFilter(system: ActorSystem[_]) extends Extension {
 
   private val settings = ConsumerFilter.ConsumerFilterSettings(system)
 

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/GrpcQuerySettings.scala

@@ -5,15 +5,13 @@
 package akka.projection.grpc.consumer
 
 import akka.actor.ClassicActorSystemProvider
-import akka.annotation.ApiMayChange
 import akka.grpc.scaladsl.Metadata
 import akka.grpc.scaladsl.MetadataBuilder
 import akka.projection.grpc.consumer.scaladsl.GrpcReadJournal
 import com.typesafe.config.Config
 
 import akka.util.ccompat.JavaConverters._
 import scala.collection.immutable
-@ApiMayChange
 object GrpcQuerySettings {
 
   /**
@@ -81,7 +79,6 @@ object GrpcQuerySettings {
   }
 }
 
-@ApiMayChange
 final class GrpcQuerySettings private (
     val streamId: String,
     val additionalRequestMetadata: Option[Metadata],

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/javadsl/EventDestinationInterceptor.scala

@@ -5,14 +5,12 @@
 package akka.projection.grpc.consumer.javadsl
 
 import akka.Done
-import akka.annotation.ApiMayChange
 import akka.grpc.javadsl.Metadata
 
 import java.util.concurrent.CompletionStage
 
 /**
  * Interceptor allowing for example authentication/authorization of incoming connections to a [[EventProducerPushDestination]] */
-@ApiMayChange
 @FunctionalInterface
 trait EventDestinationInterceptor {
 

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/javadsl/EventProducerPushDestination.scala

@@ -6,7 +6,6 @@ package akka.projection.grpc.consumer.javadsl
 
 import akka.Done
 import akka.actor.typed.ActorSystem
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.dispatch.ExecutionContexts
 import akka.grpc.internal.JavaMetadataImpl
@@ -45,7 +44,6 @@ import scala.jdk.OptionConverters.RichOption
  *
  * Producers are started using the [[akka.projection.grpc.producer.javadsl.EventProducerPush]] API.
  */
-@ApiMayChange
 object EventProducerPushDestination {
 
   /**
@@ -111,7 +109,6 @@ object EventProducerPushDestination {
 
 }
 
-@ApiMayChange
 final class EventProducerPushDestination private (
     val journalPluginId: Optional[String],
     val acceptedStreamId: String,

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/javadsl/GrpcReadJournal.scala

@@ -13,7 +13,6 @@ import scala.compat.java8.OptionConverters._
 import akka.Done
 import akka.NotUsed
 import akka.actor.ClassicActorSystemProvider
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.dispatch.ExecutionContexts
 import akka.grpc.GrpcClientSettings
@@ -31,7 +30,6 @@ import akka.projection.internal.CanTriggerReplay
 import akka.stream.javadsl.Source
 import com.google.protobuf.Descriptors
 
-@ApiMayChange
 object GrpcReadJournal {
   val Identifier: String = scaladsl.GrpcReadJournal.Identifier
 
@@ -83,8 +81,7 @@ object GrpcReadJournal {
 
 }
 
-@ApiMayChange
-class GrpcReadJournal(delegate: scaladsl.GrpcReadJournal)
+final class GrpcReadJournal(delegate: scaladsl.GrpcReadJournal)
     extends ReadJournal
     with EventsBySliceQuery
     with EventTimestampQuery

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/scaladsl/EventDestinationInterceptor.scala

@@ -5,15 +5,13 @@
 package akka.projection.grpc.consumer.scaladsl
 
 import akka.Done
-import akka.annotation.ApiMayChange
 import akka.grpc.scaladsl.Metadata
 
 import scala.concurrent.Future
 
 /**
  * Interceptor allowing for example authentication/authorization of incoming connections to a [[EventProducerPushDestination]]
  */
-@ApiMayChange
 @FunctionalInterface
 trait EventDestinationInterceptor {
 

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/scaladsl/EventProducerPushDestination.scala

@@ -5,7 +5,6 @@
 package akka.projection.grpc.consumer.scaladsl
 
 import akka.actor.typed.ActorSystem
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.grpc.scaladsl.Metadata
 import akka.http.scaladsl.model.HttpRequest
@@ -36,7 +35,6 @@ import akka.projection.grpc.replication.scaladsl.ReplicationSettings
  *
  * Producers are started using the [[akka.projection.grpc.producer.scaladsl.EventProducerPush]] API.
  */
-@ApiMayChange
 object EventProducerPushDestination {
 
   /**
@@ -57,7 +55,6 @@ object EventProducerPushDestination {
       EventProducerPushDestinationSettings(system),
       None)
 
-  @ApiMayChange
   object Transformation {
 
     /**
@@ -185,7 +182,6 @@ object EventProducerPushDestination {
 
 }
 
-@ApiMayChange
 final class EventProducerPushDestination private[akka] (
     val journalPluginId: Option[String],
     val acceptedStreamId: String,

akka-projection-grpc/src/main/scala/akka/projection/grpc/consumer/scaladsl/GrpcReadJournal.scala

@@ -10,7 +10,6 @@ import akka.actor.ClassicActorSystemProvider
 import akka.actor.ExtendedActorSystem
 import akka.actor.typed.scaladsl.LoggerOps
 import akka.actor.typed.scaladsl.adapter._
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.grpc.GrpcClientSettings
 import akka.grpc.scaladsl.BytesEntry
@@ -67,7 +66,6 @@ import scala.concurrent.Future
 import akka.projection.grpc.internal.proto.ReplayPersistenceId
 import akka.projection.grpc.internal.proto.ReplicaInfo
 import akka.projection.grpc.replication.scaladsl.ReplicationSettings
-@ApiMayChange
 object GrpcReadJournal {
   val Identifier = "akka.projection.grpc.consumer"
 
@@ -159,7 +157,6 @@ object GrpcReadJournal {
 
 }
 
-@ApiMayChange
 final class GrpcReadJournal private (
     system: ExtendedActorSystem,
     settings: GrpcQuerySettings,

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/EventProducerSettings.scala

@@ -5,13 +5,11 @@
 package akka.projection.grpc.producer
 
 import akka.actor.typed.ActorSystem
-import akka.annotation.ApiMayChange
 import akka.util.JavaDurationConverters.JavaDurationOps
 import com.typesafe.config.Config
 
 import scala.concurrent.duration.FiniteDuration
 
-@ApiMayChange
 object EventProducerSettings {
 
   /** Scala API */
@@ -37,7 +35,6 @@ object EventProducerSettings {
     apply(config)
 }
 
-@ApiMayChange
 final class EventProducerSettings private (
     val queryPluginId: String,
     val transformationParallelism: Int,

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/javadsl/EventProducer.scala

@@ -5,7 +5,6 @@
 package akka.projection.grpc.producer.javadsl
 
 import akka.actor.typed.ActorSystem
-import akka.annotation.ApiMayChange
 import akka.dispatch.ExecutionContexts
 import akka.http.javadsl.model.HttpRequest
 import akka.http.javadsl.model.HttpResponse
@@ -23,7 +22,6 @@ import scala.compat.java8.OptionConverters.RichOptionalGeneric
 /**
  * The event producer implementation that can be included a gRPC route in an Akka HTTP server.
  */
-@ApiMayChange
 object EventProducer {
 
   /**

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/javadsl/EventProducerInterceptor.scala

@@ -5,7 +5,6 @@
 package akka.projection.grpc.producer.javadsl
 
 import akka.Done
-import akka.annotation.ApiMayChange
 import akka.grpc.internal.JavaMetadataImpl
 import akka.grpc.javadsl.Metadata
 import akka.grpc.scaladsl
@@ -17,7 +16,6 @@ import scala.concurrent.Future
 /**
  * Interceptor allowing for example authentication/authorization of incoming requests to consume a specific stream.
  */
-@ApiMayChange
 @FunctionalInterface
 trait EventProducerInterceptor {
 

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/javadsl/EventProducerSource.scala

@@ -6,7 +6,6 @@ package akka.projection.grpc.producer.javadsl
 
 import java.util.Optional
 import java.util.function.{ Function => JFunction }
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.persistence.query.typed.EventEnvelope
 import akka.projection.grpc.internal.TopicMatcher
@@ -39,7 +38,6 @@ object EventProducerSource {
  * @param transformation Transformations for turning the internal events to public message types
  * @param settings The event producer settings used (can be shared for multiple sources)
  */
-@ApiMayChange
 final class EventProducerSource(
     val entityType: String,
     val streamId: String,

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/javadsl/Transformation.scala

@@ -4,7 +4,6 @@
 
 package akka.projection.grpc.producer.javadsl
 
-import akka.annotation.ApiMayChange
 import akka.dispatch.ExecutionContexts
 import akka.persistence.query.typed.EventEnvelope
 import akka.projection.grpc.producer.scaladsl
@@ -17,14 +16,12 @@ import scala.compat.java8.FutureConverters._
 import scala.compat.java8.OptionConverters._
 import scala.reflect.ClassTag
 
-@ApiMayChange
 @FunctionalInterface
 trait Mapper[A, B] {
   def apply(event: A, metadata: Optional[Any]): CompletionStage[Optional[B]]
 
 }
 
-@ApiMayChange
 object Transformation {
 
   /**
@@ -47,7 +44,6 @@ object Transformation {
  * Not for direct construction, use [[Transformation.empty]] as starting point and register
  * mappers to build your needed Transformation
  */
-@ApiMayChange
 final class Transformation private[akka] (private[akka] val delegate: scaladsl.EventProducer.Transformation) {
 
   /**

akka-projection-grpc/src/main/scala/akka/projection/grpc/producer/scaladsl/EventProducer.scala

@@ -9,7 +9,6 @@ import scala.reflect.ClassTag
 
 import akka.Done
 import akka.actor.typed.ActorSystem
-import akka.annotation.ApiMayChange
 import akka.annotation.InternalApi
 import akka.grpc.scaladsl.Metadata
 import akka.http.scaladsl.model.HttpRequest
@@ -31,7 +30,6 @@ import akka.projection.grpc.replication.internal.EventOriginFilter
 /**
  * The event producer implementation that can be included a gRPC route in an Akka HTTP server.
  */
-@ApiMayChange
 object EventProducer {
 
   object EventProducerSource {
@@ -72,7 +70,6 @@ object EventProducer {
    * @param transformation Transformations for turning the internal events to public message types
    * @param settings       The event producer settings used (can be shared for multiple sources)
    */
-  @ApiMayChange
   final class EventProducerSource private (
       val entityType: String,
       val streamId: String,
@@ -138,7 +135,6 @@ object EventProducer {
 
   }
 
-  @ApiMayChange
   object Transformation {
 
     /**
@@ -164,7 +160,6 @@ object EventProducer {
    * Transformation of events to the external (public) representation.
    * Events can be excluded by mapping them to `None`.
    */
-  @ApiMayChange
   final class Transformation private (
       private[akka] val mappers: Map[Class[_], EventEnvelope[Any] => Future[Option[Any]]],
       private[akka] val orElse: EventEnvelope[Any] => Future[Option[Any]]) {
@@ -373,7 +368,6 @@ object EventProducer {
 /**
  * Interceptor allowing for example authentication/authorization of incoming requests to consume a specific stream.
  */
-@ApiMayChange
 trait EventProducerInterceptor {
 
   /**

akka-projection-grpc/src/main/scala/akka/projection/grpc/replication/javadsl/Replica.scala

@@ -4,15 +4,13 @@
 
 package akka.projection.grpc.replication.javadsl
 
-import akka.annotation.ApiMayChange
 import akka.annotation.DoNotInherit
 import akka.grpc.GrpcClientSettings
 import akka.persistence.typed.ReplicaId
 import akka.projection.grpc.replication.internal.ReplicaImpl
 
 import java.util.Optional
 
-@ApiMayChange
 object Replica {
 
   /**
@@ -28,9 +26,8 @@ object Replica {
 }
 
 /**
- * Not for user extension, construct using Replica#create
+ * Not for user extension, construct using [[Replica.create]]
  */
-@ApiMayChange
 @DoNotInherit
 trait Replica {
 

akka-projection-grpc/src/main/scala/akka/projection/grpc/replication/javadsl/ReplicatedBehaviors.scala

@@ -5,7 +5,7 @@
 package akka.projection.grpc.replication.javadsl
 
 import akka.actor.typed.Behavior
-import akka.annotation.ApiMayChange
+import akka.annotation.DoNotInherit
 import akka.japi.function.{ Function => JFunction }
 import akka.persistence.typed.javadsl.EventSourcedBehavior
 import akka.persistence.typed.javadsl.ReplicationContext
@@ -16,8 +16,10 @@ import akka.persistence.typed.javadsl.ReplicationContext
  * Must be used to create an event sourced behavior to be replicated with [[Replication.grpcReplication]].
  *
  * Can optionally be composed with other Behavior factories, to get access to actor context or timers.
+ *
+ * Not for user extension.
  */
-@ApiMayChange
+@DoNotInherit
 abstract class ReplicatedBehaviors[Command, Event, State] {
   def setup(factory: JFunction[ReplicationContext, EventSourcedBehavior[Command, Event, State]]): Behavior[Command]
 }