Update how Cart/Checkout is tracked to be realtime. #35139

senadir · 2024-01-19T17:50:47Z

Proposed changes:

This PR changes how we're tracking Checkout block events. Instead of firing the event when Checkout loads, and assuming whatever is in the Checkout page is that, we now only react to Checkout events (shortcode and Block), and dynamically edit the checkout_page_contains_checkout_block and checkout_page_contains_checkout_shortcode values.

This is done by hooking into Checkout events.

This PR also adds a from_checkout prop to indicate if the event came from Checkout page or not.

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

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

Testing instructions:

Setup a new website That's running Checkout Block on the Checkout page. Install One Page Checkout, and mark a product a single page product.
Create a new page called Checkout Shortcode and add Shortcode Checkout to it.
Add a product to your cart, open track vigilante, and go to Checkout page (with Block), make sure the checkout_page_contains_checkout_block value is 1 and checkout_page_contains_checkout_shortcode is 0 on product_checkout event, make sure that from_checkout is 1.
Place the order, make sure the values are still correct in the product_purshase event.
Do the same from the one page checkout product page, make sure the values are reversed, so shortcode is 1 and block is 0, and that from_checkout is 0.
Do the same from the extra page you create and make sure the values are still correct.
Now change your default Checkout to shortcode, run the flow again the Checkout page and make sure the values are correct in both events.

