Integrate Web Worker Offloading with Google Site Kit #1686

westonruter · 2024-11-21T02:01:06Z

Depends on:

Output consent mode JS via wp_print_inline_script_tag() google/site-kit-wp#9726

Diff in page source when activating

--- wwo-disabled.html	2024-11-20 18:13:10.158395531 -0800
+++ wwo-enabled.html	2024-11-20 18:12:37.771394543 -0800
@@ -12,7 +12,7 @@

 	<meta name='robots' content='index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1' />
 	<!-- Google tag (gtag.js) Consent Mode dataLayer added by Site Kit -->
-	<script id="google_gtagjs-js-consent-mode-data-layer">
+	<script id="google_gtagjs-js-consent-mode-data-layer" type="text/partytown">
 		window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}
 		gtag('consent', 'default', {"ad_personalization":"denied","ad_storage":"denied","ad_user_data":"denied","analytics_storage":"denied","functionality_storage":"denied","security_storage":"denied","personalization_storage":"denied","region":["AT","BE","BG","CH","CY","CZ","DE","DK","EE","ES","FI","FR","GB","GR","HR","HU","IE","IS","IT","LI","LT","LU","LV","MT","NL","NO","PL","PT","RO","SE","SI","SK"],"wait_for_update":500});
 		window._googlesitekitConsentCategoryMap = {"statistics":["analytics_storage"],"marketing":["ad_storage","ad_user_data","ad_personalization"],"functional":["functionality_storage","security_storage"],"preferences":["personalization_storage"]};
@@ -198,11 +198,18 @@

 	</style>
 	<link rel='stylesheet' id='jetpack_css-css' href='https://example.com/wp-content/plugins/jetpack/css/jetpack.css?ver=13.8.1' media='all' />
+	<script id="web-worker-offloading-js-before">
+		window.partytown = {...(window.partytown || {}), ...{"lib":"\/wp-content\/plugins\/web-worker-offloading\/build\/","globalFns":["gtag"],"forward":["dataLayer.push"],"mainWindowAccessors":["_googlesitekitConsentCategoryMap","_googlesitekitConsents"]}};
+	</script>
+	<script id="web-worker-offloading-js-after">
+		/* Partytown 0.10.2-dev1727590485751 - MIT builder.io */
+		const t={preserveBehavior:!1},e=e=>{if("string"==typeof e)return[e,t];const[n,r=t]=e;return[n,{...t,...r}]},n=Object.freeze((()=>{const t=new Set;let e=[];do{Object.getOwnPropertyNames(e).forEach((n=>{"function"==typeof e[n]&&t.add(n)}))}while((e=Object.getPrototypeOf(e))!==Object.prototype);return Array.from(t)})());!function(t,r,o,i,a,s,c,d,l,p,u=t,f){function h(){f||(f=1,"/"==(c=(s.lib||"/~partytown/")+(s.debug?"debug/":""))[0]&&(l=r.querySelectorAll('script[type="text/partytown"]'),i!=t?i.dispatchEvent(new CustomEvent("pt1",{detail:t})):(d=setTimeout(v,999999999),r.addEventListener("pt0",w),a?y(1):o.serviceWorker?o.serviceWorker.register(c+(s.swPath||"partytown-sw.js"),{scope:c}).then((function(t){t.active?y():t.installing&&t.installing.addEventListener("statechange",(function(t){"activated"==t.target.state&&y()}))}),console.error):v())))}function y(e){p=r.createElement(e?"script":"iframe"),t._pttab=Date.now(),e||(p.style.display="block",p.style.width="0",p.style.height="0",p.style.border="0",p.style.visibility="hidden",p.setAttribute("aria-hidden",!0)),p.src=c+"partytown-"+(e?"atomics.js?v=0.10.2-dev1727590485751":"sandbox-sw.html?"+t._pttab),r.querySelector(s.sandboxParent||"body").appendChild(p)}function v(n,o){for(w(),i==t&&(s.forward||[]).map((function(n){const[r]=e(n);delete t[r.split(".")[0]]})),n=0;n<l.length;n++)(o=r.createElement("script")).innerHTML=l[n].innerHTML,o.nonce=s.nonce,r.head.appendChild(o);p&&p.parentNode.removeChild(p)}function w(){clearTimeout(d)}s=t.partytown||{},i==t&&(s.forward||[]).map((function(r){const[o,{preserveBehavior:i}]=e(r);u=t,o.split(".").map((function(e,r,o){var a;u=u[o[r]]=r+1<o.length?u[o[r]]||(a=o[r+1],n.includes(a)?[]:{}):(()=>{let e=null;if(i){const{methodOrProperty:n,thisObject:r}=((t,e)=>{let n=t;for(let t=0;t<e.length-1;t+=1)n=n[e[t]];return{thisObject:n,methodOrProperty:e.length>0?n[e[e.length-1]]:void 0}})(t,o);"function"==typeof n&&(e=(...t)=>n.apply(r,...t))}return function(){let n;return e&&(n=e(arguments)),(t._ptf=t._ptf||[]).push(o,arguments),n}})()}))})),"complete"==r.readyState?h():(t.addEventListener("DOMContentLoaded",h),t.addEventListener("load",h))}(window,document,navigator,top,window.crossOriginIsolated);
+	</script>
 	<script src="https://example.com/wp-content/themes/twentytwenty/assets/js/index.js?ver=2.7" id="twentytwenty-js-js" defer data-wp-strategy="defer"></script>

 	<!-- Google tag (gtag.js) snippet added by Site Kit -->
-	<script src="https://www.googletagmanager.com/gtag/js?id=GT-1234567" id="google_gtagjs-js" async></script>
-	<script id="google_gtagjs-js-after">
+	<script type="text/partytown" src="https://www.googletagmanager.com/gtag/js?id=GT-1234567" id="google_gtagjs-js" async></script>
+	<script id="google_gtagjs-js-after" type="text/partytown">
 		window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}
 		gtag("js", new Date());
 		gtag("set", "developer_id.dZTNiMT", true);
@@ -225,6 +232,7 @@
 	<meta name="apple-mobile-web-app-title" content="Weston Ruter">
 	<meta name="application-name" content="Weston Ruter">
 	<!-- Stream WordPress user activity plugin v4.0.2 -->
+	<meta name="generator" content="web-worker-offloading 0.1.1">
 	<meta name="generator" content="webp-uploads 2.2.0">
 	<script>document.documentElement.className = document.documentElement.className.replace( 'no-js', 'js' );</script>
 	<meta name="generator" content="image-prioritizer 0.1.4">

westonruter · 2024-11-21T02:35:38Z

plugins/web-worker-offloading/third-party/google-site-kit.php

+plwwo_mark_scripts_for_offloading(
+	array(
+		'google_gtagjs',
+		'googlesitekit-consent-mode',


I don't know how the Consent Mode is supposed to work, especially as it relates to the WP Consent API plugin. On my test site I didn't get any consent banner even without WWO active, so I don't know what to look for to see if it is working as expected.

you may need to have this plugin installed? https://wordpress.org/plugins/wp-consent-api/

cc: @aaemnnosttv ^^

westonruter · 2024-12-02T16:45:15Z

@joemcgill @aaemnnosttv If someone from the Site Kit team could test that this is working as expected with a pre-release version of Site Kit, that would be very helpful.

westonruter · 2024-12-02T16:46:48Z

Build for testing: web-worker-offloading.zip

github-actions · 2024-12-13T18:08:43Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <[email protected]>
Co-authored-by: adamsilverstein <[email protected]>
Co-authored-by: aaemnnosttv <[email protected]>
Co-authored-by: gutobenn <[email protected]>
Co-authored-by: oxyc <[email protected]>
Co-authored-by: felixarntz <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

plugins/web-worker-offloading/third-party/google-site-kit.php

westonruter · 2024-12-13T19:18:23Z

Updated build for testing which includes additional compatibility with the WP Consent API: web-worker-offloading.zip

plugins/web-worker-offloading/third-party/google-site-kit.php

adamsilverstein

Looks good, left some small feedback.

aaemnnosttv · 2024-12-13T21:18:08Z

@westonruter I gave this a few tests using the latest test build (#1686 (comment)) as well and it seemed to work as expected. However, on closer inspection, it seems there may be an issue with inline scripts as the inline script that accompanies the Google tag doesn't seem to be running (e.g. window.gtag is undefined).

Co-authored-by: Adam Silverstein <[email protected]>

westonruter · 2024-12-13T21:22:08Z

@aaemnnosttv Is this anywhere I can test?

westonruter · 2024-12-13T22:26:34Z

Another build for testing: web-worker-offloading.zip

westonruter · 2024-12-13T22:31:44Z

plugins/web-worker-offloading/third-party/seo-by-rank-math.php

+
+	// Expose on the main tread. See <https://partytown.builder.io/forwarding-event>.
+	$configuration['forward'][] = 'dataLayer.push';
+	$configuration['forward'][] = 'gtag';


The addition here means that scripts in the main thread will now be able to call gtag() whereas previously it was only available to other scripts offloaded to a worker.

westonruter · 2024-12-13T22:32:05Z

plugins/web-worker-offloading/third-party/woocommerce.php

+
+	// Expose on the main tread. See <https://partytown.builder.io/forwarding-event>.
+	$configuration['forward'][] = 'dataLayer.push';
+	$configuration['forward'][] = 'gtag';


The addition of this line here means that scripts in the main thread will now be able to call gtag() whereas previously it was only available to other scripts offloaded to a worker.

I can confirm this works now 👍

aaemnnosttv · 2024-12-13T22:59:12Z

With the recent updates here and my understanding of the expectations, this seems to be working as expected 👍

adamsilverstein

Tremendous 🎉

Integrate WWO with Site Kit

5670047

westonruter added [Type] Enhancement A suggestion for improvement of an existing feature [Plugin] Web Worker Offloading Issues for the Web Worker Offloading plugin. labels Nov 21, 2024

westonruter added this to the web-worker-offloading n.e.x.t milestone Nov 21, 2024

Integrate with Site Kit's consent mode

c62e6a4

westonruter added the blocked label Nov 21, 2024

Offload googlesitekit-consent-mode to worker as well

0e3e00d

westonruter commented Nov 21, 2024

View reviewed changes

westonruter mentioned this pull request Nov 21, 2024

Offloading Google Analytics (gtag) to a Web Worker #1455

Closed

felixarntz mentioned this pull request Nov 21, 2024

Output consent mode JS via wp_print_inline_script_tag() google/site-kit-wp#9726

Merged

19 tasks

westonruter mentioned this pull request Nov 26, 2024

Update direct script tag output to use wp_print_inline_script_tag() google/site-kit-wp#9725

Closed

1 task

westonruter marked this pull request as ready for review December 13, 2024 18:08

westonruter commented Dec 13, 2024

View reviewed changes

plugins/web-worker-offloading/third-party/google-site-kit.php Outdated Show resolved Hide resolved

Clarify why forward config is used

c0c4f27

Base automatically changed from add/wwo-rank-math-integration to trunk December 13, 2024 18:57

Merge branch 'trunk' into add/wwo-site-kit-integration

e59dd0e

westonruter commented Dec 13, 2024

View reviewed changes

plugins/web-worker-offloading/third-party/google-site-kit.php Outdated Show resolved Hide resolved

westonruter added 2 commits December 13, 2024 11:03

Update permalink to Consent_Mode.php

c2a80b0

Add missing WP Consent API globals

0162d90

westonruter requested a review from adamsilverstein December 13, 2024 20:15

westonruter removed the blocked label Dec 13, 2024

adamsilverstein reviewed Dec 13, 2024

View reviewed changes

plugins/web-worker-offloading/third-party/google-site-kit.php Outdated Show resolved Hide resolved

adamsilverstein reviewed Dec 13, 2024

View reviewed changes

plugins/web-worker-offloading/third-party/google-site-kit.php Outdated Show resolved Hide resolved

adamsilverstein reviewed Dec 13, 2024

View reviewed changes

Fix plugin name reference

dc7ef36

Co-authored-by: Adam Silverstein <[email protected]>

westonruter added 2 commits December 13, 2024 13:26

Fix permalink to Site Kit on GitHub

eeb4327

Ensure gtag() can be called from main thread

6a89d7b

westonruter commented Dec 13, 2024

View reviewed changes

westonruter mentioned this pull request Dec 13, 2024

Fix tracking events like add_to_cart in WooCommerce integration #1740

Merged

adamsilverstein approved these changes Dec 14, 2024

View reviewed changes

westonruter merged commit fb9769e into trunk Dec 14, 2024
17 of 18 checks passed

westonruter deleted the add/wwo-site-kit-integration branch December 14, 2024 00:03

jamesozzie mentioned this pull request Nov 13, 2025

Web Worker Offloading - Support for Site Kit #2262

Open

Integrate Web Worker Offloading with Google Site Kit #1686

Integrate Web Worker Offloading with Google Site Kit #1686

Uh oh!

Conversation

westonruter commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

westonruter Nov 21, 2024

Choose a reason for hiding this comment

Uh oh!

adamsilverstein Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

adamsilverstein Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

westonruter commented Dec 2, 2024

Uh oh!

westonruter commented Dec 2, 2024

Uh oh!

github-actions bot commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

westonruter commented Dec 13, 2024

Uh oh!

Uh oh!

Uh oh!

adamsilverstein left a comment

Choose a reason for hiding this comment

Uh oh!

aaemnnosttv commented Dec 13, 2024

Uh oh!

westonruter commented Dec 13, 2024

Uh oh!

westonruter commented Dec 13, 2024

Uh oh!

westonruter Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

westonruter Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

aaemnnosttv Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

aaemnnosttv commented Dec 13, 2024

Uh oh!

adamsilverstein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

westonruter commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Dec 13, 2024 •

edited

Loading