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.

Sign up for GitHub

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

fix: await reconciliation bug #187

Merged
merged 3 commits into from
Nov 29, 2024
Merged

fix: await reconciliation bug #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c657f94
fix: await reconcilliation bug
nicklasl Nov 28, 2024
f8b8a1a
refactor: replace delay with async-await
nicklasl Nov 29, 2024
ae8f319
fixup! refactor: replace delay with async-await
nicklasl Nov 29, 2024
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
3 changes: 2 additions & 1 deletion Confidence/api/Confidence.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ public final class com/spotify/confidence/Confidence : com/spotify/confidence/Co
public final fun activate ()V
public final fun apply (Ljava/lang/String;Ljava/lang/String;)V
public final fun asyncFetch ()V
public final fun awaitReconciliation (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun awaitReconciliation (JLkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static synthetic fun awaitReconciliation$default (Lcom/spotify/confidence/Confidence;JLkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
public final fun fetchAndActivate (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun flush ()V
public fun getContext ()Ljava/util/Map;
Expand Down
30 changes: 26 additions & 4 deletions Confidence/src/main/java/com/spotify/confidence/Confidence.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.Job
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.TimeoutCancellationException
import kotlinx.coroutines.cancel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.launch
import kotlinx.coroutines.withTimeout
import kotlinx.coroutines.yield
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.encodeToJsonElement
Expand Down Expand Up @@ -60,11 +63,25 @@ class Confidence internal constructor(
}
}

suspend fun awaitReconciliation() {
if (currentFetchJob != null) {
suspend fun awaitReconciliation(timeoutMillis: Long = 5000) {
if (timeoutMillis <= 0) error("timeoutMillis need to be larger than 0")
debugLogger?.logMessage("reconciliation started")
yield() // will make sure that we respect other coroutine scopes triggered before this
Copy link
Member Author

Choose a reason for hiding this comment

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

This line is the actual fix. The rest is mainly just improvements.

withSafeTimeout(timeoutMillis) {
currentFetchJob?.join()
activate()
}
debugLogger?.logMessage("reconciliation completed")
}

private suspend fun withSafeTimeout(timeout: Long, block: suspend () -> Unit) {
try {
withTimeout(timeout) {
block()
}
} catch (e: TimeoutCancellationException) {
debugLogger?.logMessage("timed out after $timeout")
}
}

/**
Expand Down Expand Up @@ -238,7 +255,9 @@ class Confidence internal constructor(
* made available in the app session.
*/
fun asyncFetch() {
currentFetchJob?.cancel()
currentFetchJob?.cancel().also {
currentFetchJob = null
}
currentFetchJob = fetch()
}

Expand All @@ -249,7 +268,9 @@ class Confidence internal constructor(
* Fetching is best-effort, so no error is propagated. Errors can still be thrown if something goes wrong access data on disk.
*/
suspend fun fetchAndActivate() = kotlinx.coroutines.withContext(dispatcher) {
currentFetchJob?.cancel()
currentFetchJob?.cancel().also {
currentFetchJob = null
}
currentFetchJob = fetch()
currentFetchJob?.join()
activate()
Expand Down Expand Up @@ -337,6 +358,7 @@ object ConfidenceFactory {
clientSecret = clientSecret,
region = region,
httpClient = OkHttpClient.Builder()
.connectTimeout(timeoutMillis, TimeUnit.MILLISECONDS)
.callTimeout(timeoutMillis, TimeUnit.MILLISECONDS)
.build(),
dispatcher = dispatcher,
Expand Down
Loading