Changelog 1.4 version

I've received the following exception report for an Android app.
It was sporadic and I cannot reproduce the problem. The problem seems to lie within Ktor itself so I'll simply share what I can.

FATAL EXCEPTION: k.a0 Dispatcher = okhttp3.OkHttpClient Dispatcher
java.lang.NullPointerException
	at h.b.a.g.j.b$a.l(Unknown Source:58) = io.ktor.client.request.forms.FormDataContentKt$copyTo$2.invokeSuspend(java.lang.Object)
	at kotlin.c0.k.a.a.n(Unknown Source:9) = kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(java.lang.Object)
	at kotlinx.coroutines.a1.run(Unknown Source:93)
	at kotlinx.coroutines.d3.b.b0(Unknown Source:0)
	at kotlinx.coroutines.d3.b$a.c(Unknown Source:14)
	at kotlinx.coroutines.d3.b$a.m(Unknown Source:28)
	at kotlinx.coroutines.d3.b$a.run(Unknown Source:0)

This is the relevant mapping:

io.ktor.client.request.forms.FormDataContentKt$copyTo$2 -> h.b.a.g.j.b$a:
    io.ktor.utils.io.WriterSuspendSession p$ -> p
    java.lang.Object L$0 -> q
    io.ktor.utils.io.core.Input $this_copyTo -> s
    int label -> r
    java.lang.Object invoke(java.lang.Object,java.lang.Object) -> M
    kotlin.coroutines.Continuation create(java.lang.Object,kotlin.coroutines.Continuation) -> d
    java.lang.Object invokeSuspend(java.lang.Object) -> l

The relevant code from Ktor:
https://github.com/ktorio/ktor/blob/a6d68420ee0b272cd09d235057427a6601736487/ktor-client/ktor-client-core/common/src/io/ktor/client/request/forms/FormDataContent.kt#L154

private suspend fun Input.copyTo(channel: ByteWriteChannel) {
    if (this is ByteReadPacket) {
        channel.writePacket(this)
        return
    }

    channel.writeSuspendSession {
        while (!this@copyTo.endOfInput) {
            tryAwait(1)
            val buffer = request(1)!!                                   // <-- likely cause
            val size = this@copyTo.readAvailable(buffer)

            if (size < 0) continue
            written(size)
        }
    }
}

In the CIO client engine exceptions like SocketTimeoutException are logged to standard error by the coroutines' uncaught exception handler and thrown by client.get().

import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.features.*
import io.ktor.client.request.*
import io.ktor.client.statement.*
import kotlinx.coroutines.*

suspend fun main(): Unit = withContext(Dispatchers.Default) {
    HttpClient(CIO) {
        install(HttpTimeout) {
            socketTimeoutMillis = 5
        }
    }.use { client ->
        try {
            client.get<HttpResponse>("http://www.google.com").readText()
        } catch (e: Throwable) {
            println("Caught: $e")
        }
    }
}

Output:

Exception in thread "kotlinx.coroutines.DefaultExecutor" java.net.SocketTimeoutException
	at io.ktor.network.util.UtilsKt$withSocketTimeout$2.invokeSuspend(Utils.kt:23)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
	at kotlinx.coroutines.internal.ScopeCoroutine.afterResume(Scopes.kt:32)
	at kotlinx.coroutines.AbstractCoroutine.resumeWith(AbstractCoroutine.kt:113)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46)
	at kotlinx.coroutines.DispatchedContinuation.resumeWith(DispatchedContinuation.kt:188)
	at kotlinx.coroutines.DispatchedTaskKt.resume(DispatchedTask.kt:122)
	at kotlinx.coroutines.DispatchedTaskKt.dispatch(DispatchedTask.kt:111)
	at kotlinx.coroutines.CancellableContinuationImpl.dispatchResume(CancellableContinuationImpl.kt:308)
	at kotlinx.coroutines.CancellableContinuationImpl.cancel(CancellableContinuationImpl.kt:177)
	at kotlinx.coroutines.CancellableContinuationImpl.parentCancelled$kotlinx_coroutines_core(CancellableContinuationImpl.kt:184)
	at kotlinx.coroutines.ChildContinuation.invoke(JobSupport.kt:1484)
	at kotlinx.coroutines.JobSupport.notifyCancelling(JobSupport.kt:1511)
	at kotlinx.coroutines.JobSupport.tryMakeCancelling(JobSupport.kt:792)
	at kotlinx.coroutines.JobSupport.makeCancelling(JobSupport.kt:752)
	at kotlinx.coroutines.JobSupport.cancelImpl$kotlinx_coroutines_core(JobSupport.kt:668)
	at kotlinx.coroutines.JobSupport.cancelCoroutine(JobSupport.kt:655)
	at kotlinx.coroutines.TimeoutCoroutine.run(Timeout.kt:128)
	at kotlinx.coroutines.EventLoopImplBase$DelayedRunnableTask.run(EventLoop.common.kt:497)
	at kotlinx.coroutines.EventLoopImplBase.processNextEvent(EventLoop.common.kt:274)
	at kotlinx.coroutines.DefaultExecutor.run(DefaultExecutor.kt:68)
	at java.base/java.lang.Thread.run(Thread.java:832)

