KTOR-9054 Fix application call coroutine context (#5170)

bjhham · osipxd · web-flow · commit 08006fc5f91c · 2025-11-04T16:50:49.000+01:00
* KTOR-9054 Fix application call coroutine context

* KTOR-9054 Fixup Jetty engine coroutines

* Update ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/SustainabilityTestSuite.kt

Co-authored-by: Osip Fatkullin &lt;osip.fatkullin@jetbrains.com&gt;

* Disable tomcat coroutine hierarchy check

---------

Co-authored-by: Osip Fatkullin &lt;osip.fatkullin@jetbrains.com&gt;
diff --git a/ktor-server/ktor-server-cio/jvm/test/io/ktor/tests/server/cio/CIOEngineTestJvm.kt b/ktor-server/ktor-server-cio/jvm/test/io/ktor/tests/server/cio/CIOEngineTestJvm.kt
@@ -46,6 +46,9 @@ class CIOSustainabilityTest : SustainabilityTestSuite<CIOApplicationEngine, CIOA
         enableHttp2 = false
         enableSsl = false
     }
+
+    @Ignore
+    override fun validateCallCoroutineContext() {}
 }
 
 class CIOConfigTest : ConfigTestSuite(CIO)
diff --git a/ktor-server/ktor-server-core/common/src/io/ktor/server/routing/RoutingPipelineCall.kt b/ktor-server/ktor-server-core/common/src/io/ktor/server/routing/RoutingPipelineCall.kt
@@ -23,29 +23,29 @@ import kotlin.coroutines.*
 public class RoutingPipelineCall(
     public val engineCall: PipelineCall,
     public val route: RoutingNode,
+    override val coroutineContext: CoroutineContext,
     receivePipeline: ApplicationReceivePipeline,
     responsePipeline: ApplicationSendPipeline,
     public val pathParameters: Parameters
 ) : PipelineCall, CoroutineScope {
-    @Deprecated(level = DeprecationLevel.WARNING, message = "CoroutineContext is delegated to engineCall now.")
+    @Deprecated(level = DeprecationLevel.WARNING, message = "Use explicit coroutineContext instead.")
     public constructor(
         engineCall: PipelineCall,
         route: RoutingNode,
-        coroutineContext: CoroutineContext,
         receivePipeline: ApplicationReceivePipeline,
         responsePipeline: ApplicationSendPipeline,
         pathParameters: Parameters
     ) : this(
         engineCall,
         route,
+        engineCall.coroutineContext,
         receivePipeline,
         responsePipeline,
         pathParameters
     )
 
     override val application: Application get() = engineCall.application
     override val attributes: Attributes get() = engineCall.attributes
-    override val coroutineContext: CoroutineContext get() = engineCall.coroutineContext
 
     override val request: RoutingPipelineRequest =
         RoutingPipelineRequest(this, receivePipeline, engineCall.request)
diff --git a/ktor-server/ktor-server-core/common/src/io/ktor/server/routing/RoutingRoot.kt b/ktor-server/ktor-server-core/common/src/io/ktor/server/routing/RoutingRoot.kt
@@ -94,6 +94,7 @@ public class RoutingRoot(
         val routingApplicationCall = RoutingPipelineCall(
             context.call,
             route,
+            context.coroutineContext,
             receivePipeline,
             responsePipeline,
             parameters
diff --git a/ktor-server/ktor-server-jetty-jakarta/jvm/src/io/ktor/server/jetty/jakarta/JettyKtorHandler.kt b/ktor-server/ktor-server-jetty-jakarta/jvm/src/io/ktor/server/jetty/jakarta/JettyKtorHandler.kt
@@ -17,6 +17,7 @@ import org.eclipse.jetty.server.Response
 import org.eclipse.jetty.util.Callback
 import java.util.concurrent.*
 import java.util.concurrent.atomic.AtomicLong
+import kotlin.coroutines.CoroutineContext
 
 private val JettyCallHandlerCoroutineName = CoroutineName("jetty-call-handler")
 private val JettyKtorCounter = AtomicLong()
@@ -41,17 +42,16 @@ internal class JettyKtorHandler(
         Thread(r, "ktor-jetty-$environmentName-${JettyKtorCounter.incrementAndGet()}")
     }
     private val dispatcher = executor.asCoroutineDispatcher()
-
-    private val handlerJob = SupervisorJob(applicationProvider().parentCoroutineContext[Job])
-    private val coroutineScope: CoroutineScope =
-        applicationProvider() + handlerJob + DefaultUncaughtExceptionHandler(environment.log)
+    private val handlerContext: CoroutineContext = dispatcher +
+        DefaultUncaughtExceptionHandler(environment.log) +
+        JettyCallHandlerCoroutineName
 
     override fun destroy() {
         try {
             super.destroy()
             executor.shutdownNow()
         } finally {
-            handlerJob.cancel()
+            handlerContext.cancel()
         }
     }
 
@@ -61,14 +61,15 @@ internal class JettyKtorHandler(
         callback: Callback,
     ): Boolean {
         try {
-            coroutineScope.launch(dispatcher + JettyCallHandlerCoroutineName) {
+            val application = applicationProvider()
+            application.launch(handlerContext) {
                 val call = JettyApplicationCall(
-                    applicationProvider(),
+                    application,
                     request,
                     response,
                     executor = executor,
-                    userContext = dispatcher,
-                    coroutineContext = this@launch.coroutineContext,
+                    userContext = application.coroutineContext,
+                    coroutineContext = currentCoroutineContext(),
                     idleTimeout = configuration.idleTimeout
                 )
 
diff --git a/ktor-server/ktor-server-jetty-jakarta/jvm/test/io/ktor/tests/server/jetty/jakarta/JettyAsyncServletContainerTest.kt b/ktor-server/ktor-server-jetty-jakarta/jvm/test/io/ktor/tests/server/jetty/jakarta/JettyAsyncServletContainerTest.kt
@@ -44,7 +44,10 @@ class JettyAsyncServletContainerHttpServerJvmTest :
 class JettyAsyncServletContainerSustainabilityTest :
     SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
         Servlet(async = true)
-    )
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyAsyncServerPluginsTest :
     ServerPluginsTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
diff --git a/ktor-server/ktor-server-jetty-jakarta/jvm/test/io/ktor/tests/server/jetty/jakarta/JettyBlockingServletContainerTest.kt b/ktor-server/ktor-server-jetty-jakarta/jvm/test/io/ktor/tests/server/jetty/jakarta/JettyBlockingServletContainerTest.kt
@@ -45,7 +45,10 @@ class JettyBlockingServletContainerHttpServerJvmTest :
 class JettyBlockingServletContainerSustainabilityTest :
     SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
         Servlet(async = false)
-    )
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyBlockingServletServerPluginTest :
     ServerPluginsTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
diff --git a/ktor-server/ktor-server-jetty-jakarta/ktor-server-jetty-test-http2-jakarta/jvm/test/io/ktor/tests/server/jetty/http2/jakarta/JettyHttp2ServletAsyncTest.kt b/ktor-server/ktor-server-jetty-jakarta/ktor-server-jetty-test-http2-jakarta/jvm/test/io/ktor/tests/server/jetty/http2/jakarta/JettyHttp2ServletAsyncTest.kt
@@ -37,4 +37,9 @@ class JettyHttp2AsyncServletContainerHttpServerJvmTest :
 }
 
 class JettyHttp2AsyncServletContainerSustainabilityTest :
-    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(Servlet(async = true))
+    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
+        Servlet(async = true)
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
diff --git a/ktor-server/ktor-server-jetty-jakarta/ktor-server-jetty-test-http2-jakarta/jvm/test/io/ktor/tests/server/jetty/http2/jakarta/JettyHttp2ServletBlockingTest.kt b/ktor-server/ktor-server-jetty-jakarta/ktor-server-jetty-test-http2-jakarta/jvm/test/io/ktor/tests/server/jetty/http2/jakarta/JettyHttp2ServletBlockingTest.kt
@@ -44,4 +44,7 @@ class JettyHttp2BlockingServletContainerHttpServerJvmTest :
 class JettyHttp2BlockingServletContainerSustainabilityTest :
     SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
         Servlet(async = false)
-    )
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
diff --git a/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyAsyncServletContainerTest.kt b/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyAsyncServletContainerTest.kt
@@ -37,7 +37,12 @@ class JettyAsyncServletContainerHttpServerJvmTest :
 }
 
 class JettyAsyncServletContainerSustainabilityTest :
-    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(Servlet(async = true))
+    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
+        Servlet(async = true)
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyAsyncServerPluginsTest :
     ServerPluginsTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
diff --git a/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyBlockingServletContainerTest.kt b/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyBlockingServletContainerTest.kt
@@ -44,7 +44,10 @@ class JettyBlockingServletContainerHttpServerJvmTest :
 class JettyBlockingServletContainerSustainabilityTest :
     SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
         Servlet(async = false)
-    )
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyBlockingServletServerPluginTest :
     ServerPluginsTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
diff --git a/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyEngineTest.kt b/ktor-server/ktor-server-jetty/jvm/test/io/ktor/tests/server/jetty/JettyEngineTest.kt
@@ -85,7 +85,10 @@ class JettyHttpServerJvmTest : HttpServerJvmTestSuite<JettyApplicationEngine, Je
 }
 
 class JettySustainabilityTest :
