Merge pull request #46 from SLNE-Development/43-improve-handling-of-standalone-crash-in-server-client-architecture

Improve crash handling in standalone server-client architecture with graceful shutdown and restart logic

Author: twisti-dev

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/exceptions/FatalSurfError.kt

@@ -1,5 +1,6 @@
 package dev.slne.surf.cloud.api.common.exceptions
 
+import dev.slne.surf.cloud.api.common.util.annotation.InternalApi
 import org.apache.commons.lang3.StringUtils
 import org.apache.commons.text.WordUtils
 import org.springframework.boot.ExitCodeGenerator
@@ -21,6 +22,7 @@ private const val LINE_WIDTH = 80
  * @property possibleSolutions Suggestions for resolving the error.
  * @property exitCode The exit code to return when terminating the application.
  */
+@InternalApi
 class FatalSurfError private constructor(
     private val simpleErrorMessage: String?,
     private val detailedErrorMessage: String?,

surf-cloud-api/surf-cloud-api-common/src/main/kotlin/dev/slne/surf/cloud/api/common/util/spring-util.kt

@@ -6,10 +6,12 @@ import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
 import org.springframework.aop.framework.AopProxyUtils
 import org.springframework.beans.factory.ObjectFactory
+import org.springframework.beans.factory.ObjectProvider
 import org.springframework.core.MethodIntrospector
 import org.springframework.core.annotation.AnnotatedElementUtils
 import org.springframework.core.annotation.AnnotationUtils
 import org.springframework.core.type.AnnotationMetadata
+import org.springframework.stereotype.Component
 import org.springframework.transaction.TransactionStatus
 import org.springframework.transaction.support.TransactionOperations
 import org.springframework.util.StopWatch
@@ -117,3 +119,8 @@ suspend inline fun <T> TransactionOperations.executeAndAwait(
         } as T
     }
 }
+
+
+inline fun <T> ObjectProvider<T>.forEachOrdered(action: (T) -> Unit) {
+    orderedStream().iterator().forEach(action)
+}

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

@@ -150,4 +150,6 @@ fun Method.isSuspending() = kotlinFunction?.isSuspend == true
 suspend inline fun <T, R> Iterable<T>.mapAsync(crossinline transform: suspend (T) -> R): ObjectList<Deferred<R>> =
     coroutineScope {
         mapTo(mutableObjectListOf()) { async { transform(it) } }
-    }
+    }
+
+fun <T : Any> T?.asOptional(): Optional<T> = Optional.ofNullable(this)

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

@@ -1,6 +1,7 @@
 package dev.slne.surf.cloud.bukkit
 
 import dev.slne.surf.cloud.core.common.CloudCoreInstance.BootstrapData
+import dev.slne.surf.cloud.core.common.coreCloudInstance
 import dev.slne.surf.cloud.core.common.handleEventuallyFatalError
 import io.papermc.paper.plugin.bootstrap.BootstrapContext
 import io.papermc.paper.plugin.bootstrap.PluginBootstrap
