[Woo POS][Local Catalog] Full sync missing/overdue handling #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
Scheduling one-time, instant full sync in case the nightly full sync is overdue

⚠️ In case the full sync was never performed before, it should be obligatory before entering the POS. This will be added in the next PR: WOOMOB-1414.

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

Steps to reproduce

Testing information

Verify that WooPosLocalCatalogSyncWorker is being scheduled and completes when the app is opened, in case previous one was not done within last 24h.

The tests that have been performed

Above.

Images/gif

N/A

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

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

Codecov Report

❌ Patch coverage is 60.00000% with 76 lines in your changes missing coverage. Please review.
✅ Project coverage is 38.42%. Comparing base (36df697) to head (eba015c).
⚠️ Report is 5 commits behind head on trunk.

Files with missing lines	Patch %	Lines
...ocalcatalog/WooPosPerformInitialCatalogFullSync.kt	64.58%	29 Missing and 5 partials ⚠️
...os/util/datastore/WooPosSyncTimestampRepository.kt	0.00%	13 Missing ⚠️
...erce/android/ui/woopos/home/WooPosHomeViewModel.kt	50.00%	11 Missing and 1 partial ⚠️
...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 ⚠️
...n/kotlin/com/woocommerce/android/AppInitializer.kt	0.00%	2 Missing ⚠️
...mmerce/android/ui/woopos/home/WooPosHomeUIEvent.kt	0.00%	1 Missing ⚠️
.../woopos/localcatalog/WooPosFullSyncCheckUseCase.kt	97.14%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #14678      +/-   ##
============================================
+ Coverage     38.38%   38.42%   +0.03%     
- Complexity     9836     9854      +18     
============================================
  Files          2094     2096       +2     
  Lines        116801   116988     +187     
  Branches      15633    15667      +34     
============================================
+ Hits          44837    44950     +113     
- Misses        67801    67868      +67     
- Partials       4163     4170       +7

☔ 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 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

	1 Message
📖	This PR is still a Draft: some checks will be skipped.

Generated by 🚫 Danger

…overdue-handling # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/WooPosItemsScreen.kt

Copilot

Pull Request Overview

This PR enhances the reliability of POS local catalog full sync by implementing overdue handling. Previously, if a device was turned off during the scheduled nightly full sync, the sync could fail indefinitely. This change adds tracking and automatic recovery for overdue syncs.

Key changes:

Added timestamp tracking for full sync completion
Implemented overdue sync detection (24-hour threshold)
Added automatic background sync triggering when sync is overdue
Moved incremental sync from splash screen to POS home initialization

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
WooPosLocalCatalogStore.kt	Added product count method for catalog validation
WooPosProductsDao.kt	Added SQL query to count products in local database
WooPosSyncTimestampRepository.kt	Added methods to store and retrieve full sync completion timestamps
WooPosSyncTimestampManager.kt	Added wrapper methods for full sync timestamp management
WooPosPerformInitialCatalogFullSync.kt	New use case handling initial sync with overdue detection logic
WooPosFullSyncCheckUseCase.kt	New use case for checking and triggering overdue syncs on app start
WooPosLocalCatalogSyncWorker.kt	Updated to store completion timestamp after successful sync
WooPosSplashViewModel.kt	Removed incremental sync from splash screen initialization
WooPosHomeViewModel.kt	Added catalog sync state management and incremental sync triggering
WooPosHomeScreen.kt	Added sync overlay UI components for progress and error states
AppInitializer.kt	Added overdue sync check on app startup

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

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

Copilot · 2025-10-03T13:22:39Z

...ain/kotlin/com/woocommerce/android/ui/woopos/util/datastore/WooPosSyncTimestampRepository.kt

+    suspend fun getFullSyncLastCompletedTimestamp(): Long? {
+        val key = buildSiteSpecificKey(FULL_SYNC_TIMESTAMP_KEY)
+        return if (key != null) {
+            dataStore.data.first()[key]?.toLong()


The toLong() call can throw a NumberFormatException if the stored string is not a valid long. Consider using toLongOrNull() and handling the null case.

samiuelson · 2025-10-03T13:24:16Z

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

+        emit(WooPosFullSyncStatus.InProgress)
+
+        var workerStillRunning = true
+        while (workerStillRunning) {


💡 I'll investigate if it's possible to replace while with getWorkInfoById.

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

Merge branch 'trunk' into woomob-1412-woo-poslocal-catalog-full-sync-…

eba015c

…overdue-handling # Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/home/items/WooPosItemsScreen.kt

samiuelson requested a review from Copilot October 3, 2025 13:21

Copilot AI reviewed Oct 3, 2025

View reviewed changes

samiuelson commented Oct 3, 2025

View reviewed changes

samiuelson changed the title ~~[Woo POS][Local Catalog] Full sync overdue handling~~ [Woo POS][Local Catalog] Full sync missing/overdue handling Oct 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Woo POS][Local Catalog] Full sync missing/overdue handling #14678

[Woo POS][Local Catalog] Full sync missing/overdue handling #14678

Uh oh!

samiuelson commented Oct 2, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Oct 2, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Oct 2, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Oct 2, 2025 •

edited

Loading

Uh oh!

dangermattic commented Oct 3, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 3, 2025

Uh oh!

samiuelson Oct 3, 2025

Uh oh!

Uh oh!

[Woo POS][Local Catalog] Full sync missing/overdue handling #14678

Are you sure you want to change the base?

[Woo POS][Local Catalog] Full sync missing/overdue handling #14678

Uh oh!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

samiuelson Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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