KTOR-5560 Add shutdown configuration for engine

ktor-server/ktor-server-cio/jvmAndNix/src/io/ktor/server/cio/CIOApplicationEngine.kt

@@ -54,6 +54,10 @@ public class CIOApplicationEngine(
     }
 
     override fun start(wait: Boolean): ApplicationEngine {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         serverJob.start()
 
         runBlocking {

ktor-server/ktor-server-cio/jvmAndNix/src/io/ktor/server/cio/EngineMain.kt

@@ -19,15 +19,6 @@ public object EngineMain {
     public fun main(args: Array<String>) {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = CIOApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
-        val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong()
-                ?: 50
-        val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong()
-                ?: 5000
-        engine.addShutdownHook {
-            engine.stop(gracePeriod, timeout)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-host-common/api/ktor-server-host-common.api

@@ -11,9 +11,13 @@ public class io/ktor/server/engine/ApplicationEngine$Configuration {
 	public final fun getCallGroupSize ()I
 	public final fun getConnectionGroupSize ()I
 	public final fun getParallelism ()I
+	public final fun getShutdownGracePeriod ()J
+	public final fun getShutdownTimeout ()J
 	public final fun getWorkerGroupSize ()I
 	public final fun setCallGroupSize (I)V
 	public final fun setConnectionGroupSize (I)V
+	public final fun setShutdownGracePeriod (J)V
+	public final fun setShutdownTimeout (J)V
 	public final fun setWorkerGroupSize (I)V
 }
 
@@ -257,7 +261,8 @@ public final class io/ktor/server/engine/EngineConnectorConfigKt {
 
 public final class io/ktor/server/engine/EngineContextCancellationHelperKt {
 	public static final fun launchOnCancellation (Lkotlinx/coroutines/Job;Lkotlin/jvm/functions/Function1;)Lkotlinx/coroutines/CompletableJob;
-	public static final fun stopServerOnCancellation (Lio/ktor/server/engine/ApplicationEngine;)Lkotlinx/coroutines/CompletableJob;
+	public static final fun stopServerOnCancellation (Lio/ktor/server/engine/ApplicationEngine;JJ)Lkotlinx/coroutines/CompletableJob;
+	public static synthetic fun stopServerOnCancellation$default (Lio/ktor/server/engine/ApplicationEngine;JJILjava/lang/Object;)Lkotlinx/coroutines/CompletableJob;
 }
 
 public final class io/ktor/server/engine/EnginePipeline : io/ktor/util/pipeline/Pipeline {

ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/ApplicationEngine.kt

@@ -37,6 +37,16 @@ public interface ApplicationEngine {
          * Specifies the minimum size of a thread pool used to process application calls.
          */
         public var callGroupSize: Int = parallelism
+
+        /**
+         * Specifies the maximum amount of time in milliseconds for activity to cool down
+         */
+        public var shutdownGracePeriod: Long = 1000
+
+        /**
+         * Specifies the maximum amount of time in milliseconds to wait until server stops gracefully
+         */
+        public var shutdownTimeout: Long = 5000
     }
 
     /**

ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/CommandLine.kt

@@ -130,6 +130,12 @@ public fun BaseApplicationEngine.Configuration.loadCommonConfiguration(deploymen
     deploymentConfig.propertyOrNull("workerGroupSize")?.getString()?.toInt()?.let {
         workerGroupSize = it
     }
+    deploymentConfig.propertyOrNull("shutdownGracePeriod")?.getString()?.toLong()?.let {
+        shutdownGracePeriod = it
+    }
+    deploymentConfig.propertyOrNull("shutdownTimeout")?.getString()?.toLong()?.let {
+        shutdownTimeout = it
+    }
 }
 
 internal fun String.splitPair(ch: Char): Pair<String, String>? = indexOf(ch).let { idx ->

ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/EngineContextCancellationHelper.kt

@@ -12,9 +12,12 @@ import kotlinx.coroutines.*
  * Stop server on job cancellation. The returned deferred need to be completed or cancelled.
  */
 @OptIn(InternalAPI::class)
-public fun ApplicationEngine.stopServerOnCancellation(): CompletableJob =
+public fun ApplicationEngine.stopServerOnCancellation(
+    gracePeriodMillis: Long = 50,
+    timeoutMillis: Long = 5000
+): CompletableJob =
     environment.parentCoroutineContext[Job]?.launchOnCancellation {
-        stop(50, 5000)
+        stop(gracePeriodMillis, timeoutMillis)
     } ?: Job()
 
 /**

ktor-server/ktor-server-jetty-jakarta/jvm/src/io/ktor/server/jetty/jakarta/EngineMain.kt

@@ -6,7 +6,6 @@ package io.ktor.server.jetty.jakarta
 
 import io.ktor.server.config.*
 import io.ktor.server.engine.*
-import java.util.concurrent.*
 
 /**
  * Jetty engine
@@ -20,9 +19,6 @@ public object EngineMain {
     public fun main(args: Array<String>) {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = JettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
-        engine.addShutdownHook {
-            engine.stop(3, 5, TimeUnit.SECONDS)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-jetty-jakarta/jvm/src/io/ktor/server/jetty/jakarta/JettyApplicationEngineBase.kt

@@ -9,7 +9,6 @@ import io.ktor.server.application.*
 import io.ktor.server.engine.*
 import kotlinx.coroutines.*
 import org.eclipse.jetty.server.*
-import java.util.concurrent.*
 
 /**
  * [ApplicationEngine] base type for running in a standalone Jetty
@@ -46,10 +45,15 @@ public open class JettyApplicationEngineBase(
     }
 
     override fun start(wait: Boolean): JettyApplicationEngineBase {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         environment.start()
 
         server.start()
-        cancellationDeferred = stopServerOnCancellation()
+        cancellationDeferred =
+            stopServerOnCancellation(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
 
         val connectors = server.connectors.zip(environment.connectors)
             .map { it.second.withPort((it.first as ServerConnector).localPort) }
@@ -59,7 +63,7 @@ public open class JettyApplicationEngineBase(
 
         if (wait) {
             server.join()
-            stop(1, 5, TimeUnit.SECONDS)
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         }
         return this
     }

ktor-server/ktor-server-jetty/jvm/src/io/ktor/server/jetty/EngineMain.kt

@@ -19,15 +19,6 @@ public object EngineMain {
     public fun main(args: Array<String>) {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = JettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
-        val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong()
-                ?: 3000
-        val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong()
-                ?: 5000
-        engine.addShutdownHook {
-            engine.stop(gracePeriod, timeout)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-jetty/jvm/src/io/ktor/server/jetty/JettyApplicationEngineBase.kt

@@ -9,7 +9,6 @@ import io.ktor.server.application.*
 import io.ktor.server.engine.*
 import kotlinx.coroutines.*
 import org.eclipse.jetty.server.*
-import java.util.concurrent.*
 
 /**
  * [ApplicationEngine] base type for running in a standalone Jetty
@@ -46,10 +45,15 @@ public open class JettyApplicationEngineBase(
     }
 
     override fun start(wait: Boolean): JettyApplicationEngineBase {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         environment.start()
 
         server.start()
-        cancellationDeferred = stopServerOnCancellation()
+        cancellationDeferred =
+            stopServerOnCancellation(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
 
         val connectors = server.connectors.zip(environment.connectors)
             .map { it.second.withPort((it.first as ServerConnector).localPort) }
@@ -59,7 +63,7 @@ public open class JettyApplicationEngineBase(
 
         if (wait) {
             server.join()
-            stop(1, 5, TimeUnit.SECONDS)
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         }
         return this
     }

ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/EngineMain.kt

@@ -20,15 +20,6 @@ public object EngineMain {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = NettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
 
-        val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong()
-                ?: 3000
-        val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong()
-                ?: 5000
-        engine.addShutdownHook {
-            engine.stop(gracePeriod, timeout)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/NettyApplicationEngine.kt

@@ -209,6 +209,10 @@ public class NettyApplicationEngine(
     }
 
     override fun start(wait: Boolean): NettyApplicationEngine {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         environment.start()
 
         try {
@@ -225,11 +229,12 @@ public class NettyApplicationEngine(
 
         environment.monitor.raiseCatching(ServerReady, environment, environment.log)
 
-        cancellationDeferred = stopServerOnCancellation()
+        cancellationDeferred =
+            stopServerOnCancellation(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
 
         if (wait) {
             channels?.map { it.closeFuture() }?.forEach { it.sync() }
-            stop(1, 5, TimeUnit.SECONDS)
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         }
         return this
     }

ktor-server/ktor-server-tomcat-jakarta/jvm/src/io/ktor/server/tomcat/jakarta/EngineMain.kt

@@ -6,7 +6,6 @@ package io.ktor.server.tomcat.jakarta
 
 import io.ktor.server.config.*
 import io.ktor.server.engine.*
-import java.util.concurrent.*
 
 /**
  * Tomcat engine
@@ -22,9 +21,6 @@ public object EngineMain {
         val engine = TomcatApplicationEngine(applicationEnvironment) {
             loadConfiguration(applicationEnvironment.config)
         }
-        engine.addShutdownHook {
-            engine.stop(3, 5, TimeUnit.SECONDS)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-tomcat-jakarta/jvm/src/io/ktor/server/tomcat/jakarta/TomcatApplicationEngine.kt

@@ -21,7 +21,6 @@ import org.apache.tomcat.util.net.jsse.*
 import org.apache.tomcat.util.net.openssl.*
 import org.slf4j.*
 import java.nio.file.*
-import java.util.concurrent.*
 import kotlin.coroutines.*
 
 /**
@@ -156,6 +155,10 @@ public class TomcatApplicationEngine(
     private val stopped = atomic(false)
 
     override fun start(wait: Boolean): TomcatApplicationEngine {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         environment.start()
         server.start()
 
@@ -164,10 +167,11 @@ public class TomcatApplicationEngine(
         resolvedConnectors.complete(connectors)
         environment.monitor.raiseCatching(ServerReady, environment, environment.log)
 
-        cancellationDeferred = stopServerOnCancellation()
+        cancellationDeferred =
+            stopServerOnCancellation(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         if (wait) {
             server.server.await()
-            stop(1, 5, TimeUnit.SECONDS)
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         }
         return this
     }

ktor-server/ktor-server-tomcat/jvm/src/io/ktor/server/tomcat/EngineMain.kt

@@ -21,15 +21,6 @@ public object EngineMain {
         val engine = TomcatApplicationEngine(applicationEnvironment) {
             loadConfiguration(applicationEnvironment.config)
         }
-        val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong()
-                ?: 3000
-        val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong()
-                ?: 5000
-        engine.addShutdownHook {
-            engine.stop(gracePeriod, timeout)
-        }
         engine.start(true)
     }
 

ktor-server/ktor-server-tomcat/jvm/src/io/ktor/server/tomcat/TomcatApplicationEngine.kt

@@ -20,7 +20,6 @@ import org.apache.tomcat.util.net.jsse.*
 import org.apache.tomcat.util.net.openssl.*
 import org.slf4j.*
 import java.nio.file.*
-import java.util.concurrent.*
 import javax.servlet.*
 import kotlin.coroutines.*
 
@@ -142,6 +141,10 @@ public class TomcatApplicationEngine(
     private val stopped = atomic(false)
 
     override fun start(wait: Boolean): TomcatApplicationEngine {
+        addShutdownHook {
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
+        }
+
         environment.start()
         server.start()
 
@@ -150,10 +153,11 @@ public class TomcatApplicationEngine(
         resolvedConnectors.complete(connectors)
         environment.monitor.raiseCatching(ServerReady, environment, environment.log)
 
-        cancellationDeferred = stopServerOnCancellation()
+        cancellationDeferred =
+            stopServerOnCancellation(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         if (wait) {
             server.server.await()
-            stop(1, 5, TimeUnit.SECONDS)
+            stop(configuration.shutdownGracePeriod, configuration.shutdownTimeout)
         }
         return this
     }