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

New feature for retrying request after failed #26

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
package dev.icerock.moko.network.features
Alex009 marked this conversation as resolved.
Show resolved Hide resolved

import io.ktor.client.HttpClient
import io.ktor.client.features.HttpClientFeature
import io.ktor.client.request.HttpRequestBuilder
import io.ktor.client.request.HttpSendPipeline
import io.ktor.client.statement.HttpStatement
import io.ktor.util.AttributeKey
import io.ktor.utils.io.errors.IOException
import kotlinx.coroutines.delay

/**
@param onGetDelay the callback for calculation a delay between failed request and next request
@param maxAmountRetrying the max amounts retrying requests
@param onConditionRetrying the callback for condition a retrying request. By default it check `e is IOException `
Copy link
Member

Choose a reason for hiding this comment

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

naming invalid. onGetDelay called as callback, but it not "callback" - it behavior function. i suggest delayGetter: (lastDelayInMillisecond: Long, timeRetrying: Int) -> Long naming.
for onConditionRetrying - isShouldRetryRequest(e: Throwable): Boolean

*/
class HttpRetrySendFeature(
private val onGetDelay: (lastDelayInMillisecond: Long, timeRetrying: Int) -> Long,
private val maxAmountsRetrying: Int,
private val onConditionRetrying: (e: Throwable) -> Boolean
) {

class Config {
var onGetDelay: (lastDelayInMillisecond: Long, timeRetrying: Int) -> Long =
{ _, _ -> 2_000L }
var maxAmountRetrying: Int = 3 // first request + three retrying requests,
var onConditionRetrying: (e: Throwable) -> Boolean = { e -> e is IOException }
fun build() = HttpRetrySendFeature(onGetDelay, maxAmountRetrying, onConditionRetrying)
}

companion object Feature : HttpClientFeature<Config, HttpRetrySendFeature> {
private const val LAST_DELAY_HEADER = "HttpRetrySendFeature-Last-Delay"
private const val RETRY_COUNTER_HEADER = "HttpRetrySendFeature-Retry-Counter"

override val key: AttributeKey<HttpRetrySendFeature> = AttributeKey("HttpRetrySendFeature")

override fun install(feature: HttpRetrySendFeature, scope: HttpClient) {
scope.sendPipeline.intercept(HttpSendPipeline.Before) {
val counter = context.headers[RETRY_COUNTER_HEADER]?.toInt() ?: 0
val lastDelay = context.headers[LAST_DELAY_HEADER]?.toLong()
?: feature.onGetDelay(0L, counter)
if (counter < feature.maxAmountsRetrying) {
try {
context.headers.remove(LAST_DELAY_HEADER)
context.headers.remove(RETRY_COUNTER_HEADER)
proceed()
Comment on lines +48 to +50
Copy link
Member

Choose a reason for hiding this comment

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

strange logic. we send request without headers, but later we send request with headers one time and if it failed - we not catch again...do you debug this logic?

Copy link
Author

Choose a reason for hiding this comment

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

In final this headers not send in a futher phase after HttpSendPipeline.Before. Logic:
if request failed then I'm fininishing current request(all pipeline) and create new request (new pipeline(requestPipeline->sendPipeline)) adding info in headers when new request(retryed) come in the HttpSendPipeline.Before phase then I get info from headers and I delete these headers then send to next phase.
If counter more or equel maxAmountsRetrying, I send to next phase like common request, that could throw a not handled exception(in this feature).

Copy link
Member

Choose a reason for hiding this comment

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

confused logic in code...support of this will be pain - we should rework it to more clear version. @Tetraquark will help you

} catch (e: Throwable) {
if (feature.onConditionRetrying(e)) {
val requestBuilder = HttpRequestBuilder().takeFrom(context)
val indexRetrying = counter + 1
val nextDelay = feature.onGetDelay(lastDelay, counter)
requestBuilder.headers[RETRY_COUNTER_HEADER] = indexRetrying.toString()
requestBuilder.headers[LAST_DELAY_HEADER] = nextDelay.toString()
delay(nextDelay)
finish()
Copy link
Member

Choose a reason for hiding this comment

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

for what we finish pipeline? later called proceed

Copy link
Author

Choose a reason for hiding this comment

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

When finish a pipeline without a calling of proceedWith the ktor throw error:
java.lang.IllegalStateException: Failed to execute send pipeline. Expected to got [HttpClientCall], but received EmptyContent at io.ktor.client.features.HttpSend$DefaultSender.execute(HttpSend.kt:120) at io.ktor.client.features.HttpSend$DefaultSender$execute$1.invokeSuspend(Unknown Source:12) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at io.ktor.util.pipeline.SuspendFunctionGun.resumeRootWith(PipelineContext.kt:238) at io.ktor.util.pipeline.SuspendFunctionGun.loop(PipelineContext.kt:194) at io.ktor.util.pipeline.SuspendFunctionGun.access$loop(PipelineContext.kt:67) at io.ktor.util.pipeline.SuspendFunctionGun$continuation$1.resumeWith(PipelineContext.kt:144) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46) at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56) at android.os.Handler.handleCallback(Handler.java:883) at android.os.Handler.dispatchMessage(Handler.java:100) at android.os.Looper.loop(Looper.java:214) at android.app.ActivityThread.main(ActivityThread.java:7403) at java.lang.reflect.Method.invoke(Native Method) at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:492) at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:935)


proceedWith(HttpStatement(requestBuilder, scope).execute().call)
} else {
throw e
}
}
} else {
context.headers.remove(LAST_DELAY_HEADER)
context.headers.remove(RETRY_COUNTER_HEADER)
proceed()
}

}
}

override fun prepare(block: Config.() -> Unit): HttpRetrySendFeature {
return Config().apply(block).build()
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ class TokenFeature private constructor(
override fun install(feature: TokenFeature, scope: HttpClient) {
scope.requestPipeline.intercept(HttpRequestPipeline.State) {
feature.tokenProvider.getToken()?.apply {
context.headers.remove(feature.tokenHeaderName)
context.header(feature.tokenHeaderName, this)
context.headers[feature.tokenHeaderName] = this
Copy link
Member

Choose a reason for hiding this comment

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

why this chaged?

Copy link
Author

Choose a reason for hiding this comment

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

Because it replace two operation(maybe more, search->get->delete-->add) to one(rewrite | write) => mini performance)

Copy link
Member

Choose a reason for hiding this comment

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

it was added because we have case when multiple tokens was sent

Copy link
Member

Choose a reason for hiding this comment

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

}
}
}
Expand Down