Caught: io.ktor.network.sockets.SocketTimeoutException: Socket timeout has been expired [url=http://www.google.com/, socket_timeout=5] ms

Currently HttpRedirect feature alters Location header value by escaping query parameters, but it's significant in case of signed URLs verifications.

val httpClient = HttpClient(Apache) {
    followRedirects = true
}
val response = httpClient.get<HttpResponse>("https://dl.bintray.com/jetbrains/markdown/org/jetbrains/markdown-jvm/0.2.0.pre-61/markdown-jvm-0.2.0.pre-61.jar")
assertTrue(response.status.isSuccess())

The original response contains Location like that:

https://akamai.bintray.com/22/225b067044aa56f36590ef56d41e256cd1d0887b176bfdeec123ecccc6057790?__gda__=exp=1604350711~hmac=417cbd5a97b4c499e2cf7e9eae5dfb9ad95b42cb3ff76c5fb0fae70e2a42db9c&...

But Ktor executes URL encode for query parameters and uses the following value:

https://akamai.bintray.com/22/225b067044aa56f36590ef56d41e256cd1d0887b176bfdeec123ecccc6057790?__gda__=exp%3D1604350711~hmac%3D417cbd5a97b4c499e2cf7e9eae5dfb9ad95b42cb3ff76c5fb0fae70e2a42db9c&...

Ktor Version and Engine Used (client or server and name)

Client CIO, 1.4.1

Describe the bug

HttpClient with CIO Engine sometimes sends an invalid multipart/form-data request when it includes large size binary data.
When it comes to invalid requests, it does not seem to contain a trailing multipart/form-data request boundary.
(There doesn't seem to be enough content in the request body.)

java.nio.BufferOverflowException seems to occur in the following process.
https://github.com/ktorio/ktor/blob/master/ktor-client/ktor-client-core/common/src/io/ktor/client/request/forms/FormDataContent.kt#L123

This behavior is not reproduced in the case of HttpClient with Apache Engine.

To Reproduce

Sample code is below.

@KtorExperimentalAPI
@Suppress("unused") // Referenced in application.conf
@kotlin.jvm.JvmOverloads
fun Application.module(testing: Boolean = false) {
    routing {
        post("/multipart") {
            val multipartData = call.receiveMultipart()
            multipartData.forEachPart {
                if (it is PartData.FileItem) {
                    println(
                        withContext(Dispatchers.IO) {
                            it.streamProvider().readAllBytes().size
                        }
                    )
                }
            }
            call.respondText("test")
        }
        get("/execute/cio") {
            repeat(10) {
                request(HttpClient(CIO))
            }
            call.respondText("success")
        }
        get("/execute/apache") {
            repeat(10) {
                request(HttpClient(Apache))
            }
            call.respondText("success")
        }
    }
}

suspend fun request(client: HttpClient) {
    val body = formData {
        val headers = headersOf(
            HttpHeaders.ContentDisposition,
            ContentDisposition.File
                .withParameter(ContentDisposition.Parameters.Name, "file")
                .withParameter(ContentDisposition.Parameters.FileName, "test.jpg")
                .toString()
        )
        appendInput("file", headers) {
            // dummy 10MB binary file
            ByteArray(10_000_000).inputStream().asInput()
        }
    }
    client.use {
        it.submitFormWithBinaryData<Unit>(
            url = "http://localhost:8080/multipart",
            formData = body
        )
    }
}

(full code is in https://github.com/ma2Cta/ktor-multipart-request-test/blob/main/src/Application.kt )

1. Start the server.

2. Run $ curl http://localhost:8080/execute/apache a few times.

10 times 10000000 will be printed as expected.

3. Run $ curl http://localhost:8080/execute/cio a few times.

You won't get 10000000 10 times, and you'll probably get a number less than 10000000 the first few times

Expected

The correct request is sent even in the case of CIO Engine.

While using Ktor client, with timeout feature, the following instruction can throw a java.net.SocketTimeoutException instead of the expected ConnectTimeoutException. The stack trace is in the attachments.

PS: The exceptions section in the Timeout feature documentation is outdated.

Creating a simple HttpClient with the Logging feature included fails with the attached stack trace. The failure occurs both for real web calls in-app, as well as for a unit test using MockEngine. Both the test and the in-app call succeed if the logging configuration is removed.

I have a simple reproducer project attached, and also available at https://github.com/russhwolf/Ktor14

Note that my test configuration is using version 1.3.9-native-mt of kotlinx.coroutines, because version 1.3.9 leads to KTOR-915 / KTOR-919

kotlinx.coroutines.CoroutinesInternalError: Fatal exception in coroutines machinery for DispatchedContinuation[EventLoopImpl@36817bc8, Continuation @ $split$lambda-0$<anonymous>_3COROUTINE$2]. Please read KDoc to 'handleFatalException' method and report this incident to maintainers
	at kotlin.Error#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Exceptions.kt:14)
	at kotlinx.coroutines.CoroutinesInternalError#<init>(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Exceptions.common.kt:28)
	at kotlinx.coroutines.DispatchedTask#handleFatalException(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/internal/DispatchedTask.kt:93)
	at kotlinx.coroutines.DispatchedTask#run(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/internal/DispatchedTask.kt:64)
	at kotlinx.coroutines.EventLoopImplBase#processNextEvent(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/EventLoop.common.kt:274)
	at kotlinx.coroutines#runEventLoop(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:80)
	at kotlinx.coroutines.BlockingCoroutine.joinBlocking#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:67)
	at kotlinx.coroutines#runBlocking(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:50)
	at com.example#runBlocking(/Users/russell/IdeaProjects/Ktor14/shared/src/iosTest/kotlin/runBlocking.kt:8)
	at com.example#runBlocking$default(/Users/russell/IdeaProjects/Ktor14/shared/src/iosTest/kotlin/runBlocking.kt:7)
	at com.example.ApiClientTest#mockWebCall(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:20)
	at com.example.$ApiClientTest$test$0.$mockWebCall$FUNCTION_REFERENCE$0.invoke#internal(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:19)
	at com.example.$ApiClientTest$test$0.$mockWebCall$FUNCTION_REFERENCE$0.$<bridge-UNNN>invoke(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:19)
	at kotlin.native.internal.test.BaseClassSuite.TestCase#run(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestSuite.kt:85)
	at kotlin.native.internal.test.TestRunner.run#internal(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:236)
	at kotlin.native.internal.test.TestRunner.runIteration#internal(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:258)
	at kotlin.native.internal.test.TestRunner#run(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:273)
	at kotlin.native.internal.test#testLauncherEntryPoint(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:22)
	at kotlin.native.internal.test#main(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:26)
	at <global>.Konan_start(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:25)
	at <global>.Init_and_run_start(Unknown Source)
	at <global>.start(Unknown Source)
	at kotlin.Exception#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Exceptions.kt:25)
	at kotlin.RuntimeException#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Exceptions.kt:36)
	at kotlinx.coroutines.CompletionHandlerException#<init>(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Exceptions.common.kt:13)
	at kotlinx.coroutines.JobSupport.notifyCompletion#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:365)
	at kotlinx.coroutines.JobSupport.completeStateFinalization#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:326)
	at kotlinx.coroutines.JobSupport.finalizeFinishingState#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:241)
	at kotlinx.coroutines.JobSupport.tryMakeCompletingSlowPath#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:922)
	at kotlinx.coroutines.JobSupport.tryMakeCompleting#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:875)
	at kotlinx.coroutines.JobSupport#makeCompletingOnce(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/JobSupport.kt:840)
	at kotlinx.coroutines.AbstractCoroutine#resumeWith(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/AbstractCoroutine.kt:111)
	at kotlin.coroutines.native.internal.BaseContinuationImpl#resumeWith(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/coroutines/ContinuationImpl.kt:43)
	at kotlinx.coroutines.DispatchedTask#run(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/internal/DispatchedTask.kt:53)
	at kotlinx.coroutines.EventLoopImplBase#processNextEvent(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/EventLoop.common.kt:274)
	at kotlin.Throwable#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Throwable.kt:23)
	at kotlin.Exception#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Exceptions.kt:23)
	at kotlin.RuntimeException#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/Exceptions.kt:34)
	at kotlin.native.concurrent.InvalidMutabilityException#<init>(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/concurrent/Freezing.kt:22)
	at <global>.ThrowInvalidMutabilityException(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/concurrent/Internal.kt:92)
	at <global>.MutationCheck(Unknown Source)
	at kotlinx.coroutines.AwaitAll.AwaitAllNode.<set-handle>#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Await.kt:94)
	at kotlinx.coroutines.AwaitAll.await#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Await.kt:68)
	at kotlinx.coroutines.$awaitAllCOROUTINE$1#invokeSuspend(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Await.kt:38)
	at kotlinx.coroutines#awaitAll@kotlin.collections.Collection<kotlinx.coroutines.Deferred<0:0>>(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/Await.kt:37)
	at io.ktor.util.$split$lambda-0COROUTINE$3.invokeSuspend#internal(/opt/buildAgent/work/a85294440dc5c6e/ktor-utils/common/src/io/ktor/util/ByteChannels.kt:29)
	at kotlin.coroutines.native.internal.BaseContinuationImpl#resumeWith(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/coroutines/ContinuationImpl.kt:30)
	at kotlinx.coroutines.DispatchedTask#run(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/internal/DispatchedTask.kt:39)
	at kotlinx.coroutines.EventLoopImplBase#processNextEvent(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/common/src/EventLoop.common.kt:274)
	at kotlinx.coroutines#runEventLoop(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:80)
	at kotlinx.coroutines.BlockingCoroutine.joinBlocking#internal(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:67)
	at kotlinx.coroutines#runBlocking(/opt/buildAgent/work/44ec6e850d5c63f0/kotlinx-coroutines-core/native/src/Builders.kt:50)
	at com.example#runBlocking(/Users/russell/IdeaProjects/Ktor14/shared/src/iosTest/kotlin/runBlocking.kt:8)
	at com.example#runBlocking$default(/Users/russell/IdeaProjects/Ktor14/shared/src/iosTest/kotlin/runBlocking.kt:7)
	at com.example.ApiClientTest#mockWebCall(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:20)
	at com.example.$ApiClientTest$test$0.$mockWebCall$FUNCTION_REFERENCE$0.invoke#internal(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:19)
	at com.example.$ApiClientTest$test$0.$mockWebCall$FUNCTION_REFERENCE$0.$<bridge-UNNN>invoke(/Users/russell/IdeaProjects/Ktor14/shared/src/commonTest/kotlin/ApiClientTest.kt:19)
	at kotlin.native.internal.test.BaseClassSuite.TestCase#run(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestSuite.kt:85)
	at kotlin.native.internal.test.TestRunner.run#internal(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:236)
	at kotlin.native.internal.test.TestRunner.runIteration#internal(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:258)
	at kotlin.native.internal.test.TestRunner#run(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/TestRunner.kt:273)
	at kotlin.native.internal.test#testLauncherEntryPoint(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:22)
	at kotlin.native.internal.test#main(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:26)
	at <global>.Konan_start(/Users/teamcity/buildAgent/work/cae0e6559deed4c4/runtime/src/main/kotlin/kotlin/native/internal/test/Launcher.kt:25)
	at <global>.Init_and_run_start(Unknown Source)

On JVM, if Input is empty, it will throw EOFException
On Native/JS it will just return empty string

reproducer:

println(ByteReadPacket.Empty.readTextExactBytes(1).length)

JVM: fail with EOF
JS/Native: print 0

While profiling rsocket-kotlin I found in graphs/traces that one of the most frequent element are calls to SharedJVM and boxing of Int values. I know, that shared delegate used in ktor-io to support using atomics on K/N and plain value on JVM/JS. But that code optimization isn't ok regarding to performance.
The issue consists of two parts:

1. every usage of shared - create anonymous object on initialization
2. boxing/unboxing of primitives on setting/getting value
   F.e. Buffer class from ktor-io use shared for 4 Int fields: readPosition, writePosition, startGap, limit - and all of them are updating frequently. So all time we operate on them we will do box/unbox - performance suffer significantly...

To proof my idea, I've replaced calls of shared to plain variables inside ktor-io module, and built it locally. Running benchmarks I found, that it's 50% faster!
So, f.e. io.rsocket.kotlin.benchmarks.RSocketBenchmark#requestResponseParallel benchmark on ktor version 1.4.2 gives ~200 ops/s and on local version without shared gives ~300 ops/s.
That benchmark heavily use big ByteReadPackets.

I think that should be fixed some how, as 50% difference is really big

Problem

Currently, we have a public commitment to not break any API and ABI. This is generally good.
The problem is that it makes it almost impossible for a new experimental feature/API to grow and entirely stops evolution since major versions are released too slowly.

Proposed solution

The idea is to relax guarantees for all API that is marked with experimental annotations similar to Kotlin.

Rules

• in a patch version: no changes allowed, deprecations with level WARNING could be introduced for existing API.
• in a minor version: both source and binary changes allowed except for complete removal. All changes should include migration/deprecation. Hidden deprecated APIs should be introduced for binary compatibility.
• in a major version: any changes including complete removal but only through the deprecation cycle.

Requirements for experimental API:

• experimental API should be marked with an experimental annotation requiring opt-in
• an experimental annotation should have level ERROR and should have a reasonable and clear description
• for a single or group of new experimental functions/classes/APIs having the same purpose and/or related functionality, it is required to introduce a new experimental annotation

Note: the consequence is that you can't use KtorExperimentalAPI annotation for new API. So one should always create new experimental annotations for now.
The other consequence is that we should revisit all KtorExperimentalAPI usages and either stabilize them or migrate to new experimental annotations.

Requirements for experimental API annotation:

An experimental annotation class should:

• require opt-in with level ERROR (@RequiresOptIn(level = ERROR));
• have a reasonable and clear description;
• have a reference to a ktor ticket that introduced this API and/or describes why the API is experimental and that is useful for tracking the concrete experimental feature status;
• have retention BINARY, unless there is a reason to have RUNTIME;
• be documented;
• contain a disclamer in the kdoc about the risk of using experimental features.

Note: RUNTIME retention is not recommended since the ability to analyze it in runtime makes it more difficult to remove the annotation due to indirect and unobvious references. Retention SOURCE is not acceptable because it is how @RequiresOptIn works in Kotlin.

Experimental API Deprecation cycle

A deprecation cycle for an API that is intended to be removed or changed consist of the following steps:

1. In any release, make the API deprecated with level WARNING by applying one of the following:

• @Deprecated annotation with level WARNING, provide a clear message describing what will be changed and what exact migration is required, provide a "replace with"
• a new annotation requiring opt-in with level WARNING and the description

2. In the next minor release, promote the deprecation level from WARNING to ERROR
3. In the next minor release after step 2, change the deprecation level from ERROR to HIDDEN, keep the implementation working despite that it is hidden (to keep binary compatibility)
4. In the next major release, remove the old API

Please note that using an opt-in annotation for deprecation doesn't provide the ability to write a "replace with". Thus, it only makes sense to use it for removing old API. A good example is kotlinx.coroutines ObsoleteCoroutinesApi

If some of the rules are impossible to comply (for example, it is impossible to provide a "replace with" action or impossible to keep a hidden function working), an author of change should initiate a discussion at least with PR reviewer. When decided, it could be also discussed in the team or even publically for a quite popular experimental API. If it was decided to skip some of the requirements, it is important to document that decision and reasons in the PR.

KtorExperimentalAPI deprecation

@KtorExperimentalAPI annotation is going to be deprecated in the following stages:

1. Revisit all existing API marked with the annotation and stabilize when possible without breaking changes in a minor version(s). Mark the annotation deprecated with level WARNING.
2. In major version (2.0.0), revisit again. When impossible to stabilize, introduce new experimental annotations and use them instead. Ensure no KtorExperimentalAPI usages. Promote its deprecation to level ERROR.
3. In the next major version (3.0.0) deprecate it with level HIDDEN. Use text search to ensure no text occurrences.
4. In the next major version (4.0.0) remove it.

The reason why we deprecate it is that it introduces a way of "anonymous" experiment. An experimental API should be introduced with a clear reason and plan. A plan should cover only one particular feature/functionality. An experimental feature should have a more or less clear lifecycle.

The other disadvantage of this annotation is that there is no easy way to de-opt-in users from it. Also, it invites most brave users to opt-in globally for the whole project (just as we did for ExperimentalCoroutinesApi). This is very bad because in this case experimental usages will become uncontrolled and the user doesn't realize anymore what danger it is. So to prevent such problems, we should stop using it and migrate to a better approach.

Example

Here is an example of an experimental API:

/**
 * API marked with this annotation is a part of experimental Z feature. 
 * The feature preview provides the ability to work with Z. 
 * Please see KTOR-number for details and stabilization plan.
 * 
 * This is an API preview and it's not recommended for production development 
 * since it could be changed or removed in the future and 
 * not guaranteed to remain functional and its behaviour may also change in any non-patch release.
 */
@RequiresOptIn("Z feature is experimental and not recommended for production development.", level = ERROR)
@Retention(BINARY)
annotation class ZFeature

/**
 * Z feature's context
 */
@ZFeature
class ZContext

/** 
 * Configures Z feature and invokes [block] with running instance.
 */
@ZFeature
fun withZ(block: () -> Unit) = ...

From PR #2199:

To be used in specific kotlinx-train CI configuration. It's needed for faster adoption of JVM IR compiler.

PRs to https://github.com/ktorio/ktor-samples are not checked by CI

To reproduce run ./gradlew :publishKotlinMultiplatformPublicationToMavenLocal in the root directory of the Ktor framework repository using the latest master.

> Failed to publish publication 'kotlinMultiplatform' to repository 'mavenLocal'
   > Invalid publication 'kotlinMultiplatform': multiple artifacts with the identical extension and classifier ('jar', 'null').

OS: macOS Catalina

It seems like this commit broke the Jackson content negotiator, now when calling call.receive() the following exception occurs:

java.lang.IllegalStateException: Using blocking primitives on this dispatcher is not allowed. Consider using async channel instead or use blocking primitives in withContext(Dispatchers.IO) instead.
	at io.ktor.utils.io.jvm.javaio.BlockingKt.ensureParkingAllowed(Blocking.kt:302)
	at io.ktor.utils.io.jvm.javaio.BlockingKt.access$ensureParkingAllowed(Blocking.kt:1)
	at io.ktor.utils.io.jvm.javaio.InputAdapter.<init>(Blocking.kt:30)
	at io.ktor.utils.io.jvm.javaio.BlockingKt.toInputStream(Blocking.kt:20)
	at io.ktor.utils.io.jvm.javaio.BlockingKt.toInputStream$default(Blocking.kt:20)
	at io.ktor.jackson.JacksonConverter.convertForReceive(JacksonConverter.kt:55)
	at io.ktor.features.ContentNegotiation$Feature$install$3.invokeSuspend(ContentNegotiation.kt:175)
	at io.ktor.features.ContentNegotiation$Feature$install$3.invoke(ContentNegotiation.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.util.pipeline.SuspendFunctionGun.execute(SuspendFunctionGun.kt:133)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77)
	at io.ktor.request.ApplicationReceiveFunctionsKt.receive(ApplicationReceiveFunctions.kt:110)
	at net.octyl.ourtwobe.api.ApiServerKt$module$7$2$1$1.invokeSuspend(ApiServer.kt:232)
	at net.octyl.ourtwobe.api.ApiServerKt$module$7$2$1$1.invoke(ApiServer.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.util.pipeline.SuspendFunctionGun.execute(SuspendFunctionGun.kt:133)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77)
	at io.ktor.routing.Routing.executeResult(Routing.kt:148)
	at io.ktor.routing.Routing.interceptor(Routing.kt:35)
	at io.ktor.routing.Routing$Feature$install$1.invokeSuspend(Routing.kt:100)
	at io.ktor.routing.Routing$Feature$install$1.invoke(Routing.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.features.ContentNegotiation$Feature$install$1.invokeSuspend(ContentNegotiation.kt:113)
	at io.ktor.features.ContentNegotiation$Feature$install$1.invoke(ContentNegotiation.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.features.StatusPages$interceptCall$2.invokeSuspend(StatusPages.kt:101)
	at io.ktor.features.StatusPages$interceptCall$2.invoke(StatusPages.kt)
	at kotlinx.coroutines.intrinsics.UndispatchedKt.startUndispatchedOrReturn(Undispatched.kt:91)
	at kotlinx.coroutines.CoroutineScopeKt.coroutineScope(CoroutineScope.kt:194)
	at io.ktor.features.StatusPages.interceptCall(StatusPages.kt:100)
	at io.ktor.features.StatusPages$Feature$install$2.invokeSuspend(StatusPages.kt:140)
	at io.ktor.features.StatusPages$Feature$install$2.invoke(StatusPages.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.features.CallLogging$Feature$install$2.invokeSuspend(CallLogging.kt:139)
	at io.ktor.features.CallLogging$Feature$install$2.invoke(CallLogging.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.util.pipeline.SuspendFunctionGun.execute(SuspendFunctionGun.kt:133)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77)
	at io.ktor.server.engine.DefaultEnginePipelineKt$defaultEnginePipeline$2.invokeSuspend(DefaultEnginePipeline.kt:118)
	at io.ktor.server.engine.DefaultEnginePipelineKt$defaultEnginePipeline$2.invoke(DefaultEnginePipeline.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.util.pipeline.SuspendFunctionGun.execute(SuspendFunctionGun.kt:133)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77)
	at io.ktor.server.netty.NettyApplicationCallHandler$handleRequest$1.invokeSuspend(NettyApplicationCallHandler.kt:55)
	at io.ktor.server.netty.NettyApplicationCallHandler$handleRequest$1.invoke(NettyApplicationCallHandler.kt)
	at kotlinx.coroutines.intrinsics.UndispatchedKt.startCoroutineUndispatched(Undispatched.kt:55)
	at kotlinx.coroutines.CoroutineStart.invoke(CoroutineStart.kt:111)
	at kotlinx.coroutines.AbstractCoroutine.start(AbstractCoroutine.kt:158)
	at kotlinx.coroutines.BuildersKt__Builders_commonKt.launch(Builders.common.kt:56)
	at kotlinx.coroutines.BuildersKt.launch(Unknown Source)
	at io.ktor.server.netty.NettyApplicationCallHandler.handleRequest(NettyApplicationCallHandler.kt:38)
	at io.ktor.server.netty.NettyApplicationCallHandler.channelRead(NettyApplicationCallHandler.kt:29)
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
	at io.netty.channel.AbstractChannelHandlerContext.access$600(AbstractChannelHandlerContext.java:61)
	at io.netty.channel.AbstractChannelHandlerContext$7.run(AbstractChannelHandlerContext.java:370)
	at io.netty.util.concurrent.AbstractEventExecutor.safeExecute$$$capture(AbstractEventExecutor.java:164)
	at io.netty.util.concurrent.AbstractEventExecutor.safeExecute(AbstractEventExecutor.java)
	at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks(SingleThreadEventExecutor.java:472)
	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:500)
	at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:989)
	at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
	at io.ktor.server.netty.EventLoopGroupProxy$Companion$create$factory$1$1.run(NettyApplicationEngine.kt:215)
	at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
	at java.base/java.lang.Thread.run(Thread.java:832)

Kotlin version: 1.3.70
Ktor version: 1.3.2

In situations when receiving large cookies and the headers exceed the 8K limit (using Netty as engine), not all headers get loaded.

Example 1:

• When we have the ContentNegotiation feature enabled
• And a content-type: application/json is present on the request
• And the cookie header is very large (the sum of all headers exceeding 8K)
• Then the ContentNegotiation feature resolves the content type to Any (*/*) - probably because it can't load all headers
• This results in a situation where the server responds with 415 - Unsupported Media Type.

In this particular example probably a 431 - Requests header fields too large is more appropriate.

Example 2:

• Consider the hypothesis from Example 1
• When the content-type: application/json header is loaded before the cookie header
• Then the request passes successfully through the ContentNegotiation feature
• But the request hangs

This seems like an issue where Ktor does not correctly interpret errors from the Netty engine.

Sample engine error:

DefaultHttpRequest(decodeResult: failure(io.netty.handler.codec.TooLongFrameException: HTTP header is larger than 8192 bytes.), version: HTTP/1.1)
POST /v1/api HTTP/1.1
Host: localhost:8080
Accept: */*
cache-control: no-cache
user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.105 Safari/537.36
content-type: text/plain;charset=UTF-8

We recently got some alerts in our webserver because ktor threw an uncaught exception. Ideally these are handled and a 400 is sent back.

Here is the exception:
Wrong HEX escape: %uf, in /%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/%uff0e%uff0e/winnt/win.ini

Stacktrace:

at io.ktor.http.CodecsKt.decodeImpl (Codecs.kt:197)
at io.ktor.http.CodecsKt.decodeScan (Codecs.kt:146)
at io.ktor.http.CodecsKt.decodeURLPart (Codecs.kt:140)
at io.ktor.http.CodecsKt.decodeURLPart$default (Codecs.kt:139)
at io.ktor.routing.RoutingResolveContext.parse (RoutingResolve.kt:70)
at io.ktor.routing.RoutingResolveContext.<init> (RoutingResolve.kt:49)
at io.ktor.routing.Routing.interceptor (Routing.kt:31)
at io.ktor.routing.Routing$Feature$install$1.invokeSuspend (Routing.kt:99)
at io.ktor.routing.Routing$Feature$install$1.invoke (Routing.kt)
at io.ktor.util.pipeline.SuspendFunctionGun.loop (PipelineContext.kt:318)
at io.ktor.util.pipeline.SuspendFunctionGun.proceed (PipelineContext.kt:163)
at io.ktor.features.ContentNegotiation$Feature$install$1.invokeSuspend (ContentNegotiation.kt:107)
at io.ktor.features.ContentNegotiation$Feature$install$1.invoke (ContentNegotiation.kt)
at io.ktor.util.pipeline.SuspendFunctionGun.loop (PipelineContext.kt:318)
at io.ktor.util.pipeline.SuspendFunctionGun.proceed (PipelineContext.kt:163)
at io.ktor.util.pipeline.SuspendFunctionGun.execute (PipelineContext.kt:183)
at io.ktor.util.pipeline.Pipeline.execute (Pipeline.kt:27)
at io.ktor.server.engine.DefaultEnginePipelineKt$defaultEnginePipeline$2.invokeSuspend (DefaultEnginePipeline.kt:120)
at io.ktor.server.engine.DefaultEnginePipelineKt$defaultEnginePipeline$2.invoke (DefaultEnginePipeline.kt)
at io.ktor.util.pipeline.SuspendFunctionGun.loop (PipelineContext.kt:318)
at io.ktor.util.pipeline.SuspendFunctionGun.proceed (PipelineContext.kt:163)
at io.ktor.util.pipeline.SuspendFunctionGun.execute (PipelineContext.kt:183)
at io.ktor.util.pipeline.Pipeline.execute (Pipeline.kt:27)
at io.ktor.server.netty.NettyApplicationCallHandler$handleRequest$1.invokeSuspend (NettyApplicationCallHandler.kt:40)
at io.ktor.server.netty.NettyApplicationCallHandler$handleRequest$1.invoke (NettyApplicationCallHandler.kt)
at kotlinx.coroutines.intrinsics.UndispatchedKt.startCoroutineUndispatched (Undispatched.kt:55)
at kotlinx.coroutines.CoroutineStart.invoke (CoroutineStart.kt:111)
at kotlinx.coroutines.AbstractCoroutine.start (AbstractCoroutine.kt:158)
at kotlinx.coroutines.BuildersKt__Builders_commonKt.launch (Builders.common.kt:54)
at kotlinx.coroutines.BuildersKt.launch (Unknown Source)
at io.ktor.server.netty.NettyApplicationCallHandler.handleRequest (NettyApplicationCallHandler.kt:30)
at io.ktor.server.netty.NettyApplicationCallHandler.channelRead (NettyApplicationCallHandler.kt:24)
at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead (AbstractChannelHandlerContext.java:379)
at io.netty.channel.AbstractChannelHandlerContext.access$600 (AbstractChannelHandlerContext.java:61)
at io.netty.channel.AbstractChannelHandlerContext$7.run (AbstractChannelHandlerContext.java:370)
at io.netty.util.concurrent.AbstractEventExecutor.safeExecute (AbstractEventExecutor.java:164)
at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks (SingleThreadEventExecutor.java:472)
at io.netty.channel.nio.NioEventLoop.run (NioEventLoop.java:500)
at io.netty.util.concurrent.SingleThreadEventExecutor$4.run (SingleThreadEventExecutor.java:989)
at io.netty.util.internal.ThreadExecutorMap$2.run (ThreadExecutorMap.java:74)
at io.netty.util.concurrent.FastThreadLocalRunnable.run (FastThreadLocalRunnable.java:30)

HttpServerTestSuite.testHeadResponse fails with Netty HTTP/2 because a response message has no actual body but headers have the concrete content length so it leads to the pipeline failure

edit: https://github.com/dm6801/ktor_sessions_ssl

when trying to use Session feature with cookies

    install(Sessions) {
        cookie<MySession>("MY_SESSION")
    }

accessing https:/localhost:443/ throws:

java.lang.UnsupportedOperationException: null
	(Coroutine boundary)
	at io.ktor.server.engine.DefaultEnginePipelineKt$defaultEnginePipeline$2.invokeSuspend(DefaultEnginePipeline.kt:118)
	at io.ktor.server.netty.NettyApplicationCallHandler$handleRequest$1.invokeSuspend(NettyApplicationCallHandler.kt:55)
	(Coroutine creation stacktrace)
	at kotlinx.coroutines.intrinsics.UndispatchedKt.startCoroutineUndispatched(Undispatched.kt:188)
	at kotlinx.coroutines.BuildersKt.launch(Unknown Source)
	at io.ktor.server.netty.NettyApplicationCallHandler.handleRequest(NettyApplicationCallHandler.kt:38)
	at io.ktor.server.netty.NettyApplicationCallHandler.channelRead(NettyApplicationCallHandler.kt:29)
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379)
	at io.netty.channel.AbstractChannelHandlerContext.access$600(AbstractChannelHandlerContext.java:61)
	at io.netty.channel.AbstractChannelHandlerContext$7.run(AbstractChannelHandlerContext.java:370)
	at io.netty.util.concurrent.AbstractEventExecutor.safeExecute(AbstractEventExecutor.java:164)
	at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks(SingleThreadEventExecutor.java:472)
	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:500)
	at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:989)
	at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
	at io.ktor.server.netty.EventLoopGroupProxy$Companion$create$factory$1$1.run(NettyApplicationEngine.kt:215)
	at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
	at java.lang.Thread.run(Thread.java:821)
Caused by: java.lang.UnsupportedOperationException: null
	at io.ktor.server.netty.http2.NettyHttp2ApplicationRequest.getCookies(NettyHttp2ApplicationRequest.kt:64)
	at io.ktor.sessions.SessionTransportCookie.receive(SessionTransportCookie.kt:28)
	at io.ktor.sessions.SessionsKt.receiveSessionData(Sessions.kt:204)
	at io.ktor.sessions.Sessions$Feature$install$1.invokeSuspend(Sessions.kt:59)
	at io.ktor.sessions.Sessions$Feature$install$1.invoke(Sessions.kt)
	at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:243)
	at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:113)
	at io.ktor.util.pipeline.SuspendFunctionGun.execute(SuspendFunctionGun.kt:133)
	at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77)