@@ -14,13 +15,15 @@ class BukkitBootstrap : PluginBootstrap {
 
     override fun bootstrap(context: BootstrapContext): Unit = runBlocking {
         try {
-            bukkitCloudInstance.bootstrap(
+            coreCloudInstance.bootstrap(
                 BootstrapData(
                     dataFolder = context.dataDirectory
                 )
             )
         } catch (e: Throwable) {
-            e.handleEventuallyFatalError { exitProcess(it.exitCode) }
+            e.handleEventuallyFatalError {
+                exitProcess(it)
+            }
         }
     }
 

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

@@ -1,7 +1,6 @@
 package dev.slne.surf.cloud.bukkit
 
 import com.github.shynixn.mccoroutine.folia.SuspendingJavaPlugin
-import com.github.shynixn.mccoroutine.folia.globalRegionDispatcher
 import com.github.shynixn.mccoroutine.folia.launch
 import dev.jorel.commandapi.CommandAPIBukkit
 import dev.jorel.commandapi.kotlindsl.*
@@ -11,11 +10,11 @@ import dev.slne.surf.cloud.api.common.player.teleport.TeleportCause
 import dev.slne.surf.cloud.api.common.player.teleport.fineLocation
 import dev.slne.surf.cloud.api.common.player.toCloudPlayer
 import dev.slne.surf.cloud.api.common.server.CloudServerManager
+import dev.slne.surf.cloud.core.common.coreCloudInstance
 import dev.slne.surf.cloud.core.common.handleEventuallyFatalError
 import dev.slne.surf.surfapi.bukkit.api.event.listen
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.text.format.NamedTextColor
-import org.bukkit.Bukkit
 import org.bukkit.Location
 import org.bukkit.entity.Player
 import org.bukkit.event.server.ServerLoadEvent
@@ -25,43 +24,33 @@ import kotlin.contracts.contract
 class BukkitMain : SuspendingJavaPlugin() {
     override suspend fun onLoadAsync() {
         try {
-            bukkitCloudInstance.onLoad()
+            coreCloudInstance.onLoad()
         } catch (t: Throwable) {
-            t.handleEventuallyFatalError { Bukkit.shutdown() }
+            t.handleEventuallyFatalError { server.restart() }
         }
     }
 
     override suspend fun onEnableAsync() {
         try {
-            bukkitCloudInstance.onEnable()
+            coreCloudInstance.onEnable()
         } catch (t: Throwable) {
-            t.handleEventuallyFatalError { Bukkit.shutdown() }
+            t.handleEventuallyFatalError { server.restart() }
         }
 
         var serverLoaded = false
         listen<ServerLoadEvent> {
             if (serverLoaded) return@listen
             serverLoaded = true
 
-            launch(globalRegionDispatcher) {
+            launch {
                 try {
-                    bukkitCloudInstance.afterStart()
+                    coreCloudInstance.afterStart()
                 } catch (t: Throwable) {
-                    t.handleEventuallyFatalError { Bukkit.shutdown() }
+                    t.handleEventuallyFatalError { server.restart() }
                 }
             }
         }
 
-        // TODO: does this actually delay until the server is fully loaded?
-//        launch(globalRegionDispatcher) {
-//            delay(1.ticks)
-//            try {
-//                bukkitCloudInstance.afterStart()
-//            } catch (t: Throwable) {
-//                t.handleEventuallyFatalError({ Bukkit.shutdown() })
-//            }
-//        }
-
         commandAPICommand("deport") {
             entitySelectorArgumentOnePlayer("target")
             locationArgument("location")
@@ -133,7 +122,7 @@ class BukkitMain : SuspendingJavaPlugin() {
 
     override suspend fun onDisableAsync() {
         try {
-            bukkitCloudInstance.onDisable()
+            coreCloudInstance.onDisable()
         } catch (t: Throwable) {
             t.handleEventuallyFatalError {}
         }

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

@@ -1,5 +1,6 @@
 package dev.slne.surf.cloud.bukkit.command
 
+import dev.slne.surf.cloud.api.common.util.TimeLogger
 import dev.slne.surf.cloud.bukkit.command.broadcast.broadcastCommand
 import dev.slne.surf.cloud.bukkit.command.connection.disconnectPlayerCommand
 import dev.slne.surf.cloud.bukkit.command.connection.timeoutPlayerCommand
@@ -9,8 +10,20 @@ import dev.slne.surf.cloud.bukkit.command.network.glistCommand
 import dev.slne.surf.cloud.bukkit.command.network.sendCommand
 import dev.slne.surf.cloud.bukkit.command.network.serverCommand
 import dev.slne.surf.cloud.bukkit.command.playtime.playtimeCommand
+import dev.slne.surf.cloud.core.common.spring.CloudLifecycleAware
+import org.springframework.core.annotation.Order
+import org.springframework.stereotype.Component
+
+@Component
+@Order(CloudLifecycleAware.MISC_PRIORITY)
+class PaperCommandManager : CloudLifecycleAware {
+
+    override suspend fun onEnable(timeLogger: TimeLogger) {
+        timeLogger.measureStep("Register Cloud commands") {
+            registerCommands()
+        }
+    }
 
-object PaperCommandManager {
     fun registerCommands() {
         findCommand()
         serverCommand()

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

@@ -1,16 +1,34 @@
 package dev.slne.surf.cloud.bukkit.listener
 
+import dev.slne.surf.cloud.api.common.util.TimeLogger
 import dev.slne.surf.cloud.bukkit.listener.exception.SurfFatalErrorExceptionListener
 import dev.slne.surf.cloud.bukkit.listener.player.ConnectionListener
 import dev.slne.surf.cloud.bukkit.listener.player.SilentDisconnectListener
 import dev.slne.surf.cloud.bukkit.plugin
+import dev.slne.surf.cloud.core.common.spring.CloudLifecycleAware
 import dev.slne.surf.surfapi.bukkit.api.event.register
 import dev.slne.surf.surfapi.bukkit.api.nms.NmsUseWithCaution
 import dev.slne.surf.surfapi.bukkit.api.nms.nmsBridge
 import org.bukkit.event.HandlerList
+import org.springframework.core.annotation.Order
+import org.springframework.stereotype.Component
 
 @OptIn(NmsUseWithCaution::class)
-object ListenerManager {
+@Component
+@Order(CloudLifecycleAware.MISC_PRIORITY)
+class ListenerManager: CloudLifecycleAware {
+
+    override suspend fun onEnable(timeLogger: TimeLogger) {
+        timeLogger.measureStep("Registering listeners") {
+            registerListeners()
+        }
+    }
+
+    override suspend fun onDisable(timeLogger: TimeLogger) {
+        timeLogger.measureStep("Unregistering listeners") {
+            unregisterListeners()
+        }
+    }
 
     fun registerListeners() {
         ConnectionListener.register()

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

@@ -8,15 +8,15 @@ import org.bukkit.event.EventHandler
 import org.bukkit.event.Listener
 
 object SurfFatalErrorExceptionListener : Listener {
-    private val handler = { _: FatalSurfError -> Bukkit.shutdown() }
+//    private val handler = { _: FatalSurfError -> Bukkit.shutdown() }
 
-    @EventHandler
-    fun onServerException(event: ServerExceptionEvent) {
-        val e = event.exception
-        if (e.handle()) return
-        if (e.cause?.handle() == true) return
-    }
-
-    private fun Throwable.handle() = handleEventuallyFatalError(false, false, handler)
+//    @EventHandler
+//    fun onServerException(event: ServerExceptionEvent) {
+//        val e = event.exception
+//        if (e.handle()) return
+//        if (e.cause?.handle() == true) return
+//    }
+//
+//    private fun Throwable.handle() = handleEventuallyFatalError(false, false, handler)
 
 }

surf-cloud-bukkit/src/main/kotlin/dev/slne/surf/cloud/bukkit/listener/exception/SurfFatalErrorExceptionListener.kt

@@ -3,6 +3,7 @@ package dev.slne.surf.cloud.bukkit.netty
 import com.google.auto.service.AutoService
 import dev.slne.surf.cloud.api.client.netty.CloudClientNettyManager
 import dev.slne.surf.cloud.core.client.netty.CommonCloudClientNettyManagerImpl
+import dev.slne.surf.cloud.core.common.util.bean
 import dev.slne.surf.cloud.core.common.util.checkInstantiationByServiceLoader
 
 @AutoService(CloudClientNettyManager::class)
@@ -11,5 +12,5 @@ class BukkitCloudClientNettyManagerImpl : CommonCloudClientNettyManagerImpl() {
         checkInstantiationByServiceLoader()
     }
 
-    override val client get() = BukkitNettyManager.nettyClient
+    override val client get() = bean<BukkitNettyManager>().nettyClient
 }