Product Collection: disable "Sync with current query" option for 2nd+ block in product archive

[kmanijak]

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

There's a "Sync with current query" option available on Product Collection block (Product Catalog collection). Till now the option was enabled by default on product archives. This PR introduces the logic that the option is enabled ONLY IF there's no other Product Collection block that already syncs with query.
In other words, the rule of thumb is:

• first Product Collection (Product Catalog) on a page will get the option enabled by default
• second and next will get the option disabled.

Closes #44086

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

Scenario 1

1. Go to Product Catalog template
2. Add Product Collection (Beta) block
3. Choose "Featured" collection - this step is to make sure "other" collections don't influence the solution
4. Add Product Collection (Beta) block
5. Choose "Product Catalog" collection
6. Expected: Check inspector controls - "Sync with current query" should be ENABLED

6. Add Product Collection (Beta) block
7. Choose "Product Catalog" collection
8. Expected: Check inspector controls - "Sync with current query" should be DISABLED

Scenario 2

1. Go to Product Catalog template
2. Add Product Collection (Beta) block
3. Choose "Featured" collection - this step is to make sure "other" collections don't influence the solution
4. Add Product Collection (Beta) block
5. Choose "Product Catalog" collection
6. Expected: Check inspector controls - "Sync with current query" should be ENABLED
7. Disable the option
8. Add Product Collection (Beta) block
9. Choose "Product Catalog" collection
10. Expected: Check inspector controls - "Sync with current query" should be ENABLED because we disabled the option in previous one

Scenario 3

1. Create new post
2. Add Product Collection (Beta) block
3. Choose "Featured" collection
4. Add Product Collection (Beta) block
5. Choose "Product Catalog" collection
6. Expected: Check inspector controls - "Sync with current query" option is not available
7. Switch to Code Editor view (Three dots menu in top right corner of Editor -> Code Editor)

7. Search for "inherit" and make sure it's false

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Comment

[github-actions]

Hi @thealexandrelara,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[github-actions]

Test Results Summary

Commit SHA: ccaf4fc

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	300	0	0	40	0	340	8m 44s

---

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

[thealexandrelara]

Great work so far! I left two minor suggestions regarding the title of the tests. Here are the testing results:

⛔ Scenario 1: After adding the last Product Collection (Beta) block, the "Sync with current query" is not disabled:

CleanShot.2024-02-15.at.12.55.35.mp4

---

✅ Scenario 2: After adding the last Product Collection (Beta) block, the "Sync with current query" setting of the last added block is enabled.

CleanShot.2024-02-15.at.13.05.00.mp4

---

✅ Scenario 3: When I add the Product Collection (Beta) block to a new post, the ""Sync with current query" option is not available. If I switch to the Code Editor view, the "inherit" is set to false.

CleanShot.2024-02-15.at.13.06.51.mp4

[kmanijak]

@thealexandrelara , thanks for a review! I addressed minor comments 👍

⛔ Scenario 1: After adding the last Product Collection (Beta) block, the "Sync with current query" is not disabled:

TBH I can't reproduce it at all. Is there any chance the project didn't rebuild on your side? I'm asking because scenarios 2 and 3 are only regression scenarios, meaning they would pass on trunk as well and only scenario 1 is new feature covered in that PR. I'd be grateful for double-checking 🙏

[thealexandrelara]

@thealexandrelara , thanks for a review! I addressed minor comments 👍

⛔ Scenario 1: After adding the last Product Collection (Beta) block, the "Sync with current query" is not disabled:

TBH I can't reproduce it at all. Is there any chance the project didn't rebuild on your side? I'm asking because scenarios 2 and 3 are only regression scenarios, meaning they would pass on trunk as well and only scenario 1 is new feature covered in that PR. I'd be grateful for double-checking 🙏

I tried rebuilding or creating a JN site from this branch, but still getting the same results, unless I'm doing something wrong while testing or there is some requirement that I'm missing. I'm going to send the JN site credentials to you in private :)

[kmanijak]

I tried rebuilding or creating a JN site from this branch, but still getting the same results, unless I'm doing something wrong while testing or there is some requirement that I'm missing

@thealexandrelara , I tested adding blocks on a higher level, while you tested with nested blocks. I misread one selector documentation I didn't notice it wouldn't work for nested blocks. I revisited implementation. May I ask you for yet another review? 🙏

[thealexandrelara]

Great work! Thank you for addressing all the raised points. I just tested it and everything is working as expected. 🚀