Prevent duplicate consent update calls if the parameters have not cha…

…ngesd.
google · Jul 10, 2024 · ef83c39 · ef83c39
1 parent 97816cc
commit ef83c39
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/assets/js/consent-mode/consent-mode.js b/assets/js/consent-mode/consent-mode.js
@@ -14,6 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * External dependencies
+ */
+const { isEqual } = require( 'lodash' );
+
 ( function () {
 	function actionConsentChange( event ) {
 		if ( event.detail ) {
@@ -62,8 +67,13 @@
 				}
 			}
 		);
-		if ( hasConsentParameters ) {
+		if (
+			hasConsentParameters &&
+			// Prevent duplicate calls to gtag, only updating if the consent parameters have changed.
+			! isEqual( consentParameters, global._googlesitekitConsents )
+		) {
 			global.gtag( 'consent', 'update', consentParameters );
+			global._googlesitekitConsents = consentParameters;
 		}
 	}
 	document.addEventListener(

diff --git a/assets/js/consent-mode/consent-mode.test.js b/assets/js/consent-mode/consent-mode.test.js
@@ -29,11 +29,18 @@ describe( 'Consent Mode', () => {
 		global._googlesitekitConsentCategoryMap = {
 			'test-category': [ 'test-parameter' ],
 		};
+		global.wp_consent_type = 'optin';
+		global.wp_has_consent = () => true;
+		global._googlesitekitConsents = {};
 	} );
 
 	afterEach( () => {
+		gtagMock.mockReset();
 		delete global.gtag;
 		delete global._googlesitekitConsentCategoryMap;
+		delete global.wp_consent_type;
+		delete global.wp_has_consent;
+		delete global._googlesitekitConsents;
 	} );
 
 	it( 'should call gtag with the correct parameters when wp_listen_for_consent_change event is triggered', () => {
@@ -69,4 +76,17 @@ describe( 'Consent Mode', () => {
 			'test-parameter': 'granted',
 		} );
 	} );
+
+	it( 'should not trigger duplicate calls to gtag if the consent parameter have not changed', () => {
+		document.dispatchEvent( new Event( 'DOMContentLoaded' ) );
+		document.dispatchEvent(
+			new CustomEvent( 'wp_consent_type_defined', {
+				detail: {
+					'test-category': 'allow',
+				},
+			} )
+		);
+
+		expect( gtagMock ).toHaveBeenCalledTimes( 1 );
+	} );
 } );
diff --git a/includes/Core/Consent_Mode/Consent_Mode.php b/includes/Core/Consent_Mode/Consent_Mode.php
@@ -175,6 +175,7 @@ protected function render_gtag_consent_data_layer_snippet() {
 window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}
 gtag('consent', 'default', <?php echo wp_json_encode( $consent_defaults ); ?>);
 window._googlesitekitConsentCategoryMap = <?php	echo wp_json_encode( $consent_category_map ); ?>;
+window._googlesitekitConsents = <?php echo wp_json_encode( $consent_defaults ); ?>
 </script>
 <!-- <?php echo esc_html__( 'End Google tag (gtag.js) Consent Mode dataLayer added by Site Kit', 'google-site-kit' ); ?> -->
 			<?php