Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

KTOR-5359 Add engine shutdown configuration #3324

Merged
merged 5 commits into from Dec 20, 2022
Merged

KTOR-5359 Add engine shutdown configuration #3324

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32a220e
KTOR-5359 Add engine shutdown configuration
marychatte Dec 19, 2022
2736113
Fix ApiDump
marychatte Dec 19, 2022
a532c45
Rename gracePeriod and timeout
marychatte Dec 20, 2022
27727e6
Remove unnecessary config field
marychatte Dec 20, 2022
a367da2
Fix CodeStyle
marychatte Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ktor-server/ktor-server-cio/jvm/test/io/ktor/tests/server/cio/CIOEngineTestJvm.kt
View file
Open in desktop
Expand Up @@ -44,7 +44,7 @@ class CIOSustainabilityTest : SustainabilityTestSuite<CIOApplicationEngine, CIOA
}
}

class CIOConfigTest : ConfigTestSuite(CIO)
class CIOConfigTest : ConfigTestSuite(CIO, { CIOApplicationEngine.Configuration() })

class CIOConnectionTest : ConnectionTestSuite(CIO)

Expand Down
6 changes: 5 additions & 1 deletion ktor-server/ktor-server-cio/jvmAndNix/src/io/ktor/server/cio/EngineMain.kt
View file
Open in desktop
Expand Up @@ -19,8 +19,12 @@ 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.gracePeriod")?.getString()?.toLong() ?: 50
val timeout =
engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
marychatte marked this conversation as resolved.
Show resolved Hide resolved
engine.addShutdownHook {
engine.stop(50, 5000)
engine.stop(gracePeriod, timeout)
}
engine.start(true)
}
Expand Down
4 changes: 4 additions & 0 deletions ktor-server/ktor-server-host-common/api/ktor-server-host-common.api
View file
Open in desktop
Expand Up @@ -10,10 +10,14 @@ public class io/ktor/server/engine/ApplicationEngine$Configuration {
public fun <init> ()V
public final fun getCallGroupSize ()I
public final fun getConnectionGroupSize ()I
public final fun getGracePeriodMillis ()J
public final fun getParallelism ()I
public final fun getTimeoutMillis ()J
public final fun getWorkerGroupSize ()I
public final fun setCallGroupSize (I)V
public final fun setConnectionGroupSize (I)V
public final fun setGracePeriodMillis (J)V
public final fun setTimeoutMillis (J)V
public final fun setWorkerGroupSize (I)V
}

Expand Down
10 changes: 10 additions & 0 deletions ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/ApplicationEngine.kt
View file
Open in desktop
Expand Up @@ -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 for activity to cool down in milliseconds.
*/
public var gracePeriodMillis: Long = 500
marychatte marked this conversation as resolved.
Show resolved Hide resolved

/**
* Specifies the maximum amount of time to wait until a server stops gracefully in milliseconds.
*/
public var timeoutMillis: Long = 500
}

/**
Expand Down
6 changes: 6 additions & 0 deletions ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/CommandLine.kt
View file
Open in desktop
Expand Up @@ -130,6 +130,12 @@ public fun BaseApplicationEngine.Configuration.loadCommonConfiguration(deploymen
deploymentConfig.propertyOrNull("workerGroupSize")?.getString()?.toInt()?.let {
workerGroupSize = it
}
deploymentConfig.propertyOrNull("gracePeriod")?.getString()?.toLong()?.let {
gracePeriodMillis = it
}
deploymentConfig.propertyOrNull("timeout")?.getString()?.toLong()?.let {
timeoutMillis = it
}
}

internal fun String.splitPair(ch: Char): Pair<String, String>? = indexOf(ch).let { idx ->
Expand Down
7 changes: 5 additions & 2 deletions ktor-server/ktor-server-jetty/jvm/src/io/ktor/server/jetty/EngineMain.kt
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@ package io.ktor.server.jetty

import io.ktor.server.config.*
import io.ktor.server.engine.*
import java.util.concurrent.*

/**
* Jetty engine
Expand All @@ -20,8 +19,12 @@ 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.gracePeriod")?.getString()?.toLong() ?: 3000
val timeout =
engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
engine.addShutdownHook {
engine.stop(3, 5, TimeUnit.SECONDS)
engine.stop(gracePeriod, timeout)
}
engine.start(true)
}
Expand Down
2 changes: 1 addition & 1 deletion ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyEngineTest.kt
View file
Open in desktop
Expand Up @@ -88,7 +88,7 @@ class JettyHttpServerJvmTest : HttpServerJvmTestSuite<JettyApplicationEngine, Je
class JettySustainabilityTest :
SustainabilityTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty)

class JettyConfigTest : ConfigTestSuite(Jetty)
class JettyConfigTest : ConfigTestSuite(Jetty, { JettyApplicationEngineBase.Configuration() })

class JettyConnectionTest : ConnectionTestSuite(Jetty)

Expand Down
8 changes: 6 additions & 2 deletions ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/EngineMain.kt
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@ package io.ktor.server.netty

import io.ktor.server.config.*
import io.ktor.server.engine.*
import java.util.concurrent.*

/**
* Netty engine
Expand All @@ -20,8 +19,13 @@ public object EngineMain {
public fun main(args: Array<String>) {
val applicationEnvironment = commandLineEnvironment(args)
val engine = NettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }

val gracePeriod =
engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 3000
val timeout =
engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
engine.addShutdownHook {
engine.stop(3, 5, TimeUnit.SECONDS)
engine.stop(gracePeriod, timeout)
}
engine.start(true)
}
Expand Down
2 changes: 1 addition & 1 deletion ktor-server/ktor-server-netty/jvm/test/io/ktor/tests/server/netty/NettyEngineTest.kt
View file
Open in desktop
Expand Up @@ -104,7 +104,7 @@ class NettySustainabilityTest : SustainabilityTestSuite<NettyApplicationEngine,
}
}

class NettyConfigTest : ConfigTestSuite(Netty)
class NettyConfigTest : ConfigTestSuite(Netty, { NettyApplicationEngine.Configuration() })

class NettyConnectionTest : ConnectionTestSuite(Netty)

Expand Down
27 changes: 26 additions & 1 deletion ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/ConfigTestSuite.kt
View file
Open in desktop
Expand Up @@ -4,6 +4,8 @@

package io.ktor.server.testing.suites

import com.typesafe.config.*
import io.ktor.server.config.*
import io.ktor.server.engine.*
import kotlinx.coroutines.*
import org.junit.*
Expand All @@ -13,7 +15,10 @@ import kotlin.system.*

var count = 0

abstract class ConfigTestSuite(val engine: ApplicationEngineFactory<*, *>) {
abstract class ConfigTestSuite(
val engine: ApplicationEngineFactory<*, *>,
val configuration: () -> BaseApplicationEngine.Configuration
) {

@Test
fun testStartOnceWhenException() {
Expand Down Expand Up @@ -59,4 +64,24 @@ abstract class ConfigTestSuite(val engine: ApplicationEngineFactory<*, *>) {

assertTrue("Stop time is $time", time < 100)
}

@Test
fun testCommonEngineConfiguration() {
val config = HoconApplicationConfig(
ConfigFactory.parseString(
"""
ktor {
deployment {
gracePeriod: 2000,
timeout: 6000
}
}
""".trimIndent()
)
)

val configuration = configuration().apply { loadCommonConfiguration(config.config("ktor.deployment")) }
assertEquals(2000, configuration.gracePeriodMillis)
assertEquals(6000, configuration.timeoutMillis)
}
}
7 changes: 5 additions & 2 deletions ktor-server/ktor-server-tomcat/jvm/src/io/ktor/server/tomcat/EngineMain.kt
View file
Open in desktop
Expand Up @@ -6,7 +6,6 @@ package io.ktor.server.tomcat

import io.ktor.server.config.*
import io.ktor.server.engine.*
import java.util.concurrent.*

/**
* Tomcat engine
Expand All @@ -22,8 +21,12 @@ public object EngineMain {
val engine = TomcatApplicationEngine(applicationEnvironment) {
loadConfiguration(applicationEnvironment.config)
}
val gracePeriod =
engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 3000
val timeout =
engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
engine.addShutdownHook {
engine.stop(3, 5, TimeUnit.SECONDS)
engine.stop(gracePeriod, timeout)
}
engine.start(true)
}
Expand Down
2 changes: 1 addition & 1 deletion ktor-server/ktor-server-tomcat/jvm/test/io/ktor/tests/server/tomcat/TomcatEngineTest.kt
View file
Open in desktop
Expand Up @@ -167,7 +167,7 @@ class TomcatSustainabilityTestSuite :
}
}

class TomcatConfigTest : ConfigTestSuite(Tomcat)
class TomcatConfigTest : ConfigTestSuite(Tomcat, { TomcatApplicationEngine.Configuration() })

class TomcatConnectionTest : ConnectionTestSuite(Tomcat)

Expand Down