[POS - Historical Orders] In-memory Cache #14569

toupper · 2025-09-04T10:16:35Z

Description

Closes WOOMOB-1145

With this PR, we add an in-memory cache when fetching the POS Orders. The cache content is removed when leaving POS.

Steps to reproduce

Open the app.
Navigate to POS.
Go to Orders.
Confirm that a loading state is shown while the orders are being fetched.
Once the orders are fetched, they are displayed.
Return to the POS home, then go back to Orders.
Confirm that cached orders are shown immediately (no loading state). Once the new fetch completes, the list refreshes.
Exit POS.
Open POS again and go to Orders.
Confirm that, since cached orders are cleared on exit, the loading state is shown first, followed by the fetched orders.

Testing information

Tested on Samsung Tab A8 Android 14

Images/gif

Screen_Recording_20250904_120742_Woo.Dev.mp4

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

…nto feat/WOOMOB-1145-pos-historical-orders-in-memory-cache # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModel.kt

…eat/WOOMOB-1145-pos-historical-orders-in-memory-cache # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt

…eat/WOOMOB-1145-pos-historical-orders-in-memory-cache # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModel.kt

…eat/WOOMOB-1145-pos-historical-orders-in-memory-cache

wpmobilebot · 2025-09-04T10:21:48Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`9720e3c`
	Direct Download	`woocommerce-wear-prototype-build-pr14569-9720e3c.apk`

wpmobilebot · 2025-09-04T10:35:34Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`9720e3c`
	Direct Download	`woocommerce-prototype-build-pr14569-9720e3c.apk`

...c/test/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCacheTest.kt

kidinov · 2025-09-05T12:15:11Z

...e/src/main/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCache.kt

+    private val mutex = Mutex()
+
+    companion object {
+        private const val INITIAL_CAPACITY = MAX_CACHE_SIZE


As the goal is to have this equal to the page size, I think we should reference the same constant used in WooPosOrdersDataSource and here.

Maybe adding const val ORDERS_PAGE_SIZE = 25 to WooPosOrdersDataSource.kt and then

private const val INITIAL_CAPACITY = ORDERS_PAGE_SIZE

?

kidinov · 2025-09-05T12:16:18Z

...e/src/main/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCache.kt

@@ -0,0 +1,41 @@
+package com.woocommerce.android.ui.woopos.common.data


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.

kidinov · 2025-09-05T12:19:21Z

...e/src/main/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCache.kt

+
+    private val ordersCache = LinkedHashMap<Long, Order>(INITIAL_CAPACITY, LOAD_FACTOR, true)
+
+    override suspend fun addAll(orders: List<Order>) = mutex.withLock {


As discussed on the call, this should probably be setAll that just replaces all you have in the cache with the new list.

kidinov · 2025-09-05T12:22:48Z

...e/src/main/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCache.kt

+        private const val LOAD_FACTOR = 0.75f
+    }
+
+    private val ordersCache = LinkedHashMap<Long, Order>(INITIAL_CAPACITY, LOAD_FACTOR, true)


Any specific reason to use hash map here? I think we can have just a list of orders here

kidinov · 2025-09-05T12:27:45Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/root/WooPosActivity.kt

    }
