[plugin] change httpclient from CIO to Apache for tasks (ExpediaGroup#1162)

It looks like using CIO engine causes some issues with the classpath (ExpediaGroup#1084). Unsure what is the root cause of the classpath issue - it looks like CIO engine relies on coroutines-core `native-mt` vs regular artifact that we pull in. Switching to a different engine seems to resolve the classpath issue.

Author: dariuszkuc

plugins/client/graphql-kotlin-client-generator/build.gradle.kts

@@ -2,6 +2,7 @@ description = "GraphQL Kotlin common utilities to generate a client."
 
 val compileTestingVersion: String by project
 val graphQLJavaVersion: String by project
+val jacksonVersion: String by project
 val junitVersion: String by project
 val kotlinPoetVersion: String by project
 val kotlinxSerializationVersion: String by project
@@ -15,8 +16,12 @@ dependencies {
     }
     api("com.squareup:kotlinpoet:$kotlinPoetVersion")
     api("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion")
-    implementation("io.ktor:ktor-client-cio:$ktorVersion")
-    implementation("io.ktor:ktor-client-jackson:$ktorVersion")
+    implementation("io.ktor:ktor-client-apache:$ktorVersion")
+    implementation("io.ktor:ktor-client-jackson:$ktorVersion") {
+        exclude("com.fasterxml.jackson.core", "jackson-databind")
+        exclude("com.fasterxml.jackson.module", "jackson-module-kotlin")
+    }
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:$jacksonVersion")
     testImplementation(project(path = ":graphql-kotlin-client-jackson"))
     testImplementation("com.github.tomakehurst:wiremock-jre8:$wireMockVersion")
     testImplementation("com.github.tschuchortdev:kotlin-compile-testing:$compileTestingVersion")

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/downloadSchema.kt

@@ -18,13 +18,14 @@ package com.expediagroup.graphql.plugin.client
 
 import graphql.schema.idl.SchemaParser
 import io.ktor.client.HttpClient
-import io.ktor.client.engine.cio.CIO
-import io.ktor.client.engine.cio.endpoint
+import io.ktor.client.engine.apache.Apache
 import io.ktor.client.features.ClientRequestException
+import io.ktor.client.features.HttpRequestTimeoutException
+import io.ktor.client.features.HttpTimeout
 import io.ktor.client.request.get
 import io.ktor.client.request.header
-import kotlinx.coroutines.TimeoutCancellationException
 import kotlinx.coroutines.runBlocking
+import java.net.UnknownHostException
 
 /**
  * Downloads GraphQL SDL from the specified endpoint and verifies whether the result is a valid GraphQL schema.
@@ -34,12 +35,10 @@ fun downloadSchema(
     httpHeaders: Map<String, Any> = emptyMap(),
     connectTimeout: Long = 5_000,
     readTimeout: Long = 15_000
-): String = HttpClient(engineFactory = CIO) {
-    engine {
-        this.requestTimeout = readTimeout
-        endpoint {
-            this.connectTimeout = connectTimeout
-        }
+): String = HttpClient(engineFactory = Apache) {
+    install(HttpTimeout) {
+        connectTimeoutMillis = connectTimeout
+        requestTimeoutMillis = readTimeout
     }
 }.use { client ->
     runBlocking {
@@ -51,7 +50,7 @@ fun downloadSchema(
             }
         } catch (e: Throwable) {
             when (e) {
-                is ClientRequestException, is TimeoutCancellationException -> throw e
+                is ClientRequestException, is HttpRequestTimeoutException, is UnknownHostException -> throw e
                 else -> throw RuntimeException("Unable to download SDL from specified endpoint=$endpoint", e)
             }
         }

plugins/client/graphql-kotlin-client-generator/src/main/kotlin/com/expediagroup/graphql/plugin/client/introspectSchema.kt

@@ -19,17 +19,18 @@ package com.expediagroup.graphql.plugin.client
 import graphql.introspection.IntrospectionResultToSchema
 import graphql.schema.idl.SchemaPrinter
 import io.ktor.client.HttpClient
-import io.ktor.client.engine.cio.CIO
-import io.ktor.client.engine.cio.endpoint
+import io.ktor.client.engine.apache.Apache
 import io.ktor.client.features.ClientRequestException
+import io.ktor.client.features.HttpRequestTimeoutException
+import io.ktor.client.features.HttpTimeout
 import io.ktor.client.features.json.JsonFeature
 import io.ktor.client.request.header
 import io.ktor.client.request.post
 import io.ktor.client.request.url
 import io.ktor.http.ContentType
 import io.ktor.http.contentType
-import kotlinx.coroutines.TimeoutCancellationException
 import kotlinx.coroutines.runBlocking
+import java.net.UnknownHostException
 
 private const val INTROSPECTION_QUERY =
     """
@@ -131,12 +132,10 @@ fun introspectSchema(
     httpHeaders: Map<String, Any> = emptyMap(),
     connectTimeout: Long = 5_000,
     readTimeout: Long = 15_000
-): String = HttpClient(engineFactory = CIO) {
-    engine {
-        requestTimeout = readTimeout
-        endpoint {
-            this.connectTimeout = connectTimeout
-        }
+): String = HttpClient(engineFactory = Apache) {
+    install(HttpTimeout) {
+        connectTimeoutMillis = connectTimeout
+        requestTimeoutMillis = readTimeout
     }
     install(feature = JsonFeature)
 }.use { client ->
@@ -155,7 +154,7 @@ fun introspectSchema(
             }
         } catch (e: Throwable) {
             when (e) {
-                is ClientRequestException, is TimeoutCancellationException -> throw e
+                is ClientRequestException, is HttpRequestTimeoutException, is UnknownHostException -> throw e
                 else -> throw RuntimeException("Unable to run introspection query against the specified endpoint=$endpoint", e)
             }
         }

plugins/client/graphql-kotlin-client-generator/src/test/kotlin/com/expediagroup/graphql/plugin/client/DownloadSchemaTest.kt

@@ -24,15 +24,15 @@ import com.github.tomakehurst.wiremock.client.WireMock.stubFor
 import com.github.tomakehurst.wiremock.core.WireMockConfiguration
 import graphql.schema.idl.errors.SchemaProblem
 import io.ktor.client.features.ClientRequestException
+import io.ktor.client.features.HttpRequestTimeoutException
 import io.ktor.util.KtorExperimentalAPI
-import kotlinx.coroutines.TimeoutCancellationException
 import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
-import java.nio.channels.UnresolvedAddressException
+import java.net.UnknownHostException
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
@@ -97,12 +97,11 @@ class DownloadSchemaTest {
     @Test
     @KtorExperimentalAPI
     fun `verify downloadSchema will throw exception if URL is not valid`() {
-        val exception = assertThrows<RuntimeException> {
+        assertThrows<UnknownHostException> {
             runBlocking {
                 downloadSchema("https://non-existent-graphql-url.com/should_404")
             }
         }
-        assertTrue(exception.cause is UnresolvedAddressException)
     }
 
     @Test
@@ -147,7 +146,7 @@ class DownloadSchemaTest {
                     .withFixedDelay(1_000)
             )
         )
-        assertThrows<TimeoutCancellationException> {
+        assertThrows<HttpRequestTimeoutException> {
             runBlocking {
                 downloadSchema(endpoint = "${wireMockServer.baseUrl()}/sdl", connectTimeout = 100, readTimeout = 100)
             }

plugins/client/graphql-kotlin-client-generator/src/test/kotlin/com/expediagroup/graphql/plugin/client/IntrospectSchemaTest.kt

@@ -20,15 +20,16 @@ import com.github.tomakehurst.wiremock.WireMockServer
 import com.github.tomakehurst.wiremock.client.WireMock
 import com.github.tomakehurst.wiremock.core.WireMockConfiguration
 import io.ktor.client.features.ClientRequestException
+import io.ktor.client.features.HttpRequestTimeoutException
 import io.ktor.util.KtorExperimentalAPI
-import kotlinx.coroutines.TimeoutCancellationException
 import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
 import java.io.BufferedReader
+import java.net.UnknownHostException
 import kotlin.test.assertEquals
 
 class IntrospectSchemaTest {
@@ -129,13 +130,23 @@ class IntrospectSchemaTest {
                         .withFixedDelay(1_000)
                 )
         )
-        assertThrows<TimeoutCancellationException> {
+        assertThrows<HttpRequestTimeoutException> {
             runBlocking {
                 introspectSchema(endpoint = "${wireMockServer.baseUrl()}/graphql", connectTimeout = 100, readTimeout = 100)
             }
         }
     }
 
+    @Test
+    @KtorExperimentalAPI
+    fun `verify introspectSchema will throw exception if URL is not valid`() {
+        assertThrows<UnknownHostException> {
+            runBlocking {
+                downloadSchema("https://non-existent-graphql-url.com/should_404")
+            }
+        }
+    }
+
     companion object {
         private val wireMockServer: WireMockServer = WireMockServer(WireMockConfiguration.wireMockConfig().dynamicPort())
 

plugins/graphql-kotlin-gradle-plugin/src/test/kotlin/com/expediagroup/graphql/plugin/gradle/tasks/GraphQLDownloadSDLTaskIT.kt

@@ -154,7 +154,8 @@ class GraphQLDownloadSDLTaskIT : GraphQLGradlePluginAbstractIT() {
             .withArguments(DOWNLOAD_SDL_TASK_NAME, "--stacktrace")
             .buildAndFail()
 
+        println(result.output)
         assertEquals(TaskOutcome.FAILED, result.task(":$DOWNLOAD_SDL_TASK_NAME")?.outcome)
-        assertTrue(result.output.contains("Timed out waiting for 100 ms", ignoreCase = true))
+        assertTrue(result.output.contains("Request timeout has been expired", ignoreCase = true))
     }
 }

plugins/graphql-kotlin-gradle-plugin/src/test/kotlin/com/expediagroup/graphql/plugin/gradle/tasks/GraphQLIntrospectSchemaTaskIT.kt

@@ -152,6 +152,6 @@ class GraphQLIntrospectSchemaTaskIT : GraphQLGradlePluginAbstractIT() {
             .buildAndFail()
 
         assertEquals(TaskOutcome.FAILED, result.task(":$INTROSPECT_SCHEMA_TASK_NAME")?.outcome)
-        assertTrue(result.output.contains("Timed out waiting for 100 ms", ignoreCase = true))
+        assertTrue(result.output.contains("Request timeout has been expired", ignoreCase = true))
     }
 }