Add ThrottleIntegrationTest

Author: Sven Obser

gradle/libs.versions.toml

@@ -1,7 +1,7 @@
 [versions]
 kotlin = "2.2.20"
-
 ktor = "3.3.1"
+
 dokka = "2.1.0"
 kover = "0.9.2"
 ktlint = "13.1.0"
@@ -10,6 +10,11 @@ researchgate-release = "3.1.0"
 
 [libraries]
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
+ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
+ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "ktor" }
+ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" }
+ktor-server-cio = { module = "io.ktor:ktor-server-cio", version.ref = "ktor" }
+ktor-server-rate-limit = { module = "io.ktor:ktor-server-rate-limit", version.ref = "ktor" }
 
 [plugins]
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }

library/build.gradle.kts

@@ -41,6 +41,11 @@ kotlin {
 
         commonTest.dependencies {
             implementation(kotlin("test"))
+            implementation(libs.ktor.client.cio)
+            implementation(libs.ktor.client.logging)
+            implementation(libs.ktor.server.core)
+            implementation(libs.ktor.server.cio)
+            implementation(libs.ktor.server.rate.limit)
         }
     }
 }

library/src/jvmTest/kotlin/throttle/ThrottleIntegrationTest.kt

@@ -0,0 +1,112 @@
+package throttle
+
+import de.brudaswen.ktor.client.throttle.HttpRequestThrottle
+import io.ktor.client.HttpClient
+import io.ktor.client.engine.cio.CIO
+import io.ktor.client.plugins.logging.LogLevel
+import io.ktor.client.plugins.logging.Logger
+import io.ktor.client.plugins.logging.Logging
+import io.ktor.client.plugins.logging.SIMPLE
+import io.ktor.client.request.get
+import io.ktor.client.request.parameter
+import io.ktor.server.application.install
+import io.ktor.server.engine.embeddedServer
+import io.ktor.server.plugins.ratelimit.RateLimit
+import io.ktor.server.response.respondText
+import io.ktor.server.routing.get
+import io.ktor.server.routing.routing
+import kotlinx.coroutines.runBlocking
+import kotlin.test.Test
+import kotlin.time.Duration.Companion.seconds
+import kotlin.time.measureTimedValue
+import io.ktor.server.cio.CIO as ServerCIO
+
+internal class ThrottleIntegrationTest {
+
+    private val server = embeddedServer(ServerCIO, port = 8080) {
+        install(RateLimit) {
+            global {
+                rateLimiter(
+                    limit = 5,
+                    refillPeriod = 2.seconds,
+                )
+            }
+        }
+
+        routing {
+            get("/") {
+                call.respondText("Hello, world!")
+            }
+        }
+    }
+
+    @Test
+    fun `client should not fail if refillPeriod is large enough`() = runBlocking {
+        server.startSuspend()
+
+        val client = HttpClient(CIO) {
+            expectSuccess = true
+
+            install(HttpRequestThrottle) {
+                throttler(
+                    limit = 5,
+                    refillPeriod = 3.seconds,
+                    retry = false,
+                )
+            }
+
+            install(Logging) {
+                logger = Logger.SIMPLE
+                level = LogLevel.HEADERS
+            }
+        }
+        val stats = List(10) { it }.map { id ->
+            measureTimedValue {
+                client.get("http://localhost:8080/") {
+                    parameter("id", id)
+                }.status
+            }.let { (status, duration) ->
+                "Request $id took $duration: $status"
+            }
+        }
+
+        println(stats.joinToString("\n"))
+
+        server.stopSuspend()
+    }
+
+    @Test
+    fun `client should retry failed 429 requests`() = runBlocking {
+        server.startSuspend()
+
+        val client = HttpClient(CIO) {
+            expectSuccess = true
+
+            install(HttpRequestThrottle) {
+                throttler(
+                    limit = 5,
+                    refillPeriod = 2.seconds,
+                    retry = true,
+                )
+            }
+
+            install(Logging) {
+                logger = Logger.SIMPLE
+                level = LogLevel.HEADERS
+            }
+        }
+        val stats = List(10) { it }.map { id ->
+            measureTimedValue {
+                client.get("http://localhost:8080/") {
+                    parameter("id", id)
+                }.status
+            }.let { (status, duration) ->
+                "Request $id took $duration: $status"
+            }
+        }
+
+        println(stats.joinToString("\n"))
+
+        server.stopSuspend()
+    }
+}