Jetpack Sync HPOS: Ensure get_objects_by_id will return all relevant orders

[fgiannar]

Fixes a bug in WooCommerce_HPOS_Orders's get_objects_by_id method when querying orders via wc_get_orders.
We used to specify the order ids we need using include query argument, however this resulted in the later getting ignored and returning all orders instead.
This is fixed by replacing include with post__in as per the corresponding WP_Query docs that wc_get_orders uses under the hood.

Proposed changes:

• Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders: Add a limit argument set to -1 to ensure all requested orders will be returned when fetching orders via wc_get_orders used in get_objects_by_id method.
• Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders: Introduce get_all_possible_order_status_keys for fetching all the possible order statuses and use it in get_objects_by_id when fetching orders via wc_get_orders. This is needed because by default wc_get_orders will ignore draft and trash statuses since it uses WP_Query under the hood and WP_Query retrieves any status except for inherit, trash and auto-draft. Custom post statuses with exclude_from_search set to true are also excluded.

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:

Pre-requisites:

• A JP connected site with WooCommerce and Jetpack plugins active.

• At least 11 orders with all the possible statuses (see get_all_possible_order_status_keys)

• Enter wp shell

$hpos = new Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders();
return $hpos->get_objects_by_id( 'order', [ YOUR_ORDER_IDS ] )

• With the PR applied confirm you get all the requested orders. Without the PR, max 10 orders will be returned and the ones with auto-draft and trash statuses will be missing
• Bonus points for testing with a custom order status with exclude_from_search set to true and ensuring the corresponding order will be returned too.

[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 fix/sync-hpos-get_objects_by_id 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 fix/sync-hpos-get_objects_by_id
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/sync-hpos-get_objects_by_id
  

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 Added you as a reviewer mostly to confirm this is the recommended way to ensure we fetch all the orders, including the ones with trash and auto-draft statuses via wc_get_orders

[darssen]

When is wc_get_order_statuses not available?

[fgiannar]

When WooCommerce is not active I guess, but since it's an external function I think it's safer to check if it exists first before attempting to use it.

[darssen]

Code makes sense and tests as expected. 🚢

[vedanshujain]

LGTM, tested on my local with relevant code: