WooCommerce Analytics: Fix duplicate product purchase events

[chihsuan]

Proposed changes:

Problem:

The woocommerceanalytics_product_purchase event is currently triggered every time a user refreshes the order confirmation page, due to its reliance on the woocommerce_thankyou hook. This causes duplicate events, which is problematic, especially when users open the order confirmation page in another device/browser since we use this event to track completed checkouts and calculate conversion rates accurately.

Solution:

This update resolves the issue by switching from the woocommerce_thankyou hook to the woocommerce_checkout_order_processed and woocommerce_store_api_checkout_order_processed hooks. These order processed hooks are triggered only once when the order is completed, ensuring the event is not duplicated on page refreshes.

Additionally, I have modified the capture_event_in_session_data method to accept event properties and to standardize the order of its parameters.

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)?

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

No, this PR does not change what data we track. It only fixes the timing and frequency of when the existing woocommerceanalytics_product_purchase events are triggered to prevent duplicates.

Testing instructions:

• Set up a WooCommerce store with Jetpack WooCommerce Analytics enabled
• In your WooCommerce admin, set up store so it's ready to accept orders
• Open your browser’s developer tools and go to the "Network" tab.
• Add products to cart and complete a purchase
• After completing the purchase, verify that the woocommerceanalytics_product_purchase event is recorded in the Network tab
• Refresh the order confirmation/thank you page multiple times
• Verify that woocommerceanalytics_product_purchase events are not recorded when refreshing the page

Note: You can also check the ClickHouse table to verify that the event is not recorded more than once.

[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 WoA dev 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 (Jetpack), and enable the fix/woo-analytics-product-purchase-event branch.
• To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/woo-analytics-product-purchase-event

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 Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ 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 🤖

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
3. You can use GitHub's Reviewers functionality to request a review.
4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

[jp-launch-control]

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/packages/woocommerce-analytics/src/class-universal.php	0/365 (0.00%)	0.00%	10 💔

Full summary · PHP report · JS report

_{Coverage check overridden by Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR .}

[chihsuan]

Ref:

https://github.com/woocommerce/woocommerce/blob/cb74293e687b585bf3dd0c958e3673b1ca8a81b2/plugins/woocommerce/includes/class-wc-checkout.php#L1352

https://github.com/woocommerce/woocommerce/blob/cb74293e687b585bf3dd0c958e3673b1ca8a81b2/plugins/woocommerce/src/StoreApi/Routes/V1/Checkout.php#L549

[kangzj]

Works as described 👍