-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
perf: improve in-memory cache [WPB-8645] (#2891)
* perf: improve in-memory cache Replaced the LRUCache with a new FlowCache implementation to optimize flow handling in memory caching. Updated corresponding cache usages across DAOs and tests to ensure compatibility and improved efficiency. * test: verify that cached flow is cancelled * docs: improve FlowCache documentation * style: remove unused import * ci: enable kvm * test: use same dispatcher for backup tests
- Loading branch information
1 parent
f534d36
commit 69d3227
Showing
11 changed files
with
268 additions
and
239 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
persistence/src/commonMain/kotlin/com/wire/kalium/persistence/cache/FlowCache.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* | ||
| * Wire | ||
| * Copyright (C) 2024 Wire Swiss GmbH | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see http://www.gnu.org/licenses/. | ||
| */ | ||
| package com.wire.kalium.persistence.cache | ||
|
|
||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.channels.BufferOverflow | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.SharingStarted | ||
| import kotlinx.coroutines.flow.buffer | ||
| import kotlinx.coroutines.flow.distinctUntilChanged | ||
| import kotlinx.coroutines.flow.onCompletion | ||
| import kotlinx.coroutines.flow.shareIn | ||
| import kotlinx.coroutines.sync.Mutex | ||
| import kotlinx.coroutines.sync.withLock | ||
| import kotlin.time.Duration | ||
| import kotlin.time.Duration.Companion.milliseconds | ||
|
|
||
| /** | ||
| * In-memory cache for sharing flows. | ||
| * This aims to bundle all interested collectors | ||
| * and read from a single upstream source, reducing IO reading. | ||
| * | ||
| * New collectors will get the latest value immediately. | ||
| * It converts produced flows into shared flows with a replay cache of 1. | ||
| * | ||
| * Each individual call to [get] will get its own buffer (size of 1), | ||
| * and oldest values are dropped if the collector is slow. | ||
| * | ||
| * Once the cached flows have no more collectors, the flows are removed from memory after [flowTimeoutDuration]. | ||
| * | ||
| * Once the [cacheScope] is canceled, the whole cache stops. | ||
| */ | ||
| internal class FlowCache<Key : Any, Value>( | ||
| private val cacheScope: CoroutineScope, | ||
| private val flowTimeoutDuration: Duration = FLOW_OBSERVING_TIMEOUT_IN_MILLIS.milliseconds, | ||
| ) { | ||
|
|
||
| private val mutex = Mutex() | ||
| private val storage = hashMapOf<Key, Flow<Value>>() | ||
|
|
||
| suspend fun get( | ||
| key: Key, | ||
| flowProducer: suspend (key: Key) -> Flow<Value> | ||
| ): Flow<Value> { | ||
| suspend fun createFlow() = flowProducer(key) | ||
| .onCompletion { | ||
| remove(key) | ||
| } | ||
| .shareIn( | ||
| scope = cacheScope, | ||
| started = SharingStarted.WhileSubscribed( | ||
| stopTimeoutMillis = flowTimeoutDuration.inWholeMilliseconds | ||
| ), | ||
| replay = 1 | ||
| ) | ||
|
|
||
| return mutex.withLock { | ||
| val result = storage.getOrPut(key) { | ||
| createFlow() | ||
| } | ||
| result | ||
| }.distinctUntilChanged() | ||
| .buffer( | ||
| capacity = 1, | ||
| onBufferOverflow = BufferOverflow.DROP_OLDEST | ||
| ) | ||
| } | ||
|
|
||
| suspend fun remove(key: Key) = mutex.withLock { | ||
| storage.remove(key) | ||
| } | ||
|
|
||
| companion object { | ||
| const val FLOW_OBSERVING_TIMEOUT_IN_MILLIS = 5_000L | ||
| } | ||
| } |
76 changes: 0 additions & 76 deletions
76
persistence/src/commonMain/kotlin/com/wire/kalium/persistence/cache/LRUCache.kt
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.