Merge 4f61167 into 73990ee

guardian · Oct 2, 2024 · dbe54cd · dbe54cd
2 parents 73990ee + 4f61167
commit dbe54cd
Show file tree

Hide file tree

Showing 19 changed files with 249 additions and 141 deletions.
diff --git a/.changeset/giant-nails-sniff.md b/.changeset/giant-nails-sniff.md
@@ -0,0 +1,5 @@
+---
+'@guardian/commercial': minor
+---
+
+Updates @guardian/libs to latest version which migrated frameworks from ccpa to usnat. Therefore, commercial needed to be updated to reflect this.
diff --git a/docs/e2e-testing/# E2E testing.md b/docs/e2e-testing/# E2E testing.md
@@ -29,7 +29,7 @@
         -   TCF: If the user doesn't consent we shouldn't show ads.
         -   TCF: Ads don't render until the user gives consent.
         -   AUS: Check if a user selects "non personalized advertising" that the targeting is different.
-        -   CCPA: Check if a user selects "do not sell my information" that the targeting is different.
+        -   USNAT: Check if a user selects "do not sell my information" that the targeting is different.
 
 -   Lower priorities features:
     -   Commercial metrics

diff --git a/package.json b/package.json
@@ -56,7 +56,7 @@
 		"@guardian/eslint-config-typescript": "^12.0.0",
 		"@guardian/identity-auth": "^3.0.0",
 		"@guardian/identity-auth-frontend": "^5.0.0",
-		"@guardian/libs": "18.0.2",
+		"@guardian/libs": "19.0.0",
 		"@guardian/prettier": "8.0.1",
 		"@guardian/source": "8.0.0",
 		"@playwright/test": "1.46.0",
@@ -127,7 +127,7 @@
 		"@guardian/core-web-vitals": "^7.0.0",
 		"@guardian/identity-auth": "^3.0.0",
 		"@guardian/identity-auth-frontend": "^5.0.0",
