chore: Make SSE event encode method public API (akka#4484)

Author: johanandren

akka-http-core/src/main/java/akka/http/javadsl/model/sse/ServerSentEvent.java

@@ -16,16 +16,21 @@
 
 package akka.http.javadsl.model.sse;
 
+import akka.annotation.DoNotInherit;
+import akka.util.ByteString;
+import scala.Option;
+import scala.jdk.javaapi.OptionConverters;
+
 import java.util.Optional;
 import java.util.OptionalInt;
 
-import scala.jdk.javaapi.OptionConverters;
-import scala.Option;
-
 /**
  * Representation of a server-sent event. According to the specification, an empty data field
  * designates an event which is to be ignored which is useful for heartbeats.
+ * <p>
+ * Not for user extension
  */
+@DoNotInherit
 public abstract class ServerSentEvent {
 
     private static final Option<String> stringNone = Option.empty();
@@ -116,4 +121,9 @@ public static ServerSentEvent create(String data,
      * Optional reconnection delay in milliseconds.
      */
     public abstract OptionalInt getRetry();
+
+    /**
+     * Encode the event to bytes for use in a response
+     */
+    public abstract ByteString encode();
 }

akka-http-core/src/main/mima-filters/10.7.0.backwards.excludes/sse-encode.excludes

@@ -0,0 +1,2 @@
+# internal method made public/added in Java DSL
+ProblemFilters.exclude[ReversedMissingMethodProblem]("akka.http.javadsl.model.sse.ServerSentEvent.encode")

akka-http-core/src/main/scala/akka/http/scaladsl/model/sse/ServerSentEvent.scala

@@ -7,8 +7,6 @@ package scaladsl
 package model
 package sse
 
-import akka.annotation.InternalStableApi
-
 import java.nio.charset.StandardCharsets.UTF_8
 import akka.http.javadsl.model
 import akka.util.ByteString
@@ -89,8 +87,7 @@ final case class ServerSentEvent(
   require(id.forall(noNewLine), "id must not contain \\n or \\r!")
   require(retry.forall(_ > 0), "retry must be a positive number!")
 
-  @InternalStableApi
-  private[scaladsl] def encode = {
+  override def encode(): ByteString = {
     def s = { // Performance fun fact: change this to val and get an ~30% performance penalty!!!
       // Why 8? "data:" == 5 + \n\n (1 data (at least) and 1 ending) == 2 and then we add 1 extra to allocate
       //        a bigger memory slab than data.length since we're going to add data ("data:" + "\n") per line

project/MiMa.scala

@@ -18,8 +18,8 @@ object MiMa extends AutoPlugin {
   override def trigger = allRequirements
 
   // A fork is a branch of the project where new releases are created that are not ancestors of the current release line
-  val forks = Seq("10.2.", "10.4.", "10.5.")
-  val currentFork = "10.6."
+  val forks = Seq("10.2.", "10.4.", "10.5.", "10.6.")
+  val currentFork = "10.7."
 
   // manually maintained list of previous versions to make sure all incompatibilities are found
   // even if so far no files have been been created in this project's mima-filters directory