Skip to content

[WOOMOB-1949] Wire file-based sync action and use shared result type #15174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samiuelson merged 9 commits into from
Jan 12, 2026
Merged

[WOOMOB-1949] Wire file-based sync action and use shared result type #15174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a88751c
Remove fileUrl from the result
malinajirka Jan 7, 2026
f94c89d
Merge branch 'issue/woomob-1945-poslocal-catalog-switch-between-file-…
malinajirka Jan 7, 2026
dcd6f43
Refactor WooPosFileBasedSyncAction to use shared result type
malinajirka Jan 8, 2026
b9873d9
Wire WooPosFileBasedSyncAction when FF enabled
malinajirka Jan 8, 2026
da54348
Merge branch 'trunk' into issue/woomob-1949-poslocal-catalog-switch-b…
malinajirka Jan 8, 2026
59f2b7a
Merge branch 'issue/woomob-1945-poslocal-catalog-switch-between-file-…
malinajirka Jan 8, 2026
4191e47
Update WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/…
malinajirka Jan 8, 2026
50b0e03
Set last sync timestamps for file based sync
malinajirka Jan 8, 2026
f3424a8
Merge branch 'trunk' into issue/woomob-1949-poslocal-catalog-switch-b…
samiuelson Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 91 additions & 58 deletions ...c/main/kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosFileBasedSyncAction.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,44 @@ class WooPosFileBasedSyncAction @Inject constructor(
private const val MAX_POLL_INTERVAL_MS = 30_000L
private const val BACKOFF_MULTIPLIER = 1.3
}
sealed class WooPosFileBasedSyncResult {
data class Success(
val result: PosLocalCatalogSyncResult.Success,
val lastModifiedDate: String?
) : WooPosFileBasedSyncResult()

data class Failure(
val result: PosLocalCatalogSyncResult.Failure
) : WooPosFileBasedSyncResult()
}

