[Local Catalog] Filter trashed products #16361

joshheald · 2025-11-17T12:30:24Z

Merge after: #16353

Description

This PR ensures that trashed products are removed from POS after an incremental sync.

We already hide them if they're trashed when we do a full sync – because the API doesn't return them for a normal request. However, that works against us if they've been trashed when we do an incremental sync, because the newly-trashed product won't be returned for those requests either.

To resolve that, we do an extra request for any newly trashed products, and include those in the local database. When we've done that, we filter those products from all our queries.

Note that Variations can't be trashed, they just get deleted.

Test Steps

Set up a new product with a GTIN that you can scan with a barcode scanner

Ensure you've done a full sync
Trash a product in WP-Admin
Pull to refresh
Observe that product is no longer shown in the list
Scan the barcode
Observe that a Not found error is shown, same as for deleted products

Search isn't affected by this, as it doesn't use the local catalog yet.

Fully deleted products are still not removed by incremental sync, but will be by the next full sync. Without extensive backend work, this is unavoidable.

Screenshots

This shows:

View a product
Trash it
Pull to refresh
Scroll down – it's gone
Trash another product on the first page
Pull to refresh
Product is gone
Restore product
Pull to refresh
Product is back

trashed.products.mp4

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

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

…yncRemote 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

…arameter 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

- Add tests verifying include_status parameter is correctly added/omitted - Add test verifying status is included in _fields request parameter - Update MockPOSCatalogSyncRemote to support includeStatus parameter - Update test fixtures to include required statusKey field 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

- Add tests verifying both regular and trashed products are fetched - Add test ensuring same modifiedAfter date is used for both requests - Add test verifying includeStatus parameter values - Add tests for combined persistence of regular and trashed products - Add tests for edge cases (empty trash, only trash updates) - Enhance MockPOSCatalogSyncRemote to support separate trashed product results 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Replace non-thread-safe array append with actor-based IncludeStatusTracker to prevent EXC_BAD_ACCESS crash when concurrent requests modify the array. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add "status": "publish" to product fixtures that were missing the field, fixing decoding errors in POSCatalogSyncRemoteTests. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Wrap single product objects in {"data": [...]} envelope to match standard WooCommerce REST API response format expected by tests. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add statusKey field with default value "publish" to TestProduct struct to match updated PersistedProduct schema, fixing NOT NULL constraint errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

wpmobilebot · 2025-11-17T12:43:17Z

📲 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	`pr16361-9538e40`
	Version	`23.7`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`9538e40`
	Installation URL	489bq3lm85hpo

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

The catalog download parser decodes all items as POSProduct first before filtering by type, so variations also need the status field to avoid decoding errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

…hed-products

iamgabrielma

LGTM, just a comment about excluding private products

🚀

iamgabrielma · 2025-11-19T00:48:56Z

Modules/Sources/Storage/GRDB/Migrations/V001InitialSchema.swift

            productTable.column("stockQuantity", .double)
            productTable.column("stockStatusKey", .text).notNull()
+
+            productTable.column("statusKey", .text).notNull()


Just curious, with GRDB is as easy to update the model? Or we just happen to work with the initial schema so it's straight-forward?

Once it's released, we'll need to make new schemas and migrations for changes like this... that's the reason for the V001 in the name. It's still very lightweight to change.

During development, we delete the database when a schema change is detected and make it fresh. I guess we could even do that in production, but it risks someone having to do an extra full sync at an inconvenient time.

iamgabrielma · 2025-11-19T00:51:06Z

Modules/Sources/Storage/GRDB/Model/PersistedProduct.swift

    /// Returns a request for POS-supported products (simple and variable, non-downloadable) for a given site, ordered by name
