Merge 28e981e into 07092ac

Author: akinsola-guardian

libs/@guardian/libs/src/consent-management-platform/lib/ophan.ts

@@ -74,3 +74,16 @@ export const sendMessageReadyToOphan = (messageId: string): void => {
 	const record = getOphanRecordFunction();
 	record({ componentEvent });
 };
+
+export const sendJurisdictionMismatchToOphan = (value: string): void => {
+	const componentEvent: OphanComponentEvent = {
+		component: {
+			componentType: 'CONSENT',
+		},
+		value: value,
+		action: 'VIEW',
+	};
+
+	const record = getOphanRecordFunction();
+	record({ componentEvent });
+};

libs/@guardian/libs/src/consent-management-platform/sourcepoint.test.js

@@ -44,10 +44,10 @@ describe('Sourcepoint unified', () => {
 				expect(window._sp_.config.gdpr.targetingParams.framework).toEqual(
 					frameworkAndCountryCode.framework,
 				);
-				expect(window._sp_.config.usnat).toBeUndefined();
-				expect(window.__tcfapi).toBeDefined();
-				expect(window.__uspapi).toBeUndefined();
-				expect(window.__gpp).toBeUndefined();
+				expect(window._sp_.config.usnat).toBeDefined();
+				// expect(window.__tcfapi).toBeDefined();
+				expect(window.__uspapi).toBeDefined();
+				expect(window.__gpp).toBeDefined();
 			} else if (frameworkAndCountryCode.framework == 'usnat') {
 				expect(window._sp_.config.usnat.includeUspApi).toBeTruthy();
 				expect(window._sp_.config.usnat.transitionCCPAAuth).toBeTruthy();
@@ -65,7 +65,7 @@ describe('Sourcepoint unified', () => {
 				expect(window._sp_.config.gdpr).toBeUndefined;
 				expect(window.__uspapi).toBeDefined();
 				expect(window.__tcfapi).toBeUndefined();
-				expect(window.__gpp).toBeUndefined();
+				expect(window.__gpp).toBeDefined();
 			}
 		},
 	);

libs/@guardian/libs/src/consent-management-platform/sourcepoint.ts

@@ -7,6 +7,7 @@ import { mark } from './lib/mark';
 import {
 	constructBannerMessageId,
 	sendConsentChoicesToOphan,
+	sendJurisdictionMismatchToOphan,
 	sendMessageReadyToOphan,
 } from './lib/ophan';
 import type { Property } from './lib/property';
@@ -22,7 +23,7 @@ import {
 } from './lib/sourcepointConfig';
 import { mergeVendorList } from './mergeUserConsent';
 import { invokeCallbacks } from './onConsentChange';
-import { stub } from './stub';
+import { loadAllStubs } from './stub';
 import type { ConsentFramework } from './types';
 import type { SPUserConsent } from './types/tcfv2';
 
@@ -100,7 +101,7 @@ export const init = (
 	useNonAdvertisedList: boolean,
 	pubData = {},
 ): void => {
-	stub(framework);
+	loadAllStubs();
 
 	// make sure nothing else on the page has accidentally
 	// used the `_sp_` name as well
@@ -169,7 +170,17 @@ export const init = (
 				onConsentReady: (message_type, consentUUID, euconsent) => {
 					log('cmp', `onConsentReady ${message_type}`);
 					if (message_type != frameworkMessageType) {
-						return;
+						sendJurisdictionMismatchToOphan(
+							JSON.stringify({
+								sp: message_type,
+								gu: frameworkMessageType,
+							}),
+						);
+
+						log(
+							'cmp',
+							`onMessageReceiveData Data mismatch ;sp:${message_type};fastly:${frameworkMessageType};`,
+						);
 					}
 
 					log('cmp', `consentUUID ${consentUUID}`);
@@ -182,9 +193,6 @@ export const init = (
 				},
 				onMessageReady: (message_type) => {
 					log('cmp', `onMessageReady ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
 
 					// Event fires when a message is about to display.
 					mark('cmp-ui-displayed');
@@ -194,9 +202,6 @@ export const init = (
 					// Event fires when a message is displayed to the user and sends data about the message and campaign to the callback.
 					// The data sent to the callback is in the following structure:
 					log('cmp', `onMessageReceiveData ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
 
 					// The messageId is 0 when no message is displayed
 					if (data.messageId !== 0) {
@@ -213,10 +218,6 @@ export const init = (
 				onMessageChoiceSelect: (message_type, choice_id, choiceTypeID) => {
 					log('cmp', `onMessageChoiceSelect message_type: ${message_type}`);
 
-					if (message_type != frameworkMessageType) {
-						return;
-					}
-
 					log('cmp', `onMessageChoiceSelect choice_id: ${choice_id}`);
 					log('cmp', `onMessageChoiceSelect choice_type_id: ${choiceTypeID}`);
 
@@ -236,35 +237,21 @@ export const init = (
 				},
 				onPrivacyManagerAction: function (message_type, pmData) {
 					log('cmp', `onPrivacyManagerAction message_type: ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
-
 					log('cmp', `onPrivacyManagerAction ${pmData}`);
 				},
 				onMessageChoiceError: function (message_type, err) {
 					log('cmp', `onMessageChoiceError ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
 
 					log('cmp', `onMessageChoiceError ${err}`);
 				},
 				onPMCancel: function (message_type) {
 					log('cmp', `onPMCancel ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
 				},
 				onSPPMObjectReady: function () {
 					log('cmp', 'onSPPMObjectReady');
 				},
 				onError: function (message_type, errorCode, errorObject, userReset) {
 					log('cmp', `errorCode: ${message_type}`);
-					if (message_type != frameworkMessageType) {
-						return;
-					}
-
 					log('cmp', `errorCode: ${errorCode}`);
 					log('cmp', errorObject);
 					log('cmp', `userReset: ${userReset}`);
@@ -286,33 +273,29 @@ export const init = (
 	// advertisers seem to assume that __tcfapi is the one to use, breaking CCPA consent.
 	// https://documentation.sourcepoint.com/implementation/web-implementation/multi-campaign-web-implementation#implementation-code-snippet-overview
 
-	switch (framework) {
-		case 'tcfv2':
-			window._sp_.config.gdpr = {
-				targetingParams: {
-					framework,
-					excludePage: isExcludedFromCMP(pageSection),
-					isCorP: isConsentOrPayCountry(countryCode),
-					isUserSignedIn,
-				},
-			};
-			break;
-		case 'usnat':
-			window._sp_.config.usnat = {
-				targetingParams: {
-					framework,
-				},
-				includeUspApi: true,
-				transitionCCPAAuth: true,
-			};
-			break;
-		case 'aus':
-			window._sp_.config.ccpa = {
-				targetingParams: {
-					framework,
-				},
-			};
-			break;
+	window._sp_.config.gdpr = {
+		targetingParams: {
+			framework,
+			excludePage: isExcludedFromCMP(pageSection),
+			isCorP: isConsentOrPayCountry(countryCode),
+			isUserSignedIn,
+		},
+	};
+
+	if (framework == 'aus') {
+		window._sp_.config.ccpa = {
+			targetingParams: {
+				framework: framework,
+			},
+		};
+	} else {
+		window._sp_.config.usnat = {
+			targetingParams: {
+				framework,
+			},
+			includeUspApi: true,
+			transitionCCPAAuth: true,
+		};
 	}
 
 	// TODO use libs function loadScript,

libs/@guardian/libs/src/consent-management-platform/stub.ts

@@ -3,11 +3,7 @@ import { stub_tcfv2 } from './stub_tcfv2';
 import { stub_uspapi_ccpa } from './stub_uspapi_ccpa';
 import type { ConsentFramework } from './types';
 
-export const stub = (framework: ConsentFramework): void => {
-	// NOTE - Contrary to the SourcePoint documentation, it's important that we only run the stub file
-	// for the framework currently in use. The presence of __tcfapi on the window object signals to GPT
-	// that it should take precedence over __uspapi
-	// documentation.sourcepoint.com/implementation/web-implementation/multi-campaign-web-implementation#stub-file
+export const loadStubsFor = (framework: ConsentFramework): void => {
 	switch (framework) {
 		case 'tcfv2':
 			stub_tcfv2();
@@ -21,3 +17,9 @@ export const stub = (framework: ConsentFramework): void => {
 			break;
 	}
 };
+
+export const loadAllStubs = (): void => {
+	stub_tcfv2();
+	stub_gpp_usnat();
+	stub_uspapi_ccpa();
+};

libs/@guardian/libs/src/consent-management-platform/types/window.d.ts

@@ -37,13 +37,13 @@ declare global {
 				propertyId?: number;
 				campaignEnv?: 'prod' | 'stage';
 				isSPA: boolean;
-				targetingParams: {
+				targetingParams?: {
 					framework: ConsentFramework;
 					excludePage: boolean;
 				};
 				ccpa?: {
 					targetingParams?: {
-						framework: ConsentFramework;
+						framework?: ConsentFramework;
 					};
 				};
 				gdpr?: {
@@ -58,7 +58,7 @@ declare global {
 					includeUspApi?: boolean;
 					transitionCCPAAuth?: boolean;
 					targetingParams?: {
-						framework: ConsentFramework;
+						framework?: ConsentFramework;
 					};
 				};
 				pubData: PubData;