relevant line NettyHttp2ApplicationRequest.getCookies(NettyHttp2ApplicationRequest.kt:64):

override val cookies: RequestCookies
    get() = throw UnsupportedOperationException()

• http://localhost:8080/ - works

failing on: val bookRequest = call.receive<Example>() (full example):

package app.controllers

import app.models.Example
import app.services.ExampleService
import io.ktor.application.*
import io.ktor.auth.*
import io.ktor.auth.jwt.*
import io.ktor.features.*
import io.ktor.http.*
import io.ktor.request.*
import io.ktor.response.*
import io.ktor.routing.*
import org.kodein.di.instance

class ExampleController(application: Application): Controller(application) {
    private val exampleService: ExampleService by instance()

    override fun Route.getRoutes() {
        post("/") {
            val bookRequest = call.receive<Example>()
            exampleService.addExample(bookRequest)
            call.respond(HttpStatusCode.Accepted)
        }
    }
}

    @Test
    fun testErrorInWritingPropagates() = testSuspend {
        val client = HttpClient(factory)
        val channel = ByteChannel(true)
        channel.writeAvailable("text".toByteArray())
        channel.close(IllegalStateException("Error on write"))
        assertFailsWith<IllegalStateException>("Error on write") {
            val result = client.post<String>("http://localhost:$serverPort/echo") {
                body = channel
            }
        }
    }

