[Local Catalog] Add remote for products/variations incremental sync API #16033

jaclync · 2025-08-25T08:25:27Z

Description

Adds a new POSCatalogSyncRemote class to support incremental synchronization of POS catalog data. This enables merchants to efficiently sync only products and product variations that have been modified after a specific date, significantly reducing bandwidth usage and improving sync performance for large catalogs.

The implementation includes:

POSCatalogSyncRemote with protocol-based design for easy mocking in the future
loadProducts method with product type filtering and default values
loadProductVariations method for fetching variation data
- We are tentatively using an existing wc-analytics endpoint, and we will create a new endpoint with a WC path later
Reusable pagination helper extracted to Remote base class

This PR also includes a feature flag for Local Catalog i1.

Steps to reproduce

Just CI is sufficient as the remote isn't used in the app yet.

Testing information

I tested with

let products = try await syncRemote.loadProducts(modifiedAfter: .init().addingTimeInterval(-90000), siteID: siteID, pageNumber: 1)
let variations = try await syncRemote.loadProductVariations(
    modifiedAfter: .init().addingTimeInterval(-90000),
    siteID: siteID,
    pageNumber: 1
)
print("Synced \(products.items.count) products and \(variations.items.count) variations for siteID \(siteID)")

in the app to verify that the remote methods are working as expected.

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

…cts/variations.

wpmobilebot · 2025-08-25T08:34:32Z

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

	App Name	WooCommerce iOS Prototype
	Build Number	`pr16033-ae63cd3`
	Version	`23.1`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`ae63cd3`
	Installation URL	29dgs954jm168

Automatticians: You can use our internal self-serve MC tool to give yourself access to those builds if needed.

…t is used.

joshheald

Thanks Jaclyn, looks good 👍

joshheald · 2025-08-25T17:25:06Z

Modules/Sources/Networking/Remote/POSCatalogSyncRemote.swift

