[Woo POS][Local Catalog] Catalog full sync required #14678

samiuelson · 2025-10-02T11:01:19Z

Description

The goal of PR is to improve the reliability of the full sync of POS local catalog.
The full sync is scheduled to be performed every 24h, at night. However, in case the device was turned off at night, the sync may not succeed. To handle such case, this PR adds:

Keeping track of the last full sync timestamp
Checking if the last full sync is overdue (7 days)
Scheduling one-time, instant full sync in case the full sync was never done before, or data is missing (WooPosProductEntity is empty)

⚠️ Do not merge until the base branch is trunk.

Steps to reproduce

The full sync should be performed in a blocking way before allowing access to the POS for the first time (or in case product data is missing)

Testing information

Wipe the PosProductsEntity table and then verify that the full sync occurs when entering POS.

The tests that have been performed

Above.

Images/gif

Screen_recording_20251007_181723.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.

wpmobilebot · 2025-10-02T11:06:17Z

📲 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	`33cfa10`
	Direct Download	`woocommerce-wear-prototype-build-pr14678-33cfa10.apk`

wpmobilebot · 2025-10-02T11:18:47Z

📲 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	`33cfa10`
	Direct Download	`woocommerce-prototype-build-pr14678-33cfa10.apk`

codecov-commenter · 2025-10-02T12:15:26Z

Codecov Report

❌ Patch coverage is 28.87701% with 133 lines in your changes missing coverage. Please review.
✅ Project coverage is 38.26%. Comparing base (8956252) to head (3e747f4).

Files with missing lines	Patch %	Lines
...woopos/localcatalog/WooPosFullSyncStatusChecker.kt	4.44%	43 Missing ⚠️
...ocalcatalog/WooPosPerformInstantCatalogFullSync.kt	49.27%	33 Missing and 2 partials ⚠️
...erce/android/ui/woopos/home/WooPosHomeViewModel.kt	37.50%	19 Missing and 1 partial ⚠️
...os/util/datastore/WooPosSyncTimestampRepository.kt	0.00%	13 Missing ⚠️
...os/localcatalog/WooPosLocalCatalogSyncScheduler.kt	0.00%	8 Missing ⚠️
...commerce/android/ui/woopos/home/WooPosHomeState.kt	33.33%	6 Missing ⚠️
.../store/pos/localcatalog/WooPosLocalCatalogStore.kt	0.00%	4 Missing ⚠️
...oopos/util/datastore/WooPosSyncTimestampManager.kt	0.00%	3 Missing ⚠️
...mmerce/android/ui/woopos/home/WooPosHomeUIEvent.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #14678      +/-   ##
============================================
- Coverage     38.27%   38.26%   -0.02%     
- Complexity    10010    10018       +8     
============================================
  Files          2118     2120       +2     
  Lines        118488   118668     +180     
  Branches      15824    15849      +25     
============================================
+ Hits          45357    45410      +53     
- Misses        68917    69041     +124     
- Partials       4214     4217       +3

☔ 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.

…n-pos-splash' into woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling

dangermattic · 2025-10-03T07:22:56Z

	1 Error
🚫	This PR is tagged with `status: do not merge` label(s).

	1 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

malinajirka

Thanks for working on this @samiuelson!

I'm not entirely sure what is in scope of this PR and what is out of scope. I'll list issues I encountered, feel free to ignore those that are out of scope.

When we are doing an initial full sync, the blocking screen should be full screen (part of splash screen):

instead of the current:

I noticed that currently during the full sync, the blocking layer is semi-transparent, so I can see products already loaded below the loading state:

I can see loading skeletons during an incremental sync - the incremental sync shouldn't be visible to the user as it goes against the speed we are trying to achieve.

Screen.Recording.2025-10-08.at.8.16.52.mov

Not sure if it's an issue, but I can see the loading skeletons for 0.5seconds even when I turn off the feature flag even though we load the items during the splashscreen.
The POS is not accessible when there is no internet connection even though I have data in the database + I can see the data behind the error:

Let me know what you think.

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/WooPosHomeViewModel.kt

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

malinajirka · 2025-10-08T05:42:25Z

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

