Merge pull request #8441 from google/bug/fix-como-region-property

google · Mar 28, 2024 · 1248d0c · 1248d0c
2 parents 13c9111 + e15801b
commit 1248d0c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 22 deletions.
diff --git a/includes/Core/Consent_Mode/Consent_Mode.php b/includes/Core/Consent_Mode/Consent_Mode.php
@@ -88,7 +88,10 @@ protected function render_gtag_consent_snippet() {
 			'ad_storage'         => 'denied',
 			'ad_user_data'       => 'denied',
 			'analytics_storage'  => 'denied',
-			'regions'            => $this->consent_mode_settings->get_regions(),
+			// TODO: The value for `region` should be retrieved from $this->consent_mode_settings->get_regions(),
+			// but we'll need to migrate/clean up the incorrect values that were set from the initial release.
+			// See https://github.com/google/site-kit-wp/issues/8444.
+			'region'             => Regions::EU_USER_CONSENT_POLICY,
 			'wait_for_update'    => 500, // Allow 500ms for Consent Management Platforms (CMPs) to update the consent status.
 		);
 

diff --git a/includes/Core/Consent_Mode/Consent_Mode_Settings.php b/includes/Core/Consent_Mode/Consent_Mode_Settings.php
@@ -47,7 +47,7 @@ protected function get_type() {
 	protected function get_default() {
 		return array(
 			'enabled' => false,
-			'regions' => Regions::EEA,
+			'regions' => Regions::EU_USER_CONSENT_POLICY,
 		);
 	}
 

diff --git a/includes/Core/Consent_Mode/Regions.php b/includes/Core/Consent_Mode/Regions.php
@@ -20,13 +20,13 @@
 class Regions {
 
 	/**
-	 * List of countries in the European Economic Area (EEA).
+	 * List of countries that Google's EU user consent policy applies to, which are the
+	 * countries in the European Economic Area (EEA) plus the UK.
 	 */
-	const EEA = array(
+	const EU_USER_CONSENT_POLICY = array(
 		'AT',
 		'BE',
 		'BG',
-		'CH',
 		'CY',
 		'CZ',
 		'DE',
@@ -35,6 +35,7 @@ class Regions {
 		'ES',
 		'FI',
 		'FR',
+		'GB',
 		'GR',
 		'HR',
 		'HU',
@@ -54,6 +55,5 @@ class Regions {
 		'SE',
 		'SI',
 		'SK',
-		'UK',
 	);
 }
diff --git a/tests/e2e/specs/front-end/consent-mode.test.js b/tests/e2e/specs/front-end/consent-mode.test.js
@@ -30,11 +30,10 @@ import {
 	wpApiFetch,
 } from '../../utils';
 
-const eeaRegions = [
+const euUserConsentPolicyRegions = [
 	'AT',
 	'BE',
 	'BG',
-	'CH',
 	'CY',
 	'CZ',
 	'DE',
@@ -43,6 +42,7 @@ const eeaRegions = [
 	'ES',
 	'FI',
 	'FR',
+	'GB',
 	'GR',
 	'HR',
 	'HU',
@@ -62,7 +62,6 @@ const eeaRegions = [
 	'SE',
 	'SI',
 	'SK',
-	'UK',
 ];
 
 describe( 'Consent Mode snippet', () => {
@@ -101,7 +100,7 @@ describe( 'Consent Mode snippet', () => {
 					ad_storage: 'denied',
 					ad_user_data: 'denied',
 					analytics_storage: 'denied',
-					regions: eeaRegions,
+					region: euUserConsentPolicyRegions,
 					wait_for_update: 500,
 				},
 			},
@@ -124,7 +123,7 @@ describe( 'Consent Mode snippet', () => {
 					ad_storage: 'denied',
 					ad_user_data: 'denied',
 					analytics_storage: 'denied',
-					regions: eeaRegions,
+					region: euUserConsentPolicyRegions,
 					wait_for_update: 500,
 				},
 			},
@@ -160,7 +159,7 @@ describe( 'Consent Mode snippet', () => {
 					ad_storage: 'denied',
 					ad_user_data: 'denied',
 					analytics_storage: 'denied',
-					regions: eeaRegions,
+					region: euUserConsentPolicyRegions,
 					wait_for_update: 500,
 				},
 			},
@@ -184,7 +183,7 @@ describe( 'Consent Mode snippet', () => {
 					ad_storage: 'denied',
 					ad_user_data: 'denied',
 					analytics_storage: 'denied',
-					regions: eeaRegions,
+					region: euUserConsentPolicyRegions,
 					wait_for_update: 500,
 				},
 			},

diff --git a/tests/phpunit/integration/Core/Consent_Mode/Consent_Mode_SettingsTest.php b/tests/phpunit/integration/Core/Consent_Mode/Consent_Mode_SettingsTest.php
@@ -50,7 +50,7 @@ public function test_get_default() {
 		$this->assertEqualSetsWithIndex(
 			array(
 				'enabled' => false,
-				'regions' => Regions::EEA,
+				'regions' => Regions::EU_USER_CONSENT_POLICY,
 			),
 			$default_settings
 		);
@@ -64,14 +64,14 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => false,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'enabled empty'       => array(
 				array(),
 				array(
 					'enabled' => false,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'enabled true'        => array(
@@ -80,7 +80,7 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => true,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'enabled non-empty'   => array(
@@ -89,7 +89,7 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => true,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'valid regions'       => array(
@@ -116,7 +116,7 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => false,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'empty regions'       => array(
@@ -125,7 +125,7 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => false,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 			'non-array regions'   => array(
@@ -134,7 +134,7 @@ public function data_consent_mode_settings() {
 				),
 				array(
 					'enabled' => false,
-					'regions' => Regions::EEA,
+					'regions' => Regions::EU_USER_CONSENT_POLICY,
 				),
 			),
 		);
@@ -162,7 +162,7 @@ public function test_is_consent_mode_enabled() {
 	}
 
 	public function test_get_regions() {
-		$this->assertEquals( Regions::EEA, $this->settings->get_regions() );
+		$this->assertEquals( Regions::EU_USER_CONSENT_POLICY, $this->settings->get_regions() );
 
 		$regions = array( 'SG', 'UA-AS' );
 		$this->settings->set( array( 'regions' => $regions ) );