+
+    override fun onDestroy() {
+        runBlocking {


Not sure about that for 2 reasons:

You are blocking the main thread here

Overall, are you sure that we want to clean the cache here? Keep in mind that on Android, activity can be destroyed on configuration change. I wouldn't do that at all, especially since currently there are up to 25 orders in memory

Thanks for the comment @kidinov!

You are blocking the main thread here

If we do it asynchronously, we lose the reference to the cache, so we end up not deleting the cache.

Overall, are you sure that we want to clean the cache here? Keep in mind that on Android, activity can be destroyed on configuration change. I wouldn't do that at all, especially since currently there are up to 25 orders in memory

What other place would be more suitable for this action?

kidinov · 2025-09-05T12:28:59Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersViewModel.kt

+                        _state.update {
+                            it.copy(
+                                isLoading = false,
+                                error = result.message ?: "Unknown error"


Just keep in mind to not show this error to a user, as this won't be localized

Ah, and btw message is never null so ?: "Unknown error" not needed

Awesome, I removed it 👍

kidinov · 2025-09-05T12:30:28Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt

    }

-    private suspend fun List<OrderEntity>.toAppModels(): List<Order> = map {
+    private suspend fun List<OrderEntity>?.toAppModels(): List<Order> = this?.map {


I’m a bit confused about this change. I thought the list here was always non-nullable, right?

kidinov · 2025-09-05T12:38:50Z

...kotlin/com/woocommerce/android/ui/woopos/common/data/searchbyidentifier/WooPosOrdersCache.kt

+
+import com.woocommerce.android.model.Order
+
+interface WooPosOrdersCache {


np: I think we don't really need an interface here. For the products, it was introduced because we were planning to migrate to persistent storage; therefore, we declared one interface with potential for two implementations. Here, at least for now, there are no plans for that, so maybe keeping it simple would be easier.

kidinov

LGTM. I left a few comments; please take a look!

wpmobilebot · 2025-09-05T12:59:18Z

Version 23.2 has now entered code-freeze, so the milestone of this PR has been updated to 23.3.

codecov-commenter · 2025-09-05T14:52:42Z

Codecov Report

❌ Patch coverage is 48.71795% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 37.99%. Comparing base (13b352d) to head (9720e3c).
⚠️ Report is 245 commits behind head on trunk.

Files with missing lines	Patch %	Lines
.../android/ui/woopos/orders/WooPosOrdersViewModel.kt	0.00%	18 Missing ⚠️
.../android/ui/woopos/splash/WooPosSplashViewModel.kt	33.33%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##              trunk   #14569   +/-   ##
=========================================
  Coverage     37.99%   37.99%           
- Complexity     9450     9453    +3     
=========================================
  Files          2040     2041    +1     
  Lines        114311   114328   +17     
  Branches      15162    15162           
=========================================
+ Hits          43430    43443   +13     
- Misses        66900    66902    +2     
- Partials       3981     3983    +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

toupper added 13 commits August 29, 2025 11:09

First approach to cache

e1aab9d

Implement cache and use it in view model

3f9d131

Remove comments

a77834d

Show the cached content right away

659ad10

Clear cache when leaving POS

4a5f936

Add max size for orders cache

2bc7118

Add tests for cache

0a349b7

Bring data source back to the orders package

7f2acde

Merge branch 'feat/WOOMOB-1145-pos-historical-orders-fetching' into f…

d4d8169

…eat/WOOMOB-1145-pos-historical-orders-in-memory-cache # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/orders/WooPosOrdersDataSource.kt

Merge branch 'feat/WOOMOB-1145-pos-historical-orders-fetching' into f…

a8ef33d

…eat/WOOMOB-1145-pos-historical-orders-in-memory-cache

Fix test

96c3a09

toupper added this to the 23.2 milestone Sep 4, 2025

toupper requested a review from kidinov September 4, 2025 10:16

toupper added the type: task An internally driven task. label Sep 4, 2025

github-advanced-security bot found potential problems Sep 4, 2025

View reviewed changes

...c/test/kotlin/com/woocommerce/android/ui/woopos/common/data/WooPosOrdersInMemoryCacheTest.kt Fixed Show fixed Hide fixed

toupper added 4 commits September 4, 2025 16:47

Remove non necessary suspend

a57f5d7

Move file to its right package

333effb

Fix detekt

60d1cf9

fix lint and simplify test

69cc4dd

kidinov self-assigned this Sep 5, 2025

kidinov reviewed Sep 5, 2025

View reviewed changes

kidinov approved these changes Sep 5, 2025

View reviewed changes

wpmobilebot modified the milestones: 23.2, 23.3 Sep 5, 2025

toupper added 9 commits September 5, 2025 15:41

Improve POS Orders cache

e0e5325

Remove non necessary code

0cadb0c

Move file to its right package

fe798f6

Revert change

10c135c

Add unit test for clearing cache on splash screen

eab3bc7

Add test

1d91751

Simplify cache

02fa76f

Make cache a singleton

a57941c

Fallback string not necessary

9720e3c

toupper merged commit 08931bc into trunk Sep 5, 2025
17 checks passed

toupper deleted the feat/WOOMOB-1145-pos-historical-orders-in-memory-cache branch September 5, 2025 14:59

		@@ -0,0 +1,41 @@
		package com.woocommerce.android.ui.woopos.common.data


		private val ordersCache = LinkedHashMap<Long, Order>(INITIAL_CAPACITY, LOAD_FACTOR, true)

		override suspend fun addAll(orders: List<Order>) = mutex.withLock {


		import com.woocommerce.android.model.Order

		interface WooPosOrdersCache {

[POS - Historical Orders] In-memory Cache #14569

[POS - Historical Orders] In-memory Cache #14569

Uh oh!

Conversation

toupper commented Sep 4, 2025

Description

Steps to reproduce

Testing information

Images/gif

Uh oh!

wpmobilebot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

kidinov Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

toupper Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kidinov Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kidinov left a comment

Choose a reason for hiding this comment

Uh oh!

wpmobilebot commented Sep 5, 2025

Uh oh!

codecov-commenter commented Sep 5, 2025

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wpmobilebot commented Sep 4, 2025 •

edited

Loading

wpmobilebot commented Sep 4, 2025 •

edited

Loading

kidinov Sep 5, 2025 •

edited

Loading

toupper Sep 5, 2025 •

edited

Loading

kidinov Sep 5, 2025 •

edited

Loading