github-actions · 2024-01-19T17:51:41Z

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 add/move-woo-event-tracking-frontend branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/move-woo-event-tracking-frontend

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 · 2024-01-19T17:51:45Z

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.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for March 5, 2024 (scheduled code freeze on March 4, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

...pack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php

senadir · 2024-02-01T16:19:15Z

@anomiex let us know that the failing E2E test above is happening to all issues and it shouldn't prevent us from merging given everything else is passing.

opr

As a logged-in user, in woocommerceanalytics_checkout_view and woocommerceanalytics_product_checkout events the guest_checkout property is Yes for me but in woocommerceanalytics_order_confirmation_view it becomes No.

In the testing instructions:

Do the same from the extra page you create and make sure the values are still correct.

Just noting that in this case woocommerceanalytics_checkout_view is showing the incorrect values. Only woocommerceanalytics_product_checkout and woocommerceanalytics_product_purchase are correct.

...pack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php

opr · 2024-01-22T15:00:09Z

...pack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php

+						}
+
+						const checkoutDataStore = wp.data.select( 'wc/store/checkout' );
+						if ( undefined !== checkoutDataStore && checkoutDataStore.getOrderId() !== 0 ) {


I would check if ( 'undefined' !== typeof checkoutDataStore && checkoutDataStore.getOrderId() !== 0 ) rather than using undefined for consistency with the above uses

This is outdated I think, because I already removed the checkoutDataStore check because we're subscribing to it so it's always there.

.../jetpack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-trait.php

.../modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-checkout-flow.php

senadir · 2024-02-07T15:46:21Z

@opr I addressed the review points, added tracking to the Checkout view event as well (while trying to keep it PHP only) and made sure the event triggers regardless (previously it required you to interact with Checkout for it to run, now it should run on mount).

senadir · 2024-02-07T15:47:06Z

.../modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-checkout-flow.php

@@ -147,18 +147,27 @@ public function capture_checkout_view() {
 		$is_checkout = $checkout_page_id && is_page( $checkout_page_id )
 		|| wc_post_content_has_shortcode( 'woocommerce_checkout' )
 		|| has_block( 'woocommerce/checkout', $post )
+		|| has_block( 'woocommerce/classic-shortcode', $post )


There is no way to check if the block is Cart or Checkout.

True, this is OK though. It's based on the template as far as I can tel. If someone has set up their Checkout page to use the Cart template then it will be an edge case, don't think we can or should try to solve for this.

opr

Happy to say this is testing OK for me, tried with several different configs and all seem to be fine for me.

🤞🏼

* Update how Cart/Checkout is tracked * add extra to see from checkout is coming * address changes

jjcoffee · 2024-03-25T11:04:03Z

...pack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php

+						if ( true === cartItem_{$cart_item_key}_logged ) {
+							return;
+						}
+						wp.hooks.addAction( 'wcpay.payment-request.availability', 'wcpay', function ( args ) {


wp.hooks is not guaranteed to be available. If it's not available, this blocks a lot of JS on the checkout from working, including coupons, "Click here to login", etc. See here.

Thanks for raising this @jjcoffee - I agree we should add a check to ensure it's available before using.

@jjcoffee - I have opened #36560 to solve this.

github-actions bot added [Feature] WooCommerce Analytics [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Jan 19, 2024

senadir marked this pull request as ready for review January 22, 2024 12:21

senadir self-assigned this Jan 22, 2024

senadir requested a review from opr January 22, 2024 12:21

senadir commented Jan 22, 2024

View reviewed changes

...pack/modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php Show resolved Hide resolved

senadir force-pushed the add/move-woo-event-tracking-frontend branch from 94f34bd to 509aebb Compare February 1, 2024 15:24

senadir requested review from opr and removed request for opr February 1, 2024 16:03

senadir mentioned this pull request Feb 2, 2024

Add tracking for Checkout Block additional fields #35418

Closed

3 tasks

opr requested changes Feb 2, 2024

View reviewed changes

senadir requested a review from opr February 7, 2024 15:45

senadir force-pushed the add/move-woo-event-tracking-frontend branch from 509aebb to 318f2a8 Compare February 7, 2024 15:45

senadir commented Feb 7, 2024

View reviewed changes

opr approved these changes Feb 8, 2024

View reviewed changes

senadir added 3 commits February 9, 2024 14:15

Update how Cart/Checkout is tracked

433b642

add extra to see from checkout is coming

8283994

address changes

5a8ca44

senadir force-pushed the add/move-woo-event-tracking-frontend branch from 318f2a8 to 5a8ca44 Compare February 9, 2024 13:15

senadir enabled auto-merge (squash) February 9, 2024 13:15

senadir merged commit 30544af into trunk Feb 9, 2024
52 checks passed

senadir deleted the add/move-woo-event-tracking-frontend branch February 9, 2024 13:26

github-actions bot removed the [Status] In Progress label Feb 9, 2024

github-actions bot added this to the jetpack/13.2 milestone Feb 9, 2024

spsiddarthan pushed a commit that referenced this pull request Feb 15, 2024

Update how Cart/Checkout is tracked to be realtime. (#35139)

91a7055

* Update how Cart/Checkout is tracked * add extra to see from checkout is coming * address changes

jeherve mentioned this pull request Feb 21, 2024

WooCommerce Analytics: require package in the Jetpack plugin #35758

Merged

3 tasks

jjcoffee reviewed Mar 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update how Cart/Checkout is tracked to be realtime. #35139

Update how Cart/Checkout is tracked to be realtime. #35139

senadir commented Jan 19, 2024 •

edited

Loading

github-actions bot commented Jan 19, 2024 •

edited

Loading

github-actions bot commented Jan 19, 2024 •

edited

Loading

senadir commented Feb 1, 2024

opr left a comment

opr Jan 22, 2024

senadir Feb 7, 2024

senadir commented Feb 7, 2024

senadir Feb 7, 2024

opr Feb 8, 2024

opr left a comment

jjcoffee Mar 25, 2024 •

edited

Loading

opr Mar 25, 2024 •

edited

Loading

opr Mar 25, 2024

Update how Cart/Checkout is tracked to be realtime. #35139

Update how Cart/Checkout is tracked to be realtime. #35139

Conversation

senadir commented Jan 19, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Jan 19, 2024 • edited Loading

github-actions bot commented Jan 19, 2024 • edited Loading

senadir commented Feb 1, 2024

opr left a comment

Choose a reason for hiding this comment

opr Jan 22, 2024

Choose a reason for hiding this comment

senadir Feb 7, 2024

Choose a reason for hiding this comment

senadir commented Feb 7, 2024

senadir Feb 7, 2024

Choose a reason for hiding this comment

opr Feb 8, 2024

Choose a reason for hiding this comment

opr left a comment

Choose a reason for hiding this comment

jjcoffee Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

opr Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

opr Mar 25, 2024

Choose a reason for hiding this comment

senadir commented Jan 19, 2024 •

edited

Loading

github-actions bot commented Jan 19, 2024 •

edited

Loading

github-actions bot commented Jan 19, 2024 •

edited

Loading

jjcoffee Mar 25, 2024 •

edited

Loading

opr Mar 25, 2024 •

edited

Loading