Deprecate apollo engine ktor and publish engine tests (#5988)

* Deprecate apollo-engine-ktor and publish engine tests

* add apiDump

* fix indentation

* fix build

Author: martinbonnin

libraries/apollo-engine-ktor/src/commonMain/kotlin/com/apollographql/apollo3/network/KtorExtensions.kt

@@ -1,6 +1,7 @@
 package com.apollographql.apollo3.network
 
 import com.apollographql.apollo3.ApolloClient
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import com.apollographql.apollo3.annotations.ApolloExperimental
 import com.apollographql.apollo3.network.http.KtorHttpEngine
 import com.apollographql.apollo3.network.ws.KtorWebSocketEngine
@@ -13,6 +14,8 @@ import io.ktor.client.HttpClient
  * See also [ApolloClient.Builder.httpEngine] and [ApolloClient.Builder.webSocketEngine]
  */
 @ApolloExperimental
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
+@Deprecated("apollo-engine-ktor has moved to 'com.apollographql.ktor:apollo-engine-ktor'")
 fun ApolloClient.Builder.ktorClient(httpClient: HttpClient) = apply {
   httpEngine(KtorHttpEngine(httpClient))
   webSocketEngine(KtorWebSocketEngine(httpClient))

libraries/apollo-engine-ktor/src/commonMain/kotlin/com/apollographql/apollo3/network/adapter/KtorHttpUrlAdapter.kt

@@ -1,5 +1,6 @@
 package com.apollographql.apollo3.network.adapter
 
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import com.apollographql.apollo3.api.Adapter
 import com.apollographql.apollo3.api.CustomScalarAdapters
 import com.apollographql.apollo3.api.json.JsonReader
@@ -9,6 +10,8 @@ import io.ktor.http.Url
 /**
  * An [Adapter] that converts to/from [io.ktor.http.Url]
  */
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
+@Deprecated("apollo-engine-ktor has moved to 'com.apollographql.ktor:apollo-engine-ktor'")
 object KtorHttpUrlAdapter: Adapter<Url> {
   override fun fromJson(reader: JsonReader, customScalarAdapters: CustomScalarAdapters): Url {
     return Url(reader.nextString()!!)

libraries/apollo-engine-ktor/src/commonMain/kotlin/com/apollographql/apollo3/network/http/KtorHttpEngine.kt

@@ -1,5 +1,6 @@
 package com.apollographql.apollo3.network.http
 
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import com.apollographql.apollo3.annotations.ApolloExperimental
 import com.apollographql.apollo3.annotations.ApolloInternal
 import com.apollographql.apollo3.api.http.HttpHeader
@@ -19,6 +20,8 @@ import okio.Buffer
 import kotlin.coroutines.cancellation.CancellationException
 
 @ApolloExperimental
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
+@Deprecated("apollo-engine-ktor has moved to 'com.apollographql.ktor:apollo-engine-ktor'")
 class KtorHttpEngine(
     private val client: HttpClient,
 ): HttpEngine {

libraries/apollo-engine-ktor/src/commonMain/kotlin/com/apollographql/apollo3/network/ws/KtorWebSocketEngine.kt

@@ -1,5 +1,6 @@
 package com.apollographql.apollo3.network.ws
 
+import com.apollographql.apollo3.annotations.ApolloDeprecatedSince
 import com.apollographql.apollo3.annotations.ApolloExperimental
 import com.apollographql.apollo3.api.http.HttpHeader
 import com.apollographql.apollo3.exception.ApolloNetworkException
@@ -27,6 +28,8 @@ import kotlinx.coroutines.launch
 import okio.ByteString
 
 @ApolloExperimental
+@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_0_0)
+@Deprecated("apollo-engine-ktor has moved to 'com.apollographql.ktor:apollo-engine-ktor'")
 class KtorWebSocketEngine(
     private val client: HttpClient,
 ) : WebSocketEngine {

libraries/apollo-engine-tests/README.md

@@ -0,0 +1,9 @@
+# Module apollo-engine-tests
+
+apollo-engine-tests contains a list of tests for implementations of `HttpEngine` and `WebSocketEngine`.
+
+This should ideally be apollo-runtime test fixtures.
+
+See https://youtrack.jetbrains.com/issue/KT-46899/Dynamic-test-API
+See https://youtrack.jetbrains.com/issue/KT-63142
+

libraries/apollo-engine-tests/api/apollo-engine-tests.api

@@ -0,0 +1,24 @@
+public final class com/apollographql/apollo3/engine/tests/All_testsKt {
+	public static final fun runAllTests (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function0;ZLkotlin/coroutines/Continuation;)Ljava/lang/Object;
+}
+
+public final class com/apollographql/apollo3/engine/tests/GzipTestKt {
+	public static final fun gzipTest (Lcom/apollographql/apollo3/network/http/HttpEngine;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+}
+
+public final class com/apollographql/apollo3/engine/tests/HttpEngineTestKt {
+	public static final fun connectTimeout (Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun errorWithBody (Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun headers (Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun post (Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun readTimeout (Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+}
+
+public final class com/apollographql/apollo3/engine/tests/WebSocketEngineTestKt {
+	public static final fun binaryFrames (Lkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun headers (Lkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun serverCloseAbruptly (Lkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun serverCloseNicely (Lkotlin/jvm/functions/Function0;ZLkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static final fun textFrames (Lkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+}
+

libraries/apollo-engine-tests/api/apollo-engine-tests.klib.api

@@ -0,0 +1,20 @@
+// Klib ABI Dump
+// Targets: [iosArm64, iosSimulatorArm64, iosX64, js, macosArm64, macosX64, tvosArm64, tvosSimulatorArm64, tvosX64, wasmJs, watchosArm32, watchosArm64, watchosSimulatorArm64]
+// Rendering settings:
+// - Signature version: 2
+// - Show manifest properties: true
+// - Show declarations: true
+
+// Library unique name: <com.apollographql.apollo3:apollo-engine-tests>
+final suspend fun com.apollographql.apollo3.engine.tests/binaryFrames(kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>) // com.apollographql.apollo3.engine.tests/binaryFrames|binaryFrames(kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/connectTimeout(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>): com.apollographql.apollo3.exception/ApolloException // com.apollographql.apollo3.engine.tests/connectTimeout|connectTimeout(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/errorWithBody(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>) // com.apollographql.apollo3.engine.tests/errorWithBody|errorWithBody(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/gzipTest(com.apollographql.apollo3.network.http/HttpEngine) // com.apollographql.apollo3.engine.tests/gzipTest|gzipTest(com.apollographql.apollo3.network.http.HttpEngine){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/headers(kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>) // com.apollographql.apollo3.engine.tests/headers|headers(kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/headers(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>) // com.apollographql.apollo3.engine.tests/headers|headers(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/post(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>) // com.apollographql.apollo3.engine.tests/post|post(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/readTimeout(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>): com.apollographql.apollo3.exception/ApolloException // com.apollographql.apollo3.engine.tests/readTimeout|readTimeout(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/runAllTests(kotlin/Function1<kotlin/Long, com.apollographql.apollo3.network.http/HttpEngine>, kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>, kotlin/Boolean) // com.apollographql.apollo3.engine.tests/runAllTests|runAllTests(kotlin.Function1<kotlin.Long,com.apollographql.apollo3.network.http.HttpEngine>;kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>;kotlin.Boolean){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/serverCloseAbruptly(kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>) // com.apollographql.apollo3.engine.tests/serverCloseAbruptly|serverCloseAbruptly(kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/serverCloseNicely(kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>, kotlin/Boolean) // com.apollographql.apollo3.engine.tests/serverCloseNicely|serverCloseNicely(kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>;kotlin.Boolean){}[0]
+final suspend fun com.apollographql.apollo3.engine.tests/textFrames(kotlin/Function0<com.apollographql.apollo3.network.ws/WebSocketEngine>) // com.apollographql.apollo3.engine.tests/textFrames|textFrames(kotlin.Function0<com.apollographql.apollo3.network.ws.WebSocketEngine>){}[0]

libraries/apollo-engine-tests/build.gradle.kts

@@ -0,0 +1,30 @@
+plugins {
+  id("org.jetbrains.kotlin.multiplatform")
+}
+
+apolloLibrary(
+    namespace = "com.apollographql.apollo3.engine.tests",
+    withLinux = false,
+)
+
+kotlin {
+  sourceSets {
+    findByName("commonMain")?.apply {
+      dependencies {
+        api(project(":apollo-runtime"))
+        implementation(libs.kotlin.test)
+        implementation(libs.apollo.mockserver)
+      }
+    }
+    findByName("commonTest")?.apply {
+      dependencies {
+        implementation(project(":apollo-testing-support"))
+      }
+    }
+    findByName("jvmTest")?.apply {
+      dependencies {
+        implementation(libs.kotlin.test.junit)
+      }
+    }
+  }
+}

libraries/apollo-engine-tests/gradle.properties

@@ -0,0 +1,2 @@
+POM_NAME=Apollo Engine Tests
+POM_DESCRIPTION=Tests for Apollo engines

libraries/apollo-engine-tests/src/appleMain/kotlin/com/apollographql/apollo3/engine/tests/WebSocketEngineTest.apple.kt

@@ -0,0 +1,5 @@
+package com.apollographql.apollo3.engine.tests
+
+internal actual fun platform(): Platform {
+  return Platform.Native
+}