WooCommerce Analytics: Queue `add_to_cart` Events #9052

greenafrican · 2018-03-14T14:36:07Z

Fixes #9049

Changes proposed in this Pull Request:

move to queueing all add_to_cart events and logging on the next page
prevent duplicate product_view events from product page

Testing instructions:

click any add to cart button and look for event to be logged in the next page load
add a link to a post or page with href like http://exampleshop.com/?add-to-cart=${product_id}
make sure page view and cart event logged in next page load

Proposed changelog entry for your changes:

WooCommerce Analytics: Start tracking all possible ways to add a product to a cart

greenafrican · 2018-03-14T14:38:39Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+		 * @param $cart_item_data
+		 */
+		public function capture_add_to_cart( $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data ) {
+			if ( ! is_single() ) {


is_single() doesn't seem to work here so we always get a page_view even if we've already logged one on the single product page. Any ideas @psealock @timmyc ?

timmyc

Some quick comments, will run some further tests shortly and report back.

timmyc · 2018-03-15T16:08:31Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

-		);
+		// check for previous add-to-cart cart events
+		$data = WC()->session->get( 'wca_session_data' );
+		if ( !empty( $data ) ) {


minor but space between ! empty

timmyc · 2018-03-15T16:09:40Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

@@ -325,4 +303,89 @@ public function get_user_id() {
 		return 'null';
 	}

+	/**
+		 * @param $cart_item_key


Indentation is a little wonky right here.

timmyc · 2018-03-15T16:10:34Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+		public function capture_add_to_cart( $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data ) {
+			$referer_postid = isset( $_SERVER['HTTP_REFERER'] ) ? url_to_postid( $_SERVER['HTTP_REFERER'] ) : 0;
+			// if the referring post is not a product OR the product being added is not the same as post
+			// (eg. related product list on single product page) then include a product view event


Also noting from our convo today - how will this bit of logic respond to a quick add event from a product listing page?

Good point. It captures the add_to_cart action properly -- but it does also fire off a view which might not be accurate in this case.

yes, adding a product from the product page results in 2 product_views and one add-to-cart

if the referring post is not a product OR the product being added is not the same as post
(eg. related product list on single product page) then include a product view event

This is correct, and when I step through the code, this portion behaves as expected. Digging further, the extra page view is from the page refresh, and you can see that working in the master branch.

@greenafrican Since we are utilizing session, in capture_product_view we can check to see if a product_view is about to be dropped. This may depend on timing. Is it worth exploring?

Digging further, the extra page view is from the page refresh

Yes, I had an extra check to prevent these but removed it yesterday as it can cause other issues down the line. For example, if the user continues to add_to_cart we log all the additional add_to_cart events but no further product_views. It is not ideal/perfect as is but I'd rather there were a few extra product_views than have a situation where there can be more add_to_carts than product_views. The more I think about this the more I wonder if we don't need to move to reporting on uniques rather than simple counts.

how will this bit of logic respond to a quick add event from a product listing page?

@timmyc It will add both a product_view and an add_to_cart event, which is what we want.

It captures the add_to_cart action properly -- but it does also fire off a view which might not be accurate in this case.

@justinshreve My thoughts are that we do want the product_view here for 2 reasons: 1) we don't want a situation where we have more add_to_cart events than product_views in a funnel, 2) I feel as though, by clicking add_to_cart, the user has 'looked' at the product.

timmyc · 2018-03-15T16:11:01Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+
+	/**
+	 * @param $product_id
+	 * @param $qty


s/qty/quantity ?

timmyc · 2018-03-15T16:11:48Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+
+		// extract new event data
+		$new_data = array(
+			'event'     		=> $event,


spacing a bit off here too.

timmyc · 2018-03-15T16:29:53Z

/cc @justinshreve - would be keen to have you 👀 this PR if you have some time.

justinshreve

A few comments. Events seem to be firing correctly.

justinshreve · 2018-03-15T18:06:14Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+		$product_id,
+		$quantity,
+		$event,
+		$cart_item_key = '' ) {


Minor: I'm not a fan of having each argument on it's own line here.

justinshreve · 2018-03-15T18:06:47Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+
+		// check for existing data
+		$data = WC()->session->get( 'wca_session_data' );
+		if ( empty( $data ) || !is_array( $data ) ) {


Space between ! and is_array

justinshreve · 2018-03-15T18:07:45Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+	/**
+	 * Gets product categories or varation attributes as a formatted concatenated string
+	 *
+	 * @param array $product WC_Product.


$product is an object, not an array.

justinshreve · 2018-03-15T19:04:50Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+		public function capture_add_to_cart( $cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data ) {
+			$referer_postid = isset( $_SERVER['HTTP_REFERER'] ) ? url_to_postid( $_SERVER['HTTP_REFERER'] ) : 0;
+			// if the referring post is not a product OR the product being added is not the same as post
+			// (eg. related product list on single product page) then include a product view event


Good point. It captures the add_to_cart action properly -- but it does also fire off a view which might not be accurate in this case.

psealock · 2018-03-15T22:38:52Z

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

+		$product_id,
+		$quantity,
+		$event,
+		$cart_item_key = '' ) {


$cart_item_key is unused in this function

send product view events for products added to cart from any list or non-product detail page

…non-product detail page

timmyc · 2018-03-16T15:32:16Z

Any ideas why 88e8644 broke the build for this branch?

zinigor · 2018-03-16T16:42:36Z

It probably just needs a restart - I restarted two failed jobs, let's see what happens.

timmyc · 2018-03-16T18:57:16Z

Thanks @zinigor

greenafrican · 2018-03-20T14:02:52Z

Thanks for the reviews @timmyc @psealock @justinshreve

Fixes included in the latest squashed commit:

spaces between ! empty and ! array
indentation and spacing fixes
rename qty to quantity
moved arguments onto 1 line
documented $product as an object, not array
removed unused $cart_item_key

greenafrican · 2018-03-20T14:07:40Z

@jeherve Would you mind reviewing this PR, to be included in v5.9.1 if possible?

greenafrican · 2018-03-23T14:27:44Z

@psealock @timmyc @justinshreve would you mind doing another review of this?

psealock

Gave this another run through. Works as expected, didn't find anything odd.

@tiagonoronha

* Changelog 6.0: create base for changelog. * Add #8938 to changelog * Add #8962 to changelog * Add #8974 to changelog * Add #8975 to changelog * Add #8978 to changelog * Add #8867 to changelog * Add #8937 to changelog * Add #8961 to changelog * Add #8855 to changelog * Add #8944 to changelog * Add #8973 to changelog * Add #8977 to changelog * Add #8979 to changelog * Add #8980 to changelog * Add #8982 to changelog * Add #8983 to changelog * Add #8984 to changelog * Add #8986 to changelog * Add #9005 to changelog * Add #9010 to changelog * Add #9012 to changelog * Add #9021 to changelog * Add #9022 to changelog * Add #9056 to changelog * Add #9061 to changelog * Add #9079 to changelog * Add #9080 to changelog * Add #9088 to changelog * Add #9096 to changelog * Add #9097 to changelog * Add #9100 to changelog * Add #9107 to changelog * Add #8969 to changelog * Add #8993 to changelog * Add #9003 to changelog * Add #9031 to changelog * Add #8945 to changelog * Add #9052 to changelog * Add #9058 to changelog * Add #9066 to changelog * Add #9076 to changelog * Add #9053 to changelog * Add #9108 to changelog * Add #9135 to changelog * Add #9148 to changelog * Add #9125 to changelog * Add #9137 to changelog * Added testing instructions for 6.0. * Added IS testing instructions, huge props to @tiagonoronha. * Added #8498 to changelog. * Added #8954 to changelog. * Added #8985 to changelog. * add #9027 * add #9112 to changelog * add #9136 to changelog * add #9102 to changelog * add #9093 to changelog * add #9062 to changelog * add #9172 to changelog

greenafrican added [Type] Bug When a feature is broken and / or not performing as intended [Feature] WooCommerce Analytics labels Mar 14, 2018

greenafrican requested a review from psealock March 14, 2018 14:36

greenafrican requested a review from a team as a code owner March 14, 2018 14:36

greenafrican requested a review from timmyc March 14, 2018 14:36

greenafrican added the [Status] In Progress label Mar 14, 2018

greenafrican commented Mar 14, 2018

View reviewed changes

greenafrican changed the title ~~New wc session to queue cart events~~ WooCommerce Analytics: queue cart events Mar 14, 2018

greenafrican changed the title ~~WooCommerce Analytics: queue cart events~~ WooCommerce Analytics: Queue add_to_cart Events Mar 14, 2018

ghost removed the [Status] In Progress label Mar 15, 2018

greenafrican force-pushed the fix/missing-cart-events branch from 4793a0f to dacc670 Compare March 15, 2018 12:17

timmyc reviewed Mar 15, 2018

View reviewed changes

justinshreve reviewed Mar 15, 2018

View reviewed changes

psealock reviewed Mar 15, 2018

View reviewed changes

Robert Elliott added 2 commits March 16, 2018 11:32

use new wc session to queue events

003687b

send product view events for products added to cart from any list or non-product detail page

send product view events for products added to cart from any list or …

4ec0832

…non-product detail page

greenafrican force-pushed the fix/missing-cart-events branch from eefb048 to 4ec0832 Compare March 16, 2018 09:32

greenafrican mentioned this pull request Mar 16, 2018

WooCommerce Analytics: bring inline with PR in Jetpack for testing Automattic/wc-calypso-bridge#42

Closed

remove cart item key parameter

88e8644

zinigor added the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Mar 19, 2018

greenafrican requested a review from jeherve March 20, 2018 14:07

jeherve added this to the 6.0 milestone Mar 20, 2018

jeherve added the [Pri] High label Mar 20, 2018

psealock approved these changes Mar 25, 2018

View reviewed changes

zinigor approved these changes Mar 26, 2018

View reviewed changes

zinigor merged commit d876f73 into master Mar 26, 2018

matticbot added the [Status] Needs Changelog label Mar 26, 2018

ghost removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Mar 26, 2018

zinigor deleted the fix/missing-cart-events branch March 26, 2018 13:20

oskosk added [Status] Has Changelog and removed [Status] Needs Changelog labels Mar 26, 2018

oskosk added a commit that referenced this pull request Mar 26, 2018

Add #9052 to changelog

d5afee1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WooCommerce Analytics: Queue `add_to_cart` Events #9052

WooCommerce Analytics: Queue `add_to_cart` Events #9052

greenafrican commented Mar 14, 2018 •

edited by oskosk

Loading

greenafrican Mar 14, 2018

timmyc left a comment

timmyc Mar 15, 2018

timmyc Mar 15, 2018

timmyc Mar 15, 2018

justinshreve Mar 15, 2018

psealock Mar 15, 2018

greenafrican Mar 16, 2018

greenafrican Mar 16, 2018

timmyc Mar 15, 2018

timmyc Mar 15, 2018

timmyc commented Mar 15, 2018

justinshreve left a comment

justinshreve Mar 15, 2018

justinshreve Mar 15, 2018

justinshreve Mar 15, 2018

justinshreve Mar 15, 2018

psealock Mar 15, 2018

timmyc commented Mar 16, 2018

zinigor commented Mar 16, 2018

timmyc commented Mar 16, 2018

greenafrican commented Mar 20, 2018

greenafrican commented Mar 20, 2018

greenafrican commented Mar 23, 2018

psealock left a comment

WooCommerce Analytics: Queue add_to_cart Events #9052

WooCommerce Analytics: Queue add_to_cart Events #9052

Conversation

greenafrican commented Mar 14, 2018 • edited by oskosk Loading

Changes proposed in this Pull Request:

Testing instructions:

Proposed changelog entry for your changes:

Choose a reason for hiding this comment

timmyc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timmyc commented Mar 15, 2018

justinshreve left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timmyc commented Mar 16, 2018

zinigor commented Mar 16, 2018

timmyc commented Mar 16, 2018

greenafrican commented Mar 20, 2018

greenafrican commented Mar 20, 2018

greenafrican commented Mar 23, 2018

psealock left a comment

Choose a reason for hiding this comment

WooCommerce Analytics: Queue `add_to_cart` Events #9052

WooCommerce Analytics: Queue `add_to_cart` Events #9052

greenafrican commented Mar 14, 2018 •

edited by oskosk

Loading