+    }
+
+    private fun isFullSyncOverdue(lastSyncTimestamp: Long): Boolean {
+        val currentTime = System.currentTimeMillis()


🔍 This code doesn't seem testable, we might want to inject time provider.

malinajirka · 2025-10-08T05:45:33Z

...kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosPerformInstantCatalogFullSync.kt

+        when (workInfo?.state) {
+            WorkInfo.State.SUCCEEDED -> {
+                val completedTimestamp = syncTimestampManager.getFullSyncLastCompletedTimestamp()
+                if (completedTimestamp != null) {


❓ How can this scenario happen?

@malinajirka 👋 Most common case I can think of - completedTimestamp can be null here, for example, in case the site was switched during full sync. The completedTimestamp would be null for the newly selected site, even though the worker would finish full sync with success for the previous site. WooPosSyncTimestampRepository handles values specific to the currently selected site.

This makes me think - maybe we should schedule sync workers with names unique to the currently selected site? This way we could make sure at POS splash screen, that the active worker is syncing data of the currently selected site. Wdyt, @malinajirka ?

@samiuelson I'm up for it, but it might not be trivial I think - the worker should likely be scheduled in app startup and the user might not be logged in yet. I'd be a bit worried we might end up in a situation where we have a bunch of workers waking up the device too often.

Makes sense. In that case, relying on getFullSyncLastCompletedTimestamp to verify if the completed sync was related to the currently selected store should be good enough, IMO.

malinajirka · 2025-10-08T05:57:32Z

...kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosPerformInstantCatalogFullSync.kt

+    private suspend fun FlowCollector<WooPosFullSyncState>.monitorOneTimeWorkerProgress() {
+        emit(WooPosFullSyncState.InProgress)
+
+        val finalWorkInfo = syncScheduler.observeOneTimeWorkInfo()


❓ It seems the worker as well as this code runs in a coroutine (not main thread) => are we guaranteed that between

val isOneTimeRunning = syncScheduler.observeOneTimeWorkStatus().first()

and

val finalWorkInfo = syncScheduler.observeOneTimeWorkInfo().filter { workInfo -> workInfo?.state?.isFinished == true } .first()

the worker doesn't finish? I'm not sure, but I have a gut feeling this code might lead to a deadlock.

I think we could fix it by completing this observer also when workInfo is null (aka if no work is in progress anymore). Wdyt?

Good catch. I tried improving it in 6190d97

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/WooPosHomeViewModel.kt

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

…overdue-handling Resolved conflicts: - WooPosLocalCatalogSyncWorker.kt: Combined timestamp storage with incremental sync - WooPosLocalCatalogSyncScheduler.kt: Merged all required coroutine imports Fixed compilation errors: - WooPosItemsScreen.kt: Updated to use WooPosErrorScreenButtonState instead of private Button component 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

…andling

samiuelson · 2025-10-16T13:07:06Z

When we are doing an initial full sync, the blocking screen should be full screen (part of splash screen):

I noticed that currently during the full sync, the blocking layer is semi-transparent, so I can see products already loaded below the loading state:

That was fixed 👍

I can see loading skeletons during an incremental sync - the incremental sync shouldn't be visible to the user as it goes against the speed we are trying to achieve.

Not sure if it's an issue, but I can see the loading skeletons for 0.5seconds even when I turn off the feature flag even though we load the items during the splashscreen.

Let me improve 3. and 4. in a separate PR, as this one grew too big—sorry for that, BTW! I created task for this: WOOMOB-1525

The POS is not accessible when there is no internet connection even though I have data in the database + I can see the data behind the error:

Good catch. This was fixed 👍

Thank you for the review, @malinajirka! I addressed your comments. Also, sorry for the long PR I failed to keep it within a limit.

Copilot

Pull Request Overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

...kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosPerformInstantCatalogFullSync.kt

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/splash/WooPosSplashScreen.kt

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/WooPosItemsScreen.kt

Co-authored-by: Copilot <[email protected]>

wpmobilebot · 2025-10-17T12:37:03Z

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

malinajirka

Thanks @samiuelson for iterating on the PR! I've reviewed the code and it all looks good to me. However, I've encountered a couple issues when testing the PR. I'd consider merging it as is and fixing the bugs in a separate PR, wdyt?

Infinite splash screen

Downgrade your site to WooCommerce 10.2 or older
Clean apps data
Login
Enter POS
Notice catalog is syncing -> notice /variations requests fail since the endpoint isn't available in v10.2 => the logs mention Worker result RETRY which isn't properly handled (it goes again into ENQUEUED state on Retry).

POS Opened with empty catalog

Clean apps data
Login
Turn off wifi/data
Open POS
Notice expected error
Tap on retry
Turn on wifi/data
Tap on retry
Notice you are allowed to enter POS before the initial sync completes.

My.Movie.mp4

malinajirka · 2025-10-18T16:59:54Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/splash/WooPosSplashViewModel.kt

+        startTime: Long
+    ) = FlowCollector<WooPosLocalCatalogInitialFullSyncState> { syncState ->
+        when (syncState) {
+            is WooPosLocalCatalogInitialFullSyncState.Ready -> {


🔍 np: I'd consider calling this NotRequired instead of Ready. At first I thought Ready means that the sync is about to start.

malinajirka · 2025-10-18T17:04:27Z

...-plugin/src/main/kotlin/org/wordpress/android/fluxc/persistence/dao/pos/WooPosProductsDao.kt

    abstract suspend fun getProduct(localSiteId: LocalId, remoteId: RemoteId): WooPosProductEntity?

+    @Query("SELECT COUNT(*) FROM PosProductEntity WHERE localSiteId = :localSiteId")
+    abstract suspend fun getProductCount(localSiteId: LocalId): Int


📓 I think this is fine for the current use case, but we need to be careful, since getProductCount returns count of all products including those which are not supported by the POS (hidden in the POS).

malinajirka · 2025-10-18T17:20:19Z

...rc/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFullSyncStatusChecker.kt

+            wooPosLogWrapper.e("Full sync check failed: No site selected")
+            return WooPosFullSyncRequirement.Error("No site selected")
+        }
+


💡 I'm wondering if we need to check isPeriodicSyncEnabledForSite here as well. Otherwise, this class might require sync while the worker always finishes with failure on line WooPosLocalCatalogSyncWorker::54. Wdyt?

P.S. Feel free to create a separate ticket.

samiuelson added 3 commits October 2, 2025 12:03

Allow storing last full sync timestamp

32eaa62

Store full sync timestamp

5aec9de

Check if full sync is overdue

df96e15

samiuelson changed the title ~~Woomob 1412 woo poslocal catalog full sync overdue handling~~ [Woo POS][Local Catalog] Full sync overdue handling Oct 2, 2025

Satisfy detekt's complaints

7dd0994

samiuelson added 2 commits October 2, 2025 18:28

Merge branch 'woomob-1405-woo-poslocal-catalog-run-incremental-sync-o…

170d746

…n-pos-splash' into woomob-1412-woo-poslocal-catalog-full-sync-overdue-handling

Clean up code

925d668

samiuelson added the type: task An internally driven task. label Oct 2, 2025

samiuelson added this to the 23.4 milestone Oct 2, 2025

samiuelson requested a review from kidinov October 2, 2025 16:42

samiuelson marked this pull request as ready for review October 2, 2025 16:43

Clean up code

f6edb88

samiuelson requested review from malinajirka and removed request for kidinov October 3, 2025 07:11

samiuelson added the status: do not merge Dependent on another PR, ready for review but not ready for merge. label Oct 3, 2025

malinajirka modified the milestones: 23.4, 23.5 Oct 3, 2025

Base automatically changed from woomob-1405-woo-poslocal-catalog-run-incremental-sync-on-pos-splash to trunk October 3, 2025 11:05

samiuelson marked this pull request as draft October 3, 2025 11:33

samiuelson removed the request for review from malinajirka October 3, 2025 11:33

samiuelson added 6 commits October 3, 2025 14:25

Add function to check if local catalog is empty

15df113

Add getProductCount method

144d9de

Execute one-time full sync if needed before opening POS

941672f

Remove incremental sync from POS splash

a9eac13

Update WooPosIncrementalSyncReason

06dd9b2

Update WooPosIncrementalSyncReason

2a2bab8

samiuelson added 2 commits October 7, 2025 18:24

Emit error in case site is null

fae6e2c

Remove comment

0977a06

samiuelson requested a review from malinajirka October 7, 2025 16:27

samiuelson marked this pull request as ready for review October 7, 2025 16:27

malinajirka self-assigned this Oct 8, 2025

malinajirka requested changes Oct 8, 2025

View reviewed changes

samiuelson marked this pull request as draft October 15, 2025 13:33

samiuelson and others added 7 commits October 15, 2025 15:45

Move initial full sync to splash screen

afed690

Clean up code

88fdeab

Allow entering POS with empty catalog

1bed6b0

Improve worker completion monitoring

6190d97

Merge trunk into woomob-1412-woo-poslocal-catalog-full-sync-overdue-h…

e4e7fe6

…andling

Add tests for WooPosFullSyncStatusCheckerTest

ec3a521

samiuelson marked this pull request as ready for review October 16, 2025 12:56

samiuelson requested a review from Copilot October 16, 2025 13:07

Copilot AI reviewed Oct 16, 2025

View reviewed changes

samiuelson and others added 5 commits October 16, 2025 15:26

Clean up code

fe6375a

Co-authored-by: Copilot <[email protected]>

Clean up code

984b76d

Clean up code

c3a3d32

Rename method

6169c46

Clean up code

33cfa10

samiuelson requested a review from malinajirka October 16, 2025 13:58

wpmobilebot modified the milestones: 23.5, 23.6 Oct 17, 2025

samiuelson marked this pull request as draft October 17, 2025 15:12

samiuelson marked this pull request as ready for review October 17, 2025 15:14

malinajirka approved these changes Oct 18, 2025

View reviewed changes

[Woo POS][Local Catalog] Catalog full sync required #14678

Are you sure you want to change the base?

[Woo POS][Local Catalog] Catalog full sync required #14678

Conversation

samiuelson commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Testing information

The tests that have been performed

Images/gif

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

codecov-commenter commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dangermattic commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

malinajirka left a comment • 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!

Uh oh!

Uh oh!

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!

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!

Uh oh!

Uh oh!

samiuelson commented Oct 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wpmobilebot commented Oct 17, 2025

Uh oh!

malinajirka left a comment

Choose a reason for hiding this comment

Infinite splash screen

POS Opened with empty catalog

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

samiuelson commented Oct 2, 2025 •

edited

Loading

wpmobilebot commented Oct 2, 2025 •

edited

Loading

wpmobilebot commented Oct 2, 2025 •

edited

Loading

codecov-commenter commented Oct 2, 2025 •

edited

Loading

dangermattic commented Oct 3, 2025 •

edited

Loading

malinajirka left a comment •

edited

Loading