Jetpack Sync: Ensure HPOS order status is prefixed with 'wc-' before sending it to WPCOM

[fgiannar]

Jetpack Sync: Ensure HPOS order status is prefixed with wc- before sending it to WPCOM

This is needed so that when we insert custom order statuses in the corresponding wc_orders table on WPCOM, we get the proper wc- prefix. We are handling the issue in the Sync package end since wc_get_order_statuses is not available when the corresponding Sync action is processed.

Proposed changes:

• Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders: Introduce a wrapper for wc_get_order_statuses in case it's not present, but also to handle a bug in the WooCommerce codebase, since wc-checkout-draft is missing
• Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders: Update filter_order_data to prefix the order status with wc- when applicable before sending the order to WPCOM

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

p9dueE-8ec-p2

Does this pull request change what data or activity we track or use?

No

Testing instructions:

• Since get_objects_by_id is also affected it would be nice to repeat the test instructions from Jetpack Sync HPOS: Ensure get_objects_by_id will return all relevant orders #38251
• Add a custom order status with exclude_from_search set to true and ensure the corresponding order will be synced with the status prefixed with wc-.
• Ensure we are NOT adding the wc- prefix for auto-draft and trash orders

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/sync-hpos-add-wc-order-status-prefix branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack update/sync-hpos-add-wc-order-status-prefix
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sync-hpos-add-wc-order-status-prefix
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

[fgiannar]

@vedanshujain Just a confirmation if we should include draft here. In our discussion you mentioned that draft is a potential order status, however based on the Woo check upon setting the status, it looks like it's not.

[vedanshujain]

yeah, looks like we are actively changing draft to pending in case it is set. so this implementation looks good,

[darssen]

Tests well! 👍

[vedanshujain]

LGTM