feat(proxy): implement multi-proxy support for load balancing and scalability

Author: twisti-dev

surf-cloud-api/surf-cloud-api-client/surf-cloud-api-client-velocity/build.gradle.kts

@@ -1,7 +1,7 @@
 import dev.slne.surf.surfapi.gradle.util.slneReleases
 
 plugins {
-    id("dev.slne.surf.surfapi.gradle.core")
+    id("dev.slne.surf.surfapi.gradle.velocity")
 }
 
 dependencies {

surf-cloud-api/surf-cloud-api-client/surf-cloud-api-client-velocity/src/main/kotlin/dev/slne/surf/cloud/api/client/velocity/server/VelocityCloudServeExtensions.kt

@@ -0,0 +1,8 @@
+package dev.slne.surf.cloud.api.client.velocity.server
+
+import com.velocitypowered.api.proxy.ProxyServer
+import dev.slne.surf.cloud.api.common.server.CloudServer
+import kotlin.jvm.optionals.getOrNull
+
+fun CloudServer.toRegisteredServer(proxy: ProxyServer) =
+    proxy.getServer(name).getOrNull() ?: error("Server $name is not registered in Velocity proxy")

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/meta/SurfNettyPacket.kt

@@ -126,6 +126,7 @@ object DefaultIds {
     const val CLIENTBOUND_CLEAR_RESOURCE_PACKS_PACKET = "cloud:clientbound:clear_resource_packs"
 
     const val PLAYER_CONNECT_TO_SERVER_PACKET = "cloud:player:connect_to_server"
+    const val PLAYER_CONNECTED_TO_SERVER_PACKET = "cloud:player:connected_to_server"
     const val PLAYER_DISCONNECT_FROM_SERVER_PACKET = "cloud:player:disconnect_from_server"
 
     const val SERVERBOUND_REQUEST_DISPLAY_NAME_PACKET = "cloud:serverbound:request_display_name"

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/netty/packet/NettyPacket.kt

@@ -17,6 +17,7 @@ abstract class NettyPacket {
      * This is for internal use and is not intended to be modified externally.
      */
     @InternalApi
+    @Transient
     var handled = false
         private set
 
@@ -33,40 +34,48 @@ abstract class NettyPacket {
      * is required after this packet and the protocol switches to the next state.
      */
     @InternalApi
+    @Transient
     open val terminal: Boolean = false
     // endregion
 
+    @Transient
     private val meta = this::class.getPacketMeta()
 
     /**
      * The unique identifier of this packet.
      */
+    @Transient
     val id = meta.id
 
     /**
      * The flow direction of this packet (e.g., client-to-server or server-to-client).
      */
+    @Transient
     val flow = meta.flow
 
     /**
      * Supported protocols for this packet.
      */
+    @Transient
     val protocols = meta.protocols
 
     /**
      * A session identifier for the packet, generated randomly for each instance.
      */
+    @Transient
     val sessionId = ThreadLocalRandom.current().nextLong()
 
     /**
      * Indicates whether the packet is skippable.
      * If true, the packet will be ignored if its size exceeds the allowed limit.
      */
+    @Transient
     open val skippable = false
 
     /**
      * Additional packets that should be sent after this packet, if any.
      */
+    @Transient
     open val extraPackets: List<NettyPacket>? = null
 
     /**

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/server/CloudServer.kt

@@ -3,7 +3,6 @@ package dev.slne.surf.cloud.api.common.server
 import dev.slne.surf.cloud.api.common.player.CloudPlayer
 import dev.slne.surf.cloud.api.common.player.ConnectionResultEnum
 import it.unimi.dsi.fastutil.objects.ObjectList
-import net.kyori.adventure.text.Component
 import org.jetbrains.annotations.ApiStatus
 import org.jetbrains.annotations.Unmodifiable
 
@@ -25,5 +24,7 @@ interface CloudServer : CommonCloudServer {
      */
     val allowlist: Boolean
 
+    val lobby: Boolean
+
     suspend fun pullPlayers(players: Collection<CloudPlayer>): @Unmodifiable ObjectList<Pair<CloudPlayer, ConnectionResultEnum>>
 }

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/server/CloudServerManager.kt

@@ -70,6 +70,9 @@ interface CloudServerManager {
 
     suspend fun retrieveAllServers(): ObjectCollection<out CommonCloudServer>
 
+    suspend fun retrieveServers(): ObjectCollection<out CloudServer>
+    suspend fun retrieveProxies(): ObjectCollection<out ProxyCloudServer>
+
     suspend fun pullPlayersToGroup(
         group: String,
         players: Collection<CloudPlayer>

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/server/CommonCloudServer.kt

@@ -7,6 +7,7 @@ import it.unimi.dsi.fastutil.objects.Object2ObjectMap
 import net.kyori.adventure.audience.ForwardingAudience
 import net.kyori.adventure.text.Component
 import org.jetbrains.annotations.ApiStatus
+import java.net.InetSocketAddress
 
 /**
  * Represents the result of a batch transfer operation.
@@ -73,6 +74,8 @@ interface CommonCloudServer : ForwardingAudience {
      */
     val users: UserList
 
+    val playAddress: InetSocketAddress
+
     val displayName: String
         get() = "$group/$uid $name"
 

surf-cloud-api/surf-cloud-api-server/src/main/kotlin/dev/slne/surf/cloud/api/server/netty/packet/NettyPacketServerExtensions.kt

@@ -2,18 +2,8 @@ package dev.slne.surf.cloud.api.server.netty.packet
 
 import dev.slne.surf.cloud.api.common.netty.packet.NettyPacket
 import dev.slne.surf.cloud.api.server.server.ServerCloudServerManager
-import dev.slne.surf.surfapi.core.api.util.logger
 
-private val log = logger()
 
-suspend fun NettyPacket.broadcast() {
-    ServerCloudServerManager.retrieveAllServers().forEach { server ->
-        try {
-            server.connection.send(this)
-        } catch (e: Throwable) {
-            log.atWarning()
-                .withCause(e)
-                .log("Failed to send packet in broadcast action to server ${server.displayName}")
-        }
-    }
+fun NettyPacket.broadcast() {
+    ServerCloudServerManager.broadcast(this)
 }

surf-cloud-api/surf-cloud-api-server/src/main/kotlin/dev/slne/surf/cloud/api/server/server/ServerCloudServerManager.kt

@@ -1,5 +1,6 @@
 package dev.slne.surf.cloud.api.server.server
 
+import dev.slne.surf.cloud.api.common.netty.packet.NettyPacket
 import dev.slne.surf.cloud.api.common.server.CloudServerManager
 import dev.slne.surf.cloud.api.common.server.CommonCloudServer
 import it.unimi.dsi.fastutil.objects.ObjectCollection
@@ -20,6 +21,10 @@ interface ServerCloudServerManager : CloudServerManager {
     override suspend fun retrieveServersInGroup(group: String): ObjectList<out ServerCommonCloudServer>
     override suspend fun retrieveServersByCategory(category: String): ObjectList<out ServerCommonCloudServer>
     override suspend fun retrieveAllServers(): ObjectCollection<out ServerCommonCloudServer>
+    override suspend fun retrieveServers(): ObjectCollection<out ServerCloudServer>
+    override suspend fun retrieveProxies(): ObjectCollection<out ServerProxyCloudServer>
+
+    fun broadcast(packet: NettyPacket)
 
     companion object :
         ServerCloudServerManager by CloudServerManager.instance as ServerCloudServerManager

surf-cloud-bukkit/src/main/kotlin/dev/slne/surf/cloud/bukkit/BukkitMain.kt

@@ -18,6 +18,9 @@ import net.kyori.adventure.text.format.NamedTextColor
 import org.bukkit.Location
 import org.bukkit.entity.Player
 import org.bukkit.event.server.ServerLoadEvent
+import java.net.DatagramSocket
+import java.net.InetSocketAddress
+import java.net.URI
 import kotlin.contracts.ExperimentalContracts
 import kotlin.contracts.contract
 
@@ -43,6 +46,21 @@ class BukkitMain : SuspendingJavaPlugin() {
             serverLoaded = true
 
             launch {
+                val datagramSocketIp = DatagramSocket().run {
+                    connect(InetSocketAddress("8.8.8.8", 53))
+                    val ip = localAddress.hostAddress
+                    close()
+                    ip
+                }
+
+                val publicIp = URI("https://checkip.amazonaws.com").toURL().readText().trim()
+
+                repeat(20) {
+                    println("Ip: ${server.ip}")
+                    println("Public IP: $publicIp")
+                    println("Datagram Socket IP: $datagramSocketIp")
+                }
+
                 try {
                     coreCloudInstance.afterStart()
                 } catch (t: Throwable) {