[POS - Historical Orders] In-memory Cache #14569
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,41 @@ | ||
| package com.woocommerce.android.ui.woopos.common.data | ||
|
|
||
| import com.woocommerce.android.model.Order | ||
| import com.woocommerce.android.ui.woopos.common.data.searchbyidentifier.WooPosOrdersCache | ||
| import com.woocommerce.android.ui.woopos.common.data.searchbyidentifier.WooPosOrdersCache.Companion.MAX_CACHE_SIZE | ||
| import kotlinx.coroutines.sync.Mutex | ||
| import kotlinx.coroutines.sync.withLock | ||
| import javax.inject.Inject | ||
|
|
||
| class WooPosOrdersInMemoryCache @Inject constructor() : WooPosOrdersCache { | ||
| private val mutex = Mutex() | ||
|
|
||
| companion object { | ||
| private const val INITIAL_CAPACITY = MAX_CACHE_SIZE | ||
|
||
| private const val LOAD_FACTOR = 0.75f | ||
| } | ||
|
|
||
| private val ordersCache = LinkedHashMap<Long, Order>(INITIAL_CAPACITY, LOAD_FACTOR, true) | ||
|
||
|
|
||
| override suspend fun addAll(orders: List<Order>) = mutex.withLock { | ||
|
||
| addAllInternal(orders) | ||
| } | ||
|
|
||
| override suspend fun getAll(): List<Order> = mutex.withLock { | ||
| ordersCache.values.toList() | ||
| } | ||
|
|
||
| override suspend fun clear() = mutex.withLock { | ||
| ordersCache.clear() | ||
| } | ||
|
|
||
| private fun addAllInternal(orders: List<Order>) { | ||
| orders.forEach { order -> | ||
| ordersCache[order.id] = order | ||
| if (ordersCache.size > MAX_CACHE_SIZE) { | ||
| val keysToRemove = ordersCache.keys.take(ordersCache.size - MAX_CACHE_SIZE) | ||
| keysToRemove.forEach { ordersCache.remove(it) } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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,15 @@ | ||
| package com.woocommerce.android.ui.woopos.common.data.searchbyidentifier | ||
|
|
||
| import com.woocommerce.android.model.Order | ||
|
|
||
| interface WooPosOrdersCache { | ||
|
||
| companion object { | ||
| const val MAX_CACHE_SIZE = 25 | ||
| } | ||
|
|
||
| suspend fun addAll(orders: List<Order>) | ||
|
|
||
| suspend fun getAll(): List<Order> | ||
|
|
||
| suspend fun clear() | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -14,11 +14,13 @@ import androidx.core.view.WindowInsetsCompat | |
| import com.woocommerce.android.ui.woopos.cardreader.WooPosCardReaderFacade | ||
| import com.woocommerce.android.ui.woopos.common.composeui.designsystem.WooPosSpacing | ||
| import com.woocommerce.android.ui.woopos.common.composeui.designsystem.WooPosTheme | ||
| import com.woocommerce.android.ui.woopos.common.data.searchbyidentifier.WooPosOrdersCache | ||
| import com.woocommerce.android.ui.woopos.home.items.coupons.creation.WooPosCouponCreationFacade | ||
| import com.woocommerce.android.ui.woopos.support.WooPosGetSupportFacade | ||
| import com.woocommerce.android.ui.woopos.util.analytics.WooPosAnalyticsTracker | ||
| import com.woocommerce.android.ui.woopos.util.ext.isGestureNavigation | ||
| import dagger.hilt.android.AndroidEntryPoint | ||
| import kotlinx.coroutines.runBlocking | ||
| import javax.inject.Inject | ||
|
|
||
| @AndroidEntryPoint | ||
|
|
@@ -35,6 +37,9 @@ class WooPosActivity : AppCompatActivity() { | |
| @Inject | ||
| lateinit var wooPosCouponCreationFacade: WooPosCouponCreationFacade | ||
|
|
||
| @Inject | ||
| lateinit var ordersCache: WooPosOrdersCache | ||
|
|
||
| override fun onCreate(savedInstanceState: Bundle?) { | ||
| super.onCreate(savedInstanceState) | ||
| WindowCompat.setDecorFitsSystemWindows(window, false) | ||
|
|
@@ -53,6 +58,13 @@ class WooPosActivity : AppCompatActivity() { | |
| } | ||
| } | ||
| } | ||
|
|
||
| override fun onDestroy() { | ||
| runBlocking { | ||
|
||
| ordersCache.clear() | ||
| } | ||
| super.onDestroy() | ||
| } | ||
| } | ||
|
|
||
| @Composable | ||
|
|
||
This file contains hidden or 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,119 @@ | ||
| package com.woocommerce.android.ui.woopos.common.data | ||
|
|
||
| import com.woocommerce.android.ui.orders.OrderTestUtils | ||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.async | ||
| import kotlinx.coroutines.awaitAll | ||
| import kotlinx.coroutines.test.runTest | ||
| import org.assertj.core.api.Assertions.assertThat | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
|
|
||
| @ExperimentalCoroutinesApi | ||
| class WooPosOrdersInMemoryCacheTest { | ||
|
|
||
| private lateinit var cache: WooPosOrdersInMemoryCache | ||
|
|
||
| @Before | ||
| fun setup() { | ||
| cache = WooPosOrdersInMemoryCache() | ||
| } | ||
|
|
||
| @Test | ||
| fun `when cache is empty, then getAll returns empty list`() = runTest { | ||
| // WHEN | ||
| val result = cache.getAll() | ||
|
|
||
| // THEN | ||
| assertThat(result).isEmpty() | ||
| } | ||
|
|
||
| @Test | ||
| fun `when orders are added, then getAll returns all orders`() = runTest { | ||
| // GIVEN | ||
| val orders = listOf(OrderTestUtils.generateTestOrder(1), OrderTestUtils.generateTestOrder(2)) | ||
|
|
||
| // WHEN | ||
| cache.addAll(orders) | ||
| val result = cache.getAll() | ||
|
|
||
| // THEN | ||
| assertThat(result).hasSize(2) | ||
| assertThat(result).containsExactlyInAnyOrderElementsOf(orders) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when cache is cleared, then getAll returns empty list`() = runTest { | ||
| // GIVEN | ||
| val orders = listOf(OrderTestUtils.generateTestOrder(1), OrderTestUtils.generateTestOrder(2)) | ||
| cache.addAll(orders) | ||
|
|
||
| // WHEN | ||
| cache.clear() | ||
| val result = cache.getAll() | ||
|
|
||
| // THEN | ||
| assertThat(result).isEmpty() | ||
| } | ||
|
|
||
| @Test | ||
| fun `when adding order with existing id, then it should replace old order`() = runTest { | ||
| // GIVEN | ||
| val order1 = OrderTestUtils.generateTestOrder(1) | ||
| val order1Updated = OrderTestUtils.generateTestOrder(1).copy(currency = "TEST") | ||
|
|
||
| // WHEN | ||
| cache.addAll(listOf(order1)) | ||
| cache.addAll(listOf(order1Updated)) | ||
| val result = cache.getAll().first { it.id == 1L } | ||
|
|
||
| // THEN | ||
| assertThat(result).isEqualTo(order1Updated) | ||
| assertThat(result.currency).isEqualTo("TEST") | ||
| } | ||
|
|
||
| @Test | ||
| fun `when adding more orders than max cache size, then oldest orders should be removed`() = runTest { | ||
| // GIVEN | ||
| val orders = (1..10005L).map { OrderTestUtils.generateTestOrder(it) } | ||
|
|
||
| // WHEN | ||
| cache.addAll(orders) | ||
| val firstOrder = cache.getAll().find { it.id == 1L } | ||
| val lastOrder = cache.getAll().find { it.id == 10005L } | ||
|
|
||
| // THEN | ||
| assertThat(firstOrder).isNull() | ||
| assertThat(lastOrder).isNotNull | ||
| assertThat(cache.getAll()).hasSize(25) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when multiple threads access cache concurrently, then data remains consistent`() = runTest { | ||
| // GIVEN | ||
| val initialOrders = (1..100L).map { OrderTestUtils.generateTestOrder(it) } | ||
| cache.addAll(initialOrders) | ||
|
|
||
| // WHEN - simulate concurrent access | ||
| val concurrentOperations = (101..200L).map { id -> | ||
| async { | ||
| val order = OrderTestUtils.generateTestOrder(id) | ||
| cache.addAll(listOf(order)) | ||
| cache.getAll().find { it.id == id } | ||
| } | ||
| } | ||
|
|
||
| // THEN | ||
| val results = concurrentOperations.awaitAll() | ||
| assertThat(results).hasSize(100) | ||
| assertThat(results).doesNotContainNull() | ||
|
|
||
| val allCachedOrders = cache.getAll() | ||
| // Only MAX_CACHE_SIZE should remain | ||
| assertThat(allCachedOrders).hasSize(25) | ||
|
|
||
| // The most recent 25 orders should be present | ||
| val expectedIds = (176L..200L).toList() | ||
| assertThat(allCachedOrders.map { it.id }).containsExactlyInAnyOrderElementsOf(expectedIds) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to place it into
woopos.orders. The product-related code here is because it's used in the list and the search.