Apache: sends empty body without error
OkHttp: hangs
CIO: sends empty body without error
Android: succeed

This issue was imported from GitHub issue: https://github.com/ktorio/ktor/issues/1945

Ktor Version and Engine Used (client or server and name)
Version: 1.3.2-1.4-M1-2
ktor-client-core
ktor-client-json-native
ktor-client-serialization-native
ktor-client-curl

Describe the bug
The URL is wrong escaped.

To Reproduce

class FahrplanApi(private val serverUrl: String = "http://api.deutschebahn.com/freeplan/v1") {
    private val client = HttpClient {
        install(JsonFeature)
        // workaround for version 1.4-M1 
        // https://github.com/ktorio/ktor/issues/1820#issuecomment-633519483
        HttpResponseValidator {
            validateResponse { response ->
                when (response.status.value) {
                    in 300..399 -> throw RedirectResponseException(response)
                    in 400..499 -> throw ClientRequestException(response)
                    in 500..599 -> throw ServerResponseException(response)
                }
            }
        }

        expectSuccess = false
    }

    suspend fun departureBoardDateTime(id: Long, date: String) =
        client.get<Departure>("$serverUrl/departureBoard/$id?date=$date")
}

fun main(): Unit = runBlocking {
    val api = FahrplanApi()
    api.departureBoardDateTime(8000096, "2020-06-14T20:21:22")
}

