Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[kotlin-client] OkHttp call is now non-blocking #10303

Merged

Conversation

sheepdreamofandroids
Copy link
Contributor

All functions in the kotlin-client are marked suspend but the final call to OkHttp was blocking the thread. This is no longer the case.

Note that this can have impact on integration tests that verify backend calls because now it can happen that one call fails and therefore cancels the whole hierarchy of coroutines which possible cancels other backend calls before they even started. That IS desired behaviour though.

This code is a subset of a few patches that are running in production.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jimschubert, @dr4ke616, @karismann, @Zomzog, @andrewemery, @4brunu, @yutaka0m

Copy link
Contributor

@4brunu 4brunu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for this contribution, this is indeed a good idea.
I left some comments with improvements.
Also all those changes should only be applied when the user uses kotlin coroutines, so they should be inside the following if.

{{#useCoroutines}}
changes here for the projects that use kotlin coroutines
{{/useCoroutines}}
{{^useCoroutines}}
changes here for the projects that don't use kotlin coroutines
{{/useCoroutines}}
{{/doNotUseRxAndCoroutines}}

val response: Response = suspendCoroutine { continuation ->
client.newCall(request).enqueue(object : Callback {
override fun onFailure(call: Call, e: IOException) {
continuation.resumeWithException(e)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sheepdreamofandroids I think this should only be called if the call is not canceled.

https://github.com/coil-kt/coil/blob/a17284794764ed5d0680330bfd8bca722a36bb5e/coil-base/src/main/java/coil/util/ContinuationCallback.kt

    override fun onFailure(call: Call, e: IOException) {
        if (!call.isCanceled) {
            continuation.resumeWithException(e)
        }
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the call is cancelled because the coroutine is cancelled as per your next comment, the resumeWithException shouldn't do anything.
On the other hand, if the call is ever cancelled for another reason, you do want to report the exception and resume, or else the coroutine will never terminate.
See https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/suspend-cancellable-coroutine.html

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation, looks good to me 👍

@@ -326,7 +333,16 @@ import com.squareup.moshi.adapter
headers.forEach { header -> addHeader(header.key, header.value) }
}.build()

val response = client.newCall(request).execute()
val response: Response = suspendCoroutine { continuation ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did this except for the check on call.isCancelled.

I added checks around the coroutine imports. The other imports may not be necessary all the time but they come from the same very common dependencies as other unconditional imports. I prefer to keep the template simple.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
By the way, I would like to have your option regarding this change from suspendCoroutine to suspendCancellableCoroutine?
Do you agree with it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The additional value is that an ongoing http call will be cancelled in case the result is not needed anymore. In itself that is valuable.

It seems to me that the time window where you can cancel an ongoing http call is very short, unless there is a huge request body so it will rarely make a difference.

The additional complexity is quite low though so my gut feeling says it's worth it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@wing328
Copy link
Member

wing328 commented Sep 1, 2021

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

sheepdreamofandroids and others added 6 commits September 2, 2021 09:10
Only use coroutines when requested
Not adding potentially unavailable imports
…otlin-client/async-call

# Conflicts:
#	modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-okhttp/infrastructure/ApiClient.kt.mustache
#	samples/client/petstore/kotlin-gson/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-jackson/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-json-request-string/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-jvm-okhttp4-coroutines/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-moshi-codegen/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-nonpublic/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-nullable/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-okhttp3/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-string/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-threetenbp/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin-uppercase-enum/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
#	samples/client/petstore/kotlin/src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt
Copy link
Contributor

@4brunu 4brunu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me this PR is ready to merge 👍

@wing328 wing328 added this to the 5.3.0 milestone Sep 3, 2021
@wing328 wing328 merged commit 490c747 into OpenAPITools:master Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants