Add wc hpos backfill tool to backfill from/to either datastore

[jorgeatorres]

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:

This PR adds a new CLI tool wp hpos backfill that can be used to backfill orders from either the HPOS or CPT datastore, regardless of what the current datastore is.
This can be used to resolve situations where a given order has correct data in either table but the merchant can't change datastores or the sync process would overwrite other orders.

Closes #41909.

How to test the changes in this Pull Request:

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

1. Go to WC > Settings > Advanced > Features and make sure HPOS is set as datastore and compat mode is disabled.
2. If your site doesn't have any orders, create at least one in WC > Orders > Add order.
3. Open any order (in the admin) and take note of its ID.
4. Go to Custom Fields and add a custom field by specifying a name (say, <meta_key>) and value and clicking "Add Custom Field" or saving the order.
5. Confirm that the backup post doesn't have this metadata (since compat mode is disabled) by running wp post meta list <order_id> and confirming the list doesn't include this new meta / is empty.
6. Run wp wc hpos backfill <order_id> --from=hpos --to=posts.
7. Run wp post meta list <order_id> and confirm that now all the order metadata appears, including the metadata you manually added.
8. Directly modify the post metadata by running wp post meta update <order_id> <meta_key> <any_other_meta_value>.
9. Confirm that this metadata is not yet in the HPOS tables by re-opening this order in the admin and verifying that the Custom Fields metabox still lists the original value.
10. Run wp wc hpos backfill <order_id> --from=posts --to=hpos to backfill from posts to HPOS.
11. Refresh the order edit screen / re-open the order for editing in the admin, and confirm that the Custom Fields metabox now lists the metadata we manually added to the post (in step 8).

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]

Test Results Summary

Commit SHA: 3520f6d

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	318	0	0	3	0	321	7m 7s

---

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.

[github-actions]

Hi @Konamiman,

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

[Konamiman]

To be coherent with how multiple choice arguments are usually specified in the help of command line tools it could be:

--from={hpos|posts}

(angle brackets usually indicate non-literal values that need to be replaced, like in <order id>)

And the same with --to.

[jorgeatorres]

This actually got me thinking what the "correct" format should be. I agree with you that the braces seem to better indicate the options, but apparently WP-CLI expects arguments in a specific format (https://make.wordpress.org/cli/handbook/references/documentation-standards/#command-parameter-description) and so I changed the documentation to match that. This actually allows WP-CLI to validate args before the command runs.

I also made the --from and --to arguments mandatory with no default, to make things more explicit and prevent accidental overwriting of orders.

[Konamiman]

Looks good, I just added a couple of comments regarding the arguments syntax used in the command help.

[jorgeatorres]

Hey @Konamiman!

I've made some changes based on your feedback. Please take another look at your leisure! Thanks for the review!