-		"@guardian/libs": "^18.0.0",
+		"@guardian/libs": "^19.1.0",
 		"@guardian/source": "^8.0.0",
 		"typescript": "~5.5.3"
 	},

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/core/send-commercial-metrics.spec.ts b/src/core/send-commercial-metrics.spec.ts
@@ -1,4 +1,4 @@
-import type { ConsentState } from '@guardian/libs';
+import type { ConsentState, USNATConsentState } from '@guardian/libs';
 import { onConsent } from '@guardian/libs';
 import { EventTimer } from './event-timer';
 import {
@@ -103,16 +103,26 @@ const tcfv2AllConsentExceptPurpose8: ConsentState = {
 	framework: 'tcfv2',
 };
 
-const ccpaConsent: ConsentState = {
-	ccpa: { doNotSell: false },
+const usnatNonConsentObject: USNATConsentState = {
+	doNotSell: true,
+	signalStatus: 'ready',
+};
+
+const usnatConsentObject: USNATConsentState = {
+	doNotSell: false,
+	signalStatus: 'ready',
+};
+
+const usnatConsent: ConsentState = {
+	usnat: usnatConsentObject,
 	canTarget: true,
-	framework: 'ccpa',
+	framework: 'usnat',
 };
 
-const ccpaNonConsent: ConsentState = {
-	ccpa: { doNotSell: true },
+const usnatNonConsent: ConsentState = {
+	usnat: usnatNonConsentObject,
 	canTarget: false,
-	framework: 'ccpa',
+	framework: 'usnat',
 };
 
 const setVisibility = (value: 'hidden' | 'visible'): void => {
@@ -212,7 +222,7 @@ describe('send commercial metrics', () => {
 	});
 
 	it('sends metrics when non-TCFv2 user (i.e. USA or Australia) consents', async () => {
-		mockOnConsent(ccpaConsent);
+		mockOnConsent(usnatConsent);
 
 		await initCommercialMetrics({
 			pageViewId: PAGE_VIEW_ID,
@@ -231,7 +241,7 @@ describe('send commercial metrics', () => {
 	});
 
 	it('sends metrics when non-TCFv2 user (i.e. USA or Australia) does not consent', async () => {
-		mockOnConsent(ccpaNonConsent);
+		mockOnConsent(usnatNonConsent);
 
 		await initCommercialMetrics({
 			pageViewId: PAGE_VIEW_ID,

diff --git a/src/core/targeting/build-page-targeting.spec.ts b/src/core/targeting/build-page-targeting.spec.ts
@@ -1,4 +1,8 @@
-import type { ConsentState, TCFv2ConsentState } from '@guardian/libs';
+import type {
+	ConsentState,
+	TCFv2ConsentState,
+	USNATConsentState,
+} from '@guardian/libs';
 import { cmp as cmp_, setCookie, storage } from '@guardian/libs';
 import { getAuthStatus as getAuthStatus_ } from 'lib/identity/api';
 import type { AuthStatus } from 'lib/identity/api';
@@ -52,17 +56,27 @@ const mockViewport = (width: number, height: number): void => {
 	});
 };
 
-// CCPA
-const ccpaWithConsentMock: ConsentState = {
-	ccpa: { doNotSell: false },
+const usnatConsent: USNATConsentState = {
+	doNotSell: false,
+	signalStatus: 'ready',
+};
+
+const usnatNonConsent: USNATConsentState = {
+	doNotSell: true,
+	signalStatus: 'ready',
+};
+
+// USNAT
+const usnatWithConsentMock: ConsentState = {
+	usnat: usnatConsent,
 	canTarget: true,
-	framework: 'ccpa',
+	framework: 'usnat',
 };
 
-const ccpaWithoutConsentMock: ConsentState = {
-	ccpa: { doNotSell: true },
+const usnatWithoutConsentMock: ConsentState = {
+	usnat: usnatNonConsent,
 	canTarget: false,
-	framework: 'ccpa',
+	framework: 'usnat',
 };
 
 // AUS
@@ -258,15 +272,15 @@ describe('Build Page Targeting', () => {
 			buildPageTargeting({
 				adFree: false,
 				clientSideParticipations: {},
-				consentState: ccpaWithConsentMock,
+				consentState: usnatWithConsentMock,
 				isSignedIn: true,
 			}).pa,
 		).toBe('t');
 		expect(
 			buildPageTargeting({
 				adFree: false,
 				clientSideParticipations: {},
-				consentState: ccpaWithoutConsentMock,
+				consentState: usnatWithoutConsentMock,
 				isSignedIn: true,
 			}).pa,
 		).toBe('f');
@@ -293,15 +307,15 @@ describe('Build Page Targeting', () => {
 			buildPageTargeting({
 				adFree: false,
 				clientSideParticipations: {},
-				consentState: ccpaWithConsentMock,
+				consentState: usnatWithConsentMock,
 				isSignedIn: true,
 			}).rdp,
 		).toBe('f');
 		expect(
 			buildPageTargeting({
 				adFree: false,
 				clientSideParticipations: {},
-				consentState: ccpaWithoutConsentMock,
+				consentState: usnatWithoutConsentMock,
 				isSignedIn: true,
 			}).rdp,
 		).toBe('t');
@@ -598,7 +612,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).permutive,
 			).toEqual(['1', '2', '3']);
@@ -612,7 +626,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('5');
@@ -624,7 +638,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('16-19');
@@ -636,7 +650,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('30plus');
@@ -648,7 +662,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('0');
@@ -660,7 +674,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithConsentMock,
+					consentState: usnatWithConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('0');
@@ -672,7 +686,7 @@ describe('Build Page Targeting', () => {
 				buildPageTargeting({
 					adFree: false,
 					clientSideParticipations: {},
-					consentState: ccpaWithoutConsentMock,
+					consentState: usnatWithoutConsentMock,
 					isSignedIn: true,
 				}).fr,
 			).toEqual('0');
@@ -902,8 +916,8 @@ describe('Build Page Targeting', () => {
 		});
 
 		it.each([
-			[ccpaWithConsentMock, '9'],
-			[ccpaWithoutConsentMock, '9'],
+			[usnatWithConsentMock, '9'],
+			[usnatWithoutConsentMock, '9'],
 
 			[ausWithConsentMock, '9'],
 			[ausWithoutConsentMock, '9'],
@@ -1126,7 +1140,7 @@ describe('Build Page Targeting', () => {
 			buildPageTargeting({
 				adFree: false,
 				clientSideParticipations: {},
-				consentState: ccpaWithConsentMock,
+				consentState: usnatWithConsentMock,
 				isSignedIn: true,
 			}).firstvisit,
 		).toBeUndefined();