Ensure the product category syncs properly between the Square and WooCommerce store #172

iamdharmesh · 2024-07-09T16:00:01Z

All Submissions:

Does your code follow the WooCommerce Sniffs variant of WordPress coding standards?
Have you written new tests for your changes, as applicable?
Have you successfully run tests with your changes locally?
Will this change require new documentation or changes to existing documentation?

Changes proposed in this Pull Request:

The PR fixes the category reverting issue reported in #156. This issue was introduced due to the Square SDK upgrade, which updated the Square API version. The update added support for multiple categories and deprecated the category_id field. As a result, retrieving the category ID failed, causing categories to revert to the default WooCommerce category during sync. The PR makes the necessary changes to get the category from the Square catalog item and sync it with the Woo store.

Since Square now supports multiple categories, the plugin first looks for the reporting category to import. If the reporting category is not set, it uses the first category from the categories array of the catalog item.

Note

The PR does not add support for syncing multiple categories; it fixes the issue with single category sync, ensuring it works as intended. Opened separate issue for adding support for sync multiple categories - [Sync] Add support for syncing multiple categories. #173
The newly added fields categories and reporting_category are still in BETA, but the previous category_id field has been removed from the API. Therefore, I have used the newly added fields as suggested in the documentation.

Closes #156

Steps to test the changes in this Pull Request:

Checkout to this PR branch.
Set up SOR to Square.
Import products by clicking on the "Import Products From Square" button.
Verify that the product category does not revert and continues syncing properly.
Test sync thoroughly for all fields (title, price, description, image, category, inventory, etc.) in all types of sync:
- Product Import
- Manual Sync
- Interval polling
Set up WooCommerce as the SOR.
Test sync thoroughly for all fields (title, price, description, image, category, inventory, etc.) in all types of sync:
- Product create/update in WooCommerce store
- Manual Sync
- Interval polling

Changelog entry

Fix - Ensure the product category syncs properly between the Square and WooCommerce store.

jeffpaul · 2024-07-10T15:34:03Z

tests/e2e/specs/c4.product-import.spec.js

-	const response = await createCatalogObject( 'Cap', 'cap', 1350, 'This is a very good cap, no cap.' );
+	const categoryResponse = await createCategory('Hats');
+	const categoryId = categoryResponse.catalog_object?.id || '';
+	const response = await createCatalogObject( 'Cap', 'cap', 1350, 'This is a very good cap, no cap.', categoryId );


I would like to tag @Sidsector9, the author of this creativity. 🤣

includes/Handlers/Category.php

includes/Sync/Product_Import.php

Co-authored-by: Darin Kotter <[email protected]>

qasumitbagthariya · 2024-07-11T10:48:49Z

QA Update ✅

I have checked this issue in the fix/156 branch and the related issue is resolved and working as expected.

I tested the following on this branch:

Test sync for all fields (title, price, description, image, category, inventory) in all types of sync:
Product Import
Manual Sync
Interval polling

Testing Environment

WordPress: 6.5.5
Theme: Storefront 4.6.0
Theme: Twenty Twenty-Four 1.1
WooCommerce - 9.0.2
PHP: 8.0.30
Web Server: Nginx 1.20.2
Browser: Chrome
OS: macOS Ventura 13.3

Screen.Recording.2024-07-11.at.3.06.25.PM.mov

Screen.Recording.2024-07-11.at.2.18.37.PM.mov

Screen.Recording.2024-07-11.at.1.54.07.PM.mov

Steps to Test- As mentioned in the PR description.
Test Results - It is working as expected.
Functional Demo / Screencast -
Special Notes - Ready for code review (Woo)
Testing Document status:
Cases related to this Issue/PR are added to the Critical Flow Wiki pages:

Yes
Not Required/Applicable for this PR

vikrampm1 · 2024-07-12T14:29:41Z

@diegocurbelo this PR is ready for your review.

diegocurbelo

Changes look good an tested well 🚢

qasumitbagthariya · 2024-07-26T17:05:48Z

Regression / Smoke Test Report ✅

Tested with Archive File created via "php woorelease.phar build repo_URL" (Composer version 2.5.5, npm version 10.7.0, node version 20.15.1)

