Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync: Fix bug in WooCommerce_HPOS_Orders::get_objects_by_id method #38192

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

fgiannar
Copy link
Contributor

@fgiannar fgiannar commented Jul 4, 2024

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: Replace include with post__in argument when fetching orders via wc_get_orders used in get_objects_by_id method.

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 2 orders

  • Enter wp shell

$hpos = new Automattic\Jetpack\Sync\Modules\WooCommerce_HPOS_Orders();
return $hpos->get_object_by_id( 'order', YOUR_ORDER_ID )
  • With the PR applied confirm you get a single order. Without the patch all existing orders will be returned

Copy link
Contributor

github-actions bot commented Jul 4, 2024

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

Copy link
Contributor

github-actions bot commented Jul 4, 2024

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 fgiannar requested review from darssen and a team July 4, 2024 08:41
@fgiannar fgiannar added [Status] Needs Team Review [Type] Bug When a feature is broken and / or not performing as intended and removed [Status] In Progress labels Jul 4, 2024
Copy link
Contributor

@darssen darssen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this.

This tests well after I used get_objects_by_id (note the 's' ) method which is the one being changed instead of get_object_by_id as specified in the instructions.

🚢

@fgiannar fgiannar merged commit 5a96755 into trunk Jul 4, 2024
77 of 78 checks passed
@fgiannar fgiannar deleted the fix/sync-hpos-get_objects_by_id branch July 4, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Sync [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants