Create Proxy Event Tracking Function to Add Site Kit as Source for All ICE Events about site-kit-wp

[aaemnnosttv]

FWIW, I think we should avoid using trackEvent as the name to avoid confusion with our internal function by the same name.

[tofumatt]

@benbowler I think it makes sense to add those here. I'll do that in the PR, it's not a big deal to include 🙂

EDIT: Never mind, they were included later 🙂

[tofumatt]

From the context/ACs here, would there be a separate, inline script if the user was using two ICE scripts (eg. using two ICE-supported plugins)?

Why output the script inline instead of having a single, common script file we build and include whenever any ICE JS script is used?

[10upsimon]

@tofumatt as per out comms offline, I think it makes sense to:

• Have this function be contained within it's own script that we will enqueue
• Register it as a dep of all singular plugin scripts
• Load it async
• Load all singular plugin tracking scripts async too

I'll update the AC accordingly.

[tofumatt]

Just one question really, when you say a “proxy function”, do you mean an actual JS Proxy? Or do you just mean that our scripts should include/reference the new trackEvent function and use it to send events?

If it’s the latter, the AC should specify that it should be available (on a Site Kit JS global I’d think).

If the former: why? 😅 Proxies when it’s just for our code seems odd. Maybe it’s just a wording thing that’s tripping me up here 😆

[10upsimon]

Just one question really, when you say a “proxy function”, do you mean an actual JS Proxy?

@tofumatt no no, not an actual proxy :) I simply meant a helper function that abstracts our calls to gtag when we track events. Yes, this should be defined against the global _googlesitekit or similar var, but that seems more like IB territory. I'll update the AC to reflect the above.

[tofumatt]

Sounds good, moving to IB 👍🏻

[10upsimon]

@zutigrm

• Update includes/Modules/Ads.php
  • In setup_assets method:
    • If conversionInfra feature flag is enabled instantiate new Script registering the above JS file and pushing it to the $assets array.
    • It should include 'execution' => 'async' in the arguments.

I do not think this is correct, as Conversion Tracking is not specific to the Ads module, and can be turned on from GA4 without the ads module active, and vice-versa.

I think it may be better to register this script from within the Conversion_Tracking class. WDYT?

[zutigrm]

@10upsimon Yes that makes more sense. Thanks. IB updated

[10upsimon]

Thanks @zutigrm IB ✅

[benbowler]

Flagging here that @eugene-manuilov doesn't update the tracking for MailChimp or Popup Maker as these weren't merged at the time this ticket was started.

Should we hold back this ticket and address that here when these two are merged or update those separately?

[mohitwp]

QA Update ⚠️

• Tested on dev environment.
• Verified Optin Monster, WP Forms, MailChimp, Popup Maker and WooCommerce plugin events.
• Verified that events tracked for WPForms OptIn Monster, Popup Maker, Mailchimp, and WooCommerce providers now tracked with _source: "site-kit".
• Verified when conversionInfra feature flag is enabled.
• Verified when Analytics is connected.
• Verified when both Analytics and ads module are connected.
• Verified when only Ads module is connected.

Note : As mentioned on #8553 (comment) for WooCommerce only 'add to cart' event is getting tracked.

@wpdarren I'm not able to test Contact Form 7 event on InstaWP and TasteWP due to same error. Can you please retest this on your live site ?

Optin monster

Submit lead form event tracked when only analytics is connected

When only Ad module is connected

WP Forms

When only Ads module is connected

When only Analytics is connected

MailChimp

When only Analytics is connected

When only Ads module is connected

Popup Maker

When only ads module is connected

When only Analytics is connected

WooCommerce -

Add to cart event tracked

[wpdarren]

@mohitwp yes, I can confirm that the source appears for the contact conversion event.

[mohitwp]

QA Update ✅

Thanks @wpdarren !

• Tested on dev environment.
• Verified Optin Monster, WP Forms, MailChimp, Popup Maker, Contact Form 7 and WooCommerce plugin events.
• Verified that events tracked for WPForms OptIn Monster, Popup Maker, Mailchimp, and WooCommerce providers now tracked with _source: "site-kit".
• Verified when conversionInfra feature flag is enabled.
• Verified when Analytics is connected.
• Verified when both Analytics and ads module are connected.
• Verified when only Ads module is connected.

Note : As mentioned on #8553 (comment) for WooCommerce only 'add to cart' event is getting tracked.

Optin monster

Submit lead form event tracked when only analytics is connected

When only Ad module is connected

WP Forms

When only Ads module is connected

When only Analytics is connected

MailChimp

When only Analytics is connected

When only Ads module is connected

Popup Maker

When only ads module is connected

When only Analytics is connected

WooCommerce -

Add to cart event tracked

[aaemnnosttv]

Noting that the source parameter may change but it is currently implemented as defined.

One thing from the AC

All existing plugin scripts of the listed supported plugins should be updated to be loaded async and include this new script as a dependency

All the provider scripts should be loaded using defer – async scripts can't have dependencies since the load order isn't guaranteed. There are still a few scripts loading async so these will need to be updated in a follow up.