Status- Working expected with Plugin Archive/Zip file same as fix specific branch.

Testing Environment

WordPress: 6.6.1
Theme: Twenty Twenty-Four 1.2
WooCommerce - 9.1.2
PHP: 8.0.30
Web Server: Nginx 1.20.2
Browser: Chrome
OS: macOS Ventura 13.3

Next Step- Ready to Merge 🚀

iamdharmesh added 2 commits July 9, 2024 17:44

Fix category override to default category issue (Square SOR).

cb22e78

Fix the category sync for the Woo SOR.

813a99c

iamdharmesh self-assigned this Jul 9, 2024

iamdharmesh added the needs: e2e testing label Jul 9, 2024

vikrampm1 added this to the 4.7.1 milestone Jul 9, 2024

iamdharmesh added 2 commits July 10, 2024 12:44

Add category and description sync check in E2E tests.

a0ad2ff

E2E : Validate category is imported to woo store during sync.

bbe39ca

iamdharmesh changed the title ~~[WIP] Ensure the product category syncs properly between the Square and WooCommerce store~~ Ensure the product category syncs properly between the Square and WooCommerce store Jul 10, 2024

iamdharmesh requested review from dkotter and Sidsector9 July 10, 2024 10:24

jeffpaul requested a review from qasumitbagthariya July 10, 2024 15:33

jeffpaul reviewed Jul 10, 2024

View reviewed changes

dkotter requested changes Jul 10, 2024

View reviewed changes

iamdharmesh and others added 2 commits July 11, 2024 11:13

Apply suggestions from code review

c7f8fb3

Co-authored-by: Darin Kotter <[email protected]>

Fix catalog category id spellings typo.

d8a37a9

iamdharmesh requested a review from dkotter July 11, 2024 05:51

qasumitbagthariya approved these changes Jul 11, 2024

View reviewed changes

qasumitbagthariya requested review from a team and diegocurbelo and removed request for a team July 11, 2024 10:50

dkotter approved these changes Jul 11, 2024

View reviewed changes

diegocurbelo approved these changes Jul 19, 2024

View reviewed changes

vikrampm1 modified the milestones: 4.7.1, 4.7.2 Jul 22, 2024

Merge branch 'trunk' into fix/156

34c66d2

vikrampm1 marked this pull request as ready for review July 26, 2024 17:26

vikrampm1 merged commit a2f39ee into trunk Jul 26, 2024
5 of 6 checks passed

vikrampm1 deleted the fix/156 branch July 26, 2024 17:27

vikrampm1 mentioned this pull request Jul 26, 2024

Release version 4.7.2 #189

Closed

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure the product category syncs properly between the Square and WooCommerce store #172

Ensure the product category syncs properly between the Square and WooCommerce store #172

iamdharmesh commented Jul 9, 2024 •

edited

Loading

jeffpaul Jul 10, 2024

iamdharmesh Jul 11, 2024

Sidsector9 Jul 11, 2024

qasumitbagthariya commented Jul 11, 2024 •

edited

Loading

vikrampm1 commented Jul 12, 2024

diegocurbelo left a comment

qasumitbagthariya commented Jul 26, 2024

Ensure the product category syncs properly between the Square and WooCommerce store #172

Ensure the product category syncs properly between the Square and WooCommerce store #172

Conversation

iamdharmesh commented Jul 9, 2024 • edited Loading

All Submissions:

Changes proposed in this Pull Request:

Steps to test the changes in this Pull Request:

Changelog entry

jeffpaul Jul 10, 2024

Choose a reason for hiding this comment

iamdharmesh Jul 11, 2024

Choose a reason for hiding this comment

Sidsector9 Jul 11, 2024

Choose a reason for hiding this comment

qasumitbagthariya commented Jul 11, 2024 • edited Loading

QA Update ✅

vikrampm1 commented Jul 12, 2024

diegocurbelo left a comment

Choose a reason for hiding this comment

qasumitbagthariya commented Jul 26, 2024

Regression / Smoke Test Report ✅

iamdharmesh commented Jul 9, 2024 •

edited

Loading

qasumitbagthariya commented Jul 11, 2024 •

edited

Loading