-    SustainabilityTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty)
+    SustainabilityTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyConfigTest : ConfigTestSuite(Jetty)
 
diff --git a/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyEngineTest.kt b/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyEngineTest.kt
@@ -33,7 +33,10 @@ class JettyEngineHttp2HttpServerJvmTest :
 }
 
 class JettyEngineHttp2SustainabilityTest :
-    SustainabilityTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty)
+    SustainabilityTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
 
 class JettyEngineServerPluginsTest :
     ServerPluginsTestSuite<JettyApplicationEngine, JettyApplicationEngineBase.Configuration>(Jetty) {
diff --git a/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyHttp2ServletAsyncTest.kt b/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyHttp2ServletAsyncTest.kt
@@ -37,4 +37,9 @@ class JettyHttp2AsyncServletContainerHttpServerJvmTest :
 }
 
 class JettyHttp2AsyncServletContainerSustainabilityTest :
-    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(Servlet(async = true))
+    SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
+        Servlet(async = true)
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
diff --git a/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyHttp2ServletBlockingTest.kt b/ktor-server/ktor-server-jetty/ktor-server-jetty-test-http2/jvm/test/io/ktor/tests/server/jetty/http2/JettyHttp2ServletBlockingTest.kt
@@ -44,4 +44,7 @@ class JettyHttp2BlockingServletContainerHttpServerJvmTest :
 class JettyHttp2BlockingServletContainerSustainabilityTest :
     SustainabilityTestSuite<JettyApplicationEngineBase, JettyApplicationEngineBase.Configuration>(
         Servlet(async = false)
-    )
+    ) {
+    @Ignore
+    override fun validateCallCoroutineContext() {}
+}
diff --git a/ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/SustainabilityTestSuite.kt b/ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/SustainabilityTestSuite.kt
@@ -967,6 +967,32 @@ abstract class SustainabilityTestSuite<TEngine : ApplicationEngine, TConfigurati
         }
     }
 
+    @OptIn(ExperimentalCoroutinesApi::class)
+    @Test
+    open fun validateCallCoroutineContext() = runTest {
+        createAndStartServer {
+            get {
+                val applicationJob = application.coroutineContext.job
+                val callJob = call.coroutineContext.job
+                val hierarchy = generateSequence(callJob) { it.parent }.toList()
+                call.respondText(
+                    """
+                    Hierarchy preserved: ${callJob != applicationJob && applicationJob in hierarchy}
+                    """.trimIndent()
+                )
+            }
+        }
+
+        withUrl("") {
+            assertEquals(
+                """
+                Hierarchy preserved: true
+                """.trimIndent(),
+                body()
+            )
+        }
+    }
+
     @OptIn(ExperimentalCoroutinesApi::class)
     @Test
     open fun testJobsAreCancelledOnShutdown() = runTest {
diff --git a/ktor-server/ktor-server-tomcat-jakarta/jvm/test/io/ktor/tests/server/tomcat/jakarta/TomcatEngineTest.kt b/ktor-server/ktor-server-tomcat-jakarta/jvm/test/io/ktor/tests/server/tomcat/jakarta/TomcatEngineTest.kt
@@ -173,6 +173,9 @@ class TomcatSustainabilityTestSuite :
     override fun testBlockingConcurrency() {
         super.testBlockingConcurrency()
     }
+
+    @Ignore
+    override fun validateCallCoroutineContext() {}
 }
 
 class TomcatConfigTest : ConfigTestSuite(Tomcat)
diff --git a/ktor-server/ktor-server-tomcat/jvm/test/io/ktor/tests/server/tomcat/TomcatEngineTest.kt b/ktor-server/ktor-server-tomcat/jvm/test/io/ktor/tests/server/tomcat/TomcatEngineTest.kt
@@ -171,6 +171,9 @@ class TomcatSustainabilityTestSuite :
     override fun testBlockingConcurrency() {
         super.testBlockingConcurrency()
     }
+
+    @Ignore
+    override fun validateCallCoroutineContext() {}
 }
 
 class TomcatConfigTest : ConfigTestSuite(Tomcat)

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,9 @@ class CIOSustainabilityTest : SustainabilityTestSuite<CIOApplicationEngine, CIOA`
`46`	`46`	`enableHttp2 = false`
`47`	`47`	`enableSsl = false`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ @Ignore`
	`51`	`+ override fun validateCallCoroutineContext() {}`
`49`	`52`	`}`
`50`	`53`
`51`	`54`	`class CIOConfigTest : ConfigTestSuite(CIO)`