after run:

Uncaught Kotlin exception: io.ktor.client.features.ClientRequestException: Client request(https://api.deutschebahn.com/freeplan/v1/departureBoard/8000096?date=2020-06-14T20%253A21%253A22) invalid: 400 Bad Request

Expected behavior

https://api.deutschebahn.com/freeplan/v1/departureBoard/8000096?date=2020-06-14T20%3A21%3A22

%253A --> %3A (25 is actually %)

This issue was imported from GitHub issue: https://github.com/ktorio/ktor/issues/1518

Ktor Version and Engine Used (client or server and name)
version, client/server, additional ktor modules included
android
io.ktor:ktor-client-cio:1.3.0-rc

Describe the bug
Error occurred
“ Failed to parse request body: request body length should be specified,
chunked transfer encoding should be used or
keep-alive should be disabled (connection: close)”

Client code
var httpClient= HttpClient(CIO) {
install(JsonFeature) {
serializer = GsonSerializer()
}
}
val params = baseFormData {
append("phone", phone)
append("code", code)
}
var baseRepository = httpClient.submitFormWithBinaryData<BaseRes<LoginResponse>>(params) {
url("$baseUrl/users/phoneLogin")
}
Debugging found ktor-client-cio-1.3.0-rc-sources.jar! /JvmMain/io/ktor/client/engine/cio/utils.kt:
Val rawResponse = parseResponse (input) did not parse successfully Content-Length
Debug screenshot

This issue was imported from GitHub issue: https://github.com/ktorio/ktor/issues/1557

Ktor Version and Engine Used (client or server and name)
1.2.6, 1.3.0-rc2

Describe the bug
Any sendPipeline interceptor installed does not get called when testing using withTestApplication.

To Reproduce
Steps to reproduce the behavior:
Install a sendPipeline interceptor an try to use it with a handleRequest. The interception lambda will not be called.

Expected behavior
The interception lambda to be called.

You can check out the test code here in this feature of mine where I'm having the issue. A run of the tests is also available here on TravisCI and the corresponding build scan here.

This issue was imported from GitHub issue: https://github.com/ktorio/ktor/issues/1663

Ktor Version and Engine Used (client or server and name)
Ktor server (CIO) 1.3.1, plain JS on the client.

Describe the bug
In my application I need to modify a requesting host address and send back a request for data.
When called on localhost server, call.request.host() returns 0.0.0.0.0.0.0.0 instead of ip4 address, which does not play well with some JS functions. It was working properly on 1.2.3, but is broken after migration.

Expected behavior
Don't know, maybe it is by design, but it should be documented in that case.