+    public func loadProducts(modifiedAfter: Date, siteID: Int64, productTypes: [ProductType] = [.simple, .variable], pageNumber: Int)
+    async throws -> PagedItems<POSProduct> {
+        let path = "products"
+        let dateFormatter = ISO8601DateFormatter()


Suggested change

let dateFormatter = ISO8601DateFormatter()

let dateFormatter = ISO8601DateFormatter()

Perhaps best to have this in a property? I think DateFormatter is reasonably expensive to create, and this could be called quite a few times.

Updated in b1f9850.

joshheald · 2025-08-25T17:25:27Z

Modules/Sources/Networking/Remote/POSCatalogSyncRemote.swift

+    ///   - pageNumber: Page number for pagination.
+    /// - Returns: Paginated list of POS products.
+    ///
+    // periphery:ignore - TODO - remove when this endpoint is integrated with catalog sync


Is the function marked for removal? Why...? I thought we'd need this all the way through?

Or is this just telling periphery to ignore the function and we'll remove that? Why do we need to ignore it if so?

Not the function, just the periphery ignore comment! The periphery:ignore comment is required now since it's not used in the app right now. I'll update the comment to avoid confusion.

Updatead in b0d5574.

joshheald · 2025-08-25T17:27:22Z

Modules/Sources/Networking/Remote/POSCatalogSyncRemote.swift

+        let dateFormatter = ISO8601DateFormatter()
+        let parameters = [
+            ParameterKey.modifiedAfter: dateFormatter.string(from: modifiedAfter),
+            ParameterKey.productTypes: productTypes.map { $0.rawValue }.joined(separator: ","),


We'll need to keep this under review, based on what we do with full sync. There are arguments to pull everything down, and filter on the client side... especially if that's easier to generate in the file.

Good point, right now the full sync does not support filtering on product types. I will remove this product types parameter for now.

Updated in ae63cd3.

joshheald · 2025-08-25T17:29:49Z

Modules/Sources/NetworkingCore/Remote/Remote.swift

+    func createPagedItems<T>(items: [T],
+                             responseHeaders: [String: String]?,
+                             currentPageNumber: Int) -> PagedItems<T> {
+        // Extract total pages from response headers (case insensitive)
+        let totalPages = responseHeaders?.first(where: {
+            $0.key.lowercased() == PaginationHeaderKey.totalPagesCount.lowercased()
+        }).flatMap { Int($0.value) }
+
+        let hasMorePages = totalPages.map { currentPageNumber < $0 } ?? true
+
+        // Extract total count from response headers (case insensitive)
+        let totalItems = responseHeaders?.first(where: {
+            $0.key.lowercased() == PaginationHeaderKey.totalCount.lowercased()
+        }).flatMap { Int($0.value) }
+
+        return PagedItems(items: items, hasMorePages: hasMorePages, totalItems: totalItems)
+    }


…ncremental sync, as product types filtering is not supported in full sync at least for now.

jaclync added 3 commits August 25, 2025 14:49

Add pointOfSaleLocalCatalogi1 feature flag.

cac41a7

Add POSCatalogSyncRemote with methods for incremental sync on produ…

ed0aedd

…cts/variations.

Use Remote.createPagedItems helper in products and variations remote.

d2a22d4

jaclync added the feature: POS label Aug 25, 2025

jaclync added this to the 23.2 milestone Aug 25, 2025

jaclync changed the title ~~Add POSCatalogSyncRemote for incremental sync API~~ [Local Catalog] Add remote for products/variations incremental sync API Aug 25, 2025

jaclync added 2 commits August 25, 2025 16:43

Delete unused POSCatalogSyncRemoteProtocol, will add it back when i…

75f7f38

…t is used.

Add periphery:ignore to remote methods that aren't used yet.

238e2e2

jaclync requested a review from joshheald August 25, 2025 10:16

joshheald approved these changes Aug 25, 2025

View reviewed changes

jaclync added 3 commits August 26, 2025 10:04

Move date formatter to a property.

b1f9850

Update periphery ignore comment to avoid confusion.

b0d5574

POSCatalogSyncRemote: remove productTypes parameter from products i…

ae63cd3

…ncremental sync, as product types filtering is not supported in full sync at least for now.

jaclync enabled auto-merge August 26, 2025 02:16

jaclync merged commit 46a5125 into trunk Aug 26, 2025
14 checks passed

jaclync deleted the feat/WOOMOB-1096-incremental-sync-remote branch August 26, 2025 02:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Local Catalog] Add remote for products/variations incremental sync API #16033

[Local Catalog] Add remote for products/variations incremental sync API #16033

Uh oh!

jaclync commented Aug 25, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Aug 25, 2025 •

edited

Loading

Uh oh!

joshheald left a comment

Uh oh!

joshheald Aug 25, 2025

Uh oh!

jaclync Aug 26, 2025

Uh oh!

joshheald Aug 25, 2025

Uh oh!

jaclync Aug 26, 2025 •

edited

Loading

Uh oh!

joshheald Aug 25, 2025

Uh oh!

jaclync Aug 26, 2025 •

edited

Loading

Uh oh!

joshheald Aug 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	let dateFormatter = ISO8601DateFormatter()
	let dateFormatter = ISO8601DateFormatter()

[Local Catalog] Add remote for products/variations incremental sync API #16033

[Local Catalog] Add remote for products/variations incremental sync API #16033

Uh oh!

Conversation

jaclync commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Testing information

Uh oh!

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

Uh oh!

Uh oh!

joshheald left a comment

Choose a reason for hiding this comment

Uh oh!

joshheald Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

jaclync Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

jaclync Aug 26, 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!

joshheald Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

jaclync Aug 26, 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!

joshheald Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jaclync commented Aug 25, 2025 •

edited

Loading

wpmobilebot commented Aug 25, 2025 •

edited

Loading

jaclync Aug 26, 2025 •

edited

Loading

jaclync Aug 26, 2025 •

edited

Loading