suspend fun syncCatalog(
site: SiteModel
): Result<FileBasedSyncResult> {
logger.d("Starting file-based catalog generation for site ${site.id}")
suspend fun syncCatalog(site: SiteModel): WooPosFileBasedSyncResult {
val startTime = System.currentTimeMillis()
logger.d("WooPosFileBasedSyncAction: Starting file-based catalog generation for site ${site.id}")

var failedConsecutiveAttempts = 0

repeat(MAX_POLL_ATTEMPTS) { attemptCount ->
if (attemptCount > 0) {
val delayMs = computeBackoffDelay(attemptCount)
logger.d("Waiting ${delayMs}ms before poll attempt $attemptCount")
logger.d("WooPosFileBasedSyncAction: Waiting ${delayMs}ms before poll attempt $attemptCount")
delay(delayMs)
}

val response = posLocalCatalogStore.generateCatalogOrGetStatus(site)

if (response.isFailure) {
if (++failedConsecutiveAttempts >= MAX_CONSECUTIVE_FAILED_ATTEMPTS) {
return Result.failure(response.exceptionOrNull() ?: Exception("Unknown error"))
val error = response.exceptionOrNull()
logger.e(
"WooPosFileBasedSyncAction: File-based sync failed " +
"after $MAX_CONSECUTIVE_FAILED_ATTEMPTS consecutive failures"
)
return WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.NetworkError(
error?.message ?: "API error during catalog sync"
)
)
} else {
logger.w("Poll attempt $attemptCount failed: ${response.exceptionOrNull()?.message}")
return@repeat
Expand All @@ -51,99 +69,114 @@ class WooPosFileBasedSyncAction @Inject constructor(
failedConsecutiveAttempts = 0

val result = response.getOrThrow()
logger.d(
"Poll attempt $attemptCount"
)
logger.d("WooPosFileBasedSyncAction: Poll attempt $attemptCount")

val processedResult = processPollingResult(result, site)
val processedResult = processPollingResult(result, site, startTime = startTime)
if (processedResult != null) {
return processedResult
}
}

logger.e("Catalog generation timed out after $MAX_POLL_ATTEMPTS attempts")
return Result.failure(Exception("Catalog generation timed out"))
logger.e("WooPosFileBasedSyncAction: Catalog generation timed out after $MAX_POLL_ATTEMPTS attempts")
return WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.CatalogGenerationTimeout(
"Catalog generation is taking longer than expected."
)
)
}

data class FileBasedSyncResult(
val totalProducts: Int?,
val completedAt: String?,
val productsStored: Int,
val variationsStored: Int
)

private suspend fun processPollingResult(
result: WooPosGenerateCatalogResult,
site: SiteModel
): Result<FileBasedSyncResult>? {
site: SiteModel,
startTime: Long
): WooPosFileBasedSyncResult? {
return when (result.state) {
WooPosGenerateCatalogState.COMPLETED -> {
val url = result.url
if (url != null) {
logger.d("Catalog available, starting download.")

processDownloadAndStore(url, result, site)
if (result.url != null) {
logger.d("WooPosFileBasedSyncAction: Catalog available, starting download.")
processDownloadAndStore(result, site, startTime)
} else {
logger.e("Catalog generation completed but URL is missing")
Result.failure(Exception("Catalog generation completed but URL is missing"))
logger.e("WooPosFileBasedSyncAction: Catalog generation completed but URL is missing")
WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.InvalidResponse(
"Catalog generation completed but download URL is missing."
)
)
}
}

else -> null.also {
logger.d("State: ${result.state}, Progress: ${result.progress}% out of ${result.total} items")
logger.d(
"WooPosFileBasedSyncAction: State: ${result.state}, Progress: ${result.progress}% " +
"out of ${result.total} items"
)
}
}
}

@Suppress("ReturnCount")
private suspend fun processDownloadAndStore(
url: String,
catalogResult: WooPosGenerateCatalogResult,
site: SiteModel
): Result<FileBasedSyncResult> {
val downloadedFile = catalogFileDownloader.downloadCatalogFile(url, site.localId())
result: WooPosGenerateCatalogResult,
site: SiteModel,
startTime: Long
): WooPosFileBasedSyncResult {
val downloadedFile = catalogFileDownloader.downloadCatalogFile(result.url!!, site.localId())
.onFailureLog("Failed to download catalog file")
.getOrElse { return Result.failure(it) }
.getOrElse {
return WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.NetworkError(
it.message ?: "Failed to download catalog file"
)
)
}

val parsedData = catalogFileParser.parseCatalogFile(downloadedFile, site.localId())
.onFailureLog("Failed to parse catalog file")
.getOrElse { return Result.failure(it) }
.getOrElse {
return WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.InvalidResponse(
it.message ?: "Failed to parse catalog file"
)
)
}

posLocalCatalogStore.storeCatalogData(
localSiteId = site.localId(),
products = parsedData.products,
variations = parsedData.variations
).onFailureLog("Failed to store catalog data")
.getOrElse { return Result.failure(it) }
.getOrElse {
return WooPosFileBasedSyncResult.Failure(
PosLocalCatalogSyncResult.Failure.DatabaseError(
it.message ?: "Failed to store catalog data"
)
)
}

catalogFileDownloader.cleanupOldCatalogFiles(keepLatest = downloadedFile)

return Result.success(
createFileBasedSyncResult(
result = catalogResult,
productsStored = parsedData.products.size,
variationsStored = parsedData.variations.size
)
val syncDuration = System.currentTimeMillis() - startTime
logger.d(
"WooPosFileBasedSyncAction: File-based sync completed successfully. " +
"Products: ${parsedData.products.size}, Variations: ${parsedData.variations.size}. " +
"Duration: ${syncDuration}ms."
)

return WooPosFileBasedSyncResult.Success(
PosLocalCatalogSyncResult.Success(
productsSynced = parsedData.products.size,
variationsSynced = parsedData.variations.size,
syncDurationMs = syncDuration
),
// Using scheduledAt (not completedAt) to not miss changes made during generation
lastModifiedDate = result.scheduledAt
)
}

private fun <T> Result<T>.onFailureLog(context: String): Result<T> {
onFailure { logger.e("$context: ${it.message}") }
onFailure { logger.e("WooPosFileBasedSyncAction: $context: ${it.message}") }
return this
}

private fun createFileBasedSyncResult(
result: WooPosGenerateCatalogResult,
productsStored: Int,
variationsStored: Int
): FileBasedSyncResult {
return FileBasedSyncResult(
totalProducts = result.total,
completedAt = result.completedAt,
productsStored = productsStored,
variationsStored = variationsStored
)
}

private fun computeBackoffDelay(attemptCount: Int): Long {
val exponent = (attemptCount - 2).coerceAtLeast(0)
val raw = INITIAL_POLL_INTERVAL_MS * BACKOFF_MULTIPLIER.pow(exponent.toDouble())
Expand Down
33 changes: 27 additions & 6 deletions ...kotlin/com/woocommerce/android/ui/woopos/localcatalog/WooPosLocalCatalogSyncRepository.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import com.woocommerce.android.ui.woopos.util.analytics.WooPosAnalyticsTracker
import com.woocommerce.android.ui.woopos.util.datastore.WooPosPreferencesRepository
import com.woocommerce.android.ui.woopos.util.datastore.WooPosSyncTimestampManager
import com.woocommerce.android.util.CoroutineDispatchers
import com.woocommerce.android.util.FeatureFlag
import kotlinx.coroutines.withContext
import org.wordpress.android.fluxc.model.LocalOrRemoteId.LocalId
import org.wordpress.android.fluxc.model.SiteModel
Expand All @@ -21,6 +22,7 @@ import javax.inject.Singleton
@Singleton
class WooPosLocalCatalogSyncRepository @Inject constructor(
private val posSyncAction: WooPosSyncAction,
private val posFileBasedSyncAction: WooPosFileBasedSyncAction,
private val posCheckCatalogSizeAction: WooPosCheckCatalogSizeAction,
private val syncTimestampManager: WooPosSyncTimestampManager,
private val preferencesRepository: WooPosPreferencesRepository,
Expand All @@ -47,12 +49,16 @@ class WooPosLocalCatalogSyncRepository @Inject constructor(
)
)

return@withContext performSync(
site = site,
pageSize = PAGE_SIZE,
maxPages = MAX_PAGES_PER_FULL_SYNC,
maxTotalItems = MAX_TOTAL_ITEMS_FULL_SYNC
).also { result ->
return@withContext if (FeatureFlag.WOO_POS_LOCAL_CATALOG_FILE_APPROACH.isEnabled()) {
performFileBasedSync(site)
} else {
performSync(
site = site,
pageSize = PAGE_SIZE,
maxPages = MAX_PAGES_PER_FULL_SYNC,
maxTotalItems = MAX_TOTAL_ITEMS_FULL_SYNC
)
}.also { result ->
when (result) {
is PosLocalCatalogSyncResult.Success -> {
syncTimestampManager.storeFullSyncLastCompletedTimestamp(dateTimeProvider.now())
Expand Down Expand Up @@ -97,6 +103,21 @@ class WooPosLocalCatalogSyncRepository @Inject constructor(
}
}

private suspend fun performFileBasedSync(site: SiteModel): PosLocalCatalogSyncResult {
return when (val result = posFileBasedSyncAction.syncCatalog(site)) {
is WooPosFileBasedSyncAction.WooPosFileBasedSyncResult.Success -> result.result.also {
if (result.lastModifiedDate != null) {
syncTimestampManager.parseTimestampFromApi(result.lastModifiedDate)?.let { timestamp ->
syncTimestampManager.storeProductsLastSyncTimestamp(timestamp)
syncTimestampManager.storeVariationsLastSyncTimestamp(timestamp)
}
}
}

is WooPosFileBasedSyncAction.WooPosFileBasedSyncResult.Failure -> result.result
}
}

private suspend fun trackSyncCompleted(
site: SiteModel,
syncType: SyncType,
Expand Down
Loading