arrow-kt / suspendapp Goto Github PK

Issue: http inflight request is aborted on app getting e.g. SIGTERM even though SuspendApp preWait is configured to be e.g. 10s.

Expectation: http inflight requests are allowed to complete within preWait on app getting e.g. SIGTERM.

Steps to reproduce: (example app code issue-suspendapp-inflight-abort.zip)

• Start app with -Dio.ktor.server.engine.ShutdownHook=false
• curl http://localhost/ping -v
• kill -s SIGTERM `lsof -t -i:80`
• Inflight request is aborted immediately ignoring preWait

Looks like an issue is with Ktor itself as I also get the same outcome using just Ktor embeddedServer (also raised an issue with Ktor)
Nevertheless I thought maybe Arrow community could also help investigating this issue.

Repro Steps:
https://github.com/jamesward/kmp-conf-server

./gradlew runDebugExecutableLinuxX64

(Not sure if the same problem exists on Mac)

Hit Ctrl-C and see the Gradle process end, but the native server process continues running even after multiple minutes:

$ ps auxwww|grep kmp-conf-server
jw        847540  0.1  0.0 554808 28072 ?        Sl   16:09   0:00 /home/jw/projects/kmp-conf-server/build/bin/linuxX64/debugExecutable/kmp-conf-server.kexe

I used the Ktor example of SuspendApp and generated a jar file.
When run on windows, the process does not terminate on SIGINT (Ctrl+c). Notably, the ktor server shuts down, nevertheless the process still keeps running. When pressing Ctrl+c another time, the processes finally terminates. On linux however (using the same jar), the application terminates gracefully as expected.

fun main() = SuspendApp {
  resourceScope {
    server(Netty) { ... }
    awaitCancellation()
  }
}

The example module currently doesn't setup the Java app.
Upon setting up the example module we ran into some issues setting up Java from a Kotlin MPP project.

It didn't correctly link the Main-Class in the Manifest when configuring from the regular Java Gradle DSL.
Neither Google, nor Kotlin Slack gave me an quick solution so I opted to move it out of the scope of PR #4.

Since Ktor v2.3.0 shutdown hook was added to Ktor engines e.g. CIO and Netty, making Ktor server to stop before waiting a preWait duration configured by SuspendApp.
Adding an example project to reproduce this issue issue-demo.zip

Steps to reproduce it:

• Start app with -Dio.ktor.server.engine.ShutdownHook=true (true by default)
• curl http://localhost/ping -v to get 200 response
• kill -s SIGTERM `lsof -t -i:80`
• curl http://localhost/ping -v again to get an error while it is expected to get 200 response for a period of preWait duration before engine.stop is called.

Setting -Dio.ktor.server.engine.ShutdownHook=false fixes this issue.
To save developers time troubleshooting this issue, probably SuspendApp readme/docs should mention this Ktor engine configuration bit making sure SuspendApp works as expected?
Also might be worth adding an integration test to cover this behaviour.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update kotlin to v2 (major) (org.jetbrains.kotlin.jvm, org.jetbrains.kotlin.multiplatform)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update arrowGradleConfig to v0.12.0-rc.24 (io.arrow-kt.arrow-gradle-config-versioning, io.arrow-kt.arrow-gradle-config-publish, io.arrow-kt.arrow-gradle-config-nexus, io.arrow-kt.arrow-gradle-config-formatter)
• Update dependency io.ktor:ktor-server-host-common to v2.3.12

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Can we add support for LinuxArm64 also? Getting the following error

:shared:linuxArm64Main: Could not resolve io.arrow-kt:suspendapp:0.4.1-alpha.5.

Kotlin version: 1.9.21
Native Platform build: linuxX64
OS: Ubuntu 23.10

I tried the "Simple Example" from the README.MD, but the backpressure communication via the CompletableDeferred<Int> seems the get deadlocked and the simple example never terminates. Triggering the kill signal (SIGINT or SITGERM) gets correctly communicated to the arrow.continuations.unsafe.Unsafe#onShutdown hook, but the shutdown hook never returns from the call to BACKPRESSURE.complete(..) and the waiting signal handler never gets released. Providing a timeout to arrow.continuations.SuspendAppKt#SuspendApp has no effect.