WooCommerce Analytics: Fix duplicate product purchase events (#44973)

* Refactor event tracking in Universal class: update order processing hooks and improve capture_event_in_session_data method to accept event properties.

This enhances the accuracy of event data captured during checkout and cart actions.

* changelog

Author: chihsuan

projects/packages/woocommerce-analytics/changelog/fix-woo-analytics-product-purchase-event

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+Fix duplicate product purchase events on order confirmation page

projects/packages/woocommerce-analytics/src/class-universal.php

@@ -50,8 +50,9 @@ public function init_hooks() {
 		// Send events after checkout block.
 		add_action( 'woocommerce_blocks_enqueue_checkout_block_scripts_after', array( $this, 'checkout_process' ) );
 
-		// order confirmed.
-		add_action( 'woocommerce_thankyou', array( $this, 'order_process' ), 10, 1 );
+		// order processed.
+		add_action( 'woocommerce_checkout_order_processed', array( $this, 'order_process' ), 10, 1 );
+		add_action( 'woocommerce_store_api_checkout_order_processed', array( $this, 'order_process' ), 10, 1 );
 
 		add_filter( 'woocommerce_checkout_posted_data', array( $this, 'save_checkout_post_data' ), 10, 1 );
 
@@ -153,7 +154,7 @@ public function remove_from_cart() {
 	 */
 	public function capture_remove_from_cart( $cart_item_key, $cart ) {
 		$item = $cart->removed_cart_contents[ $cart_item_key ] ?? null;
-		$this->capture_event_in_session_data( (int) $item['product_id'], (int) $item['quantity'], 'woocommerceanalytics_remove_from_cart' );
+		$this->capture_event_in_session_data( 'woocommerceanalytics_remove_from_cart', (int) $item['product_id'], (int) $item['quantity'] );
 	}
 
 	/**
@@ -169,13 +170,13 @@ public function capture_remove_from_cart( $cart_item_key, $cart ) {
 	public function capture_cart_quantity_update( $cart_item_key, $quantity, $old_quantity, $cart ) {
 		$product_id = $cart->cart_contents[ $cart_item_key ]['product_id'];
 		if ( $quantity > $old_quantity ) {
-			$this->capture_event_in_session_data( $product_id, $quantity, 'woocommerceanalytics_add_to_cart' );
+			$this->capture_event_in_session_data( 'woocommerceanalytics_add_to_cart', $product_id, $quantity );
 			$this->lock_add_to_cart_events = true;
 			return;
 		}
 
 		if ( $quantity < $old_quantity ) {
-			$this->capture_event_in_session_data( $product_id, $quantity, 'woocommerceanalytics_remove_from_cart' );
+			$this->capture_event_in_session_data( 'woocommerceanalytics_remove_from_cart', $product_id, $quantity );
 			return;
 		}
 	}
@@ -291,12 +292,16 @@ public function checkout_process() {
 	}
 
 	/**
-	 * After the checkout process, fire an event for each item in the order
+	 * After the order processed, fire an event for each item in the order
 	 *
-	 * @param string $order_id Order Id.
+	 * @param string|WC_Order $order_id_or_order Order Id or Order object.
 	 */
-	public function order_process( $order_id ) {
-		$order = wc_get_order( $order_id );
+	public function order_process( $order_id_or_order ) {
+		if ( is_string( $order_id_or_order ) ) {
+			$order = wc_get_order( $order_id_or_order );
+		} else {
+			$order = $order_id_or_order;
+		}
 
 		if (
 			! $order
@@ -359,8 +364,11 @@ public function order_process( $order_id ) {
 			if ( is_array( $order_coupons ) ) {
 				$order_coupons_count = count( $order_coupons );
 			}
-			$this->record_event(
+
+			$this->capture_event_in_session_data(
 				'woocommerceanalytics_product_purchase',
+				$product_id,
+				$order_item->get_quantity(),
 				array(
 					'oi'                       => $order->get_order_number(),
 					'pq'                       => $order_item->get_quantity(),
@@ -379,8 +387,7 @@ public function order_process( $order_id ) {
 					'from_checkout'            => $checkout_page_used,
 					'checkout_page_contains_checkout_block' => $checkout_page_contains_checkout_block,
 					'checkout_page_contains_checkout_shortcode' => $checkout_page_contains_checkout_shortcode,
-				),
-				$product_id
+				)
 			);
 		}
 	}
@@ -455,23 +462,23 @@ public function capture_add_to_cart( $cart_item_key, $product_id, $quantity, $va
 		if ( $this->lock_add_to_cart_events ) {
 			return;
 		}
-		$this->capture_event_in_session_data( $product_id, $quantity, 'woocommerceanalytics_add_to_cart' );
+		$this->capture_event_in_session_data( 'woocommerceanalytics_add_to_cart', $product_id, $quantity );
 	}
 
 	/**
 	 * Track in-session data.
 	 *
+	 * @param string $event Fired event.
 	 * @param int    $product_id Product ID.
 	 * @param int    $quantity Quantity.
-	 * @param string $event Fired event.
+	 * @param array  $properties Event properties.
 	 */
-	public function capture_event_in_session_data( $product_id, $quantity, $event ) {
+	public function capture_event_in_session_data( $event, $product_id, $quantity, $properties = array() ) {
 
 		$product = wc_get_product( $product_id );
 		if ( ! $product instanceof WC_Product ) {
 			return;
 		}
-
 		$quantity = ( 0 === $quantity ) ? 1 : $quantity;
 
 		// check for existing data.
@@ -484,14 +491,21 @@ public function capture_event_in_session_data( $product_id, $quantity, $event )
 			$data = array();
 		}
 
+		$event_properties = array_merge(
+			array(
+				'quantity'     => (string) $quantity,
+				'session_id'   => $this->get_session_id(),
+				'landing_page' => $this->get_landing_page(),
+				'is_engaged'   => $this->is_engaged_session(),
+			),
+			$properties
+		);
+
 		// extract new event data.
 		$new_data = array(
-			'event'        => $event,
-			'product_id'   => (string) $product_id,
-			'quantity'     => (string) $quantity,
-			'session_id'   => $this->get_session_id(),
-			'landing_page' => $this->get_landing_page(),
-			'is_engaged'   => $this->is_engaged_session(),
+			'event'      => $event,
+			'product_id' => (string) $product_id,
+			'properties' => $event_properties,
 		);
 
 		// append new data.