KTOR-6614 Fix SSE client breaking non-SSE requests (#3973)

ktorio · Feb 8, 2024 · cb14545 · cb14545
1 parent 2ee301f
commit cb14545
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/sse/SSE.kt b/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/sse/SSE.kt
@@ -46,6 +46,9 @@ public val SSE: ClientPlugin<SSEConfig> = createClientPlugin(
     val showRetryEvents = pluginConfig.showRetryEvents
 
     transformRequestBody { request, _, _ ->
+        if (getAttributeValue(request, sseRequestAttr) != true) {
+            return@transformRequestBody null
+        }
         LOGGER.trace("Sending SSE request ${request.url}")
         request.setCapability(SSECapability, Unit)
 

diff --git a/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/sse/builders.kt b/ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/sse/builders.kt
@@ -13,6 +13,7 @@ import io.ktor.util.*
 import kotlinx.coroutines.*
 import kotlin.time.*
 
+internal val sseRequestAttr = AttributeKey<Boolean>("SSERequestFlag")
 internal val reconnectionTimeAttr = AttributeKey<Duration>("SSEReconnectionTime")
 internal val showCommentEventsAttr = AttributeKey<Boolean>("SSEShowCommentEvents")
 internal val showRetryEventsAttr = AttributeKey<Boolean>("SSEShowRetryEvents")
@@ -40,6 +41,7 @@ public suspend fun HttpClient.serverSentEventsSession(
     val sessionDeferred = CompletableDeferred<ClientSSESession>()
     val statement = prepareRequest {
         block()
+        addAttribute(sseRequestAttr, true)
         addAttribute(reconnectionTimeAttr, reconnectionTime)
         addAttribute(showCommentEventsAttr, showCommentEvents)
         addAttribute(showRetryEventsAttr, showRetryEvents)

diff --git a/...client/ktor-client-tests/common/test/io/ktor/client/tests/plugins/ServerSentEventsTest.kt b/...client/ktor-client-tests/common/test/io/ktor/client/tests/plugins/ServerSentEventsTest.kt
@@ -9,6 +9,8 @@ import io.ktor.client.plugins.*
 import io.ktor.client.plugins.auth.*
 import io.ktor.client.plugins.auth.providers.*
 import io.ktor.client.plugins.sse.*
+import io.ktor.client.request.*
+import io.ktor.client.statement.*
 import io.ktor.client.tests.utils.*
 import io.ktor.http.*
 import io.ktor.sse.*
@@ -35,6 +37,20 @@ class ServerSentEventsTest : ClientLoader(timeoutSeconds = 120) {
         }
     }
 
+    @Test
+    fun normalRequestsWorkWithSSEInstalled() = clientTests {
+        config {
+            install(SSE)
+        }
+
+        test { client ->
+            val response = client.post("$TEST_SERVER/content/echo") {
+                setBody("Hello")
+            }
+            assertEquals("Hello", response.bodyAsText())
+        }
+    }
+
     @Test
     fun testSseSession() = clientTests {
         config {