+    /// Filters out products with trash, draft, pending, or private status to ensure only published and 3rd party custom status products are shown
    static func posProductsRequest(siteID: Int64) -> QueryInterfaceRequest<PersistedProduct> {
+        let excludedStatuses = [


Would make sense to import Networking here and use the raw values for ProductStatus rather than the string directly?

You can't import Networking from Storage as they're siblings

iamgabrielma · 2025-11-19T00:52:38Z

Modules/Sources/Storage/GRDB/Model/PersistedProduct.swift

+            "trash",
+            "draft",
+            "pending",
+            "private"


I'm not sure we want to exclude private products. While these are hidden from public view on the shop page and in search results, this is a web-based thing, for POS it would make sense to keep it included as the product is still visible to any logged-in user that is not a customer (admins, editors, etc, ... )

Great catch, thank you!

Modules/Sources/Yosemite/Tools/POS/POSCatalogIncrementalSyncService.swift

iamgabrielma · 2025-11-19T00:54:36Z

Modules/Tests/YosemiteTests/Tools/POS/POSCatalogIncrementalSyncServiceTests.swift

All the try await sut.startIncrementalSync(... in this file throw a warning since the result is unused, let's make them let _ = or discardableresult

Co-authored-by: Gabriel Maldonado <[email protected]>

joshheald and others added 18 commits November 14, 2025 16:21

Add trash status to ProductStatus enum

1b1896e

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add status field to POSProduct model

480aafd

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add statusKey column to product database schema

2f415d4

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Filter trashed/draft/pending/private products in POS catalog view

39ad0c5

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add support for fetching products with specific status in POSCatalogS…

5cef067

…yncRemote 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Fetch trashed products during incremental sync using modified_after p…

f410437

…arameter 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Prevent scanning trashed/draft/pending/private products via barcode

1b8ec6b

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Update generated files for POSProduct status field

6ab6187

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Include status in persisted product

330ad63

Add status field assertions in PersistedProductTests

7632001

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add trash filtering tests to PersistedProductTests

2b9e060

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add barcode scanning status validation tests

46f28b2

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add status field to JSON test fixtures

15f8e8e

Add "status": "publish" to product fixtures that were missing the field, fixing decoding errors in POSCatalogSyncRemoteTests. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

joshheald added this to the 23.8 milestone Nov 17, 2025

joshheald added type: task An internally driven task. feature: POS labels Nov 17, 2025

joshheald changed the base branch from trunk to issue/woomob-1686-local-catalog-handle-errors-from-order-creation-with November 17, 2025 12:31

Fix lint

574f15b

joshheald marked this pull request as ready for review November 17, 2025 13:46

Base automatically changed from issue/woomob-1686-local-catalog-handle-errors-from-order-creation-with to trunk November 18, 2025 14:37

Merge branch 'trunk' into issue/woomob-1493-local-catalog-filter-tras…

67581b6

…hed-products

joshheald requested a review from iamgabrielma November 18, 2025 14:43

iamgabrielma self-assigned this Nov 19, 2025

iamgabrielma approved these changes Nov 19, 2025

View reviewed changes

joshheald and others added 4 commits November 19, 2025 10:13

Use ProductStatus rawValue for status request

0683d96

Co-authored-by: Gabriel Maldonado <[email protected]>

Don’t filter out private products

da6db35

Resolve warnings when not using the resulting catalog

0a096fe

Fix line length

9538e40

joshheald enabled auto-merge November 19, 2025 17:27

joshheald merged commit 20876f1 into trunk Nov 19, 2025
14 checks passed

joshheald deleted the issue/woomob-1493-local-catalog-filter-trashed-products branch November 19, 2025 17:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Local Catalog] Filter trashed products #16361

[Local Catalog] Filter trashed products #16361

joshheald commented Nov 17, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Nov 17, 2025 •

edited

Loading

Uh oh!

iamgabrielma left a comment

Uh oh!

iamgabrielma Nov 19, 2025

Uh oh!

joshheald Nov 19, 2025

Uh oh!

iamgabrielma Nov 19, 2025

Uh oh!

joshheald Nov 19, 2025

Uh oh!

iamgabrielma Nov 19, 2025

Uh oh!

joshheald Nov 19, 2025

Uh oh!

Uh oh!

iamgabrielma Nov 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[Local Catalog] Filter trashed products #16361

[Local Catalog] Filter trashed products #16361

Conversation

joshheald commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test Steps

Screenshots

Uh oh!

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

Uh oh!

Uh oh!

iamgabrielma left a comment

Choose a reason for hiding this comment

Uh oh!

iamgabrielma Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

iamgabrielma Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

iamgabrielma Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

joshheald Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iamgabrielma Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joshheald commented Nov 17, 2025 •

edited

Loading

wpmobilebot commented Nov 17, 2025 •

edited

Loading