Merge 4f27acb into 89e3a6a

.changeset/moody-glasses-mate.md

@@ -0,0 +1,5 @@
+---
+'@guardian/consent-management-platform': patch
+---
+
+testing exeperimentation

monitoring/package.json

@@ -18,9 +18,10 @@
     "dotenv": "^16.3.1",
     "inquirer": "^8.2.6",
     "playwright-aws-lambda": "^0.10.0",
-    "playwright-core": "^1.40.1",
     "tslib": "^2.6.2",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.1",
+		"@guardian/consent-management-platform": "0.0.0-beta-20240129231944",
+		"playwright-core": "^1.40.1"
   },
   "devDependencies": {
     "@aws-sdk/client-lambda": "^3.490.0",
@@ -47,4 +48,4 @@
   "overrides": {
     "clone-deep": "4.0.1"
   }
-}
+}

monitoring/src/check-page/aus.ts

@@ -1,11 +1,10 @@
+import { checkTopAdHasLoaded, clickAcceptAllCookies } from '@guardian/consent-management-platform';
 import type { Browser, BrowserContext, Page } from 'playwright-core';
 import type { Config } from '../types';
 import {
 	checkCMPIsNotVisible,
 	checkCMPIsOnPage,
 	checkCMPLoadingTimeAndVersion,
-	checkTopAdHasLoaded,
-	clickAcceptAllCookies,
 	loadPage,
 	log_info,
 	makeNewBrowser,
@@ -45,7 +44,7 @@ const checkPages = async (config: Config, url: string, nextUrl: string) => {
 	await loadPage(page, url);
 	await checkTopAdHasLoaded(page);
 	await checkCMPIsOnPage(page);
-	await clickAcceptAllCookies(config, page, 'Continue');
+	await clickAcceptAllCookies(page, 'Continue');
 	await checkCMPIsNotVisible(page);
 	await reloadPage(page);
 	await checkTopAdHasLoaded(page);

monitoring/src/check-page/ccpa.ts

@@ -1,11 +1,11 @@
+import {checkTopAdHasLoaded} from '@guardian/consent-management-platform';
 import type { Browser, BrowserContext, Page } from 'playwright-core';
 import { ELEMENT_ID } from '../types';
 import type { Config } from '../types';
 import {
 	checkCMPIsNotVisible,
 	checkCMPIsOnPage,
 	checkCMPLoadingTimeAndVersion,
-	checkTopAdHasLoaded,
 	loadPage,
 	log_info,
 	makeNewBrowser,

monitoring/src/check-page/common-functions.ts

@@ -6,7 +6,7 @@ import {
 	PutMetricDataCommand
 } from '@aws-sdk/client-cloudwatch';
 import { launchChromium } from 'playwright-aws-lambda';
-import type { Browser, BrowserContext, Page, Request } from 'playwright-core';
+import type { Browser, BrowserContext, Page } from 'playwright-core';
 import type { Config } from '../types';
 import { ELEMENT_ID } from '../types';
 
@@ -73,24 +73,6 @@ export const makeNewPage = async (context: BrowserContext): Promise<Page> => {
 	return page;
 };
 
-/**
- * This function waits for the page to load
- * clicks the accept all button
- *
- * @param {Config} config
- * @param {Page} page
- * @param {string} textToPrintToConsole
- */
-export const clickAcceptAllCookies = async (config: Config, page: Page, textToPrintToConsole: string) => {
-
-	log_info(`Clicking on "${textToPrintToConsole}" on CMP`);
-
-	const acceptAllButton = page.frameLocator(ELEMENT_ID.CMP_CONTAINER).locator(ELEMENT_ID.TCFV2_FIRST_LAYER_ACCEPT_ALL);
-  	await acceptAllButton.click();
-
-	log_info(`Clicked on "${textToPrintToConsole}"`);
-};
-
 /**
  * This function waits for the page to load
  * clicks the manage cookies button to open the privacy settings panel
@@ -165,56 +147,6 @@ export const clickRejectAllSecondLayer = async (config: Config, page: Page) => {
 	log_info(`Clicking on reject all button: Complete`);
 };
 
-/**
- * This function checks for interaction with GAM
- * Using this after advice from Commercial to check that cookies were accepted as we otherwise do not interact with GAM
- * This has to be adjusted if anything in the interaction with GAM changes or we stop using GAM
- *
- * @param {Page} page
- * @return {*}  {Promise<void>}
- */
-export const checkTopAdHasLoaded = async (page: Page) => {
-	log_info(`Waiting for interaction with GAM: Start`);
-
-	const gamUrl = /https:\/\/securepubads.g.doubleclick.net\/gampad\/ads/;
-
-	const getEncodedParamsFromRequest = (
-		request: Request,
-		paramName: string,
-	): URLSearchParams | null => {
-		const url = new URL(request.url());
-		const param = url.searchParams.get(paramName);
-		if (!param) return null;
-		const paramDecoded = decodeURIComponent(param);
-		const searchParams = new URLSearchParams(paramDecoded);
-		return searchParams;
-	};
-
-	const assertOnSlotFromRequest = (request: Request, expectedSlot: string) => {
-		const isURL = request.url().match(gamUrl);
-		if (!isURL) return false;
-		const searchParams = getEncodedParamsFromRequest(request, 'prev_scp');
-		if (searchParams === null) return false;
-		const slot = searchParams.get('slot');
-		if (slot !== expectedSlot) return false;
-		return true;
-	};
-
-	const waitForGAMRequestForSlot = (page: Page, slotExpected: string) => {
-		return page.waitForRequest((request) =>
-			assertOnSlotFromRequest(request, slotExpected),
-		);
-	};
-
-	const gamRequestPromise = waitForGAMRequestForSlot(
-		page,
-		'top-above-nav',
-	);
-	await gamRequestPromise;
-
-	log_info(`Waiting for interaction with GAM: Complete`);
-};
-
 /**
  * This function checks the ad is not on the page
  * This checks that the top ad frame does not appear on the page

monitoring/src/check-page/tcfv2.ts

@@ -1,3 +1,4 @@
+import { checkTopAdHasLoaded, clickAcceptAllCookies } from '@guardian/consent-management-platform';
 import type { Browser, BrowserContext, Page } from 'playwright-core';
 import type { Config } from '../types';
 import {
@@ -6,10 +7,8 @@ import {
 	checkCMPLoadingTimeAndVersion,
 	checkPrivacySettingsPanelIsOpen,
 	checkTopAdDidNotLoad,
-	checkTopAdHasLoaded,
 	clearCookies,
 	clearLocalStorage,
-	clickAcceptAllCookies,
 	clickRejectAllSecondLayer,
 	clickSaveAndCloseSecondLayer,
 	loadPage,
@@ -45,7 +44,7 @@ const checkSubsequentPage = async (
 	]);
 	await reloadPage(page);
 	await checkTopAdDidNotLoad(page);
-	await clickAcceptAllCookies(config, page, "Yes I'm Happy");
+	await clickAcceptAllCookies( page, "Yes I'm Happy");
 	await Promise.all([
 		checkCMPIsNotVisible(page),
 		checkTopAdHasLoaded(page),
@@ -126,7 +125,7 @@ export const firstLayerCheck = async function (
 
 	await checkTopAdDidNotLoad(page);
 
-	await clickAcceptAllCookies(config, page, "Yes I'm Happy");
+	await clickAcceptAllCookies( page, "Yes I'm Happy");
 
 	await checkCMPIsNotVisible(page);
 

monitoring/yarn.lock

@@ -871,6 +871,11 @@
   resolved "https://registry.yarnpkg.com/@eslint/js/-/js-8.56.0.tgz#ef20350fec605a7f7035a01764731b2de0f3782b"
   integrity sha512-gMsVel9D7f2HLkBma9VbtzZRehRogVRfbr++f06nL2vnCGCNlzOD+/MUov/F4p8myyAHspEhVobgjpX64q5m6A==
 
+"@guardian/[email protected]":
+  version "0.0.0-beta-20240129231944"
+  resolved "https://registry.yarnpkg.com/@guardian/consent-management-platform/-/consent-management-platform-0.0.0-beta-20240129231944.tgz#f980a59bbb5617614cea8f946e33a17316727d6f"
+  integrity sha512-0K+xzKZtqCLUZmPBXo+zVP17mcZnC6dvJuj2D0R7N8QovY5XZH5+JaqWN9O+YkcHyEKCwo4m+nJ4RpeGNMqdQQ==
+
 "@guardian/eslint-config-typescript@^9.0.1":
   version "9.0.1"
   resolved "https://registry.yarnpkg.com/@guardian/eslint-config-typescript/-/eslint-config-typescript-9.0.1.tgz#42d63f6b4d0c0414d5a7a6a4da3b288fa53df709"
@@ -4725,9 +4730,9 @@ playwright-aws-lambda@^0.10.0:
     lambdafs "^2.1.1"
 
 playwright-core@^1.40.1:
-  version "1.40.1"
-  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.40.1.tgz#442d15e86866a87d90d07af528e0afabe4c75c05"
-  integrity sha512-+hkOycxPiV534c4HhpfX6yrlawqVUzITRKwHAmYfmsVreltEl6fAZJ3DPfLMOODw0H3s1Itd6MDCWmP1fl/QvQ==
+  version "1.41.1"
+  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.41.1.tgz#9c152670010d9d6f970f34b68e3e935d3c487431"
+  integrity sha512-/KPO5DzXSMlxSX77wy+HihKGOunh3hqndhqeo/nMxfigiKzogn8kfL0ZBDu0L1RKgan5XHCPmn6zXd2NUJgjhg==
 
 prelude-ls@^1.2.1:
   version "1.2.1"

package.json

@@ -88,9 +88,12 @@
 		"svelte": "~3.59.1",
 		"tslib": "^2.5.3",
 		"typescript": "~5.1.3",
-		"wait-for-expect": "^3"
+		"wait-for-expect": "^3",
+		"playwright-core": "^1.40.1"
 	},
 	"peerDependencies": {
-		"@guardian/libs": "^15.0.0"
-	}
+		"@guardian/libs": "^15.0.0",
+		"playwright-core": "^1.40.1"
+	},
+	"packageManager": "[email protected]"
 }

src/index.ts

@@ -15,6 +15,8 @@ import {
 import type { CMP, InitCMP, WillShowPrivacyMessage } from './types';
 import { initVendorDataManager } from './vendorDataManager';
 
+export {checkTopAdHasLoaded, clickAcceptAllCookies} from './testing/common-functions';
+
 // Store some bits in the global scope for reuse, in case there's more
 // than one instance of the CMP on the page in different scopes.
 if (!isServerSide) {

src/testing/common-functions.ts

@@ -0,0 +1,78 @@
+import type { Page, Request } from 'playwright-core';
+
+/**
+ * This function console logs an info message.
+ *
+ * @param {string} message
+ */
+const log_info = (message: string): void => {
+	console.log(`(cmp monitoring) info: ${message}`);
+};
+
+
+/**
+ * This function waits for the page to load
+ * clicks the accept all button
+ *
+ * @param {Page} page
+ * @param {string} textToPrintToConsole
+ */
+export const clickAcceptAllCookies = async (page: Page, textToPrintToConsole: string = "Accept All") => {
+
+	log_info(`Clicking on "${textToPrintToConsole}" on CMP`);
+
+	const acceptAllButton = page.frameLocator('[id*="sp_message_iframe"]').locator('button.sp_choice_type_11');
+  	await acceptAllButton.click();
+
+	log_info(`Clicked on "${textToPrintToConsole}"`);
+};
+
+/**
+ * This function checks for interaction with GAM
+ * Using this after advice from Commercial to check that cookies were accepted as we otherwise do not interact with GAM
+ * This has to be adjusted if anything in the interaction with GAM changes or we stop using GAM
+ *
+ * @param {Page} page
+ * @return {*}  {Promise<void>}
+ */
+export const checkTopAdHasLoaded = async (page: Page) => {
+	log_info(`Waiting for interaction with GAM: Start`);
+
+	const gamUrl = /https:\/\/securepubads.g.doubleclick.net\/gampad\/ads/;
+
+	const getEncodedParamsFromRequest = (
+		request: Request,
+		paramName: string,
+	): URLSearchParams | null => {
+		const url = new URL(request.url());
+		const param = url.searchParams.get(paramName);
+		if (!param) return null;
+		const paramDecoded = decodeURIComponent(param);
+		const searchParams = new URLSearchParams(paramDecoded);
+		return searchParams;
+	};
+
+	const assertOnSlotFromRequest = (request: Request, expectedSlot: string) => {
+		const isURL = request.url().match(gamUrl);
+		if (!isURL) return false;
+		const searchParams = getEncodedParamsFromRequest(request, 'prev_scp');
+		if (searchParams === null) return false;
+		const slot = searchParams.get('slot');
+		if (slot !== expectedSlot) return false;
+		return true;
+	};
+
+	const waitForGAMRequestForSlot = (page: Page, slotExpected: string) => {
+		return page.waitForRequest((request) =>
+			assertOnSlotFromRequest(request, slotExpected),
+		);
+	};
+
+	const gamRequestPromise = waitForGAMRequestForSlot(
+		page,
+		'top-above-nav',
+	);
+	await gamRequestPromise;
+
+	log_info(`Waiting for interaction with GAM: Complete`);
+};