Update to Ktor 1.2.0

q-litzler · q-litzler · commit 19ebec718a65 · 2019-05-15T10:09:42.000+02:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -40,6 +40,7 @@ kotlin {
                 api(Ktor("client-logging"))
                 api(Ktor("client-core"))
                 api(Ktor("client-json"))
+                api(Ktor("client-serialization"))
             }
         }
         val commonTest by getting {
@@ -55,6 +56,7 @@ kotlin {
                 api(Ktor("client-core-jvm"))
                 api(Ktor("client-json-jvm"))
                 api(Ktor("client-logging-jvm"))
+                api(Ktor("client-serialization-jvm"))
             }
         }
         val jvmTest by getting {
diff --git a/buildSrc/src/main/kotlin/Ktor.kt b/buildSrc/src/main/kotlin/Ktor.kt
@@ -2,5 +2,5 @@ object Ktor : Dependency {
 
     override val group = "io.ktor"
     override val artifact = "ktor"
-    override val version = "1.1.5"
+    override val version = "1.2.0"
 }
diff --git a/docs/ExceptionHandling.md b/docs/ExceptionHandling.md
@@ -15,7 +15,7 @@ However, an HTTP exception can occur. Handle it with a try / catch block.
 ```kotlin
 try {
     val response = index.search()
-} catch (exception: BadResponseStatusException) {
+} catch (exception: ResponseException) {
     when (exception.response.status) {
         HttpStatusCode.NotFound -> TODO()
         HttpStatusCode.BadRequest -> TODO()
@@ -30,7 +30,7 @@ Other kinds of exceptions can occur. Handle them appropriately.
 ```kotlin
 try {
     val response = index.search()
-} catch (exception: BadResponseStatusException) {
+} catch (exception: ResponseException) {
     TODO()
 } catch (exception: IOException) {
     TODO()
diff --git a/src/commonMain/kotlin/com/algolia/search/client/ClientAccount.kt b/src/commonMain/kotlin/com/algolia/search/client/ClientAccount.kt
@@ -2,7 +2,7 @@ package com.algolia.search.client
 
 import com.algolia.search.model.ApplicationID
 import com.algolia.search.model.task.Task
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 
 
@@ -23,7 +23,7 @@ public object ClientAccount {
         var hasThrown404 = false
         try {
             destination.getSettings()
-        } catch (exception: BadResponseStatusException) {
+        } catch (exception: ResponseException) {
             hasThrown404 = exception.response.status.value == HttpStatusCode.NotFound.value
             if (!hasThrown404) throw exception
         }
diff --git a/src/commonMain/kotlin/com/algolia/search/client/ClientSearch.kt b/src/commonMain/kotlin/com/algolia/search/client/ClientSearch.kt
@@ -27,7 +27,7 @@ import com.algolia.search.serialize.KeyType
 import com.algolia.search.serialize.RouteLogs
 import com.algolia.search.transport.RequestOptions
 import com.algolia.search.transport.Transport
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.client.features.logging.LogLevel
 import io.ktor.http.HttpMethod
 import io.ktor.http.HttpStatusCode
@@ -104,7 +104,7 @@ public class ClientSearch private constructor(
             while (true) {
                 try {
                     return getAPIKey(apiKey)
-                } catch (exception: BadResponseStatusException) {
+                } catch (exception: ResponseException) {
                     if (exception.response.status.value != HttpStatusCode.NotFound.value) throw exception
                 }
                 delay(1000L)
@@ -126,7 +126,7 @@ public class ClientSearch private constructor(
             while (true) {
                 try {
                     getAPIKey(apiKey)
-                } catch (exception: BadResponseStatusException) {
+                } catch (exception: ResponseException) {
                     if (exception.response.status.value == HttpStatusCode.NotFound.value) return true else throw exception
                 }
                 delay(1000L)
diff --git a/src/commonMain/kotlin/com/algolia/search/configuration/Extensions.kt b/src/commonMain/kotlin/com/algolia/search/configuration/Extensions.kt
@@ -5,4 +5,4 @@ import io.ktor.client.features.logging.LogLevel
 
 internal const val defaultWriteTimeout: Long = 30000L
 internal const val defaultReadTimeout: Long = 2000L
-internal val defaultLogLevel = LogLevel.INFO
+internal val defaultLogLevel = LogLevel.NONE
diff --git a/src/commonMain/kotlin/com/algolia/search/helper/ResponseException.kt b/src/commonMain/kotlin/com/algolia/search/helper/ResponseException.kt
@@ -1,13 +1,13 @@
 package com.algolia.search.helper
 
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.client.response.readBytes
 import kotlinx.io.core.String
 
 
 /**
- * Convenience method to convert [BadResponseStatusException.response] body bytes to a [String].
+ * Convenience method to convert [ResponseException.response] body bytes to a [String].
  */
-suspend fun BadResponseStatusException.readContent(): String {
+suspend fun ResponseException.readContent(): String {
     return String(response.readBytes())
 }
diff --git a/src/commonMain/kotlin/com/algolia/search/model/search/IgnorePlurals.kt b/src/commonMain/kotlin/com/algolia/search/model/search/IgnorePlurals.kt
@@ -1,7 +1,7 @@
 package com.algolia.search.model.search
 
-import com.algolia.search.serialize.JsonNonStrict
 import com.algolia.search.model.settings.Settings
+import com.algolia.search.serialize.JsonNonStrict
 import com.algolia.search.serialize.asJsonInput
 import kotlinx.serialization.*
 import kotlinx.serialization.internal.BooleanSerializer
diff --git a/src/commonMain/kotlin/com/algolia/search/model/search/RemoveStopWords.kt b/src/commonMain/kotlin/com/algolia/search/model/search/RemoveStopWords.kt
@@ -1,7 +1,7 @@
 package com.algolia.search.model.search
 
-import com.algolia.search.serialize.JsonNonStrict
 import com.algolia.search.model.settings.Settings
+import com.algolia.search.serialize.JsonNonStrict
 import com.algolia.search.serialize.asJsonInput
 import kotlinx.serialization.*
 import kotlinx.serialization.internal.BooleanSerializer
diff --git a/src/commonMain/kotlin/com/algolia/search/transport/Transport.kt b/src/commonMain/kotlin/com/algolia/search/transport/Transport.kt
@@ -3,7 +3,7 @@ package com.algolia.search.transport
 import com.algolia.search.configuration.CallType
 import com.algolia.search.configuration.Configuration
 import com.algolia.search.configuration.RetryableHost
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.client.request.HttpRequestBuilder
 import io.ktor.client.request.request
 import io.ktor.http.HttpMethod
@@ -75,7 +75,7 @@ internal class Transport(
                 mutex.withLock { host.hasTimedOut() }
             } catch (exception: IOException) {
                 mutex.withLock { host.hasFailed() }
-            } catch (exception: BadResponseStatusException) {
+            } catch (exception: ResponseException) {
                 val isRetryable = floor(exception.response.status.value / 100f) != 4f
 
                 if (isRetryable) mutex.withLock { host.hasFailed() } else throw exception
diff --git a/src/commonTest/kotlin/client/TestClient.kt b/src/commonTest/kotlin/client/TestClient.kt
@@ -7,8 +7,7 @@ import com.algolia.search.configuration.*
 import com.algolia.search.helper.toAPIKey
 import com.algolia.search.helper.toApplicationID
 import io.ktor.client.engine.mock.MockEngine
-import io.ktor.client.engine.mock.MockHttpResponse
-import io.ktor.http.HttpStatusCode
+import io.ktor.client.engine.mock.respondOk
 import shouldEqual
 import kotlin.test.Test
 
@@ -19,7 +18,7 @@ internal class TestClient {
     private val appID = "appID".toApplicationID()
     private val hosts = listOf(RetryableHost("host"))
 
-    private val engine = MockEngine { MockHttpResponse(call, HttpStatusCode.OK) }
+    private val engine = MockEngine { respondOk() }
     private val configurationSearch = ConfigurationSearch(appID, apiKey, engine = engine, hosts = hosts)
     private val configurationInsights = ConfigurationInsights(appID, apiKey, engine = engine, hosts = hosts)
     private val configurationAnalytics = ConfigurationAnalytics(appID, apiKey, engine = engine, hosts = hosts)
diff --git a/src/commonTest/kotlin/client/TestMockEngine.kt b/src/commonTest/kotlin/client/TestMockEngine.kt
@@ -8,7 +8,7 @@ import com.algolia.search.model.IndexName
 import com.algolia.search.model.response.ResponseSearch
 import com.algolia.search.serialize.JsonNoDefaults
 import io.ktor.client.engine.mock.MockEngine
-import io.ktor.client.engine.mock.MockHttpResponse
+import io.ktor.client.engine.mock.respond
 import io.ktor.http.ContentType
 import io.ktor.http.HttpStatusCode
 import io.ktor.http.headersOf
@@ -24,9 +24,8 @@ internal class TestMockEngine {
     private val appID = "appID".toApplicationID()
     private val responseSearch = ResponseSearch(hitsOrNull = listOf())
     private val engine = MockEngine {
-        MockHttpResponse(
-            call,
-            HttpStatusCode.OK,
+        respond(
+            status = HttpStatusCode.OK,
             headers = headersOf("Content-Type", listOf(ContentType.Application.Json.toString())),
             content = ByteReadChannel(JsonNoDefaults.stringify(ResponseSearch.serializer(), responseSearch))
         )
diff --git a/src/commonTest/kotlin/documentation/methods/synonym/DocCopySynonyms.kt b/src/commonTest/kotlin/documentation/methods/synonym/DocCopySynonyms.kt
@@ -2,7 +2,7 @@ package documentation.methods.synonym
 
 import documentation.index
 import documentation.indexName
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import runBlocking
 import shouldFailWith
 import kotlin.test.Ignore
@@ -19,7 +19,7 @@ internal class DocCopySynonyms {
 
     @Test
     fun snippet1() {
-        shouldFailWith<BadResponseStatusException> {
+        shouldFailWith<ResponseException> {
             runBlocking {
                 index.copySynonyms(indexName)
             }
diff --git a/src/commonTest/kotlin/documentation/reference/DocPhilosophy.kt b/src/commonTest/kotlin/documentation/reference/DocPhilosophy.kt
@@ -15,7 +15,7 @@ import com.algolia.search.serialize.Json
 import com.algolia.search.serialize.JsonNonStrict
 import documentation.client
 import documentation.index
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.coroutines.*
 import kotlinx.io.IOException
@@ -170,7 +170,7 @@ internal class DocPhilosophy {
         runBlocking {
             try {
                 val response = index.search()
-            } catch (exception: BadResponseStatusException) {
+            } catch (exception: ResponseException) {
                 when (exception.response.status) {
                     HttpStatusCode.NotFound -> TODO()
                     HttpStatusCode.BadRequest -> TODO()
@@ -184,7 +184,7 @@ internal class DocPhilosophy {
         runBlocking {
             try {
                 val response = index.search()
-            } catch (exception: BadResponseStatusException) {
+            } catch (exception: ResponseException) {
                 TODO()
             } catch (exception: IOException) {
                 TODO()
diff --git a/src/commonTest/kotlin/suite/TestSecuredAPIKey.kt b/src/commonTest/kotlin/suite/TestSecuredAPIKey.kt
@@ -7,7 +7,7 @@ import com.algolia.search.model.Time
 import com.algolia.search.model.apikey.SecuredAPIKeyRestriction
 import com.algolia.search.model.task.TaskStatus
 import com.algolia.search.serialize.KeyObjectID
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import kotlinx.serialization.json.json
 import runBlocking
 import shouldEqual
@@ -49,7 +49,7 @@ internal class TestSecuredAPIKey {
             }
             client.apply {
                 initIndex(indexName).search()
-                shouldFailWith<BadResponseStatusException> { initIndex(indexNameDev).search() }
+                shouldFailWith<ResponseException> { initIndex(indexNameDev).search() }
             }
         }
     }
diff --git a/src/commonTest/kotlin/suite/TestSuiteABTest.kt b/src/commonTest/kotlin/suite/TestSuiteABTest.kt
@@ -10,7 +10,7 @@ import com.algolia.search.model.analytics.Variant
 import com.algolia.search.model.task.TaskStatus
 import com.algolia.search.serialize.KeyObjectID
 import dayInMillis
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.json
 import runBlocking
@@ -67,7 +67,7 @@ internal class TestSuiteABTest {
                 clientAnalytics.getABTest(responseA.abTestID).status shouldEqual ABTestStatus.Stopped
                 clientAnalytics.deleteABTest(responseA.abTestID).wait() shouldEqual TaskStatus.Published
 
-                val responseB = shouldFailWith<BadResponseStatusException> {
+                val responseB = shouldFailWith<ResponseException> {
                     clientAnalytics.getABTest(responseA.abTestID)
                 }
 
diff --git a/src/commonTest/kotlin/suite/TestSuiteAPIKey.kt b/src/commonTest/kotlin/suite/TestSuiteAPIKey.kt
@@ -9,7 +9,7 @@ import com.algolia.search.model.search.Query
 import com.algolia.search.model.search.TypoTolerance
 import com.algolia.search.serialize.toJsonNoDefaults
 import com.algolia.search.serialize.urlEncode
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
@@ -63,7 +63,7 @@ internal class TestSuiteAPIKey {
                 while (isActive) {
                     try {
                         if (getAPIKey(key).maxHitsPerQuery == 42) break
-                    } catch (exception: BadResponseStatusException) {
+                    } catch (exception: ResponseException) {
                         exception.response.status.value shouldEqual HttpStatusCode.NotFound
                     }
                     delay(1000L)
diff --git a/src/commonTest/kotlin/suite/TestSuiteMultiCluster.kt b/src/commonTest/kotlin/suite/TestSuiteMultiCluster.kt
@@ -4,7 +4,7 @@ import DateFormat
 import clientMcm
 import com.algolia.search.helper.toUserID
 import com.algolia.search.model.multicluster.UserIDQuery
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.client.response.readBytes
 import io.ktor.http.HttpStatusCode
 import kotlinx.coroutines.delay
@@ -35,7 +35,7 @@ internal class TestSuiteMultiCluster {
                 try {
                     clientMcm.getUserID(userID)
                     break
-                } catch (exception: BadResponseStatusException) {
+                } catch (exception: ResponseException) {
                     exception.response.status shouldEqual HttpStatusCode.NotFound
                 }
                 delay(1000L)
@@ -47,7 +47,7 @@ internal class TestSuiteMultiCluster {
             loop@ while (isActive) {
                 try {
                     clientMcm.removeUserID(userID)
-                } catch (exception: BadResponseStatusException) {
+                } catch (exception: ResponseException) {
                     when (exception.response.status) {
                         HttpStatusCode.NotFound -> break@loop
                         HttpStatusCode.BadRequest -> println(String(exception.response.readBytes()))
@@ -57,7 +57,7 @@ internal class TestSuiteMultiCluster {
             while (isActive) {
                 try {
                     clientMcm.getUserID(userID)
-                } catch (exception: BadResponseStatusException) {
+                } catch (exception: ResponseException) {
                     exception.response.status.value shouldEqual HttpStatusCode.NotFound.value
                     break
                 }
diff --git a/src/commonTest/kotlin/suite/TestSuiteReplaceAll.kt b/src/commonTest/kotlin/suite/TestSuiteReplaceAll.kt
@@ -7,7 +7,7 @@ import com.algolia.search.model.synonym.Synonym
 import com.algolia.search.model.task.Task
 import com.algolia.search.model.task.TaskStatus
 import com.algolia.search.serialize.KeyObjectID
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.json
 import runBlocking
@@ -60,15 +60,15 @@ class TestSuiteReplaceAll {
                 getRule(objectIDTwo).objectID shouldEqual objectIDTwo
                 getSynonym(objectIDTwo).objectID shouldEqual objectIDTwo
 
-                (shouldFailWith<BadResponseStatusException> {
+                (shouldFailWith<ResponseException> {
                     getObject(objectIDOne)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value
 
-                (shouldFailWith<BadResponseStatusException> {
+                (shouldFailWith<ResponseException> {
                     getSynonym(objectIDOne)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value
 
-                (shouldFailWith<BadResponseStatusException> {
+                (shouldFailWith<ResponseException> {
                     getRule(objectIDOne)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value
             }
diff --git a/src/commonTest/kotlin/suite/TestSuiteRules.kt b/src/commonTest/kotlin/suite/TestSuiteRules.kt
@@ -7,7 +7,7 @@ import com.algolia.search.model.settings.AttributeForFaceting
 import com.algolia.search.model.settings.Settings
 import com.algolia.search.model.task.Task
 import com.algolia.search.model.task.TaskStatus
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.JsonObjectSerializer
 import kotlinx.serialization.list
@@ -57,7 +57,7 @@ internal class TestSuiteRules {
                 searches.find { it.objectID == rules.first().objectID }.shouldNotBeNull()
                 deleteRule(rule.objectID).wait() shouldEqual TaskStatus.Published
 
-                (shouldFailWith<BadResponseStatusException> {
+                (shouldFailWith<ResponseException> {
                     getRule(rule.objectID)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value
                 clearRules().wait() shouldEqual TaskStatus.Published
diff --git a/src/commonTest/kotlin/suite/TestSuiteSynonyms.kt b/src/commonTest/kotlin/suite/TestSuiteSynonyms.kt
@@ -7,7 +7,7 @@ import com.algolia.search.model.synonym.SynonymQuery
 import com.algolia.search.model.synonym.SynonymType
 import com.algolia.search.model.task.Task
 import com.algolia.search.model.task.TaskStatus
-import io.ktor.client.features.BadResponseStatusException
+import io.ktor.client.features.ResponseException
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.JsonObjectSerializer
 import kotlinx.serialization.list
@@ -76,7 +76,7 @@ internal class TestSuiteSynonyms {
                     synonyms shouldContain synonymAlternative2
                 }
                 deleteSynonym(gba).wait() shouldEqual TaskStatus.Published
-                (shouldFailWith<BadResponseStatusException> {
+                (shouldFailWith<ResponseException> {
                     getSynonym(gba)
                 }).response.status.value shouldEqual HttpStatusCode.NotFound.value
 

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ kotlin {`
`40`	`40`	`api(Ktor("client-logging"))`
`41`	`41`	`api(Ktor("client-core"))`
`42`	`42`	`api(Ktor("client-json"))`
	`43`	`+ api(Ktor("client-serialization"))`
`43`	`44`	`}`
`44`	`45`	`}`
`45`	`46`	`val commonTest by getting {`
`@@ -55,6 +56,7 @@ kotlin {`
`55`	`56`	`api(Ktor("client-core-jvm"))`
`56`	`57`	`api(Ktor("client-json-jvm"))`
`57`	`58`	`api(Ktor("client-logging-jvm"))`
	`59`	`+ api(Ktor("client-serialization-jvm"))`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`	`val jvmTest by getting {`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@ object Ktor : Dependency {`
`2`	`2`
`3`	`3`	`override val group = "io.ktor"`
`4`	`4`	`override val artifact = "ktor"`
`5`		`- override val version = "1.1.5"`
	`5`	`+ override val version = "1.2.0"`
`6`	`6`	`}`